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"
52 #include "wine/library.h"
56 struct list entry; /* entry in list of notifications */
57 struct event *event; /* event to set when changing this key */
58 int subtree; /* true if subtree notification */
59 unsigned int filter; /* which events to notify on */
60 obj_handle_t hkey; /* hkey associated with this notification */
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 unsigned int flags; /* flags */
77 time_t modif; /* last modification time */
78 struct list notify_list; /* list of notifications */
82 #define KEY_VOLATILE 0x0001 /* key is volatile (not saved to disk) */
83 #define KEY_DELETED 0x0002 /* key has been deleted */
84 #define KEY_DIRTY 0x0004 /* key has been modified */
89 WCHAR *name; /* value name */
90 int type; /* value type */
91 size_t len; /* value data length in bytes */
92 void *data; /* pointer to value data */
95 #define MIN_SUBKEYS 8 /* min. number of allocated subkeys per key */
96 #define MIN_VALUES 8 /* min. number of allocated values per key */
99 /* the root of the registry tree */
100 static struct key *root_key;
102 static const int save_period = 30000; /* delay between periodic saves (in ms) */
103 static struct timeout_user *save_timeout_user; /* saving timer */
105 static void set_periodic_save_timer(void);
107 /* information about where to save a registry branch */
108 struct save_branch_info
114 #define MAX_SAVE_BRANCH_INFO 3
115 static int save_branch_count;
116 static struct save_branch_info save_branch_info[MAX_SAVE_BRANCH_INFO];
119 /* information about a file being loaded */
120 struct file_load_info
122 FILE *file; /* input file */
123 char *buffer; /* line buffer */
124 int len; /* buffer length */
125 int line; /* current input line */
126 char *tmp; /* temp buffer to use while parsing input */
127 int tmplen; /* length of temp buffer */
131 static void key_dump( struct object *obj, int verbose );
132 static void key_destroy( struct object *obj );
134 static const struct object_ops key_ops =
136 sizeof(struct key), /* size */
138 no_add_queue, /* add_queue */
139 NULL, /* remove_queue */
141 NULL, /* satisfied */
142 no_signal, /* signal */
143 no_get_fd, /* get_fd */
144 key_destroy /* destroy */
149 * The registry text file format v2 used by this code is similar to the one
150 * used by REGEDIT import/export functionality, with the following differences:
151 * - strings and key names can contain \x escapes for Unicode
152 * - key names use escapes too in order to support Unicode
153 * - the modification time optionally follows the key name
154 * - REG_EXPAND_SZ and REG_MULTI_SZ are saved as strings instead of hex
157 static inline char to_hex( char ch )
159 if (isdigit(ch)) return ch - '0';
160 return tolower(ch) - 'a' + 10;
163 /* dump the full path of a key */
164 static void dump_path( const struct key *key, const struct key *base, FILE *f )
166 if (key->parent && key->parent != base)
168 dump_path( key->parent, base, f );
169 fprintf( f, "\\\\" );
171 dump_strW( key->name, strlenW(key->name), f, "[]" );
174 /* dump a value to a text file */
175 static void dump_value( const struct key_value *value, FILE *f )
183 count = 1 + dump_strW( value->name, strlenW(value->name), f, "\"\"" );
184 count += fprintf( f, "\"=" );
186 else count = fprintf( f, "@=" );
193 if (value->type != REG_SZ) fprintf( f, "str(%d):", value->type );
195 if (value->data) dump_strW( (WCHAR *)value->data, value->len / sizeof(WCHAR), f, "\"\"" );
199 if (value->len == sizeof(DWORD))
202 memcpy( &dw, value->data, sizeof(DWORD) );
203 fprintf( f, "dword:%08lx", dw );
206 /* else fall through */
208 if (value->type == REG_BINARY) count += fprintf( f, "hex:" );
209 else count += fprintf( f, "hex(%x):", value->type );
210 for (i = 0; i < value->len; i++)
212 count += fprintf( f, "%02x", *((unsigned char *)value->data + i) );
213 if (i < value->len-1)
218 fprintf( f, "\\\n " );
228 /* save a registry and all its subkeys to a text file */
229 static void save_subkeys( const struct key *key, const struct key *base, FILE *f )
233 if (key->flags & KEY_VOLATILE) return;
234 /* save key if it has either some values or no subkeys */
235 /* keys with no values but subkeys are saved implicitly by saving the subkeys */
236 if ((key->last_value >= 0) || (key->last_subkey == -1))
239 if (key != base) dump_path( key, base, f );
240 fprintf( f, "] %ld\n", (long)key->modif );
241 for (i = 0; i <= key->last_value; i++) dump_value( &key->values[i], f );
243 for (i = 0; i <= key->last_subkey; i++) save_subkeys( key->subkeys[i], base, f );
246 static void dump_operation( const struct key *key, const struct key_value *value, const char *op )
248 fprintf( stderr, "%s key ", op );
249 if (key) dump_path( key, NULL, stderr );
250 else fprintf( stderr, "ERROR" );
253 fprintf( stderr, " value ");
254 dump_value( value, stderr );
256 else fprintf( stderr, "\n" );
259 static void key_dump( struct object *obj, int verbose )
261 struct key *key = (struct key *)obj;
262 assert( obj->ops == &key_ops );
263 fprintf( stderr, "Key flags=%x ", key->flags );
264 dump_path( key, NULL, stderr );
265 fprintf( stderr, "\n" );
268 /* notify waiter and maybe delete the notification */
269 static void do_notification( struct key *key, struct notify *notify, int del )
273 set_event( notify->event );
274 release_object( notify->event );
275 notify->event = NULL;
279 list_remove( ¬ify->entry );
284 static struct notify *find_notify( struct key *key, obj_handle_t hkey)
286 struct notify *notify;
288 LIST_FOR_EACH_ENTRY( notify, &key->notify_list, struct notify, entry )
290 if (notify->hkey == hkey) return notify;
295 /* close the notification associated with a handle */
296 void registry_close_handle( struct object *obj, obj_handle_t hkey )
298 struct key * key = (struct key *) obj;
299 struct notify *notify;
301 if( obj->ops != &key_ops )
303 notify = find_notify( key, hkey );
306 do_notification( key, notify, 1 );
309 static void key_destroy( struct object *obj )
313 struct key *key = (struct key *)obj;
314 assert( obj->ops == &key_ops );
316 if (key->name) free( key->name );
317 if (key->class) free( key->class );
318 for (i = 0; i <= key->last_value; i++)
320 free( key->values[i].name );
321 if (key->values[i].data) free( key->values[i].data );
323 if (key->values) free( key->values );
324 for (i = 0; i <= key->last_subkey; i++)
326 key->subkeys[i]->parent = NULL;
327 release_object( key->subkeys[i] );
329 if (key->subkeys) free( key->subkeys );
330 /* unconditionally notify everything waiting on this key */
331 while ((ptr = list_head( &key->notify_list )))
333 struct notify *notify = LIST_ENTRY( ptr, struct notify, entry );
334 do_notification( key, notify, 1 );
338 /* duplicate a key path */
339 /* returns a pointer to a static buffer, so only useable once per request */
340 static WCHAR *copy_path( const WCHAR *path, size_t len, int skip_root )
342 static WCHAR buffer[MAX_PATH+1];
343 static const WCHAR root_name[] = { '\\','R','e','g','i','s','t','r','y','\\',0 };
345 if (len > sizeof(buffer)-sizeof(buffer[0]))
347 set_error( STATUS_BUFFER_OVERFLOW );
350 memcpy( buffer, path, len );
351 buffer[len / sizeof(WCHAR)] = 0;
352 if (skip_root && !strncmpiW( buffer, root_name, 10 )) return buffer + 10;
356 /* copy a path from the request buffer */
357 static WCHAR *copy_req_path( size_t len, int skip_root )
359 const WCHAR *name_ptr = get_req_data();
360 if (len > get_req_data_size())
362 fatal_protocol_error( current, "copy_req_path: invalid length %d/%d\n",
363 len, get_req_data_size() );
366 return copy_path( name_ptr, len, skip_root );
369 /* return the next token in a given path */
370 /* returns a pointer to a static buffer, so only useable once per request */
371 static WCHAR *get_path_token( WCHAR *initpath )
378 /* path cannot start with a backslash */
379 if (*initpath == '\\')
381 set_error( STATUS_OBJECT_PATH_INVALID );
386 else while (*path == '\\') path++;
389 while (*path && *path != '\\') path++;
390 if (*path) *path++ = 0;
394 /* duplicate a Unicode string from the request buffer */
395 static WCHAR *req_strdupW( const void *req, const WCHAR *str, size_t len )
398 if ((name = mem_alloc( len + sizeof(WCHAR) )) != NULL)
400 memcpy( name, str, len );
401 name[len / sizeof(WCHAR)] = 0;
406 /* allocate a key object */
407 static struct key *alloc_key( const WCHAR *name, time_t modif )
410 if ((key = alloc_object( &key_ops )))
414 key->last_subkey = -1;
418 key->last_value = -1;
422 list_init( &key->notify_list );
423 if (!(key->name = strdupW( name )))
425 release_object( key );
432 /* mark a key and all its parents as dirty (modified) */
433 static void make_dirty( struct key *key )
437 if (key->flags & (KEY_DIRTY|KEY_VOLATILE)) return; /* nothing to do */
438 key->flags |= KEY_DIRTY;
443 /* mark a key and all its subkeys as clean (not modified) */
444 static void make_clean( struct key *key )
448 if (key->flags & KEY_VOLATILE) return;
449 if (!(key->flags & KEY_DIRTY)) return;
450 key->flags &= ~KEY_DIRTY;
451 for (i = 0; i <= key->last_subkey; i++) make_clean( key->subkeys[i] );
454 /* go through all the notifications and send them if necessary */
455 static void check_notify( struct key *key, unsigned int change, int not_subtree )
457 struct list *ptr, *next;
459 LIST_FOR_EACH_SAFE( ptr, next, &key->notify_list )
461 struct notify *n = LIST_ENTRY( ptr, struct notify, entry );
462 if ( ( not_subtree || n->subtree ) && ( change & n->filter ) )
463 do_notification( key, n, 0 );
467 /* update key modification time */
468 static void touch_key( struct key *key, unsigned int change )
472 key->modif = time(NULL);
475 /* do notifications */
476 check_notify( key, change, 1 );
477 for ( k = key->parent; k; k = k->parent )
478 check_notify( k, change & ~REG_NOTIFY_CHANGE_LAST_SET, 0 );
481 /* try to grow the array of subkeys; return 1 if OK, 0 on error */
482 static int grow_subkeys( struct key *key )
484 struct key **new_subkeys;
489 nb_subkeys = key->nb_subkeys + (key->nb_subkeys / 2); /* grow by 50% */
490 if (!(new_subkeys = realloc( key->subkeys, nb_subkeys * sizeof(*new_subkeys) )))
492 set_error( STATUS_NO_MEMORY );
498 nb_subkeys = MIN_VALUES;
499 if (!(new_subkeys = mem_alloc( nb_subkeys * sizeof(*new_subkeys) ))) return 0;
501 key->subkeys = new_subkeys;
502 key->nb_subkeys = nb_subkeys;
506 /* allocate a subkey for a given key, and return its index */
507 static struct key *alloc_subkey( struct key *parent, const WCHAR *name, int index, time_t modif )
512 if (parent->last_subkey + 1 == parent->nb_subkeys)
514 /* need to grow the array */
515 if (!grow_subkeys( parent )) return NULL;
517 if ((key = alloc_key( name, modif )) != NULL)
519 key->parent = parent;
520 for (i = ++parent->last_subkey; i > index; i--)
521 parent->subkeys[i] = parent->subkeys[i-1];
522 parent->subkeys[index] = key;
527 /* free a subkey of a given key */
528 static void free_subkey( struct key *parent, int index )
533 assert( index >= 0 );
534 assert( index <= parent->last_subkey );
536 key = parent->subkeys[index];
537 for (i = index; i < parent->last_subkey; i++) parent->subkeys[i] = parent->subkeys[i + 1];
538 parent->last_subkey--;
539 key->flags |= KEY_DELETED;
541 release_object( key );
543 /* try to shrink the array */
544 nb_subkeys = parent->nb_subkeys;
545 if (nb_subkeys > MIN_SUBKEYS && parent->last_subkey < nb_subkeys / 2)
547 struct key **new_subkeys;
548 nb_subkeys -= nb_subkeys / 3; /* shrink by 33% */
549 if (nb_subkeys < MIN_SUBKEYS) nb_subkeys = MIN_SUBKEYS;
550 if (!(new_subkeys = realloc( parent->subkeys, nb_subkeys * sizeof(*new_subkeys) ))) return;
551 parent->subkeys = new_subkeys;
552 parent->nb_subkeys = nb_subkeys;
556 /* find the named child of a given key and return its index */
557 static struct key *find_subkey( const struct key *key, const WCHAR *name, int *index )
559 int i, min, max, res;
562 max = key->last_subkey;
566 if (!(res = strcmpiW( key->subkeys[i]->name, name )))
569 return key->subkeys[i];
571 if (res > 0) max = i - 1;
574 *index = min; /* this is where we should insert it */
579 /* warning: the key name must be writeable (use copy_path) */
580 static struct key *open_key( struct key *key, WCHAR *name )
585 if (!(path = get_path_token( name ))) return NULL;
588 if (!(key = find_subkey( key, path, &index )))
590 set_error( STATUS_OBJECT_NAME_NOT_FOUND );
593 path = get_path_token( NULL );
596 if (debug_level > 1) dump_operation( key, NULL, "Open" );
597 if (key) grab_object( key );
601 /* create a subkey */
602 /* warning: the key name must be writeable (use copy_path) */
603 static struct key *create_key( struct key *key, WCHAR *name, WCHAR *class,
604 int flags, time_t modif, int *created )
610 if (key->flags & KEY_DELETED) /* we cannot create a subkey under a deleted key */
612 set_error( STATUS_KEY_DELETED );
615 if (!(flags & KEY_VOLATILE) && (key->flags & KEY_VOLATILE))
617 set_error( STATUS_CHILD_MUST_BE_VOLATILE );
620 if (!modif) modif = time(NULL);
622 if (!(path = get_path_token( name ))) return NULL;
627 if (!(subkey = find_subkey( key, path, &index ))) break;
629 path = get_path_token( NULL );
632 /* create the remaining part */
634 if (!*path) goto done;
636 if (flags & KEY_DIRTY) make_dirty( key );
639 key = alloc_subkey( key, path, index, modif );
643 path = get_path_token( NULL );
644 if (!*path) goto done;
645 /* we know the index is always 0 in a new key */
646 key = alloc_subkey( key, path, 0, modif );
648 if (base_idx != -1) free_subkey( base, base_idx );
652 if (debug_level > 1) dump_operation( key, NULL, "Create" );
653 if (class) key->class = strdupW(class);
658 /* query information about a key or a subkey */
659 static void enum_key( const struct key *key, int index, int info_class,
660 struct enum_key_reply *reply )
663 size_t len, namelen, classlen;
664 int max_subkey = 0, max_class = 0;
665 int max_value = 0, max_data = 0;
668 if (index != -1) /* -1 means use the specified key directly */
670 if ((index < 0) || (index > key->last_subkey))
672 set_error( STATUS_NO_MORE_ENTRIES );
675 key = key->subkeys[index];
678 namelen = strlenW(key->name) * sizeof(WCHAR);
679 classlen = key->class ? strlenW(key->class) * sizeof(WCHAR) : 0;
683 case KeyBasicInformation:
684 classlen = 0; /* only return the name */
686 case KeyNodeInformation:
687 reply->max_subkey = 0;
688 reply->max_class = 0;
689 reply->max_value = 0;
692 case KeyFullInformation:
693 for (i = 0; i <= key->last_subkey; i++)
695 struct key *subkey = key->subkeys[i];
696 len = strlenW( subkey->name );
697 if (len > max_subkey) max_subkey = len;
698 if (!subkey->class) continue;
699 len = strlenW( subkey->class );
700 if (len > max_class) max_class = len;
702 for (i = 0; i <= key->last_value; i++)
704 len = strlenW( key->values[i].name );
705 if (len > max_value) max_value = len;
706 len = key->values[i].len;
707 if (len > max_data) max_data = len;
709 reply->max_subkey = max_subkey;
710 reply->max_class = max_class;
711 reply->max_value = max_value;
712 reply->max_data = max_data;
713 namelen = 0; /* only return the class */
716 set_error( STATUS_INVALID_PARAMETER );
719 reply->subkeys = key->last_subkey + 1;
720 reply->values = key->last_value + 1;
721 reply->modif = key->modif;
722 reply->total = namelen + classlen;
724 len = min( reply->total, get_reply_max_size() );
725 if (len && (data = set_reply_data_size( len )))
729 reply->namelen = namelen;
730 memcpy( data, key->name, namelen );
731 memcpy( (char *)data + namelen, key->class, len - namelen );
735 reply->namelen = len;
736 memcpy( data, key->name, len );
739 if (debug_level > 1) dump_operation( key, NULL, "Enum" );
742 /* delete a key and its values */
743 static int delete_key( struct key *key, int recurse )
748 /* must find parent and index */
751 set_error( STATUS_ACCESS_DENIED );
754 if (!(parent = key->parent) || (key->flags & KEY_DELETED))
756 set_error( STATUS_KEY_DELETED );
760 while (recurse && (key->last_subkey>=0))
761 if(0>delete_key(key->subkeys[key->last_subkey], 1))
764 for (index = 0; index <= parent->last_subkey; index++)
765 if (parent->subkeys[index] == key) break;
766 assert( index <= parent->last_subkey );
768 /* we can only delete a key that has no subkeys */
769 if (key->last_subkey >= 0)
771 set_error( STATUS_ACCESS_DENIED );
775 if (debug_level > 1) dump_operation( key, NULL, "Delete" );
776 free_subkey( parent, index );
777 touch_key( parent, REG_NOTIFY_CHANGE_NAME );
781 /* try to grow the array of values; return 1 if OK, 0 on error */
782 static int grow_values( struct key *key )
784 struct key_value *new_val;
789 nb_values = key->nb_values + (key->nb_values / 2); /* grow by 50% */
790 if (!(new_val = realloc( key->values, nb_values * sizeof(*new_val) )))
792 set_error( STATUS_NO_MEMORY );
798 nb_values = MIN_VALUES;
799 if (!(new_val = mem_alloc( nb_values * sizeof(*new_val) ))) return 0;
801 key->values = new_val;
802 key->nb_values = nb_values;
806 /* find the named value of a given key and return its index in the array */
807 static struct key_value *find_value( const struct key *key, const WCHAR *name, int *index )
809 int i, min, max, res;
812 max = key->last_value;
816 if (!(res = strcmpiW( key->values[i].name, name )))
819 return &key->values[i];
821 if (res > 0) max = i - 1;
824 *index = min; /* this is where we should insert it */
828 /* insert a new value; the index must have been returned by find_value */
829 static struct key_value *insert_value( struct key *key, const WCHAR *name, int index )
831 struct key_value *value;
835 if (key->last_value + 1 == key->nb_values)
837 if (!grow_values( key )) return NULL;
839 if (!(new_name = strdupW(name))) return NULL;
840 for (i = ++key->last_value; i > index; i--) key->values[i] = key->values[i - 1];
841 value = &key->values[index];
842 value->name = new_name;
848 /* set a key value */
849 static void set_value( struct key *key, WCHAR *name, int type, const void *data, size_t len )
851 struct key_value *value;
855 if ((value = find_value( key, name, &index )))
857 /* check if the new value is identical to the existing one */
858 if (value->type == type && value->len == len &&
859 value->data && !memcmp( value->data, data, len ))
861 if (debug_level > 1) dump_operation( key, value, "Skip setting" );
866 if (len && !(ptr = memdup( data, len ))) return;
870 if (!(value = insert_value( key, name, index )))
872 if (ptr) free( ptr );
876 else if (value->data) free( value->data ); /* already existing, free previous data */
881 touch_key( key, REG_NOTIFY_CHANGE_LAST_SET );
882 if (debug_level > 1) dump_operation( key, value, "Set" );
885 /* get a key value */
886 static void get_value( struct key *key, const WCHAR *name, int *type, int *len )
888 struct key_value *value;
891 if ((value = find_value( key, name, &index )))
895 if (value->data) set_reply_data( value->data, min( value->len, get_reply_max_size() ));
896 if (debug_level > 1) dump_operation( key, value, "Get" );
901 set_error( STATUS_OBJECT_NAME_NOT_FOUND );
905 /* enumerate a key value */
906 static void enum_value( struct key *key, int i, int info_class, struct enum_key_value_reply *reply )
908 struct key_value *value;
910 if (i < 0 || i > key->last_value) set_error( STATUS_NO_MORE_ENTRIES );
914 size_t namelen, maxlen;
916 value = &key->values[i];
917 reply->type = value->type;
918 namelen = strlenW( value->name ) * sizeof(WCHAR);
922 case KeyValueBasicInformation:
923 reply->total = namelen;
925 case KeyValueFullInformation:
926 reply->total = namelen + value->len;
928 case KeyValuePartialInformation:
929 reply->total = value->len;
933 set_error( STATUS_INVALID_PARAMETER );
937 maxlen = min( reply->total, get_reply_max_size() );
938 if (maxlen && ((data = set_reply_data_size( maxlen ))))
940 if (maxlen > namelen)
942 reply->namelen = namelen;
943 memcpy( data, value->name, namelen );
944 memcpy( (char *)data + namelen, value->data, maxlen - namelen );
948 reply->namelen = maxlen;
949 memcpy( data, value->name, maxlen );
952 if (debug_level > 1) dump_operation( key, value, "Enum" );
957 static void delete_value( struct key *key, const WCHAR *name )
959 struct key_value *value;
960 int i, index, nb_values;
962 if (!(value = find_value( key, name, &index )))
964 set_error( STATUS_OBJECT_NAME_NOT_FOUND );
967 if (debug_level > 1) dump_operation( key, value, "Delete" );
969 if (value->data) free( value->data );
970 for (i = index; i < key->last_value; i++) key->values[i] = key->values[i + 1];
972 touch_key( key, REG_NOTIFY_CHANGE_LAST_SET );
974 /* try to shrink the array */
975 nb_values = key->nb_values;
976 if (nb_values > MIN_VALUES && key->last_value < nb_values / 2)
978 struct key_value *new_val;
979 nb_values -= nb_values / 3; /* shrink by 33% */
980 if (nb_values < MIN_VALUES) nb_values = MIN_VALUES;
981 if (!(new_val = realloc( key->values, nb_values * sizeof(*new_val) ))) return;
982 key->values = new_val;
983 key->nb_values = nb_values;
987 /* get the registry key corresponding to an hkey handle */
988 static struct key *get_hkey_obj( obj_handle_t hkey, unsigned int access )
990 if (!hkey) return (struct key *)grab_object( root_key );
991 return (struct key *)get_handle_obj( current->process, hkey, access, &key_ops );
994 /* read a line from the input file */
995 static int read_next_line( struct file_load_info *info )
1003 if (!fgets( info->buffer + pos, info->len - pos, info->file ))
1004 return (pos != 0); /* EOF */
1005 pos = strlen(info->buffer);
1006 if (info->buffer[pos-1] == '\n')
1008 /* got a full line */
1009 info->buffer[--pos] = 0;
1010 if (pos > 0 && info->buffer[pos-1] == '\r') info->buffer[pos-1] = 0;
1013 if (pos < info->len - 1) return 1; /* EOF but something was read */
1015 /* need to enlarge the buffer */
1016 newlen = info->len + info->len / 2;
1017 if (!(newbuf = realloc( info->buffer, newlen )))
1019 set_error( STATUS_NO_MEMORY );
1022 info->buffer = newbuf;
1027 /* make sure the temp buffer holds enough space */
1028 static int get_file_tmp_space( struct file_load_info *info, int size )
1031 if (info->tmplen >= size) return 1;
1032 if (!(tmp = realloc( info->tmp, size )))
1034 set_error( STATUS_NO_MEMORY );
1038 info->tmplen = size;
1042 /* report an error while loading an input file */
1043 static void file_read_error( const char *err, struct file_load_info *info )
1045 fprintf( stderr, "Line %d: %s '%s'\n", info->line, err, info->buffer );
1048 /* parse an escaped string back into Unicode */
1049 /* return the number of chars read from the input, or -1 on output overflow */
1050 static int parse_strW( WCHAR *dest, int *len, const char *src, char endchar )
1052 int count = sizeof(WCHAR); /* for terminating null */
1053 const char *p = src;
1054 while (*p && *p != endchar)
1056 if (*p != '\\') *dest = (WCHAR)*p++;
1062 case 'a': *dest = '\a'; p++; break;
1063 case 'b': *dest = '\b'; p++; break;
1064 case 'e': *dest = '\e'; p++; break;
1065 case 'f': *dest = '\f'; p++; break;
1066 case 'n': *dest = '\n'; p++; break;
1067 case 'r': *dest = '\r'; p++; break;
1068 case 't': *dest = '\t'; p++; break;
1069 case 'v': *dest = '\v'; p++; break;
1070 case 'x': /* hex escape */
1072 if (!isxdigit(*p)) *dest = 'x';
1075 *dest = to_hex(*p++);
1076 if (isxdigit(*p)) *dest = (*dest * 16) + to_hex(*p++);
1077 if (isxdigit(*p)) *dest = (*dest * 16) + to_hex(*p++);
1078 if (isxdigit(*p)) *dest = (*dest * 16) + to_hex(*p++);
1088 case '7': /* octal escape */
1090 if (*p >= '0' && *p <= '7') *dest = (*dest * 8) + (*p++ - '0');
1091 if (*p >= '0' && *p <= '7') *dest = (*dest * 8) + (*p++ - '0');
1094 *dest = (WCHAR)*p++;
1098 if ((count += sizeof(WCHAR)) > *len) return -1; /* dest buffer overflow */
1102 if (!*p) return -1; /* delimiter not found */
1107 /* convert a data type tag to a value type */
1108 static int get_data_type( const char *buffer, int *type, int *parse_type )
1110 struct data_type { const char *tag; int len; int type; int parse_type; };
1112 static const struct data_type data_types[] =
1113 { /* actual type */ /* type to assume for parsing */
1114 { "\"", 1, REG_SZ, REG_SZ },
1115 { "str:\"", 5, REG_SZ, REG_SZ },
1116 { "str(2):\"", 8, REG_EXPAND_SZ, REG_SZ },
1117 { "str(7):\"", 8, REG_MULTI_SZ, REG_SZ },
1118 { "hex:", 4, REG_BINARY, REG_BINARY },
1119 { "dword:", 6, REG_DWORD, REG_DWORD },
1120 { "hex(", 4, -1, REG_BINARY },
1124 const struct data_type *ptr;
1127 for (ptr = data_types; ptr->tag; ptr++)
1129 if (memcmp( ptr->tag, buffer, ptr->len )) continue;
1130 *parse_type = ptr->parse_type;
1131 if ((*type = ptr->type) != -1) return ptr->len;
1132 /* "hex(xx):" is special */
1133 *type = (int)strtoul( buffer + 4, &end, 16 );
1134 if ((end <= buffer) || memcmp( end, "):", 2 )) return 0;
1135 return end + 2 - buffer;
1140 /* load and create a key from the input file */
1141 static struct key *load_key( struct key *base, const char *buffer, int flags,
1142 int prefix_len, struct file_load_info *info,
1146 int res, len, modif;
1148 len = strlen(buffer) * sizeof(WCHAR);
1149 if (!get_file_tmp_space( info, len )) return NULL;
1151 if ((res = parse_strW( (WCHAR *)info->tmp, &len, buffer, ']' )) == -1)
1153 file_read_error( "Malformed key", info );
1156 if (sscanf( buffer + res, " %d", &modif ) != 1) modif = default_modif;
1158 p = (WCHAR *)info->tmp;
1159 while (prefix_len && *p) { if (*p++ == '\\') prefix_len--; }
1165 file_read_error( "Malformed key", info );
1168 /* empty key name, return base key */
1169 return (struct key *)grab_object( base );
1171 if (!(name = copy_path( p, len - ((char *)p - info->tmp), 0 )))
1173 file_read_error( "Key is too long", info );
1176 return create_key( base, name, NULL, flags, modif, &res );
1179 /* parse a comma-separated list of hex digits */
1180 static int parse_hex( unsigned char *dest, int *len, const char *buffer )
1182 const char *p = buffer;
1184 while (isxdigit(*p))
1188 memcpy( buf, p, 2 );
1190 sscanf( buf, "%x", &val );
1191 if (count++ >= *len) return -1; /* dest buffer overflow */
1192 *dest++ = (unsigned char )val;
1200 /* parse a value name and create the corresponding value */
1201 static struct key_value *parse_value_name( struct key *key, const char *buffer, int *len,
1202 struct file_load_info *info )
1204 struct key_value *value;
1207 maxlen = strlen(buffer) * sizeof(WCHAR);
1208 if (!get_file_tmp_space( info, maxlen )) return NULL;
1209 if (buffer[0] == '@')
1211 info->tmp[0] = info->tmp[1] = 0;
1216 if ((*len = parse_strW( (WCHAR *)info->tmp, &maxlen, buffer + 1, '\"' )) == -1) goto error;
1217 (*len)++; /* for initial quote */
1219 while (isspace(buffer[*len])) (*len)++;
1220 if (buffer[*len] != '=') goto error;
1222 while (isspace(buffer[*len])) (*len)++;
1223 if (!(value = find_value( key, (WCHAR *)info->tmp, &index )))
1224 value = insert_value( key, (WCHAR *)info->tmp, index );
1228 file_read_error( "Malformed value name", info );
1232 /* load a value from the input file */
1233 static int load_value( struct key *key, const char *buffer, struct file_load_info *info )
1237 int maxlen, len, res;
1238 int type, parse_type;
1239 struct key_value *value;
1241 if (!(value = parse_value_name( key, buffer, &len, info ))) return 0;
1242 if (!(res = get_data_type( buffer + len, &type, &parse_type ))) goto error;
1243 buffer += len + res;
1248 len = strlen(buffer) * sizeof(WCHAR);
1249 if (!get_file_tmp_space( info, len )) return 0;
1250 if ((res = parse_strW( (WCHAR *)info->tmp, &len, buffer, '\"' )) == -1) goto error;
1254 dw = strtoul( buffer, NULL, 16 );
1258 case REG_BINARY: /* hex digits */
1262 maxlen = 1 + strlen(buffer)/3; /* 3 chars for one hex byte */
1263 if (!get_file_tmp_space( info, len + maxlen )) return 0;
1264 if ((res = parse_hex( info->tmp + len, &maxlen, buffer )) == -1) goto error;
1267 while (isspace(*buffer)) buffer++;
1268 if (!*buffer) break;
1269 if (*buffer != '\\') goto error;
1270 if (read_next_line( info) != 1) goto error;
1271 buffer = info->buffer;
1272 while (isspace(*buffer)) buffer++;
1278 ptr = NULL; /* keep compiler quiet */
1282 if (!len) newptr = NULL;
1283 else if (!(newptr = memdup( ptr, len ))) return 0;
1285 if (value->data) free( value->data );
1286 value->data = newptr;
1293 file_read_error( "Malformed value", info );
1297 /* return the length (in path elements) of name that is part of the key name */
1298 /* for instance if key is USER\foo\bar and name is foo\bar\baz, return 2 */
1299 static int get_prefix_len( struct key *key, const char *name, struct file_load_info *info )
1303 int len = strlen(name) * sizeof(WCHAR);
1304 if (!get_file_tmp_space( info, len )) return 0;
1306 if ((res = parse_strW( (WCHAR *)info->tmp, &len, name, ']' )) == -1)
1308 file_read_error( "Malformed key", info );
1311 for (p = (WCHAR *)info->tmp; *p; p++) if (*p == '\\') break;
1313 for (res = 1; key != root_key; res++)
1315 if (!strcmpiW( (WCHAR *)info->tmp, key->name )) break;
1318 if (key == root_key) res = 0; /* no matching name */
1322 /* load all the keys from the input file */
1323 /* prefix_len is the number of key name prefixes to skip, or -1 for autodetection */
1324 static void load_keys( struct key *key, FILE *f, int prefix_len )
1326 struct key *subkey = NULL;
1327 struct file_load_info info;
1329 int default_modif = time(NULL);
1330 int flags = (key->flags & KEY_VOLATILE) ? KEY_VOLATILE : KEY_DIRTY;
1336 if (!(info.buffer = mem_alloc( info.len ))) return;
1337 if (!(info.tmp = mem_alloc( info.tmplen )))
1339 free( info.buffer );
1343 if ((read_next_line( &info ) != 1) ||
1344 strcmp( info.buffer, "WINE REGISTRY Version 2" ))
1346 set_error( STATUS_NOT_REGISTRY_FILE );
1350 while (read_next_line( &info ) == 1)
1353 while (*p && isspace(*p)) p++;
1356 case '[': /* new key */
1357 if (subkey) release_object( subkey );
1358 if (prefix_len == -1) prefix_len = get_prefix_len( key, p + 1, &info );
1359 if (!(subkey = load_key( key, p + 1, flags, prefix_len, &info, default_modif )))
1360 file_read_error( "Error creating key", &info );
1362 case '@': /* default value */
1363 case '\"': /* value */
1364 if (subkey) load_value( subkey, p, &info );
1365 else file_read_error( "Value without key", &info );
1367 case '#': /* comment */
1368 case ';': /* comment */
1369 case 0: /* empty line */
1372 file_read_error( "Unrecognized input", &info );
1378 if (subkey) release_object( subkey );
1379 free( info.buffer );
1383 /* load a part of the registry from a file */
1384 static void load_registry( struct key *key, obj_handle_t handle )
1389 if (!(file = get_file_obj( current->process, handle, GENERIC_READ ))) return;
1390 fd = dup( get_file_unix_fd( file ) );
1391 release_object( file );
1394 FILE *f = fdopen( fd, "r" );
1397 load_keys( key, f, -1 );
1400 else file_set_error();
1404 /* load one of the initial registry files */
1405 static void load_init_registry_from_file( const char *filename, struct key *key )
1409 if ((f = fopen( filename, "r" )))
1411 load_keys( key, f, 0 );
1413 if (get_error() == STATUS_NOT_REGISTRY_FILE)
1414 fatal_error( "%s is not a valid registry file\n", filename );
1416 fatal_error( "loading %s failed with error %x\n", filename, get_error() );
1419 if (!(key->flags & KEY_VOLATILE))
1421 assert( save_branch_count < MAX_SAVE_BRANCH_INFO );
1423 if ((save_branch_info[save_branch_count].path = strdup( filename )))
1424 save_branch_info[save_branch_count++].key = (struct key *)grab_object( key );
1428 /* load the user registry files */
1429 static void load_user_registries( struct key *key_current_user )
1431 const char *config = wine_get_config_dir();
1434 /* load user.reg into HKEY_CURRENT_USER */
1436 if (!(filename = mem_alloc( strlen(config) + sizeof("/user.reg") ))) return;
1437 strcpy( filename, config );
1438 strcat( filename, "/user.reg" );
1439 load_init_registry_from_file( filename, key_current_user );
1442 /* start the periodic save timer */
1443 set_periodic_save_timer();
1446 /* registry initialisation */
1447 void init_registry(void)
1449 static const WCHAR root_name[] = { 0 };
1450 static const WCHAR HKLM[] = { 'M','a','c','h','i','n','e' };
1451 static const WCHAR HKU_default[] = { 'U','s','e','r','\\','.','D','e','f','a','u','l','t' };
1452 static const WCHAR config_name[] =
1453 { 'M','a','c','h','i','n','e','\\','S','o','f','t','w','a','r','e','\\',
1454 'W','i','n','e','\\','W','i','n','e','\\','C','o','n','f','i','g',0 };
1456 const char *config = wine_get_config_dir();
1461 /* create the root key */
1462 root_key = alloc_key( root_name, time(NULL) );
1465 /* load the config file */
1466 if (!(filename = malloc( strlen(config) + 16 ))) fatal_error( "out of memory\n" );
1467 strcpy( filename, config );
1468 p = filename + strlen(filename);
1470 /* load system.reg into Registry\Machine */
1472 if (!(key = create_key( root_key, copy_path( HKLM, sizeof(HKLM), 0 ),
1473 NULL, 0, time(NULL), &dummy )))
1474 fatal_error( "could not create Machine registry key\n" );
1476 strcpy( p, "/system.reg" );
1477 load_init_registry_from_file( filename, key );
1478 release_object( key );
1480 /* load userdef.reg into Registry\User\.Default */
1482 if (!(key = create_key( root_key, copy_path( HKU_default, sizeof(HKU_default), 0 ),
1483 NULL, 0, time(NULL), &dummy )))
1484 fatal_error( "could not create User\\.Default registry key\n" );
1486 strcpy( p, "/userdef.reg" );
1487 load_init_registry_from_file( filename, key );
1488 release_object( key );
1490 /* load config into Registry\Machine\Software\Wine\Wine\Config */
1492 if (!(key = create_key( root_key, copy_path( config_name, sizeof(config_name), 0 ),
1493 NULL, 0, time(NULL), &dummy )))
1494 fatal_error( "could not create Config registry key\n" );
1496 key->flags |= KEY_VOLATILE;
1497 strcpy( p, "/config" );
1498 load_init_registry_from_file( filename, key );
1499 release_object( key );
1504 /* save a registry branch to a file */
1505 static void save_all_subkeys( struct key *key, FILE *f )
1507 fprintf( f, "WINE REGISTRY Version 2\n" );
1508 fprintf( f, ";; All keys relative to " );
1509 dump_path( key, NULL, f );
1511 save_subkeys( key, key, f );
1514 /* save a registry branch to a file handle */
1515 static void save_registry( struct key *key, obj_handle_t handle )
1520 if (key->flags & KEY_DELETED)
1522 set_error( STATUS_KEY_DELETED );
1525 if (!(file = get_file_obj( current->process, handle, GENERIC_WRITE ))) return;
1526 fd = dup( get_file_unix_fd( file ) );
1527 release_object( file );
1530 FILE *f = fdopen( fd, "w" );
1533 save_all_subkeys( key, f );
1534 if (fclose( f )) file_set_error();
1544 /* save a registry branch to a file */
1545 static int save_branch( struct key *key, const char *path )
1548 char *p, *real, *tmp = NULL;
1549 int fd, count = 0, ret = 0, by_symlink;
1552 if (!(key->flags & KEY_DIRTY))
1554 if (debug_level > 1) dump_operation( key, NULL, "Not saving clean" );
1558 /* get the real path */
1560 by_symlink = (!lstat(path, &st) && S_ISLNK (st.st_mode));
1561 if (!(real = malloc( PATH_MAX ))) return 0;
1562 if (!realpath( path, real ))
1569 /* test the file type */
1571 if ((fd = open( path, O_WRONLY )) != -1)
1573 /* if file is not a regular file or has multiple links or is accessed
1574 * via symbolic links, write directly into it; otherwise use a temp file */
1576 (!fstat( fd, &st ) && (!S_ISREG(st.st_mode) || st.st_nlink > 1)))
1584 /* create a temp file in the same directory */
1586 if (!(tmp = malloc( strlen(path) + 20 ))) goto done;
1587 strcpy( tmp, path );
1588 if ((p = strrchr( tmp, '/' ))) p++;
1592 sprintf( p, "reg%lx%04x.tmp", (long) getpid(), count++ );
1593 if ((fd = open( tmp, O_CREAT | O_EXCL | O_WRONLY, 0666 )) != -1) break;
1594 if (errno != EEXIST) goto done;
1598 /* now save to it */
1601 if (!(f = fdopen( fd, "w" )))
1603 if (tmp) unlink( tmp );
1608 if (debug_level > 1)
1610 fprintf( stderr, "%s: ", path );
1611 dump_operation( key, NULL, "saving" );
1614 save_all_subkeys( key, f );
1619 /* if successfully written, rename to final name */
1620 if (ret) ret = !rename( tmp, path );
1621 if (!ret) unlink( tmp );
1627 if (ret) make_clean( key );
1631 /* periodic saving of the registry */
1632 static void periodic_save( void *arg )
1636 save_timeout_user = NULL;
1637 for (i = 0; i < save_branch_count; i++)
1638 save_branch( save_branch_info[i].key, save_branch_info[i].path );
1639 set_periodic_save_timer();
1642 /* start the periodic save timer */
1643 static void set_periodic_save_timer(void)
1645 struct timeval next;
1647 gettimeofday( &next, NULL );
1648 add_timeout( &next, save_period );
1649 if (save_timeout_user) remove_timeout_user( save_timeout_user );
1650 save_timeout_user = add_timeout_user( &next, periodic_save, NULL );
1653 /* save the modified registry branches to disk */
1654 void flush_registry(void)
1658 for (i = 0; i < save_branch_count; i++)
1660 if (!save_branch( save_branch_info[i].key, save_branch_info[i].path ))
1662 fprintf( stderr, "wineserver: could not save registry branch to %s",
1663 save_branch_info[i].path );
1669 /* close the top-level keys; used on server exit */
1670 void close_registry(void)
1674 if (save_timeout_user) remove_timeout_user( save_timeout_user );
1675 save_timeout_user = NULL;
1676 for (i = 0; i < save_branch_count; i++)
1678 release_object( save_branch_info[i].key );
1679 free( save_branch_info[i].path );
1681 release_object( root_key );
1685 /* create a registry key */
1686 DECL_HANDLER(create_key)
1688 struct key *key = NULL, *parent;
1689 unsigned int access = req->access;
1690 WCHAR *name, *class;
1692 if (access & MAXIMUM_ALLOWED) access = KEY_ALL_ACCESS; /* FIXME: needs general solution */
1694 if (!(name = copy_req_path( req->namelen, !req->parent ))) return;
1695 if ((parent = get_hkey_obj( req->parent, KEY_CREATE_SUB_KEY )))
1697 int flags = (req->options & REG_OPTION_VOLATILE) ? KEY_VOLATILE : KEY_DIRTY;
1699 if (req->namelen == get_req_data_size()) /* no class specified */
1701 key = create_key( parent, name, NULL, flags, req->modif, &reply->created );
1705 const WCHAR *class_ptr = (const WCHAR *)((const char *)get_req_data() + req->namelen);
1707 if ((class = req_strdupW( req, class_ptr, get_req_data_size() - req->namelen )))
1709 key = create_key( parent, name, class, flags, req->modif, &reply->created );
1715 reply->hkey = alloc_handle( current->process, key, access, 0 );
1716 release_object( key );
1718 release_object( parent );
1722 /* open a registry key */
1723 DECL_HANDLER(open_key)
1725 struct key *key, *parent;
1726 unsigned int access = req->access;
1728 if (access & MAXIMUM_ALLOWED) access = KEY_ALL_ACCESS; /* FIXME: needs general solution */
1730 /* NOTE: no access rights are required to open the parent key, only the child key */
1731 if ((parent = get_hkey_obj( req->parent, 0 )))
1733 WCHAR *name = copy_path( get_req_data(), get_req_data_size(), !req->parent );
1734 if (name && (key = open_key( parent, name )))
1736 reply->hkey = alloc_handle( current->process, key, access, 0 );
1737 release_object( key );
1739 release_object( parent );
1743 /* delete a registry key */
1744 DECL_HANDLER(delete_key)
1748 if ((key = get_hkey_obj( req->hkey, DELETE )))
1750 delete_key( key, 0);
1751 release_object( key );
1755 /* flush a registry key */
1756 DECL_HANDLER(flush_key)
1758 struct key *key = get_hkey_obj( req->hkey, 0 );
1761 /* we don't need to do anything here with the current implementation */
1762 release_object( key );
1766 /* enumerate registry subkeys */
1767 DECL_HANDLER(enum_key)
1771 if ((key = get_hkey_obj( req->hkey,
1772 req->index == -1 ? KEY_QUERY_VALUE : KEY_ENUMERATE_SUB_KEYS )))
1774 enum_key( key, req->index, req->info_class, reply );
1775 release_object( key );
1779 /* set a value of a registry key */
1780 DECL_HANDLER(set_key_value)
1785 if (!(name = copy_req_path( req->namelen, 0 ))) return;
1786 if ((key = get_hkey_obj( req->hkey, KEY_SET_VALUE )))
1788 size_t datalen = get_req_data_size() - req->namelen;
1789 const char *data = (const char *)get_req_data() + req->namelen;
1791 set_value( key, name, req->type, data, datalen );
1792 release_object( key );
1796 /* retrieve the value of a registry key */
1797 DECL_HANDLER(get_key_value)
1803 if (!(name = copy_path( get_req_data(), get_req_data_size(), 0 ))) return;
1804 if ((key = get_hkey_obj( req->hkey, KEY_QUERY_VALUE )))
1806 get_value( key, name, &reply->type, &reply->total );
1807 release_object( key );
1811 /* enumerate the value of a registry key */
1812 DECL_HANDLER(enum_key_value)
1816 if ((key = get_hkey_obj( req->hkey, KEY_QUERY_VALUE )))
1818 enum_value( key, req->index, req->info_class, reply );
1819 release_object( key );
1823 /* delete a value of a registry key */
1824 DECL_HANDLER(delete_key_value)
1829 if ((key = get_hkey_obj( req->hkey, KEY_SET_VALUE )))
1831 if ((name = req_strdupW( req, get_req_data(), get_req_data_size() )))
1833 delete_value( key, name );
1836 release_object( key );
1840 /* load a registry branch from a file */
1841 DECL_HANDLER(load_registry)
1843 struct key *key, *parent;
1844 struct token *token = thread_get_impersonation_token( current );
1846 const LUID_AND_ATTRIBUTES privs[] =
1848 { SeBackupPrivilege, 0 },
1849 { SeRestorePrivilege, 0 },
1852 if (!token || !token_check_privileges( token, TRUE, privs,
1853 sizeof(privs)/sizeof(privs[0]), NULL ))
1855 set_error( STATUS_PRIVILEGE_NOT_HELD );
1859 if ((parent = get_hkey_obj( req->hkey, 0 )))
1862 WCHAR *name = copy_path( get_req_data(), get_req_data_size(), !req->hkey );
1863 if (name && (key = create_key( parent, name, NULL, KEY_DIRTY, time(NULL), &dummy )))
1865 load_registry( key, req->file );
1866 release_object( key );
1868 release_object( parent );
1872 DECL_HANDLER(unload_registry)
1875 struct token *token = thread_get_impersonation_token( current );
1877 const LUID_AND_ATTRIBUTES privs[] =
1879 { SeBackupPrivilege, 0 },
1880 { SeRestorePrivilege, 0 },
1883 if (!token || !token_check_privileges( token, TRUE, privs,
1884 sizeof(privs)/sizeof(privs[0]), NULL ))
1886 set_error( STATUS_PRIVILEGE_NOT_HELD );
1890 if ((key = get_hkey_obj( req->hkey, 0 )))
1892 delete_key( key, 1 ); /* FIXME */
1893 release_object( key );
1897 /* save a registry branch to a file */
1898 DECL_HANDLER(save_registry)
1902 if (!thread_single_check_privilege( current, &SeBackupPrivilege ))
1904 set_error( STATUS_PRIVILEGE_NOT_HELD );
1908 if ((key = get_hkey_obj( req->hkey, 0 )))
1910 save_registry( key, req->file );
1911 release_object( key );
1915 /* load the user registry files */
1916 DECL_HANDLER(load_user_registries)
1920 if ((key = get_hkey_obj( req->hkey, KEY_SET_VALUE | KEY_CREATE_SUB_KEY )))
1922 load_user_registries( key );
1923 release_object( key );
1927 /* add a registry key change notification */
1928 DECL_HANDLER(set_registry_notification)
1931 struct event *event;
1932 struct notify *notify;
1934 key = get_hkey_obj( req->hkey, KEY_NOTIFY );
1937 event = get_event_obj( current->process, req->event, SYNCHRONIZE );
1940 notify = find_notify( key, req->hkey );
1943 release_object( notify->event );
1944 grab_object( event );
1945 notify->event = event;
1949 notify = mem_alloc( sizeof(*notify) );
1952 grab_object( event );
1953 notify->event = event;
1954 notify->subtree = req->subtree;
1955 notify->filter = req->filter;
1956 notify->hkey = req->hkey;
1957 list_add_head( &key->notify_list, ¬ify->entry );
1960 release_object( event );
1962 release_object( key );