2 * Server-side registry management
4 * Copyright (C) 1999 Alexandre Julliard
8 * - behavior with deleted keys
9 * - values larger than request buffer
31 #include "winnt.h" /* registry definitions */
37 struct object obj
; /* object header */
38 WCHAR
*name
; /* key name */
39 WCHAR
*class; /* key class */
40 struct key
*parent
; /* parent key */
41 int last_subkey
; /* last in use subkey */
42 int nb_subkeys
; /* count of allocated subkeys */
43 struct key
**subkeys
; /* subkeys array */
44 int last_value
; /* last in use value */
45 int nb_values
; /* count of allocated values in array */
46 struct key_value
*values
; /* values array */
47 short flags
; /* flags */
48 short level
; /* saving level */
49 time_t modif
; /* last modification time */
53 #define KEY_VOLATILE 0x0001 /* key is volatile (not saved to disk) */
54 #define KEY_DELETED 0x0002 /* key has been deleted */
55 #define KEY_ROOT 0x0004 /* key is a root key */
60 WCHAR
*name
; /* value name */
61 int type
; /* value type */
62 size_t len
; /* value data length in bytes */
63 void *data
; /* pointer to value data */
66 #define MIN_SUBKEYS 8 /* min. number of allocated subkeys per key */
67 #define MIN_VALUES 8 /* min. number of allocated values per key */
70 /* the special root keys */
71 #define HKEY_SPECIAL_ROOT_FIRST HKEY_CLASSES_ROOT
72 #define HKEY_SPECIAL_ROOT_LAST HKEY_DYN_DATA
73 #define NB_SPECIAL_ROOT_KEYS (HKEY_SPECIAL_ROOT_LAST - HKEY_SPECIAL_ROOT_FIRST + 1)
74 #define IS_SPECIAL_ROOT_HKEY(h) (((unsigned int)(h) >= HKEY_SPECIAL_ROOT_FIRST) && \
75 ((unsigned int)(h) <= HKEY_SPECIAL_ROOT_LAST))
77 static struct key
*special_root_keys
[NB_SPECIAL_ROOT_KEYS
];
79 /* the real root key */
80 static struct key
*root_key
;
82 /* the special root key names */
83 static const char * const special_root_names
[NB_SPECIAL_ROOT_KEYS
] =
85 "Machine\\Software\\Classes", /* HKEY_CLASSES_ROOT */
86 "User\\", /* we append the user name dynamically */ /* HKEY_CURRENT_USER */
87 "Machine", /* HKEY_LOCAL_MACHINE */
88 "User", /* HKEY_USERS */
89 "PerfData", /* HKEY_PERFORMANCE_DATA */
90 "Machine\\System\\CurrentControlSet\\HardwareProfiles\\Current", /* HKEY_CURRENT_CONFIG */
91 "DynData" /* HKEY_DYN_DATA */
95 /* keys saving level */
96 /* current_level is the level that is put into all newly created or modified keys */
97 /* saving_level is the minimum level that a key needs in order to get saved */
98 static int current_level
;
99 static int saving_level
;
101 static struct timeval next_save_time
; /* absolute time of next periodic save */
102 static int save_period
; /* delay between periodic saves (ms) */
103 static struct timeout_user
*save_timeout_user
; /* saving timer */
105 /* information about where to save a registry branch */
106 struct save_branch_info
112 #define MAX_SAVE_BRANCH_INFO 8
113 static int save_branch_count
;
114 static struct save_branch_info save_branch_info
[MAX_SAVE_BRANCH_INFO
];
117 /* information about a file being loaded */
118 struct file_load_info
120 FILE *file
; /* input file */
121 char *buffer
; /* line buffer */
122 int len
; /* buffer length */
123 int line
; /* current input line */
124 char *tmp
; /* temp buffer to use while parsing input */
125 int tmplen
; /* length of temp buffer */
129 static void key_dump( struct object
*obj
, int verbose
);
130 static void key_destroy( struct object
*obj
);
132 static const struct object_ops key_ops
=
134 sizeof(struct key
), /* size */
136 no_add_queue
, /* add_queue */
137 NULL
, /* remove_queue */
139 NULL
, /* satisfied */
140 NULL
, /* get_poll_events */
141 NULL
, /* poll_event */
142 no_get_fd
, /* get_fd */
143 no_flush
, /* flush */
144 no_get_file_info
, /* get_file_info */
145 NULL
, /* queue_async */
146 key_destroy
/* destroy */
151 * The registry text file format v2 used by this code is similar to the one
152 * used by REGEDIT import/export functionality, with the following differences:
153 * - strings and key names can contain \x escapes for Unicode
154 * - key names use escapes too in order to support Unicode
155 * - the modification time optionally follows the key name
156 * - REG_EXPAND_SZ and REG_MULTI_SZ are saved as strings instead of hex
159 static inline char to_hex( char ch
)
161 if (isdigit(ch
)) return ch
- '0';
162 return tolower(ch
) - 'a' + 10;
165 /* dump the full path of a key */
166 static void dump_path( struct key
*key
, struct key
*base
, FILE *f
)
168 if (key
->parent
&& key
->parent
!= base
)
170 dump_path( key
->parent
, base
, f
);
171 fprintf( f
, "\\\\" );
173 dump_strW( key
->name
, strlenW(key
->name
), f
, "[]" );
176 /* dump a value to a text file */
177 static void dump_value( struct key_value
*value
, FILE *f
)
184 count
= 1 + dump_strW( value
->name
, strlenW(value
->name
), f
, "\"\"" );
185 count
+= fprintf( f
, "\"=" );
187 else count
= fprintf( f
, "@=" );
194 if (value
->type
!= REG_SZ
) fprintf( f
, "str(%d):", value
->type
);
196 if (value
->data
) dump_strW( (WCHAR
*)value
->data
, value
->len
/ sizeof(WCHAR
), f
, "\"\"" );
200 if (value
->len
== sizeof(DWORD
))
203 memcpy( &dw
, value
->data
, sizeof(DWORD
) );
204 fprintf( f
, "dword:%08lx", dw
);
207 /* else fall through */
209 if (value
->type
== REG_BINARY
) count
+= fprintf( f
, "hex:" );
210 else count
+= fprintf( f
, "hex(%x):", value
->type
);
211 for (i
= 0; i
< value
->len
; i
++)
213 count
+= fprintf( f
, "%02x", *((unsigned char *)value
->data
+ i
) );
214 if (i
< value
->len
-1)
219 fprintf( f
, "\\\n " );
229 /* save a registry and all its subkeys to a text file */
230 static void save_subkeys( struct key
*key
, struct key
*base
, FILE *f
)
234 if (key
->flags
& KEY_VOLATILE
) return;
235 /* save key if it has the proper level, and has either some values or no subkeys */
236 /* keys with no values but subkeys are saved implicitly by saving the subkeys */
237 if ((key
->level
>= saving_level
) && ((key
->last_value
>= 0) || (key
->last_subkey
== -1)))
240 if (key
!= base
) dump_path( key
, base
, f
);
241 fprintf( f
, "] %ld\n", key
->modif
);
242 for (i
= 0; i
<= key
->last_value
; i
++) dump_value( &key
->values
[i
], f
);
244 for (i
= 0; i
<= key
->last_subkey
; i
++) save_subkeys( key
->subkeys
[i
], base
, f
);
247 static void dump_operation( struct key
*key
, struct key_value
*value
, const char *op
)
249 fprintf( stderr
, "%s key ", op
);
250 if (key
) dump_path( key
, NULL
, stderr
);
251 else fprintf( stderr
, "ERROR" );
254 fprintf( stderr
, " value ");
255 dump_value( value
, stderr
);
257 else fprintf( stderr
, "\n" );
260 static void key_dump( struct object
*obj
, int verbose
)
262 struct key
*key
= (struct key
*)obj
;
263 assert( obj
->ops
== &key_ops
);
264 fprintf( stderr
, "Key flags=%x ", key
->flags
);
265 dump_path( key
, NULL
, stderr
);
266 fprintf( stderr
, "\n" );
269 static void key_destroy( struct object
*obj
)
272 struct key
*key
= (struct key
*)obj
;
273 assert( obj
->ops
== &key_ops
);
275 if (key
->name
) free( key
->name
);
276 if (key
->class) free( key
->class );
277 for (i
= 0; i
<= key
->last_value
; i
++)
279 free( key
->values
[i
].name
);
280 if (key
->values
[i
].data
) free( key
->values
[i
].data
);
282 for (i
= 0; i
<= key
->last_subkey
; i
++)
284 key
->subkeys
[i
]->parent
= NULL
;
285 release_object( key
->subkeys
[i
] );
289 /* duplicate a key path */
290 /* returns a pointer to a static buffer, so only useable once per request */
291 static WCHAR
*copy_path( const WCHAR
*path
, size_t len
, int skip_root
)
293 static WCHAR buffer
[MAX_PATH
+1];
294 static const WCHAR root_name
[] = { '\\','R','e','g','i','s','t','r','y','\\',0 };
296 if (len
> sizeof(buffer
)-sizeof(buffer
[0]))
298 set_error( STATUS_BUFFER_OVERFLOW
);
301 memcpy( buffer
, path
, len
);
302 buffer
[len
/ sizeof(WCHAR
)] = 0;
303 if (skip_root
&& !strncmpiW( buffer
, root_name
, 10 )) return buffer
+ 10;
307 /* copy a path from the request buffer */
308 static WCHAR
*copy_req_path( size_t len
, int skip_root
)
310 const WCHAR
*name_ptr
= get_req_data();
311 if (len
> get_req_data_size())
313 fatal_protocol_error( current
, "copy_req_path: invalid length %d/%d\n",
314 len
, get_req_data_size() );
317 return copy_path( name_ptr
, len
, skip_root
);
320 /* return the next token in a given path */
321 /* returns a pointer to a static buffer, so only useable once per request */
322 static WCHAR
*get_path_token( WCHAR
*initpath
)
329 /* path cannot start with a backslash */
330 if (*initpath
== '\\')
332 set_error( STATUS_OBJECT_PATH_INVALID
);
337 else while (*path
== '\\') path
++;
340 while (*path
&& *path
!= '\\') path
++;
341 if (*path
) *path
++ = 0;
345 /* duplicate a Unicode string from the request buffer */
346 static WCHAR
*req_strdupW( const void *req
, const WCHAR
*str
, size_t len
)
349 if ((name
= mem_alloc( len
+ sizeof(WCHAR
) )) != NULL
)
351 memcpy( name
, str
, len
);
352 name
[len
/ sizeof(WCHAR
)] = 0;
357 /* allocate a key object */
358 static struct key
*alloc_key( const WCHAR
*name
, time_t modif
)
361 if ((key
= (struct key
*)alloc_object( &key_ops
, -1 )))
365 key
->last_subkey
= -1;
369 key
->last_value
= -1;
371 key
->level
= current_level
;
374 if (!(key
->name
= strdupW( name
)))
376 release_object( key
);
383 /* update key modification time */
384 static void touch_key( struct key
*key
)
386 key
->modif
= time(NULL
);
387 key
->level
= max( key
->level
, current_level
);
390 /* try to grow the array of subkeys; return 1 if OK, 0 on error */
391 static int grow_subkeys( struct key
*key
)
393 struct key
**new_subkeys
;
398 nb_subkeys
= key
->nb_subkeys
+ (key
->nb_subkeys
/ 2); /* grow by 50% */
399 if (!(new_subkeys
= realloc( key
->subkeys
, nb_subkeys
* sizeof(*new_subkeys
) )))
401 set_error( STATUS_NO_MEMORY
);
407 nb_subkeys
= MIN_VALUES
;
408 if (!(new_subkeys
= mem_alloc( nb_subkeys
* sizeof(*new_subkeys
) ))) return 0;
410 key
->subkeys
= new_subkeys
;
411 key
->nb_subkeys
= nb_subkeys
;
415 /* allocate a subkey for a given key, and return its index */
416 static struct key
*alloc_subkey( struct key
*parent
, const WCHAR
*name
, int index
, time_t modif
)
421 if (parent
->last_subkey
+ 1 == parent
->nb_subkeys
)
423 /* need to grow the array */
424 if (!grow_subkeys( parent
)) return NULL
;
426 if ((key
= alloc_key( name
, modif
)) != NULL
)
428 key
->parent
= parent
;
429 for (i
= ++parent
->last_subkey
; i
> index
; i
--)
430 parent
->subkeys
[i
] = parent
->subkeys
[i
-1];
431 parent
->subkeys
[index
] = key
;
436 /* free a subkey of a given key */
437 static void free_subkey( struct key
*parent
, int index
)
442 assert( index
>= 0 );
443 assert( index
<= parent
->last_subkey
);
445 key
= parent
->subkeys
[index
];
446 for (i
= index
; i
< parent
->last_subkey
; i
++) parent
->subkeys
[i
] = parent
->subkeys
[i
+ 1];
447 parent
->last_subkey
--;
448 key
->flags
|= KEY_DELETED
;
450 release_object( key
);
452 /* try to shrink the array */
453 nb_subkeys
= key
->nb_subkeys
;
454 if (nb_subkeys
> MIN_SUBKEYS
&& key
->last_subkey
< nb_subkeys
/ 2)
456 struct key
**new_subkeys
;
457 nb_subkeys
-= nb_subkeys
/ 3; /* shrink by 33% */
458 if (nb_subkeys
< MIN_SUBKEYS
) nb_subkeys
= MIN_SUBKEYS
;
459 if (!(new_subkeys
= realloc( key
->subkeys
, nb_subkeys
* sizeof(*new_subkeys
) ))) return;
460 key
->subkeys
= new_subkeys
;
461 key
->nb_subkeys
= nb_subkeys
;
465 /* find the named child of a given key and return its index */
466 static struct key
*find_subkey( struct key
*key
, const WCHAR
*name
, int *index
)
468 int i
, min
, max
, res
;
471 max
= key
->last_subkey
;
475 if (!(res
= strcmpiW( key
->subkeys
[i
]->name
, name
)))
478 return key
->subkeys
[i
];
480 if (res
> 0) max
= i
- 1;
483 *index
= min
; /* this is where we should insert it */
488 /* warning: the key name must be writeable (use copy_path) */
489 static struct key
*open_key( struct key
*key
, WCHAR
*name
)
494 if (!(path
= get_path_token( name
))) return NULL
;
497 if (!(key
= find_subkey( key
, path
, &index
)))
499 set_error( STATUS_OBJECT_NAME_NOT_FOUND
);
502 path
= get_path_token( NULL
);
505 if (debug_level
> 1) dump_operation( key
, NULL
, "Open" );
506 if (key
) grab_object( key
);
510 /* create a subkey */
511 /* warning: the key name must be writeable (use copy_path) */
512 static struct key
*create_key( struct key
*key
, WCHAR
*name
, WCHAR
*class,
513 unsigned int options
, time_t modif
, int *created
)
516 int base_idx
, index
, flags
= 0;
519 if (key
->flags
& KEY_DELETED
) /* we cannot create a subkey under a deleted key */
521 set_error( STATUS_KEY_DELETED
);
524 if (options
& REG_OPTION_VOLATILE
) flags
|= KEY_VOLATILE
;
525 else if (key
->flags
& KEY_VOLATILE
)
527 set_error( STATUS_CHILD_MUST_BE_VOLATILE
);
530 if (!modif
) modif
= time(NULL
);
532 if (!(path
= get_path_token( name
))) return NULL
;
537 if (!(subkey
= find_subkey( key
, path
, &index
))) break;
539 path
= get_path_token( NULL
);
542 /* create the remaining part */
544 if (!*path
) goto done
;
548 key
= alloc_subkey( key
, path
, index
, modif
);
552 path
= get_path_token( NULL
);
553 if (!*path
) goto done
;
554 /* we know the index is always 0 in a new key */
555 key
= alloc_subkey( key
, path
, 0, modif
);
557 if (base_idx
!= -1) free_subkey( base
, base_idx
);
561 if (debug_level
> 1) dump_operation( key
, NULL
, "Create" );
562 if (class) key
->class = strdupW(class);
567 /* query information about a key or a subkey */
568 static void enum_key( struct key
*key
, int index
, int info_class
, struct enum_key_reply
*reply
)
571 size_t len
, namelen
, classlen
;
572 int max_subkey
= 0, max_class
= 0;
573 int max_value
= 0, max_data
= 0;
576 if (index
!= -1) /* -1 means use the specified key directly */
578 if ((index
< 0) || (index
> key
->last_subkey
))
580 set_error( STATUS_NO_MORE_ENTRIES
);
583 key
= key
->subkeys
[index
];
586 namelen
= strlenW(key
->name
) * sizeof(WCHAR
);
587 classlen
= key
->class ? strlenW(key
->class) * sizeof(WCHAR
) : 0;
591 case KeyBasicInformation
:
592 classlen
= 0; /* only return the name */
594 case KeyNodeInformation
:
595 reply
->max_subkey
= 0;
596 reply
->max_class
= 0;
597 reply
->max_value
= 0;
600 case KeyFullInformation
:
601 for (i
= 0; i
<= key
->last_subkey
; i
++)
603 struct key
*subkey
= key
->subkeys
[i
];
604 len
= strlenW( subkey
->name
);
605 if (len
> max_subkey
) max_subkey
= len
;
606 if (!subkey
->class) continue;
607 len
= strlenW( subkey
->class );
608 if (len
> max_class
) max_class
= len
;
610 for (i
= 0; i
<= key
->last_value
; i
++)
612 len
= strlenW( key
->values
[i
].name
);
613 if (len
> max_value
) max_value
= len
;
614 len
= key
->values
[i
].len
;
615 if (len
> max_data
) max_data
= len
;
617 reply
->max_subkey
= max_subkey
;
618 reply
->max_class
= max_class
;
619 reply
->max_value
= max_value
;
620 reply
->max_data
= max_data
;
621 namelen
= 0; /* only return the class */
624 set_error( STATUS_INVALID_PARAMETER
);
627 reply
->subkeys
= key
->last_subkey
+ 1;
628 reply
->values
= key
->last_value
+ 1;
629 reply
->modif
= key
->modif
;
630 reply
->total
= namelen
+ classlen
;
632 len
= min( reply
->total
, get_reply_max_size() );
633 if (len
&& (data
= set_reply_data_size( len
)))
637 reply
->namelen
= namelen
;
638 memcpy( data
, key
->name
, namelen
);
639 memcpy( (char *)data
+ namelen
, key
->class, len
- namelen
);
643 reply
->namelen
= len
;
644 memcpy( data
, key
->name
, len
);
647 if (debug_level
> 1) dump_operation( key
, NULL
, "Enum" );
650 /* delete a key and its values */
651 static void delete_key( struct key
*key
)
656 /* must find parent and index */
657 if (key
->flags
& KEY_ROOT
)
659 set_error( STATUS_ACCESS_DENIED
);
662 if (!(parent
= key
->parent
) || (key
->flags
& KEY_DELETED
))
664 set_error( STATUS_KEY_DELETED
);
667 for (index
= 0; index
<= parent
->last_subkey
; index
++)
668 if (parent
->subkeys
[index
] == key
) break;
669 assert( index
<= parent
->last_subkey
);
671 /* we can only delete a key that has no subkeys (FIXME) */
672 if ((key
->flags
& KEY_ROOT
) || (key
->last_subkey
>= 0))
674 set_error( STATUS_ACCESS_DENIED
);
677 if (debug_level
> 1) dump_operation( key
, NULL
, "Delete" );
678 free_subkey( parent
, index
);
682 /* try to grow the array of values; return 1 if OK, 0 on error */
683 static int grow_values( struct key
*key
)
685 struct key_value
*new_val
;
690 nb_values
= key
->nb_values
+ (key
->nb_values
/ 2); /* grow by 50% */
691 if (!(new_val
= realloc( key
->values
, nb_values
* sizeof(*new_val
) )))
693 set_error( STATUS_NO_MEMORY
);
699 nb_values
= MIN_VALUES
;
700 if (!(new_val
= mem_alloc( nb_values
* sizeof(*new_val
) ))) return 0;
702 key
->values
= new_val
;
703 key
->nb_values
= nb_values
;
707 /* find the named value of a given key and return its index in the array */
708 static struct key_value
*find_value( const struct key
*key
, const WCHAR
*name
, int *index
)
710 int i
, min
, max
, res
;
713 max
= key
->last_value
;
717 if (!(res
= strcmpiW( key
->values
[i
].name
, name
)))
720 return &key
->values
[i
];
722 if (res
> 0) max
= i
- 1;
725 *index
= min
; /* this is where we should insert it */
729 /* insert a new value or return a pointer to an existing one */
730 static struct key_value
*insert_value( struct key
*key
, const WCHAR
*name
)
732 struct key_value
*value
;
736 if (!(value
= find_value( key
, name
, &index
)))
738 /* not found, add it */
739 if (key
->last_value
+ 1 == key
->nb_values
)
741 if (!grow_values( key
)) return NULL
;
743 if (!(new_name
= strdupW(name
))) return NULL
;
744 for (i
= ++key
->last_value
; i
> index
; i
--) key
->values
[i
] = key
->values
[i
- 1];
745 value
= &key
->values
[index
];
746 value
->name
= new_name
;
753 /* set a key value */
754 static void set_value( struct key
*key
, WCHAR
*name
, int type
, const void *data
, size_t len
)
756 struct key_value
*value
;
759 /* first copy the data */
760 if (len
&& !(ptr
= memdup( data
, len
))) return;
762 if (!(value
= insert_value( key
, name
)))
764 if (ptr
) free( ptr
);
767 if (value
->data
) free( value
->data
); /* already existing, free previous data */
772 if (debug_level
> 1) dump_operation( key
, value
, "Set" );
775 /* get a key value */
776 static void get_value( struct key
*key
, const WCHAR
*name
, int *type
, int *len
)
778 struct key_value
*value
;
781 if ((value
= find_value( key
, name
, &index
)))
785 if (value
->data
) set_reply_data( value
->data
, min( value
->len
, get_reply_max_size() ));
786 if (debug_level
> 1) dump_operation( key
, value
, "Get" );
791 set_error( STATUS_OBJECT_NAME_NOT_FOUND
);
795 /* enumerate a key value */
796 static void enum_value( struct key
*key
, int i
, int info_class
, struct enum_key_value_reply
*reply
)
798 struct key_value
*value
;
800 if (i
< 0 || i
> key
->last_value
) set_error( STATUS_NO_MORE_ENTRIES
);
804 size_t namelen
, maxlen
;
806 value
= &key
->values
[i
];
807 reply
->type
= value
->type
;
808 namelen
= strlenW( value
->name
) * sizeof(WCHAR
);
812 case KeyValueBasicInformation
:
813 reply
->total
= namelen
;
815 case KeyValueFullInformation
:
816 reply
->total
= namelen
+ value
->len
;
818 case KeyValuePartialInformation
:
819 reply
->total
= value
->len
;
823 set_error( STATUS_INVALID_PARAMETER
);
827 maxlen
= min( reply
->total
, get_reply_max_size() );
828 if (maxlen
&& ((data
= set_reply_data_size( maxlen
))))
830 if (maxlen
> namelen
)
832 reply
->namelen
= namelen
;
833 memcpy( data
, value
->name
, namelen
);
834 memcpy( (char *)data
+ namelen
, value
->data
, maxlen
- namelen
);
838 reply
->namelen
= maxlen
;
839 memcpy( data
, value
->name
, maxlen
);
842 if (debug_level
> 1) dump_operation( key
, value
, "Enum" );
847 static void delete_value( struct key
*key
, const WCHAR
*name
)
849 struct key_value
*value
;
850 int i
, index
, nb_values
;
852 if (!(value
= find_value( key
, name
, &index
)))
854 set_error( STATUS_OBJECT_NAME_NOT_FOUND
);
857 if (debug_level
> 1) dump_operation( key
, value
, "Delete" );
859 if (value
->data
) free( value
->data
);
860 for (i
= index
; i
< key
->last_value
; i
++) key
->values
[i
] = key
->values
[i
+ 1];
864 /* try to shrink the array */
865 nb_values
= key
->nb_values
;
866 if (nb_values
> MIN_VALUES
&& key
->last_value
< nb_values
/ 2)
868 struct key_value
*new_val
;
869 nb_values
-= nb_values
/ 3; /* shrink by 33% */
870 if (nb_values
< MIN_VALUES
) nb_values
= MIN_VALUES
;
871 if (!(new_val
= realloc( key
->values
, nb_values
* sizeof(*new_val
) ))) return;
872 key
->values
= new_val
;
873 key
->nb_values
= nb_values
;
877 static struct key
*create_root_key( handle_t hkey
)
884 p
= special_root_names
[(unsigned int)hkey
- HKEY_SPECIAL_ROOT_FIRST
];
886 while (*p
) keyname
[i
++] = *p
++;
888 if (hkey
== (handle_t
)HKEY_CURRENT_USER
) /* this one is special */
890 /* get the current user name */
892 struct passwd
*pwd
= getpwuid( getuid() );
894 if (pwd
) p
= pwd
->pw_name
;
897 sprintf( buffer
, "%ld", (long) getuid() );
900 while (*p
&& i
< sizeof(keyname
)/sizeof(WCHAR
)-1) keyname
[i
++] = *p
++;
904 if ((key
= create_key( root_key
, keyname
, NULL
, 0, time(NULL
), &dummy
)))
906 special_root_keys
[(unsigned int)hkey
- HKEY_SPECIAL_ROOT_FIRST
] = key
;
907 key
->flags
|= KEY_ROOT
;
912 /* get the registry key corresponding to an hkey handle */
913 static struct key
*get_hkey_obj( handle_t hkey
, unsigned int access
)
917 if (!hkey
) return (struct key
*)grab_object( root_key
);
918 if (IS_SPECIAL_ROOT_HKEY(hkey
))
920 if (!(key
= special_root_keys
[(unsigned int)hkey
- HKEY_SPECIAL_ROOT_FIRST
]))
921 key
= create_root_key( hkey
);
926 key
= (struct key
*)get_handle_obj( current
->process
, hkey
, access
, &key_ops
);
930 /* read a line from the input file */
931 static int read_next_line( struct file_load_info
*info
)
939 if (!fgets( info
->buffer
+ pos
, info
->len
- pos
, info
->file
))
940 return (pos
!= 0); /* EOF */
941 pos
= strlen(info
->buffer
);
942 if (info
->buffer
[pos
-1] == '\n')
944 /* got a full line */
945 info
->buffer
[--pos
] = 0;
946 if (pos
> 0 && info
->buffer
[pos
-1] == '\r') info
->buffer
[pos
-1] = 0;
949 if (pos
< info
->len
- 1) return 1; /* EOF but something was read */
951 /* need to enlarge the buffer */
952 newlen
= info
->len
+ info
->len
/ 2;
953 if (!(newbuf
= realloc( info
->buffer
, newlen
)))
955 set_error( STATUS_NO_MEMORY
);
958 info
->buffer
= newbuf
;
963 /* make sure the temp buffer holds enough space */
964 static int get_file_tmp_space( struct file_load_info
*info
, int size
)
967 if (info
->tmplen
>= size
) return 1;
968 if (!(tmp
= realloc( info
->tmp
, size
)))
970 set_error( STATUS_NO_MEMORY
);
978 /* report an error while loading an input file */
979 static void file_read_error( const char *err
, struct file_load_info
*info
)
981 fprintf( stderr
, "Line %d: %s '%s'\n", info
->line
, err
, info
->buffer
);
984 /* parse an escaped string back into Unicode */
985 /* return the number of chars read from the input, or -1 on output overflow */
986 static int parse_strW( WCHAR
*dest
, int *len
, const char *src
, char endchar
)
988 int count
= sizeof(WCHAR
); /* for terminating null */
990 while (*p
&& *p
!= endchar
)
992 if (*p
!= '\\') *dest
= (WCHAR
)*p
++;
998 case 'a': *dest
= '\a'; p
++; break;
999 case 'b': *dest
= '\b'; p
++; break;
1000 case 'e': *dest
= '\e'; p
++; break;
1001 case 'f': *dest
= '\f'; p
++; break;
1002 case 'n': *dest
= '\n'; p
++; break;
1003 case 'r': *dest
= '\r'; p
++; break;
1004 case 't': *dest
= '\t'; p
++; break;
1005 case 'v': *dest
= '\v'; p
++; break;
1006 case 'x': /* hex escape */
1008 if (!isxdigit(*p
)) *dest
= 'x';
1011 *dest
= to_hex(*p
++);
1012 if (isxdigit(*p
)) *dest
= (*dest
* 16) + to_hex(*p
++);
1013 if (isxdigit(*p
)) *dest
= (*dest
* 16) + to_hex(*p
++);
1014 if (isxdigit(*p
)) *dest
= (*dest
* 16) + to_hex(*p
++);
1024 case '7': /* octal escape */
1026 if (*p
>= '0' && *p
<= '7') *dest
= (*dest
* 8) + (*p
++ - '0');
1027 if (*p
>= '0' && *p
<= '7') *dest
= (*dest
* 8) + (*p
++ - '0');
1030 *dest
= (WCHAR
)*p
++;
1034 if ((count
+= sizeof(WCHAR
)) > *len
) return -1; /* dest buffer overflow */
1038 if (!*p
) return -1; /* delimiter not found */
1043 /* convert a data type tag to a value type */
1044 static int get_data_type( const char *buffer
, int *type
, int *parse_type
)
1046 struct data_type
{ const char *tag
; int len
; int type
; int parse_type
; };
1048 static const struct data_type data_types
[] =
1049 { /* actual type */ /* type to assume for parsing */
1050 { "\"", 1, REG_SZ
, REG_SZ
},
1051 { "str:\"", 5, REG_SZ
, REG_SZ
},
1052 { "str(2):\"", 8, REG_EXPAND_SZ
, REG_SZ
},
1053 { "str(7):\"", 8, REG_MULTI_SZ
, REG_SZ
},
1054 { "hex:", 4, REG_BINARY
, REG_BINARY
},
1055 { "dword:", 6, REG_DWORD
, REG_DWORD
},
1056 { "hex(", 4, -1, REG_BINARY
},
1060 const struct data_type
*ptr
;
1063 for (ptr
= data_types
; ptr
->tag
; ptr
++)
1065 if (memcmp( ptr
->tag
, buffer
, ptr
->len
)) continue;
1066 *parse_type
= ptr
->parse_type
;
1067 if ((*type
= ptr
->type
) != -1) return ptr
->len
;
1068 /* "hex(xx):" is special */
1069 *type
= (int)strtoul( buffer
+ 4, &end
, 16 );
1070 if ((end
<= buffer
) || memcmp( end
, "):", 2 )) return 0;
1071 return end
+ 2 - buffer
;
1076 /* load and create a key from the input file */
1077 static struct key
*load_key( struct key
*base
, const char *buffer
, unsigned int options
,
1078 int prefix_len
, struct file_load_info
*info
)
1081 int res
, len
, modif
;
1083 len
= strlen(buffer
) * sizeof(WCHAR
);
1084 if (!get_file_tmp_space( info
, len
)) return NULL
;
1086 if ((res
= parse_strW( (WCHAR
*)info
->tmp
, &len
, buffer
, ']' )) == -1)
1088 file_read_error( "Malformed key", info
);
1091 if (sscanf( buffer
+ res
, " %d", &modif
) != 1) modif
= time(NULL
);
1093 p
= (WCHAR
*)info
->tmp
;
1094 while (prefix_len
&& *p
) { if (*p
++ == '\\') prefix_len
--; }
1100 file_read_error( "Malformed key", info
);
1103 /* empty key name, return base key */
1104 return (struct key
*)grab_object( base
);
1106 if (!(name
= copy_path( p
, len
- ((char *)p
- info
->tmp
), 0 )))
1108 file_read_error( "Key is too long", info
);
1111 return create_key( base
, name
, NULL
, options
, modif
, &res
);
1114 /* parse a comma-separated list of hex digits */
1115 static int parse_hex( unsigned char *dest
, int *len
, const char *buffer
)
1117 const char *p
= buffer
;
1119 while (isxdigit(*p
))
1123 memcpy( buf
, p
, 2 );
1125 sscanf( buf
, "%x", &val
);
1126 if (count
++ >= *len
) return -1; /* dest buffer overflow */
1127 *dest
++ = (unsigned char )val
;
1135 /* parse a value name and create the corresponding value */
1136 static struct key_value
*parse_value_name( struct key
*key
, const char *buffer
, int *len
,
1137 struct file_load_info
*info
)
1139 int maxlen
= strlen(buffer
) * sizeof(WCHAR
);
1140 if (!get_file_tmp_space( info
, maxlen
)) return NULL
;
1141 if (buffer
[0] == '@')
1143 info
->tmp
[0] = info
->tmp
[1] = 0;
1148 if ((*len
= parse_strW( (WCHAR
*)info
->tmp
, &maxlen
, buffer
+ 1, '\"' )) == -1) goto error
;
1149 (*len
)++; /* for initial quote */
1151 while (isspace(buffer
[*len
])) (*len
)++;
1152 if (buffer
[*len
] != '=') goto error
;
1154 while (isspace(buffer
[*len
])) (*len
)++;
1155 return insert_value( key
, (WCHAR
*)info
->tmp
);
1158 file_read_error( "Malformed value name", info
);
1162 /* load a value from the input file */
1163 static int load_value( struct key
*key
, const char *buffer
, struct file_load_info
*info
)
1167 int maxlen
, len
, res
;
1168 int type
, parse_type
;
1169 struct key_value
*value
;
1171 if (!(value
= parse_value_name( key
, buffer
, &len
, info
))) return 0;
1172 if (!(res
= get_data_type( buffer
+ len
, &type
, &parse_type
))) goto error
;
1173 buffer
+= len
+ res
;
1178 len
= strlen(buffer
) * sizeof(WCHAR
);
1179 if (!get_file_tmp_space( info
, len
)) return 0;
1180 if ((res
= parse_strW( (WCHAR
*)info
->tmp
, &len
, buffer
, '\"' )) == -1) goto error
;
1184 dw
= strtoul( buffer
, NULL
, 16 );
1188 case REG_BINARY
: /* hex digits */
1192 maxlen
= 1 + strlen(buffer
)/3; /* 3 chars for one hex byte */
1193 if (!get_file_tmp_space( info
, len
+ maxlen
)) return 0;
1194 if ((res
= parse_hex( info
->tmp
+ len
, &maxlen
, buffer
)) == -1) goto error
;
1197 while (isspace(*buffer
)) buffer
++;
1198 if (!*buffer
) break;
1199 if (*buffer
!= '\\') goto error
;
1200 if (read_next_line( info
) != 1) goto error
;
1201 buffer
= info
->buffer
;
1202 while (isspace(*buffer
)) buffer
++;
1208 ptr
= NULL
; /* keep compiler quiet */
1212 if (!len
) newptr
= NULL
;
1213 else if (!(newptr
= memdup( ptr
, len
))) return 0;
1215 if (value
->data
) free( value
->data
);
1216 value
->data
= newptr
;
1219 /* update the key level but not the modification time */
1220 key
->level
= max( key
->level
, current_level
);
1224 file_read_error( "Malformed value", info
);
1228 /* return the length (in path elements) of name that is part of the key name */
1229 /* for instance if key is USER\foo\bar and name is foo\bar\baz, return 2 */
1230 static int get_prefix_len( struct key
*key
, const char *name
, struct file_load_info
*info
)
1234 int len
= strlen(name
) * sizeof(WCHAR
);
1235 if (!get_file_tmp_space( info
, len
)) return 0;
1237 if ((res
= parse_strW( (WCHAR
*)info
->tmp
, &len
, name
, ']' )) == -1)
1239 file_read_error( "Malformed key", info
);
1242 for (p
= (WCHAR
*)info
->tmp
; *p
; p
++) if (*p
== '\\') break;
1244 for (res
= 1; key
!= root_key
; res
++)
1246 if (!strcmpiW( (WCHAR
*)info
->tmp
, key
->name
)) break;
1249 if (key
== root_key
) res
= 0; /* no matching name */
1253 /* load all the keys from the input file */
1254 static void load_keys( struct key
*key
, FILE *f
)
1256 struct key
*subkey
= NULL
;
1257 struct file_load_info info
;
1259 unsigned int options
= 0;
1260 int prefix_len
= -1; /* number of key name prefixes to skip */
1262 if (key
->flags
& KEY_VOLATILE
) options
|= REG_OPTION_VOLATILE
;
1268 if (!(info
.buffer
= mem_alloc( info
.len
))) return;
1269 if (!(info
.tmp
= mem_alloc( info
.tmplen
)))
1271 free( info
.buffer
);
1275 if ((read_next_line( &info
) != 1) ||
1276 strcmp( info
.buffer
, "WINE REGISTRY Version 2" ))
1278 set_error( STATUS_NOT_REGISTRY_FILE
);
1282 while (read_next_line( &info
) == 1)
1285 while (*p
&& isspace(*p
)) p
++;
1288 case '[': /* new key */
1289 if (subkey
) release_object( subkey
);
1290 if (prefix_len
== -1) prefix_len
= get_prefix_len( key
, p
+ 1, &info
);
1291 if (!(subkey
= load_key( key
, p
+ 1, options
, prefix_len
, &info
)))
1292 file_read_error( "Error creating key", &info
);
1294 case '@': /* default value */
1295 case '\"': /* value */
1296 if (subkey
) load_value( subkey
, p
, &info
);
1297 else file_read_error( "Value without key", &info
);
1299 case '#': /* comment */
1300 case ';': /* comment */
1301 case 0: /* empty line */
1304 file_read_error( "Unrecognized input", &info
);
1310 if (subkey
) release_object( subkey
);
1311 free( info
.buffer
);
1315 /* load a part of the registry from a file */
1316 static void load_registry( struct key
*key
, handle_t handle
)
1321 if (!(obj
= get_handle_obj( current
->process
, handle
, GENERIC_READ
, NULL
))) return;
1322 fd
= dup(obj
->ops
->get_fd( obj
));
1323 release_object( obj
);
1326 FILE *f
= fdopen( fd
, "r" );
1329 load_keys( key
, f
);
1332 else file_set_error();
1336 /* registry initialisation */
1337 void init_registry(void)
1339 static const WCHAR root_name
[] = { 0 };
1340 static const WCHAR config_name
[] =
1341 { 'M','a','c','h','i','n','e','\\','S','o','f','t','w','a','r','e','\\',
1342 'W','i','n','e','\\','W','i','n','e','\\','C','o','n','f','i','g',0 };
1348 /* create the root key */
1349 root_key
= alloc_key( root_name
, time(NULL
) );
1351 root_key
->flags
|= KEY_ROOT
;
1353 /* load the config file */
1354 config
= get_config_dir();
1355 if (!(filename
= malloc( strlen(config
) + 8 ))) fatal_error( "out of memory\n" );
1356 strcpy( filename
, config
);
1357 strcat( filename
, "/config" );
1358 if ((f
= fopen( filename
, "r" )))
1363 /* create the config key */
1364 if (!(key
= create_key( root_key
, copy_path( config_name
, sizeof(config_name
), 0 ),
1365 NULL
, 0, time(NULL
), &dummy
)))
1366 fatal_error( "could not create config key\n" );
1367 key
->flags
|= KEY_VOLATILE
;
1369 load_keys( key
, f
);
1371 if (get_error() == STATUS_NOT_REGISTRY_FILE
)
1372 fatal_error( "%s is not a valid registry file\n", filename
);
1374 fatal_error( "loading %s failed with error %x\n", filename
, get_error() );
1376 release_object( key
);
1381 /* update the level of the parents of a key (only needed for the old format) */
1382 static int update_level( struct key
*key
)
1385 int max
= key
->level
;
1386 for (i
= 0; i
<= key
->last_subkey
; i
++)
1388 int sub
= update_level( key
->subkeys
[i
] );
1389 if (sub
> max
) max
= sub
;
1395 /* save a registry branch to a file */
1396 static void save_all_subkeys( struct key
*key
, FILE *f
)
1398 fprintf( f
, "WINE REGISTRY Version 2\n" );
1399 fprintf( f
, ";; All keys relative to " );
1400 dump_path( key
, NULL
, f
);
1402 save_subkeys( key
, key
, f
);
1405 /* save a registry branch to a file handle */
1406 static void save_registry( struct key
*key
, handle_t handle
)
1411 if (key
->flags
& KEY_DELETED
)
1413 set_error( STATUS_KEY_DELETED
);
1416 if (!(obj
= get_handle_obj( current
->process
, handle
, GENERIC_WRITE
, NULL
))) return;
1417 fd
= dup(obj
->ops
->get_fd( obj
));
1418 release_object( obj
);
1421 FILE *f
= fdopen( fd
, "w" );
1424 save_all_subkeys( key
, f
);
1425 if (fclose( f
)) file_set_error();
1435 /* register a key branch for being saved on exit */
1436 static void register_branch_for_saving( struct key
*key
, const char *path
, size_t len
)
1438 if (save_branch_count
>= MAX_SAVE_BRANCH_INFO
)
1440 set_error( STATUS_NO_MORE_ENTRIES
);
1443 if (!len
|| !(save_branch_info
[save_branch_count
].path
= memdup( path
, len
))) return;
1444 save_branch_info
[save_branch_count
].path
[len
- 1] = 0;
1445 save_branch_info
[save_branch_count
].key
= (struct key
*)grab_object( key
);
1446 save_branch_count
++;
1449 /* save a registry branch to a file */
1450 static int save_branch( struct key
*key
, const char *path
)
1452 char *p
, *real
, *tmp
= NULL
;
1453 int fd
, count
= 0, ret
= 0;
1456 /* get the real path */
1458 if (!(real
= malloc( PATH_MAX
))) return 0;
1459 if (!realpath( path
, real
))
1466 /* test the file type */
1468 if ((fd
= open( path
, O_WRONLY
)) != -1)
1471 /* if file is not a regular file or has multiple links,
1472 write directly into it; otherwise use a temp file */
1473 if (!fstat( fd
, &st
) && (!S_ISREG(st
.st_mode
) || st
.st_nlink
> 1))
1481 /* create a temp file in the same directory */
1483 if (!(tmp
= malloc( strlen(path
) + 20 ))) goto done
;
1484 strcpy( tmp
, path
);
1485 if ((p
= strrchr( tmp
, '/' ))) p
++;
1489 sprintf( p
, "reg%lx%04x.tmp", (long) getpid(), count
++ );
1490 if ((fd
= open( tmp
, O_CREAT
| O_EXCL
| O_WRONLY
, 0666 )) != -1) break;
1491 if (errno
!= EEXIST
) goto done
;
1495 /* now save to it */
1498 if (!(f
= fdopen( fd
, "w" )))
1500 if (tmp
) unlink( tmp
);
1505 if (debug_level
> 1)
1507 fprintf( stderr
, "%s: ", path
);
1508 dump_operation( key
, NULL
, "saving" );
1511 save_all_subkeys( key
, f
);
1516 /* if successfully written, rename to final name */
1517 if (ret
) ret
= !rename( tmp
, path
);
1518 if (!ret
) unlink( tmp
);
1523 if (real
) free( real
);
1527 /* periodic saving of the registry */
1528 static void periodic_save( void *arg
)
1531 for (i
= 0; i
< save_branch_count
; i
++)
1532 save_branch( save_branch_info
[i
].key
, save_branch_info
[i
].path
);
1533 add_timeout( &next_save_time
, save_period
);
1534 save_timeout_user
= add_timeout_user( &next_save_time
, periodic_save
, 0 );
1537 /* save the registry and close the top-level keys; used on server exit */
1538 void close_registry(void)
1542 for (i
= 0; i
< save_branch_count
; i
++)
1544 if (!save_branch( save_branch_info
[i
].key
, save_branch_info
[i
].path
))
1546 fprintf( stderr
, "wineserver: could not save registry branch to %s",
1547 save_branch_info
[i
].path
);
1550 release_object( save_branch_info
[i
].key
);
1552 release_object( root_key
);
1556 /* create a registry key */
1557 DECL_HANDLER(create_key
)
1559 struct key
*key
= NULL
, *parent
;
1560 unsigned int access
= req
->access
;
1561 WCHAR
*name
, *class;
1563 if (access
& MAXIMUM_ALLOWED
) access
= KEY_ALL_ACCESS
; /* FIXME: needs general solution */
1565 if (!(name
= copy_req_path( req
->namelen
, !req
->parent
))) return;
1566 if ((parent
= get_hkey_obj( req
->parent
, 0 /*FIXME*/ )))
1568 if (req
->namelen
== get_req_data_size()) /* no class specified */
1570 key
= create_key( parent
, name
, NULL
, req
->options
, req
->modif
, &reply
->created
);
1574 const WCHAR
*class_ptr
= (WCHAR
*)((char *)get_req_data() + req
->namelen
);
1576 if ((class = req_strdupW( req
, class_ptr
, get_req_data_size() - req
->namelen
)))
1578 key
= create_key( parent
, name
, class, req
->options
,
1579 req
->modif
, &reply
->created
);
1585 reply
->hkey
= alloc_handle( current
->process
, key
, access
, 0 );
1586 release_object( key
);
1588 release_object( parent
);
1592 /* open a registry key */
1593 DECL_HANDLER(open_key
)
1595 struct key
*key
, *parent
;
1596 unsigned int access
= req
->access
;
1598 if (access
& MAXIMUM_ALLOWED
) access
= KEY_ALL_ACCESS
; /* FIXME: needs general solution */
1600 if ((parent
= get_hkey_obj( req
->parent
, 0 /*FIXME*/ )))
1602 WCHAR
*name
= copy_path( get_req_data(), get_req_data_size(), !req
->parent
);
1603 if (name
&& (key
= open_key( parent
, name
)))
1605 reply
->hkey
= alloc_handle( current
->process
, key
, access
, 0 );
1606 release_object( key
);
1608 release_object( parent
);
1612 /* delete a registry key */
1613 DECL_HANDLER(delete_key
)
1617 if ((key
= get_hkey_obj( req
->hkey
, 0 /*FIXME*/ )))
1620 release_object( key
);
1624 /* enumerate registry subkeys */
1625 DECL_HANDLER(enum_key
)
1629 if ((key
= get_hkey_obj( req
->hkey
,
1630 req
->index
== -1 ? KEY_QUERY_VALUE
: KEY_ENUMERATE_SUB_KEYS
)))
1632 enum_key( key
, req
->index
, req
->info_class
, reply
);
1633 release_object( key
);
1637 /* set a value of a registry key */
1638 DECL_HANDLER(set_key_value
)
1643 if (!(name
= copy_req_path( req
->namelen
, 0 ))) return;
1644 if ((key
= get_hkey_obj( req
->hkey
, KEY_SET_VALUE
)))
1646 size_t datalen
= get_req_data_size() - req
->namelen
;
1647 const char *data
= (char *)get_req_data() + req
->namelen
;
1649 set_value( key
, name
, req
->type
, data
, datalen
);
1650 release_object( key
);
1654 /* retrieve the value of a registry key */
1655 DECL_HANDLER(get_key_value
)
1661 if (!(name
= copy_path( get_req_data(), get_req_data_size(), 0 ))) return;
1662 if ((key
= get_hkey_obj( req
->hkey
, KEY_QUERY_VALUE
)))
1664 get_value( key
, name
, &reply
->type
, &reply
->total
);
1665 release_object( key
);
1669 /* enumerate the value of a registry key */
1670 DECL_HANDLER(enum_key_value
)
1674 if ((key
= get_hkey_obj( req
->hkey
, KEY_QUERY_VALUE
)))
1676 enum_value( key
, req
->index
, req
->info_class
, reply
);
1677 release_object( key
);
1681 /* delete a value of a registry key */
1682 DECL_HANDLER(delete_key_value
)
1687 if ((key
= get_hkey_obj( req
->hkey
, KEY_SET_VALUE
)))
1689 if ((name
= req_strdupW( req
, get_req_data(), get_req_data_size() )))
1691 delete_value( key
, name
);
1694 release_object( key
);
1698 /* load a registry branch from a file */
1699 DECL_HANDLER(load_registry
)
1703 if ((key
= get_hkey_obj( req
->hkey
, KEY_SET_VALUE
| KEY_CREATE_SUB_KEY
)))
1705 /* FIXME: use subkey name */
1706 load_registry( key
, req
->file
);
1707 release_object( key
);
1711 /* save a registry branch to a file */
1712 DECL_HANDLER(save_registry
)
1716 if ((key
= get_hkey_obj( req
->hkey
, KEY_QUERY_VALUE
| KEY_ENUMERATE_SUB_KEYS
)))
1718 save_registry( key
, req
->file
);
1719 release_object( key
);
1723 /* set the current and saving level for the registry */
1724 DECL_HANDLER(set_registry_levels
)
1726 current_level
= req
->current
;
1727 saving_level
= req
->saving
;
1729 /* set periodic save timer */
1731 if (save_timeout_user
)
1733 remove_timeout_user( save_timeout_user
);
1734 save_timeout_user
= NULL
;
1736 if ((save_period
= req
->period
))
1738 if (save_period
< 10000) save_period
= 10000; /* limit rate */
1739 gettimeofday( &next_save_time
, 0 );
1740 add_timeout( &next_save_time
, save_period
);
1741 save_timeout_user
= add_timeout_user( &next_save_time
, periodic_save
, 0 );
1745 /* save a registry branch at server exit */
1746 DECL_HANDLER(save_registry_atexit
)
1750 if ((key
= get_hkey_obj( req
->hkey
, KEY_QUERY_VALUE
| KEY_ENUMERATE_SUB_KEYS
)))
1752 register_branch_for_saving( key
, get_req_data(), get_req_data_size() );
1753 release_object( key
);