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 * Set the 'local' machine name
34 * @param local_name the name we are being called
35 * @param if this is the 'final' name for us, not be be changed again
38 void set_local_machine_name(const char* local_name, BOOL perm)
40 static BOOL already_perm = False;
41 fstring tmp_local_machine;
44 * Windows NT/2k uses "*SMBSERVER" and XP uses "*SMBSERV"
48 if (strcasecmp(local_name, "*SMBSERVER")==0)
51 if (strcasecmp(local_name, "*SMBSERV")==0)
59 fstrcpy(tmp_local_machine,local_name);
60 trim_string(tmp_local_machine," "," ");
61 strlower(tmp_local_machine);
62 alpha_strcpy(local_machine,tmp_local_machine,SAFE_NETBIOS_CHARS,sizeof(local_machine)-1);
66 * Set the 'remote' machine name
67 * @param remote_name the name our client wants to be called by
68 * @param if this is the 'final' name for them, not be be changed again
71 void set_remote_machine_name(const char* remote_name, BOOL perm)
73 static BOOL already_perm = False;
74 fstring tmp_remote_machine;
81 fstrcpy(tmp_remote_machine,remote_name);
82 trim_string(tmp_remote_machine," "," ");
83 strlower(tmp_remote_machine);
84 alpha_strcpy(remote_machine,tmp_remote_machine,SAFE_NETBIOS_CHARS,sizeof(remote_machine)-1);
87 const char* get_remote_machine_name(void)
89 return remote_machine;
92 const char* get_local_machine_name(void)
94 if (!*local_machine) {
95 return global_myname();
103 setup the string used by %U substitution
105 void sub_set_smb_name(const char *name)
109 /* don't let anonymous logins override the name */
113 trim_string(tmp," "," ");
115 alpha_strcpy(smb_user_name,tmp,SAFE_NETBIOS_CHARS,sizeof(smb_user_name)-1);
119 /*******************************************************************
120 Given a pointer to a %$(NAME) expand it as an environment variable.
121 Return the number of characters by which the pointer should be advanced.
122 Based on code by Branko Cibej <branko.cibej@hermes.si>
123 When this is called p points at the '%' character.
124 ********************************************************************/
126 static size_t expand_env_var(char *p, int len)
140 * Look for the terminating ')'.
143 if ((q = strchr_m(p,')')) == NULL) {
144 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p));
149 * Extract the name from within the %$(NAME) string.
153 copylen = MIN((q-r),(sizeof(envname)-1));
154 strncpy(envname,r,copylen);
155 envname[copylen] = '\0';
157 if ((envval = getenv(envname)) == NULL) {
158 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname));
163 * Copy the full %$(NAME) into envname so it
167 copylen = MIN((q+1-p),(sizeof(envname)-1));
168 strncpy(envname,p,copylen);
169 envname[copylen] = '\0';
170 string_sub(p,envname,envval,len);
171 return 0; /* Allow the environment contents to be parsed. */
174 /*******************************************************************
175 Given a pointer to a %$(NAME) in p and the whole string in str
176 expand it as an environment variable.
177 Return a new allocated and expanded string.
178 Based on code by Branko Cibej <branko.cibej@hermes.si>
179 When this is called p points at the '%' character.
180 May substitute multiple occurrencies of the same env var.
181 ********************************************************************/
184 static char * realloc_expand_env_var(char *str, char *p)
191 if (p[0] != '%' || p[1] != '$' || p[2] != '(')
195 * Look for the terminating ')'.
198 if ((q = strchr_m(p,')')) == NULL) {
199 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p));
204 * Extract the name from within the %$(NAME) string.
209 envname = (char *)malloc(copylen + 1 + 4); /* reserve space for use later add %$() chars */
210 if (envname == NULL) return NULL;
211 strncpy(envname,r,copylen);
212 envname[copylen] = '\0';
214 if ((envval = getenv(envname)) == NULL) {
215 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname));
221 * Copy the full %$(NAME) into envname so it
226 strncpy(envname,p,copylen);
227 envname[copylen] = '\0';
228 r = realloc_string_sub(str, envname, envval);
230 if (r == NULL) return NULL;
234 /*******************************************************************
235 Patch from jkf@soton.ac.uk
236 Added this to implement %p (NIS auto-map version of %H)
237 *******************************************************************/
239 static char *automount_path(const char *user_name)
241 static pstring server_path;
243 /* use the passwd entry as the default */
244 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
246 pstrcpy(server_path, get_user_home_dir(user_name));
248 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
250 if (lp_nis_home_map()) {
251 char *home_path_start;
252 char *automount_value = automount_lookup(user_name);
254 if(strlen(automount_value) > 0) {
255 home_path_start = strchr_m(automount_value,':');
256 if (home_path_start != NULL) {
257 DEBUG(5, ("NIS lookup succeeded. Home path is: %s\n",
258 home_path_start?(home_path_start+1):""));
259 pstrcpy(server_path, home_path_start+1);
262 /* NIS key lookup failed: default to user home directory from password file */
263 DEBUG(5, ("NIS lookup failed. Using Home path from passwd file. Home path is: %s\n", server_path ));
268 DEBUG(4,("Home server path: %s\n", server_path));
273 /*******************************************************************
274 Patch from jkf@soton.ac.uk
275 This is Luke's original function with the NIS lookup code
276 moved out to a separate function.
277 *******************************************************************/
279 static const char *automount_server(const char *user_name)
281 static pstring server_name;
282 const char *local_machine_name = get_local_machine_name();
284 /* use the local machine name as the default */
285 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
286 if (local_machine_name && *local_machine_name)
287 pstrcpy(server_name, local_machine_name);
289 pstrcpy(server_name, global_myname());
291 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
293 if (lp_nis_home_map()) {
295 char *automount_value = automount_lookup(user_name);
296 home_server_len = strcspn(automount_value,":");
297 DEBUG(5, ("NIS lookup succeeded. Home server length: %d\n",home_server_len));
298 if (home_server_len > sizeof(pstring))
299 home_server_len = sizeof(pstring);
300 strncpy(server_name, automount_value, home_server_len);
301 server_name[home_server_len] = '\0';
305 DEBUG(4,("Home server: %s\n", server_name));
310 /****************************************************************************
311 Do some standard substitutions in a string.
312 len is the length in bytes of the space allowed in string str. If zero means
313 don't allow expansions.
314 ****************************************************************************/
316 void standard_sub_basic(const char *smb_name, char *str,size_t len)
321 const char *local_machine_name = get_local_machine_name();
323 for (s=str; (p=strchr_m(s, '%'));s=p) {
326 int l = (int)len - (int)(p-str);
333 fstrcpy(tmp_str, smb_name);
335 string_sub(p,"%U",tmp_str,l);
338 fstrcpy(tmp_str, smb_name);
339 if ((pass = Get_Pwnam(tmp_str))!=NULL) {
340 string_sub(p,"%G",gidtoname(pass->pw_gid),l);
346 fstrcpy(tmp_str, current_user_info.domain);
348 string_sub(p,"%D", tmp_str,l);
351 string_sub(p,"%I", client_addr(),l);
354 if (local_machine_name && *local_machine_name)
355 string_sub(p,"%L", local_machine_name,l);
359 pstrcpy(temp_name, global_myname());
361 string_sub(p,"%L", temp_name,l);
365 string_sub(p,"%M", client_name(),l);
368 string_sub(p,"%R", remote_proto,l);
371 string_sub(p,"%T", timestring(False),l);
374 string_sub(p,"%a", remote_arch,l);
377 slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)sys_getpid());
378 string_sub(p,"%d", pidstr,l);
381 string_sub(p,"%h", myhostname(),l);
384 string_sub(p,"%m", get_remote_machine_name(),l);
387 string_sub(p,"%v", VERSION,l);
390 p += expand_env_var(p,l);
391 break; /* Expand environment variables */
394 break; /* don't run off the end of the string */
402 static void standard_sub_advanced(int snum, const char *user,
403 const char *connectpath, gid_t gid,
404 const char *smb_name, char *str, size_t len)
408 for (s=str; (p=strchr_m(s, '%'));s=p) {
409 int l = (int)len - (int)(p-str);
416 string_sub(p,"%N", automount_server(user),l);
419 if ((home = get_user_home_dir(user)))
420 string_sub(p,"%H",home, l);
425 string_sub(p,"%P", connectpath, l);
428 string_sub(p,"%S", lp_servicename(snum), l);
431 string_sub(p,"%g", gidtoname(gid), l);
434 string_sub(p,"%u", user, l);
437 /* Patch from jkf@soton.ac.uk Left the %N (NIS
438 * server name) in standard_sub_basic as it is
439 * a feature for logon servers, hence uses the
440 * username. The %p (NIS server path) code is
441 * here as it is used instead of the default
442 * "path =" string in [homes] and so needs the
443 * service name, not the username. */
445 string_sub(p,"%p", automount_path(lp_servicename(snum)), l);
449 break; /* don't run off the end of the string */
456 standard_sub_basic(smb_name, str, len);
459 /****************************************************************************
460 Do some standard substitutions in a string.
461 This function will return an allocated string that have to be freed.
462 ****************************************************************************/
464 char *talloc_sub_basic(TALLOC_CTX *mem_ctx, const char *smb_name, const char *str)
467 a = alloc_sub_basic(smb_name, str);
469 t = talloc_strdup(mem_ctx, a);
474 char *alloc_sub_basic(const char *smb_name, const char *str)
476 char *b, *p, *s, *t, *r, *a_string;
479 const char *local_machine_name = get_local_machine_name();
481 a_string = strdup(str);
482 if (a_string == NULL) {
483 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
487 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
494 r = strdup_lower(smb_name);
495 if (r == NULL) goto error;
496 t = realloc_string_sub(t, "%U", r);
499 r = strdup(smb_name);
500 if (r == NULL) goto error;
501 if ((pass = Get_Pwnam(r))!=NULL) {
502 t = realloc_string_sub(t, "%G", gidtoname(pass->pw_gid));
506 r = strdup_upper(current_user_info.domain);
507 if (r == NULL) goto error;
508 t = realloc_string_sub(t, "%D", r);
511 t = realloc_string_sub(t, "%I", client_addr());
514 if (local_machine_name && *local_machine_name)
515 t = realloc_string_sub(t, "%L", local_machine_name);
517 t = realloc_string_sub(t, "%L", global_myname());
520 t = realloc_string_sub(t, "%M", client_name());
523 t = realloc_string_sub(t, "%R", remote_proto);
526 t = realloc_string_sub(t, "%T", timestring(False));
529 t = realloc_string_sub(t, "%a", remote_arch);
532 slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)sys_getpid());
533 t = realloc_string_sub(t, "%d", pidstr);
536 t = realloc_string_sub(t, "%h", myhostname());
539 t = realloc_string_sub(t, "%m", remote_machine);
542 t = realloc_string_sub(t, "%v", VERSION);
545 t = realloc_expand_env_var(t, p); /* Expand environment variables */
554 if (t == NULL) goto error;
564 /****************************************************************************
565 Do some specific substitutions in a string.
566 This function will return an allocated string that have to be freed.
567 ****************************************************************************/
569 char *talloc_sub_specified(TALLOC_CTX *mem_ctx,
570 const char *input_string,
571 const char *username,
577 a = alloc_sub_specified(input_string, username, domain, uid, gid);
579 t = talloc_strdup(mem_ctx, a);
584 char *alloc_sub_specified(const char *input_string,
585 const char *username,
590 char *a_string, *ret_string;
593 a_string = strdup(input_string);
594 if (a_string == NULL) {
595 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
599 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
605 t = realloc_string_sub(t, "%U", username);
608 t = realloc_string_sub(t, "%u", username);
612 t = realloc_string_sub(t, "%G", gidtoname(gid));
614 t = realloc_string_sub(t, "%G", "NO_GROUP");
619 t = realloc_string_sub(t, "%g", gidtoname(gid));
621 t = realloc_string_sub(t, "%g", "NO_GROUP");
625 t = realloc_string_sub(t, "%D", domain);
628 t = realloc_string_sub(t, "%N", automount_server(username));
642 ret_string = alloc_sub_basic(username, a_string);
647 char *talloc_sub_advanced(TALLOC_CTX *mem_ctx,
650 const char *connectpath,
652 const char *smb_name,
656 a = alloc_sub_advanced(snum, user, connectpath, gid, smb_name, str);
658 t = talloc_strdup(mem_ctx, a);
663 char *alloc_sub_advanced(int snum, const char *user,
664 const char *connectpath, gid_t gid,
665 const char *smb_name, char *str)
667 char *a_string, *ret_string;
668 char *b, *p, *s, *t, *h;
670 a_string = strdup(str);
671 if (a_string == NULL) {
672 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
676 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
682 t = realloc_string_sub(t, "%N", automount_server(user));
685 if ((h = get_user_home_dir(user)))
686 t = realloc_string_sub(t, "%H", h);
689 t = realloc_string_sub(t, "%P", connectpath);
692 t = realloc_string_sub(t, "%S", lp_servicename(snum));
695 t = realloc_string_sub(t, "%g", gidtoname(gid));
698 t = realloc_string_sub(t, "%u", user);
701 /* Patch from jkf@soton.ac.uk Left the %N (NIS
702 * server name) in standard_sub_basic as it is
703 * a feature for logon servers, hence uses the
704 * username. The %p (NIS server path) code is
705 * here as it is used instead of the default
706 * "path =" string in [homes] and so needs the
707 * service name, not the username. */
709 t = realloc_string_sub(t, "%p", automount_path(lp_servicename(snum)));
724 ret_string = alloc_sub_basic(smb_name, a_string);
729 /****************************************************************************
730 Do some standard substitutions in a string.
731 ****************************************************************************/
733 void standard_sub_conn(connection_struct *conn, char *str, size_t len)
735 standard_sub_advanced(SNUM(conn), conn->user, conn->connectpath,
736 conn->gid, smb_user_name, str, len);
739 char *talloc_sub_conn(TALLOC_CTX *mem_ctx, connection_struct *conn, char *str)
741 return talloc_sub_advanced(mem_ctx, SNUM(conn), conn->user,
742 conn->connectpath, conn->gid,
746 char *alloc_sub_conn(connection_struct *conn, char *str)
748 return alloc_sub_advanced(SNUM(conn), conn->user, conn->connectpath,
749 conn->gid, smb_user_name, str);
752 /****************************************************************************
753 Like standard_sub but by snum.
754 ****************************************************************************/
756 void standard_sub_snum(int snum, char *str, size_t len)
758 extern struct current_user current_user;
759 static uid_t cached_uid = -1;
760 static fstring cached_user;
761 /* calling uidtoname() on every substitute would be too expensive, so
762 we cache the result here as nearly every call is for the same uid */
764 if (cached_uid != current_user.uid) {
765 fstrcpy(cached_user, uidtoname(current_user.uid));
766 cached_uid = current_user.uid;
769 standard_sub_advanced(snum, cached_user, "", -1,
770 smb_user_name, str, len);