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 (strequal(local_name
, "*SMBSERVER"))
51 if (strequal(local_name
, "*SMBSERV"))
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 char* sub_get_smb_name( void )
121 return smb_user_name
;
124 /*******************************************************************
125 Setup the strings used by substitutions. Called per packet. Ensure
126 %U name is set correctly also.
127 ********************************************************************/
129 void set_current_user_info(const userdom_struct
*pcui
)
131 current_user_info
= *pcui
;
132 /* The following is safe as current_user_info.smb_name
133 * has already been sanitised in register_vuid. */
134 fstrcpy(smb_user_name
, current_user_info
.smb_name
);
137 /*******************************************************************
138 Given a pointer to a %$(NAME) expand it as an environment variable.
139 Return the number of characters by which the pointer should be advanced.
140 Based on code by Branko Cibej <branko.cibej@hermes.si>
141 When this is called p points at the '%' character.
142 ********************************************************************/
144 static size_t expand_env_var(char *p
, int len
)
158 * Look for the terminating ')'.
161 if ((q
= strchr_m(p
,')')) == NULL
) {
162 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p
));
167 * Extract the name from within the %$(NAME) string.
171 copylen
= MIN((q
-r
),(sizeof(envname
)-1));
172 strncpy(envname
,r
,copylen
);
173 envname
[copylen
] = '\0';
175 if ((envval
= getenv(envname
)) == NULL
) {
176 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname
));
181 * Copy the full %$(NAME) into envname so it
185 copylen
= MIN((q
+1-p
),(sizeof(envname
)-1));
186 strncpy(envname
,p
,copylen
);
187 envname
[copylen
] = '\0';
188 string_sub(p
,envname
,envval
,len
);
189 return 0; /* Allow the environment contents to be parsed. */
192 /*******************************************************************
193 Given a pointer to a %$(NAME) in p and the whole string in str
194 expand it as an environment variable.
195 Return a new allocated and expanded string.
196 Based on code by Branko Cibej <branko.cibej@hermes.si>
197 When this is called p points at the '%' character.
198 May substitute multiple occurrencies of the same env var.
199 ********************************************************************/
202 static char * realloc_expand_env_var(char *str
, char *p
)
209 if (p
[0] != '%' || p
[1] != '$' || p
[2] != '(')
213 * Look for the terminating ')'.
216 if ((q
= strchr_m(p
,')')) == NULL
) {
217 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p
));
222 * Extract the name from within the %$(NAME) string.
227 envname
= (char *)malloc(copylen
+ 1 + 4); /* reserve space for use later add %$() chars */
228 if (envname
== NULL
) return NULL
;
229 strncpy(envname
,r
,copylen
);
230 envname
[copylen
] = '\0';
232 if ((envval
= getenv(envname
)) == NULL
) {
233 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname
));
239 * Copy the full %$(NAME) into envname so it
244 strncpy(envname
,p
,copylen
);
245 envname
[copylen
] = '\0';
246 r
= realloc_string_sub(str
, envname
, envval
);
248 if (r
== NULL
) return NULL
;
252 /*******************************************************************
253 Patch from jkf@soton.ac.uk
254 Added this to implement %p (NIS auto-map version of %H)
255 *******************************************************************/
257 static char *automount_path(const char *user_name
)
259 static pstring server_path
;
261 /* use the passwd entry as the default */
262 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
264 pstrcpy(server_path
, get_user_home_dir(user_name
));
266 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
268 if (lp_nis_home_map()) {
269 char *home_path_start
;
270 char *automount_value
= automount_lookup(user_name
);
272 if(strlen(automount_value
) > 0) {
273 home_path_start
= strchr_m(automount_value
,':');
274 if (home_path_start
!= NULL
) {
275 DEBUG(5, ("NIS lookup succeeded. Home path is: %s\n",
276 home_path_start
?(home_path_start
+1):""));
277 pstrcpy(server_path
, home_path_start
+1);
280 /* NIS key lookup failed: default to user home directory from password file */
281 DEBUG(5, ("NIS lookup failed. Using Home path from passwd file. Home path is: %s\n", server_path
));
286 DEBUG(4,("Home server path: %s\n", server_path
));
291 /*******************************************************************
292 Patch from jkf@soton.ac.uk
293 This is Luke's original function with the NIS lookup code
294 moved out to a separate function.
295 *******************************************************************/
297 static const char *automount_server(const char *user_name
)
299 static pstring server_name
;
300 const char *local_machine_name
= get_local_machine_name();
302 /* use the local machine name as the default */
303 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
304 if (local_machine_name
&& *local_machine_name
)
305 pstrcpy(server_name
, local_machine_name
);
307 pstrcpy(server_name
, global_myname());
309 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
311 if (lp_nis_home_map()) {
313 char *automount_value
= automount_lookup(user_name
);
314 home_server_len
= strcspn(automount_value
,":");
315 DEBUG(5, ("NIS lookup succeeded. Home server length: %d\n",home_server_len
));
316 if (home_server_len
> sizeof(pstring
))
317 home_server_len
= sizeof(pstring
);
318 strncpy(server_name
, automount_value
, home_server_len
);
319 server_name
[home_server_len
] = '\0';
323 DEBUG(4,("Home server: %s\n", server_name
));
328 /****************************************************************************
329 Do some standard substitutions in a string.
330 len is the length in bytes of the space allowed in string str. If zero means
331 don't allow expansions.
332 ****************************************************************************/
334 void standard_sub_basic(const char *smb_name
, char *str
,size_t len
)
339 const char *local_machine_name
= get_local_machine_name();
341 for (s
=str
; (p
=strchr_m(s
, '%'));s
=p
) {
344 int l
= (int)len
- (int)(p
-str
);
351 fstrcpy(tmp_str
, smb_name
);
353 string_sub(p
,"%U",tmp_str
,l
);
356 fstrcpy(tmp_str
, smb_name
);
357 if ((pass
= Get_Pwnam(tmp_str
))!=NULL
) {
358 string_sub(p
,"%G",gidtoname(pass
->pw_gid
),l
);
364 fstrcpy(tmp_str
, current_user_info
.domain
);
366 string_sub(p
,"%D", tmp_str
,l
);
369 string_sub(p
,"%I", client_addr(),l
);
372 string_sub(p
,"%i", client_socket_addr(),l
);
375 if (local_machine_name
&& *local_machine_name
)
376 string_sub(p
,"%L", local_machine_name
,l
);
380 pstrcpy(temp_name
, global_myname());
381 strlower_m(temp_name
);
382 string_sub(p
,"%L", temp_name
,l
);
386 string_sub(p
,"%M", client_name(),l
);
389 string_sub(p
,"%R", remote_proto
,l
);
392 string_sub(p
,"%T", timestring(False
),l
);
395 string_sub(p
,"%a", remote_arch
,l
);
398 slprintf(pidstr
,sizeof(pidstr
)-1, "%d",(int)sys_getpid());
399 string_sub(p
,"%d", pidstr
,l
);
402 string_sub(p
,"%h", myhostname(),l
);
405 string_sub(p
,"%m", get_remote_machine_name(),l
);
408 string_sub(p
,"%v", SAMBA_VERSION_STRING
,l
);
411 p
+= expand_env_var(p
,l
);
412 break; /* Expand environment variables */
415 break; /* don't run off the end of the string */
423 static void standard_sub_advanced(int snum
, const char *user
,
424 const char *connectpath
, gid_t gid
,
425 const char *smb_name
, char *str
, size_t len
)
429 for (s
=str
; (p
=strchr_m(s
, '%'));s
=p
) {
430 int l
= (int)len
- (int)(p
-str
);
437 string_sub(p
,"%N", automount_server(user
),l
);
440 if ((home
= get_user_home_dir(user
)))
441 string_sub(p
,"%H",home
, l
);
446 string_sub(p
,"%P", connectpath
, l
);
449 string_sub(p
,"%S", lp_servicename(snum
), l
);
452 string_sub(p
,"%g", gidtoname(gid
), l
);
455 string_sub(p
,"%u", user
, l
);
458 /* Patch from jkf@soton.ac.uk Left the %N (NIS
459 * server name) in standard_sub_basic as it is
460 * a feature for logon servers, hence uses the
461 * username. The %p (NIS server path) code is
462 * here as it is used instead of the default
463 * "path =" string in [homes] and so needs the
464 * service name, not the username. */
466 string_sub(p
,"%p", automount_path(lp_servicename(snum
)), l
);
470 break; /* don't run off the end of the string */
477 standard_sub_basic(smb_name
, str
, len
);
480 /****************************************************************************
481 Do some standard substitutions in a string.
482 This function will return an allocated string that have to be freed.
483 ****************************************************************************/
485 char *talloc_sub_basic(TALLOC_CTX
*mem_ctx
, const char *smb_name
, const char *str
)
488 a
= alloc_sub_basic(smb_name
, str
);
490 t
= talloc_strdup(mem_ctx
, a
);
495 char *alloc_sub_basic(const char *smb_name
, const char *str
)
497 char *b
, *p
, *s
, *t
, *r
, *a_string
;
500 const char *local_machine_name
= get_local_machine_name();
502 /* workaround to prevent a crash while lookinf at bug #687 */
505 DEBUG(0,("alloc_sub_basic: NULL source string! This should not happen\n"));
509 a_string
= strdup(str
);
510 if (a_string
== NULL
) {
511 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
515 for (b
= s
= a_string
; (p
= strchr_m(s
, '%')); s
= a_string
+ (p
- b
)) {
522 r
= strdup_lower(smb_name
);
523 if (r
== NULL
) goto error
;
524 t
= realloc_string_sub(t
, "%U", r
);
527 r
= strdup(smb_name
);
528 if (r
== NULL
) goto error
;
529 if ((pass
= Get_Pwnam(r
))!=NULL
) {
530 t
= realloc_string_sub(t
, "%G", gidtoname(pass
->pw_gid
));
534 r
= strdup_upper(current_user_info
.domain
);
535 if (r
== NULL
) goto error
;
536 t
= realloc_string_sub(t
, "%D", r
);
539 t
= realloc_string_sub(t
, "%I", client_addr());
542 if (local_machine_name
&& *local_machine_name
)
543 t
= realloc_string_sub(t
, "%L", local_machine_name
);
545 t
= realloc_string_sub(t
, "%L", global_myname());
548 t
= realloc_string_sub(t
, "%N", automount_server(smb_name
));
551 t
= realloc_string_sub(t
, "%M", client_name());
554 t
= realloc_string_sub(t
, "%R", remote_proto
);
557 t
= realloc_string_sub(t
, "%T", timestring(False
));
560 t
= realloc_string_sub(t
, "%a", remote_arch
);
563 slprintf(pidstr
,sizeof(pidstr
)-1, "%d",(int)sys_getpid());
564 t
= realloc_string_sub(t
, "%d", pidstr
);
567 t
= realloc_string_sub(t
, "%h", myhostname());
570 t
= realloc_string_sub(t
, "%m", remote_machine
);
573 t
= realloc_string_sub(t
, "%v", SAMBA_VERSION_STRING
);
576 t
= realloc_expand_env_var(t
, p
); /* Expand environment variables */
585 if (t
== NULL
) goto error
;
595 /****************************************************************************
596 Do some specific substitutions in a string.
597 This function will return an allocated string that have to be freed.
598 ****************************************************************************/
600 char *talloc_sub_specified(TALLOC_CTX
*mem_ctx
,
601 const char *input_string
,
602 const char *username
,
608 a
= alloc_sub_specified(input_string
, username
, domain
, uid
, gid
);
610 t
= talloc_strdup(mem_ctx
, a
);
615 char *alloc_sub_specified(const char *input_string
,
616 const char *username
,
621 char *a_string
, *ret_string
;
624 a_string
= strdup(input_string
);
625 if (a_string
== NULL
) {
626 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
630 for (b
= s
= a_string
; (p
= strchr_m(s
, '%')); s
= a_string
+ (p
- b
)) {
636 t
= realloc_string_sub(t
, "%U", username
);
639 t
= realloc_string_sub(t
, "%u", username
);
643 t
= realloc_string_sub(t
, "%G", gidtoname(gid
));
645 t
= realloc_string_sub(t
, "%G", "NO_GROUP");
650 t
= realloc_string_sub(t
, "%g", gidtoname(gid
));
652 t
= realloc_string_sub(t
, "%g", "NO_GROUP");
656 t
= realloc_string_sub(t
, "%D", domain
);
659 t
= realloc_string_sub(t
, "%N", automount_server(username
));
673 ret_string
= alloc_sub_basic(username
, a_string
);
678 char *talloc_sub_advanced(TALLOC_CTX
*mem_ctx
,
681 const char *connectpath
,
683 const char *smb_name
,
687 a
= alloc_sub_advanced(snum
, user
, connectpath
, gid
, smb_name
, str
);
689 t
= talloc_strdup(mem_ctx
, a
);
694 char *alloc_sub_advanced(int snum
, const char *user
,
695 const char *connectpath
, gid_t gid
,
696 const char *smb_name
, const char *str
)
698 char *a_string
, *ret_string
;
699 char *b
, *p
, *s
, *t
, *h
;
701 a_string
= strdup(str
);
702 if (a_string
== NULL
) {
703 DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
707 for (b
= s
= a_string
; (p
= strchr_m(s
, '%')); s
= a_string
+ (p
- b
)) {
713 t
= realloc_string_sub(t
, "%N", automount_server(user
));
716 if ((h
= get_user_home_dir(user
)))
717 t
= realloc_string_sub(t
, "%H", h
);
720 t
= realloc_string_sub(t
, "%P", connectpath
);
723 t
= realloc_string_sub(t
, "%S", lp_servicename(snum
));
726 t
= realloc_string_sub(t
, "%g", gidtoname(gid
));
729 t
= realloc_string_sub(t
, "%u", user
);
732 /* Patch from jkf@soton.ac.uk Left the %N (NIS
733 * server name) in standard_sub_basic as it is
734 * a feature for logon servers, hence uses the
735 * username. The %p (NIS server path) code is
736 * here as it is used instead of the default
737 * "path =" string in [homes] and so needs the
738 * service name, not the username. */
740 t
= realloc_string_sub(t
, "%p", automount_path(lp_servicename(snum
)));
755 ret_string
= alloc_sub_basic(smb_name
, a_string
);
760 /****************************************************************************
761 Do some standard substitutions in a string.
762 ****************************************************************************/
764 void standard_sub_conn(connection_struct
*conn
, char *str
, size_t len
)
766 standard_sub_advanced(SNUM(conn
), conn
->user
, conn
->connectpath
,
767 conn
->gid
, smb_user_name
, str
, len
);
770 char *talloc_sub_conn(TALLOC_CTX
*mem_ctx
, connection_struct
*conn
, const char *str
)
772 return talloc_sub_advanced(mem_ctx
, SNUM(conn
), conn
->user
,
773 conn
->connectpath
, conn
->gid
,
777 char *alloc_sub_conn(connection_struct
*conn
, const char *str
)
779 return alloc_sub_advanced(SNUM(conn
), conn
->user
, conn
->connectpath
,
780 conn
->gid
, smb_user_name
, str
);
783 /****************************************************************************
784 Like standard_sub but by snum.
785 ****************************************************************************/
787 void standard_sub_snum(int snum
, char *str
, size_t len
)
789 extern struct current_user current_user
;
790 static uid_t cached_uid
= -1;
791 static fstring cached_user
;
792 /* calling uidtoname() on every substitute would be too expensive, so
793 we cache the result here as nearly every call is for the same uid */
795 if (cached_uid
!= current_user
.uid
) {
796 fstrcpy(cached_user
, uidtoname(current_user
.uid
));
797 cached_uid
= current_user
.uid
;
800 standard_sub_advanced(snum
, cached_user
, "", -1,
801 smb_user_name
, str
, len
);