2 Unix SMB/CIFS implementation.
3 string substitution functions
4 Copyright (C) Andrew Tridgell 1992-2000
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 fstring local_machine="";
25 fstring remote_arch="UNKNOWN";
26 userdom_struct current_user_info;
27 fstring remote_proto="UNKNOWN";
29 static fstring remote_machine;
30 static fstring smb_user_name;
33 void set_local_machine_name(const char* local_name)
35 fstring tmp_local_machine;
37 fstrcpy(tmp_local_machine,local_name);
38 trim_string(tmp_local_machine," "," ");
39 strlower(tmp_local_machine);
40 alpha_strcpy(local_machine,tmp_local_machine,SAFE_NETBIOS_CHARS,sizeof(local_machine)-1);
43 void set_remote_machine_name(const char* remote_name)
45 fstring tmp_remote_machine;
47 fstrcpy(tmp_remote_machine,remote_name);
48 trim_string(tmp_remote_machine," "," ");
49 strlower(tmp_remote_machine);
50 alpha_strcpy(remote_machine,tmp_remote_machine,SAFE_NETBIOS_CHARS,sizeof(remote_machine)-1);
53 const char* get_remote_machine_name(void)
55 return remote_machine;
58 const char* get_local_machine_name(void)
65 setup the string used by %U substitution
67 void sub_set_smb_name(const char *name)
72 trim_string(tmp," "," ");
74 alpha_strcpy(smb_user_name,tmp,SAFE_NETBIOS_CHARS,sizeof(smb_user_name)-1);
78 /*******************************************************************
79 Given a pointer to a %$(NAME) expand it as an environment variable.
80 Return the number of characters by which the pointer should be advanced.
81 Based on code by Branko Cibej <branko.cibej@hermes.si>
82 When this is called p points at the '%' character.
83 ********************************************************************/
85 static size_t expand_env_var(char *p, int len)
99 * Look for the terminating ')'.
102 if ((q = strchr_m(p,')')) == NULL) {
103 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p));
108 * Extract the name from within the %$(NAME) string.
112 copylen = MIN((q-r),(sizeof(envname)-1));
113 strncpy(envname,r,copylen);
114 envname[copylen] = '\0';
116 if ((envval = getenv(envname)) == NULL) {
117 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname));
122 * Copy the full %$(NAME) into envname so it
126 copylen = MIN((q+1-p),(sizeof(envname)-1));
127 strncpy(envname,p,copylen);
128 envname[copylen] = '\0';
129 string_sub(p,envname,envval,len);
130 return 0; /* Allow the environment contents to be parsed. */
133 /*******************************************************************
134 Given a pointer to a %$(NAME) in p and the whole string in str
135 expand it as an environment variable.
136 Return a new allocated and expanded string.
137 Based on code by Branko Cibej <branko.cibej@hermes.si>
138 When this is called p points at the '%' character.
139 May substitute multiple occurrencies of the same env var.
140 ********************************************************************/
143 static char * realloc_expand_env_var(char *str, char *p)
150 if (p[0] != '%' || p[1] != '$' || p[2] != '(')
154 * Look for the terminating ')'.
157 if ((q = strchr_m(p,')')) == NULL) {
158 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p));
163 * Extract the name from within the %$(NAME) string.
168 envname = (char *)malloc(copylen + 1 + 4); /* reserve space for use later add %$() chars */
169 if (envname == NULL) return NULL;
170 strncpy(envname,r,copylen);
171 envname[copylen] = '\0';
173 if ((envval = getenv(envname)) == NULL) {
174 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname));
180 * Copy the full %$(NAME) into envname so it
185 strncpy(envname,p,copylen);
186 envname[copylen] = '\0';
187 r = realloc_string_sub(str, envname, envval);
189 if (r == NULL) return NULL;
193 /*******************************************************************
194 Patch from jkf@soton.ac.uk
195 Added this to implement %p (NIS auto-map version of %H)
196 *******************************************************************/
198 static char *automount_path(const char *user_name)
200 static pstring server_path;
202 /* use the passwd entry as the default */
203 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
205 pstrcpy(server_path, get_user_home_dir(user_name));
207 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
209 if (lp_nis_home_map()) {
210 char *home_path_start;
211 char *automount_value = automount_lookup(user_name);
213 if(strlen(automount_value) > 0) {
214 home_path_start = strchr_m(automount_value,':');
215 if (home_path_start != NULL) {
216 DEBUG(5, ("NIS lookup succeeded. Home path is: %s\n",
217 home_path_start?(home_path_start+1):""));
218 pstrcpy(server_path, home_path_start+1);
221 /* NIS key lookup failed: default to user home directory from password file */
222 DEBUG(5, ("NIS lookup failed. Using Home path from passwd file. Home path is: %s\n", server_path ));
227 DEBUG(4,("Home server path: %s\n", server_path));
232 /*******************************************************************
233 Patch from jkf@soton.ac.uk
234 This is Luke's original function with the NIS lookup code
235 moved out to a separate function.
236 *******************************************************************/
238 static const char *automount_server(const char *user_name)
240 static pstring server_name;
241 const char *local_machine_name = get_local_machine_name();
243 /* use the local machine name as the default */
244 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
245 if (local_machine_name && *local_machine_name)
246 pstrcpy(server_name, local_machine_name);
248 pstrcpy(server_name, global_myname());
250 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
252 if (lp_nis_home_map()) {
254 char *automount_value = automount_lookup(user_name);
255 home_server_len = strcspn(automount_value,":");
256 DEBUG(5, ("NIS lookup succeeded. Home server length: %d\n",home_server_len));
257 if (home_server_len > sizeof(pstring))
258 home_server_len = sizeof(pstring);
259 strncpy(server_name, automount_value, home_server_len);
260 server_name[home_server_len] = '\0';
264 DEBUG(4,("Home server: %s\n", server_name));
269 /****************************************************************************
270 Do some standard substitutions in a string.
271 len is the length in bytes of the space allowed in string str. If zero means
272 don't allow expansions.
273 ****************************************************************************/
275 void standard_sub_basic(const char *smb_name, char *str,size_t len)
280 const char *local_machine_name = get_local_machine_name();
282 for (s=str; (p=strchr_m(s, '%'));s=p) {
285 int l = (int)len - (int)(p-str);
292 fstrcpy(tmp_str, smb_name);
294 string_sub(p,"%U",tmp_str,l);
297 fstrcpy(tmp_str, smb_name);
298 if ((pass = Get_Pwnam(tmp_str))!=NULL) {
299 string_sub(p,"%G",gidtoname(pass->pw_gid),l);
305 fstrcpy(tmp_str, current_user_info.domain);
307 string_sub(p,"%D", tmp_str,l);
310 string_sub(p,"%I", client_addr(),l);
313 if (local_machine_name && *local_machine_name)
314 string_sub(p,"%L", local_machine_name,l);
318 pstrcpy(temp_name, global_myname());
320 string_sub(p,"%L", temp_name,l);
324 string_sub(p,"%M", client_name(),l);
327 string_sub(p,"%R", remote_proto,l);
330 string_sub(p,"%T", timestring(False),l);
333 string_sub(p,"%a", remote_arch,l);
336 slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)sys_getpid());
337 string_sub(p,"%d", pidstr,l);
340 string_sub(p,"%h", myhostname(),l);
343 string_sub(p,"%m", get_remote_machine_name(),l);
346 string_sub(p,"%v", VERSION,l);
349 p += expand_env_var(p,l);
350 break; /* Expand environment variables */
353 break; /* don't run off the end of the string */
361 static void standard_sub_advanced(int snum, const char *user,
362 const char *connectpath, gid_t gid,
363 const char *smb_name, char *str, size_t len)
367 for (s=str; (p=strchr_m(s, '%'));s=p) {
368 int l = (int)len - (int)(p-str);
375 string_sub(p,"%N", automount_server(user),l);
378 if ((home = get_user_home_dir(user)))
379 string_sub(p,"%H",home, l);
384 string_sub(p,"%P", connectpath, l);
387 string_sub(p,"%S", lp_servicename(snum), l);
390 string_sub(p,"%g", gidtoname(gid), l);
393 string_sub(p,"%u", user, l);
396 /* Patch from jkf@soton.ac.uk Left the %N (NIS
397 * server name) in standard_sub_basic as it is
398 * a feature for logon servers, hence uses the
399 * username. The %p (NIS server path) code is
400 * here as it is used instead of the default
401 * "path =" string in [homes] and so needs the
402 * service name, not the username. */
404 string_sub(p,"%p", automount_path(lp_servicename(snum)), l);
408 break; /* don't run off the end of the string */
415 standard_sub_basic(smb_name, str, len);
418 /****************************************************************************
419 Do some standard substitutions in a string.
420 This function will return an allocated string that have to be freed.
421 ****************************************************************************/
423 char *talloc_sub_basic(TALLOC_CTX *mem_ctx, const char *smb_name, const char *str)
426 a = alloc_sub_basic(smb_name, str);
428 t = talloc_strdup(mem_ctx, a);
433 char *alloc_sub_basic(const char *smb_name, const char *str)
435 char *b, *p, *s, *t, *r, *a_string;
438 const char *local_machine_name = get_local_machine_name();
440 a_string = strdup(str);
441 if (a_string == NULL) {
442 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
446 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
453 r = strdup_lower(smb_name);
454 if (r == NULL) goto error;
455 t = realloc_string_sub(t, "%U", r);
458 r = strdup(smb_name);
459 if (r == NULL) goto error;
460 if ((pass = Get_Pwnam(r))!=NULL) {
461 t = realloc_string_sub(t, "%G", gidtoname(pass->pw_gid));
465 r = strdup_upper(current_user_info.domain);
466 if (r == NULL) goto error;
467 t = realloc_string_sub(t, "%D", r);
470 t = realloc_string_sub(t, "%I", client_addr());
473 if (local_machine_name && *local_machine_name)
474 t = realloc_string_sub(t, "%L", local_machine_name);
476 t = realloc_string_sub(t, "%L", global_myname());
479 t = realloc_string_sub(t, "%M", client_name());
482 t = realloc_string_sub(t, "%R", remote_proto);
485 t = realloc_string_sub(t, "%T", timestring(False));
488 t = realloc_string_sub(t, "%a", remote_arch);
491 slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)sys_getpid());
492 t = realloc_string_sub(t, "%d", pidstr);
495 t = realloc_string_sub(t, "%h", myhostname());
498 t = realloc_string_sub(t, "%m", remote_machine);
501 t = realloc_string_sub(t, "%v", VERSION);
504 t = realloc_expand_env_var(t, p); /* Expand environment variables */
513 if (t == NULL) goto error;
523 /****************************************************************************
524 Do some specific substitutions in a string.
525 This function will return an allocated string that have to be freed.
526 ****************************************************************************/
528 char *talloc_sub_specified(TALLOC_CTX *mem_ctx,
529 const char *input_string,
530 const char *username,
536 a = alloc_sub_specified(input_string, username, domain, uid, gid);
538 t = talloc_strdup(mem_ctx, a);
543 char *alloc_sub_specified(const char *input_string,
544 const char *username,
549 char *a_string, *ret_string;
552 a_string = strdup(input_string);
553 if (a_string == NULL) {
554 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
558 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
564 t = realloc_string_sub(t, "%U", username);
567 t = realloc_string_sub(t, "%u", username);
571 t = realloc_string_sub(t, "%G", gidtoname(gid));
573 t = realloc_string_sub(t, "%G", "NO_GROUP");
578 t = realloc_string_sub(t, "%g", gidtoname(gid));
580 t = realloc_string_sub(t, "%g", "NO_GROUP");
584 t = realloc_string_sub(t, "%D", domain);
587 t = realloc_string_sub(t, "%N", automount_server(username));
601 ret_string = alloc_sub_basic(username, a_string);
606 char *talloc_sub_advanced(TALLOC_CTX *mem_ctx,
609 const char *connectpath,
611 const char *smb_name,
615 a = alloc_sub_advanced(snum, user, connectpath, gid, smb_name, str);
617 t = talloc_strdup(mem_ctx, a);
622 char *alloc_sub_advanced(int snum, const char *user,
623 const char *connectpath, gid_t gid,
624 const char *smb_name, char *str)
626 char *a_string, *ret_string;
627 char *b, *p, *s, *t, *h;
629 a_string = strdup(str);
630 if (a_string == NULL) {
631 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
635 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
641 t = realloc_string_sub(t, "%N", automount_server(user));
644 if ((h = get_user_home_dir(user)))
645 t = realloc_string_sub(t, "%H", h);
648 t = realloc_string_sub(t, "%P", connectpath);
651 t = realloc_string_sub(t, "%S", lp_servicename(snum));
654 t = realloc_string_sub(t, "%g", gidtoname(gid));
657 t = realloc_string_sub(t, "%u", user);
660 /* Patch from jkf@soton.ac.uk Left the %N (NIS
661 * server name) in standard_sub_basic as it is
662 * a feature for logon servers, hence uses the
663 * username. The %p (NIS server path) code is
664 * here as it is used instead of the default
665 * "path =" string in [homes] and so needs the
666 * service name, not the username. */
668 t = realloc_string_sub(t, "%p", automount_path(lp_servicename(snum)));
683 ret_string = alloc_sub_basic(smb_name, a_string);
688 /****************************************************************************
689 Do some standard substitutions in a string.
690 ****************************************************************************/
692 void standard_sub_conn(connection_struct *conn, char *str, size_t len)
694 standard_sub_advanced(SNUM(conn), conn->user, conn->connectpath,
695 conn->gid, smb_user_name, str, len);
698 char *talloc_sub_conn(TALLOC_CTX *mem_ctx, connection_struct *conn, char *str)
700 return talloc_sub_advanced(mem_ctx, SNUM(conn), conn->user,
701 conn->connectpath, conn->gid,
705 char *alloc_sub_conn(connection_struct *conn, char *str)
707 return alloc_sub_advanced(SNUM(conn), conn->user, conn->connectpath,
708 conn->gid, smb_user_name, str);
711 /****************************************************************************
712 Like standard_sub but by snum.
713 ****************************************************************************/
715 void standard_sub_snum(int snum, char *str, size_t len)
717 extern struct current_user current_user;
718 static uid_t cached_uid = -1;
719 static fstring cached_user;
720 /* calling uidtoname() on every substitute would be too expensive, so
721 we cache the result here as nearly every call is for the same uid */
723 if (cached_uid != current_user.uid) {
724 fstrcpy(cached_user, uidtoname(current_user.uid));
725 cached_uid = current_user.uid;
728 standard_sub_advanced(snum, cached_user, "", -1,
729 smb_user_name, str, len);