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_char(tmp_local_machine
,' ',' ');
61 alpha_strcpy(local_machine
,tmp_local_machine
,SAFE_NETBIOS_CHARS
,sizeof(local_machine
)-1);
62 strlower_m(local_machine
);
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_char(tmp_remote_machine
,' ',' ');
83 alpha_strcpy(remote_machine
,tmp_remote_machine
,SAFE_NETBIOS_CHARS
,sizeof(remote_machine
)-1);
84 strlower_m(remote_machine
);
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();
101 /*******************************************************************
102 Setup the string used by %U substitution.
103 ********************************************************************/
105 void sub_set_smb_name(const char *name
)
109 /* don't let anonymous logins override the name */
114 trim_char(tmp
,' ',' ');
116 alpha_strcpy(smb_user_name
,tmp
,SAFE_NETBIOS_CHARS
,sizeof(smb_user_name
)-1);
119 /*******************************************************************
120 Setup the strings used by substitutions. Called per packet. Ensure
121 %U name is set correctly also.
122 ********************************************************************/
124 void set_current_user_info(const userdom_struct
*pcui
)
126 current_user_info
= *pcui
;
127 /* The following is safe as current_user_info.smb_name
128 * has already been sanitised in register_vuid. */
129 fstrcpy(smb_user_name
, current_user_info
.smb_name
);
132 /*******************************************************************
133 Given a pointer to a %$(NAME) expand it as an environment variable.
134 Return the number of characters by which the pointer should be advanced.
135 Based on code by Branko Cibej <branko.cibej@hermes.si>
136 When this is called p points at the '%' character.
137 ********************************************************************/
139 static size_t expand_env_var(char *p
, int len
)
153 * Look for the terminating ')'.
156 if ((q
= strchr_m(p
,')')) == NULL
) {
157 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p
));
162 * Extract the name from within the %$(NAME) string.
166 copylen
= MIN((q
-r
),(sizeof(envname
)-1));
167 strncpy(envname
,r
,copylen
);
168 envname
[copylen
] = '\0';
170 if ((envval
= getenv(envname
)) == NULL
) {
171 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname
));
176 * Copy the full %$(NAME) into envname so it
180 copylen
= MIN((q
+1-p
),(sizeof(envname
)-1));
181 strncpy(envname
,p
,copylen
);
182 envname
[copylen
] = '\0';
183 string_sub(p
,envname
,envval
,len
);
184 return 0; /* Allow the environment contents to be parsed. */
187 /*******************************************************************
188 Given a pointer to a %$(NAME) in p and the whole string in str
189 expand it as an environment variable.
190 Return a new allocated and expanded string.
191 Based on code by Branko Cibej <branko.cibej@hermes.si>
192 When this is called p points at the '%' character.
193 May substitute multiple occurrencies of the same env var.
194 ********************************************************************/
197 static char * realloc_expand_env_var(char *str
, char *p
)
204 if (p
[0] != '%' || p
[1] != '$' || p
[2] != '(')
208 * Look for the terminating ')'.
211 if ((q
= strchr_m(p
,')')) == NULL
) {
212 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p
));
217 * Extract the name from within the %$(NAME) string.
222 envname
= (char *)malloc(copylen
+ 1 + 4); /* reserve space for use later add %$() chars */
223 if (envname
== NULL
) return NULL
;
224 strncpy(envname
,r
,copylen
);
225 envname
[copylen
] = '\0';
227 if ((envval
= getenv(envname
)) == NULL
) {
228 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname
));
234 * Copy the full %$(NAME) into envname so it
239 strncpy(envname
,p
,copylen
);
240 envname
[copylen
] = '\0';
241 r
= realloc_string_sub(str
, envname
, envval
);
243 if (r
== NULL
) return NULL
;
247 /*******************************************************************
248 Patch from jkf@soton.ac.uk
249 Added this to implement %p (NIS auto-map version of %H)
250 *******************************************************************/
252 static char *automount_path(const char *user_name
)
254 static pstring server_path
;
256 /* use the passwd entry as the default */
257 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
259 pstrcpy(server_path
, get_user_home_dir(user_name
));
261 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
263 if (lp_nis_home_map()) {
264 char *home_path_start
;
265 char *automount_value
= automount_lookup(user_name
);
267 if(strlen(automount_value
) > 0) {
268 home_path_start
= strchr_m(automount_value
,':');
269 if (home_path_start
!= NULL
) {
270 DEBUG(5, ("NIS lookup succeeded. Home path is: %s\n",
271 home_path_start
?(home_path_start
+1):""));
272 pstrcpy(server_path
, home_path_start
+1);
275 /* NIS key lookup failed: default to user home directory from password file */
276 DEBUG(5, ("NIS lookup failed. Using Home path from passwd file. Home path is: %s\n", server_path
));
281 DEBUG(4,("Home server path: %s\n", server_path
));
286 /*******************************************************************
287 Patch from jkf@soton.ac.uk
288 This is Luke's original function with the NIS lookup code
289 moved out to a separate function.
290 *******************************************************************/
292 static const char *automount_server(const char *user_name
)
294 static pstring server_name
;
295 const char *local_machine_name
= get_local_machine_name();
297 /* use the local machine name as the default */
298 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
299 if (local_machine_name
&& *local_machine_name
)
300 pstrcpy(server_name
, local_machine_name
);
302 pstrcpy(server_name
, global_myname());
304 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
306 if (lp_nis_home_map()) {
308 char *automount_value
= automount_lookup(user_name
);
309 home_server_len
= strcspn(automount_value
,":");
310 DEBUG(5, ("NIS lookup succeeded. Home server length: %d\n",home_server_len
));
311 if (home_server_len
> sizeof(pstring
))
312 home_server_len
= sizeof(pstring
);
313 strncpy(server_name
, automount_value
, home_server_len
);
314 server_name
[home_server_len
] = '\0';
318 DEBUG(4,("Home server: %s\n", server_name
));
323 /****************************************************************************
324 Do some standard substitutions in a string.
325 len is the length in bytes of the space allowed in string str. If zero means
326 don't allow expansions.
327 ****************************************************************************/
329 void standard_sub_basic(const char *smb_name
, char *str
,size_t len
)
334 const char *local_machine_name
= get_local_machine_name();
336 for (s
=str
; (p
=strchr_m(s
, '%'));s
=p
) {
339 int l
= (int)len
- (int)(p
-str
);
346 fstrcpy(tmp_str
, smb_name
);
348 string_sub(p
,"%U",tmp_str
,l
);
351 fstrcpy(tmp_str
, smb_name
);
352 if ((pass
= Get_Pwnam(tmp_str
))!=NULL
) {
353 string_sub(p
,"%G",gidtoname(pass
->pw_gid
),l
);
359 fstrcpy(tmp_str
, current_user_info
.domain
);
361 string_sub(p
,"%D", tmp_str
,l
);
364 string_sub(p
,"%I", client_addr(),l
);
367 if (local_machine_name
&& *local_machine_name
)
368 string_sub(p
,"%L", local_machine_name
,l
);
372 pstrcpy(temp_name
, global_myname());
373 strlower_m(temp_name
);
374 string_sub(p
,"%L", temp_name
,l
);
378 string_sub(p
,"%M", client_name(),l
);
381 string_sub(p
,"%R", remote_proto
,l
);
384 string_sub(p
,"%T", timestring(False
),l
);
387 string_sub(p
,"%a", remote_arch
,l
);
390 slprintf(pidstr
,sizeof(pidstr
)-1, "%d",(int)sys_getpid());
391 string_sub(p
,"%d", pidstr
,l
);
394 string_sub(p
,"%h", myhostname(),l
);
397 string_sub(p
,"%m", get_remote_machine_name(),l
);
400 string_sub(p
,"%v", SAMBA_VERSION_STRING
,l
);
403 p
+= expand_env_var(p
,l
);
404 break; /* Expand environment variables */
407 break; /* don't run off the end of the string */
415 static void standard_sub_advanced(int snum
, const char *user
,
416 const char *connectpath
, gid_t gid
,
417 const char *smb_name
, char *str
, size_t len
)
421 for (s
=str
; (p
=strchr_m(s
, '%'));s
=p
) {
422 int l
= (int)len
- (int)(p
-str
);
429 string_sub(p
,"%N", automount_server(user
),l
);
432 if ((home
= get_user_home_dir(user
)))
433 string_sub(p
,"%H",home
, l
);
438 string_sub(p
,"%P", connectpath
, l
);
441 string_sub(p
,"%S", lp_servicename(snum
), l
);
444 string_sub(p
,"%g", gidtoname(gid
), l
);
447 string_sub(p
,"%u", user
, l
);
450 /* Patch from jkf@soton.ac.uk Left the %N (NIS
451 * server name) in standard_sub_basic as it is
452 * a feature for logon servers, hence uses the
453 * username. The %p (NIS server path) code is
454 * here as it is used instead of the default
455 * "path =" string in [homes] and so needs the
456 * service name, not the username. */
458 string_sub(p
,"%p", automount_path(lp_servicename(snum
)), l
);
462 break; /* don't run off the end of the string */
469 standard_sub_basic(smb_name
, str
, len
);
472 /****************************************************************************
473 Do some standard substitutions in a string.
474 This function will return an allocated string that have to be freed.
475 ****************************************************************************/
477 char *talloc_sub_basic(TALLOC_CTX
*mem_ctx
, const char *smb_name
, const char *str
)
480 a
= alloc_sub_basic(smb_name
, str
);
482 t
= talloc_strdup(mem_ctx
, a
);
487 char *alloc_sub_basic(const char *smb_name
, const char *str
)
489 char *b
, *p
, *s
, *t
, *r
, *a_string
;
492 const char *local_machine_name
= get_local_machine_name();
494 a_string
= strdup(str
);
495 if (a_string
== NULL
) {
496 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
500 for (b
= s
= a_string
; (p
= strchr_m(s
, '%')); s
= a_string
+ (p
- b
)) {
507 r
= strdup_lower(smb_name
);
508 if (r
== NULL
) goto error
;
509 t
= realloc_string_sub(t
, "%U", r
);
512 r
= strdup(smb_name
);
513 if (r
== NULL
) goto error
;
514 if ((pass
= Get_Pwnam(r
))!=NULL
) {
515 t
= realloc_string_sub(t
, "%G", gidtoname(pass
->pw_gid
));
519 r
= strdup_upper(current_user_info
.domain
);
520 if (r
== NULL
) goto error
;
521 t
= realloc_string_sub(t
, "%D", r
);
524 t
= realloc_string_sub(t
, "%I", client_addr());
527 if (local_machine_name
&& *local_machine_name
)
528 t
= realloc_string_sub(t
, "%L", local_machine_name
);
530 t
= realloc_string_sub(t
, "%L", global_myname());
533 t
= realloc_string_sub(t
, "%M", client_name());
536 t
= realloc_string_sub(t
, "%R", remote_proto
);
539 t
= realloc_string_sub(t
, "%T", timestring(False
));
542 t
= realloc_string_sub(t
, "%a", remote_arch
);
545 slprintf(pidstr
,sizeof(pidstr
)-1, "%d",(int)sys_getpid());
546 t
= realloc_string_sub(t
, "%d", pidstr
);
549 t
= realloc_string_sub(t
, "%h", myhostname());
552 t
= realloc_string_sub(t
, "%m", remote_machine
);
555 t
= realloc_string_sub(t
, "%v", SAMBA_VERSION_STRING
);
558 t
= realloc_expand_env_var(t
, p
); /* Expand environment variables */
567 if (t
== NULL
) goto error
;
577 /****************************************************************************
578 Do some specific substitutions in a string.
579 This function will return an allocated string that have to be freed.
580 ****************************************************************************/
582 char *talloc_sub_specified(TALLOC_CTX
*mem_ctx
,
583 const char *input_string
,
584 const char *username
,
590 a
= alloc_sub_specified(input_string
, username
, domain
, uid
, gid
);
592 t
= talloc_strdup(mem_ctx
, a
);
597 char *alloc_sub_specified(const char *input_string
,
598 const char *username
,
603 char *a_string
, *ret_string
;
606 a_string
= strdup(input_string
);
607 if (a_string
== NULL
) {
608 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
612 for (b
= s
= a_string
; (p
= strchr_m(s
, '%')); s
= a_string
+ (p
- b
)) {
618 t
= realloc_string_sub(t
, "%U", username
);
621 t
= realloc_string_sub(t
, "%u", username
);
625 t
= realloc_string_sub(t
, "%G", gidtoname(gid
));
627 t
= realloc_string_sub(t
, "%G", "NO_GROUP");
632 t
= realloc_string_sub(t
, "%g", gidtoname(gid
));
634 t
= realloc_string_sub(t
, "%g", "NO_GROUP");
638 t
= realloc_string_sub(t
, "%D", domain
);
641 t
= realloc_string_sub(t
, "%N", automount_server(username
));
655 ret_string
= alloc_sub_basic(username
, a_string
);
660 char *talloc_sub_advanced(TALLOC_CTX
*mem_ctx
,
663 const char *connectpath
,
665 const char *smb_name
,
669 a
= alloc_sub_advanced(snum
, user
, connectpath
, gid
, smb_name
, str
);
671 t
= talloc_strdup(mem_ctx
, a
);
676 char *alloc_sub_advanced(int snum
, const char *user
,
677 const char *connectpath
, gid_t gid
,
678 const char *smb_name
, const char *str
)
680 char *a_string
, *ret_string
;
681 char *b
, *p
, *s
, *t
, *h
;
683 a_string
= strdup(str
);
684 if (a_string
== NULL
) {
685 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
689 for (b
= s
= a_string
; (p
= strchr_m(s
, '%')); s
= a_string
+ (p
- b
)) {
695 t
= realloc_string_sub(t
, "%N", automount_server(user
));
698 if ((h
= get_user_home_dir(user
)))
699 t
= realloc_string_sub(t
, "%H", h
);
702 t
= realloc_string_sub(t
, "%P", connectpath
);
705 t
= realloc_string_sub(t
, "%S", lp_servicename(snum
));
708 t
= realloc_string_sub(t
, "%g", gidtoname(gid
));
711 t
= realloc_string_sub(t
, "%u", user
);
714 /* Patch from jkf@soton.ac.uk Left the %N (NIS
715 * server name) in standard_sub_basic as it is
716 * a feature for logon servers, hence uses the
717 * username. The %p (NIS server path) code is
718 * here as it is used instead of the default
719 * "path =" string in [homes] and so needs the
720 * service name, not the username. */
722 t
= realloc_string_sub(t
, "%p", automount_path(lp_servicename(snum
)));
737 ret_string
= alloc_sub_basic(smb_name
, a_string
);
742 /****************************************************************************
743 Do some standard substitutions in a string.
744 ****************************************************************************/
746 void standard_sub_conn(connection_struct
*conn
, char *str
, size_t len
)
748 standard_sub_advanced(SNUM(conn
), conn
->user
, conn
->connectpath
,
749 conn
->gid
, smb_user_name
, str
, len
);
752 char *talloc_sub_conn(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
, const char *str
)
754 return talloc_sub_advanced(mem_ctx
, SNUM(conn
), conn
->user
,
755 conn
->connectpath
, conn
->gid
,
759 char *alloc_sub_conn(connection_struct
*conn
, const char *str
)
761 return alloc_sub_advanced(SNUM(conn
), conn
->user
, conn
->connectpath
,
762 conn
->gid
, smb_user_name
, str
);
765 /****************************************************************************
766 Like standard_sub but by snum.
767 ****************************************************************************/
769 void standard_sub_snum(int snum
, char *str
, size_t len
)
771 extern struct current_user current_user
;
772 static uid_t cached_uid
= -1;
773 static fstring cached_user
;
774 /* calling uidtoname() on every substitute would be too expensive, so
775 we cache the result here as nearly every call is for the same uid */
777 if (cached_uid
!= current_user
.uid
) {
778 fstrcpy(cached_user
, uidtoname(current_user
.uid
));
779 cached_uid
= current_user
.uid
;
782 standard_sub_advanced(snum
, cached_user
, "", -1,
783 smb_user_name
, str
, len
);