2 * Server-side registry management
4 * Copyright (C) 1999 Alexandre Julliard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library 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 GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * - behavior with deleted keys
23 * - values larger than request buffer
28 #include "wine/port.h"
51 #include "wine/library.h"
55 struct event *event; /* event to set when changing this key */
56 int subtree; /* true if subtree notification */
57 unsigned int filter; /* which events to notify on */
58 obj_handle_t hkey; /* hkey associated with this notification */
59 struct notify *next; /* list of notifications */
60 struct notify *prev; /* list of notifications */
66 struct object obj; /* object header */
67 WCHAR *name; /* key name */
68 WCHAR *class; /* key class */
69 struct key *parent; /* parent key */
70 int last_subkey; /* last in use subkey */
71 int nb_subkeys; /* count of allocated subkeys */
72 struct key **subkeys; /* subkeys array */
73 int last_value; /* last in use value */
74 int nb_values; /* count of allocated values in array */
75 struct key_value *values; /* values array */
76 short flags; /* flags */
77 short level; /* saving level */
78 time_t modif; /* last modification time */
79 struct notify *first_notify; /* list of notifications */
80 struct notify *last_notify; /* list of notifications */
84 #define KEY_VOLATILE 0x0001 /* key is volatile (not saved to disk) */
85 #define KEY_DELETED 0x0002 /* key has been deleted */
86 #define KEY_DIRTY 0x0004 /* key has been modified */
91 WCHAR *name; /* value name */
92 int type; /* value type */
93 size_t len; /* value data length in bytes */
94 void *data; /* pointer to value data */
97 #define MIN_SUBKEYS 8 /* min. number of allocated subkeys per key */
98 #define MIN_VALUES 8 /* min. number of allocated values per key */
101 /* the root of the registry tree */
102 static struct key *root_key;
104 /* keys saving level */
105 /* current_level is the level that is put into all newly created or modified keys */
106 /* saving_level is the minimum level that a key needs in order to get saved */
107 static int current_level;
108 static int saving_level;
110 static struct timeval next_save_time; /* absolute time of next periodic save */
111 static int save_period; /* delay between periodic saves (ms) */
112 static struct timeout_user *save_timeout_user; /* saving timer */
114 /* information about where to save a registry branch */
115 struct save_branch_info
121 #define MAX_SAVE_BRANCH_INFO 3
122 static int save_branch_count;
123 static struct save_branch_info save_branch_info[MAX_SAVE_BRANCH_INFO];
126 /* information about a file being loaded */
127 struct file_load_info
129 FILE *file; /* input file */
130 char *buffer; /* line buffer */
131 int len; /* buffer length */
132 int line; /* current input line */
133 char *tmp; /* temp buffer to use while parsing input */
134 int tmplen; /* length of temp buffer */
138 static void key_dump( struct object *obj, int verbose );
139 static void key_destroy( struct object *obj );
141 static const struct object_ops key_ops =
143 sizeof(struct key), /* size */
145 no_add_queue, /* add_queue */
146 NULL, /* remove_queue */
148 NULL, /* satisfied */
149 no_get_fd, /* get_fd */
150 key_destroy /* destroy */
155 * The registry text file format v2 used by this code is similar to the one
156 * used by REGEDIT import/export functionality, with the following differences:
157 * - strings and key names can contain \x escapes for Unicode
158 * - key names use escapes too in order to support Unicode
159 * - the modification time optionally follows the key name
160 * - REG_EXPAND_SZ and REG_MULTI_SZ are saved as strings instead of hex
163 static inline char to_hex( char ch )
165 if (isdigit(ch)) return ch - '0';
166 return tolower(ch) - 'a' + 10;
169 /* dump the full path of a key */
170 static void dump_path( const struct key *key, const struct key *base, FILE *f )
172 if (key->parent && key->parent != base)
174 dump_path( key->parent, base, f );
175 fprintf( f, "\\\\" );
177 dump_strW( key->name, strlenW(key->name), f, "[]" );
180 /* dump a value to a text file */
181 static void dump_value( const struct key_value *value, FILE *f )
188 count = 1 + dump_strW( value->name, strlenW(value->name), f, "\"\"" );
189 count += fprintf( f, "\"=" );
191 else count = fprintf( f, "@=" );
198 if (value->type != REG_SZ) fprintf( f, "str(%d):", value->type );
200 if (value->data) dump_strW( (WCHAR *)value->data, value->len / sizeof(WCHAR), f, "\"\"" );
204 if (value->len == sizeof(DWORD))
207 memcpy( &dw, value->data, sizeof(DWORD) );
208 fprintf( f, "dword:%08lx", dw );
211 /* else fall through */
213 if (value->type == REG_BINARY) count += fprintf( f, "hex:" );
214 else count += fprintf( f, "hex(%x):", value->type );
215 for (i = 0; i < value->len; i++)
217 count += fprintf( f, "%02x", *((unsigned char *)value->data + i) );
218 if (i < value->len-1)
223 fprintf( f, "\\\n " );
233 /* save a registry and all its subkeys to a text file */
234 static void save_subkeys( const struct key *key, const struct key *base, FILE *f )
238 if (key->flags & KEY_VOLATILE) return;
239 /* save key if it has the proper level, and has either some values or no subkeys */
240 /* keys with no values but subkeys are saved implicitly by saving the subkeys */
241 if ((key->level >= saving_level) && ((key->last_value >= 0) || (key->last_subkey == -1)))
244 if (key != base) dump_path( key, base, f );
245 fprintf( f, "] %ld\n", (long)key->modif );
246 for (i = 0; i <= key->last_value; i++) dump_value( &key->values[i], f );
248 for (i = 0; i <= key->last_subkey; i++) save_subkeys( key->subkeys[i], base, f );
251 static void dump_operation( const struct key *key, const struct key_value *value, const char *op )
253 fprintf( stderr, "%s key ", op );
254 if (key) dump_path( key, NULL, stderr );
255 else fprintf( stderr, "ERROR" );
258 fprintf( stderr, " value ");
259 dump_value( value, stderr );
261 else fprintf( stderr, "\n" );
264 static void key_dump( struct object *obj, int verbose )
266 struct key *key = (struct key *)obj;
267 assert( obj->ops == &key_ops );
268 fprintf( stderr, "Key flags=%x ", key->flags );
269 dump_path( key, NULL, stderr );
270 fprintf( stderr, "\n" );
273 /* notify waiter and maybe delete the notification */
274 static void do_notification( struct key *key, struct notify *notify, int del )
278 set_event( notify->event );
279 release_object( notify->event );
280 notify->event = NULL;
286 notify->next->prev = notify->prev;
288 key->last_notify = notify->prev;
290 notify->prev->next = notify->next;
292 key->first_notify = notify->next;
296 static struct notify *find_notify( struct key *key, obj_handle_t hkey)
300 for( n=key->first_notify; n; n = n->next)
301 if( n->hkey == hkey )
306 /* close the notification associated with a handle */
307 void registry_close_handle( struct object *obj, obj_handle_t hkey )
309 struct key * key = (struct key *) obj;
310 struct notify *notify;
312 if( obj->ops != &key_ops )
314 notify = find_notify( key, hkey );
317 do_notification( key, notify, 1 );
320 static void key_destroy( struct object *obj )
323 struct key *key = (struct key *)obj;
324 assert( obj->ops == &key_ops );
326 if (key->name) free( key->name );
327 if (key->class) free( key->class );
328 for (i = 0; i <= key->last_value; i++)
330 free( key->values[i].name );
331 if (key->values[i].data) free( key->values[i].data );
333 for (i = 0; i <= key->last_subkey; i++)
335 key->subkeys[i]->parent = NULL;
336 release_object( key->subkeys[i] );
338 /* unconditionally notify everything waiting on this key */
339 while ( key->first_notify )
340 do_notification( key, key->first_notify, 1 );
343 /* duplicate a key path */
344 /* returns a pointer to a static buffer, so only useable once per request */
345 static WCHAR *copy_path( const WCHAR *path, size_t len, int skip_root )
347 static WCHAR buffer[MAX_PATH+1];
348 static const WCHAR root_name[] = { '\\','R','e','g','i','s','t','r','y','\\',0 };
350 if (len > sizeof(buffer)-sizeof(buffer[0]))
352 set_error( STATUS_BUFFER_OVERFLOW );
355 memcpy( buffer, path, len );
356 buffer[len / sizeof(WCHAR)] = 0;
357 if (skip_root && !strncmpiW( buffer, root_name, 10 )) return buffer + 10;
361 /* copy a path from the request buffer */
362 static WCHAR *copy_req_path( size_t len, int skip_root )
364 const WCHAR *name_ptr = get_req_data();
365 if (len > get_req_data_size())
367 fatal_protocol_error( current, "copy_req_path: invalid length %d/%d\n",
368 len, get_req_data_size() );
371 return copy_path( name_ptr, len, skip_root );
374 /* return the next token in a given path */
375 /* returns a pointer to a static buffer, so only useable once per request */
376 static WCHAR *get_path_token( WCHAR *initpath )
383 /* path cannot start with a backslash */
384 if (*initpath == '\\')
386 set_error( STATUS_OBJECT_PATH_INVALID );
391 else while (*path == '\\') path++;
394 while (*path && *path != '\\') path++;
395 if (*path) *path++ = 0;
399 /* duplicate a Unicode string from the request buffer */
400 static WCHAR *req_strdupW( const void *req, const WCHAR *str, size_t len )
403 if ((name = mem_alloc( len + sizeof(WCHAR) )) != NULL)
405 memcpy( name, str, len );
406 name[len / sizeof(WCHAR)] = 0;
411 /* allocate a key object */
412 static struct key *alloc_key( const WCHAR *name, time_t modif )
415 if ((key = alloc_object( &key_ops )))
419 key->last_subkey = -1;
423 key->last_value = -1;
425 key->level = current_level;
428 key->first_notify = NULL;
429 key->last_notify = NULL;
430 if (!(key->name = strdupW( name )))
432 release_object( key );
439 /* mark a key and all its parents as dirty (modified) */
440 static void make_dirty( struct key *key )
444 if (key->flags & (KEY_DIRTY|KEY_VOLATILE)) return; /* nothing to do */
445 key->flags |= KEY_DIRTY;
450 /* mark a key and all its subkeys as clean (not modified) */
451 static void make_clean( struct key *key )
455 if (key->flags & KEY_VOLATILE) return;
456 if (!(key->flags & KEY_DIRTY)) return;
457 key->flags &= ~KEY_DIRTY;
458 for (i = 0; i <= key->last_subkey; i++) make_clean( key->subkeys[i] );
461 /* go through all the notifications and send them if necessary */
462 void check_notify( struct key *key, unsigned int change, int not_subtree )
464 struct notify *n = key->first_notify;
467 struct notify *next = n->next;
468 if ( ( not_subtree || n->subtree ) && ( change & n->filter ) )
469 do_notification( key, n, 0 );
474 /* update key modification time */
475 static void touch_key( struct key *key, unsigned int change )
479 key->modif = time(NULL);
480 key->level = max( key->level, current_level );
483 /* do notifications */
484 check_notify( key, change, 1 );
485 for ( k = key->parent; k; k = k->parent )
486 check_notify( k, change & ~REG_NOTIFY_CHANGE_LAST_SET, 0 );
489 /* try to grow the array of subkeys; return 1 if OK, 0 on error */
490 static int grow_subkeys( struct key *key )
492 struct key **new_subkeys;
497 nb_subkeys = key->nb_subkeys + (key->nb_subkeys / 2); /* grow by 50% */
498 if (!(new_subkeys = realloc( key->subkeys, nb_subkeys * sizeof(*new_subkeys) )))
500 set_error( STATUS_NO_MEMORY );
506 nb_subkeys = MIN_VALUES;
507 if (!(new_subkeys = mem_alloc( nb_subkeys * sizeof(*new_subkeys) ))) return 0;
509 key->subkeys = new_subkeys;
510 key->nb_subkeys = nb_subkeys;
514 /* allocate a subkey for a given key, and return its index */
515 static struct key *alloc_subkey( struct key *parent, const WCHAR *name, int index, time_t modif )
520 if (parent->last_subkey + 1 == parent->nb_subkeys)
522 /* need to grow the array */
523 if (!grow_subkeys( parent )) return NULL;
525 if ((key = alloc_key( name, modif )) != NULL)
527 key->parent = parent;
528 for (i = ++parent->last_subkey; i > index; i--)
529 parent->subkeys[i] = parent->subkeys[i-1];
530 parent->subkeys[index] = key;
535 /* free a subkey of a given key */
536 static void free_subkey( struct key *parent, int index )
541 assert( index >= 0 );
542 assert( index <= parent->last_subkey );
544 key = parent->subkeys[index];
545 for (i = index; i < parent->last_subkey; i++) parent->subkeys[i] = parent->subkeys[i + 1];
546 parent->last_subkey--;
547 key->flags |= KEY_DELETED;
549 release_object( key );
551 /* try to shrink the array */
552 nb_subkeys = parent->nb_subkeys;
553 if (nb_subkeys > MIN_SUBKEYS && parent->last_subkey < nb_subkeys / 2)
555 struct key **new_subkeys;
556 nb_subkeys -= nb_subkeys / 3; /* shrink by 33% */
557 if (nb_subkeys < MIN_SUBKEYS) nb_subkeys = MIN_SUBKEYS;
558 if (!(new_subkeys = realloc( parent->subkeys, nb_subkeys * sizeof(*new_subkeys) ))) return;
559 parent->subkeys = new_subkeys;
560 parent->nb_subkeys = nb_subkeys;
564 /* find the named child of a given key and return its index */
565 static struct key *find_subkey( const struct key *key, const WCHAR *name, int *index )
567 int i, min, max, res;
570 max = key->last_subkey;
574 if (!(res = strcmpiW( key->subkeys[i]->name, name )))
577 return key->subkeys[i];
579 if (res > 0) max = i - 1;
582 *index = min; /* this is where we should insert it */
587 /* warning: the key name must be writeable (use copy_path) */
588 static struct key *open_key( struct key *key, WCHAR *name )
593 if (!(path = get_path_token( name ))) return NULL;
596 if (!(key = find_subkey( key, path, &index )))
598 set_error( STATUS_OBJECT_NAME_NOT_FOUND );
601 path = get_path_token( NULL );
604 if (debug_level > 1) dump_operation( key, NULL, "Open" );
605 if (key) grab_object( key );
609 /* create a subkey */
610 /* warning: the key name must be writeable (use copy_path) */
611 static struct key *create_key( struct key *key, WCHAR *name, WCHAR *class,
612 int flags, time_t modif, int *created )
618 if (key->flags & KEY_DELETED) /* we cannot create a subkey under a deleted key */
620 set_error( STATUS_KEY_DELETED );
623 if (!(flags & KEY_VOLATILE) && (key->flags & KEY_VOLATILE))
625 set_error( STATUS_CHILD_MUST_BE_VOLATILE );
628 if (!modif) modif = time(NULL);
630 if (!(path = get_path_token( name ))) return NULL;
635 if (!(subkey = find_subkey( key, path, &index ))) break;
637 path = get_path_token( NULL );
640 /* create the remaining part */
642 if (!*path) goto done;
644 if (flags & KEY_DIRTY) make_dirty( key );
647 key = alloc_subkey( key, path, index, modif );
651 path = get_path_token( NULL );
652 if (!*path) goto done;
653 /* we know the index is always 0 in a new key */
654 key = alloc_subkey( key, path, 0, modif );
656 if (base_idx != -1) free_subkey( base, base_idx );
660 if (debug_level > 1) dump_operation( key, NULL, "Create" );
661 if (class) key->class = strdupW(class);
666 /* query information about a key or a subkey */
667 static void enum_key( const struct key *key, int index, int info_class,
668 struct enum_key_reply *reply )
671 size_t len, namelen, classlen;
672 int max_subkey = 0, max_class = 0;
673 int max_value = 0, max_data = 0;
676 if (index != -1) /* -1 means use the specified key directly */
678 if ((index < 0) || (index > key->last_subkey))
680 set_error( STATUS_NO_MORE_ENTRIES );
683 key = key->subkeys[index];
686 namelen = strlenW(key->name) * sizeof(WCHAR);
687 classlen = key->class ? strlenW(key->class) * sizeof(WCHAR) : 0;
691 case KeyBasicInformation:
692 classlen = 0; /* only return the name */
694 case KeyNodeInformation:
695 reply->max_subkey = 0;
696 reply->max_class = 0;
697 reply->max_value = 0;
700 case KeyFullInformation:
701 for (i = 0; i <= key->last_subkey; i++)
703 struct key *subkey = key->subkeys[i];
704 len = strlenW( subkey->name );
705 if (len > max_subkey) max_subkey = len;
706 if (!subkey->class) continue;
707 len = strlenW( subkey->class );
708 if (len > max_class) max_class = len;
710 for (i = 0; i <= key->last_value; i++)
712 len = strlenW( key->values[i].name );
713 if (len > max_value) max_value = len;
714 len = key->values[i].len;
715 if (len > max_data) max_data = len;
717 reply->max_subkey = max_subkey;
718 reply->max_class = max_class;
719 reply->max_value = max_value;
720 reply->max_data = max_data;
721 namelen = 0; /* only return the class */
724 set_error( STATUS_INVALID_PARAMETER );
727 reply->subkeys = key->last_subkey + 1;
728 reply->values = key->last_value + 1;
729 reply->modif = key->modif;
730 reply->total = namelen + classlen;
732 len = min( reply->total, get_reply_max_size() );
733 if (len && (data = set_reply_data_size( len )))
737 reply->namelen = namelen;
738 memcpy( data, key->name, namelen );
739 memcpy( (char *)data + namelen, key->class, len - namelen );
743 reply->namelen = len;
744 memcpy( data, key->name, len );
747 if (debug_level > 1) dump_operation( key, NULL, "Enum" );
750 /* delete a key and its values */
751 static int delete_key( struct key *key, int recurse )
756 /* must find parent and index */
759 set_error( STATUS_ACCESS_DENIED );
762 if (!(parent = key->parent) || (key->flags & KEY_DELETED))
764 set_error( STATUS_KEY_DELETED );
768 while (recurse && (key->last_subkey>=0))
769 if(0>delete_key(key->subkeys[key->last_subkey], 1))
772 for (index = 0; index <= parent->last_subkey; index++)
773 if (parent->subkeys[index] == key) break;
774 assert( index <= parent->last_subkey );
776 /* we can only delete a key that has no subkeys */
777 if (key->last_subkey >= 0)
779 set_error( STATUS_ACCESS_DENIED );
783 if (debug_level > 1) dump_operation( key, NULL, "Delete" );
784 free_subkey( parent, index );
785 touch_key( parent, REG_NOTIFY_CHANGE_NAME );
789 /* try to grow the array of values; return 1 if OK, 0 on error */
790 static int grow_values( struct key *key )
792 struct key_value *new_val;
797 nb_values = key->nb_values + (key->nb_values / 2); /* grow by 50% */
798 if (!(new_val = realloc( key->values, nb_values * sizeof(*new_val) )))
800 set_error( STATUS_NO_MEMORY );
806 nb_values = MIN_VALUES;
807 if (!(new_val = mem_alloc( nb_values * sizeof(*new_val) ))) return 0;
809 key->values = new_val;
810 key->nb_values = nb_values;
814 /* find the named value of a given key and return its index in the array */
815 static struct key_value *find_value( const struct key *key, const WCHAR *name, int *index )
817 int i, min, max, res;
820 max = key->last_value;
824 if (!(res = strcmpiW( key->values[i].name, name )))
827 return &key->values[i];
829 if (res > 0) max = i - 1;
832 *index = min; /* this is where we should insert it */
836 /* insert a new value; the index must have been returned by find_value */
837 static struct key_value *insert_value( struct key *key, const WCHAR *name, int index )
839 struct key_value *value;
843 if (key->last_value + 1 == key->nb_values)
845 if (!grow_values( key )) return NULL;
847 if (!(new_name = strdupW(name))) return NULL;
848 for (i = ++key->last_value; i > index; i--) key->values[i] = key->values[i - 1];
849 value = &key->values[index];
850 value->name = new_name;
856 /* set a key value */
857 static void set_value( struct key *key, WCHAR *name, int type, const void *data, size_t len )
859 struct key_value *value;
863 if ((value = find_value( key, name, &index )))
865 /* check if the new value is identical to the existing one */
866 if (value->type == type && value->len == len &&
867 value->data && !memcmp( value->data, data, len ))
869 if (debug_level > 1) dump_operation( key, value, "Skip setting" );
874 if (len && !(ptr = memdup( data, len ))) return;
878 if (!(value = insert_value( key, name, index )))
880 if (ptr) free( ptr );
884 else if (value->data) free( value->data ); /* already existing, free previous data */
889 touch_key( key, REG_NOTIFY_CHANGE_LAST_SET );
890 if (debug_level > 1) dump_operation( key, value, "Set" );
893 /* get a key value */
894 static void get_value( struct key *key, const WCHAR *name, int *type, int *len )
896 struct key_value *value;
899 if ((value = find_value( key, name, &index )))
903 if (value->data) set_reply_data( value->data, min( value->len, get_reply_max_size() ));
904 if (debug_level > 1) dump_operation( key, value, "Get" );
909 set_error( STATUS_OBJECT_NAME_NOT_FOUND );
913 /* enumerate a key value */
914 static void enum_value( struct key *key, int i, int info_class, struct enum_key_value_reply *reply )
916 struct key_value *value;
918 if (i < 0 || i > key->last_value) set_error( STATUS_NO_MORE_ENTRIES );
922 size_t namelen, maxlen;
924 value = &key->values[i];
925 reply->type = value->type;
926 namelen = strlenW( value->name ) * sizeof(WCHAR);
930 case KeyValueBasicInformation:
931 reply->total = namelen;
933 case KeyValueFullInformation:
934 reply->total = namelen + value->len;
936 case KeyValuePartialInformation:
937 reply->total = value->len;
941 set_error( STATUS_INVALID_PARAMETER );
945 maxlen = min( reply->total, get_reply_max_size() );
946 if (maxlen && ((data = set_reply_data_size( maxlen ))))
948 if (maxlen > namelen)
950 reply->namelen = namelen;
951 memcpy( data, value->name, namelen );
952 memcpy( (char *)data + namelen, value->data, maxlen - namelen );
956 reply->namelen = maxlen;
957 memcpy( data, value->name, maxlen );
960 if (debug_level > 1) dump_operation( key, value, "Enum" );
965 static void delete_value( struct key *key, const WCHAR *name )
967 struct key_value *value;
968 int i, index, nb_values;
970 if (!(value = find_value( key, name, &index )))
972 set_error( STATUS_OBJECT_NAME_NOT_FOUND );
975 if (debug_level > 1) dump_operation( key, value, "Delete" );
977 if (value->data) free( value->data );
978 for (i = index; i < key->last_value; i++) key->values[i] = key->values[i + 1];
980 touch_key( key, REG_NOTIFY_CHANGE_LAST_SET );
982 /* try to shrink the array */
983 nb_values = key->nb_values;
984 if (nb_values > MIN_VALUES && key->last_value < nb_values / 2)
986 struct key_value *new_val;
987 nb_values -= nb_values / 3; /* shrink by 33% */
988 if (nb_values < MIN_VALUES) nb_values = MIN_VALUES;
989 if (!(new_val = realloc( key->values, nb_values * sizeof(*new_val) ))) return;
990 key->values = new_val;
991 key->nb_values = nb_values;
995 /* get the registry key corresponding to an hkey handle */
996 static struct key *get_hkey_obj( obj_handle_t hkey, unsigned int access )
998 if (!hkey) return (struct key *)grab_object( root_key );
999 return (struct key *)get_handle_obj( current->process, hkey, access, &key_ops );
1002 /* read a line from the input file */
1003 static int read_next_line( struct file_load_info *info )
1006 int newlen, pos = 0;
1011 if (!fgets( info->buffer + pos, info->len - pos, info->file ))
1012 return (pos != 0); /* EOF */
1013 pos = strlen(info->buffer);
1014 if (info->buffer[pos-1] == '\n')
1016 /* got a full line */
1017 info->buffer[--pos] = 0;
1018 if (pos > 0 && info->buffer[pos-1] == '\r') info->buffer[pos-1] = 0;
1021 if (pos < info->len - 1) return 1; /* EOF but something was read */
1023 /* need to enlarge the buffer */
1024 newlen = info->len + info->len / 2;
1025 if (!(newbuf = realloc( info->buffer, newlen )))
1027 set_error( STATUS_NO_MEMORY );
1030 info->buffer = newbuf;
1035 /* make sure the temp buffer holds enough space */
1036 static int get_file_tmp_space( struct file_load_info *info, int size )
1039 if (info->tmplen >= size) return 1;
1040 if (!(tmp = realloc( info->tmp, size )))
1042 set_error( STATUS_NO_MEMORY );
1046 info->tmplen = size;
1050 /* report an error while loading an input file */
1051 static void file_read_error( const char *err, struct file_load_info *info )
1053 fprintf( stderr, "Line %d: %s '%s'\n", info->line, err, info->buffer );
1056 /* parse an escaped string back into Unicode */
1057 /* return the number of chars read from the input, or -1 on output overflow */
1058 static int parse_strW( WCHAR *dest, int *len, const char *src, char endchar )
1060 int count = sizeof(WCHAR); /* for terminating null */
1061 const char *p = src;
1062 while (*p && *p != endchar)
1064 if (*p != '\\') *dest = (WCHAR)*p++;
1070 case 'a': *dest = '\a'; p++; break;
1071 case 'b': *dest = '\b'; p++; break;
1072 case 'e': *dest = '\e'; p++; break;
1073 case 'f': *dest = '\f'; p++; break;
1074 case 'n': *dest = '\n'; p++; break;
1075 case 'r': *dest = '\r'; p++; break;
1076 case 't': *dest = '\t'; p++; break;
1077 case 'v': *dest = '\v'; p++; break;
1078 case 'x': /* hex escape */
1080 if (!isxdigit(*p)) *dest = 'x';
1083 *dest = to_hex(*p++);
1084 if (isxdigit(*p)) *dest = (*dest * 16) + to_hex(*p++);
1085 if (isxdigit(*p)) *dest = (*dest * 16) + to_hex(*p++);
1086 if (isxdigit(*p)) *dest = (*dest * 16) + to_hex(*p++);
1096 case '7': /* octal escape */
1098 if (*p >= '0' && *p <= '7') *dest = (*dest * 8) + (*p++ - '0');
1099 if (*p >= '0' && *p <= '7') *dest = (*dest * 8) + (*p++ - '0');
1102 *dest = (WCHAR)*p++;
1106 if ((count += sizeof(WCHAR)) > *len) return -1; /* dest buffer overflow */
1110 if (!*p) return -1; /* delimiter not found */
1115 /* convert a data type tag to a value type */
1116 static int get_data_type( const char *buffer, int *type, int *parse_type )
1118 struct data_type { const char *tag; int len; int type; int parse_type; };
1120 static const struct data_type data_types[] =
1121 { /* actual type */ /* type to assume for parsing */
1122 { "\"", 1, REG_SZ, REG_SZ },
1123 { "str:\"", 5, REG_SZ, REG_SZ },
1124 { "str(2):\"", 8, REG_EXPAND_SZ, REG_SZ },
1125 { "str(7):\"", 8, REG_MULTI_SZ, REG_SZ },
1126 { "hex:", 4, REG_BINARY, REG_BINARY },
1127 { "dword:", 6, REG_DWORD, REG_DWORD },
1128 { "hex(", 4, -1, REG_BINARY },
1132 const struct data_type *ptr;
1135 for (ptr = data_types; ptr->tag; ptr++)
1137 if (memcmp( ptr->tag, buffer, ptr->len )) continue;
1138 *parse_type = ptr->parse_type;
1139 if ((*type = ptr->type) != -1) return ptr->len;
1140 /* "hex(xx):" is special */
1141 *type = (int)strtoul( buffer + 4, &end, 16 );
1142 if ((end <= buffer) || memcmp( end, "):", 2 )) return 0;
1143 return end + 2 - buffer;
1148 /* load and create a key from the input file */
1149 static struct key *load_key( struct key *base, const char *buffer, int flags,
1150 int prefix_len, struct file_load_info *info,
1154 int res, len, modif;
1156 len = strlen(buffer) * sizeof(WCHAR);
1157 if (!get_file_tmp_space( info, len )) return NULL;
1159 if ((res = parse_strW( (WCHAR *)info->tmp, &len, buffer, ']' )) == -1)
1161 file_read_error( "Malformed key", info );
1164 if (sscanf( buffer + res, " %d", &modif ) != 1) modif = default_modif;
1166 p = (WCHAR *)info->tmp;
1167 while (prefix_len && *p) { if (*p++ == '\\') prefix_len--; }
1173 file_read_error( "Malformed key", info );
1176 /* empty key name, return base key */
1177 return (struct key *)grab_object( base );
1179 if (!(name = copy_path( p, len - ((char *)p - info->tmp), 0 )))
1181 file_read_error( "Key is too long", info );
1184 return create_key( base, name, NULL, flags, modif, &res );
1187 /* parse a comma-separated list of hex digits */
1188 static int parse_hex( unsigned char *dest, int *len, const char *buffer )
1190 const char *p = buffer;
1192 while (isxdigit(*p))
1196 memcpy( buf, p, 2 );
1198 sscanf( buf, "%x", &val );
1199 if (count++ >= *len) return -1; /* dest buffer overflow */
1200 *dest++ = (unsigned char )val;
1208 /* parse a value name and create the corresponding value */
1209 static struct key_value *parse_value_name( struct key *key, const char *buffer, int *len,
1210 struct file_load_info *info )
1212 struct key_value *value;
1215 maxlen = strlen(buffer) * sizeof(WCHAR);
1216 if (!get_file_tmp_space( info, maxlen )) return NULL;
1217 if (buffer[0] == '@')
1219 info->tmp[0] = info->tmp[1] = 0;
1224 if ((*len = parse_strW( (WCHAR *)info->tmp, &maxlen, buffer + 1, '\"' )) == -1) goto error;
1225 (*len)++; /* for initial quote */
1227 while (isspace(buffer[*len])) (*len)++;
1228 if (buffer[*len] != '=') goto error;
1230 while (isspace(buffer[*len])) (*len)++;
1231 if (!(value = find_value( key, (WCHAR *)info->tmp, &index )))
1232 value = insert_value( key, (WCHAR *)info->tmp, index );
1236 file_read_error( "Malformed value name", info );
1240 /* load a value from the input file */
1241 static int load_value( struct key *key, const char *buffer, struct file_load_info *info )
1245 int maxlen, len, res;
1246 int type, parse_type;
1247 struct key_value *value;
1249 if (!(value = parse_value_name( key, buffer, &len, info ))) return 0;
1250 if (!(res = get_data_type( buffer + len, &type, &parse_type ))) goto error;
1251 buffer += len + res;
1256 len = strlen(buffer) * sizeof(WCHAR);
1257 if (!get_file_tmp_space( info, len )) return 0;
1258 if ((res = parse_strW( (WCHAR *)info->tmp, &len, buffer, '\"' )) == -1) goto error;
1262 dw = strtoul( buffer, NULL, 16 );
1266 case REG_BINARY: /* hex digits */
1270 maxlen = 1 + strlen(buffer)/3; /* 3 chars for one hex byte */
1271 if (!get_file_tmp_space( info, len + maxlen )) return 0;
1272 if ((res = parse_hex( info->tmp + len, &maxlen, buffer )) == -1) goto error;
1275 while (isspace(*buffer)) buffer++;
1276 if (!*buffer) break;
1277 if (*buffer != '\\') goto error;
1278 if (read_next_line( info) != 1) goto error;
1279 buffer = info->buffer;
1280 while (isspace(*buffer)) buffer++;
1286 ptr = NULL; /* keep compiler quiet */
1290 if (!len) newptr = NULL;
1291 else if (!(newptr = memdup( ptr, len ))) return 0;
1293 if (value->data) free( value->data );
1294 value->data = newptr;
1297 /* update the key level but not the modification time */
1298 key->level = max( key->level, current_level );
1303 file_read_error( "Malformed value", info );
1307 /* return the length (in path elements) of name that is part of the key name */
1308 /* for instance if key is USER\foo\bar and name is foo\bar\baz, return 2 */
1309 static int get_prefix_len( struct key *key, const char *name, struct file_load_info *info )
1313 int len = strlen(name) * sizeof(WCHAR);
1314 if (!get_file_tmp_space( info, len )) return 0;
1316 if ((res = parse_strW( (WCHAR *)info->tmp, &len, name, ']' )) == -1)
1318 file_read_error( "Malformed key", info );
1321 for (p = (WCHAR *)info->tmp; *p; p++) if (*p == '\\') break;
1323 for (res = 1; key != root_key; res++)
1325 if (!strcmpiW( (WCHAR *)info->tmp, key->name )) break;
1328 if (key == root_key) res = 0; /* no matching name */
1332 /* load all the keys from the input file */
1333 /* prefix_len is the number of key name prefixes to skip, or -1 for autodetection */
1334 static void load_keys( struct key *key, FILE *f, int prefix_len )
1336 struct key *subkey = NULL;
1337 struct file_load_info info;
1339 int default_modif = time(NULL);
1340 int flags = (key->flags & KEY_VOLATILE) ? KEY_VOLATILE : KEY_DIRTY;
1346 if (!(info.buffer = mem_alloc( info.len ))) return;
1347 if (!(info.tmp = mem_alloc( info.tmplen )))
1349 free( info.buffer );
1353 if ((read_next_line( &info ) != 1) ||
1354 strcmp( info.buffer, "WINE REGISTRY Version 2" ))
1356 set_error( STATUS_NOT_REGISTRY_FILE );
1360 while (read_next_line( &info ) == 1)
1363 while (*p && isspace(*p)) p++;
1366 case '[': /* new key */
1367 if (subkey) release_object( subkey );
1368 if (prefix_len == -1) prefix_len = get_prefix_len( key, p + 1, &info );
1369 if (!(subkey = load_key( key, p + 1, flags, prefix_len, &info, default_modif )))
1370 file_read_error( "Error creating key", &info );
1372 case '@': /* default value */
1373 case '\"': /* value */
1374 if (subkey) load_value( subkey, p, &info );
1375 else file_read_error( "Value without key", &info );
1377 case '#': /* comment */
1378 case ';': /* comment */
1379 case 0: /* empty line */
1382 file_read_error( "Unrecognized input", &info );
1388 if (subkey) release_object( subkey );
1389 free( info.buffer );
1393 /* load a part of the registry from a file */
1394 static void load_registry( struct key *key, obj_handle_t handle )
1399 if (!(file = get_file_obj( current->process, handle, GENERIC_READ ))) return;
1400 fd = dup( get_file_unix_fd( file ) );
1401 release_object( file );
1404 FILE *f = fdopen( fd, "r" );
1407 load_keys( key, f, -1 );
1410 else file_set_error();
1414 /* load one of the initial registry files */
1415 static void load_init_registry_from_file( const char *filename, struct key *key )
1419 if (!(f = fopen( filename, "r" ))) return;
1420 load_keys( key, f, 0 );
1422 if (get_error() == STATUS_NOT_REGISTRY_FILE)
1423 fatal_error( "%s is not a valid registry file\n", filename );
1425 fatal_error( "loading %s failed with error %x\n", filename, get_error() );
1427 if (!(key->flags & KEY_VOLATILE))
1429 assert( save_branch_count < MAX_SAVE_BRANCH_INFO );
1431 if ((save_branch_info[save_branch_count].path = strdup( filename )))
1432 save_branch_info[save_branch_count++].key = (struct key *)grab_object( key );
1436 /* load the user registry files */
1437 static void load_user_registries( struct key *key_current_user )
1439 static const WCHAR HKLM[] = { 'M','a','c','h','i','n','e' };
1440 static const WCHAR HKU_default[] = { 'U','s','e','r','\\','.','D','e','f','a','u','l','t' };
1442 const char *config = wine_get_config_dir();
1447 if (!(filename = mem_alloc( strlen(config) + 16 ))) return;
1448 strcpy( filename, config );
1449 p = filename + strlen(filename);
1451 /* load system.reg into Registry\Machine */
1453 if (!(key = create_key( root_key, copy_path( HKLM, sizeof(HKLM), 0 ),
1454 NULL, 0, time(NULL), &dummy )))
1455 fatal_error( "could not create Machine registry key\n" );
1457 strcpy( p, "/system.reg" );
1458 load_init_registry_from_file( filename, key );
1459 release_object( key );
1461 /* load userdef.reg into Registry\User\.Default */
1463 if (!(key = create_key( root_key, copy_path( HKU_default, sizeof(HKU_default), 0 ),
1464 NULL, 0, time(NULL), &dummy )))
1465 fatal_error( "could not create User\\.Default registry key\n" );
1467 strcpy( p, "/userdef.reg" );
1468 load_init_registry_from_file( filename, key );
1469 release_object( key );
1471 /* load user.reg into HKEY_CURRENT_USER */
1473 strcpy( p, "/user.reg" );
1474 load_init_registry_from_file( filename, key_current_user );
1479 /* registry initialisation */
1480 void init_registry(void)
1482 static const WCHAR root_name[] = { 0 };
1483 static const WCHAR config_name[] =
1484 { 'M','a','c','h','i','n','e','\\','S','o','f','t','w','a','r','e','\\',
1485 'W','i','n','e','\\','W','i','n','e','\\','C','o','n','f','i','g',0 };
1487 const char *config = wine_get_config_dir();
1492 /* create the root key */
1493 root_key = alloc_key( root_name, time(NULL) );
1496 /* load the config file */
1497 if (!(filename = malloc( strlen(config) + sizeof("/config") ))) fatal_error( "out of memory\n" );
1498 strcpy( filename, config );
1499 strcat( filename, "/config" );
1501 if (!(key = create_key( root_key, copy_path( config_name, sizeof(config_name), 0 ),
1502 NULL, 0, time(NULL), &dummy )))
1503 fatal_error( "could not create Config registry key\n" );
1505 key->flags |= KEY_VOLATILE;
1506 load_init_registry_from_file( filename, key );
1507 release_object( key );
1512 /* update the level of the parents of a key (only needed for the old format) */
1513 static int update_level( struct key *key )
1516 int max = key->level;
1517 for (i = 0; i <= key->last_subkey; i++)
1519 int sub = update_level( key->subkeys[i] );
1520 if (sub > max) max = sub;
1526 /* save a registry branch to a file */
1527 static void save_all_subkeys( struct key *key, FILE *f )
1529 fprintf( f, "WINE REGISTRY Version 2\n" );
1530 fprintf( f, ";; All keys relative to " );
1531 dump_path( key, NULL, f );
1533 save_subkeys( key, key, f );
1536 /* save a registry branch to a file handle */
1537 static void save_registry( struct key *key, obj_handle_t handle )
1542 if (key->flags & KEY_DELETED)
1544 set_error( STATUS_KEY_DELETED );
1547 if (!(file = get_file_obj( current->process, handle, GENERIC_WRITE ))) return;
1548 fd = dup( get_file_unix_fd( file ) );
1549 release_object( file );
1552 FILE *f = fdopen( fd, "w" );
1555 save_all_subkeys( key, f );
1556 if (fclose( f )) file_set_error();
1566 /* save a registry branch to a file */
1567 static int save_branch( struct key *key, const char *path )
1570 char *p, *real, *tmp = NULL;
1571 int fd, count = 0, ret = 0, by_symlink;
1574 if (!(key->flags & KEY_DIRTY))
1576 if (debug_level > 1) dump_operation( key, NULL, "Not saving clean" );
1580 /* get the real path */
1582 by_symlink = (!lstat(path, &st) && S_ISLNK (st.st_mode));
1583 if (!(real = malloc( PATH_MAX ))) return 0;
1584 if (!realpath( path, real ))
1591 /* test the file type */
1593 if ((fd = open( path, O_WRONLY )) != -1)
1595 /* if file is not a regular file or has multiple links or is accessed
1596 * via symbolic links, write directly into it; otherwise use a temp file */
1598 (!fstat( fd, &st ) && (!S_ISREG(st.st_mode) || st.st_nlink > 1)))
1606 /* create a temp file in the same directory */
1608 if (!(tmp = malloc( strlen(path) + 20 ))) goto done;
1609 strcpy( tmp, path );
1610 if ((p = strrchr( tmp, '/' ))) p++;
1614 sprintf( p, "reg%lx%04x.tmp", (long) getpid(), count++ );
1615 if ((fd = open( tmp, O_CREAT | O_EXCL | O_WRONLY, 0666 )) != -1) break;
1616 if (errno != EEXIST) goto done;
1620 /* now save to it */
1623 if (!(f = fdopen( fd, "w" )))
1625 if (tmp) unlink( tmp );
1630 if (debug_level > 1)
1632 fprintf( stderr, "%s: ", path );
1633 dump_operation( key, NULL, "saving" );
1636 save_all_subkeys( key, f );
1641 /* if successfully written, rename to final name */
1642 if (ret) ret = !rename( tmp, path );
1643 if (!ret) unlink( tmp );
1648 if (real) free( real );
1649 if (ret) make_clean( key );
1653 /* periodic saving of the registry */
1654 static void periodic_save( void *arg )
1657 for (i = 0; i < save_branch_count; i++)
1658 save_branch( save_branch_info[i].key, save_branch_info[i].path );
1659 add_timeout( &next_save_time, save_period );
1660 save_timeout_user = add_timeout_user( &next_save_time, periodic_save, 0 );
1663 /* save the modified registry branches to disk */
1664 void flush_registry(void)
1668 for (i = 0; i < save_branch_count; i++)
1670 if (!save_branch( save_branch_info[i].key, save_branch_info[i].path ))
1672 fprintf( stderr, "wineserver: could not save registry branch to %s",
1673 save_branch_info[i].path );
1679 /* close the top-level keys; used on server exit */
1680 void close_registry(void)
1684 for (i = 0; i < save_branch_count; i++) release_object( save_branch_info[i].key );
1685 release_object( root_key );
1689 /* create a registry key */
1690 DECL_HANDLER(create_key)
1692 struct key *key = NULL, *parent;
1693 unsigned int access = req->access;
1694 WCHAR *name, *class;
1696 if (access & MAXIMUM_ALLOWED) access = KEY_ALL_ACCESS; /* FIXME: needs general solution */
1698 if (!(name = copy_req_path( req->namelen, !req->parent ))) return;
1699 if ((parent = get_hkey_obj( req->parent, 0 /*FIXME*/ )))
1701 int flags = (req->options & REG_OPTION_VOLATILE) ? KEY_VOLATILE : KEY_DIRTY;
1703 if (req->namelen == get_req_data_size()) /* no class specified */
1705 key = create_key( parent, name, NULL, flags, req->modif, &reply->created );
1709 const WCHAR *class_ptr = (WCHAR *)((char *)get_req_data() + req->namelen);
1711 if ((class = req_strdupW( req, class_ptr, get_req_data_size() - req->namelen )))
1713 key = create_key( parent, name, class, flags, req->modif, &reply->created );
1719 reply->hkey = alloc_handle( current->process, key, access, 0 );
1720 release_object( key );
1722 release_object( parent );
1726 /* open a registry key */
1727 DECL_HANDLER(open_key)
1729 struct key *key, *parent;
1730 unsigned int access = req->access;
1732 if (access & MAXIMUM_ALLOWED) access = KEY_ALL_ACCESS; /* FIXME: needs general solution */
1734 if ((parent = get_hkey_obj( req->parent, 0 /*FIXME*/ )))
1736 WCHAR *name = copy_path( get_req_data(), get_req_data_size(), !req->parent );
1737 if (name && (key = open_key( parent, name )))
1739 reply->hkey = alloc_handle( current->process, key, access, 0 );
1740 release_object( key );
1742 release_object( parent );
1746 /* delete a registry key */
1747 DECL_HANDLER(delete_key)
1751 if ((key = get_hkey_obj( req->hkey, 0 /*FIXME*/ )))
1753 delete_key( key, 0);
1754 release_object( key );
1758 /* flush a registry key */
1759 DECL_HANDLER(flush_key)
1761 struct key *key = get_hkey_obj( req->hkey, 0 );
1764 /* we don't need to do anything here with the current implementation */
1765 release_object( key );
1769 /* enumerate registry subkeys */
1770 DECL_HANDLER(enum_key)
1774 if ((key = get_hkey_obj( req->hkey,
1775 req->index == -1 ? KEY_QUERY_VALUE : KEY_ENUMERATE_SUB_KEYS )))
1777 enum_key( key, req->index, req->info_class, reply );
1778 release_object( key );
1782 /* set a value of a registry key */
1783 DECL_HANDLER(set_key_value)
1788 if (!(name = copy_req_path( req->namelen, 0 ))) return;
1789 if ((key = get_hkey_obj( req->hkey, KEY_SET_VALUE )))
1791 size_t datalen = get_req_data_size() - req->namelen;
1792 const char *data = (char *)get_req_data() + req->namelen;
1794 set_value( key, name, req->type, data, datalen );
1795 release_object( key );
1799 /* retrieve the value of a registry key */
1800 DECL_HANDLER(get_key_value)
1806 if (!(name = copy_path( get_req_data(), get_req_data_size(), 0 ))) return;
1807 if ((key = get_hkey_obj( req->hkey, KEY_QUERY_VALUE )))
1809 get_value( key, name, &reply->type, &reply->total );
1810 release_object( key );
1814 /* enumerate the value of a registry key */
1815 DECL_HANDLER(enum_key_value)
1819 if ((key = get_hkey_obj( req->hkey, KEY_QUERY_VALUE )))
1821 enum_value( key, req->index, req->info_class, reply );
1822 release_object( key );
1826 /* delete a value of a registry key */
1827 DECL_HANDLER(delete_key_value)
1832 if ((key = get_hkey_obj( req->hkey, KEY_SET_VALUE )))
1834 if ((name = req_strdupW( req, get_req_data(), get_req_data_size() )))
1836 delete_value( key, name );
1839 release_object( key );
1843 /* load a registry branch from a file */
1844 DECL_HANDLER(load_registry)
1848 if ((key = get_hkey_obj( req->hkey, KEY_SET_VALUE | KEY_CREATE_SUB_KEY )))
1850 /* FIXME: use subkey name */
1851 load_registry( key, req->file );
1852 release_object( key );
1856 DECL_HANDLER(unload_registry)
1860 if ((key = get_hkey_obj( req->hkey, 0 )))
1862 delete_key( key, 1 ); /* FIXME */
1863 release_object( key );
1867 /* save a registry branch to a file */
1868 DECL_HANDLER(save_registry)
1872 if ((key = get_hkey_obj( req->hkey, KEY_QUERY_VALUE | KEY_ENUMERATE_SUB_KEYS )))
1874 save_registry( key, req->file );
1875 release_object( key );
1879 /* load the user registry files */
1880 DECL_HANDLER(load_user_registries)
1885 saving_level = req->saving;
1887 if ((key = get_hkey_obj( req->hkey, KEY_SET_VALUE | KEY_CREATE_SUB_KEY )))
1889 load_user_registries( key );
1890 release_object( key );
1893 /* set periodic save timer */
1895 if (save_timeout_user)
1897 remove_timeout_user( save_timeout_user );
1898 save_timeout_user = NULL;
1900 if ((save_period = req->period))
1902 if (save_period < 10000) save_period = 10000; /* limit rate */
1903 gettimeofday( &next_save_time, 0 );
1904 add_timeout( &next_save_time, save_period );
1905 save_timeout_user = add_timeout_user( &next_save_time, periodic_save, 0 );
1909 /* add a registry key change notification */
1910 DECL_HANDLER(set_registry_notification)
1913 struct event *event;
1914 struct notify *notify;
1916 key = get_hkey_obj( req->hkey, KEY_NOTIFY );
1919 event = get_event_obj( current->process, req->event, SYNCHRONIZE );
1922 notify = find_notify( key, req->hkey );
1925 release_object( notify->event );
1926 grab_object( event );
1927 notify->event = event;
1931 notify = (struct notify *) malloc (sizeof(*notify));
1934 grab_object( event );
1935 notify->event = event;
1936 notify->subtree = req->subtree;
1937 notify->filter = req->filter;
1938 notify->hkey = req->hkey;
1940 /* add to linked list */
1941 notify->prev = NULL;
1942 notify->next = key->first_notify;
1944 notify->next->prev = notify;
1946 key->last_notify = notify;
1947 key->first_notify = notify;
1950 set_error( STATUS_NO_MEMORY );
1952 release_object( event );
1954 release_object( key );