blob: b981ee3d9ef025e26cd887c1c0363009c670fb93 [file] [log] [blame]
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001/*
Fred Drake270e19b2000-06-29 16:14:14 +00002 _winreg.c
Guido van Rossum9f3712c2000-03-28 20:37:15 +00003
4 Windows Registry access module for Python.
5
6 * Simple registry access written by Mark Hammond in win32api
7 module circa 1995.
8 * Bill Tutt expanded the support significantly not long after.
9 * Numerous other people have submitted patches since then.
10 * Ripped from win32api module 03-Feb-2000 by Mark Hammond, and
11 basic Unicode support added.
12
13*/
14
15#include "windows.h"
16#include "Python.h"
17#include "structmember.h"
18#include "malloc.h" /* for alloca */
19
20static BOOL PyHKEY_AsHKEY(PyObject *ob, HKEY *pRes, BOOL bNoneOK);
21static PyObject *PyHKEY_FromHKEY(HKEY h);
22static BOOL PyHKEY_Close(PyObject *obHandle);
23
24static char errNotAHandle[] = "Object is not a handle";
25
26/* The win32api module reports the function name that failed,
27 but this concept is not in the Python core.
28 Hopefully it will one day, and in the meantime I dont
29 want to lose this info...
30*/
31#define PyErr_SetFromWindowsErrWithFunction(rc, fnname) \
32 PyErr_SetFromWindowsErr(rc)
33
34/* Forward declares */
35
36/* Doc strings */
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000037PyDoc_STRVAR(module_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +000038"This module provides access to the Windows registry API.\n"
39"\n"
40"Functions:\n"
41"\n"
42"CloseKey() - Closes a registry key.\n"
43"ConnectRegistry() - Establishes a connection to a predefined registry handle\n"
44" on another computer.\n"
45"CreateKey() - Creates the specified key, or opens it if it already exists.\n"
46"DeleteKey() - Deletes the specified key.\n"
47"DeleteValue() - Removes a named value from the specified registry key.\n"
48"EnumKey() - Enumerates subkeys of the specified open registry key.\n"
49"EnumValue() - Enumerates values of the specified open registry key.\n"
50"FlushKey() - Writes all the attributes of the specified key to the registry.\n"
51"LoadKey() - Creates a subkey under HKEY_USER or HKEY_LOCAL_MACHINE and stores\n"
52" registration information from a specified file into that subkey.\n"
53"OpenKey() - Alias for <om win32api.RegOpenKeyEx>\n"
54"OpenKeyEx() - Opens the specified key.\n"
55"QueryValue() - Retrieves the value associated with the unnamed value for a\n"
56" specified key in the registry.\n"
57"QueryValueEx() - Retrieves the type and data for a specified value name\n"
58" associated with an open registry key.\n"
59"QueryInfoKey() - Returns information about the specified key.\n"
60"SaveKey() - Saves the specified key, and all its subkeys a file.\n"
61"SetValue() - Associates a value with a specified key.\n"
62"SetValueEx() - Stores data in the value field of an open registry key.\n"
63"\n"
64"Special objects:\n"
65"\n"
66"HKEYType -- type object for HKEY objects\n"
67"error -- exception raised for Win32 errors\n"
68"\n"
69"Integer constants:\n"
70"Many constants are defined - see the documentation for each function\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000071"to see what constants are used, and where.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +000072
73
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000074PyDoc_STRVAR(CloseKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +000075"CloseKey(hkey) - Closes a previously opened registry key.\n"
76"\n"
77"The hkey argument specifies a previously opened key.\n"
78"\n"
79"Note that if the key is not closed using this method, it will be\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000080"closed when the hkey object is destroyed by Python.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +000081
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000082PyDoc_STRVAR(ConnectRegistry_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +000083"key = ConnectRegistry(computer_name, key) - "
84"Establishes a connection to a predefined registry handle on another computer.\n"
85"\n"
86"computer_name is the name of the remote computer, of the form \\\\computername.\n"
87" If None, the local computer is used.\n"
88"key is the predefined handle to connect to.\n"
89"\n"
90"The return value is the handle of the opened key.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000091"If the function fails, an EnvironmentError exception is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +000092
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +000093PyDoc_STRVAR(CreateKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +000094"key = CreateKey(key, sub_key) - Creates or opens the specified key.\n"
95"\n"
96"key is an already open key, or one of the predefined HKEY_* constants\n"
97"sub_key is a string that names the key this method opens or creates.\n"
98" If key is one of the predefined keys, sub_key may be None. In that case,\n"
99" the handle returned is the same key handle passed in to the function.\n"
100"\n"
101"If the key already exists, this function opens the existing key\n"
102"\n"
103"The return value is the handle of the opened key.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000104"If the function fails, an exception is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000105
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000106PyDoc_STRVAR(DeleteKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000107"DeleteKey(key, sub_key) - Deletes the specified key.\n"
108"\n"
109"key is an already open key, or any one of the predefined HKEY_* constants.\n"
110"sub_key is a string that must be a subkey of the key identified by the key parameter.\n"
111" This value must not be None, and the key may not have subkeys.\n"
112"\n"
113"This method can not delete keys with subkeys.\n"
114"\n"
115"If the method succeeds, the entire key, including all of its values,\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000116"is removed. If the method fails, an EnvironmentError exception is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000117
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000118PyDoc_STRVAR(DeleteValue_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000119"DeleteValue(key, value) - Removes a named value from a registry key.\n"
120"\n"
121"key is an already open key, or any one of the predefined HKEY_* constants.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000122"value is a string that identifies the value to remove.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000123
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000124PyDoc_STRVAR(EnumKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000125"string = EnumKey(key, index) - Enumerates subkeys of an open registry key.\n"
126"\n"
127"key is an already open key, or any one of the predefined HKEY_* constants.\n"
128"index is an integer that identifies the index of the key to retrieve.\n"
129"\n"
130"The function retrieves the name of one subkey each time it is called.\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000131"It is typically called repeatedly until an EnvironmentError exception is\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000132"raised, indicating no more values are available.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000133
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000134PyDoc_STRVAR(EnumValue_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000135"tuple = EnumValue(key, index) - Enumerates values of an open registry key.\n"
136"key is an already open key, or any one of the predefined HKEY_* constants.\n"
137"index is an integer that identifies the index of the value to retrieve.\n"
138"\n"
139"The function retrieves the name of one subkey each time it is called.\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000140"It is typically called repeatedly, until an EnvironmentError exception\n"
141"is raised, indicating no more values.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000142"\n"
143"The result is a tuple of 3 items:\n"
144"value_name is a string that identifies the value.\n"
145"value_data is an object that holds the value data, and whose type depends\n"
146" on the underlying registry type.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000147"data_type is an integer that identifies the type of the value data.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000148
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000149PyDoc_STRVAR(FlushKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000150"FlushKey(key) - Writes all the attributes of a key to the registry.\n"
151"\n"
152"key is an already open key, or any one of the predefined HKEY_* constants.\n"
153"\n"
154"It is not necessary to call RegFlushKey to change a key.\n"
155"Registry changes are flushed to disk by the registry using its lazy flusher.\n"
156"Registry changes are also flushed to disk at system shutdown.\n"
157"Unlike CloseKey(), the FlushKey() method returns only when all the data has\n"
158"been written to the registry.\n"
159"An application should only call FlushKey() if it requires absolute certainty that registry changes are on disk.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000160"If you don't know whether a FlushKey() call is required, it probably isn't.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000161
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000162PyDoc_STRVAR(LoadKey_doc,
Mark Hammondb422f952000-06-09 06:01:47 +0000163"LoadKey(key, sub_key, file_name) - Creates a subkey under the specified key\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000164"and stores registration information from a specified file into that subkey.\n"
165"\n"
166"key is an already open key, or any one of the predefined HKEY_* constants.\n"
167"sub_key is a string that identifies the sub_key to load\n"
168"file_name is the name of the file to load registry data from.\n"
169" This file must have been created with the SaveKey() function.\n"
170" Under the file allocation table (FAT) file system, the filename may not\n"
171"have an extension.\n"
172"\n"
173"A call to LoadKey() fails if the calling process does not have the\n"
174"SE_RESTORE_PRIVILEGE privilege.\n"
175"\n"
176"If key is a handle returned by ConnectRegistry(), then the path specified\n"
177"in fileName is relative to the remote computer.\n"
178"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000179"The docs imply key must be in the HKEY_USER or HKEY_LOCAL_MACHINE tree");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000180
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000181PyDoc_STRVAR(OpenKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000182"key = OpenKey(key, sub_key, res = 0, sam = KEY_READ) - Opens the specified key.\n"
183"\n"
184"key is an already open key, or any one of the predefined HKEY_* constants.\n"
185"sub_key is a string that identifies the sub_key to open\n"
186"res is a reserved integer, and must be zero. Default is zero.\n"
187"sam is an integer that specifies an access mask that describes the desired\n"
188" security access for the key. Default is KEY_READ\n"
189"\n"
190"The result is a new handle to the specified key\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000191"If the function fails, an EnvironmentError exception is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000192
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000193PyDoc_STRVAR(OpenKeyEx_doc, "See OpenKey()");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000194
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000195PyDoc_STRVAR(QueryInfoKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000196"tuple = QueryInfoKey(key) - Returns information about a key.\n"
197"\n"
198"key is an already open key, or any one of the predefined HKEY_* constants.\n"
199"\n"
200"The result is a tuple of 3 items:"
201"An integer that identifies the number of sub keys this key has.\n"
202"An integer that identifies the number of values this key has.\n"
203"A long integer that identifies when the key was last modified (if available)\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000204" as 100's of nanoseconds since Jan 1, 1600.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000205
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000206PyDoc_STRVAR(QueryValue_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000207"string = QueryValue(key, sub_key) - retrieves the unnamed value for a key.\n"
208"\n"
209"key is an already open key, or any one of the predefined HKEY_* constants.\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000210"sub_key is a string that holds the name of the subkey with which the value\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000211" is associated. If this parameter is None or empty, the function retrieves\n"
212" the value set by the SetValue() method for the key identified by key."
213"\n"
214"Values in the registry have name, type, and data components. This method\n"
215"retrieves the data for a key's first value that has a NULL name.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000216"But the underlying API call doesn't return the type, Lame Lame Lame, DONT USE THIS!!!");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000217
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000218PyDoc_STRVAR(QueryValueEx_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000219"value,type_id = QueryValueEx(key, value_name) - Retrieves the type and data for a specified value name associated with an open registry key.\n"
220"\n"
221"key is an already open key, or any one of the predefined HKEY_* constants.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000222"value_name is a string indicating the value to query");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000223
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000224PyDoc_STRVAR(SaveKey_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000225"SaveKey(key, file_name) - Saves the specified key, and all its subkeys to the specified file.\n"
226"\n"
227"key is an already open key, or any one of the predefined HKEY_* constants.\n"
228"file_name is the name of the file to save registry data to.\n"
229" This file cannot already exist. If this filename includes an extension,\n"
230" it cannot be used on file allocation table (FAT) file systems by the\n"
231" LoadKey(), ReplaceKey() or RestoreKey() methods.\n"
232"\n"
233"If key represents a key on a remote computer, the path described by\n"
234"file_name is relative to the remote computer.\n"
235"The caller of this method must possess the SeBackupPrivilege security privilege.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000236"This function passes NULL for security_attributes to the API.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000237
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000238PyDoc_STRVAR(SetValue_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000239"SetValue(key, sub_key, type, value) - Associates a value with a specified key.\n"
240"\n"
241"key is an already open key, or any one of the predefined HKEY_* constants.\n"
242"sub_key is a string that names the subkey with which the value is associated.\n"
243"type is an integer that specifies the type of the data. Currently this\n"
244" must be REG_SZ, meaning only strings are supported.\n"
245"value is a string that specifies the new value.\n"
246"\n"
247"If the key specified by the sub_key parameter does not exist, the SetValue\n"
248"function creates it.\n"
249"\n"
250"Value lengths are limited by available memory. Long values (more than\n"
251"2048 bytes) should be stored as files with the filenames stored in \n"
252"the configuration registry. This helps the registry perform efficiently.\n"
253"\n"
254"The key identified by the key parameter must have been opened with\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000255"KEY_SET_VALUE access.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000256
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000257PyDoc_STRVAR(SetValueEx_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000258"SetValueEx(key, value_name, reserved, type, value) - Stores data in the value field of an open registry key.\n"
259"\n"
260"key is an already open key, or any one of the predefined HKEY_* constants.\n"
Mark Hammondc9083b62003-01-15 23:38:15 +0000261"value_name is a string containing the name of the value to set, or None\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000262"type is an integer that specifies the type of the data. This should be one of:\n"
263" REG_BINARY -- Binary data in any form.\n"
264" REG_DWORD -- A 32-bit number.\n"
265" REG_DWORD_LITTLE_ENDIAN -- A 32-bit number in little-endian format.\n"
266" REG_DWORD_BIG_ENDIAN -- A 32-bit number in big-endian format.\n"
267" REG_EXPAND_SZ -- A null-terminated string that contains unexpanded references\n"
268" to environment variables (for example, %PATH%).\n"
269" REG_LINK -- A Unicode symbolic link.\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000270" REG_MULTI_SZ -- An sequence of null-terminated strings, terminated by\n"
271" two null characters. Note that Python handles this\n"
272" termination automatically.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000273" REG_NONE -- No defined value type.\n"
274" REG_RESOURCE_LIST -- A device-driver resource list.\n"
275" REG_SZ -- A null-terminated string.\n"
276"reserved can be anything - zero is always passed to the API.\n"
277"value is a string that specifies the new value.\n"
278"\n"
279"This method can also set additional value and type information for the\n"
280"specified key. The key identified by the key parameter must have been\n"
281"opened with KEY_SET_VALUE access.\n"
282"\n"
283"To open the key, use the CreateKeyEx() or OpenKeyEx() methods.\n"
284"\n"
285"Value lengths are limited by available memory. Long values (more than\n"
286"2048 bytes) should be stored as files with the filenames stored in \n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000287"the configuration registry. This helps the registry perform efficiently.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000288
289/* PyHKEY docstrings */
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000290PyDoc_STRVAR(PyHKEY_doc,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000291"PyHKEY Object - A Python object, representing a win32 registry key.\n"
292"\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000293"This object wraps a Windows HKEY object, automatically closing it when\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000294"the object is destroyed. To guarantee cleanup, you can call either\n"
295"the Close() method on the PyHKEY, or the CloseKey() method.\n"
296"\n"
297"All functions which accept a handle object also accept an integer - \n"
298"however, use of the handle object is encouraged.\n"
299"\n"
300"Functions:\n"
301"Close() - Closes the underlying handle.\n"
302"Detach() - Returns the integer Win32 handle, detaching it from the object\n"
303"\n"
304"Properties:\n"
305"handle - The integer Win32 handle.\n"
306"\n"
307"Operations:\n"
Jack Diederich4dafcc42006-11-28 19:15:13 +0000308"__bool__ - Handles with an open object return true, otherwise false.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000309"__int__ - Converting a handle to an integer returns the Win32 handle.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000310"__cmp__ - Handle objects are compared using the handle value.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000311
312
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000313PyDoc_STRVAR(PyHKEY_Close_doc,
Mark Hammondb422f952000-06-09 06:01:47 +0000314"key.Close() - Closes the underlying Windows handle.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000315"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000316"If the handle is already closed, no error is raised.");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000317
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000318PyDoc_STRVAR(PyHKEY_Detach_doc,
Mark Hammondb422f952000-06-09 06:01:47 +0000319"int = key.Detach() - Detaches the Windows handle from the handle object.\n"
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000320"\n"
321"The result is the value of the handle before it is detached. If the\n"
322"handle is already detached, this will return zero.\n"
323"\n"
324"After calling this function, the handle is effectively invalidated,\n"
325"but the handle is not closed. You would call this function when you\n"
326"need the underlying win32 handle to exist beyond the lifetime of the\n"
Mark Hammondb422f952000-06-09 06:01:47 +0000327"handle object.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +0000328"On 64 bit windows, the result of this function is a long integer");
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000329
330
331/************************************************************************
332
333 The PyHKEY object definition
334
335************************************************************************/
336typedef struct {
337 PyObject_VAR_HEAD
338 HKEY hkey;
339} PyHKEYObject;
340
341#define PyHKEY_Check(op) ((op)->ob_type == &PyHKEY_Type)
342
343static char *failMsg = "bad operand type";
344
345static PyObject *
346PyHKEY_unaryFailureFunc(PyObject *ob)
347{
348 PyErr_SetString(PyExc_TypeError, failMsg);
349 return NULL;
350}
351static PyObject *
352PyHKEY_binaryFailureFunc(PyObject *ob1, PyObject *ob2)
353{
354 PyErr_SetString(PyExc_TypeError, failMsg);
355 return NULL;
356}
357static PyObject *
358PyHKEY_ternaryFailureFunc(PyObject *ob1, PyObject *ob2, PyObject *ob3)
359{
360 PyErr_SetString(PyExc_TypeError, failMsg);
361 return NULL;
362}
363
364static void
365PyHKEY_deallocFunc(PyObject *ob)
366{
367 /* Can not call PyHKEY_Close, as the ob->tp_type
368 has already been cleared, thus causing the type
369 check to fail!
370 */
371 PyHKEYObject *obkey = (PyHKEYObject *)ob;
372 if (obkey->hkey)
373 RegCloseKey((HKEY)obkey->hkey);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000374 PyObject_DEL(ob);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000375}
376
377static int
Jack Diederich4dafcc42006-11-28 19:15:13 +0000378PyHKEY_boolFunc(PyObject *ob)
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000379{
380 return ((PyHKEYObject *)ob)->hkey != 0;
381}
382
383static PyObject *
384PyHKEY_intFunc(PyObject *ob)
385{
386 PyHKEYObject *pyhkey = (PyHKEYObject *)ob;
387 return PyLong_FromVoidPtr(pyhkey->hkey);
388}
389
390static int
391PyHKEY_printFunc(PyObject *ob, FILE *fp, int flags)
392{
393 PyHKEYObject *pyhkey = (PyHKEYObject *)ob;
394 char resBuf[160];
395 wsprintf(resBuf, "<PyHKEY at %p (%p)>",
396 ob, pyhkey->hkey);
397 fputs(resBuf, fp);
398 return 0;
399}
400
401static PyObject *
402PyHKEY_strFunc(PyObject *ob)
403{
404 PyHKEYObject *pyhkey = (PyHKEYObject *)ob;
405 char resBuf[160];
406 wsprintf(resBuf, "<PyHKEY:%p>", pyhkey->hkey);
407 return PyString_FromString(resBuf);
408}
409
410static int
411PyHKEY_compareFunc(PyObject *ob1, PyObject *ob2)
412{
413 PyHKEYObject *pyhkey1 = (PyHKEYObject *)ob1;
414 PyHKEYObject *pyhkey2 = (PyHKEYObject *)ob2;
415 return pyhkey1 == pyhkey2 ? 0 :
416 (pyhkey1 < pyhkey2 ? -1 : 1);
417}
418
419static long
420PyHKEY_hashFunc(PyObject *ob)
421{
422 /* Just use the address.
423 XXX - should we use the handle value?
424 */
Fred Drake13634cf2000-06-29 19:17:04 +0000425 return _Py_HashPointer(ob);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000426}
427
428
429static PyNumberMethods PyHKEY_NumberMethods =
430{
431 PyHKEY_binaryFailureFunc, /* nb_add */
432 PyHKEY_binaryFailureFunc, /* nb_subtract */
433 PyHKEY_binaryFailureFunc, /* nb_multiply */
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000434 PyHKEY_binaryFailureFunc, /* nb_remainder */
435 PyHKEY_binaryFailureFunc, /* nb_divmod */
436 PyHKEY_ternaryFailureFunc, /* nb_power */
437 PyHKEY_unaryFailureFunc, /* nb_negative */
438 PyHKEY_unaryFailureFunc, /* nb_positive */
439 PyHKEY_unaryFailureFunc, /* nb_absolute */
Jack Diederich4dafcc42006-11-28 19:15:13 +0000440 PyHKEY_boolFunc, /* nb_bool */
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000441 PyHKEY_unaryFailureFunc, /* nb_invert */
442 PyHKEY_binaryFailureFunc, /* nb_lshift */
443 PyHKEY_binaryFailureFunc, /* nb_rshift */
444 PyHKEY_binaryFailureFunc, /* nb_and */
445 PyHKEY_binaryFailureFunc, /* nb_xor */
446 PyHKEY_binaryFailureFunc, /* nb_or */
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000447 PyHKEY_intFunc, /* nb_int */
448 PyHKEY_unaryFailureFunc, /* nb_long */
449 PyHKEY_unaryFailureFunc, /* nb_float */
450 PyHKEY_unaryFailureFunc, /* nb_oct */
451 PyHKEY_unaryFailureFunc, /* nb_hex */
452};
453
454
455/* fwd declare __getattr__ */
Tim Petersc3d12ac2005-12-24 06:03:06 +0000456static PyObject *PyHKEY_getattr(PyObject *self, const char *name);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000457
458/* The type itself */
459PyTypeObject PyHKEY_Type =
460{
461 PyObject_HEAD_INIT(0) /* fill in type at module init */
462 0,
463 "PyHKEY",
464 sizeof(PyHKEYObject),
465 0,
466 PyHKEY_deallocFunc, /* tp_dealloc */
467 PyHKEY_printFunc, /* tp_print */
468 PyHKEY_getattr, /* tp_getattr */
469 0, /* tp_setattr */
470 PyHKEY_compareFunc, /* tp_compare */
471 0, /* tp_repr */
472 &PyHKEY_NumberMethods, /* tp_as_number */
473 0, /* tp_as_sequence */
474 0, /* tp_as_mapping */
475 PyHKEY_hashFunc, /* tp_hash */
476 0, /* tp_call */
477 PyHKEY_strFunc, /* tp_str */
478 0, /* tp_getattro */
479 0, /* tp_setattro */
480 0, /* tp_as_buffer */
481 0, /* tp_flags */
482 PyHKEY_doc, /* tp_doc */
483};
484
485#define OFF(e) offsetof(PyHKEYObject, e)
486
487static struct memberlist PyHKEY_memberlist[] = {
488 {"handle", T_INT, OFF(hkey)},
489 {NULL} /* Sentinel */
490};
491
492/************************************************************************
493
494 The PyHKEY object methods
495
496************************************************************************/
497static PyObject *
498PyHKEY_CloseMethod(PyObject *self, PyObject *args)
499{
500 if (!PyArg_ParseTuple(args, ":Close"))
501 return NULL;
502 if (!PyHKEY_Close(self))
503 return NULL;
504 Py_INCREF(Py_None);
505 return Py_None;
506}
507
508static PyObject *
509PyHKEY_DetachMethod(PyObject *self, PyObject *args)
510{
511 void* ret;
512 PyHKEYObject *pThis = (PyHKEYObject *)self;
513 if (!PyArg_ParseTuple(args, ":Detach"))
514 return NULL;
515 ret = (void*)pThis->hkey;
516 pThis->hkey = 0;
517 return PyLong_FromVoidPtr(ret);
518}
519
520static struct PyMethodDef PyHKEY_methods[] = {
Neal Norwitz031829d2002-03-31 14:37:44 +0000521 {"Close", PyHKEY_CloseMethod, METH_VARARGS, PyHKEY_Close_doc},
522 {"Detach", PyHKEY_DetachMethod, METH_VARARGS, PyHKEY_Detach_doc},
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000523 {NULL}
524};
525
526/*static*/ PyObject *
Tim Petersc3d12ac2005-12-24 06:03:06 +0000527PyHKEY_getattr(PyObject *self, const char *name)
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000528{
529 PyObject *res;
530
531 res = Py_FindMethod(PyHKEY_methods, self, name);
532 if (res != NULL)
533 return res;
534 PyErr_Clear();
535 if (strcmp(name, "handle") == 0)
536 return PyLong_FromVoidPtr(((PyHKEYObject *)self)->hkey);
537 return PyMember_Get((char *)self, PyHKEY_memberlist, name);
538}
539
540/************************************************************************
541 The public PyHKEY API (well, not public yet :-)
542************************************************************************/
543PyObject *
544PyHKEY_New(HKEY hInit)
545{
546 PyHKEYObject *key = PyObject_NEW(PyHKEYObject, &PyHKEY_Type);
547 if (key)
548 key->hkey = hInit;
549 return (PyObject *)key;
550}
551
552BOOL
553PyHKEY_Close(PyObject *ob_handle)
554{
555 LONG rc;
556 PyHKEYObject *key;
557
558 if (!PyHKEY_Check(ob_handle)) {
559 PyErr_SetString(PyExc_TypeError, "bad operand type");
560 return FALSE;
561 }
562 key = (PyHKEYObject *)ob_handle;
563 rc = key->hkey ? RegCloseKey((HKEY)key->hkey) : ERROR_SUCCESS;
564 key->hkey = 0;
565 if (rc != ERROR_SUCCESS)
566 PyErr_SetFromWindowsErrWithFunction(rc, "RegCloseKey");
567 return rc == ERROR_SUCCESS;
568}
569
570BOOL
571PyHKEY_AsHKEY(PyObject *ob, HKEY *pHANDLE, BOOL bNoneOK)
572{
573 if (ob == Py_None) {
574 if (!bNoneOK) {
575 PyErr_SetString(
576 PyExc_TypeError,
577 "None is not a valid HKEY in this context");
578 return FALSE;
579 }
580 *pHANDLE = (HKEY)0;
581 }
582 else if (PyHKEY_Check(ob)) {
583 PyHKEYObject *pH = (PyHKEYObject *)ob;
584 *pHANDLE = pH->hkey;
585 }
586 else if (PyInt_Check(ob) || PyLong_Check(ob)) {
587 /* We also support integers */
588 PyErr_Clear();
589 *pHANDLE = (HKEY)PyLong_AsVoidPtr(ob);
590 if (PyErr_Occurred())
591 return FALSE;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000592 }
593 else {
594 PyErr_SetString(
595 PyExc_TypeError,
596 "The object is not a PyHKEY object");
597 return FALSE;
598 }
599 return TRUE;
600}
601
602PyObject *
603PyHKEY_FromHKEY(HKEY h)
604{
Guido van Rossumb18618d2000-05-03 23:44:39 +0000605 PyHKEYObject *op;
606
Guido van Rossume3a8e7e2002-08-19 19:26:42 +0000607 /* Inline PyObject_New */
Guido van Rossumb18618d2000-05-03 23:44:39 +0000608 op = (PyHKEYObject *) PyObject_MALLOC(sizeof(PyHKEYObject));
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000609 if (op == NULL)
610 return PyErr_NoMemory();
Guido van Rossumb18618d2000-05-03 23:44:39 +0000611 PyObject_INIT(op, &PyHKEY_Type);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000612 op->hkey = h;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000613 return (PyObject *)op;
614}
615
616
617/************************************************************************
618 The module methods
619************************************************************************/
620BOOL
621PyWinObject_CloseHKEY(PyObject *obHandle)
622{
623 BOOL ok;
624 if (PyHKEY_Check(obHandle)) {
625 ok = PyHKEY_Close(obHandle);
626 }
Fred Drake25e17262000-06-30 17:48:51 +0000627#if SIZEOF_LONG >= SIZEOF_HKEY
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000628 else if (PyInt_Check(obHandle)) {
629 long rc = RegCloseKey((HKEY)PyInt_AsLong(obHandle));
630 ok = (rc == ERROR_SUCCESS);
631 if (!ok)
632 PyErr_SetFromWindowsErrWithFunction(rc, "RegCloseKey");
633 }
Fred Drake25e17262000-06-30 17:48:51 +0000634#else
635 else if (PyLong_Check(obHandle)) {
636 long rc = RegCloseKey((HKEY)PyLong_AsVoidPtr(obHandle));
637 ok = (rc == ERROR_SUCCESS);
638 if (!ok)
639 PyErr_SetFromWindowsErrWithFunction(rc, "RegCloseKey");
640 }
641#endif
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000642 else {
643 PyErr_SetString(
644 PyExc_TypeError,
645 "A handle must be a HKEY object or an integer");
646 return FALSE;
647 }
648 return ok;
649}
650
651
652/*
653 Private Helper functions for the registry interfaces
654
655** Note that fixupMultiSZ and countString have both had changes
656** made to support "incorrect strings". The registry specification
657** calls for strings to be terminated with 2 null bytes. It seems
Thomas Wouters7e474022000-07-16 12:04:32 +0000658** some commercial packages install strings which dont conform,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000659** causing this code to fail - however, "regedit" etc still work
660** with these strings (ie only we dont!).
661*/
662static void
663fixupMultiSZ(char **str, char *data, int len)
664{
665 char *P;
666 int i;
667 char *Q;
668
669 Q = data + len;
670 for (P = data, i = 0; P < Q && *P != '\0'; P++, i++) {
671 str[i] = P;
672 for(; *P != '\0'; P++)
673 ;
674 }
675}
676
677static int
678countStrings(char *data, int len)
679{
680 int strings;
681 char *P;
682 char *Q = data + len;
683
684 for (P = data, strings = 0; P < Q && *P != '\0'; P++, strings++)
685 for (; P < Q && *P != '\0'; P++)
686 ;
687 return strings;
688}
689
690/* Convert PyObject into Registry data.
691 Allocates space as needed. */
692static BOOL
693Py2Reg(PyObject *value, DWORD typ, BYTE **retDataBuf, DWORD *retDataSize)
694{
695 int i,j;
696 switch (typ) {
697 case REG_DWORD:
698 if (value != Py_None && !PyInt_Check(value))
699 return FALSE;
Guido van Rossumd8faa362007-04-27 19:54:29 +0000700 *retDataBuf = (BYTE *)PyMem_NEW(DWORD, 1);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000701 if (*retDataBuf==NULL){
702 PyErr_NoMemory();
703 return FALSE;
704 }
705 *retDataSize = sizeof(DWORD);
706 if (value == Py_None) {
707 DWORD zero = 0;
708 memcpy(*retDataBuf, &zero, sizeof(DWORD));
709 }
710 else
711 memcpy(*retDataBuf,
712 &PyInt_AS_LONG((PyIntObject *)value),
713 sizeof(DWORD));
714 break;
715 case REG_SZ:
716 case REG_EXPAND_SZ:
717 {
718 int need_decref = 0;
719 if (value == Py_None)
720 *retDataSize = 1;
721 else {
722 if (PyUnicode_Check(value)) {
723 value = PyUnicode_AsEncodedString(
724 value,
725 "mbcs",
726 NULL);
727 if (value==NULL)
728 return FALSE;
729 need_decref = 1;
730 }
731 if (!PyString_Check(value))
732 return FALSE;
733 *retDataSize = 1 + strlen(
734 PyString_AS_STRING(
735 (PyStringObject *)value));
736 }
737 *retDataBuf = (BYTE *)PyMem_NEW(DWORD, *retDataSize);
738 if (*retDataBuf==NULL){
739 PyErr_NoMemory();
740 return FALSE;
741 }
742 if (value == Py_None)
743 strcpy((char *)*retDataBuf, "");
744 else
745 strcpy((char *)*retDataBuf,
746 PyString_AS_STRING(
747 (PyStringObject *)value));
748 if (need_decref)
749 Py_DECREF(value);
750 break;
751 }
752 case REG_MULTI_SZ:
753 {
754 DWORD size = 0;
755 char *P;
756 PyObject **obs = NULL;
757
758 if (value == Py_None)
759 i = 0;
760 else {
761 if (!PyList_Check(value))
762 return FALSE;
763 i = PyList_Size(value);
764 }
765 obs = malloc(sizeof(PyObject *) * i);
766 memset(obs, 0, sizeof(PyObject *) * i);
767 for (j = 0; j < i; j++)
768 {
769 PyObject *t;
770 t = PyList_GET_ITEM(
771 (PyListObject *)value,j);
772 if (PyString_Check(t)) {
773 obs[j] = t;
774 Py_INCREF(t);
775 } else if (PyUnicode_Check(t)) {
776 obs[j] = PyUnicode_AsEncodedString(
777 t,
778 "mbcs",
779 NULL);
780 if (obs[j]==NULL)
781 goto reg_multi_fail;
782 } else
783 goto reg_multi_fail;
784 size += 1 + strlen(
785 PyString_AS_STRING(
786 (PyStringObject *)obs[j]));
787 }
788
789 *retDataSize = size + 1;
790 *retDataBuf = (BYTE *)PyMem_NEW(char,
791 *retDataSize);
792 if (*retDataBuf==NULL){
793 PyErr_NoMemory();
794 goto reg_multi_fail;
795 }
796 P = (char *)*retDataBuf;
797
798 for (j = 0; j < i; j++)
799 {
800 PyObject *t;
801 t = obs[j];
802 strcpy(P,
803 PyString_AS_STRING(
804 (PyStringObject *)t));
805 P += 1 + strlen(
806 PyString_AS_STRING(
807 (PyStringObject *)t));
808 Py_DECREF(obs[j]);
809 }
810 /* And doubly-terminate the list... */
811 *P = '\0';
812 free(obs);
813 break;
814 reg_multi_fail:
815 if (obs) {
816 for (j = 0; j < i; j++)
817 Py_XDECREF(obs[j]);
818
819 free(obs);
820 }
821 return FALSE;
822 }
823 case REG_BINARY:
824 /* ALSO handle ALL unknown data types here. Even if we can't
825 support it natively, we should handle the bits. */
826 default:
827 if (value == Py_None)
828 *retDataSize = 0;
829 else {
Mark Hammond4e80bb52000-07-28 03:44:41 +0000830 void *src_buf;
831 PyBufferProcs *pb = value->ob_type->tp_as_buffer;
832 if (pb==NULL) {
Tim Peters313fcd42006-02-19 04:05:39 +0000833 PyErr_Format(PyExc_TypeError,
Mark Hammond4e80bb52000-07-28 03:44:41 +0000834 "Objects of type '%s' can not "
Tim Peters313fcd42006-02-19 04:05:39 +0000835 "be used as binary registry values",
Mark Hammond4e80bb52000-07-28 03:44:41 +0000836 value->ob_type->tp_name);
837 return FALSE;
838 }
839 *retDataSize = (*pb->bf_getreadbuffer)(value, 0, &src_buf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000840 *retDataBuf = (BYTE *)PyMem_NEW(char,
841 *retDataSize);
842 if (*retDataBuf==NULL){
843 PyErr_NoMemory();
844 return FALSE;
845 }
Mark Hammond4e80bb52000-07-28 03:44:41 +0000846 memcpy(*retDataBuf, src_buf, *retDataSize);
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000847 }
848 break;
849 }
850 return TRUE;
851}
852
853/* Convert Registry data into PyObject*/
854static PyObject *
855Reg2Py(char *retDataBuf, DWORD retDataSize, DWORD typ)
856{
857 PyObject *obData;
858
859 switch (typ) {
860 case REG_DWORD:
861 if (retDataSize == 0)
862 obData = Py_BuildValue("i", 0);
863 else
864 obData = Py_BuildValue("i",
865 *(int *)retDataBuf);
866 break;
867 case REG_SZ:
868 case REG_EXPAND_SZ:
869 /* retDataBuf may or may not have a trailing NULL in
870 the buffer. */
871 if (retDataSize && retDataBuf[retDataSize-1] == '\0')
872 --retDataSize;
873 if (retDataSize ==0)
874 retDataBuf = "";
875 obData = PyUnicode_DecodeMBCS(retDataBuf,
876 retDataSize,
877 NULL);
878 break;
879 case REG_MULTI_SZ:
880 if (retDataSize == 0)
881 obData = PyList_New(0);
882 else
883 {
884 int index = 0;
885 int s = countStrings(retDataBuf, retDataSize);
886 char **str = (char **)malloc(sizeof(char *)*s);
887 if (str == NULL)
888 return PyErr_NoMemory();
889
890 fixupMultiSZ(str, retDataBuf, retDataSize);
891 obData = PyList_New(s);
Fred Drake25e17262000-06-30 17:48:51 +0000892 if (obData == NULL)
893 return NULL;
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000894 for (index = 0; index < s; index++)
895 {
Fred Drake25e17262000-06-30 17:48:51 +0000896 size_t len = _mbstrlen(str[index]);
897 if (len > INT_MAX) {
898 PyErr_SetString(PyExc_OverflowError,
899 "registry string is too long for a Python string");
900 Py_DECREF(obData);
901 return NULL;
902 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000903 PyList_SetItem(obData,
904 index,
905 PyUnicode_DecodeMBCS(
906 (const char *)str[index],
Fred Drake25e17262000-06-30 17:48:51 +0000907 (int)len,
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000908 NULL)
909 );
910 }
911 free(str);
912
913 break;
914 }
915 case REG_BINARY:
916 /* ALSO handle ALL unknown data types here. Even if we can't
917 support it natively, we should handle the bits. */
918 default:
919 if (retDataSize == 0) {
920 Py_INCREF(Py_None);
921 obData = Py_None;
922 }
923 else
924 obData = Py_BuildValue("s#",
925 (char *)retDataBuf,
926 retDataSize);
927 break;
928 }
929 if (obData == NULL)
930 return NULL;
931 else
932 return obData;
933}
934
935/* The Python methods */
936
937static PyObject *
938PyCloseKey(PyObject *self, PyObject *args)
939{
940 PyObject *obKey;
941 if (!PyArg_ParseTuple(args, "O:CloseKey", &obKey))
942 return NULL;
943 if (!PyHKEY_Close(obKey))
944 return NULL;
945 Py_INCREF(Py_None);
946 return Py_None;
947}
948
949static PyObject *
950PyConnectRegistry(PyObject *self, PyObject *args)
951{
952 HKEY hKey;
953 PyObject *obKey;
954 char *szCompName = NULL;
955 HKEY retKey;
956 long rc;
957 if (!PyArg_ParseTuple(args, "zO:ConnectRegistry", &szCompName, &obKey))
958 return NULL;
959 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
960 return NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000961 Py_BEGIN_ALLOW_THREADS
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000962 rc = RegConnectRegistry(szCompName, hKey, &retKey);
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000963 Py_END_ALLOW_THREADS
Guido van Rossum9f3712c2000-03-28 20:37:15 +0000964 if (rc != ERROR_SUCCESS)
965 return PyErr_SetFromWindowsErrWithFunction(rc,
966 "ConnectRegistry");
967 return PyHKEY_FromHKEY(retKey);
968}
969
970static PyObject *
971PyCreateKey(PyObject *self, PyObject *args)
972{
973 HKEY hKey;
974 PyObject *obKey;
975 char *subKey;
976 HKEY retKey;
977 long rc;
978 if (!PyArg_ParseTuple(args, "Oz:CreateKey", &obKey, &subKey))
979 return NULL;
980 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
981 return NULL;
982 rc = RegCreateKey(hKey, subKey, &retKey);
983 if (rc != ERROR_SUCCESS)
984 return PyErr_SetFromWindowsErrWithFunction(rc, "CreateKey");
985 return PyHKEY_FromHKEY(retKey);
986}
987
988static PyObject *
989PyDeleteKey(PyObject *self, PyObject *args)
990{
991 HKEY hKey;
992 PyObject *obKey;
993 char *subKey;
994 long rc;
995 if (!PyArg_ParseTuple(args, "Os:DeleteKey", &obKey, &subKey))
996 return NULL;
997 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
998 return NULL;
999 rc = RegDeleteKey(hKey, subKey );
1000 if (rc != ERROR_SUCCESS)
1001 return PyErr_SetFromWindowsErrWithFunction(rc, "RegDeleteKey");
1002 Py_INCREF(Py_None);
1003 return Py_None;
1004}
1005
1006static PyObject *
1007PyDeleteValue(PyObject *self, PyObject *args)
1008{
1009 HKEY hKey;
1010 PyObject *obKey;
1011 char *subKey;
1012 long rc;
1013 if (!PyArg_ParseTuple(args, "Oz:DeleteValue", &obKey, &subKey))
1014 return NULL;
1015 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1016 return NULL;
1017 Py_BEGIN_ALLOW_THREADS
1018 rc = RegDeleteValue(hKey, subKey);
1019 Py_END_ALLOW_THREADS
1020 if (rc !=ERROR_SUCCESS)
1021 return PyErr_SetFromWindowsErrWithFunction(rc,
1022 "RegDeleteValue");
1023 Py_INCREF(Py_None);
1024 return Py_None;
1025}
1026
1027static PyObject *
1028PyEnumKey(PyObject *self, PyObject *args)
1029{
1030 HKEY hKey;
1031 PyObject *obKey;
1032 int index;
1033 long rc;
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001034 PyObject *retStr;
Georg Brandl9a928e72006-02-18 23:35:11 +00001035 char tmpbuf[256]; /* max key name length is 255 */
Georg Brandlb2699b22006-02-18 23:44:24 +00001036 DWORD len = sizeof(tmpbuf); /* includes NULL terminator */
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001037
1038 if (!PyArg_ParseTuple(args, "Oi:EnumKey", &obKey, &index))
1039 return NULL;
1040 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1041 return NULL;
Tim Peters313fcd42006-02-19 04:05:39 +00001042
Georg Brandl9a928e72006-02-18 23:35:11 +00001043 Py_BEGIN_ALLOW_THREADS
1044 rc = RegEnumKeyEx(hKey, index, tmpbuf, &len, NULL, NULL, NULL, NULL);
1045 Py_END_ALLOW_THREADS
1046 if (rc != ERROR_SUCCESS)
1047 return PyErr_SetFromWindowsErrWithFunction(rc, "RegEnumKeyEx");
Tim Peters313fcd42006-02-19 04:05:39 +00001048
Georg Brandl9a928e72006-02-18 23:35:11 +00001049 retStr = PyString_FromStringAndSize(tmpbuf, len);
1050 return retStr; /* can be NULL */
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001051}
1052
1053static PyObject *
1054PyEnumValue(PyObject *self, PyObject *args)
1055{
1056 HKEY hKey;
1057 PyObject *obKey;
1058 int index;
1059 long rc;
1060 char *retValueBuf;
1061 char *retDataBuf;
1062 DWORD retValueSize;
1063 DWORD retDataSize;
1064 DWORD typ;
1065 PyObject *obData;
1066 PyObject *retVal;
1067
1068 if (!PyArg_ParseTuple(args, "Oi:EnumValue", &obKey, &index))
1069 return NULL;
1070 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1071 return NULL;
1072
1073 if ((rc = RegQueryInfoKey(hKey, NULL, NULL, NULL, NULL, NULL, NULL,
1074 NULL,
1075 &retValueSize, &retDataSize, NULL, NULL))
1076 != ERROR_SUCCESS)
1077 return PyErr_SetFromWindowsErrWithFunction(rc,
1078 "RegQueryInfoKey");
1079 ++retValueSize; /* include null terminators */
1080 ++retDataSize;
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001081 retValueBuf = (char *)PyMem_Malloc(retValueSize);
1082 if (retValueBuf == NULL)
1083 return PyErr_NoMemory();
1084 retDataBuf = (char *)PyMem_Malloc(retDataSize);
1085 if (retDataBuf == NULL) {
1086 PyMem_Free(retValueBuf);
1087 return PyErr_NoMemory();
1088 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001089
1090 Py_BEGIN_ALLOW_THREADS
1091 rc = RegEnumValue(hKey,
1092 index,
1093 retValueBuf,
1094 &retValueSize,
1095 NULL,
1096 &typ,
1097 (BYTE *)retDataBuf,
1098 &retDataSize);
1099 Py_END_ALLOW_THREADS
1100
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001101 if (rc != ERROR_SUCCESS) {
1102 retVal = PyErr_SetFromWindowsErrWithFunction(rc,
1103 "PyRegEnumValue");
1104 goto fail;
1105 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001106 obData = Reg2Py(retDataBuf, retDataSize, typ);
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001107 if (obData == NULL) {
1108 retVal = NULL;
1109 goto fail;
1110 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001111 retVal = Py_BuildValue("sOi", retValueBuf, obData, typ);
1112 Py_DECREF(obData);
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001113 fail:
1114 PyMem_Free(retValueBuf);
1115 PyMem_Free(retDataBuf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001116 return retVal;
1117}
1118
1119static PyObject *
1120PyFlushKey(PyObject *self, PyObject *args)
1121{
1122 HKEY hKey;
1123 PyObject *obKey;
1124 long rc;
1125 if (!PyArg_ParseTuple(args, "O:FlushKey", &obKey))
1126 return NULL;
1127 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1128 return NULL;
1129 Py_BEGIN_ALLOW_THREADS
1130 rc = RegFlushKey(hKey);
1131 Py_END_ALLOW_THREADS
1132 if (rc != ERROR_SUCCESS)
1133 return PyErr_SetFromWindowsErrWithFunction(rc, "RegFlushKey");
1134 Py_INCREF(Py_None);
1135 return Py_None;
1136}
1137static PyObject *
1138PyLoadKey(PyObject *self, PyObject *args)
1139{
1140 HKEY hKey;
1141 PyObject *obKey;
1142 char *subKey;
1143 char *fileName;
1144
1145 long rc;
1146 if (!PyArg_ParseTuple(args, "Oss:LoadKey", &obKey, &subKey, &fileName))
1147 return NULL;
1148 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1149 return NULL;
1150 Py_BEGIN_ALLOW_THREADS
1151 rc = RegLoadKey(hKey, subKey, fileName );
1152 Py_END_ALLOW_THREADS
1153 if (rc != ERROR_SUCCESS)
1154 return PyErr_SetFromWindowsErrWithFunction(rc, "RegLoadKey");
1155 Py_INCREF(Py_None);
1156 return Py_None;
1157}
1158
1159static PyObject *
1160PyOpenKey(PyObject *self, PyObject *args)
1161{
1162 HKEY hKey;
1163 PyObject *obKey;
1164
1165 char *subKey;
1166 int res = 0;
1167 HKEY retKey;
1168 long rc;
1169 REGSAM sam = KEY_READ;
1170 if (!PyArg_ParseTuple(args, "Oz|ii:OpenKey", &obKey, &subKey,
1171 &res, &sam))
1172 return NULL;
1173 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1174 return NULL;
1175
1176 Py_BEGIN_ALLOW_THREADS
1177 rc = RegOpenKeyEx(hKey, subKey, res, sam, &retKey);
1178 Py_END_ALLOW_THREADS
1179 if (rc != ERROR_SUCCESS)
1180 return PyErr_SetFromWindowsErrWithFunction(rc, "RegOpenKeyEx");
1181 return PyHKEY_FromHKEY(retKey);
1182}
1183
1184
1185static PyObject *
1186PyQueryInfoKey(PyObject *self, PyObject *args)
1187{
1188 HKEY hKey;
1189 PyObject *obKey;
1190 long rc;
1191 DWORD nSubKeys, nValues;
1192 FILETIME ft;
1193 LARGE_INTEGER li;
1194 PyObject *l;
1195 PyObject *ret;
1196 if (!PyArg_ParseTuple(args, "O:QueryInfoKey", &obKey))
1197 return NULL;
1198 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1199 return NULL;
1200 if ((rc = RegQueryInfoKey(hKey, NULL, NULL, 0, &nSubKeys, NULL, NULL,
1201 &nValues, NULL, NULL, NULL, &ft))
1202 != ERROR_SUCCESS)
1203 return PyErr_SetFromWindowsErrWithFunction(rc, "RegQueryInfoKey");
1204 li.LowPart = ft.dwLowDateTime;
1205 li.HighPart = ft.dwHighDateTime;
1206 l = PyLong_FromLongLong(li.QuadPart);
1207 if (l == NULL)
1208 return NULL;
1209 ret = Py_BuildValue("iiO", nSubKeys, nValues, l);
1210 Py_DECREF(l);
1211 return ret;
1212}
1213
1214static PyObject *
1215PyQueryValue(PyObject *self, PyObject *args)
1216{
1217 HKEY hKey;
1218 PyObject *obKey;
1219 char *subKey;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001220 long rc;
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001221 PyObject *retStr;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001222 char *retBuf;
1223 long bufSize = 0;
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001224
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001225 if (!PyArg_ParseTuple(args, "Oz:QueryValue", &obKey, &subKey))
1226 return NULL;
1227
1228 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1229 return NULL;
1230 if ((rc = RegQueryValue(hKey, subKey, NULL, &bufSize))
1231 != ERROR_SUCCESS)
1232 return PyErr_SetFromWindowsErrWithFunction(rc,
1233 "RegQueryValue");
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001234 retStr = PyString_FromStringAndSize(NULL, bufSize);
1235 if (retStr == NULL)
1236 return NULL;
1237 retBuf = PyString_AS_STRING(retStr);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001238 if ((rc = RegQueryValue(hKey, subKey, retBuf, &bufSize))
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001239 != ERROR_SUCCESS) {
1240 Py_DECREF(retStr);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001241 return PyErr_SetFromWindowsErrWithFunction(rc,
1242 "RegQueryValue");
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001243 }
1244 _PyString_Resize(&retStr, strlen(retBuf));
1245 return retStr;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001246}
1247
1248static PyObject *
1249PyQueryValueEx(PyObject *self, PyObject *args)
1250{
1251 HKEY hKey;
1252 PyObject *obKey;
1253 char *valueName;
1254
1255 long rc;
1256 char *retBuf;
1257 DWORD bufSize = 0;
1258 DWORD typ;
1259 PyObject *obData;
1260 PyObject *result;
1261
1262 if (!PyArg_ParseTuple(args, "Oz:QueryValueEx", &obKey, &valueName))
1263 return NULL;
1264
1265 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1266 return NULL;
1267 if ((rc = RegQueryValueEx(hKey, valueName,
1268 NULL, NULL, NULL,
1269 &bufSize))
1270 != ERROR_SUCCESS)
1271 return PyErr_SetFromWindowsErrWithFunction(rc,
1272 "RegQueryValueEx");
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001273 retBuf = (char *)PyMem_Malloc(bufSize);
1274 if (retBuf == NULL)
1275 return PyErr_NoMemory();
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001276 if ((rc = RegQueryValueEx(hKey, valueName, NULL,
1277 &typ, (BYTE *)retBuf, &bufSize))
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001278 != ERROR_SUCCESS) {
1279 PyMem_Free(retBuf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001280 return PyErr_SetFromWindowsErrWithFunction(rc,
1281 "RegQueryValueEx");
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001282 }
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001283 obData = Reg2Py(retBuf, bufSize, typ);
Guido van Rossuma6a38ad2003-11-30 22:01:43 +00001284 PyMem_Free((void *)retBuf);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001285 if (obData == NULL)
1286 return NULL;
1287 result = Py_BuildValue("Oi", obData, typ);
1288 Py_DECREF(obData);
1289 return result;
1290}
1291
1292
1293static PyObject *
1294PySaveKey(PyObject *self, PyObject *args)
1295{
1296 HKEY hKey;
1297 PyObject *obKey;
1298 char *fileName;
1299 LPSECURITY_ATTRIBUTES pSA = NULL;
1300
1301 long rc;
1302 if (!PyArg_ParseTuple(args, "Os:SaveKey", &obKey, &fileName))
1303 return NULL;
1304 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1305 return NULL;
1306/* One day we may get security into the core?
1307 if (!PyWinObject_AsSECURITY_ATTRIBUTES(obSA, &pSA, TRUE))
1308 return NULL;
1309*/
1310 Py_BEGIN_ALLOW_THREADS
1311 rc = RegSaveKey(hKey, fileName, pSA );
1312 Py_END_ALLOW_THREADS
1313 if (rc != ERROR_SUCCESS)
1314 return PyErr_SetFromWindowsErrWithFunction(rc, "RegSaveKey");
1315 Py_INCREF(Py_None);
1316 return Py_None;
1317}
1318
1319static PyObject *
1320PySetValue(PyObject *self, PyObject *args)
1321{
1322 HKEY hKey;
1323 PyObject *obKey;
1324 char *subKey;
1325 char *str;
1326 DWORD typ;
1327 DWORD len;
1328 long rc;
1329 PyObject *obStrVal;
1330 PyObject *obSubKey;
1331 if (!PyArg_ParseTuple(args, "OOiO:SetValue",
1332 &obKey,
1333 &obSubKey,
1334 &typ,
1335 &obStrVal))
1336 return NULL;
1337 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1338 return NULL;
1339 if (typ != REG_SZ) {
1340 PyErr_SetString(PyExc_TypeError,
Thomas Hellere1d18f52002-12-20 20:13:35 +00001341 "Type must be _winreg.REG_SZ");
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001342 return NULL;
1343 }
1344 /* XXX - need Unicode support */
1345 str = PyString_AsString(obStrVal);
1346 if (str == NULL)
1347 return NULL;
1348 len = PyString_Size(obStrVal);
1349 if (obSubKey == Py_None)
1350 subKey = NULL;
1351 else {
1352 subKey = PyString_AsString(obSubKey);
1353 if (subKey == NULL)
1354 return NULL;
1355 }
1356 Py_BEGIN_ALLOW_THREADS
1357 rc = RegSetValue(hKey, subKey, REG_SZ, str, len+1);
1358 Py_END_ALLOW_THREADS
1359 if (rc != ERROR_SUCCESS)
1360 return PyErr_SetFromWindowsErrWithFunction(rc, "RegSetValue");
1361 Py_INCREF(Py_None);
1362 return Py_None;
1363}
1364
1365static PyObject *
1366PySetValueEx(PyObject *self, PyObject *args)
1367{
1368 HKEY hKey;
1369 PyObject *obKey;
1370 char *valueName;
1371 PyObject *obRes;
1372 PyObject *value;
1373 BYTE *data;
1374 DWORD len;
1375 DWORD typ;
1376
1377 LONG rc;
1378
1379 if (!PyArg_ParseTuple(args, "OzOiO:SetValueEx",
1380 &obKey,
1381 &valueName,
1382 &obRes,
1383 &typ,
1384 &value))
1385 return NULL;
1386 if (!PyHKEY_AsHKEY(obKey, &hKey, FALSE))
1387 return NULL;
1388 if (!Py2Reg(value, typ, &data, &len))
1389 {
1390 if (!PyErr_Occurred())
1391 PyErr_SetString(PyExc_ValueError,
1392 "Could not convert the data to the specified type.");
1393 return NULL;
1394 }
1395 Py_BEGIN_ALLOW_THREADS
1396 rc = RegSetValueEx(hKey, valueName, 0, typ, data, len);
1397 Py_END_ALLOW_THREADS
Guido van Rossumb18618d2000-05-03 23:44:39 +00001398 PyMem_DEL(data);
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001399 if (rc != ERROR_SUCCESS)
1400 return PyErr_SetFromWindowsErrWithFunction(rc,
1401 "RegSetValueEx");
1402 Py_INCREF(Py_None);
1403 return Py_None;
1404}
1405
1406static struct PyMethodDef winreg_methods[] = {
Neal Norwitz031829d2002-03-31 14:37:44 +00001407 {"CloseKey", PyCloseKey, METH_VARARGS, CloseKey_doc},
1408 {"ConnectRegistry", PyConnectRegistry, METH_VARARGS, ConnectRegistry_doc},
1409 {"CreateKey", PyCreateKey, METH_VARARGS, CreateKey_doc},
1410 {"DeleteKey", PyDeleteKey, METH_VARARGS, DeleteKey_doc},
1411 {"DeleteValue", PyDeleteValue, METH_VARARGS, DeleteValue_doc},
1412 {"EnumKey", PyEnumKey, METH_VARARGS, EnumKey_doc},
1413 {"EnumValue", PyEnumValue, METH_VARARGS, EnumValue_doc},
1414 {"FlushKey", PyFlushKey, METH_VARARGS, FlushKey_doc},
1415 {"LoadKey", PyLoadKey, METH_VARARGS, LoadKey_doc},
1416 {"OpenKey", PyOpenKey, METH_VARARGS, OpenKey_doc},
1417 {"OpenKeyEx", PyOpenKey, METH_VARARGS, OpenKeyEx_doc},
1418 {"QueryValue", PyQueryValue, METH_VARARGS, QueryValue_doc},
1419 {"QueryValueEx", PyQueryValueEx, METH_VARARGS, QueryValueEx_doc},
1420 {"QueryInfoKey", PyQueryInfoKey, METH_VARARGS, QueryInfoKey_doc},
1421 {"SaveKey", PySaveKey, METH_VARARGS, SaveKey_doc},
1422 {"SetValue", PySetValue, METH_VARARGS, SetValue_doc},
1423 {"SetValueEx", PySetValueEx, METH_VARARGS, SetValueEx_doc},
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001424 NULL,
1425};
1426
1427static void
1428insint(PyObject * d, char * name, long value)
1429{
1430 PyObject *v = PyInt_FromLong(value);
1431 if (!v || PyDict_SetItemString(d, name, v))
1432 PyErr_Clear();
1433 Py_XDECREF(v);
1434}
1435
1436#define ADD_INT(val) insint(d, #val, val)
1437
1438static void
1439inskey(PyObject * d, char * name, HKEY key)
1440{
1441 PyObject *v = PyLong_FromVoidPtr(key);
1442 if (!v || PyDict_SetItemString(d, name, v))
1443 PyErr_Clear();
1444 Py_XDECREF(v);
1445}
1446
1447#define ADD_KEY(val) inskey(d, #val, val)
1448
Mark Hammond8235ea12002-07-19 06:55:41 +00001449PyMODINIT_FUNC init_winreg(void)
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001450{
1451 PyObject *m, *d;
Fred Drake270e19b2000-06-29 16:14:14 +00001452 m = Py_InitModule3("_winreg", winreg_methods, module_doc);
Neal Norwitz1ac754f2006-01-19 06:09:39 +00001453 if (m == NULL)
1454 return;
Guido van Rossum9f3712c2000-03-28 20:37:15 +00001455 d = PyModule_GetDict(m);
1456 PyHKEY_Type.ob_type = &PyType_Type;
1457 PyHKEY_Type.tp_doc = PyHKEY_doc;
1458 Py_INCREF(&PyHKEY_Type);
1459 if (PyDict_SetItemString(d, "HKEYType",
1460 (PyObject *)&PyHKEY_Type) != 0)
1461 return;
1462 Py_INCREF(PyExc_WindowsError);
1463 if (PyDict_SetItemString(d, "error",
1464 PyExc_WindowsError) != 0)
1465 return;
1466
1467 /* Add the relevant constants */
1468 ADD_KEY(HKEY_CLASSES_ROOT);
1469 ADD_KEY(HKEY_CURRENT_USER);
1470 ADD_KEY(HKEY_LOCAL_MACHINE);
1471 ADD_KEY(HKEY_USERS);
1472 ADD_KEY(HKEY_PERFORMANCE_DATA);
1473#ifdef HKEY_CURRENT_CONFIG
1474 ADD_KEY(HKEY_CURRENT_CONFIG);
1475#endif
1476#ifdef HKEY_DYN_DATA
1477 ADD_KEY(HKEY_DYN_DATA);
1478#endif
1479 ADD_INT(KEY_QUERY_VALUE);
1480 ADD_INT(KEY_SET_VALUE);
1481 ADD_INT(KEY_CREATE_SUB_KEY);
1482 ADD_INT(KEY_ENUMERATE_SUB_KEYS);
1483 ADD_INT(KEY_NOTIFY);
1484 ADD_INT(KEY_CREATE_LINK);
1485 ADD_INT(KEY_READ);
1486 ADD_INT(KEY_WRITE);
1487 ADD_INT(KEY_EXECUTE);
1488 ADD_INT(KEY_ALL_ACCESS);
1489 ADD_INT(REG_OPTION_RESERVED);
1490 ADD_INT(REG_OPTION_NON_VOLATILE);
1491 ADD_INT(REG_OPTION_VOLATILE);
1492 ADD_INT(REG_OPTION_CREATE_LINK);
1493 ADD_INT(REG_OPTION_BACKUP_RESTORE);
1494 ADD_INT(REG_OPTION_OPEN_LINK);
1495 ADD_INT(REG_LEGAL_OPTION);
1496 ADD_INT(REG_CREATED_NEW_KEY);
1497 ADD_INT(REG_OPENED_EXISTING_KEY);
1498 ADD_INT(REG_WHOLE_HIVE_VOLATILE);
1499 ADD_INT(REG_REFRESH_HIVE);
1500 ADD_INT(REG_NO_LAZY_FLUSH);
1501 ADD_INT(REG_NOTIFY_CHANGE_NAME);
1502 ADD_INT(REG_NOTIFY_CHANGE_ATTRIBUTES);
1503 ADD_INT(REG_NOTIFY_CHANGE_LAST_SET);
1504 ADD_INT(REG_NOTIFY_CHANGE_SECURITY);
1505 ADD_INT(REG_LEGAL_CHANGE_FILTER);
1506 ADD_INT(REG_NONE);
1507 ADD_INT(REG_SZ);
1508 ADD_INT(REG_EXPAND_SZ);
1509 ADD_INT(REG_BINARY);
1510 ADD_INT(REG_DWORD);
1511 ADD_INT(REG_DWORD_LITTLE_ENDIAN);
1512 ADD_INT(REG_DWORD_BIG_ENDIAN);
1513 ADD_INT(REG_LINK);
1514 ADD_INT(REG_MULTI_SZ);
1515 ADD_INT(REG_RESOURCE_LIST);
1516 ADD_INT(REG_FULL_RESOURCE_DESCRIPTOR);
1517 ADD_INT(REG_RESOURCE_REQUIREMENTS_LIST);
1518}
1519