updated the 3.0 branch from the head branch - ready for alpha18
[jra/samba/.git] / source3 / tdb / tdbutil.c
index 34c0967b720a6008c9ecf7acb7d3c242ab13247a..1a3a8bb9a52dedfb31f55b88e3a67a17873701f7 100644 (file)
@@ -1,6 +1,5 @@
 /* 
-   Unix SMB/Netbios implementation.
-   Version 3.0
+   Unix SMB/CIFS implementation.
    tdb utility functions
    Copyright (C) Andrew Tridgell 1992-1998
    
@@ -20,6 +19,7 @@
 */
 
 #include "includes.h"
+#include <fnmatch.h>
 
 /* these are little tdb utility functions that are meant to make
    dealing with a tdb database a little less cumbersome in Samba */
@@ -53,123 +53,127 @@ void tdb_unlock_bystring(TDB_CONTEXT *tdb, char *keyval)
 }
 
 /****************************************************************************
- Fetch a value by a arbitrary blob key, return -1 if not found.
JRA. DEPRECATED ! Use tdb_fetch_int32_byblob instead.
+ Fetch a int32 value by a arbitrary blob key, return -1 if not found.
Output is int32 in native byte order.
 ****************************************************************************/
 
-int tdb_fetch_int_byblob(TDB_CONTEXT *tdb, char *keyval, size_t len)
+int32 tdb_fetch_int32_byblob(TDB_CONTEXT *tdb, char *keyval, size_t len)
 {
        TDB_DATA key, data;
-       int ret;
+       int32 ret;
 
        key.dptr = keyval;
        key.dsize = len;
        data = tdb_fetch(tdb, key);
-       if (!data.dptr || data.dsize != sizeof(int))
+       if (!data.dptr || data.dsize != sizeof(int32))
                return -1;
        
-       memcpy(&ret, data.dptr, sizeof(int));
+       ret = IVAL(data.dptr,0);
        SAFE_FREE(data.dptr);
        return ret;
 }
 
 /****************************************************************************
- Fetch a value by string key, return -1 if not found.
JRA. DEPRECATED ! Use tdb_fetch_int32 instead.
+ Fetch a int32 value by string key, return -1 if not found.
Output is int32 in native byte order.
 ****************************************************************************/
 
-int tdb_fetch_int(TDB_CONTEXT *tdb, char *keystr)
+int32 tdb_fetch_int32(TDB_CONTEXT *tdb, char *keystr)
 {
-       return tdb_fetch_int_byblob(tdb, keystr, strlen(keystr) + 1);
+       return tdb_fetch_int32_byblob(tdb, keystr, strlen(keystr) + 1);
 }
 
 /****************************************************************************
- Store a value by an arbitary blob key, return 0 on success, -1 on failure.
JRA. DEPRECATED ! Use tdb_store_int32_byblob instead.
+ Store a int32 value by an arbitary blob key, return 0 on success, -1 on failure.
Input is int32 in native byte order. Output in tdb is in little-endian.
 ****************************************************************************/
 
-int tdb_store_int_byblob(TDB_CONTEXT *tdb, char *keystr, size_t len, int v)
+int tdb_store_int32_byblob(TDB_CONTEXT *tdb, char *keystr, size_t len, int32 v)
 {
        TDB_DATA key, data;
+       int32 v_store;
 
        key.dptr = keystr;
        key.dsize = len;
-       data.dptr = (void *)&v;
-       data.dsize = sizeof(int);
+       SIVAL(&v_store,0,v);
+       data.dptr = (void *)&v_store;
+       data.dsize = sizeof(int32);
 
        return tdb_store(tdb, key, data, TDB_REPLACE);
 }
 
 /****************************************************************************
- Store a value by string key, return 0 on success, -1 on failure.
JRA. DEPRECATED ! Use tdb_store_int32 instead.
+ Store a int32 value by string key, return 0 on success, -1 on failure.
Input is int32 in native byte order. Output in tdb is in little-endian.
 ****************************************************************************/
 
-int tdb_store_int(TDB_CONTEXT *tdb, char *keystr, int v)
+int tdb_store_int32(TDB_CONTEXT *tdb, char *keystr, int32 v)
 {
-       return tdb_store_int_byblob(tdb, keystr, strlen(keystr) + 1, v);
+       return tdb_store_int32_byblob(tdb, keystr, strlen(keystr) + 1, v);
 }
 
 /****************************************************************************
- Fetch a int32 value by a arbitrary blob key, return -1 if not found.
- Output is int32 in native byte order.
+ Fetch a uint32 value by a arbitrary blob key, return -1 if not found.
+ Output is uint32 in native byte order.
 ****************************************************************************/
 
-int32 tdb_fetch_int32_byblob(TDB_CONTEXT *tdb, char *keyval, size_t len)
+BOOL tdb_fetch_uint32_byblob(TDB_CONTEXT *tdb, char *keyval, size_t len, uint32 *value)
 {
        TDB_DATA key, data;
-       int32 ret;
 
        key.dptr = keyval;
        key.dsize = len;
        data = tdb_fetch(tdb, key);
-       if (!data.dptr || data.dsize != sizeof(int32))
-               return -1;
+       if (!data.dptr || data.dsize != sizeof(uint32))
+               return False;
        
-       ret = IVAL(data.dptr,0);
+       *value = IVAL(data.dptr,0);
        SAFE_FREE(data.dptr);
-       return ret;
+       return True;
 }
 
 /****************************************************************************
- Fetch a int32 value by string key, return -1 if not found.
- Output is int32 in native byte order.
+ Fetch a uint32 value by string key, return -1 if not found.
+ Output is uint32 in native byte order.
 ****************************************************************************/
 
-int32 tdb_fetch_int32(TDB_CONTEXT *tdb, char *keystr)
+BOOL tdb_fetch_uint32(TDB_CONTEXT *tdb, char *keystr, uint32 *value)
 {
-       return tdb_fetch_int32_byblob(tdb, keystr, strlen(keystr) + 1);
+       return tdb_fetch_uint32_byblob(tdb, keystr, strlen(keystr) + 1, value);
 }
 
 /****************************************************************************
- Store a int32 value by an arbitary blob key, return 0 on success, -1 on failure.
- Input is int32 in native byte order. Output in tdb is in little-endian.
+ Store a uint32 value by an arbitary blob key, return 0 on success, -1 on failure.
+ Input is uint32 in native byte order. Output in tdb is in little-endian.
 ****************************************************************************/
 
-int tdb_store_int32_byblob(TDB_CONTEXT *tdb, char *keystr, size_t len, int32 v)
+BOOL tdb_store_uint32_byblob(TDB_CONTEXT *tdb, char *keystr, size_t len, uint32 value)
 {
        TDB_DATA key, data;
-       int32 v_store;
+       uint32 v_store;
+       BOOL ret = True;
 
        key.dptr = keystr;
        key.dsize = len;
-       SIVAL(&v_store,0,v);
+       SIVAL(&v_store, 0, value);
        data.dptr = (void *)&v_store;
-       data.dsize = sizeof(int32);
+       data.dsize = sizeof(uint32);
 
-       return tdb_store(tdb, key, data, TDB_REPLACE);
+       if (tdb_store(tdb, key, data, TDB_REPLACE) == -1)
+               ret = False;
+
+       return ret;
 }
 
 /****************************************************************************
- Store a int32 value by string key, return 0 on success, -1 on failure.
- Input is int32 in native byte order. Output in tdb is in little-endian.
+ Store a uint32 value by string key, return 0 on success, -1 on failure.
+ Input is uint32 in native byte order. Output in tdb is in little-endian.
 ****************************************************************************/
 
-int tdb_store_int32(TDB_CONTEXT *tdb, char *keystr, int32 v)
+BOOL tdb_store_uint32(TDB_CONTEXT *tdb, char *keystr, uint32 value)
 {
-       return tdb_store_int32_byblob(tdb, keystr, strlen(keystr) + 1, v);
+       return tdb_store_uint32_byblob(tdb, keystr, strlen(keystr) + 1, value);
 }
-
 /****************************************************************************
  Store a buffer by a null terminated string key.  Return 0 on success, -1
  on failure.
@@ -203,30 +207,51 @@ TDB_DATA tdb_fetch_by_string(TDB_CONTEXT *tdb, char *keystr)
     return tdb_fetch(tdb, key);
 }
 
+/****************************************************************************
+ Delete a buffer using a null terminated string key.
+****************************************************************************/
+
+int tdb_delete_by_string(TDB_CONTEXT *tdb, char *keystr)
+{
+       TDB_DATA key;
+
+       key.dptr = keystr;
+       key.dsize = strlen(keystr) + 1;
+
+       return tdb_delete(tdb, key);
+}
+
 /****************************************************************************
  Atomic integer change. Returns old value. To create, set initial value in *oldval. 
 ****************************************************************************/
 
-int tdb_change_int_atomic(TDB_CONTEXT *tdb, char *keystr, int *oldval, int change_val)
+int32 tdb_change_int32_atomic(TDB_CONTEXT *tdb, char *keystr, int32 *oldval, int32 change_val)
 {
-       int val;
-       int ret = -1;
+       int32 val;
+       int32 ret = -1;
 
        if (tdb_lock_bystring(tdb, keystr) == -1)
                return -1;
 
-       if ((val = tdb_fetch_int(tdb, keystr)) == -1) {
-               if (tdb_error(tdb) != TDB_ERR_NOEXIST)
+       if ((val = tdb_fetch_int32(tdb, keystr)) == -1) {
+               /* The lookup failed */
+               if (tdb_error(tdb) != TDB_ERR_NOEXIST) {
+                       /* but not becouse it didn't exist */
                        goto err_out;
-
+               }
+               
+               /* Start with 'old' value */
                val = *oldval;
 
        } else {
+               /* It worked, set return value (oldval) to tdb data */
                *oldval = val;
-               val += change_val;
        }
+
+       /* Increment value for storage and return next time */
+       val += change_val;
                
-       if (tdb_store_int(tdb, keystr, val) == -1)
+       if (tdb_store_int32(tdb, keystr, val) == -1)
                goto err_out;
 
        ret = 0;
@@ -237,6 +262,48 @@ int tdb_change_int_atomic(TDB_CONTEXT *tdb, char *keystr, int *oldval, int chang
        return ret;
 }
 
+/****************************************************************************
+ Atomic unsigned integer change. Returns old value. To create, set initial value in *oldval. 
+****************************************************************************/
+
+BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, char *keystr, uint32 *oldval, uint32 change_val)
+{
+       uint32 val;
+       BOOL ret = False;
+
+       if (tdb_lock_bystring(tdb, keystr) == -1)
+               return False;
+
+       if (!tdb_fetch_uint32(tdb, keystr, &val)) {
+               /* It failed */
+               if (tdb_error(tdb) != TDB_ERR_NOEXIST) { 
+                       /* and not becouse it didn't exist */
+                       goto err_out;
+               }
+
+               /* Start with 'old' value */
+               val = *oldval;
+
+       } else {
+               /* it worked, set return value (oldval) to tdb data */
+               *oldval = val;
+
+       }
+
+       /* get a new value to store */
+       val += change_val;
+               
+       if (!tdb_store_uint32(tdb, keystr, val))
+               goto err_out;
+
+       ret = True;
+
+  err_out:
+
+       tdb_unlock_bystring(tdb, keystr);
+       return ret;
+}
+
 /****************************************************************************
  Useful pair of routines for packing/unpacking data consisting of
  integers and strings.
@@ -437,7 +504,7 @@ static void tdb_log(TDB_CONTEXT *tdb, int level, const char *format, ...)
        if (!ptr || !*ptr)
                return;
 
-       DEBUG(level, ("tdb(%s): %s", tdb->name, ptr));
+       DEBUG(level, ("tdb(%s): %s", tdb->name ? tdb->name : "unnamed", ptr));
        SAFE_FREE(ptr);
 }
 
@@ -446,7 +513,7 @@ static void tdb_log(TDB_CONTEXT *tdb, int level, const char *format, ...)
  the samba DEBUG() system.
 ****************************************************************************/
 
-TDB_CONTEXT *tdb_open_log(char *name, int hash_size, int tdb_flags,
+TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
                          int open_flags, mode_t mode)
 {
        TDB_CONTEXT *tdb;
@@ -454,13 +521,11 @@ TDB_CONTEXT *tdb_open_log(char *name, int hash_size, int tdb_flags,
        if (!lp_use_mmap())
                tdb_flags |= TDB_NOMMAP;
 
-       tdb = tdb_open(name, hash_size, tdb_flags, 
-                                   open_flags, mode);
+       tdb = tdb_open_ex(name, hash_size, tdb_flags, 
+                                   open_flags, mode, tdb_log);
        if (!tdb)
                return NULL;
 
-       tdb_logging_function(tdb, tdb_log);
-
        return tdb;
 }
 
@@ -474,3 +539,74 @@ int tdb_traverse_delete_fn(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf,
 {
     return tdb_delete(the_tdb, key);
 }
+
+
+
+/**
+ * Search across the whole tdb for keys that match the given pattern
+ * return the result as a list of keys
+ *
+ * @param tdb pointer to opened tdb file context
+ * @param pattern searching pattern used by fnmatch(3) functions
+ *
+ * @return list of keys found by looking up with given pattern
+ **/
+TDB_LIST_NODE *tdb_search_keys(TDB_CONTEXT *tdb, const char* pattern)
+{
+       TDB_DATA key, next;
+       TDB_LIST_NODE *list = NULL;
+       TDB_LIST_NODE *rec = NULL;
+       TDB_LIST_NODE *tmp = NULL;
+       
+       for (key = tdb_firstkey(tdb); key.dptr; key = next) {
+               /* duplicate key string to ensure null-termination */
+               char *key_str = (char*) strndup(key.dptr, key.dsize);
+               if (!key_str) {
+                       DEBUG(0, ("tdb_search_keys: strndup() failed!\n"));
+                       smb_panic("strndup failed!\n");
+               }
+               
+               DEBUG(18, ("checking %s for match to pattern %s\n", key_str, pattern));
+               
+               next = tdb_nextkey(tdb, key);
+
+               /* do the pattern checking */
+               if (fnmatch(pattern, key_str, 0) == 0) {
+                       rec = (TDB_LIST_NODE*) malloc(sizeof(*rec));
+                       ZERO_STRUCTP(rec);
+
+                       rec->node_key = key;
+       
+                       DLIST_ADD_END(list, rec, tmp);
+               
+                       DEBUG(18, ("checking %s matched pattern %s\n", key_str, pattern));
+               } else {
+                       free(key.dptr);
+               }
+               
+               /* free duplicated key string */
+               free(key_str);
+       }
+       
+       return list;
+
+};
+
+
+/**
+ * Free the list returned by tdb_search_keys
+ *
+ * @param node list of results found by tdb_search_keys
+ **/
+void tdb_search_list_free(TDB_LIST_NODE* node)
+{
+       TDB_LIST_NODE *next_node;
+       
+       while (node) {
+               next_node = node->next;
+               SAFE_FREE(node);
+               node = next_node;
+       };
+};
+
+