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
32 #include <wine/unicode.h>
35 #define REG_VAL_BUF_SIZE 4096
37 /* maximal number of characters in hexadecimal data line,
38 * including the indentation, but not including the '\' character
40 #define REG_FILE_HEX_LINE_LEN (2 + 25 * 3)
42 extern const WCHAR
* reg_class_namesW
[];
44 static HKEY reg_class_keys
[] = {
45 HKEY_LOCAL_MACHINE
, HKEY_USERS
, HKEY_CLASSES_ROOT
,
46 HKEY_CURRENT_CONFIG
, HKEY_CURRENT_USER
, HKEY_DYN_DATA
49 #define REG_CLASS_NUMBER (sizeof(reg_class_keys) / sizeof(reg_class_keys[0]))
52 #define NOT_ENOUGH_MEMORY 1
55 /* processing macros */
57 /* common check of memory allocation results */
58 #define CHECK_ENOUGH_MEMORY(p) \
61 fprintf(stderr,"%s: file %s, line %d: Not enough memory\n", \
62 getAppName(), __FILE__, __LINE__); \
63 exit(NOT_ENOUGH_MEMORY); \
66 /******************************************************************************
67 * Allocates memory and converts input from multibyte to wide chars
68 * Returned string must be freed by the caller
70 WCHAR
* GetWideString(const char* strA
)
75 int len
= MultiByteToWideChar(CP_ACP
, 0, strA
, -1, NULL
, 0);
77 strW
= HeapAlloc(GetProcessHeap(), 0, len
* sizeof(WCHAR
));
78 CHECK_ENOUGH_MEMORY(strW
);
79 MultiByteToWideChar(CP_ACP
, 0, strA
, -1, strW
, len
);
85 /******************************************************************************
86 * Allocates memory and converts input from multibyte to wide chars
87 * Returned string must be freed by the caller
89 static WCHAR
* GetWideStringN(const char* strA
, int chars
, DWORD
*len
)
94 *len
= MultiByteToWideChar(CP_ACP
, 0, strA
, chars
, NULL
, 0);
96 strW
= HeapAlloc(GetProcessHeap(), 0, *len
* sizeof(WCHAR
));
97 CHECK_ENOUGH_MEMORY(strW
);
98 MultiByteToWideChar(CP_ACP
, 0, strA
, chars
, strW
, *len
);
105 /******************************************************************************
106 * Allocates memory and converts input from wide chars to multibyte
107 * Returned string must be freed by the caller
109 char* GetMultiByteString(const WCHAR
* strW
)
114 int len
= WideCharToMultiByte(CP_ACP
, 0, strW
, -1, NULL
, 0, NULL
, NULL
);
116 strA
= HeapAlloc(GetProcessHeap(), 0, len
);
117 CHECK_ENOUGH_MEMORY(strA
);
118 WideCharToMultiByte(CP_ACP
, 0, strW
, -1, strA
, len
, NULL
, NULL
);
124 /******************************************************************************
125 * Allocates memory and converts input from wide chars to multibyte
126 * Returned string must be freed by the caller
128 static char* GetMultiByteStringN(const WCHAR
* strW
, int chars
, DWORD
* len
)
133 *len
= WideCharToMultiByte(CP_ACP
, 0, strW
, chars
, NULL
, 0, NULL
, NULL
);
135 strA
= HeapAlloc(GetProcessHeap(), 0, *len
);
136 CHECK_ENOUGH_MEMORY(strA
);
137 WideCharToMultiByte(CP_ACP
, 0, strW
, chars
, strA
, *len
, NULL
, NULL
);
144 /******************************************************************************
145 * Converts a hex representation of a DWORD into a DWORD.
147 static BOOL
convertHexToDWord(WCHAR
* str
, DWORD
*dw
)
152 WideCharToMultiByte(CP_ACP
, 0, str
, -1, buf
, 9, NULL
, NULL
);
153 if (lstrlenW(str
) > 8 || sscanf(buf
, "%x%c", dw
, &dummy
) != 1) {
154 fprintf(stderr
,"%s: ERROR, invalid hex value\n", getAppName());
160 /******************************************************************************
161 * Converts a hex comma separated values list into a binary string.
163 static BYTE
* convertHexCSVToHex(WCHAR
*str
, DWORD
*size
)
168 /* The worst case is 1 digit + 1 comma per byte */
169 *size
=(lstrlenW(str
)+1)/2;
170 data
=HeapAlloc(GetProcessHeap(), 0, *size
);
171 CHECK_ENOUGH_MEMORY(data
);
180 wc
= strtoulW(s
,&end
,16);
181 if (end
== s
|| wc
> 0xff || (*end
&& *end
!= ',')) {
182 char* strA
= GetMultiByteString(s
);
183 fprintf(stderr
,"%s: ERROR converting CSV hex stream. Invalid value at '%s'\n",
185 HeapFree(GetProcessHeap(), 0, data
);
186 HeapFree(GetProcessHeap(), 0, strA
);
198 /******************************************************************************
199 * This function returns the HKEY associated with the data type encoded in the
200 * value. It modifies the input parameter (key value) in order to skip this
201 * "now useless" data type information.
203 * Note: Updated based on the algorithm used in 'server/registry.c'
205 static DWORD
getDataType(LPWSTR
*lpValue
, DWORD
* parse_type
)
207 struct data_type
{ const WCHAR
*tag
; int len
; int type
; int parse_type
; };
209 static const WCHAR quote
[] = {'"'};
210 static const WCHAR str
[] = {'s','t','r',':','"'};
211 static const WCHAR str2
[] = {'s','t','r','(','2',')',':','"'};
212 static const WCHAR hex
[] = {'h','e','x',':'};
213 static const WCHAR dword
[] = {'d','w','o','r','d',':'};
214 static const WCHAR hexp
[] = {'h','e','x','('};
216 static const struct data_type data_types
[] = { /* actual type */ /* type to assume for parsing */
217 { quote
, 1, REG_SZ
, REG_SZ
},
218 { str
, 5, REG_SZ
, REG_SZ
},
219 { str2
, 8, REG_EXPAND_SZ
, REG_SZ
},
220 { hex
, 4, REG_BINARY
, REG_BINARY
},
221 { dword
, 6, REG_DWORD
, REG_DWORD
},
222 { hexp
, 4, -1, REG_BINARY
},
226 const struct data_type
*ptr
;
229 for (ptr
= data_types
; ptr
->tag
; ptr
++) {
230 if (strncmpW( ptr
->tag
, *lpValue
, ptr
->len
))
234 *parse_type
= ptr
->parse_type
;
240 /* "hex(xx):" is special */
241 type
= (int)strtoulW( *lpValue
, &end
, 16 );
242 if (**lpValue
=='\0' || *end
!=')' || *(end
+1)!=':') {
250 *parse_type
=REG_NONE
;
254 /******************************************************************************
255 * Replaces escape sequences with the characters.
257 static void REGPROC_unescape_string(WCHAR
* str
)
259 int str_idx
= 0; /* current character under analysis */
260 int val_idx
= 0; /* the last character of the unescaped string */
261 int len
= lstrlenW(str
);
262 for (str_idx
= 0; str_idx
< len
; str_idx
++, val_idx
++) {
263 if (str
[str_idx
] == '\\') {
265 switch (str
[str_idx
]) {
271 str
[val_idx
] = str
[str_idx
];
274 fprintf(stderr
,"Warning! Unrecognized escape sequence: \\%c'\n",
276 str
[val_idx
] = str
[str_idx
];
280 str
[val_idx
] = str
[str_idx
];
286 static BOOL
parseKeyName(LPWSTR lpKeyName
, HKEY
*hKey
, LPWSTR
*lpKeyPath
)
288 WCHAR
* lpSlash
= NULL
;
291 if (lpKeyName
== NULL
)
294 for(i
= 0; *(lpKeyName
+i
) != 0; i
++)
296 if(*(lpKeyName
+i
) == '\\')
298 lpSlash
= lpKeyName
+i
;
305 len
= lpSlash
-lpKeyName
;
309 len
= lstrlenW(lpKeyName
);
310 lpSlash
= lpKeyName
+len
;
314 for (i
= 0; i
< REG_CLASS_NUMBER
; i
++) {
315 if (CompareStringW(LOCALE_USER_DEFAULT
, 0, lpKeyName
, len
, reg_class_namesW
[i
], len
) == CSTR_EQUAL
&&
316 len
== lstrlenW(reg_class_namesW
[i
])) {
317 *hKey
= reg_class_keys
[i
];
326 if (*lpSlash
!= '\0')
328 *lpKeyPath
= lpSlash
;
332 /* Globals used by the setValue() & co */
333 static LPSTR currentKeyName
;
334 static HKEY currentKeyHandle
= NULL
;
336 /******************************************************************************
337 * Sets the value with name val_name to the data in val_data for the currently
341 * val_name - name of the registry value
342 * val_data - registry value data
344 static LONG
setValue(WCHAR
* val_name
, WCHAR
* val_data
, BOOL is_unicode
)
347 DWORD dwDataType
, dwParseType
;
350 WCHAR del
[] = {'-',0};
352 if ( (val_name
== NULL
) || (val_data
== NULL
) )
353 return ERROR_INVALID_PARAMETER
;
355 if (lstrcmpW(val_data
, del
) == 0)
357 res
=RegDeleteValueW(currentKeyHandle
,val_name
);
358 return (res
== ERROR_FILE_NOT_FOUND
? ERROR_SUCCESS
: res
);
361 /* Get the data type stored into the value field */
362 dwDataType
= getDataType(&val_data
, &dwParseType
);
364 if (dwParseType
== REG_SZ
) /* no conversion for string */
366 REGPROC_unescape_string(val_data
);
367 /* Compute dwLen after REGPROC_unescape_string because it may
368 * have changed the string length and we don't want to store
369 * the extra garbage in the registry.
371 dwLen
= lstrlenW(val_data
);
372 if(val_data
[dwLen
-1] != '"')
373 return ERROR_INVALID_DATA
;
374 if (dwLen
>0 && val_data
[dwLen
-1]=='"')
377 val_data
[dwLen
]='\0';
379 lpbData
= (BYTE
*) val_data
;
380 dwLen
++; /* include terminating null */
381 dwLen
= dwLen
* sizeof(WCHAR
); /* size is in bytes */
383 else if (dwParseType
== REG_DWORD
) /* Convert the dword types */
385 if (!convertHexToDWord(val_data
, &dwData
))
386 return ERROR_INVALID_DATA
;
387 lpbData
= (BYTE
*)&dwData
;
388 dwLen
= sizeof(dwData
);
390 else if (dwParseType
== REG_BINARY
) /* Convert the binary data */
392 lpbData
= convertHexCSVToHex(val_data
, &dwLen
);
394 return ERROR_INVALID_DATA
;
396 if((dwDataType
== REG_MULTI_SZ
|| dwDataType
== REG_EXPAND_SZ
) && !is_unicode
)
398 LPBYTE tmp
= lpbData
;
399 lpbData
= (LPBYTE
)GetWideStringN((char*)lpbData
, dwLen
, &dwLen
);
400 dwLen
*= sizeof(WCHAR
);
401 HeapFree(GetProcessHeap(), 0, tmp
);
404 else /* unknown format */
406 fprintf(stderr
,"%s: ERROR, unknown data format\n", getAppName());
407 return ERROR_INVALID_DATA
;
410 res
= RegSetValueExW(
417 if (dwParseType
== REG_BINARY
)
418 HeapFree(GetProcessHeap(), 0, lpbData
);
422 /******************************************************************************
423 * A helper function for processRegEntry() that opens the current key.
424 * That key must be closed by calling closeKey().
426 static LONG
openKeyW(WCHAR
* stdInput
)
434 if (stdInput
== NULL
)
435 return ERROR_INVALID_PARAMETER
;
437 /* Get the registry class */
438 if (!parseKeyName(stdInput
, &keyClass
, &keyPath
))
439 return ERROR_INVALID_PARAMETER
;
441 res
= RegCreateKeyExW(
442 keyClass
, /* Class */
443 keyPath
, /* Sub Key */
445 NULL
, /* object type */
446 REG_OPTION_NON_VOLATILE
, /* option, REG_OPTION_NON_VOLATILE ... */
447 KEY_ALL_ACCESS
, /* access mask, KEY_ALL_ACCESS */
448 NULL
, /* security attribute */
449 ¤tKeyHandle
, /* result */
450 &dwDisp
); /* disposition, REG_CREATED_NEW_KEY or
451 REG_OPENED_EXISTING_KEY */
453 if (res
== ERROR_SUCCESS
)
454 currentKeyName
= GetMultiByteString(stdInput
);
456 currentKeyHandle
= NULL
;
462 /******************************************************************************
463 * Close the currently opened key.
465 static void closeKey(void)
467 if (currentKeyHandle
)
469 HeapFree(GetProcessHeap(), 0, currentKeyName
);
470 RegCloseKey(currentKeyHandle
);
471 currentKeyHandle
= NULL
;
475 /******************************************************************************
476 * This function is a wrapper for the setValue function. It prepares the
477 * land and cleans the area once completed.
478 * Note: this function modifies the line parameter.
480 * line - registry file unwrapped line. Should have the registry value name and
481 * complete registry value data.
483 static void processSetValue(WCHAR
* line
, BOOL is_unicode
)
485 WCHAR
* val_name
; /* registry value name */
486 WCHAR
* val_data
; /* registry value data */
487 int line_idx
= 0; /* current character under analysis */
491 while ( isspaceW(line
[line_idx
]) ) line_idx
++;
492 if (line
[line_idx
] == '@' && line
[line_idx
+ 1] == '=') {
493 line
[line_idx
] = '\0';
496 } else if (line
[line_idx
] == '\"') {
498 val_name
= line
+ line_idx
;
499 while (line
[line_idx
]) {
500 if (line
[line_idx
] == '\\') /* skip escaped character */
504 if (line
[line_idx
] == '\"') {
505 line
[line_idx
] = '\0';
513 while ( isspaceW(line
[line_idx
]) ) line_idx
++;
514 if (!line
[line_idx
]) {
515 fprintf(stderr
, "%s: warning: unexpected EOL\n", getAppName());
518 if (line
[line_idx
] != '=') {
520 line
[line_idx
] = '\"';
521 lineA
= GetMultiByteString(line
);
522 fprintf(stderr
,"%s: warning: unrecognized line: '%s'\n", getAppName(), lineA
);
523 HeapFree(GetProcessHeap(), 0, lineA
);
528 char* lineA
= GetMultiByteString(line
);
529 fprintf(stderr
,"%s: warning: unrecognized line: '%s'\n", getAppName(), lineA
);
530 HeapFree(GetProcessHeap(), 0, lineA
);
533 line_idx
++; /* skip the '=' character */
535 while ( isspaceW(line
[line_idx
]) ) line_idx
++;
536 val_data
= line
+ line_idx
;
537 /* trim trailing blanks */
538 line_idx
= strlenW(val_data
);
539 while (line_idx
> 0 && isspaceW(val_data
[line_idx
-1])) line_idx
--;
540 val_data
[line_idx
] = '\0';
542 REGPROC_unescape_string(val_name
);
543 res
= setValue(val_name
, val_data
, is_unicode
);
544 if ( res
!= ERROR_SUCCESS
)
546 char* val_nameA
= GetMultiByteString(val_name
);
547 char* val_dataA
= GetMultiByteString(val_data
);
548 fprintf(stderr
,"%s: ERROR Key %s not created. Value: %s, Data: %s\n",
553 HeapFree(GetProcessHeap(), 0, val_nameA
);
554 HeapFree(GetProcessHeap(), 0, val_dataA
);
558 /******************************************************************************
559 * This function receives the currently read entry and performs the
560 * corresponding action.
561 * isUnicode affects parsing of REG_MULTI_SZ values
563 static void processRegEntry(WCHAR
* stdInput
, BOOL isUnicode
)
566 * We encountered the end of the file, make sure we
567 * close the opened key and exit
569 if (stdInput
== NULL
) {
574 if ( stdInput
[0] == '[') /* We are reading a new key */
577 closeKey(); /* Close the previous key */
579 /* Get rid of the square brackets */
581 keyEnd
= strrchrW(stdInput
, ']');
585 /* delete the key if we encounter '-' at the start of reg key */
586 if ( stdInput
[0] == '-')
588 delete_registry_key(stdInput
+ 1);
589 } else if ( openKeyW(stdInput
) != ERROR_SUCCESS
)
591 char* stdInputA
= GetMultiByteString(stdInput
);
592 fprintf(stderr
,"%s: setValue failed to open key %s\n",
593 getAppName(), stdInputA
);
594 HeapFree(GetProcessHeap(), 0, stdInputA
);
596 } else if( currentKeyHandle
&&
597 (( stdInput
[0] == '@') || /* reading a default @=data pair */
598 ( stdInput
[0] == '\"'))) /* reading a new value=data pair */
600 processSetValue(stdInput
, isUnicode
);
603 /* Since we are assuming that the file format is valid we must be
604 * reading a blank line which indicates the end of this key processing
610 /******************************************************************************
611 * Processes a registry file.
612 * Correctly processes comments (in # form), line continuation.
615 * in - input stream to read from
616 * first_chars - beginning of stream, read due to Unicode check
618 static void processRegLinesA(FILE *in
, char* first_chars
)
620 LPSTR line
= NULL
; /* line read from input stream */
621 ULONG lineSize
= REG_VAL_BUF_SIZE
;
623 line
= HeapAlloc(GetProcessHeap(), 0, lineSize
);
624 CHECK_ENOUGH_MEMORY(line
);
625 memcpy(line
, first_chars
, 2);
628 LPSTR s
; /* The pointer into line for where the current fgets should read */
639 size_t size_remaining
;
641 char *s_eol
; /* various local uses */
643 /* Do we need to expand the buffer ? */
644 assert (s
>= line
&& s
<= line
+ lineSize
);
645 size_remaining
= lineSize
- (s
-line
);
646 if (size_remaining
< 2) /* room for 1 character and the \0 */
649 size_t new_size
= lineSize
+ REG_VAL_BUF_SIZE
;
650 if (new_size
> lineSize
) /* no arithmetic overflow */
651 new_buffer
= HeapReAlloc (GetProcessHeap(), 0, line
, new_size
);
654 CHECK_ENOUGH_MEMORY(new_buffer
);
656 s
= line
+ lineSize
- size_remaining
;
658 size_remaining
= lineSize
- (s
-line
);
661 /* Get as much as possible into the buffer, terminated either by
662 * eof, error, eol or getting the maximum amount. Abort on error.
664 size_to_get
= (size_remaining
> INT_MAX
? INT_MAX
: size_remaining
);
666 /* get a single line. note that `i' must be one past the last
667 * meaningful character in `s' when this loop exits */
668 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
= FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER
| FORMAT_MESSAGE_FROM_SYSTEM
,
894 NULL
, error_code
, 0, (LPSTR
) &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
[] = {'\\','\r','\n',' ',' ',0};
993 DWORD concat_prefix
, concat_len
;
994 const WCHAR newline
[] = {'\r','\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
[] = {'\r','\n','[','%','s',']','\r','\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
[] = {'"','\r','\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 subtract 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','\r','\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 in binary mode for export.
1261 static FILE *REGPROC_open_export_file(WCHAR
*file_name
, BOOL unicode
)
1266 if (strncmpW(file_name
,&dash
,1)==0) {
1268 _setmode(_fileno(file
), _O_BINARY
);
1271 CHAR
* file_nameA
= GetMultiByteString(file_name
);
1272 file
= fopen(file_nameA
, "wb");
1275 fprintf(stderr
,"%s: Can't open file \"%s\"\n", getAppName(), file_nameA
);
1276 HeapFree(GetProcessHeap(), 0, file_nameA
);
1279 HeapFree(GetProcessHeap(), 0, file_nameA
);
1283 const BYTE unicode_seq
[] = {0xff,0xfe};
1284 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','\r','\n'};
1285 fwrite(unicode_seq
, sizeof(BYTE
), sizeof(unicode_seq
)/sizeof(unicode_seq
[0]), file
);
1286 fwrite(header
, sizeof(WCHAR
), sizeof(header
)/sizeof(header
[0]), file
);
1289 fputs("REGEDIT4\r\n", file
);
1295 /******************************************************************************
1296 * Writes contents of the registry key to the specified file stream.
1299 * file_name - name of a file to export registry branch to.
1300 * reg_key_name - registry branch to export. The whole registry is exported if
1301 * reg_key_name is NULL or contains an empty string.
1303 BOOL
export_registry_key(WCHAR
*file_name
, WCHAR
*reg_key_name
, DWORD format
)
1305 WCHAR
*reg_key_name_buf
;
1306 WCHAR
*val_name_buf
;
1309 DWORD reg_key_name_size
= KEY_MAX_LEN
;
1310 DWORD val_name_size
= KEY_MAX_LEN
;
1311 DWORD val_size
= REG_VAL_BUF_SIZE
;
1312 DWORD line_buf_size
= KEY_MAX_LEN
+ REG_VAL_BUF_SIZE
;
1314 BOOL unicode
= (format
== REG_FORMAT_5
);
1316 reg_key_name_buf
= HeapAlloc(GetProcessHeap(), 0,
1317 reg_key_name_size
* sizeof(*reg_key_name_buf
));
1318 val_name_buf
= HeapAlloc(GetProcessHeap(), 0,
1319 val_name_size
* sizeof(*val_name_buf
));
1320 val_buf
= HeapAlloc(GetProcessHeap(), 0, val_size
);
1321 line_buf
= HeapAlloc(GetProcessHeap(), 0, line_buf_size
* sizeof(*line_buf
));
1322 CHECK_ENOUGH_MEMORY(reg_key_name_buf
&& val_name_buf
&& val_buf
&& line_buf
);
1324 if (reg_key_name
&& reg_key_name
[0]) {
1326 WCHAR
*branch_name
= NULL
;
1329 REGPROC_resize_char_buffer(®_key_name_buf
, ®_key_name_size
,
1330 lstrlenW(reg_key_name
));
1331 lstrcpyW(reg_key_name_buf
, reg_key_name
);
1333 /* open the specified key */
1334 if (!parseKeyName(reg_key_name
, ®_key_class
, &branch_name
)) {
1335 CHAR
* key_nameA
= GetMultiByteString(reg_key_name
);
1336 fprintf(stderr
,"%s: Incorrect registry class specification in '%s'\n",
1337 getAppName(), key_nameA
);
1338 HeapFree(GetProcessHeap(), 0, key_nameA
);
1341 if (!branch_name
[0]) {
1342 /* no branch - registry class is specified */
1343 file
= REGPROC_open_export_file(file_name
, unicode
);
1344 export_hkey(file
, reg_key_class
,
1345 ®_key_name_buf
, ®_key_name_size
,
1346 &val_name_buf
, &val_name_size
,
1347 &val_buf
, &val_size
, &line_buf
,
1348 &line_buf_size
, unicode
);
1349 } else if (RegOpenKeyW(reg_key_class
, branch_name
, &key
) == ERROR_SUCCESS
) {
1350 file
= REGPROC_open_export_file(file_name
, unicode
);
1351 export_hkey(file
, key
,
1352 ®_key_name_buf
, ®_key_name_size
,
1353 &val_name_buf
, &val_name_size
,
1354 &val_buf
, &val_size
, &line_buf
,
1355 &line_buf_size
, unicode
);
1358 CHAR
* key_nameA
= GetMultiByteString(reg_key_name
);
1359 fprintf(stderr
,"%s: Can't export. Registry key '%s' does not exist!\n",
1360 getAppName(), key_nameA
);
1361 HeapFree(GetProcessHeap(), 0, key_nameA
);
1362 REGPROC_print_error();
1367 /* export all registry classes */
1368 file
= REGPROC_open_export_file(file_name
, unicode
);
1369 for (i
= 0; i
< REG_CLASS_NUMBER
; i
++) {
1370 /* do not export HKEY_CLASSES_ROOT */
1371 if (reg_class_keys
[i
] != HKEY_CLASSES_ROOT
&&
1372 reg_class_keys
[i
] != HKEY_CURRENT_USER
&&
1373 reg_class_keys
[i
] != HKEY_CURRENT_CONFIG
&&
1374 reg_class_keys
[i
] != HKEY_DYN_DATA
) {
1375 lstrcpyW(reg_key_name_buf
, reg_class_namesW
[i
]);
1376 export_hkey(file
, reg_class_keys
[i
],
1377 ®_key_name_buf
, ®_key_name_size
,
1378 &val_name_buf
, &val_name_size
,
1379 &val_buf
, &val_size
, &line_buf
,
1380 &line_buf_size
, unicode
);
1388 HeapFree(GetProcessHeap(), 0, reg_key_name
);
1389 HeapFree(GetProcessHeap(), 0, val_name_buf
);
1390 HeapFree(GetProcessHeap(), 0, val_buf
);
1391 HeapFree(GetProcessHeap(), 0, line_buf
);
1395 /******************************************************************************
1396 * Reads contents of the specified file into the registry.
1398 BOOL
import_registry_file(FILE* reg_file
)
1403 if (fread( s
, 2, 1, reg_file
) == 1)
1405 if (s
[0] == 0xff && s
[1] == 0xfe)
1407 processRegLinesW(reg_file
);
1410 processRegLinesA(reg_file
, (char*)s
);
1418 /******************************************************************************
1419 * Removes the registry key with all subkeys. Parses full key name.
1422 * reg_key_name - full name of registry branch to delete. Ignored if is NULL,
1423 * empty, points to register key class, does not exist.
1425 void delete_registry_key(WCHAR
*reg_key_name
)
1427 WCHAR
*key_name
= NULL
;
1430 if (!reg_key_name
|| !reg_key_name
[0])
1433 if (!parseKeyName(reg_key_name
, &key_class
, &key_name
)) {
1434 char* reg_key_nameA
= GetMultiByteString(reg_key_name
);
1435 fprintf(stderr
,"%s: Incorrect registry class specification in '%s'\n",
1436 getAppName(), reg_key_nameA
);
1437 HeapFree(GetProcessHeap(), 0, reg_key_nameA
);
1441 char* reg_key_nameA
= GetMultiByteString(reg_key_name
);
1442 fprintf(stderr
,"%s: Can't delete registry class '%s'\n",
1443 getAppName(), reg_key_nameA
);
1444 HeapFree(GetProcessHeap(), 0, reg_key_nameA
);
1448 RegDeleteTreeW(key_class
, key_name
);