From: robk-tahoe Date: Fri, 11 Jan 2008 02:03:23 +0000 (-0700) Subject: move registry module into allmydata.windows package X-Git-Url: https://git.rkrishnan.org/components/com_hotproperty/%22doc.html/architecture.txt?a=commitdiff_plain;h=fbf6c48ed86915c6379fa5f0fac201dd4e5c2c73;p=tahoe-lafs%2Ftahoe-lafs.git move registry module into allmydata.windows package --- diff --git a/src/allmydata/windows/__init__.py b/src/allmydata/windows/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/src/allmydata/windows/registry.py b/src/allmydata/windows/registry.py new file mode 100644 index 00000000..2b87689b --- /dev/null +++ b/src/allmydata/windows/registry.py @@ -0,0 +1,77 @@ +import sys +import _winreg + +_AMD_KEY = r"Software\Allmydata" +_BDIR_KEY = 'Base Dir Path' + +if sys.platform not in ('win32'): + raise ImportError, "registry cannot be used on non-windows systems" + class WindowsError(Exception): # stupid voodoo to appease pyflakes + pass + +def get_registry_setting(key, name, _topkey=None): + """ + This function iterates through _topkey (if not None), + HKEY_CURRENT_USER, and HKEY_LOCAL_MACHINE before giving up. + + @note: Only supports string values. + + @param key: The key we are searching. + @type key: String + + @param name: The name of the setting we are querying. + @type name: String + """ + topkeys = [_winreg.HKEY_CURRENT_USER, _winreg.HKEY_LOCAL_MACHINE] + + if _topkey: + topkeys.insert(0, _topkey) + + for topkey in topkeys: + try: + regkey = _winreg.OpenKey(topkey, key) + + sublen, vallen, timestamp = _winreg.QueryInfoKey(regkey) + for validx in xrange(vallen): + keyname, value, keytype = _winreg.EnumValue(regkey, validx) + if keyname == name and keytype == _winreg.REG_SZ: + return value + + except WindowsError: + continue + # We didn't find the key: + raise KeyError, (key, name, "registry setting not found") + +def set_registry_setting(key, name, data, reg_type=_winreg.REG_SZ, + _topkey=_winreg.HKEY_LOCAL_MACHINE, create_key_if_missing=True): + """ + Sets a registry setting. + + defaults to string values (REG_SZ) - overridable with reg_type. + """ + try: + regkey = _winreg.OpenKey(_topkey, key, 0, _winreg.KEY_SET_VALUE) + except WindowsError: + if create_key_if_missing: + regkey = _winreg.CreateKey(_topkey, key) + else: + raise KeyError, (key, "registry key not found") + + try: + _winreg.DeleteValue(regkey, name) + except: + pass + + _winreg.SetValueEx(regkey, name, 0, reg_type, data) + +def get_registry_value(keyname): + """ + retrieves a registry key value from within the Software/Allmydata Inc key + """ + try: + return get_registry_setting(_AMD_KEY, keyname) + except KeyError: + return None + +def get_base_dir_path(): + return get_registry_value(_BDIR_KEY) diff --git a/windows/registry.py b/windows/registry.py deleted file mode 100644 index 2b87689b..00000000 --- a/windows/registry.py +++ /dev/null @@ -1,77 +0,0 @@ -import sys -import _winreg - -_AMD_KEY = r"Software\Allmydata" -_BDIR_KEY = 'Base Dir Path' - -if sys.platform not in ('win32'): - raise ImportError, "registry cannot be used on non-windows systems" - class WindowsError(Exception): # stupid voodoo to appease pyflakes - pass - -def get_registry_setting(key, name, _topkey=None): - """ - This function iterates through _topkey (if not None), - HKEY_CURRENT_USER, and HKEY_LOCAL_MACHINE before giving up. - - @note: Only supports string values. - - @param key: The key we are searching. - @type key: String - - @param name: The name of the setting we are querying. - @type name: String - """ - topkeys = [_winreg.HKEY_CURRENT_USER, _winreg.HKEY_LOCAL_MACHINE] - - if _topkey: - topkeys.insert(0, _topkey) - - for topkey in topkeys: - try: - regkey = _winreg.OpenKey(topkey, key) - - sublen, vallen, timestamp = _winreg.QueryInfoKey(regkey) - for validx in xrange(vallen): - keyname, value, keytype = _winreg.EnumValue(regkey, validx) - if keyname == name and keytype == _winreg.REG_SZ: - return value - - except WindowsError: - continue - # We didn't find the key: - raise KeyError, (key, name, "registry setting not found") - -def set_registry_setting(key, name, data, reg_type=_winreg.REG_SZ, - _topkey=_winreg.HKEY_LOCAL_MACHINE, create_key_if_missing=True): - """ - Sets a registry setting. - - defaults to string values (REG_SZ) - overridable with reg_type. - """ - try: - regkey = _winreg.OpenKey(_topkey, key, 0, _winreg.KEY_SET_VALUE) - except WindowsError: - if create_key_if_missing: - regkey = _winreg.CreateKey(_topkey, key) - else: - raise KeyError, (key, "registry key not found") - - try: - _winreg.DeleteValue(regkey, name) - except: - pass - - _winreg.SetValueEx(regkey, name, 0, reg_type, data) - -def get_registry_value(keyname): - """ - retrieves a registry key value from within the Software/Allmydata Inc key - """ - try: - return get_registry_setting(_AMD_KEY, keyname) - except KeyError: - return None - -def get_base_dir_path(): - return get_registry_value(_BDIR_KEY) diff --git a/windows/tahoesvc.py b/windows/tahoesvc.py index 1b830e7c..d338b95d 100644 --- a/windows/tahoesvc.py +++ b/windows/tahoesvc.py @@ -23,7 +23,7 @@ logmsg('service loaded') # Now with some bootstrap util functions in place, let's try and init things: try: logmsg('loading base dir') - import registry + from allmydata.windows import registry basedir = registry.get_base_dir_path() logmsg("got base dir (%s)" % (basedir,)) if not basedir: