Always initialize lpWaveHdr->lpNext to NULL.
[wine.git] / server / registry.c
blob188725e8b69dea947ff77d60663ade61e0b199d7
1 /*
2 * Server-side registry management
4 * Copyright (C) 1999 Alexandre Julliard
5 */
7 /* To do:
8 * - behavior with deleted keys
9 * - values larger than request buffer
10 * - symbolic links
13 #include <assert.h>
14 #include <limits.h>
15 #include <stdio.h>
16 #include <stdlib.h>
17 #include <unistd.h>
18 #include "object.h"
19 #include "handle.h"
20 #include "request.h"
21 #include "unicode.h"
23 #include "winbase.h"
24 #include "winerror.h"
25 #include "winreg.h"
28 /* a registry key */
29 struct key
31 struct object obj; /* object header */
32 WCHAR *name; /* key name */
33 WCHAR *class; /* key class */
34 struct key *parent; /* parent key */
35 int last_subkey; /* last in use subkey */
36 int nb_subkeys; /* count of allocated subkeys */
37 struct key **subkeys; /* subkeys array */
38 int last_value; /* last in use value */
39 int nb_values; /* count of allocated values in array */
40 struct key_value *values; /* values array */
41 short flags; /* flags */
42 short level; /* saving level */
43 time_t modif; /* last modification time */
46 /* key flags */
47 #define KEY_VOLATILE 0x0001 /* key is volatile (not saved to disk) */
48 #define KEY_DELETED 0x0002 /* key has been deleted */
49 #define KEY_ROOT 0x0004 /* key is a root key */
51 /* a key value */
52 struct key_value
54 WCHAR *name; /* value name */
55 int type; /* value type */
56 size_t len; /* value data length in bytes */
57 void *data; /* pointer to value data */
60 #define MIN_SUBKEYS 8 /* min. number of allocated subkeys per key */
61 #define MIN_VALUES 8 /* min. number of allocated values per key */
64 /* the root keys */
65 #define HKEY_ROOT_FIRST HKEY_CLASSES_ROOT
66 #define HKEY_ROOT_LAST HKEY_DYN_DATA
67 #define NB_ROOT_KEYS (HKEY_ROOT_LAST - HKEY_ROOT_FIRST + 1)
68 #define IS_ROOT_HKEY(h) (((h) >= HKEY_ROOT_FIRST) && ((h) <= HKEY_ROOT_LAST))
69 static struct key *root_keys[NB_ROOT_KEYS];
71 static const char * const root_key_names[NB_ROOT_KEYS] =
73 "HKEY_CLASSES_ROOT",
74 "HKEY_CURRENT_USER",
75 "HKEY_LOCAL_MACHINE",
76 "HKEY_USERS",
77 "HKEY_PERFORMANCE_DATA",
78 "HKEY_CURRENT_CONFIG",
79 "HKEY_DYN_DATA"
83 /* keys saving level */
84 /* current_level is the level that is put into all newly created or modified keys */
85 /* saving_level is the minimum level that a key needs in order to get saved */
86 static int current_level;
87 static int saving_level;
89 static int saving_version = 1; /* file format version */
92 /* information about a file being loaded */
93 struct file_load_info
95 FILE *file; /* input file */
96 char *buffer; /* line buffer */
97 int len; /* buffer length */
98 int line; /* current input line */
99 char *tmp; /* temp buffer to use while parsing input */
100 int tmplen; /* length of temp buffer */
104 static void key_dump( struct object *obj, int verbose );
105 static void key_destroy( struct object *obj );
107 static const struct object_ops key_ops =
109 sizeof(struct key), /* size */
110 key_dump, /* dump */
111 no_add_queue, /* add_queue */
112 NULL, /* remove_queue */
113 NULL, /* signaled */
114 NULL, /* satisfied */
115 NULL, /* get_poll_events */
116 NULL, /* poll_event */
117 no_read_fd, /* get_read_fd */
118 no_write_fd, /* get_write_fd */
119 no_flush, /* flush */
120 no_get_file_info, /* get_file_info */
121 key_destroy /* destroy */
126 * The registry text file format v2 used by this code is similar to the one
127 * used by REGEDIT import/export functionality, with the following differences:
128 * - strings and key names can contain \x escapes for Unicode
129 * - key names use escapes too in order to support Unicode
130 * - the modification time optionally follows the key name
131 * - REG_EXPAND_SZ and REG_MULTI_SZ are saved as strings instead of hex
134 static inline char to_hex( char ch )
136 if (isdigit(ch)) return ch - '0';
137 return tolower(ch) - 'a' + 10;
140 /* dump the full path of a key */
141 static void dump_path( struct key *key, struct key *base, FILE *f )
143 if (key->parent && key != base)
145 dump_path( key->parent, base, f );
146 fprintf( f, "\\\\" );
149 if (key->name) dump_strW( key->name, strlenW(key->name), f, "[]" );
150 else /* root key */
152 int i;
153 for (i = 0; i < NB_ROOT_KEYS; i++)
154 if (root_keys[i] == key) fprintf( f, "%s", root_key_names[i] );
158 /* dump a value to a text file */
159 static void dump_value( struct key_value *value, FILE *f )
161 int i, count;
163 if (value->name[0])
165 fputc( '\"', f );
166 count = 1 + dump_strW( value->name, strlenW(value->name), f, "\"\"" );
167 count += fprintf( f, "\"=" );
169 else count = fprintf( f, "@=" );
171 switch(value->type)
173 case REG_SZ:
174 case REG_EXPAND_SZ:
175 case REG_MULTI_SZ:
176 if (value->type != REG_SZ) fprintf( f, "str(%d):", value->type );
177 fputc( '\"', f );
178 if (value->data) dump_strW( (WCHAR *)value->data, value->len / sizeof(WCHAR), f, "\"\"" );
179 fputc( '\"', f );
180 break;
181 case REG_DWORD:
182 if (value->len == sizeof(DWORD))
184 DWORD dw;
185 memcpy( &dw, value->data, sizeof(DWORD) );
186 fprintf( f, "dword:%08lx", dw );
187 break;
189 /* else fall through */
190 default:
191 if (value->type == REG_BINARY) count += fprintf( f, "hex:" );
192 else count += fprintf( f, "hex(%x):", value->type );
193 for (i = 0; i < value->len; i++)
195 count += fprintf( f, "%02x", *((unsigned char *)value->data + i) );
196 if (i < value->len-1)
198 fputc( ',', f );
199 if (++count > 76)
201 fprintf( f, "\\\n " );
202 count = 2;
206 break;
208 fputc( '\n', f );
211 /* save a registry and all its subkeys to a text file */
212 static void save_subkeys( struct key *key, struct key *base, FILE *f )
214 int i;
216 if (key->flags & KEY_VOLATILE) return;
217 /* save key if it has the proper level, and has either some values or no subkeys */
218 /* keys with no values but subkeys are saved implicitly by saving the subkeys */
219 if ((key->level >= saving_level) && ((key->last_value >= 0) || (key->last_subkey == -1)))
221 fprintf( f, "\n[" );
222 dump_path( key, base, f );
223 fprintf( f, "] %ld\n", key->modif );
224 for (i = 0; i <= key->last_value; i++) dump_value( &key->values[i], f );
226 for (i = 0; i <= key->last_subkey; i++) save_subkeys( key->subkeys[i], base, f );
229 static void dump_operation( struct key *key, struct key_value *value, const char *op )
231 fprintf( stderr, "%s key ", op );
232 if (key) dump_path( key, NULL, stderr );
233 else fprintf( stderr, "ERROR" );
234 if (value)
236 fprintf( stderr, " value ");
237 dump_value( value, stderr );
239 else fprintf( stderr, "\n" );
242 static void key_dump( struct object *obj, int verbose )
244 struct key *key = (struct key *)obj;
245 assert( obj->ops == &key_ops );
246 fprintf( stderr, "Key flags=%x ", key->flags );
247 dump_path( key, NULL, stderr );
248 fprintf( stderr, "\n" );
251 static void key_destroy( struct object *obj )
253 int i;
254 struct key *key = (struct key *)obj;
255 assert( obj->ops == &key_ops );
257 free( key->name );
258 if (key->class) free( key->class );
259 for (i = 0; i <= key->last_value; i++)
261 free( key->values[i].name );
262 if (key->values[i].data) free( key->values[i].data );
264 for (i = 0; i <= key->last_subkey; i++)
266 key->subkeys[i]->parent = NULL;
267 release_object( key->subkeys[i] );
271 /* duplicate a key path from the request buffer */
272 /* returns a pointer to a static buffer, so only useable once per request */
273 static WCHAR *copy_path( const path_t path )
275 static WCHAR buffer[MAX_PATH+1];
276 WCHAR *p = buffer;
278 while (p < buffer + sizeof(buffer) - 1) if (!(*p++ = *path++)) break;
279 *p = 0;
280 return buffer;
283 /* return the next token in a given path */
284 /* returns a pointer to a static buffer, so only useable once per request */
285 static WCHAR *get_path_token( const WCHAR *initpath, size_t maxlen )
287 static const WCHAR *path;
288 static const WCHAR *end;
289 static WCHAR buffer[MAX_PATH+1];
290 WCHAR *p = buffer;
292 if (initpath)
294 path = initpath;
295 end = path + maxlen / sizeof(WCHAR);
297 while ((path < end) && (*path == '\\')) path++;
298 while ((path < end) && (p < buffer + sizeof(buffer) - 1))
300 WCHAR ch = *path;
301 if (!ch || (ch == '\\')) break;
302 *p++ = ch;
303 path++;
305 *p = 0;
306 return buffer;
309 /* duplicate a Unicode string from the request buffer */
310 static WCHAR *req_strdupW( const WCHAR *str )
312 WCHAR *name;
313 size_t len = get_req_strlenW( str );
314 if ((name = mem_alloc( (len + 1) * sizeof(WCHAR) )) != NULL)
316 memcpy( name, str, len * sizeof(WCHAR) );
317 name[len] = 0;
319 return name;
322 /* allocate a key object */
323 static struct key *alloc_key( const WCHAR *name, time_t modif )
325 struct key *key;
326 if ((key = (struct key *)alloc_object( &key_ops, -1 )))
328 key->name = NULL;
329 key->class = NULL;
330 key->flags = 0;
331 key->last_subkey = -1;
332 key->nb_subkeys = 0;
333 key->subkeys = NULL;
334 key->nb_values = 0;
335 key->last_value = -1;
336 key->values = NULL;
337 key->level = current_level;
338 key->modif = modif;
339 key->parent = NULL;
340 if (name && !(key->name = strdupW( name )))
342 release_object( key );
343 key = NULL;
346 return key;
349 /* update key modification time */
350 static void touch_key( struct key *key )
352 key->modif = time(NULL);
353 key->level = MAX( key->level, current_level );
356 /* try to grow the array of subkeys; return 1 if OK, 0 on error */
357 static int grow_subkeys( struct key *key )
359 struct key **new_subkeys;
360 int nb_subkeys;
362 if (key->nb_subkeys)
364 nb_subkeys = key->nb_subkeys + (key->nb_subkeys / 2); /* grow by 50% */
365 if (!(new_subkeys = realloc( key->subkeys, nb_subkeys * sizeof(*new_subkeys) )))
367 set_error( ERROR_OUTOFMEMORY );
368 return 0;
371 else
373 nb_subkeys = MIN_VALUES;
374 if (!(new_subkeys = mem_alloc( nb_subkeys * sizeof(*new_subkeys) ))) return 0;
376 key->subkeys = new_subkeys;
377 key->nb_subkeys = nb_subkeys;
378 return 1;
381 /* allocate a subkey for a given key, and return its index */
382 static struct key *alloc_subkey( struct key *parent, const WCHAR *name, int index, time_t modif )
384 struct key *key;
385 int i;
387 if (parent->last_subkey + 1 == parent->nb_subkeys)
389 /* need to grow the array */
390 if (!grow_subkeys( parent )) return NULL;
392 if ((key = alloc_key( name, modif )) != NULL)
394 key->parent = parent;
395 for (i = ++parent->last_subkey; i > index; i--)
396 parent->subkeys[i] = parent->subkeys[i-1];
397 parent->subkeys[index] = key;
399 return key;
402 /* free a subkey of a given key */
403 static void free_subkey( struct key *parent, int index )
405 struct key *key;
406 int i, nb_subkeys;
408 assert( index >= 0 );
409 assert( index <= parent->last_subkey );
411 key = parent->subkeys[index];
412 for (i = index; i < parent->last_subkey; i++) parent->subkeys[i] = parent->subkeys[i + 1];
413 parent->last_subkey--;
414 key->flags |= KEY_DELETED;
415 key->parent = NULL;
416 release_object( key );
418 /* try to shrink the array */
419 nb_subkeys = key->nb_subkeys;
420 if (nb_subkeys > MIN_SUBKEYS && key->last_subkey < nb_subkeys / 2)
422 struct key **new_subkeys;
423 nb_subkeys -= nb_subkeys / 3; /* shrink by 33% */
424 if (nb_subkeys < MIN_SUBKEYS) nb_subkeys = MIN_SUBKEYS;
425 if (!(new_subkeys = realloc( key->subkeys, nb_subkeys * sizeof(*new_subkeys) ))) return;
426 key->subkeys = new_subkeys;
427 key->nb_subkeys = nb_subkeys;
431 /* find the named child of a given key and return its index */
432 static struct key *find_subkey( struct key *key, const WCHAR *name, int *index )
434 int i, min, max, res;
436 min = 0;
437 max = key->last_subkey;
438 while (min <= max)
440 i = (min + max) / 2;
441 if (!(res = strcmpiW( key->subkeys[i]->name, name )))
443 *index = i;
444 return key->subkeys[i];
446 if (res > 0) max = i - 1;
447 else min = i + 1;
449 *index = min; /* this is where we should insert it */
450 return NULL;
453 /* open a subkey */
454 static struct key *open_key( struct key *key, const WCHAR *name, size_t maxlen )
456 int index;
457 WCHAR *path;
459 path = get_path_token( name, maxlen );
460 while (*path)
462 if (!(key = find_subkey( key, path, &index )))
464 set_error( ERROR_FILE_NOT_FOUND );
465 break;
467 path = get_path_token( NULL, 0 );
470 if (debug_level > 1) dump_operation( key, NULL, "Open" );
471 if (key) grab_object( key );
472 return key;
475 /* create a subkey */
476 static struct key *create_key( struct key *key, const WCHAR *name, size_t maxlen, WCHAR *class,
477 unsigned int options, time_t modif, int *created )
479 struct key *base;
480 int base_idx, index, flags = 0;
481 WCHAR *path;
483 if (key->flags & KEY_DELETED) /* we cannot create a subkey under a deleted key */
485 set_error( ERROR_KEY_DELETED );
486 return NULL;
488 if (options & REG_OPTION_VOLATILE) flags |= KEY_VOLATILE;
489 else if (key->flags & KEY_VOLATILE)
491 set_error( ERROR_CHILD_MUST_BE_VOLATILE );
492 return NULL;
495 path = get_path_token( name, maxlen );
496 *created = 0;
497 while (*path)
499 struct key *subkey;
500 if (!(subkey = find_subkey( key, path, &index ))) break;
501 key = subkey;
502 path = get_path_token( NULL, 0 );
505 /* create the remaining part */
507 if (!*path) goto done;
508 *created = 1;
509 base = key;
510 base_idx = index;
511 key = alloc_subkey( key, path, index, modif );
512 while (key)
514 key->flags |= flags;
515 path = get_path_token( NULL, 0 );
516 if (!*path) goto done;
517 /* we know the index is always 0 in a new key */
518 key = alloc_subkey( key, path, 0, modif );
520 if (base_idx != -1) free_subkey( base, base_idx );
521 return NULL;
523 done:
524 if (debug_level > 1) dump_operation( key, NULL, "Create" );
525 if (class) key->class = strdupW(class);
526 grab_object( key );
527 return key;
530 /* find a subkey of a given key by its index */
531 static void enum_key( struct key *parent, int index, WCHAR *name, WCHAR *class, time_t *modif )
533 struct key *key;
535 if ((index < 0) || (index > parent->last_subkey)) set_error( ERROR_NO_MORE_ITEMS );
536 else
538 key = parent->subkeys[index];
539 *modif = key->modif;
540 strcpyW( name, key->name );
541 if (key->class) strcpyW( class, key->class ); /* FIXME: length */
542 else *class = 0;
543 if (debug_level > 1) dump_operation( key, NULL, "Enum" );
547 /* query information about a key */
548 static void query_key( struct key *key, struct query_key_info_request *req )
550 int i, len;
551 int max_subkey = 0, max_class = 0;
552 int max_value = 0, max_data = 0;
554 for (i = 0; i <= key->last_subkey; i++)
556 struct key *subkey = key->subkeys[i];
557 len = strlenW( subkey->name );
558 if (len > max_subkey) max_subkey = len;
559 if (!subkey->class) continue;
560 len = strlenW( subkey->class );
561 if (len > max_class) max_class = len;
563 for (i = 0; i <= key->last_value; i++)
565 len = strlenW( key->values[i].name );
566 if (len > max_value) max_value = len;
567 len = key->values[i].len;
568 if (len > max_data) max_data = len;
570 req->subkeys = key->last_subkey + 1;
571 req->max_subkey = max_subkey;
572 req->max_class = max_class;
573 req->values = key->last_value + 1;
574 req->max_value = max_value;
575 req->max_data = max_data;
576 req->modif = key->modif;
577 strcpyW( req->name, key->name);
578 if (key->class) strcpyW( req->class, key->class ); /* FIXME: length */
579 else req->class[0] = 0;
580 if (debug_level > 1) dump_operation( key, NULL, "Query" );
583 /* delete a key and its values */
584 static void delete_key( struct key *key, const WCHAR *name, size_t maxlen )
586 int index;
587 struct key *parent;
588 WCHAR *path;
590 path = get_path_token( name, maxlen );
591 if (!*path)
593 /* deleting this key, must find parent and index */
594 if (key->flags & KEY_ROOT)
596 set_error( ERROR_ACCESS_DENIED );
597 return;
599 if (!(parent = key->parent) || (key->flags & KEY_DELETED))
601 set_error( ERROR_KEY_DELETED );
602 return;
604 for (index = 0; index <= parent->last_subkey; index++)
605 if (parent->subkeys[index] == key) break;
606 assert( index <= parent->last_subkey );
608 else while (*path)
610 parent = key;
611 if (!(key = find_subkey( parent, path, &index )))
613 set_error( ERROR_FILE_NOT_FOUND );
614 return;
616 path = get_path_token( NULL, 0 );
619 /* we can only delete a key that has no subkeys (FIXME) */
620 if ((key->flags & KEY_ROOT) || (key->last_subkey >= 0))
622 set_error( ERROR_ACCESS_DENIED );
623 return;
625 if (debug_level > 1) dump_operation( key, NULL, "Delete" );
626 free_subkey( parent, index );
627 touch_key( parent );
630 /* try to grow the array of values; return 1 if OK, 0 on error */
631 static int grow_values( struct key *key )
633 struct key_value *new_val;
634 int nb_values;
636 if (key->nb_values)
638 nb_values = key->nb_values + (key->nb_values / 2); /* grow by 50% */
639 if (!(new_val = realloc( key->values, nb_values * sizeof(*new_val) )))
641 set_error( ERROR_OUTOFMEMORY );
642 return 0;
645 else
647 nb_values = MIN_VALUES;
648 if (!(new_val = mem_alloc( nb_values * sizeof(*new_val) ))) return 0;
650 key->values = new_val;
651 key->nb_values = nb_values;
652 return 1;
655 /* find the named value of a given key and return its index in the array */
656 static struct key_value *find_value( const struct key *key, const WCHAR *name, int *index )
658 int i, min, max, res;
660 min = 0;
661 max = key->last_value;
662 while (min <= max)
664 i = (min + max) / 2;
665 if (!(res = strcmpiW( key->values[i].name, name )))
667 *index = i;
668 return &key->values[i];
670 if (res > 0) max = i - 1;
671 else min = i + 1;
673 *index = min; /* this is where we should insert it */
674 return NULL;
677 /* insert a new value or return a pointer to an existing one */
678 static struct key_value *insert_value( struct key *key, const WCHAR *name )
680 struct key_value *value;
681 WCHAR *new_name;
682 int i, index;
684 if (!(value = find_value( key, name, &index )))
686 /* not found, add it */
687 if (key->last_value + 1 == key->nb_values)
689 if (!grow_values( key )) return NULL;
691 if (!(new_name = strdupW(name))) return NULL;
692 for (i = ++key->last_value; i > index; i--) key->values[i] = key->values[i - 1];
693 value = &key->values[index];
694 value->name = new_name;
695 value->len = 0;
696 value->data = NULL;
698 return value;
701 /* set a key value */
702 static void set_value( struct key *key, WCHAR *name, int type, int datalen, void *data )
704 struct key_value *value;
705 void *ptr = NULL;
707 /* first copy the data */
708 if (datalen)
710 if (!(ptr = mem_alloc( datalen ))) return;
711 memcpy( ptr, data, datalen );
714 if (!(value = insert_value( key, name )))
716 if (ptr) free( ptr );
717 return;
719 if (value->data) free( value->data ); /* already existing, free previous data */
720 value->type = type;
721 value->len = datalen;
722 value->data = ptr;
723 touch_key( key );
724 if (debug_level > 1) dump_operation( key, value, "Set" );
727 /* get a key value */
728 static void get_value( struct key *key, WCHAR *name, int *type, int *len, void *data )
730 struct key_value *value;
731 int index;
733 if ((value = find_value( key, name, &index )))
735 *type = value->type;
736 *len = value->len;
737 if (value->data) memcpy( data, value->data, value->len );
738 if (debug_level > 1) dump_operation( key, value, "Get" );
740 else
742 *type = -1;
743 *len = 0;
744 set_error( ERROR_FILE_NOT_FOUND );
748 /* enumerate a key value */
749 static void enum_value( struct key *key, int i, WCHAR *name, int *type, int *len, void *data )
751 struct key_value *value;
753 if (i < 0 || i > key->last_value)
755 name[0] = 0;
756 *len = 0;
757 set_error( ERROR_NO_MORE_ITEMS );
759 else
761 value = &key->values[i];
762 strcpyW( name, value->name );
763 *type = value->type;
764 *len = value->len;
765 if (value->data) memcpy( data, value->data, value->len );
766 if (debug_level > 1) dump_operation( key, value, "Enum" );
770 /* delete a value */
771 static void delete_value( struct key *key, const WCHAR *name )
773 struct key_value *value;
774 int i, index, nb_values;
776 if (!(value = find_value( key, name, &index )))
778 set_error( ERROR_FILE_NOT_FOUND );
779 return;
781 if (debug_level > 1) dump_operation( key, value, "Delete" );
782 free( value->name );
783 if (value->data) free( value->data );
784 for (i = index; i < key->last_value; i++) key->values[i] = key->values[i + 1];
785 key->last_value--;
786 touch_key( key );
788 /* try to shrink the array */
789 nb_values = key->nb_values;
790 if (nb_values > MIN_VALUES && key->last_value < nb_values / 2)
792 struct key_value *new_val;
793 nb_values -= nb_values / 3; /* shrink by 33% */
794 if (nb_values < MIN_VALUES) nb_values = MIN_VALUES;
795 if (!(new_val = realloc( key->values, nb_values * sizeof(*new_val) ))) return;
796 key->values = new_val;
797 key->nb_values = nb_values;
801 static struct key *get_hkey_obj( int hkey, unsigned int access );
803 static struct key *create_root_key( int hkey )
805 int dummy;
806 struct key *key;
808 switch(hkey)
810 /* the two real root-keys */
811 case HKEY_LOCAL_MACHINE:
813 static const WCHAR name[] = { 'M','A','C','H','I','N','E',0 };
814 key = alloc_key( name, time(NULL) );
816 break;
817 case HKEY_USERS:
819 static const WCHAR name[] = { 'U','S','E','R',0 };
820 key = alloc_key( name, time(NULL) );
822 break;
823 /* special subkeys */
824 case HKEY_CLASSES_ROOT:
826 static const WCHAR name[] =
827 { 'S','O','F','T','W','A','R','E','\\','C','l','a','s','s','e','s',0 };
829 struct key *root = get_hkey_obj( HKEY_LOCAL_MACHINE, 0 );
830 if (!root) return NULL;
831 key = create_key( root, name, sizeof(name), NULL, 0, time(NULL), &dummy );
832 release_object( root );
834 break;
835 case HKEY_CURRENT_CONFIG:
837 static const WCHAR name[] = {
838 'S','Y','S','T','E','M','\\',
839 'C','U','R','R','E','N','T','C','O','N','T','R','O','L','S','E','T','\\',
840 'H','A','R','D','W','A','R','E','P','R','O','F','I','L','E','S','\\',
841 'C','U','R','R','E','N','T',0};
842 struct key *root = get_hkey_obj( HKEY_LOCAL_MACHINE, 0 );
843 if (!root) return NULL;
844 key = create_key( root, name, sizeof(name), NULL, 0, time(NULL), &dummy );
845 release_object( root );
847 break;
848 case HKEY_CURRENT_USER:
850 /* FIXME: should be HKEY_USERS\\the_current_user_SID */
851 static const WCHAR name[] = { '.','D','e','f','a','u','l','t',0 };
852 struct key *root = get_hkey_obj( HKEY_USERS, 0 );
853 if (!root) return NULL;
854 key = create_key( root, name, sizeof(name), NULL, 0, time(NULL), &dummy );
855 release_object( root );
857 break;
858 /* dynamically generated keys */
859 case HKEY_PERFORMANCE_DATA:
860 case HKEY_DYN_DATA:
861 key = alloc_key( NULL, time(NULL) );
862 break;
863 default:
864 key = NULL;
865 assert(0);
867 if (key)
869 root_keys[hkey - HKEY_ROOT_FIRST] = key;
870 key->flags |= KEY_ROOT;
872 return key;
875 /* close the top-level keys; used on server exit */
876 void close_registry(void)
878 int i;
879 for (i = 0; i < NB_ROOT_KEYS; i++)
881 if (root_keys[i]) release_object( root_keys[i] );
885 /* get the registry key corresponding to an hkey handle */
886 static struct key *get_hkey_obj( int hkey, unsigned int access )
888 struct key *key;
890 if (IS_ROOT_HKEY(hkey))
892 if (!(key = root_keys[hkey - HKEY_ROOT_FIRST])) key = create_root_key( hkey );
893 grab_object( key );
895 else
896 key = (struct key *)get_handle_obj( current->process, hkey, access, &key_ops );
897 return key;
900 /* read a line from the input file */
901 static int read_next_line( struct file_load_info *info )
903 char *newbuf;
904 int newlen, pos = 0;
906 info->line++;
907 for (;;)
909 if (!fgets( info->buffer + pos, info->len - pos, info->file ))
910 return (pos != 0); /* EOF */
911 pos = strlen(info->buffer);
912 if (info->buffer[pos-1] == '\n')
914 /* got a full line */
915 info->buffer[--pos] = 0;
916 if (pos > 0 && info->buffer[pos-1] == '\r') info->buffer[pos-1] = 0;
917 return 1;
919 if (pos < info->len - 1) return 1; /* EOF but something was read */
921 /* need to enlarge the buffer */
922 newlen = info->len + info->len / 2;
923 if (!(newbuf = realloc( info->buffer, newlen )))
925 set_error( ERROR_OUTOFMEMORY );
926 return -1;
928 info->buffer = newbuf;
929 info->len = newlen;
933 /* make sure the temp buffer holds enough space */
934 static int get_file_tmp_space( struct file_load_info *info, int size )
936 char *tmp;
937 if (info->tmplen >= size) return 1;
938 if (!(tmp = realloc( info->tmp, size )))
940 set_error( ERROR_OUTOFMEMORY );
941 return 0;
943 info->tmp = tmp;
944 info->tmplen = size;
945 return 1;
948 /* report an error while loading an input file */
949 static void file_read_error( const char *err, struct file_load_info *info )
951 fprintf( stderr, "Line %d: %s '%s'\n", info->line, err, info->buffer );
954 /* parse an escaped string back into Unicode */
955 /* return the number of chars read from the input, or -1 on output overflow */
956 static int parse_strW( WCHAR *dest, int *len, const char *src, char endchar )
958 int count = sizeof(WCHAR); /* for terminating null */
959 const char *p = src;
960 while (*p && *p != endchar)
962 if (*p != '\\') *dest = (WCHAR)*p++;
963 else
965 p++;
966 switch(*p)
968 case 'a': *dest = '\a'; p++; break;
969 case 'b': *dest = '\b'; p++; break;
970 case 'e': *dest = '\e'; p++; break;
971 case 'f': *dest = '\f'; p++; break;
972 case 'n': *dest = '\n'; p++; break;
973 case 'r': *dest = '\r'; p++; break;
974 case 't': *dest = '\t'; p++; break;
975 case 'v': *dest = '\v'; p++; break;
976 case 'x': /* hex escape */
977 p++;
978 if (!isxdigit(*p)) *dest = 'x';
979 else
981 *dest = to_hex(*p++);
982 if (isxdigit(*p)) *dest = (*dest * 16) + to_hex(*p++);
983 if (isxdigit(*p)) *dest = (*dest * 16) + to_hex(*p++);
984 if (isxdigit(*p)) *dest = (*dest * 16) + to_hex(*p++);
986 break;
987 case '0':
988 case '1':
989 case '2':
990 case '3':
991 case '4':
992 case '5':
993 case '6':
994 case '7': /* octal escape */
995 *dest = *p++ - '0';
996 if (*p >= '0' && *p <= '7') *dest = (*dest * 8) + (*p++ - '0');
997 if (*p >= '0' && *p <= '7') *dest = (*dest * 8) + (*p++ - '0');
998 break;
999 default:
1000 *dest = (WCHAR)*p++;
1001 break;
1004 if ((count += sizeof(WCHAR)) > *len) return -1; /* dest buffer overflow */
1005 dest++;
1007 *dest = 0;
1008 if (!*p) return -1; /* delimiter not found */
1009 *len = count;
1010 return p + 1 - src;
1013 /* convert a data type tag to a value type */
1014 static int get_data_type( const char *buffer, int *type, int *parse_type )
1016 struct data_type { const char *tag; int len; int type; int parse_type; };
1018 static const struct data_type data_types[] =
1019 { /* actual type */ /* type to assume for parsing */
1020 { "\"", 1, REG_SZ, REG_SZ },
1021 { "str:\"", 5, REG_SZ, REG_SZ },
1022 { "str(2):\"", 8, REG_EXPAND_SZ, REG_SZ },
1023 { "str(7):\"", 8, REG_MULTI_SZ, REG_SZ },
1024 { "hex:", 4, REG_BINARY, REG_BINARY },
1025 { "dword:", 6, REG_DWORD, REG_DWORD },
1026 { "hex(", 4, -1, REG_BINARY },
1027 { NULL, }
1030 const struct data_type *ptr;
1031 char *end;
1033 for (ptr = data_types; ptr->tag; ptr++)
1035 if (memcmp( ptr->tag, buffer, ptr->len )) continue;
1036 *parse_type = ptr->parse_type;
1037 if ((*type = ptr->type) != -1) return ptr->len;
1038 /* "hex(xx):" is special */
1039 *type = (int)strtoul( buffer + 4, &end, 16 );
1040 if ((end <= buffer) || memcmp( end, "):", 2 )) return 0;
1041 return end + 2 - buffer;
1043 return 0;
1046 /* load and create a key from the input file */
1047 static struct key *load_key( struct key *base, const char *buffer, struct file_load_info *info )
1049 WCHAR *p;
1050 int res, len, modif;
1052 len = strlen(buffer) * sizeof(WCHAR);
1053 if (!get_file_tmp_space( info, len )) return NULL;
1055 if ((res = parse_strW( (WCHAR *)info->tmp, &len, buffer, ']' )) == -1)
1057 file_read_error( "Malformed key", info );
1058 return NULL;
1060 if (!sscanf( buffer + res, " %d", &modif )) modif = time(NULL);
1062 for (p = (WCHAR *)info->tmp; *p; p++) if (*p == '\\') { p++; break; }
1063 return create_key( base, p, len - ((char *)p - info->tmp), NULL, 0, modif, &res );
1066 /* parse a comma-separated list of hex digits */
1067 static int parse_hex( unsigned char *dest, int *len, const char *buffer )
1069 const char *p = buffer;
1070 int count = 0;
1071 while (isxdigit(*p))
1073 int val;
1074 char buf[3];
1075 memcpy( buf, p, 2 );
1076 buf[2] = 0;
1077 sscanf( buf, "%x", &val );
1078 if (count++ >= *len) return -1; /* dest buffer overflow */
1079 *dest++ = (unsigned char )val;
1080 p += 2;
1081 if (*p == ',') p++;
1083 *len = count;
1084 return p - buffer;
1087 /* parse a value name and create the corresponding value */
1088 static struct key_value *parse_value_name( struct key *key, const char *buffer, int *len,
1089 struct file_load_info *info )
1091 int maxlen = strlen(buffer) * sizeof(WCHAR);
1092 if (!get_file_tmp_space( info, maxlen )) return NULL;
1093 if (buffer[0] == '@')
1095 info->tmp[0] = info->tmp[1] = 0;
1096 *len = 1;
1098 else
1100 if ((*len = parse_strW( (WCHAR *)info->tmp, &maxlen, buffer + 1, '\"' )) == -1) goto error;
1101 (*len)++; /* for initial quote */
1103 if (buffer[*len] != '=') goto error;
1104 (*len)++;
1105 return insert_value( key, (WCHAR *)info->tmp );
1107 error:
1108 file_read_error( "Malformed value name", info );
1109 return NULL;
1112 /* load a value from the input file */
1113 static int load_value( struct key *key, const char *buffer, struct file_load_info *info )
1115 DWORD dw;
1116 void *ptr, *newptr;
1117 int maxlen, len, res;
1118 int type, parse_type;
1119 struct key_value *value;
1121 if (!(value = parse_value_name( key, buffer, &len, info ))) return 0;
1122 if (!(res = get_data_type( buffer + len, &type, &parse_type ))) goto error;
1123 buffer += len + res;
1125 switch(parse_type)
1127 case REG_SZ:
1128 len = strlen(buffer) * sizeof(WCHAR);
1129 if (!get_file_tmp_space( info, len )) return 0;
1130 if ((res = parse_strW( (WCHAR *)info->tmp, &len, buffer, '\"' )) == -1) goto error;
1131 ptr = info->tmp;
1132 break;
1133 case REG_DWORD:
1134 dw = strtoul( buffer, NULL, 16 );
1135 ptr = &dw;
1136 len = sizeof(dw);
1137 break;
1138 case REG_BINARY: /* hex digits */
1139 len = 0;
1140 for (;;)
1142 maxlen = 1 + strlen(buffer)/3; /* 3 chars for one hex byte */
1143 if (!get_file_tmp_space( info, len + maxlen )) return 0;
1144 if ((res = parse_hex( info->tmp + len, &maxlen, buffer )) == -1) goto error;
1145 len += maxlen;
1146 buffer += res;
1147 while (isspace(*buffer)) buffer++;
1148 if (!*buffer) break;
1149 if (*buffer != '\\') goto error;
1150 if (read_next_line( info) != 1) goto error;
1151 buffer = info->buffer;
1152 while (isspace(*buffer)) buffer++;
1154 ptr = info->tmp;
1155 break;
1156 default:
1157 assert(0);
1158 ptr = NULL; /* keep compiler quiet */
1159 break;
1162 if (!len) newptr = NULL;
1163 else if (!(newptr = memdup( ptr, len ))) return 0;
1165 if (value->data) free( value->data );
1166 value->data = newptr;
1167 value->len = len;
1168 value->type = type;
1169 /* update the key level but not the modification time */
1170 key->level = MAX( key->level, current_level );
1171 return 1;
1173 error:
1174 file_read_error( "Malformed value", info );
1175 return 0;
1178 /* load all the keys from the input file */
1179 static void load_keys( struct key *key, FILE *f )
1181 struct key *subkey = NULL;
1182 struct file_load_info info;
1183 char *p;
1185 info.file = f;
1186 info.len = 4;
1187 info.tmplen = 4;
1188 info.line = 0;
1189 if (!(info.buffer = mem_alloc( info.len ))) return;
1190 if (!(info.tmp = mem_alloc( info.tmplen )))
1192 free( info.buffer );
1193 return;
1196 if ((read_next_line( &info ) != 1) ||
1197 strcmp( info.buffer, "WINE REGISTRY Version 2" ))
1199 set_error( ERROR_NOT_REGISTRY_FILE );
1200 goto done;
1203 while (read_next_line( &info ) == 1)
1205 for (p = info.buffer; *p && isspace(*p); p++);
1206 switch(*p)
1208 case '[': /* new key */
1209 if (subkey) release_object( subkey );
1210 subkey = load_key( key, p + 1, &info );
1211 break;
1212 case '@': /* default value */
1213 case '\"': /* value */
1214 if (subkey) load_value( subkey, p, &info );
1215 else file_read_error( "Value without key", &info );
1216 break;
1217 case '#': /* comment */
1218 case ';': /* comment */
1219 case 0: /* empty line */
1220 break;
1221 default:
1222 file_read_error( "Unrecognized input", &info );
1223 break;
1227 done:
1228 if (subkey) release_object( subkey );
1229 free( info.buffer );
1230 free( info.tmp );
1233 /* load a part of the registry from a file */
1234 static void load_registry( struct key *key, int handle )
1236 struct object *obj;
1237 int fd;
1239 if (!(obj = get_handle_obj( current->process, handle, GENERIC_READ, NULL ))) return;
1240 fd = obj->ops->get_read_fd( obj );
1241 release_object( obj );
1242 if (fd != -1)
1244 FILE *f = fdopen( fd, "r" );
1245 if (f)
1247 load_keys( key, f );
1248 fclose( f );
1250 else file_set_error();
1254 /* update the level of the parents of a key (only needed for the old format) */
1255 static int update_level( struct key *key )
1257 int i;
1258 int max = key->level;
1259 for (i = 0; i <= key->last_subkey; i++)
1261 int sub = update_level( key->subkeys[i] );
1262 if (sub > max) max = sub;
1264 key->level = max;
1265 return max;
1268 /* dump a string to a registry save file in the old v1 format */
1269 static void save_string_v1( LPCWSTR str, FILE *f )
1271 if (!str) return;
1272 while (*str)
1274 if ((*str > 0x7f) || (*str == '\n') || (*str == '='))
1275 fprintf( f, "\\u%04x", *str );
1276 else
1278 if (*str == '\\') fputc( '\\', f );
1279 fputc( (char)*str, f );
1281 str++;
1285 /* save a registry and all its subkeys to a text file in the old v1 format */
1286 static void save_subkeys_v1( struct key *key, int nesting, FILE *f )
1288 int i, j;
1290 if (key->flags & KEY_VOLATILE) return;
1291 if (key->level < saving_level) return;
1292 for (i = 0; i <= key->last_value; i++)
1294 struct key_value *value = &key->values[i];
1295 for (j = nesting; j > 0; j --) fputc( '\t', f );
1296 save_string_v1( value->name, f );
1297 fprintf( f, "=%d,%d,", value->type, 0 );
1298 if (value->type == REG_SZ || value->type == REG_EXPAND_SZ)
1299 save_string_v1( (LPWSTR)value->data, f );
1300 else
1301 for (j = 0; j < value->len; j++)
1302 fprintf( f, "%02x", *((unsigned char *)value->data + j) );
1303 fputc( '\n', f );
1305 for (i = 0; i <= key->last_subkey; i++)
1307 for (j = nesting; j > 0; j --) fputc( '\t', f );
1308 save_string_v1( key->subkeys[i]->name, f );
1309 fputc( '\n', f );
1310 save_subkeys_v1( key->subkeys[i], nesting + 1, f );
1314 /* save a registry branch to a file handle */
1315 static void save_registry( struct key *key, int handle )
1317 struct object *obj;
1318 int fd;
1320 if (key->flags & KEY_DELETED)
1322 set_error( ERROR_KEY_DELETED );
1323 return;
1325 if (!(obj = get_handle_obj( current->process, handle, GENERIC_WRITE, NULL ))) return;
1326 fd = obj->ops->get_write_fd( obj );
1327 release_object( obj );
1328 if (fd != -1)
1330 FILE *f = fdopen( fd, "w" );
1331 if (f)
1333 fprintf( f, "WINE REGISTRY Version %d\n", saving_version );
1334 if (saving_version == 2) save_subkeys( key, key, f );
1335 else
1337 update_level( key );
1338 save_subkeys_v1( key, 0, f );
1340 if (fclose( f )) file_set_error();
1342 else
1344 file_set_error();
1345 close( fd );
1350 /* create a registry key */
1351 DECL_HANDLER(create_key)
1353 struct key *key, *parent;
1354 WCHAR *class;
1355 unsigned int access = req->access;
1357 if (access & MAXIMUM_ALLOWED) access = KEY_ALL_ACCESS; /* FIXME: needs general solution */
1358 req->hkey = -1;
1359 if ((parent = get_hkey_obj( req->parent, KEY_CREATE_SUB_KEY )))
1361 if ((class = req_strdupW( req->class )))
1363 if ((key = create_key( parent, req->name, sizeof(req->name), class, req->options,
1364 req->modif, &req->created )))
1366 req->hkey = alloc_handle( current->process, key, access, 0 );
1367 release_object( key );
1369 free( class );
1371 release_object( parent );
1375 /* open a registry key */
1376 DECL_HANDLER(open_key)
1378 struct key *key, *parent;
1379 unsigned int access = req->access;
1381 if (access & MAXIMUM_ALLOWED) access = KEY_ALL_ACCESS; /* FIXME: needs general solution */
1382 req->hkey = -1;
1383 if ((parent = get_hkey_obj( req->parent, 0 /*FIXME*/ )))
1385 if ((key = open_key( parent, req->name, sizeof(req->name) )))
1387 req->hkey = alloc_handle( current->process, key, access, 0 );
1388 release_object( key );
1390 release_object( parent );
1394 /* delete a registry key */
1395 DECL_HANDLER(delete_key)
1397 struct key *key;
1399 if ((key = get_hkey_obj( req->hkey, KEY_CREATE_SUB_KEY /*FIXME*/ )))
1401 delete_key( key, req->name, sizeof(req->name) );
1402 release_object( key );
1406 /* close a registry key */
1407 DECL_HANDLER(close_key)
1409 int hkey = req->hkey;
1410 /* ignore attempts to close a root key */
1411 if (!IS_ROOT_HKEY(hkey)) close_handle( current->process, hkey );
1414 /* enumerate registry subkeys */
1415 DECL_HANDLER(enum_key)
1417 struct key *key;
1419 if ((key = get_hkey_obj( req->hkey, KEY_ENUMERATE_SUB_KEYS )))
1421 enum_key( key, req->index, req->name, req->class, &req->modif );
1422 release_object( key );
1426 /* query information about a registry key */
1427 DECL_HANDLER(query_key_info)
1429 struct key *key;
1431 if ((key = get_hkey_obj( req->hkey, KEY_QUERY_VALUE )))
1433 query_key( key, req );
1434 release_object( key );
1438 /* set a value of a registry key */
1439 DECL_HANDLER(set_key_value)
1441 struct key *key;
1442 int max = get_req_size( req->data, sizeof(req->data[0]) );
1443 int datalen = req->len;
1444 if (datalen > max)
1446 set_error( ERROR_OUTOFMEMORY ); /* FIXME */
1447 return;
1449 if ((key = get_hkey_obj( req->hkey, KEY_SET_VALUE )))
1451 set_value( key, copy_path( req->name ), req->type, datalen, req->data );
1452 release_object( key );
1456 /* retrieve the value of a registry key */
1457 DECL_HANDLER(get_key_value)
1459 struct key *key;
1461 if ((key = get_hkey_obj( req->hkey, KEY_QUERY_VALUE )))
1463 get_value( key, copy_path( req->name ), &req->type, &req->len, req->data );
1464 release_object( key );
1468 /* enumerate the value of a registry key */
1469 DECL_HANDLER(enum_key_value)
1471 struct key *key;
1473 if ((key = get_hkey_obj( req->hkey, KEY_QUERY_VALUE )))
1475 enum_value( key, req->index, req->name, &req->type, &req->len, req->data );
1476 release_object( key );
1480 /* delete a value of a registry key */
1481 DECL_HANDLER(delete_key_value)
1483 WCHAR *name;
1484 struct key *key;
1486 if ((key = get_hkey_obj( req->hkey, KEY_SET_VALUE )))
1488 if ((name = req_strdupW( req->name )))
1490 delete_value( key, name );
1491 free( name );
1493 release_object( key );
1497 /* load a registry branch from a file */
1498 DECL_HANDLER(load_registry)
1500 struct key *key;
1502 if ((key = get_hkey_obj( req->hkey, KEY_SET_VALUE | KEY_CREATE_SUB_KEY )))
1504 /* FIXME: use subkey name */
1505 load_registry( key, req->file );
1506 release_object( key );
1510 /* save a registry branch to a file */
1511 DECL_HANDLER(save_registry)
1513 struct key *key;
1515 if ((key = get_hkey_obj( req->hkey, KEY_QUERY_VALUE | KEY_ENUMERATE_SUB_KEYS )))
1517 save_registry( key, req->file );
1518 release_object( key );
1522 /* set the current and saving level for the registry */
1523 DECL_HANDLER(set_registry_levels)
1525 current_level = req->current;
1526 saving_level = req->saving;
1527 saving_version = req->version;