source3/registry/reg_objects.c

   1 /*
   2  *  Unix SMB/CIFS implementation.
   3  *  Virtual Windows Registry Layer
   4  *  Copyright (C) Gerald Carter                     2002-2005
   5  *
   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 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  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.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /* Implementation of registry frontend view functions. */
  21
  22 #include "includes.h"
  23
  24 #undef DBGC_CLASS
  25 #define DBGC_CLASS DBGC_REGISTRY
  26
  27 struct regsubkey_ctr {
  28         uint32          num_subkeys;
  29         char            **subkeys;
  30         int seqnum;
  31 };
  32
  33 /**********************************************************************
  34
  35  Note that the struct regsubkey_ctr and REGVAL_CTR objects *must* be
  36  talloc()'d since the methods use the object pointer as the talloc
  37  context for internal private data.
  38
  39  There is no longer a regval_ctr_intit() and regval_ctr_destroy()
  40  pair of functions.  Simply TALLOC_ZERO_P() and TALLOC_FREE() the
  41  object.
  42
  43  **********************************************************************/
  44
  45 WERROR regsubkey_ctr_init(TALLOC_CTX *mem_ctx, struct regsubkey_ctr **ctr)
  46 {
  47         if (ctr == NULL) {
  48                 return WERR_INVALID_PARAM;
  49         }
  50
  51         *ctr = talloc_zero(mem_ctx, struct regsubkey_ctr);
  52         if (*ctr == NULL) {
  53                 return WERR_NOMEM;
  54         }
  55
  56         return WERR_OK;
  57 }
  58
  59 WERROR regsubkey_ctr_set_seqnum(struct regsubkey_ctr *ctr, int seqnum)
  60 {
  61         if (ctr == NULL) {
  62                 return WERR_INVALID_PARAM;
  63         }
  64
  65         ctr->seqnum = seqnum;
  66
  67         return WERR_OK;
  68 }
  69
  70 int regsubkey_ctr_get_seqnum(struct regsubkey_ctr *ctr)
  71 {
  72         if (ctr == NULL) {
  73                 return -1;
  74         }
  75
  76         return ctr->seqnum;
  77 }
  78
  79 /***********************************************************************
  80  Add a new key to the array
  81  **********************************************************************/
  82
  83 WERROR regsubkey_ctr_addkey( struct regsubkey_ctr *ctr, const char *keyname )
  84 {
  85         char **newkeys;
  86
  87         if ( !keyname ) {
  88                 return WERR_OK;
  89         }
  90
  91         /* make sure the keyname is not already there */
  92
  93         if ( regsubkey_ctr_key_exists( ctr, keyname ) ) {
  94                 return WERR_OK;
  95         }
  96
  97         if (!(newkeys = TALLOC_REALLOC_ARRAY(ctr, ctr->subkeys, char *,
  98                                              ctr->num_subkeys+1))) {
  99                 return WERR_NOMEM;
 100         }
 101
 102         ctr->subkeys = newkeys;
 103
 104         if (!(ctr->subkeys[ctr->num_subkeys] = talloc_strdup(ctr->subkeys,
 105                                                              keyname ))) {
 106                 /*
 107                  * Don't shrink the new array again, this wastes a pointer
 108                  */
 109                 return WERR_NOMEM;
 110         }
 111         ctr->num_subkeys++;
 112
 113         return WERR_OK;
 114 }
 115
 116  /***********************************************************************
 117  Delete a key from the array
 118  **********************************************************************/
 119
 120 int regsubkey_ctr_delkey( struct regsubkey_ctr *ctr, const char *keyname )
 121 {
 122         int i;
 123
 124         if ( !keyname )
 125                 return ctr->num_subkeys;
 126
 127         /* make sure the keyname is actually already there */
 128
 129         for ( i=0; i<ctr->num_subkeys; i++ ) {
 130                 if ( strequal( ctr->subkeys[i], keyname ) )
 131                         break;
 132         }
 133
 134         if ( i == ctr->num_subkeys )
 135                 return ctr->num_subkeys;
 136
 137         /* update if we have any keys left */
 138         ctr->num_subkeys--;
 139         if ( i < ctr->num_subkeys )
 140                 memmove(&ctr->subkeys[i], &ctr->subkeys[i+1],
 141                         sizeof(char*) * (ctr->num_subkeys-i));
 142
 143         return ctr->num_subkeys;
 144 }
 145
 146 /***********************************************************************
 147  Check for the existance of a key
 148  **********************************************************************/
 149
 150 bool regsubkey_ctr_key_exists( struct regsubkey_ctr *ctr, const char *keyname )
 151 {
 152         int     i;
 153
 154         if (!ctr->subkeys) {
 155                 return False;
 156         }
 157
 158         for ( i=0; i<ctr->num_subkeys; i++ ) {
 159                 if ( strequal( ctr->subkeys[i],keyname ) )
 160                         return True;
 161         }
 162
 163         return False;
 164 }
 165
 166 /***********************************************************************
 167  How many keys does the container hold ?
 168  **********************************************************************/
 169
 170 int regsubkey_ctr_numkeys( struct regsubkey_ctr *ctr )
 171 {
 172         return ctr->num_subkeys;
 173 }
 174
 175 /***********************************************************************
 176  Retreive a specific key string
 177  **********************************************************************/
 178
 179 char* regsubkey_ctr_specific_key( struct regsubkey_ctr *ctr, uint32 key_index )
 180 {
 181         if ( ! (key_index < ctr->num_subkeys) )
 182                 return NULL;
 183
 184         return ctr->subkeys[key_index];
 185 }
 186
 187 /*
 188  * Utility functions for REGVAL_CTR
 189  */
 190
 191 /***********************************************************************
 192  How many keys does the container hold ?
 193  **********************************************************************/
 194
 195 int regval_ctr_numvals( REGVAL_CTR *ctr )
 196 {
 197         return ctr->num_values;
 198 }
 199
 200 /***********************************************************************
 201  allocate memory for and duplicate a REGISTRY_VALUE.
 202  This is malloc'd memory so the caller should free it when done
 203  **********************************************************************/
 204
 205 REGISTRY_VALUE* dup_registry_value( REGISTRY_VALUE *val )
 206 {
 207         REGISTRY_VALUE  *copy = NULL;
 208
 209         if ( !val )
 210                 return NULL;
 211
 212         if ( !(copy = SMB_MALLOC_P( REGISTRY_VALUE)) ) {
 213                 DEBUG(0,("dup_registry_value: malloc() failed!\n"));
 214                 return NULL;
 215         }
 216
 217         /* copy all the non-pointer initial data */
 218
 219         memcpy( copy, val, sizeof(REGISTRY_VALUE) );
 220
 221         copy->size = 0;
 222         copy->data_p = NULL;
 223
 224         if ( val->data_p && val->size )
 225         {
 226                 if ( !(copy->data_p = (uint8 *)memdup( val->data_p,
 227                                                        val->size )) ) {
 228                         DEBUG(0,("dup_registry_value: memdup() failed for [%d] "
 229                                  "bytes!\n", val->size));
 230                         SAFE_FREE( copy );
 231                         return NULL;
 232                 }
 233                 copy->size = val->size;
 234         }
 235
 236         return copy;
 237 }
 238
 239 /**********************************************************************
 240  free the memory allocated to a REGISTRY_VALUE
 241  *********************************************************************/
 242
 243 void free_registry_value( REGISTRY_VALUE *val )
 244 {
 245         if ( !val )
 246                 return;
 247
 248         SAFE_FREE( val->data_p );
 249         SAFE_FREE( val );
 250
 251         return;
 252 }
 253
 254 /**********************************************************************
 255  *********************************************************************/
 256
 257 uint8* regval_data_p( REGISTRY_VALUE *val )
 258 {
 259         return val->data_p;
 260 }
 261
 262 /**********************************************************************
 263  *********************************************************************/
 264
 265 uint32 regval_size( REGISTRY_VALUE *val )
 266 {
 267         return val->size;
 268 }
 269
 270 /**********************************************************************
 271  *********************************************************************/
 272
 273 char* regval_name( REGISTRY_VALUE *val )
 274 {
 275         return val->valuename;
 276 }
 277
 278 /**********************************************************************
 279  *********************************************************************/
 280
 281 uint32 regval_type( REGISTRY_VALUE *val )
 282 {
 283         return val->type;
 284 }
 285
 286 /***********************************************************************
 287  Retreive a pointer to a specific value.  Caller shoud dup the structure
 288  since this memory will go away when the ctr is free()'d
 289  **********************************************************************/
 290
 291 REGISTRY_VALUE* regval_ctr_specific_value( REGVAL_CTR *ctr, uint32 idx )
 292 {
 293         if ( !(idx < ctr->num_values) )
 294                 return NULL;
 295
 296         return ctr->values[idx];
 297 }
 298
 299 /***********************************************************************
 300  Check for the existance of a value
 301  **********************************************************************/
 302
 303 bool regval_ctr_key_exists( REGVAL_CTR *ctr, const char *value )
 304 {
 305         int     i;
 306
 307         for ( i=0; i<ctr->num_values; i++ ) {
 308                 if ( strequal( ctr->values[i]->valuename, value) )
 309                         return True;
 310         }
 311
 312         return False;
 313 }
 314
 315 /***********************************************************************
 316  * compose a REGISTRY_VALUE from input data
 317  **********************************************************************/
 318
 319 REGISTRY_VALUE *regval_compose(TALLOC_CTX *ctx, const char *name, uint16 type,
 320                                const char *data_p, size_t size)
 321 {
 322         REGISTRY_VALUE *regval = TALLOC_P(ctx, REGISTRY_VALUE);
 323
 324         if (regval == NULL) {
 325                 return NULL;
 326         }
 327
 328         fstrcpy(regval->valuename, name);
 329         regval->type = type;
 330         if (size) {
 331                 regval->data_p = (uint8 *)TALLOC_MEMDUP(regval, data_p, size);
 332                 if (!regval->data_p) {
 333                         TALLOC_FREE(regval);
 334                         return NULL;
 335                 }
 336         } else {
 337                 regval->data_p = NULL;
 338         }
 339         regval->size = size;
 340
 341         return regval;
 342 }
 343
 344 /***********************************************************************
 345  Add a new registry value to the array
 346  **********************************************************************/
 347
 348 int regval_ctr_addvalue( REGVAL_CTR *ctr, const char *name, uint16 type,
 349                          const char *data_p, size_t size )
 350 {
 351         if ( !name )
 352                 return ctr->num_values;
 353
 354         /* Delete the current value (if it exists) and add the new one */
 355
 356         regval_ctr_delvalue( ctr, name );
 357
 358         /* allocate a slot in the array of pointers */
 359
 360         if (  ctr->num_values == 0 ) {
 361                 ctr->values = TALLOC_P( ctr, REGISTRY_VALUE *);
 362         } else {
 363                 ctr->values = TALLOC_REALLOC_ARRAY(ctr, ctr->values,
 364                                                    REGISTRY_VALUE *,
 365                                                    ctr->num_values+1);
 366         }
 367
 368         if (!ctr->values) {
 369                 ctr->num_values = 0;
 370                 return 0;
 371         }
 372
 373         /* allocate a new value and store the pointer in the arrya */
 374
 375         ctr->values[ctr->num_values] = regval_compose(ctr, name, type, data_p,
 376                                                       size);
 377         if (ctr->values[ctr->num_values] == NULL) {
 378                 ctr->num_values = 0;
 379                 return 0;
 380         }
 381         ctr->num_values++;
 382
 383         return ctr->num_values;
 384 }
 385
 386 /***********************************************************************
 387  Add a new registry value to the array
 388  **********************************************************************/
 389
 390 int regval_ctr_copyvalue( REGVAL_CTR *ctr, REGISTRY_VALUE *val )
 391 {
 392         if ( val ) {
 393                 regval_ctr_addvalue(ctr, val->valuename, val->type,
 394                                     (char *)val->data_p, val->size);
 395         }
 396
 397         return ctr->num_values;
 398 }
 399
 400 /***********************************************************************
 401  Delete a single value from the registry container.
 402  No need to free memory since it is talloc'd.
 403  **********************************************************************/
 404
 405 int regval_ctr_delvalue( REGVAL_CTR *ctr, const char *name )
 406 {
 407         int     i;
 408
 409         for ( i=0; i<ctr->num_values; i++ ) {
 410                 if ( strequal( ctr->values[i]->valuename, name ) )
 411                         break;
 412         }
 413
 414         /* just return if we don't find it */
 415
 416         if ( i == ctr->num_values )
 417                 return ctr->num_values;
 418
 419         /* If 'i' was not the last element, just shift everything down one */
 420         ctr->num_values--;
 421         if ( i < ctr->num_values )
 422                 memmove(&ctr->values[i], &ctr->values[i+1],
 423                         sizeof(REGISTRY_VALUE*)*(ctr->num_values-i));
 424
 425         return ctr->num_values;
 426 }
 427
 428 /***********************************************************************
 429  Retrieve single value from the registry container.
 430  No need to free memory since it is talloc'd.
 431  **********************************************************************/
 432
 433 REGISTRY_VALUE* regval_ctr_getvalue( REGVAL_CTR *ctr, const char *name )
 434 {
 435         int     i;
 436
 437         /* search for the value */
 438
 439         for ( i=0; i<ctr->num_values; i++ ) {
 440                 if ( strequal( ctr->values[i]->valuename, name ) )
 441                         return ctr->values[i];
 442         }
 443
 444         return NULL;
 445 }
 446
 447 /***********************************************************************
 448  return the data_p as a uint32
 449  **********************************************************************/
 450
 451 uint32 regval_dword( REGISTRY_VALUE *val )
 452 {
 453         uint32 data;
 454
 455         data = IVAL( regval_data_p(val), 0 );
 456
 457         return data;
 458 }
 459
 460 /***********************************************************************
 461  return the data_p as a character string
 462  **********************************************************************/
 463
 464 char *regval_sz(REGISTRY_VALUE *val)
 465 {
 466         char *data = NULL;
 467
 468         rpcstr_pull_talloc(talloc_tos(), &data,
 469                         regval_data_p(val), regval_size(val),0);
 470         return data;
 471 }