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";
28 extern pstring global_myname;
30 static fstring remote_machine="";
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)
63 /*******************************************************************
64 Given a pointer to a %$(NAME) expand it as an environment variable.
65 Return the number of characters by which the pointer should be advanced.
66 Based on code by Branko Cibej <branko.cibej@hermes.si>
67 When this is called p points at the '%' character.
68 ********************************************************************/
70 static size_t expand_env_var(char *p, int len)
84 * Look for the terminating ')'.
87 if ((q = strchr_m(p,')')) == NULL) {
88 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p));
93 * Extract the name from within the %$(NAME) string.
97 copylen = MIN((q-r),(sizeof(envname)-1));
98 strncpy(envname,r,copylen);
99 envname[copylen] = '\0';
101 if ((envval = getenv(envname)) == NULL) {
102 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname));
107 * Copy the full %$(NAME) into envname so it
111 copylen = MIN((q+1-p),(sizeof(envname)-1));
112 strncpy(envname,p,copylen);
113 envname[copylen] = '\0';
114 string_sub(p,envname,envval,len);
115 return 0; /* Allow the environment contents to be parsed. */
118 /*******************************************************************
119 Given a pointer to a %$(NAME) in p and the whole string in str
120 expand it as an environment variable.
121 Return a new allocated and expanded string.
122 Based on code by Branko Cibej <branko.cibej@hermes.si>
123 When this is called p points at the '%' character.
124 May substitute multiple occurrencies of the same env var.
125 ********************************************************************/
128 static char * realloc_expand_env_var(char *str, char *p)
135 if (p[0] != '%' || p[1] != '$' || p[2] != '(')
139 * Look for the terminating ')'.
142 if ((q = strchr_m(p,')')) == NULL) {
143 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p));
148 * Extract the name from within the %$(NAME) string.
153 envname = (char *)malloc(copylen + 1 + 4); /* reserve space for use later add %$() chars */
154 if (envname == NULL) return NULL;
155 strncpy(envname,r,copylen);
156 envname[copylen] = '\0';
158 if ((envval = getenv(envname)) == NULL) {
159 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname));
165 * Copy the full %$(NAME) into envname so it
170 strncpy(envname,p,copylen);
171 envname[copylen] = '\0';
172 r = realloc_string_sub(str, envname, envval);
174 if (r == NULL) return NULL;
178 /*******************************************************************
179 Patch from jkf@soton.ac.uk
180 Added this to implement %p (NIS auto-map version of %H)
181 *******************************************************************/
183 static char *automount_path(const char *user_name)
185 static pstring server_path;
187 /* use the passwd entry as the default */
188 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
190 pstrcpy(server_path, get_user_home_dir(user_name));
192 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
194 if (lp_nis_home_map()) {
195 char *home_path_start;
196 char *automount_value = automount_lookup(user_name);
198 if(strlen(automount_value) > 0) {
199 home_path_start = strchr_m(automount_value,':');
200 if (home_path_start != NULL) {
201 DEBUG(5, ("NIS lookup succeeded. Home path is: %s\n",
202 home_path_start?(home_path_start+1):""));
203 pstrcpy(server_path, home_path_start+1);
206 /* NIS key lookup failed: default to user home directory from password file */
207 DEBUG(5, ("NIS lookup failed. Using Home path from passwd file. Home path is: %s\n", server_path ));
212 DEBUG(4,("Home server path: %s\n", server_path));
217 /*******************************************************************
218 Patch from jkf@soton.ac.uk
219 This is Luke's original function with the NIS lookup code
220 moved out to a separate function.
221 *******************************************************************/
223 static const char *automount_server(const char *user_name)
225 static pstring server_name;
226 const char *local_machine_name = get_local_machine_name();
228 /* use the local machine name as the default */
229 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
230 if (local_machine_name && *local_machine_name)
231 pstrcpy(server_name, local_machine_name);
233 pstrcpy(server_name, global_myname);
235 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
237 if (lp_nis_home_map()) {
239 char *automount_value = automount_lookup(user_name);
240 home_server_len = strcspn(automount_value,":");
241 DEBUG(5, ("NIS lookup succeeded. Home server length: %d\n",home_server_len));
242 if (home_server_len > sizeof(pstring))
243 home_server_len = sizeof(pstring);
244 strncpy(server_name, automount_value, home_server_len);
245 server_name[home_server_len] = '\0';
249 DEBUG(4,("Home server: %s\n", server_name));
254 /****************************************************************************
255 Do some standard substitutions in a string.
256 len is the length in bytes of the space allowed in string str. If zero means
257 don't allow expansions.
258 ****************************************************************************/
260 void standard_sub_basic(const char *smb_name, char *str,size_t len)
265 const char *local_machine_name = get_local_machine_name();
267 for (s=str; (p=strchr_m(s, '%'));s=p) {
270 int l = (int)len - (int)(p-str);
277 fstrcpy(tmp_str, smb_name);
279 string_sub(p,"%U",tmp_str,l);
282 fstrcpy(tmp_str, smb_name);
283 if ((pass = Get_Pwnam(tmp_str))!=NULL) {
284 string_sub(p,"%G",gidtoname(pass->pw_gid),l);
290 fstrcpy(tmp_str, current_user_info.domain);
292 string_sub(p,"%D", tmp_str,l);
295 string_sub(p,"%I", client_addr(),l);
298 if (local_machine_name && *local_machine_name)
299 string_sub(p,"%L", local_machine_name,l);
301 string_sub(p,"%L", global_myname,l);
304 string_sub(p,"%M", client_name(),l);
307 string_sub(p,"%R", remote_proto,l);
310 string_sub(p,"%T", timestring(False),l);
313 string_sub(p,"%a", remote_arch,l);
316 slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)sys_getpid());
317 string_sub(p,"%d", pidstr,l);
320 string_sub(p,"%h", myhostname(),l);
323 string_sub(p,"%m", get_remote_machine_name(),l);
326 string_sub(p,"%v", VERSION,l);
329 p += expand_env_var(p,l);
330 break; /* Expand environment variables */
333 break; /* don't run off the end of the string */
341 static void standard_sub_advanced(int snum, const char *user,
342 const char *connectpath, gid_t gid,
343 const char *smb_name, char *str, size_t len)
347 for (s=str; (p=strchr_m(s, '%'));s=p) {
348 int l = (int)len - (int)(p-str);
355 string_sub(p,"%N", automount_server(user),l);
358 if ((home = get_user_home_dir(user)))
359 string_sub(p,"%H",home, l);
364 string_sub(p,"%P", connectpath, l);
367 string_sub(p,"%S", lp_servicename(snum), l);
370 string_sub(p,"%g", gidtoname(gid), l);
373 string_sub(p,"%u", user, l);
376 /* Patch from jkf@soton.ac.uk Left the %N (NIS
377 * server name) in standard_sub_basic as it is
378 * a feature for logon servers, hence uses the
379 * username. The %p (NIS server path) code is
380 * here as it is used instead of the default
381 * "path =" string in [homes] and so needs the
382 * service name, not the username. */
384 string_sub(p,"%p", automount_path(lp_servicename(snum)), l);
388 break; /* don't run off the end of the string */
395 standard_sub_basic(smb_name, str, len);
398 /****************************************************************************
399 Do some standard substitutions in a string.
400 This function will return an allocated string that have to be freed.
401 ****************************************************************************/
403 char *talloc_sub_basic(TALLOC_CTX *mem_ctx, const char *smb_name, const char *str)
406 a = alloc_sub_basic(smb_name, str);
408 t = talloc_strdup(mem_ctx, a);
413 char *alloc_sub_basic(const char *smb_name, const char *str)
415 char *b, *p, *s, *t, *r, *a_string;
418 const char *local_machine_name = get_local_machine_name();
420 a_string = strdup(str);
421 if (a_string == NULL) {
422 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
426 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
433 r = strdup_lower(smb_name);
434 if (r == NULL) goto error;
435 t = realloc_string_sub(t, "%U", r);
438 r = strdup(smb_name);
439 if (r == NULL) goto error;
440 if ((pass = Get_Pwnam(r))!=NULL) {
441 t = realloc_string_sub(t, "%G", gidtoname(pass->pw_gid));
445 r = strdup_upper(current_user_info.domain);
446 if (r == NULL) goto error;
447 t = realloc_string_sub(t, "%D", r);
450 t = realloc_string_sub(t, "%I", client_addr());
453 if (local_machine_name && *local_machine_name)
454 t = realloc_string_sub(t, "%L", local_machine_name);
456 t = realloc_string_sub(t, "%L", global_myname);
459 t = realloc_string_sub(t, "%M", client_name());
462 t = realloc_string_sub(t, "%R", remote_proto);
465 t = realloc_string_sub(t, "%T", timestring(False));
468 t = realloc_string_sub(t, "%a", remote_arch);
471 slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)sys_getpid());
472 t = realloc_string_sub(t, "%d", pidstr);
475 t = realloc_string_sub(t, "%h", myhostname());
478 t = realloc_string_sub(t, "%m", remote_machine);
481 t = realloc_string_sub(t, "%v", VERSION);
484 t = realloc_expand_env_var(t, p); /* Expand environment variables */
493 if (t == NULL) goto error;
503 /****************************************************************************
504 Do some specific substitutions in a string.
505 This function will return an allocated string that have to be freed.
506 ****************************************************************************/
508 char *talloc_sub_specified(TALLOC_CTX *mem_ctx,
509 const char *input_string,
510 const char *username,
516 a = alloc_sub_specified(input_string, username, domain, uid, gid);
518 t = talloc_strdup(mem_ctx, a);
523 char *alloc_sub_specified(const char *input_string,
524 const char *username,
529 char *a_string, *ret_string;
532 a_string = strdup(input_string);
533 if (a_string == NULL) {
534 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
538 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
544 t = realloc_string_sub(t, "%U", username);
547 t = realloc_string_sub(t, "%u", username);
551 t = realloc_string_sub(t, "%G", gidtoname(gid));
553 t = realloc_string_sub(t, "%G", "NO_GROUP");
558 t = realloc_string_sub(t, "%g", gidtoname(gid));
560 t = realloc_string_sub(t, "%g", "NO_GROUP");
564 t = realloc_string_sub(t, "%D", domain);
567 t = realloc_string_sub(t, "%N", automount_server(username));
581 ret_string = alloc_sub_basic(username, a_string);
586 char *talloc_sub_advanced(TALLOC_CTX *mem_ctx,
589 const char *connectpath,
591 const char *smb_name,
595 a = alloc_sub_advanced(snum, user, connectpath, gid, smb_name, str);
597 t = talloc_strdup(mem_ctx, a);
602 char *alloc_sub_advanced(int snum, const char *user,
603 const char *connectpath, gid_t gid,
604 const char *smb_name, char *str)
606 char *a_string, *ret_string;
607 char *b, *p, *s, *t, *h;
609 a_string = strdup(str);
610 if (a_string == NULL) {
611 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
615 for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
621 t = realloc_string_sub(t, "%N", automount_server(user));
624 if ((h = get_user_home_dir(user)))
625 t = realloc_string_sub(t, "%H", h);
628 t = realloc_string_sub(t, "%P", connectpath);
631 t = realloc_string_sub(t, "%S", lp_servicename(snum));
634 t = realloc_string_sub(t, "%g", gidtoname(gid));
637 t = realloc_string_sub(t, "%u", user);
640 /* Patch from jkf@soton.ac.uk Left the %N (NIS
641 * server name) in standard_sub_basic as it is
642 * a feature for logon servers, hence uses the
643 * username. The %p (NIS server path) code is
644 * here as it is used instead of the default
645 * "path =" string in [homes] and so needs the
646 * service name, not the username. */
648 t = realloc_string_sub(t, "%p", automount_path(lp_servicename(snum)));
663 ret_string = alloc_sub_basic(smb_name, a_string);
668 /****************************************************************************
669 Do some standard substitutions in a string.
670 ****************************************************************************/
672 void standard_sub_conn(connection_struct *conn, char *str, size_t len)
674 standard_sub_advanced(SNUM(conn), conn->user, conn->connectpath,
675 conn->gid, current_user_info.smb_name, str, len);
678 /****************************************************************************
679 Like standard_sub but by snum.
680 ****************************************************************************/
682 void standard_sub_snum(int snum, char *str, size_t len)
684 extern struct current_user current_user;
685 static uid_t cached_uid = -1;
686 static fstring cached_user;
687 /* calling uidtoname() on every substitute would be too expensive, so
688 we cache the result here as nearly every call is for the same uid */
690 if (cached_uid != current_user.uid) {
691 fstrcpy(cached_user, uidtoname(current_user.uid));
692 cached_uid = current_user.uid;
695 standard_sub_advanced(snum, cached_user, "", -1,
696 current_user_info.smb_name, str, len);