updated the 3.0 branch from the head branch - ready for alpha18
[samba.git] / source3 / lib / substitute.c
index e878ee8cbfd13397ec1d502fc53833dd9a5f290a..6d96a1820f1484fcd997ff5774c313936bab0e5d 100644 (file)
@@ -83,6 +83,66 @@ static size_t expand_env_var(char *p, int len)
        return 0; /* Allow the environment contents to be parsed. */
 }
 
+/*******************************************************************
+ Given a pointer to a %$(NAME) in p and the whole string in str
+ expand it as an environment variable.
+ Return a new allocated and expanded string.
+ Based on code by Branko Cibej <branko.cibej@hermes.si>
+ When this is called p points at the '%' character.
+ May substitute multiple occurrencies of the same env var.
+********************************************************************/
+
+
+static char * realloc_expand_env_var(char *str, char *p)
+{
+       char *envname;
+       char *envval;
+       char *q, *r;
+       int copylen;
+
+       if (p[0] != '%' || p[1] != '$' || p[2] != '(')
+               return str;
+
+       /*
+        * Look for the terminating ')'.
+        */
+
+       if ((q = strchr_m(p,')')) == NULL) {
+               DEBUG(0,("expand_env_var: Unterminated environment variable [%s]\n", p));
+               return str;
+       }
+
+       /*
+        * Extract the name from within the %$(NAME) string.
+        */
+
+       r = p + 3;
+       copylen = q - r;
+       envname = (char *)malloc(copylen + 1 + 4); /* reserve space for use later add %$() chars */
+       if (envname == NULL) return NULL;
+       strncpy(envname,r,copylen);
+       envname[copylen] = '\0';
+
+       if ((envval = getenv(envname)) == NULL) {
+               DEBUG(0,("expand_env_var: Environment variable [%s] not set\n", envname));
+               SAFE_FREE(envname);
+               return str;
+       }
+
+       /*
+        * Copy the full %$(NAME) into envname so it
+        * can be replaced.
+        */
+
+       copylen = q + 1 - p;
+       strncpy(envname,p,copylen);
+       envname[copylen] = '\0';
+       r = realloc_string_sub(str, envname, envval);
+       SAFE_FREE(envname);
+       if (r == NULL) return NULL;
+       return r;
+}
+
 /*******************************************************************
  Patch from jkf@soton.ac.uk
  Added this to implement %p (NIS auto-map version of %H)
@@ -160,9 +220,11 @@ static char *automount_server(const char *user_name)
 
 /****************************************************************************
  Do some standard substitutions in a string.
+ len is the length in bytes of the space allowed in string str. If zero means
+ don't allow expansions.
 ****************************************************************************/
 
-void standard_sub_basic(const char *smb_name, char *str)
+void standard_sub_basic(const char *smb_name, char *str,size_t len)
 {
        char *p, *s;
        fstring pidstr;
@@ -171,7 +233,10 @@ void standard_sub_basic(const char *smb_name, char *str)
        for (s=str; (p=strchr_m(s, '%'));s=p) {
                fstring tmp_str;
 
-               int l = sizeof(pstring) - (int)(p-str);
+               int l = (int)len - (int)(p-str);
+
+               if (l < 0)
+                       l = 0;
                
                switch (*(p+1)) {
                case 'U' : 
@@ -192,26 +257,43 @@ void standard_sub_basic(const char *smb_name, char *str)
                        strupper(tmp_str);
                        string_sub(p,"%D", tmp_str,l);
                        break;
-               case 'I' : string_sub(p,"%I", client_addr(),l); break;
+               case 'I' :
+                       string_sub(p,"%I", client_addr(),l);
+                       break;
                case 'L' : 
-                       if (*local_machine) {
+                       if (*local_machine)
                                string_sub(p,"%L", local_machine,l); 
-                       } else {
+                       else
                                string_sub(p,"%L", global_myname,l); 
-                       }
                        break;
-               case 'M' : string_sub(p,"%M", client_name(),l); break;
-               case 'R' : string_sub(p,"%R", remote_proto,l); break;
-               case 'T' : string_sub(p,"%T", timestring(False),l); break;
-               case 'a' : string_sub(p,"%a", remote_arch,l); break;
+               case 'M' :
+                       string_sub(p,"%M", client_name(),l);
+                       break;
+               case 'R' :
+                       string_sub(p,"%R", remote_proto,l);
+                       break;
+               case 'T' :
+                       string_sub(p,"%T", timestring(False),l);
+                       break;
+               case 'a' :
+                       string_sub(p,"%a", remote_arch,l);
+                       break;
                case 'd' :
                        slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)sys_getpid());
                        string_sub(p,"%d", pidstr,l);
                        break;
-               case 'h' : string_sub(p,"%h", myhostname(),l); break;
-               case 'm' : string_sub(p,"%m", remote_machine,l); break;
-               case 'v' : string_sub(p,"%v", VERSION,l); break;
-               case '$' : p += expand_env_var(p,l); break; /* Expand environment variables */
+               case 'h' :
+                       string_sub(p,"%h", myhostname(),l);
+                       break;
+               case 'm' :
+                       string_sub(p,"%m", remote_machine,l);
+                       break;
+               case 'v' :
+                       string_sub(p,"%v", VERSION,l);
+                       break;
+               case '$' :
+                       p += expand_env_var(p,l);
+                       break; /* Expand environment variables */
                case '\0': 
                        p++; 
                        break; /* don't run off the end of the string */
@@ -222,34 +304,34 @@ void standard_sub_basic(const char *smb_name, char *str)
        }
 }
 
-/****************************************************************************
- Do some standard substitutions in a string.
-****************************************************************************/
-
-void standard_sub_advanced(int snum, const char *user, const char *connectpath, gid_t gid, const char *smb_name, char *str)
+static void standard_sub_advanced(int snum, const char *user, 
+                                 const char *connectpath, gid_t gid, 
+                                 const char *smb_name, char *str, size_t len)
 {
        char *p, *s, *home;
 
        for (s=str; (p=strchr_m(s, '%'));s=p) {
-               int l = sizeof(pstring) - (int)(p-str);
-               
+               int l = (int)len - (int)(p-str);
+       
+               if (l < 0)
+                       l = 0;
+       
                switch (*(p+1)) {
-               case 'N' : string_sub(p,"%N", automount_server(user),l); break;
+               case 'N' :
+                       string_sub(p,"%N", automount_server(user),l);
+                       break;
                case 'H':
-                       if ((home = get_user_home_dir(user))) {
+                       if ((home = get_user_home_dir(user)))
                                string_sub(p,"%H",home, l);
-                       } else {
+                       else
                                p += 2;
-                       }
                        break;
                case 'P': 
                        string_sub(p,"%P", connectpath, l); 
                        break;
-                       
                case 'S': 
                        string_sub(p,"%S", lp_servicename(snum), l); 
                        break;
-                       
                case 'g': 
                        string_sub(p,"%g", gidtoname(gid), l); 
                        break;
@@ -276,54 +358,293 @@ void standard_sub_advanced(int snum, const char *user, const char *connectpath,
                }
        }
 
-       standard_sub_basic(smb_name, str);
+       standard_sub_basic(smb_name, str, len);
 }
 
 /****************************************************************************
  Do some standard substitutions in a string.
+ This function will return an allocated string that have to be freed.
 ****************************************************************************/
 
-void standard_sub_conn(connection_struct *conn, char *str)
+char *talloc_sub_basic(TALLOC_CTX *mem_ctx, const char *smb_name, const char *str)
 {
-       standard_sub_advanced(SNUM(conn), conn->user, conn->connectpath, conn->gid, current_user_info.smb_name, str);
+       char *a, *t;
+               a = alloc_sub_basic(smb_name, str);
+       if (!a) return NULL;
+       t = talloc_strdup(mem_ctx, a);
+       SAFE_FREE(a);
+       return t;
+}
+
+char *alloc_sub_basic(const char *smb_name, const char *str)
+{
+       char *b, *p, *s, *t, *r, *a_string;
+       fstring pidstr;
+       struct passwd *pass;
+
+       a_string = strdup(str);
+       if (a_string == NULL) {
+               DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
+               return NULL;
+       }
+       
+       for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
+
+               r = NULL;
+               b = t = a_string;
+               
+               switch (*(p+1)) {
+               case 'U' : 
+                       r = strdup_lower(smb_name);
+                       if (r == NULL) goto error;
+                       t = realloc_string_sub(t, "%U", r);
+                       break;
+               case 'G' :
+                       r = strdup(smb_name);
+                       if (r == NULL) goto error;
+                       if ((pass = Get_Pwnam(r))!=NULL) {
+                               t = realloc_string_sub(t, "%G", gidtoname(pass->pw_gid));
+                       } 
+                       break;
+               case 'D' :
+                       r = strdup_upper(current_user_info.domain);
+                       if (r == NULL) goto error;
+                       t = realloc_string_sub(t, "%D", r);
+                       break;
+               case 'I' :
+                       t = realloc_string_sub(t, "%I", client_addr());
+                       break;
+               case 'L' : 
+                       if (*local_machine)
+                               t = realloc_string_sub(t, "%L", local_machine); 
+                       else
+                               t = realloc_string_sub(t, "%L", global_myname); 
+                       break;
+               case 'M' :
+                       t = realloc_string_sub(t, "%M", client_name());
+                       break;
+               case 'R' :
+                       t = realloc_string_sub(t, "%R", remote_proto);
+                       break;
+               case 'T' :
+                       t = realloc_string_sub(t, "%T", timestring(False));
+                       break;
+               case 'a' :
+                       t = realloc_string_sub(t, "%a", remote_arch);
+                       break;
+               case 'd' :
+                       slprintf(pidstr,sizeof(pidstr)-1, "%d",(int)sys_getpid());
+                       t = realloc_string_sub(t, "%d", pidstr);
+                       break;
+               case 'h' :
+                       t = realloc_string_sub(t, "%h", myhostname());
+                       break;
+               case 'm' :
+                       t = realloc_string_sub(t, "%m", remote_machine);
+                       break;
+               case 'v' :
+                       t = realloc_string_sub(t, "%v", VERSION);
+                       break;
+               case '$' :
+                       t = realloc_expand_env_var(t, p); /* Expand environment variables */
+                       break;
+                       
+               default: 
+                       break;
+               }
+
+               p++;
+               SAFE_FREE(r);
+               if (t == NULL) goto error;
+               a_string = t;
+       }
+
+       return a_string;
+error:
+       SAFE_FREE(a_string);
+       return NULL;
 }
 
 /****************************************************************************
- Like standard_sub but for a homes share where snum still points to the [homes]
share. No user specific snum created yet so servicename should be the username.
+ Do some specific substitutions in a string.
This function will return an allocated string that have to be freed.
 ****************************************************************************/
 
-void standard_sub_home(int snum, const char *user, char *str)
+char *talloc_sub_specified(TALLOC_CTX *mem_ctx,
+                       const char *input_string,
+                       const char *username,
+                       const char *domain,
+                       uid_t uid,
+                       gid_t gid)
 {
-       char *p, *s;
+       char *a, *t;
+               a = alloc_sub_specified(input_string, username, domain, uid, gid);
+       if (!a) return NULL;
+       t = talloc_strdup(mem_ctx, a);
+       SAFE_FREE(a);
+       return t;
+}
 
-       for (s=str; (p=strchr_m(s, '%'));s=p) {
-               int l = sizeof(pstring) - (int)(p-str);
+char *alloc_sub_specified(const char *input_string,
+                       const char *username,
+                       const char *domain,
+                       uid_t uid,
+                       gid_t gid)
+{
+       char *a_string, *ret_string;
+       char *b, *p, *s, *t;
+
+       a_string = strdup(input_string);
+       if (a_string == NULL) {
+               DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
+               return NULL;
+       }
+       
+       for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
+               
+               b = t = a_string;
+               
+               switch (*(p+1)) {
+               case 'U' : 
+                       t = realloc_string_sub(t, "%U", username);
+                       break;
+               case 'u' : 
+                       t = realloc_string_sub(t, "%u", username);
+                       break;
+               case 'G' :
+                       if (gid != -1) {
+                               t = realloc_string_sub(t, "%G", gidtoname(gid));
+                       } else {
+                               t = realloc_string_sub(t, "%G", "NO_GROUP");
+                       }
+                       break;
+               case 'g' :
+                       if (gid != -1) {
+                               t = realloc_string_sub(t, "%g", gidtoname(gid));
+                       } else {
+                               t = realloc_string_sub(t, "%g", "NO_GROUP");
+                       }
+                       break;
+               case 'D' :
+                       t = realloc_string_sub(t, "%D", domain);
+                       break;
+               case 'N' : 
+                       t = realloc_string_sub(t, "%N", automount_server(username)); 
+                       break;
+               default: 
+                       break;
+               }
+
+               p++;
+               if (t == NULL) {
+                       SAFE_FREE(a_string);
+                       return NULL;
+               }
+               a_string = t;
+       }
+
+       ret_string = alloc_sub_basic(username, a_string);
+       SAFE_FREE(a_string);
+       return ret_string;
+}
+
+char *talloc_sub_advanced(TALLOC_CTX *mem_ctx,
+                       int snum,
+                       const char *user,
+                       const char *connectpath,
+                       gid_t gid,
+                       const char *smb_name,
+                       char *str)
+{
+       char *a, *t;
+               a = alloc_sub_advanced(snum, user, connectpath, gid, smb_name, str);
+       if (!a) return NULL;
+       t = talloc_strdup(mem_ctx, a);
+       SAFE_FREE(a);
+       return t;
+}
+
+char *alloc_sub_advanced(int snum, const char *user, 
+                                 const char *connectpath, gid_t gid, 
+                                 const char *smb_name, char *str)
+{
+       char *a_string, *ret_string;
+       char *b, *p, *s, *t, *h;
+
+       a_string = strdup(str);
+       if (a_string == NULL) {
+               DEBUG(0, ("alloc_sub_specified: Out of memory!\n"));
+               return NULL;
+       }
+       
+       for (b = s = a_string; (p = strchr_m(s, '%')); s = a_string + (p - b)) {
+               
+               b = t = a_string;
                
                switch (*(p+1)) {
+               case 'N' :
+                       t = realloc_string_sub(t, "%N", automount_server(user));
+                       break;
+               case 'H':
+                       if ((h = get_user_home_dir(user)))
+                               t = realloc_string_sub(t, "%H", h);
+                       break;
+               case 'P': 
+                       t = realloc_string_sub(t, "%P", connectpath); 
+                       break;
                case 'S': 
-                       string_sub(p,"%S", user, l); 
+                       t = realloc_string_sub(t, "%S", lp_servicename(snum)); 
+                       break;
+               case 'g': 
+                       t = realloc_string_sub(t, "%g", gidtoname(gid)); 
+                       break;
+               case 'u': 
+                       t = realloc_string_sub(t, "%u", user); 
                        break;
+                       
+                       /* Patch from jkf@soton.ac.uk Left the %N (NIS
+                        * server name) in standard_sub_basic as it is
+                        * a feature for logon servers, hence uses the
+                        * username.  The %p (NIS server path) code is
+                        * here as it is used instead of the default
+                        * "path =" string in [homes] and so needs the
+                        * service name, not the username.  */
                case 'p': 
-                       string_sub(p,"%p", automount_path(user), l); 
+                       t = realloc_string_sub(t, "%p", automount_path(lp_servicename(snum))); 
                        break;
-               case '\0': 
-                       p++; 
-                       break; /* don't run off the end of the string */
                        
-               default: p+=2; 
+               default: 
                        break;
                }
+
+               p++;
+               if (t == NULL) {
+                       SAFE_FREE(a_string);
+                       return NULL;
+               }
+               a_string = t;
        }
 
-        standard_sub_advanced(snum, user, "", -1, current_user_info.smb_name, str);
+       ret_string = alloc_sub_basic(smb_name, a_string);
+       SAFE_FREE(a_string);
+       return ret_string;
+}
+
+/****************************************************************************
+ Do some standard substitutions in a string.
+****************************************************************************/
+
+void standard_sub_conn(connection_struct *conn, char *str, size_t len)
+{
+       standard_sub_advanced(SNUM(conn), conn->user, conn->connectpath,
+                       conn->gid, current_user_info.smb_name, str, len);
 }
 
 /****************************************************************************
  Like standard_sub but by snum.
 ****************************************************************************/
 
-void standard_sub_snum(int snum, char *str)
+void standard_sub_snum(int snum, char *str, size_t len)
 {
        extern struct current_user current_user;
        static uid_t cached_uid = -1;
@@ -336,23 +657,6 @@ void standard_sub_snum(int snum, char *str)
                cached_uid = current_user.uid;
        }
 
-       standard_sub_advanced(snum, cached_user, "", -1, current_user_info.smb_name, str);
-}
-
-/*******************************************************************
- Substitute strings with useful parameters.
-********************************************************************/
-
-void standard_sub_vuser(char *str, user_struct *vuser)
-{
-       standard_sub_advanced(-1, vuser->user.unix_name, "", -1, current_user_info.smb_name, str);
-}
-
-/*******************************************************************
- Substitute strings with useful parameters.
-********************************************************************/
-
-void standard_sub_vsnum(char *str, user_struct *vuser, int snum)
-{
-       standard_sub_advanced(snum, vuser->user.unix_name, "", -1, current_user_info.smb_name, str);
+       standard_sub_advanced(snum, cached_user, "", -1,
+               current_user_info.smb_name, str, len);
 }