2 * Registry processing routines. Routines, common for registry
3 * processing frontends.
5 * Copyright 1999 Sylvain St-Germain
6 * Copyright 2002 Andriy Palamarchuk
7 * Copyright 2008 Alexander N. Sørnes <alex@thehandofagony.com>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
30 #include <wine/unicode.h>
33 #define REG_VAL_BUF_SIZE 4096
35 /* maximal number of characters in hexadecimal data line,
36 * including the indentation, but not including the '\' character
38 #define REG_FILE_HEX_LINE_LEN (2 + 25 * 3)
40 static const CHAR *reg_class_names[] = {
41 "HKEY_LOCAL_MACHINE", "HKEY_USERS", "HKEY_CLASSES_ROOT",
42 "HKEY_CURRENT_CONFIG", "HKEY_CURRENT_USER", "HKEY_DYN_DATA"
45 #define REG_CLASS_NUMBER (sizeof(reg_class_names) / sizeof(reg_class_names[0]))
47 extern const WCHAR* reg_class_namesW[];
49 static HKEY reg_class_keys[REG_CLASS_NUMBER] = {
50 HKEY_LOCAL_MACHINE, HKEY_USERS, HKEY_CLASSES_ROOT,
51 HKEY_CURRENT_CONFIG, HKEY_CURRENT_USER, HKEY_DYN_DATA
55 #define NOT_ENOUGH_MEMORY 1
58 /* processing macros */
60 /* common check of memory allocation results */
61 #define CHECK_ENOUGH_MEMORY(p) \
64 fprintf(stderr,"%s: file %s, line %d: Not enough memory\n", \
65 getAppName(), __FILE__, __LINE__); \
66 exit(NOT_ENOUGH_MEMORY); \
69 /******************************************************************************
70 * Allocates memory and converts input from multibyte to wide chars
71 * Returned string must be freed by the caller
73 WCHAR* GetWideString(const char* strA)
78 int len = MultiByteToWideChar(CP_ACP, 0, strA, -1, NULL, 0);
80 strW = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
81 CHECK_ENOUGH_MEMORY(strW);
82 MultiByteToWideChar(CP_ACP, 0, strA, -1, strW, len);
88 /******************************************************************************
89 * Allocates memory and converts input from multibyte to wide chars
90 * Returned string must be freed by the caller
92 static WCHAR* GetWideStringN(const char* strA, int chars, DWORD *len)
97 *len = MultiByteToWideChar(CP_ACP, 0, strA, chars, NULL, 0);
99 strW = HeapAlloc(GetProcessHeap(), 0, *len * sizeof(WCHAR));
100 CHECK_ENOUGH_MEMORY(strW);
101 MultiByteToWideChar(CP_ACP, 0, strA, chars, strW, *len);
108 /******************************************************************************
109 * Allocates memory and converts input from wide chars to multibyte
110 * Returned string must be freed by the caller
112 char* GetMultiByteString(const WCHAR* strW)
117 int len = WideCharToMultiByte(CP_ACP, 0, strW, -1, NULL, 0, NULL, NULL);
119 strA = HeapAlloc(GetProcessHeap(), 0, len);
120 CHECK_ENOUGH_MEMORY(strA);
121 WideCharToMultiByte(CP_ACP, 0, strW, -1, strA, len, NULL, NULL);
127 /******************************************************************************
128 * Allocates memory and converts input from wide chars to multibyte
129 * Returned string must be freed by the caller
131 static char* GetMultiByteStringN(const WCHAR* strW, int chars, DWORD* len)
136 *len = WideCharToMultiByte(CP_ACP, 0, strW, chars, NULL, 0, NULL, NULL);
138 strA = HeapAlloc(GetProcessHeap(), 0, *len);
139 CHECK_ENOUGH_MEMORY(strA);
140 WideCharToMultiByte(CP_ACP, 0, strW, chars, strA, *len, NULL, NULL);
147 /******************************************************************************
148 * Converts a hex representation of a DWORD into a DWORD.
150 static BOOL convertHexToDWord(WCHAR* str, DWORD *dw)
155 WideCharToMultiByte(CP_ACP, 0, str, -1, buf, 9, NULL, NULL);
156 if (lstrlenW(str) > 8 || sscanf(buf, "%x%c", dw, &dummy) != 1) {
157 fprintf(stderr,"%s: ERROR, invalid hex value\n", getAppName());
163 /******************************************************************************
164 * Converts a hex comma separated values list into a binary string.
166 static BYTE* convertHexCSVToHex(WCHAR *str, DWORD *size)
171 /* The worst case is 1 digit + 1 comma per byte */
172 *size=(lstrlenW(str)+1)/2;
173 data=HeapAlloc(GetProcessHeap(), 0, *size);
174 CHECK_ENOUGH_MEMORY(data);
183 wc = strtoulW(s,&end,16);
184 if (end == s || wc > 0xff || (*end && *end != ',')) {
185 char* strA = GetMultiByteString(s);
186 fprintf(stderr,"%s: ERROR converting CSV hex stream. Invalid value at '%s'\n",
188 HeapFree(GetProcessHeap(), 0, data);
189 HeapFree(GetProcessHeap(), 0, strA);
201 /******************************************************************************
202 * This function returns the HKEY associated with the data type encoded in the
203 * value. It modifies the input parameter (key value) in order to skip this
204 * "now useless" data type information.
206 * Note: Updated based on the algorithm used in 'server/registry.c'
208 static DWORD getDataType(LPWSTR *lpValue, DWORD* parse_type)
210 struct data_type { const WCHAR *tag; int len; int type; int parse_type; };
212 static const WCHAR quote[] = {'"'};
213 static const WCHAR str[] = {'s','t','r',':','"'};
214 static const WCHAR str2[] = {'s','t','r','(','2',')',':','"'};
215 static const WCHAR hex[] = {'h','e','x',':'};
216 static const WCHAR dword[] = {'d','w','o','r','d',':'};
217 static const WCHAR hexp[] = {'h','e','x','('};
219 static const struct data_type data_types[] = { /* actual type */ /* type to assume for parsing */
220 { quote, 1, REG_SZ, REG_SZ },
221 { str, 5, REG_SZ, REG_SZ },
222 { str2, 8, REG_EXPAND_SZ, REG_SZ },
223 { hex, 4, REG_BINARY, REG_BINARY },
224 { dword, 6, REG_DWORD, REG_DWORD },
225 { hexp, 4, -1, REG_BINARY },
229 const struct data_type *ptr;
232 for (ptr = data_types; ptr->tag; ptr++) {
233 if (strncmpW( ptr->tag, *lpValue, ptr->len ))
237 *parse_type = ptr->parse_type;
243 /* "hex(xx):" is special */
244 type = (int)strtoulW( *lpValue , &end, 16 );
245 if (**lpValue=='\0' || *end!=')' || *(end+1)!=':') {
253 *parse_type=REG_NONE;
257 /******************************************************************************
258 * Replaces escape sequences with the characters.
260 static void REGPROC_unescape_string(WCHAR* str)
262 int str_idx = 0; /* current character under analysis */
263 int val_idx = 0; /* the last character of the unescaped string */
264 int len = lstrlenW(str);
265 for (str_idx = 0; str_idx < len; str_idx++, val_idx++) {
266 if (str[str_idx] == '\\') {
268 switch (str[str_idx]) {
274 str[val_idx] = str[str_idx];
277 fprintf(stderr,"Warning! Unrecognized escape sequence: \\%c'\n",
279 str[val_idx] = str[str_idx];
283 str[val_idx] = str[str_idx];
289 static BOOL parseKeyName(LPWSTR lpKeyName, HKEY *hKey, LPWSTR *lpKeyPath)
291 WCHAR* lpSlash = NULL;
294 if (lpKeyName == NULL)
297 for(i = 0; *(lpKeyName+i) != 0; i++)
299 if(*(lpKeyName+i) == '\\')
301 lpSlash = lpKeyName+i;
308 len = lpSlash-lpKeyName;
312 len = lstrlenW(lpKeyName);
313 lpSlash = lpKeyName+len;
317 for (i = 0; i < REG_CLASS_NUMBER; i++) {
318 if (CompareStringW(LOCALE_USER_DEFAULT, 0, lpKeyName, len, reg_class_namesW[i], len) == CSTR_EQUAL &&
319 len == lstrlenW(reg_class_namesW[i])) {
320 *hKey = reg_class_keys[i];
329 if (*lpSlash != '\0')
331 *lpKeyPath = lpSlash;
335 /* Globals used by the setValue() & co */
336 static LPSTR currentKeyName;
337 static HKEY currentKeyHandle = NULL;
339 /******************************************************************************
340 * Sets the value with name val_name to the data in val_data for the currently
344 * val_name - name of the registry value
345 * val_data - registry value data
347 static LONG setValue(WCHAR* val_name, WCHAR* val_data, BOOL is_unicode)
350 DWORD dwDataType, dwParseType;
353 WCHAR del[] = {'-',0};
355 if ( (val_name == NULL) || (val_data == NULL) )
356 return ERROR_INVALID_PARAMETER;
358 if (lstrcmpW(val_data, del) == 0)
360 res=RegDeleteValueW(currentKeyHandle,val_name);
361 return (res == ERROR_FILE_NOT_FOUND ? ERROR_SUCCESS : res);
364 /* Get the data type stored into the value field */
365 dwDataType = getDataType(&val_data, &dwParseType);
367 if (dwParseType == REG_SZ) /* no conversion for string */
369 REGPROC_unescape_string(val_data);
370 /* Compute dwLen after REGPROC_unescape_string because it may
371 * have changed the string length and we don't want to store
372 * the extra garbage in the registry.
374 dwLen = lstrlenW(val_data);
375 if(val_data[dwLen-1] != '"')
376 return ERROR_INVALID_DATA;
377 if (dwLen>0 && val_data[dwLen-1]=='"')
380 val_data[dwLen]='\0';
382 lpbData = (BYTE*) val_data;
383 dwLen++; /* include terminating null */
384 dwLen = dwLen * sizeof(WCHAR); /* size is in bytes */
386 else if (dwParseType == REG_DWORD) /* Convert the dword types */
388 if (!convertHexToDWord(val_data, &dwData))
389 return ERROR_INVALID_DATA;
390 lpbData = (BYTE*)&dwData;
391 dwLen = sizeof(dwData);
393 else if (dwParseType == REG_BINARY) /* Convert the binary data */
395 lpbData = convertHexCSVToHex(val_data, &dwLen);
397 return ERROR_INVALID_DATA;
399 if((dwDataType == REG_MULTI_SZ || dwDataType == REG_EXPAND_SZ) && !is_unicode)
401 LPBYTE tmp = lpbData;
402 lpbData = (LPBYTE)GetWideStringN((char*)lpbData, dwLen, &dwLen);
403 dwLen *= sizeof(WCHAR);
404 HeapFree(GetProcessHeap(), 0, tmp);
407 else /* unknown format */
409 fprintf(stderr,"%s: ERROR, unknown data format\n", getAppName());
410 return ERROR_INVALID_DATA;
413 res = RegSetValueExW(
420 if (dwParseType == REG_BINARY)
421 HeapFree(GetProcessHeap(), 0, lpbData);
425 /******************************************************************************
426 * A helper function for processRegEntry() that opens the current key.
427 * That key must be closed by calling closeKey().
429 static LONG openKeyW(WCHAR* stdInput)
437 if (stdInput == NULL)
438 return ERROR_INVALID_PARAMETER;
440 /* Get the registry class */
441 if (!parseKeyName(stdInput, &keyClass, &keyPath))
442 return ERROR_INVALID_PARAMETER;
444 res = RegCreateKeyExW(
445 keyClass, /* Class */
446 keyPath, /* Sub Key */
448 NULL, /* object type */
449 REG_OPTION_NON_VOLATILE, /* option, REG_OPTION_NON_VOLATILE ... */
450 KEY_ALL_ACCESS, /* access mask, KEY_ALL_ACCESS */
451 NULL, /* security attribute */
452 ¤tKeyHandle, /* result */
453 &dwDisp); /* disposition, REG_CREATED_NEW_KEY or
454 REG_OPENED_EXISTING_KEY */
456 if (res == ERROR_SUCCESS)
457 currentKeyName = GetMultiByteString(stdInput);
459 currentKeyHandle = NULL;
465 /******************************************************************************
466 * Close the currently opened key.
468 static void closeKey(void)
470 if (currentKeyHandle)
472 HeapFree(GetProcessHeap(), 0, currentKeyName);
473 RegCloseKey(currentKeyHandle);
474 currentKeyHandle = NULL;
478 /******************************************************************************
479 * This function is a wrapper for the setValue function. It prepares the
480 * land and cleans the area once completed.
481 * Note: this function modifies the line parameter.
483 * line - registry file unwrapped line. Should have the registry value name and
484 * complete registry value data.
486 static void processSetValue(WCHAR* line, BOOL is_unicode)
488 WCHAR* val_name; /* registry value name */
489 WCHAR* val_data; /* registry value data */
490 int line_idx = 0; /* current character under analysis */
494 while ( isspaceW(line[line_idx]) ) line_idx++;
495 if (line[line_idx] == '@' && line[line_idx + 1] == '=') {
496 line[line_idx] = '\0';
499 } else if (line[line_idx] == '\"') {
501 val_name = line + line_idx;
502 while (line[line_idx]) {
503 if (line[line_idx] == '\\') /* skip escaped character */
507 if (line[line_idx] == '\"') {
508 line[line_idx] = '\0';
516 while ( isspaceW(line[line_idx]) ) line_idx++;
517 if (!line[line_idx]) {
518 fprintf(stderr, "%s: warning: unexpected EOL\n", getAppName());
521 if (line[line_idx] != '=') {
523 line[line_idx] = '\"';
524 lineA = GetMultiByteString(line);
525 fprintf(stderr,"%s: warning: unrecognized line: '%s'\n", getAppName(), lineA);
526 HeapFree(GetProcessHeap(), 0, lineA);
531 char* lineA = GetMultiByteString(line);
532 fprintf(stderr,"%s: warning: unrecognized line: '%s'\n", getAppName(), lineA);
533 HeapFree(GetProcessHeap(), 0, lineA);
536 line_idx++; /* skip the '=' character */
538 while ( isspaceW(line[line_idx]) ) line_idx++;
539 val_data = line + line_idx;
540 /* trim trailing blanks */
541 line_idx = strlenW(val_data);
542 while (line_idx > 0 && isspaceW(val_data[line_idx-1])) line_idx--;
543 val_data[line_idx] = '\0';
545 REGPROC_unescape_string(val_name);
546 res = setValue(val_name, val_data, is_unicode);
547 if ( res != ERROR_SUCCESS )
549 char* val_nameA = GetMultiByteString(val_name);
550 char* val_dataA = GetMultiByteString(val_data);
551 fprintf(stderr,"%s: ERROR Key %s not created. Value: %s, Data: %s\n",
556 HeapFree(GetProcessHeap(), 0, val_nameA);
557 HeapFree(GetProcessHeap(), 0, val_dataA);
561 /******************************************************************************
562 * This function receives the currently read entry and performs the
563 * corresponding action.
564 * isUnicode affects parsing of REG_MULTI_SZ values
566 static void processRegEntry(WCHAR* stdInput, BOOL isUnicode)
569 * We encountered the end of the file, make sure we
570 * close the opened key and exit
572 if (stdInput == NULL) {
577 if ( stdInput[0] == '[') /* We are reading a new key */
580 closeKey(); /* Close the previous key */
582 /* Get rid of the square brackets */
584 keyEnd = strrchrW(stdInput, ']');
588 /* delete the key if we encounter '-' at the start of reg key */
589 if ( stdInput[0] == '-')
591 delete_registry_key(stdInput + 1);
592 } else if ( openKeyW(stdInput) != ERROR_SUCCESS )
594 char* stdInputA = GetMultiByteString(stdInput);
595 fprintf(stderr,"%s: setValue failed to open key %s\n",
596 getAppName(), stdInputA);
597 HeapFree(GetProcessHeap(), 0, stdInputA);
599 } else if( currentKeyHandle &&
600 (( stdInput[0] == '@') || /* reading a default @=data pair */
601 ( stdInput[0] == '\"'))) /* reading a new value=data pair */
603 processSetValue(stdInput, isUnicode);
606 /* Since we are assuming that the file format is valid we must be
607 * reading a blank line which indicates the end of this key processing
613 /******************************************************************************
614 * Processes a registry file.
615 * Correctly processes comments (in # form), line continuation.
618 * in - input stream to read from
619 * first_chars - beginning of stream, read due to Unicode check
621 static void processRegLinesA(FILE *in, char* first_chars)
623 LPSTR line = NULL; /* line read from input stream */
624 ULONG lineSize = REG_VAL_BUF_SIZE;
626 line = HeapAlloc(GetProcessHeap(), 0, lineSize);
627 CHECK_ENOUGH_MEMORY(line);
628 memcpy(line, first_chars, 2);
631 LPSTR s; /* The pointer into line for where the current fgets should read */
642 size_t size_remaining;
644 char *s_eol; /* various local uses */
646 /* Do we need to expand the buffer ? */
647 assert (s >= line && s <= line + lineSize);
648 size_remaining = lineSize - (s-line);
649 if (size_remaining < 2) /* room for 1 character and the \0 */
652 size_t new_size = lineSize + REG_VAL_BUF_SIZE;
653 if (new_size > lineSize) /* no arithmetic overflow */
654 new_buffer = HeapReAlloc (GetProcessHeap(), 0, line, new_size);
657 CHECK_ENOUGH_MEMORY(new_buffer);
659 s = line + lineSize - size_remaining;
661 size_remaining = lineSize - (s-line);
664 /* Get as much as possible into the buffer, terminated either by
665 * eof, error, eol or getting the maximum amount. Abort on error.
667 size_to_get = (size_remaining > INT_MAX ? INT_MAX : size_remaining);
669 /* get a single line. note that `i' must be one past the last
670 * meaningful character in `s' when this loop exits */
671 for(i = 0; i < size_to_get-1; ++i){
675 perror("While reading input");
682 /* read the next character iff it's \n */
683 if(i+2 >= size_to_get){
684 /* buffer too short, so put back the EOL char to
704 /* If we didn't read the eol nor the eof go around for the rest */
705 s_eol = strpbrk (s, "\r\n");
706 if (!feof (in) && !s_eol) {
707 s = strchr (s, '\0');
711 /* If it is a comment line then discard it and go around again */
712 if (line [0] == '#') {
717 /* Remove any line feed. Leave s_eol on the first \0 */
719 if (*s_eol == '\r' && *(s_eol+1) == '\n')
723 s_eol = strchr (s, '\0');
725 /* If there is a concatenating \\ then go around again */
726 if (s_eol > line && *(s_eol-1) == '\\') {
733 } while(c == ' ' || c == '\t');
737 fprintf(stderr,"%s: ERROR - invalid continuation.\n",
748 lineW = GetWideString(line);
750 break; /* That is the full virtual line */
753 processRegEntry(lineW, FALSE);
754 HeapFree(GetProcessHeap(), 0, lineW);
756 processRegEntry(NULL, FALSE);
758 HeapFree(GetProcessHeap(), 0, line);
761 static void processRegLinesW(FILE *in)
763 WCHAR* buf = NULL; /* line read from input stream */
764 ULONG lineSize = REG_VAL_BUF_SIZE;
765 size_t CharsInBuf = -1;
767 WCHAR* s; /* The pointer into buf for where the current fgets should read */
768 WCHAR* line; /* The start of the current line */
770 buf = HeapAlloc(GetProcessHeap(), 0, lineSize * sizeof(WCHAR));
771 CHECK_ENOUGH_MEMORY(buf);
777 size_t size_remaining;
779 WCHAR *s_eol = NULL; /* various local uses */
781 /* Do we need to expand the buffer ? */
782 assert (s >= buf && s <= buf + lineSize);
783 size_remaining = lineSize - (s-buf);
784 if (size_remaining < 2) /* room for 1 character and the \0 */
787 size_t new_size = lineSize + (REG_VAL_BUF_SIZE / sizeof(WCHAR));
788 if (new_size > lineSize) /* no arithmetic overflow */
789 new_buffer = HeapReAlloc (GetProcessHeap(), 0, buf, new_size * sizeof(WCHAR));
792 CHECK_ENOUGH_MEMORY(new_buffer);
795 s = buf + lineSize - size_remaining;
797 size_remaining = lineSize - (s-buf);
800 /* Get as much as possible into the buffer, terminated either by
801 * eof, error or getting the maximum amount. Abort on error.
803 size_to_get = (size_remaining > INT_MAX ? INT_MAX : size_remaining);
805 CharsInBuf = fread(s, sizeof(WCHAR), size_to_get - 1, in);
808 if (CharsInBuf == 0) {
810 perror ("While reading input");
815 /* It is not clear to me from the definition that the
816 * contents of the buffer are well defined on detecting
817 * an eof without managing to read anything.
822 /* If we didn't read the eol nor the eof go around for the rest */
825 const WCHAR line_endings[] = {'\r','\n',0};
826 s_eol = strpbrkW(line, line_endings);
829 /* Move the stub of the line to the start of the buffer so
830 * we get the maximum space to read into, and so we don't
831 * have to recalculate 'line' if the buffer expands */
832 MoveMemory(buf, line, (strlenW(line)+1) * sizeof(WCHAR));
834 s = strchrW(line, '\0');
838 /* If it is a comment line then discard it and go around again */
840 if (*s_eol == '\r' && *(s_eol+1) == '\n')
847 /* If there is a concatenating \\ then go around again */
848 if (*(s_eol-1) == '\\') {
849 WCHAR* NextLine = s_eol + 1;
851 if(*s_eol == '\r' && *(s_eol+1) == '\n')
854 while(*(NextLine+1) == ' ' || *(NextLine+1) == '\t')
857 MoveMemory(s_eol - 1, NextLine, (CharsInBuf - (NextLine - s) + 1)*sizeof(WCHAR));
858 CharsInBuf -= NextLine - s_eol + 1;
863 /* Remove any line feed. Leave s_eol on the last \0 */
864 if (*s_eol == '\r' && *(s_eol + 1) == '\n')
868 processRegEntry(line, TRUE);
871 continue; /* That is the full virtual line */
875 processRegEntry(NULL, TRUE);
877 HeapFree(GetProcessHeap(), 0, buf);
880 /****************************************************************************
881 * REGPROC_print_error
883 * Print the message for GetLastError
886 static void REGPROC_print_error(void)
892 error_code = GetLastError ();
893 status = FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
894 NULL, error_code, 0, (LPTSTR) &lpMsgBuf, 0, NULL);
896 fprintf(stderr,"%s: Cannot display message for error %d, status %d\n",
897 getAppName(), error_code, GetLastError());
905 /******************************************************************************
906 * Checks whether the buffer has enough room for the string or required size.
907 * Resizes the buffer if necessary.
910 * buffer - pointer to a buffer for string
911 * len - current length of the buffer in characters.
912 * required_len - length of the string to place to the buffer in characters.
913 * The length does not include the terminating null character.
915 static void REGPROC_resize_char_buffer(WCHAR **buffer, DWORD *len, DWORD required_len)
918 if (required_len > *len) {
921 *buffer = HeapAlloc(GetProcessHeap(), 0, *len * sizeof(**buffer));
923 *buffer = HeapReAlloc(GetProcessHeap(), 0, *buffer, *len * sizeof(**buffer));
924 CHECK_ENOUGH_MEMORY(*buffer);
928 /******************************************************************************
929 * Same as REGPROC_resize_char_buffer() but on a regular buffer.
932 * buffer - pointer to a buffer
933 * len - current size of the buffer in bytes
934 * required_size - size of the data to place in the buffer in bytes
936 static void REGPROC_resize_binary_buffer(BYTE **buffer, DWORD *size, DWORD required_size)
938 if (required_size > *size) {
939 *size = required_size;
941 *buffer = HeapAlloc(GetProcessHeap(), 0, *size);
943 *buffer = HeapReAlloc(GetProcessHeap(), 0, *buffer, *size);
944 CHECK_ENOUGH_MEMORY(*buffer);
948 /******************************************************************************
949 * Prints string str to file
951 static void REGPROC_export_string(WCHAR **line_buf, DWORD *line_buf_size, DWORD *line_len, WCHAR *str, DWORD str_len)
956 REGPROC_resize_char_buffer(line_buf, line_buf_size, *line_len + str_len + 10);
958 /* escaping characters */
960 for (i = 0; i < str_len; i++) {
965 REGPROC_resize_char_buffer(line_buf, line_buf_size, *line_len + str_len + extra);
966 (*line_buf)[pos++] = '\\';
967 (*line_buf)[pos++] = 'n';
973 REGPROC_resize_char_buffer(line_buf, line_buf_size, *line_len + str_len + extra);
974 (*line_buf)[pos++] = '\\';
978 (*line_buf)[pos++] = c;
982 (*line_buf)[pos] = '\0';
986 static void REGPROC_export_binary(WCHAR **line_buf, DWORD *line_buf_size, DWORD *line_len, DWORD type, BYTE *value, DWORD value_size, BOOL unicode)
988 DWORD hex_pos, data_pos;
989 const WCHAR *hex_prefix;
990 const WCHAR hex[] = {'h','e','x',':',0};
992 const WCHAR concat[] = {'\\','\n',' ',' ',0};
993 DWORD concat_prefix, concat_len;
994 const WCHAR newline[] = {'\n',0};
995 CHAR* value_multibyte = NULL;
997 if (type == REG_BINARY) {
1000 const WCHAR hex_format[] = {'h','e','x','(','%','u',')',':',0};
1001 hex_prefix = hex_buf;
1002 sprintfW(hex_buf, hex_format, type);
1003 if ((type == REG_SZ || type == REG_EXPAND_SZ || type == REG_MULTI_SZ) && !unicode)
1005 value_multibyte = GetMultiByteStringN((WCHAR*)value, value_size / sizeof(WCHAR), &value_size);
1006 value = (BYTE*)value_multibyte;
1010 concat_len = lstrlenW(concat);
1013 hex_pos = *line_len;
1014 *line_len += lstrlenW(hex_prefix);
1015 data_pos = *line_len;
1016 *line_len += value_size * 3;
1017 /* - The 2 spaces that concat places at the start of the
1018 * line effectively reduce the space available for data.
1019 * - If the value name and hex prefix are very long
1020 * ( > REG_FILE_HEX_LINE_LEN) then we may overestimate
1021 * the needed number of lines by one. But that's ok.
1022 * - The trailing linefeed takes the place of a comma so
1023 * it's accounted for already.
1025 *line_len += *line_len / (REG_FILE_HEX_LINE_LEN - concat_prefix) * concat_len;
1026 REGPROC_resize_char_buffer(line_buf, line_buf_size, *line_len);
1027 lstrcpyW(*line_buf + hex_pos, hex_prefix);
1030 const WCHAR format[] = {'%','0','2','x',0};
1033 column = data_pos; /* no line wrap yet */
1037 sprintfW(*line_buf + data_pos, format, (unsigned int)value[i]);
1039 if (++i == value_size)
1042 (*line_buf)[data_pos++] = ',';
1046 if (column >= REG_FILE_HEX_LINE_LEN) {
1047 lstrcpyW(*line_buf + data_pos, concat);
1048 data_pos += concat_len;
1049 column = concat_prefix;
1053 lstrcpyW(*line_buf + data_pos, newline);
1054 HeapFree(GetProcessHeap(), 0, value_multibyte);
1057 /******************************************************************************
1058 * Writes the given line to a file, in multi-byte or wide characters
1060 static void REGPROC_write_line(FILE *file, const WCHAR* str, BOOL unicode)
1064 fwrite(str, sizeof(WCHAR), lstrlenW(str), file);
1067 char* strA = GetMultiByteString(str);
1069 HeapFree(GetProcessHeap(), 0, strA);
1073 /******************************************************************************
1074 * Writes contents of the registry key to the specified file stream.
1077 * file - writable file stream to export registry branch to.
1078 * key - registry branch to export.
1079 * reg_key_name_buf - name of the key with registry class.
1080 * Is resized if necessary.
1081 * reg_key_name_size - length of the buffer for the registry class in characters.
1082 * val_name_buf - buffer for storing value name.
1083 * Is resized if necessary.
1084 * val_name_size - length of the buffer for storing value names in characters.
1085 * val_buf - buffer for storing values while extracting.
1086 * Is resized if necessary.
1087 * val_size - size of the buffer for storing values in bytes.
1089 static void export_hkey(FILE *file, HKEY key,
1090 WCHAR **reg_key_name_buf, DWORD *reg_key_name_size,
1091 WCHAR **val_name_buf, DWORD *val_name_size,
1092 BYTE **val_buf, DWORD *val_size,
1093 WCHAR **line_buf, DWORD *line_buf_size,
1096 DWORD max_sub_key_len;
1097 DWORD max_val_name_len;
1103 WCHAR key_format[] = {'\n','[','%','s',']','\n',0};
1105 /* get size information and resize the buffers if necessary */
1106 if (RegQueryInfoKeyW(key, NULL, NULL, NULL, NULL,
1107 &max_sub_key_len, NULL,
1108 NULL, &max_val_name_len, &max_val_size, NULL, NULL
1109 ) != ERROR_SUCCESS) {
1110 REGPROC_print_error();
1112 curr_len = strlenW(*reg_key_name_buf);
1113 REGPROC_resize_char_buffer(reg_key_name_buf, reg_key_name_size,
1114 max_sub_key_len + curr_len + 1);
1115 REGPROC_resize_char_buffer(val_name_buf, val_name_size,
1117 REGPROC_resize_binary_buffer(val_buf, val_size, max_val_size);
1118 REGPROC_resize_char_buffer(line_buf, line_buf_size, lstrlenW(*reg_key_name_buf) + 4);
1119 /* output data for the current key */
1120 sprintfW(*line_buf, key_format, *reg_key_name_buf);
1121 REGPROC_write_line(file, *line_buf, unicode);
1123 /* print all the values */
1128 DWORD val_name_size1 = *val_name_size;
1129 DWORD val_size1 = *val_size;
1130 ret = RegEnumValueW(key, i, *val_name_buf, &val_name_size1, NULL,
1131 &value_type, *val_buf, &val_size1);
1132 if (ret == ERROR_MORE_DATA) {
1133 /* Increase the size of the buffers and retry */
1134 REGPROC_resize_char_buffer(val_name_buf, val_name_size, val_name_size1);
1135 REGPROC_resize_binary_buffer(val_buf, val_size, val_size1);
1136 } else if (ret != ERROR_SUCCESS) {
1138 if (ret != ERROR_NO_MORE_ITEMS) {
1139 REGPROC_print_error();
1145 if ((*val_name_buf)[0]) {
1146 const WCHAR val_start[] = {'"','%','s','"','=',0};
1149 REGPROC_export_string(line_buf, line_buf_size, &line_len, *val_name_buf, lstrlenW(*val_name_buf));
1150 REGPROC_resize_char_buffer(val_name_buf, val_name_size, lstrlenW(*line_buf) + 1);
1151 lstrcpyW(*val_name_buf, *line_buf);
1153 line_len = 3 + lstrlenW(*val_name_buf);
1154 REGPROC_resize_char_buffer(line_buf, line_buf_size, line_len);
1155 sprintfW(*line_buf, val_start, *val_name_buf);
1157 const WCHAR std_val[] = {'@','=',0};
1159 REGPROC_resize_char_buffer(line_buf, line_buf_size, line_len);
1160 lstrcpyW(*line_buf, std_val);
1163 switch (value_type) {
1166 WCHAR* wstr = (WCHAR*)*val_buf;
1168 if (val_size1 < sizeof(WCHAR) || val_size1 % sizeof(WCHAR) ||
1169 wstr[val_size1 / sizeof(WCHAR) - 1]) {
1170 REGPROC_export_binary(line_buf, line_buf_size, &line_len, value_type, *val_buf, val_size1, unicode);
1172 const WCHAR start[] = {'"',0};
1173 const WCHAR end[] = {'"','\n',0};
1176 len = lstrlenW(start);
1177 REGPROC_resize_char_buffer(line_buf, line_buf_size, line_len + len);
1178 lstrcpyW(*line_buf + line_len, start);
1181 /* At this point we know wstr is '\0'-terminated
1182 * so we can substract 1 from the size
1184 REGPROC_export_string(line_buf, line_buf_size, &line_len, wstr, val_size1 / sizeof(WCHAR) - 1);
1186 REGPROC_resize_char_buffer(line_buf, line_buf_size, line_len + lstrlenW(end));
1187 lstrcpyW(*line_buf + line_len, end);
1194 WCHAR format[] = {'d','w','o','r','d',':','%','0','8','x','\n',0};
1196 REGPROC_resize_char_buffer(line_buf, line_buf_size, line_len + 15);
1197 sprintfW(*line_buf + line_len, format, *((DWORD *)*val_buf));
1203 char* key_nameA = GetMultiByteString(*reg_key_name_buf);
1204 char* value_nameA = GetMultiByteString(*val_name_buf);
1205 fprintf(stderr,"%s: warning - unsupported registry format '%d', "
1206 "treat as binary\n",
1207 getAppName(), value_type);
1208 fprintf(stderr,"key name: \"%s\"\n", key_nameA);
1209 fprintf(stderr,"value name:\"%s\"\n\n", value_nameA);
1210 HeapFree(GetProcessHeap(), 0, key_nameA);
1211 HeapFree(GetProcessHeap(), 0, value_nameA);
1218 REGPROC_export_binary(line_buf, line_buf_size, &line_len, value_type, *val_buf, val_size1, unicode);
1220 REGPROC_write_line(file, *line_buf, unicode);
1226 (*reg_key_name_buf)[curr_len] = '\\';
1228 DWORD buf_size = *reg_key_name_size - curr_len - 1;
1230 ret = RegEnumKeyExW(key, i, *reg_key_name_buf + curr_len + 1, &buf_size,
1231 NULL, NULL, NULL, NULL);
1232 if (ret == ERROR_MORE_DATA) {
1233 /* Increase the size of the buffer and retry */
1234 REGPROC_resize_char_buffer(reg_key_name_buf, reg_key_name_size, curr_len + 1 + buf_size);
1235 } else if (ret != ERROR_SUCCESS) {
1237 if (ret != ERROR_NO_MORE_ITEMS) {
1238 REGPROC_print_error();
1244 if (RegOpenKeyW(key, *reg_key_name_buf + curr_len + 1,
1245 &subkey) == ERROR_SUCCESS) {
1246 export_hkey(file, subkey, reg_key_name_buf, reg_key_name_size,
1247 val_name_buf, val_name_size, val_buf, val_size,
1248 line_buf, line_buf_size, unicode);
1249 RegCloseKey(subkey);
1251 REGPROC_print_error();
1255 (*reg_key_name_buf)[curr_len] = '\0';
1258 /******************************************************************************
1259 * Open file for export.
1261 static FILE *REGPROC_open_export_file(WCHAR *file_name, BOOL unicode)
1266 if (strncmpW(file_name,&dash,1)==0)
1270 CHAR* file_nameA = GetMultiByteString(file_name);
1271 file = fopen(file_nameA, "w");
1274 fprintf(stderr,"%s: Can't open file \"%s\"\n", getAppName(), file_nameA);
1275 HeapFree(GetProcessHeap(), 0, file_nameA);
1278 HeapFree(GetProcessHeap(), 0, file_nameA);
1282 const BYTE unicode_seq[] = {0xff,0xfe};
1283 const WCHAR header[] = {'W','i','n','d','o','w','s',' ','R','e','g','i','s','t','r','y',' ','E','d','i','t','o','r',' ','V','e','r','s','i','o','n',' ','5','.','0','0','\n'};
1284 fwrite(unicode_seq, sizeof(BYTE), sizeof(unicode_seq)/sizeof(unicode_seq[0]), file);
1285 fwrite(header, sizeof(WCHAR), sizeof(header)/sizeof(header[0]), file);
1288 fputs("REGEDIT4\n", file);
1294 /******************************************************************************
1295 * Writes contents of the registry key to the specified file stream.
1298 * file_name - name of a file to export registry branch to.
1299 * reg_key_name - registry branch to export. The whole registry is exported if
1300 * reg_key_name is NULL or contains an empty string.
1302 BOOL export_registry_key(WCHAR *file_name, WCHAR *reg_key_name, DWORD format)
1304 WCHAR *reg_key_name_buf;
1305 WCHAR *val_name_buf;
1308 DWORD reg_key_name_size = KEY_MAX_LEN;
1309 DWORD val_name_size = KEY_MAX_LEN;
1310 DWORD val_size = REG_VAL_BUF_SIZE;
1311 DWORD line_buf_size = KEY_MAX_LEN + REG_VAL_BUF_SIZE;
1313 BOOL unicode = (format == REG_FORMAT_5);
1315 reg_key_name_buf = HeapAlloc(GetProcessHeap(), 0,
1316 reg_key_name_size * sizeof(*reg_key_name_buf));
1317 val_name_buf = HeapAlloc(GetProcessHeap(), 0,
1318 val_name_size * sizeof(*val_name_buf));
1319 val_buf = HeapAlloc(GetProcessHeap(), 0, val_size);
1320 line_buf = HeapAlloc(GetProcessHeap(), 0, line_buf_size * sizeof(*line_buf));
1321 CHECK_ENOUGH_MEMORY(reg_key_name_buf && val_name_buf && val_buf && line_buf);
1323 if (reg_key_name && reg_key_name[0]) {
1325 WCHAR *branch_name = NULL;
1328 REGPROC_resize_char_buffer(®_key_name_buf, ®_key_name_size,
1329 lstrlenW(reg_key_name));
1330 lstrcpyW(reg_key_name_buf, reg_key_name);
1332 /* open the specified key */
1333 if (!parseKeyName(reg_key_name, ®_key_class, &branch_name)) {
1334 CHAR* key_nameA = GetMultiByteString(reg_key_name);
1335 fprintf(stderr,"%s: Incorrect registry class specification in '%s'\n",
1336 getAppName(), key_nameA);
1337 HeapFree(GetProcessHeap(), 0, key_nameA);
1340 if (!branch_name[0]) {
1341 /* no branch - registry class is specified */
1342 file = REGPROC_open_export_file(file_name, unicode);
1343 export_hkey(file, reg_key_class,
1344 ®_key_name_buf, ®_key_name_size,
1345 &val_name_buf, &val_name_size,
1346 &val_buf, &val_size, &line_buf,
1347 &line_buf_size, unicode);
1348 } else if (RegOpenKeyW(reg_key_class, branch_name, &key) == ERROR_SUCCESS) {
1349 file = REGPROC_open_export_file(file_name, unicode);
1350 export_hkey(file, key,
1351 ®_key_name_buf, ®_key_name_size,
1352 &val_name_buf, &val_name_size,
1353 &val_buf, &val_size, &line_buf,
1354 &line_buf_size, unicode);
1357 CHAR* key_nameA = GetMultiByteString(reg_key_name);
1358 fprintf(stderr,"%s: Can't export. Registry key '%s' does not exist!\n",
1359 getAppName(), key_nameA);
1360 HeapFree(GetProcessHeap(), 0, key_nameA);
1361 REGPROC_print_error();
1366 /* export all registry classes */
1367 file = REGPROC_open_export_file(file_name, unicode);
1368 for (i = 0; i < REG_CLASS_NUMBER; i++) {
1369 /* do not export HKEY_CLASSES_ROOT */
1370 if (reg_class_keys[i] != HKEY_CLASSES_ROOT &&
1371 reg_class_keys[i] != HKEY_CURRENT_USER &&
1372 reg_class_keys[i] != HKEY_CURRENT_CONFIG &&
1373 reg_class_keys[i] != HKEY_DYN_DATA) {
1374 lstrcpyW(reg_key_name_buf, reg_class_namesW[i]);
1375 export_hkey(file, reg_class_keys[i],
1376 ®_key_name_buf, ®_key_name_size,
1377 &val_name_buf, &val_name_size,
1378 &val_buf, &val_size, &line_buf,
1379 &line_buf_size, unicode);
1387 HeapFree(GetProcessHeap(), 0, reg_key_name);
1388 HeapFree(GetProcessHeap(), 0, val_name_buf);
1389 HeapFree(GetProcessHeap(), 0, val_buf);
1390 HeapFree(GetProcessHeap(), 0, line_buf);
1394 /******************************************************************************
1395 * Reads contents of the specified file into the registry.
1397 BOOL import_registry_file(FILE* reg_file)
1402 if (fread( s, 2, 1, reg_file) == 1)
1404 if (s[0] == 0xff && s[1] == 0xfe)
1406 processRegLinesW(reg_file);
1409 processRegLinesA(reg_file, (char*)s);
1417 /******************************************************************************
1418 * Removes the registry key with all subkeys. Parses full key name.
1421 * reg_key_name - full name of registry branch to delete. Ignored if is NULL,
1422 * empty, points to register key class, does not exist.
1424 void delete_registry_key(WCHAR *reg_key_name)
1426 WCHAR *key_name = NULL;
1429 if (!reg_key_name || !reg_key_name[0])
1432 if (!parseKeyName(reg_key_name, &key_class, &key_name)) {
1433 char* reg_key_nameA = GetMultiByteString(reg_key_name);
1434 fprintf(stderr,"%s: Incorrect registry class specification in '%s'\n",
1435 getAppName(), reg_key_nameA);
1436 HeapFree(GetProcessHeap(), 0, reg_key_nameA);
1440 char* reg_key_nameA = GetMultiByteString(reg_key_name);
1441 fprintf(stderr,"%s: Can't delete registry class '%s'\n",
1442 getAppName(), reg_key_nameA);
1443 HeapFree(GetProcessHeap(), 0, reg_key_nameA);
1447 RegDeleteTreeW(key_class, key_name);