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)
71 /* don't let anonymous logins override the name */
75 trim_string(tmp," "," ");
77 alpha_strcpy(smb_user_name,tmp,SAFE_NETBIOS_CHARS,sizeof(smb_user_name)-1);
81 /*******************************************************************
82 Given a pointer to a %$(NAME) expand it as an environment variable.
83 Return the number of characters by which the pointer should be advanced.
84 Based on code by Branko Cibej <branko.cibej@hermes.si>
85 When this is called p points at the '%' character.
86 ********************************************************************/
88 static size_t expand_env_var(char *p, int len)
102 * Look for the terminating ')'.
105 if ((q = strchr_m(p,')')) == NULL) {
106 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p));
111 * Extract the name from within the %$(NAME) string.
115 copylen = MIN((q-r),(sizeof(envname)-1));
116 strncpy(envname,r,copylen);
117 envname[copylen] = '\0';
119 if ((envval = getenv(envname)) == NULL) {
120 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname));
125 * Copy the full %$(NAME) into envname so it
129 copylen = MIN((q+1-p),(sizeof(envname)-1));
130 strncpy(envname,p,copylen);
131 envname[copylen] = '\0';
132 string_sub(p,envname,envval,len);
133 return 0; /* Allow the environment contents to be parsed. */
136 /*******************************************************************
137 Given a pointer to a %$(NAME) in p and the whole string in str
138 expand it as an environment variable.
139 Return a new allocated and expanded string.
140 Based on code by Branko Cibej <branko.cibej@hermes.si>
141 When this is called p points at the '%' character.
142 May substitute multiple occurrencies of the same env var.
143 ********************************************************************/
146 static char * realloc_expand_env_var(char *str, char *p)
153 if (p[0] != '%' || p[1] != '$' || p[2] != '(')
157 * Look for the terminating ')'.
160 if ((q = strchr_m(p,')')) == NULL) {
161 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p));
166 * Extract the name from within the %$(NAME) string.
171 envname = (char *)malloc(copylen + 1 + 4); /* reserve space for use later add %$() chars */
172 if (envname == NULL) return NULL;
173 strncpy(envname,r,copylen);
174 envname[copylen] = '\0';
176 if ((envval = getenv(envname)) == NULL) {
177 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname));
183 * Copy the full %$(NAME) into envname so it
188 strncpy(envname,p,copylen);
189 envname[copylen] = '\0';
190 r = realloc_string_sub(str, envname, envval);
192 if (r == NULL) return NULL;
196 /*******************************************************************
197 Patch from jkf@soton.ac.uk
198 Added this to implement %p (NIS auto-map version of %H)
199 *******************************************************************/
201 static char *automount_path(const char *user_name)
203 static pstring server_path;
205 /* use the passwd entry as the default */
206 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
208 pstrcpy(server_path, get_user_home_dir(user_name));
210 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
212 if (lp_nis_home_map()) {
213 char *home_path_start;
214 char *automount_value = automount_lookup(user_name);
216 if(strlen(automount_value) > 0) {
217 home_path_start = strchr_m(automount_value,':');
218 if (home_path_start != NULL) {
219 DEBUG(5, ("NIS lookup succeeded. Home path is: %s\n",
220 home_path_start?(home_path_start+1):""));
221 pstrcpy(server_path, home_path_start+1);
224 /* NIS key lookup failed: default to user home directory from password file */
225 DEBUG(5, ("NIS lookup failed. Using Home path from passwd file. Home path is: %s\n", server_path ));
230 DEBUG(4,("Home server path: %s\n", server_path));
235 /*******************************************************************
236 Patch from jkf@soton.ac.uk
237 This is Luke's original function with the NIS lookup code
238 moved out to a separate function.
239 *******************************************************************/
241 static const char *automount_server(const char *user_name)
243 static pstring server_name;
244 const char *local_machine_name = get_local_machine_name();
246 /* use the local machine name as the default */
247 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
248 if (local_machine_name && *local_machine_name)
249 pstrcpy(server_name, local_machine_name);
251 pstrcpy(server_name, global_myname());
253 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
255 if (lp_nis_home_map()) {
257 char *automount_value = automount_lookup(user_name);
258 home_server_len = strcspn(automount_value,":");
259 DEBUG(5, ("NIS lookup succeeded. Home server length: %d\n",home_server_len));
260 if (home_server_len > sizeof(pstring))
261 home_server_len = sizeof(pstring);
262 strncpy(server_name, automount_value, home_server_len);
263 server_name[home_server_len] = '\0';
267 DEBUG(4,("Home server: %s\n", server_name));
272 /****************************************************************************
273 Do some standard substitutions in a string.
274 len is the length in bytes of the space allowed in string str. If zero means
275 don't allow expansions.
276 ****************************************************************************/
278 void standard_sub_basic(const char *smb_name, char *str,size_t len)
283 const char *local_machine_name = get_local_machine_name();
285 for (s=str; (p=strchr_m(s, '%'));s=p) {
288 int l = (int)len - (int)(p-str);
295 fstrcpy(tmp_str, smb_name);
297 string_sub(p,"%U",tmp_str,l);
300 fstrcpy(tmp_str, smb_name);
301 if ((pass = Get_Pwnam(tmp_str))!=NULL) {
302 string_sub(p,"%G",gidtoname(pass->pw_gid),l);
308 fstrcpy(tmp_str, current_user_info.domain);
310 string_sub(p,"%D", tmp_str,l);
313 string_sub(p,"%I", client_addr(),l);
316 if (local_machine_name && *local_machine_name)
317 string_sub(p,"%L", local_machine_name,l);
321 pstrcpy(temp_name, global_myname());
323 string_sub(p,"%L", temp_name,l);
327 string_sub(p,"%M", client_name(),l);
330 string_sub(p,"%R", remote_proto,l);
333 string_sub(p,"%T", timestring(False),l);
336 string_sub(p,"%a", remote_arch,l);
339 slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)sys_getpid());
340 string_sub(p,"%d", pidstr,l);
343 string_sub(p,"%h", myhostname(),l);
346 string_sub(p,"%m", get_remote_machine_name(),l);
349 string_sub(p,"%v", VERSION,l);
352 p += expand_env_var(p,l);
353 break; /* Expand environment variables */
356 break; /* don't run off the end of the string */
364 static void standard_sub_advanced(int snum, const char *user,
365 const char *connectpath, gid_t gid,
366 const char *smb_name, char *str, size_t len)
370 for (s=str; (p=strchr_m(s, '%'));s=p) {
371 int l = (int)len - (int)(p-str);
378 string_sub(p,"%N", automount_server(user),l);
381 if ((home = get_user_home_dir(user)))
382 string_sub(p,"%H",home, l);
387 string_sub(p,"%P", connectpath, l);
390 string_sub(p,"%S", lp_servicename(snum), l);
393 string_sub(p,"%g", gidtoname(gid), l);
396 string_sub(p,"%u", user, l);
399 /* Patch from jkf@soton.ac.uk Left the %N (NIS
400 * server name) in standard_sub_basic as it is
401 * a feature for logon servers, hence uses the
402 * username. The %p (NIS server path) code is
403 * here as it is used instead of the default
404 * "path =" string in [homes] and so needs the
405 * service name, not the username. */
407 string_sub(p,"%p", automount_path(lp_servicename(snum)), l);
411 break; /* don't run off the end of the string */
418 standard_sub_basic(smb_name, str, len);
421 /****************************************************************************
422 Do some standard substitutions in a string.
423 This function will return an allocated string that have to be freed.
424 ****************************************************************************/
426 char *talloc_sub_basic(TALLOC_CTX *mem_ctx, const char *smb_name, const char *str)
429 a = alloc_sub_basic(smb_name, str);
431 t = talloc_strdup(mem_ctx, a);
436 char *alloc_sub_basic(const char *smb_name, const char *str)
438 char *b, *p, *s, *t, *r, *a_string;
441 const char *local_machine_name = get_local_machine_name();
443 a_string = strdup(str);
444 if (a_string == NULL) {
445 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
449 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
456 r = strdup_lower(smb_name);
457 if (r == NULL) goto error;
458 t = realloc_string_sub(t, "%U", r);
461 r = strdup(smb_name);
462 if (r == NULL) goto error;
463 if ((pass = Get_Pwnam(r))!=NULL) {
464 t = realloc_string_sub(t, "%G", gidtoname(pass->pw_gid));
468 r = strdup_upper(current_user_info.domain);
469 if (r == NULL) goto error;
470 t = realloc_string_sub(t, "%D", r);
473 t = realloc_string_sub(t, "%I", client_addr());
476 if (local_machine_name && *local_machine_name)
477 t = realloc_string_sub(t, "%L", local_machine_name);
479 t = realloc_string_sub(t, "%L", global_myname());
482 t = realloc_string_sub(t, "%M", client_name());
485 t = realloc_string_sub(t, "%R", remote_proto);
488 t = realloc_string_sub(t, "%T", timestring(False));
491 t = realloc_string_sub(t, "%a", remote_arch);
494 slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)sys_getpid());
495 t = realloc_string_sub(t, "%d", pidstr);
498 t = realloc_string_sub(t, "%h", myhostname());
501 t = realloc_string_sub(t, "%m", remote_machine);
504 t = realloc_string_sub(t, "%v", VERSION);
507 t = realloc_expand_env_var(t, p); /* Expand environment variables */
516 if (t == NULL) goto error;
526 /****************************************************************************
527 Do some specific substitutions in a string.
528 This function will return an allocated string that have to be freed.
529 ****************************************************************************/
531 char *talloc_sub_specified(TALLOC_CTX *mem_ctx,
532 const char *input_string,
533 const char *username,
539 a = alloc_sub_specified(input_string, username, domain, uid, gid);
541 t = talloc_strdup(mem_ctx, a);
546 char *alloc_sub_specified(const char *input_string,
547 const char *username,
552 char *a_string, *ret_string;
555 a_string = strdup(input_string);
556 if (a_string == NULL) {
557 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
561 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
567 t = realloc_string_sub(t, "%U", username);
570 t = realloc_string_sub(t, "%u", username);
574 t = realloc_string_sub(t, "%G", gidtoname(gid));
576 t = realloc_string_sub(t, "%G", "NO_GROUP");
581 t = realloc_string_sub(t, "%g", gidtoname(gid));
583 t = realloc_string_sub(t, "%g", "NO_GROUP");
587 t = realloc_string_sub(t, "%D", domain);
590 t = realloc_string_sub(t, "%N", automount_server(username));
604 ret_string = alloc_sub_basic(username, a_string);
609 char *talloc_sub_advanced(TALLOC_CTX *mem_ctx,
612 const char *connectpath,
614 const char *smb_name,
618 a = alloc_sub_advanced(snum, user, connectpath, gid, smb_name, str);
620 t = talloc_strdup(mem_ctx, a);
625 char *alloc_sub_advanced(int snum, const char *user,
626 const char *connectpath, gid_t gid,
627 const char *smb_name, char *str)
629 char *a_string, *ret_string;
630 char *b, *p, *s, *t, *h;
632 a_string = strdup(str);
633 if (a_string == NULL) {
634 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
638 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
644 t = realloc_string_sub(t, "%N", automount_server(user));
647 if ((h = get_user_home_dir(user)))
648 t = realloc_string_sub(t, "%H", h);
651 t = realloc_string_sub(t, "%P", connectpath);
654 t = realloc_string_sub(t, "%S", lp_servicename(snum));
657 t = realloc_string_sub(t, "%g", gidtoname(gid));
660 t = realloc_string_sub(t, "%u", user);
663 /* Patch from jkf@soton.ac.uk Left the %N (NIS
664 * server name) in standard_sub_basic as it is
665 * a feature for logon servers, hence uses the
666 * username. The %p (NIS server path) code is
667 * here as it is used instead of the default
668 * "path =" string in [homes] and so needs the
669 * service name, not the username. */
671 t = realloc_string_sub(t, "%p", automount_path(lp_servicename(snum)));
686 ret_string = alloc_sub_basic(smb_name, a_string);
691 /****************************************************************************
692 Do some standard substitutions in a string.
693 ****************************************************************************/
695 void standard_sub_conn(connection_struct *conn, char *str, size_t len)
697 standard_sub_advanced(SNUM(conn), conn->user, conn->connectpath,
698 conn->gid, smb_user_name, str, len);
701 char *talloc_sub_conn(TALLOC_CTX *mem_ctx, connection_struct *conn, char *str)
703 return talloc_sub_advanced(mem_ctx, SNUM(conn), conn->user,
704 conn->connectpath, conn->gid,
708 char *alloc_sub_conn(connection_struct *conn, char *str)
710 return alloc_sub_advanced(SNUM(conn), conn->user, conn->connectpath,
711 conn->gid, smb_user_name, str);
714 /****************************************************************************
715 Like standard_sub but by snum.
716 ****************************************************************************/
718 void standard_sub_snum(int snum, char *str, size_t len)
720 extern struct current_user current_user;
721 static uid_t cached_uid = -1;
722 static fstring cached_user;
723 /* calling uidtoname() on every substitute would be too expensive, so
724 we cache the result here as nearly every call is for the same uid */
726 if (cached_uid != current_user.uid) {
727 fstrcpy(cached_user, uidtoname(current_user.uid));
728 cached_uid = current_user.uid;
731 standard_sub_advanced(snum, cached_user, "", -1,
732 smb_user_name, str, len);