trying to get HEAD building again. If you want the code
[sfrench/samba-autobuild/.git] / source3 / lib / util_str.c
index b7344528677a27ba3299d77498dbe110b53c981a..96fbc3f1247d81a4d185d856bd09d532e5f73fdb 100644 (file)
@@ -1,8 +1,10 @@
 /* 
    Unix SMB/CIFS implementation.
    Samba utility functions
+   
    Copyright (C) Andrew Tridgell 1992-2001
    Copyright (C) Simo Sorce      2001-2002
+   Copyright (C) Martin Pool     2003
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
 
 #include "includes.h"
 
-#ifdef DEVELOPER
-const char *global_clobber_region_function;
-unsigned int global_clobber_region_line;
-#endif
+/**
+ * @file
+ * @brief String utilities.
+ **/
 
 /**
  * Get the next token from a string, return False if none found.
@@ -36,6 +38,7 @@ unsigned int global_clobber_region_line;
 BOOL next_token(const char **ptr,char *buff, const char *sep, size_t bufsize)
 {
        const char *s;
+       char *pbuf;
        BOOL quoted;
        size_t len=1;
 
@@ -57,17 +60,18 @@ BOOL next_token(const char **ptr,char *buff, const char *sep, size_t bufsize)
                return(False);
        
        /* copy over the token */
+       pbuf = buff;
        for (quoted = False; len < bufsize && *s && (quoted || !strchr_m(sep,*s)); s++) {
                if (*s == '\"') {
                        quoted = !quoted;
                } else {
                        len++;
-                       *buff++ = *s;
+                       *pbuf++ = *s;
                }
        }
        
        *ptr = (*s) ? s+1 : s;  
-       *buff = 0;
+       *pbuf = 0;
        
        return(True);
 }
@@ -145,21 +149,79 @@ char **toktocliplist(int *ctok, const char *sep)
 }
 
 /**
- Case insensitive string compararison.
-**/
-
+ * Case insensitive string compararison.
+ *
+ * iconv does not directly give us a way to compare strings in
+ * arbitrary unix character sets -- all we can is convert and then
+ * compare.  This is expensive.
+ *
+ * As an optimization, we do a first pass that considers only the
+ * prefix of the strings that is entirely 7-bit.  Within this, we
+ * check whether they have the same value.
+ *
+ * Hopefully this will often give the answer without needing to copy.
+ * In particular it should speed comparisons to literal ascii strings
+ * or comparisons of strings that are "obviously" different.
+ *
+ * If we find a non-ascii character we fall back to converting via
+ * iconv.
+ *
+ * This should never be slower than convering the whole thing, and
+ * often faster.
+ *
+ * A different optimization would be to compare for bitwise equality
+ * in the binary encoding.  (It would be possible thought hairy to do
+ * both simultaneously.)  But in that case if they turn out to be
+ * different, we'd need to restart the whole thing.
+ *
+ * Even better is to implement strcasecmp for each encoding and use a
+ * function pointer. 
+ **/
 int StrCaseCmp(const char *s, const char *t)
 {
+
+       const char * ps, * pt;
        pstring buf1, buf2;
-       unix_strupper(s, strlen(s)+1, buf1, sizeof(buf1));
-       unix_strupper(t, strlen(t)+1, buf2, sizeof(buf2));
-       return strcmp(buf1,buf2);
+
+       for (ps = s, pt = t; ; ps++, pt++) {
+               char us, ut;
+
+               if (!*ps && !*pt)
+                       return 0; /* both ended */
+               else if (!*ps)
+                       return -1; /* s is a prefix */
+               else if (!*pt)
+                       return +1; /* t is a prefix */
+               else if ((*ps & 0x80) || (*pt & 0x80))
+                       /* not ascii anymore, do it the hard way from here on in */
+                       break;
+
+               us = toupper(*ps);
+               ut = toupper(*pt);
+               if (us == ut)
+                       continue;
+               else if (us < ut)
+                       return -1;
+               else if (us > ut)
+                       return +1;
+       }
+
+       /* TODO: Don't do this with a fixed-length buffer.  This could
+        * still be much more efficient. */
+       /* TODO: Hardcode a char-by-char comparison for UTF-8, which
+        * can be much faster. */
+       /* TODO: Test case for this! */
+
+       unix_strupper(ps, strlen(ps)+1, buf1, sizeof(buf1));
+       unix_strupper(pt, strlen(pt)+1, buf2, sizeof(buf2));
+
+       return strcmp(buf1, buf2);
 }
 
+
 /**
  Case insensitive string compararison, length limited.
 **/
-
 int StrnCaseCmp(const char *s, const char *t, size_t n)
 {
        pstring buf1, buf2;
@@ -252,7 +314,7 @@ char *strupper_static(const char *s)
        static pstring str;
 
        pstrcpy(str, s);
-       strupper(str);
+       strupper_m(str);
 
        return str;
 }
@@ -265,9 +327,9 @@ void strnorm(char *s)
 {
        extern int case_default;
        if (case_default == CASE_UPPER)
-               strupper(s);
+               strupper_m(s);
        else
-               strlower(s);
+               strlower_m(s);
 }
 
 /**
@@ -414,40 +476,6 @@ size_t count_chars(const char *s,char c)
        return(count);
 }
 
-/**
- * In developer builds, clobber a region of memory.
- *
- * If we think a string buffer is longer than it really is, this ought
- * to make the failure obvious, by segfaulting (if in the heap) or by
- * killing the return address (on the stack), or by trapping under a
- * memory debugger.
- *
- * This is meant to catch possible string overflows, even if the
- * actual string copied is not big enough to cause an overflow.
- *
- * In addition, under Valgrind the buffer is marked as uninitialized.
- **/
-void clobber_region(const char *fn, unsigned int line, char *dest, size_t len)
-{
-#ifdef DEVELOPER
-       global_clobber_region_function = fn;
-       global_clobber_region_line = line;
-
-       /* F1 is odd and 0xf1f1f1f1 shouldn't be a valid pointer */
-       memset(dest, 0xF1, len);
-#ifdef VALGRIND
-       /* Even though we just wrote to this, from the application's
-        * point of view it is not initialized.
-        *
-        * (This is not redundant with the clobbering above.  The
-        * marking might not actually take effect if we're not running
-        * under valgrind or not with --client-perms.) */
-       VALGRIND_MAKE_WRITABLE(dest, len);
-#endif /* VALGRIND */
-#endif /* DEVELOPER */
-}
-
-
 /**
  Safe string copy into a known length string. maxlength does not
  include the terminating zero.
@@ -469,7 +497,7 @@ char *safe_strcpy_fn(const char *fn, int line, char *dest,const char *src, size_
                return dest;
        }  
 
-       len = strlen(src);
+       len = strnlen(src, maxlength+1);
 
        if (len > maxlength) {
                DEBUG(0,("ERROR: string overflow by %u (%u - %u) in safe_strcpy [%.50s]\n",
@@ -498,8 +526,8 @@ char *safe_strcat_fn(const char *fn, int line, char *dest, const char *src, size
        if (!src)
                return dest;
        
-       src_len = strlen(src);
-       dest_len = strlen(dest);
+       src_len = strnlen(src, maxlength + 1);
+       dest_len = strnlen(dest, maxlength + 1);
 
        clobber_region(fn, line, dest + dest_len, maxlength + 1 - dest_len);
 
@@ -577,8 +605,12 @@ char *StrnCpy_fn(const char *fn, int line,char *dest,const char *src,size_t n)
                *dest = 0;
                return(dest);
        }
-       while (n-- && (*d++ = *src++))
-               ;
+       
+       while (n-- && (*d = *src)) {
+               d++;
+               src++;
+       }
+
        *d = 0;
        return(dest);
 }
@@ -655,6 +687,22 @@ size_t strhex_to_str(char *p, size_t len, const char *strhex)
        return num_chars;
 }
 
+/**
+ * Routine to print a buffer as HEX digits, into an allocated string.
+ */
+
+void hex_encode(const unsigned char *buff_in, size_t len, char **out_hex_buffer)
+{
+       int i;
+       char *hex_buffer;
+
+       *out_hex_buffer = smb_xmalloc((len*2)+1);
+       hex_buffer = *out_hex_buffer;
+
+       for (i = 0; i < len; i++)
+               slprintf(&hex_buffer[i*2], 3, "%02X", buff_in[i]);
+}
+
 /**
  Check if a string is part of a list.
 **/
@@ -1063,6 +1111,26 @@ char *strrchr_m(const char *s, char c)
        return (char *)(s+strlen(s2));
 }
 
+/***********************************************************************
+ Return the equivalent of doing strrchr 'n' times - always going
+ backwards.
+***********************************************************************/
+
+char *strnrchr_m(const char *s, char c, unsigned int n)
+{
+       wpstring ws;
+       pstring s2;
+       smb_ucs2_t *p;
+
+       push_ucs2(NULL, ws, s, sizeof(ws), STR_TERMINATE);
+       p = strnrchr_w(ws, UCS2_CHAR(c), n);
+       if (!p)
+               return NULL;
+       *p = 0;
+       pull_ucs2_pstring(s2, ws);
+       return (char *)(s+strlen(s2));
+}
+
 /**
  Convert a string to lower case.
 **/
@@ -1180,12 +1248,12 @@ char *binary_string(char *buf, int len)
        return ret;
 }
 
-#if 0
+
 /**
  Just a typesafety wrapper for snprintf into a fstring.
 **/
 
-static int fstr_sprintf(fstring s, const char *fmt, ...)
+int fstr_sprintf(fstring s, const char *fmt, ...)
 {
        va_list ap;
        int ret;
@@ -1195,7 +1263,7 @@ static int fstr_sprintf(fstring s, const char *fmt, ...)
        va_end(ap);
        return ret;
 }
-#endif
+
 
 #ifndef HAVE_STRNDUP
 /**
@@ -1423,6 +1491,7 @@ BOOL str_list_substitute(char **list, const char *pattern, const char *insert)
 
 
 #define IPSTR_LIST_SEP ","
+#define IPSTR_LIST_CHAR        ','
 
 /**
  * Add ip string representation to ipstr list. Used also
@@ -1437,19 +1506,20 @@ BOOL str_list_substitute(char **list, const char *pattern, const char *insert)
  *         reallocated to new length
  **/
 
-char* ipstr_list_add(char** ipstr_list, const struct in_addr *ip)
+char* ipstr_list_add(char** ipstr_list, const struct ip_service *service)
 {
        char* new_ipstr = NULL;
        
        /* arguments checking */
-       if (!ipstr_list || !ip) return NULL;
+       if (!ipstr_list || !service) return NULL;
 
        /* attempt to convert ip to a string and append colon separator to it */
        if (*ipstr_list) {
-               asprintf(&new_ipstr, "%s%s%s", *ipstr_list, IPSTR_LIST_SEP,inet_ntoa(*ip));
+               asprintf(&new_ipstr, "%s%s%s:%d", *ipstr_list, IPSTR_LIST_SEP,
+                       inet_ntoa(service->ip), service->port);
                SAFE_FREE(*ipstr_list);
        } else {
-               asprintf(&new_ipstr, "%s", inet_ntoa(*ip));
+               asprintf(&new_ipstr, "%s:%d", inet_ntoa(service->ip), service->port);
        }
        *ipstr_list = new_ipstr;
        return *ipstr_list;
@@ -1466,7 +1536,7 @@ char* ipstr_list_add(char** ipstr_list, const struct in_addr *ip)
  * @return pointer to allocated ip string
  **/
  
-char* ipstr_list_make(char** ipstr_list, const struct in_addr* ip_list, int ip_count)
+char* ipstr_list_make(char** ipstr_list, const struct ip_service* ip_list, int ip_count)
 {
        int i;
        
@@ -1485,7 +1555,8 @@ char* ipstr_list_make(char** ipstr_list, const struct in_addr* ip_list, int ip_c
 
 /**
  * Parse given ip string list into array of ip addresses
- * (as in_addr structures)
+ * (as ip_service structures)  
+ *    e.g. 192.168.1.100:389,192.168.1.78, ...
  *
  * @param ipstr ip string list to be parsed 
  * @param ip_list pointer to array of ip addresses which is
@@ -1493,28 +1564,40 @@ char* ipstr_list_make(char** ipstr_list, const struct in_addr* ip_list, int ip_c
  * @return number of succesfully parsed addresses
  **/
  
-int ipstr_list_parse(const char* ipstr_list, struct in_addr** ip_list)
+int ipstr_list_parse(const char* ipstr_list, struct ip_service **ip_list)
 {
        fstring token_str;
-       int count;
+       size_t count;
+       int i;
 
-       if (!ipstr_list || !ip_list) return 0;
+       if (!ipstr_list || !ip_list) 
+               return 0;
+       
+       count = count_chars(ipstr_list, IPSTR_LIST_CHAR) + 1;
+       if ( (*ip_list = (struct ip_service*)malloc(count * sizeof(struct ip_service))) == NULL ) {
+               DEBUG(0,("ipstr_list_parse: malloc failed for %d entries\n", count));
+               return 0;
+       }
        
-       for (*ip_list = NULL, count = 0;
-            next_token(&ipstr_list, token_str, IPSTR_LIST_SEP, FSTRING_LEN);
-            count++) {
-            
+       for ( i=0; 
+               next_token(&ipstr_list, token_str, IPSTR_LIST_SEP, FSTRING_LEN) && i<count; 
+               i++ ) 
+       {
                struct in_addr addr;
+               unsigned port = 0;      
+               char *p = strchr(token_str, ':');
+               
+               if (p) {
+                       *p = 0;
+                       port = atoi(p+1);
+               }
 
                /* convert single token to ip address */
                if ( (addr.s_addr = inet_addr(token_str)) == INADDR_NONE )
                        break;
-               
-               /* prepare place for another in_addr structure */
-               *ip_list = Realloc(*ip_list, (count + 1) * sizeof(struct in_addr));
-               if (!*ip_list) return -1;
-               
-               (*ip_list)[count] = addr;
+                               
+               (*ip_list)[i].ip = addr;
+               (*ip_list)[i].port = port;
        }
        
        return count;
@@ -1616,10 +1699,10 @@ void base64_decode_inplace(char *s)
 {
        DATA_BLOB decoded = base64_decode_data_blob(s);
        memcpy(s, decoded.data, decoded.length);
-       data_blob_free(&decoded);
-
        /* null terminate */
        s[decoded.length] = '\0';
+
+       data_blob_free(&decoded);
 }
 
 /**
@@ -1667,3 +1750,25 @@ char * base64_encode_data_blob(DATA_BLOB data)
     return result;
 }
 
+/* read a SMB_BIG_UINT from a string */
+SMB_BIG_UINT STR_TO_SMB_BIG_UINT(const char *nptr, const char **entptr)
+{
+
+       SMB_BIG_UINT val = -1;
+       const char *p = nptr;
+       
+       while (p && *p && isspace(*p))
+               p++;
+#ifdef LARGE_SMB_OFF_T
+       sscanf(p,"%llu",&val);  
+#else /* LARGE_SMB_OFF_T */
+       sscanf(p,"%lu",&val);
+#endif /* LARGE_SMB_OFF_T */
+       if (entptr) {
+               while (p && *p && isdigit(*p))
+                       p++;
+               *entptr = p;
+       }
+
+       return val;
+}