2 Unix SMB/Netbios implementation.
4 string substitution functions
5 Copyright (C) Andrew Tridgell 1992-2000
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 fstring local_machine
="";
26 fstring remote_arch
="UNKNOWN";
27 userdom_struct current_user_info
;
28 pstring samlogon_user
="";
29 BOOL sam_logon_in_ssb
= False
;
30 fstring remote_proto
="UNKNOWN";
31 fstring remote_machine
="";
34 /*******************************************************************
35 Given a pointer to a %$(NAME) expand it as an environment variable.
36 Return the number of characters by which the pointer should be advanced.
37 Based on code by Branko Cibej <branko.cibej@hermes.si>
38 When this is called p points at the '%' character.
39 ********************************************************************/
41 static size_t expand_env_var(char *p
, int len
)
55 * Look for the terminating ')'.
58 if ((q
= strchr(p
,')')) == NULL
) {
59 DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p
));
64 * Extract the name from within the %$(NAME) string.
68 copylen
= MIN((q
-r
),(sizeof(envname
)-1));
69 strncpy(envname
,r
,copylen
);
70 envname
[copylen
] = '\0';
72 if ((envval
= getenv(envname
)) == NULL
) {
73 DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname
));
78 * Copy the full %$(NAME) into envname so it
82 copylen
= MIN((q
+1-p
),(sizeof(envname
)-1));
83 strncpy(envname
,p
,copylen
);
84 envname
[copylen
] = '\0';
85 string_sub(p
,envname
,envval
,len
);
86 return 0; /* Allow the environment contents to be parsed. */
89 /*******************************************************************
90 Patch from jkf@soton.ac.uk
91 Added this to implement %p (NIS auto-map version of %H)
92 *******************************************************************/
94 static char *automount_path(char *user_name
)
96 static pstring server_path
;
98 /* use the passwd entry as the default */
99 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
101 pstrcpy(server_path
, get_user_home_dir(user_name
));
103 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
105 if (lp_nis_home_map()) {
106 char *home_path_start
;
107 char *automount_value
= automount_lookup(user_name
);
109 if(strlen(automount_value
) > 0) {
110 home_path_start
= strchr(automount_value
,':');
111 if (home_path_start
!= NULL
) {
112 DEBUG(5, ("NIS lookup succeeded. Home path is: %s\n",
113 home_path_start
?(home_path_start
+1):""));
114 pstrcpy(server_path
, home_path_start
+1);
117 /* NIS key lookup failed: default to user home directory from password file */
118 DEBUG(5, ("NIS lookup failed. Using Home path from passwd file. Home path is: %s\n", server_path
));
123 DEBUG(4,("Home server path: %s\n", server_path
));
128 /*******************************************************************
129 Patch from jkf@soton.ac.uk
130 This is Luke's original function with the NIS lookup code
131 moved out to a separate function.
132 *******************************************************************/
134 static char *automount_server(char *user_name
)
136 extern pstring global_myname
;
137 static pstring server_name
;
139 /* use the local machine name as the default */
140 /* this will be the default if WITH_AUTOMOUNT is not used or fails */
142 pstrcpy(server_name
, local_machine
);
144 pstrcpy(server_name
, global_myname
);
146 #if (defined(HAVE_NETGROUP) && defined (WITH_AUTOMOUNT))
148 if (lp_nis_home_map()) {
150 char *automount_value
= automount_lookup(user_name
);
151 home_server_len
= strcspn(automount_value
,":");
152 DEBUG(5, ("NIS lookup succeeded. Home server length: %d\n",home_server_len
));
153 if (home_server_len
> sizeof(pstring
))
154 home_server_len
= sizeof(pstring
);
155 strncpy(server_name
, automount_value
, home_server_len
);
156 server_name
[home_server_len
] = '\0';
160 DEBUG(4,("Home server: %s\n", server_name
));
165 /****************************************************************************
166 Do some standard substitutions in a string.
167 ****************************************************************************/
169 void standard_sub_basic(char *str
)
175 for (s
=str
; (p
=strchr(s
, '%'));s
=p
) {
178 int l
= sizeof(pstring
) - (int)(p
-str
);
182 fstrcpy(tmp_str
, sam_logon_in_ssb
?samlogon_user
:current_user_info
.smb_name
);
184 string_sub(p
,"%U",tmp_str
,l
);
187 fstrcpy(tmp_str
, sam_logon_in_ssb
?samlogon_user
:current_user_info
.smb_name
);
188 if ((pass
= Get_Pwnam(tmp_str
, False
))!=NULL
) {
189 string_sub(p
,"%G",gidtoname(pass
->pw_gid
),l
);
195 fstrcpy(tmp_str
, current_user_info
.domain
);
197 string_sub(p
,"%D", tmp_str
,l
);
199 case 'I' : string_sub(p
,"%I", client_addr(),l
); break;
200 case 'L' : string_sub(p
,"%L", local_machine
,l
); break;
201 case 'M' : string_sub(p
,"%M", client_name(),l
); break;
202 case 'R' : string_sub(p
,"%R", remote_proto
,l
); break;
203 case 'T' : string_sub(p
,"%T", timestring(False
),l
); break;
204 case 'a' : string_sub(p
,"%a", remote_arch
,l
); break;
206 slprintf(pidstr
,sizeof(pidstr
)-1, "%d",(int)sys_getpid());
207 string_sub(p
,"%d", pidstr
,l
);
209 case 'h' : string_sub(p
,"%h", myhostname(),l
); break;
210 case 'm' : string_sub(p
,"%m", remote_machine
,l
); break;
211 case 'v' : string_sub(p
,"%v", VERSION
,l
); break;
212 case '$' : p
+= expand_env_var(p
,l
); break; /* Expand environment variables */
215 break; /* don't run off the end of the string */
223 /****************************************************************************
224 Do some standard substitutions in a string.
225 ****************************************************************************/
227 void standard_sub_advanced(int snum
, char *user
, char *connectpath
, gid_t gid
, char *str
)
231 for (s
=str
; (p
=strchr(s
, '%'));s
=p
) {
232 int l
= sizeof(pstring
) - (int)(p
-str
);
235 case 'N' : string_sub(p
,"%N", automount_server(user
),l
); break;
237 if ((home
= get_user_home_dir(user
))) {
238 string_sub(p
,"%H",home
, l
);
244 string_sub(p
,"%P", connectpath
, l
);
248 string_sub(p
,"%S", lp_servicename(snum
), l
);
252 string_sub(p
,"%g", gidtoname(gid
), l
);
255 string_sub(p
,"%u", user
, l
);
258 /* Patch from jkf@soton.ac.uk Left the %N (NIS
259 * server name) in standard_sub_basic as it is
260 * a feature for logon servers, hence uses the
261 * username. The %p (NIS server path) code is
262 * here as it is used instead of the default
263 * "path =" string in [homes] and so needs the
264 * service name, not the username. */
266 string_sub(p
,"%p", automount_path(lp_servicename(snum
)), l
);
270 break; /* don't run off the end of the string */
277 standard_sub_basic(str
);
280 /****************************************************************************
281 Do some standard substitutions in a string.
282 ****************************************************************************/
284 void standard_sub_conn(connection_struct
*conn
, char *str
)
286 standard_sub_advanced(SNUM(conn
), conn
->user
, conn
->connectpath
, conn
->gid
, str
);
289 /****************************************************************************
290 Like standard_sub but for a homes share where snum still points to the [homes]
291 share. No user specific snum created yet so servicename should be the username.
292 ****************************************************************************/
294 void standard_sub_home(int snum
, char *user
, char *str
)
298 for (s
=str
; (p
=strchr(s
, '%'));s
=p
) {
299 int l
= sizeof(pstring
) - (int)(p
-str
);
303 string_sub(p
,"%S", user
, l
);
306 string_sub(p
,"%p", automount_path(user
), l
);
310 break; /* don't run off the end of the string */
317 standard_sub_advanced(snum
, user
, "", -1, str
);
320 /****************************************************************************
321 Like standard_sub but by snum.
322 ****************************************************************************/
324 void standard_sub_snum(int snum
, char *str
)
326 extern struct current_user current_user
;
327 static uid_t cached_uid
= -1;
328 static fstring cached_user
;
329 /* calling uidtoname() on every substitute would be too expensive, so
330 we cache the result here as nearly every call is for the same uid */
332 if (cached_uid
!= current_user
.uid
) {
333 fstrcpy(cached_user
, uidtoname(current_user
.uid
));
334 cached_uid
= current_user
.uid
;
337 standard_sub_advanced(snum
, cached_user
, "", -1, str
);
340 /*******************************************************************
341 Substitute strings with useful parameters.
342 ********************************************************************/
344 void standard_sub_vuser(char *str
, user_struct
*vuser
)
346 standard_sub_advanced(-1, vuser
->user
.unix_name
, "", -1, str
);
349 /*******************************************************************
350 Substitute strings with useful parameters.
351 ********************************************************************/
353 void standard_sub_vsnum(char *str
, user_struct
*vuser
, int snum
)
355 standard_sub_advanced(snum
, vuser
->user
.unix_name
, "", -1, str
);