home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 July / CMCD0704.ISO / Software / Shareware / Comunicatii / jyte / jyte.exe / regutil.py < prev    next >
Text File  |  2002-01-08  |  11KB  |  285 lines
  1. # Some registry helpers.
  2. import win32api
  3. import win32con
  4. import sys
  5. import os
  6.  
  7. error = "Registry utility error"
  8.  
  9. # A .py file has a CLSID associated with it (why? - dunno!)
  10. CLSIDPyFile = "{b51df050-06ae-11cf-ad3b-524153480001}"
  11.  
  12. RegistryIDPyFile = "Python.File" # The registry "file type" of a .py file
  13. RegistryIDPycFile = "Python.CompiledFile" # The registry "file type" of a .pyc file
  14.  
  15. def GetRootKey():
  16.     """Retrieves the Registry root in use by Python.
  17.     """
  18. # Win32s no longer supported/released.
  19. #    if win32ui.IsWin32s():
  20. #        return win32con.HKEY_CLASSES_ROOT
  21. #    else:
  22.     return win32con.HKEY_LOCAL_MACHINE
  23.  
  24. def GetRegistryDefaultValue(subkey, rootkey = None):
  25.     """A helper to return the default value for a key in the registry.
  26.         """
  27.     if rootkey is None: rootkey = GetRootKey()
  28.     return win32api.RegQueryValue(rootkey, subkey)
  29.  
  30. def SetRegistryDefaultValue(subKey, value, rootkey = None):
  31.     """A helper to set the default value for a key in the registry
  32.         """
  33.     import types
  34.     if rootkey is None: rootkey = GetRootKey()
  35.     if type(value)==types.StringType:
  36.         typeId = win32con.REG_SZ
  37.     elif type(value)==types.IntType:
  38.         typeId = win32con.REG_DWORD
  39.     else:
  40.         raise TypeError, "Value must be string or integer - was passed " + str(value)
  41.  
  42.     win32api.RegSetValue(rootkey, subKey, typeId ,value)
  43.     
  44. def BuildDefaultPythonKey():
  45.     """Builds a string containing the path to the current registry key.
  46.  
  47.        The Python registry key contains the Python version.  This function
  48.        uses the version of the DLL used by the current process to get the
  49.        registry key currently in use.
  50.         """
  51.  
  52.     return "Software\\Python\\PythonCore\\" + sys.winver
  53.  
  54. def GetAppPathsKey():
  55.     return "Software\\Microsoft\\Windows\\CurrentVersion\\App Paths"
  56.  
  57. def RegisterPythonExe(exeFullPath, exeAlias = None, exeAppPath = None):
  58.     """Register a .exe file that uses Python.
  59.  
  60.        Registers the .exe with the OS.  This allows the specified .exe to
  61.        be run from the command-line or start button without using the full path,
  62.        and also to setup application specific path (ie, os.environ['PATH']).
  63.  
  64.        Currently the exeAppPath is not supported, so this function is general
  65.        purpose, and not specific to Python at all.  Later, exeAppPath may provide
  66.        a reasonable default that is used.
  67.  
  68.        exeFullPath -- The full path to the .exe
  69.        exeAlias = None -- An alias for the exe - if none, the base portion
  70.                  of the filename is used.
  71.        exeAppPath -- Not supported.
  72.     """
  73.     # Note - Dont work on win32s (but we dont care anymore!)
  74.     if exeAppPath:
  75.         raise error, "Do not support exeAppPath argument currently"
  76.     if exeAlias is None:
  77.         exeAlias = os.path.basename(exeFullPath)
  78.     win32api.RegSetValue(GetRootKey(), GetAppPathsKey() + "\\" + exeAlias, win32con.REG_SZ, exeFullPath)
  79.  
  80. def GetRegisteredExe(exeAlias):
  81.     """Get a registered .exe
  82.     """
  83.     return win32api.RegQueryValue(GetRootKey(), GetAppPathsKey() + "\\" + exeAlias)
  84.  
  85. def UnregisterPythonExe(exeAlias):
  86.     """Unregister a .exe file that uses Python.
  87.     """
  88.     try:
  89.         win32api.RegDeleteKey(GetRootKey(), GetAppPathsKey() + "\\" + exeAlias)
  90.     except win32api.error, (code, fn, details):
  91.         import winerror
  92.         if code!=winerror.ERROR_FILE_NOT_FOUND:
  93.             raise win32api.error, (code, fn, desc)
  94.         return
  95.  
  96. def RegisterNamedPath(name, path):
  97.     """Register a named path - ie, a named PythonPath entry.
  98.     """
  99.     keyStr = BuildDefaultPythonKey() + "\\PythonPath"
  100.     if name: keyStr = keyStr + "\\" + name
  101.     win32api.RegSetValue(GetRootKey(), keyStr, win32con.REG_SZ, path)
  102.  
  103. def UnregisterNamedPath(name):
  104.     """Unregister a named path - ie, a named PythonPath entry.
  105.     """
  106.     keyStr = BuildDefaultPythonKey() + "\\PythonPath\\" + name
  107.     try:
  108.         win32api.RegDeleteKey(GetRootKey(), keyStr)
  109.     except win32api.error, (code, fn, details):
  110.         import winerror
  111.         if code!=winerror.ERROR_FILE_NOT_FOUND:
  112.             raise win32api.error, (code, fn, desc)
  113.         return
  114.  
  115. def GetRegisteredNamedPath(name):
  116.     """Get a registered named path, or None if it doesnt exist.
  117.     """
  118.     keyStr = BuildDefaultPythonKey() + "\\PythonPath"
  119.     if name: keyStr = keyStr + "\\" + name
  120.     try:
  121.         return win32api.RegQueryValue(GetRootKey(), keyStr)
  122.     except win32api.error, (code, fn, details):
  123.         import winerror
  124.         if code!=winerror.ERROR_FILE_NOT_FOUND:
  125.             raise win32api.error, (code, fn, details)
  126.         return None
  127.  
  128.  
  129. def RegisterModule(modName, modPath):
  130.     """Register an explicit module in the registry.  This forces the Python import
  131.            mechanism to locate this module directly, without a sys.path search.  Thus
  132.            a registered module need not appear in sys.path at all.
  133.  
  134.        modName -- The name of the module, as used by import.
  135.        modPath -- The full path and file name of the module.
  136.     """
  137.     try:
  138.         import os
  139.         os.stat(modPath)
  140.     except os.error:
  141.         print "Warning: Registering non-existant module %s" % modPath
  142.     win32api.RegSetValue(GetRootKey(), 
  143.                          BuildDefaultPythonKey() + "\\Modules\\%s" % modName,
  144.         win32con.REG_SZ, modPath)
  145.  
  146. def UnregisterModule(modName):
  147.     """Unregister an explicit module in the registry.
  148.  
  149.        modName -- The name of the module, as used by import.
  150.     """
  151.     try:
  152.         win32api.RegDeleteKey(GetRootKey(), 
  153.                              BuildDefaultPythonKey() + "\\Modules\\%s" % modName)
  154.     except win32api.error, (code, fn, desc):
  155.         import winerror
  156.         if code!=winerror.ERROR_FILE_NOT_FOUND:
  157.             raise win32api.error, (code, fn, desc)
  158.  
  159. def GetRegisteredHelpFile(helpDesc):
  160.     """Given a description, return the registered entry.
  161.     """
  162.     try:
  163.         return GetRegistryDefaultValue(BuildDefaultPythonKey() + "\\Help\\" + helpDesc)
  164.     except win32api.error:
  165.         try:
  166.             return GetRegistryDefaultValue(BuildDefaultPythonKey() + "\\Help\\" + helpDesc, win32con.HKEY_CURRENT_USER)
  167.         except win32api.error:
  168.             pass
  169.     return None
  170.  
  171. def RegisterHelpFile(helpFile, helpPath, helpDesc = None, bCheckFile = 1):
  172.     """Register a help file in the registry.
  173.     
  174.          Note that this used to support writing to the Windows Help
  175.          key, however this is no longer done, as it seems to be incompatible.
  176.  
  177.            helpFile -- the base name of the help file.
  178.            helpPath -- the path to the help file
  179.            helpDesc -- A description for the help file.  If None, the helpFile param is used.
  180.            bCheckFile -- A flag indicating if the file existence should be checked.
  181.     """
  182.     if helpDesc is None: helpDesc = helpFile
  183.     fullHelpFile = os.path.join(helpPath, helpFile)
  184.     try:
  185.         if bCheckFile: os.stat(fullHelpFile)
  186.     except os.error:
  187.         raise ValueError, "Help file does not exist"
  188.     # Now register with Python itself.
  189.     win32api.RegSetValue(GetRootKey(), 
  190.                          BuildDefaultPythonKey() + "\\Help\\%s" % helpDesc, win32con.REG_SZ, fullHelpFile)
  191.  
  192. def UnregisterHelpFile(helpFile, helpDesc = None):
  193.     """Unregister a help file in the registry.
  194.  
  195.            helpFile -- the base name of the help file.
  196.            helpDesc -- A description for the help file.  If None, the helpFile param is used.
  197.     """
  198.     key = win32api.RegOpenKey(win32con.HKEY_LOCAL_MACHINE, "Software\\Microsoft\\Windows\\Help", 0, win32con.KEY_ALL_ACCESS)
  199.     try:
  200.         try:
  201.             win32api.RegDeleteValue(key, helpFile)
  202.         except win32api.error, (code, fn, desc):
  203.             import winerror
  204.             if code!=winerror.ERROR_FILE_NOT_FOUND:
  205.                 raise win32api.error, (code, fn, desc)
  206.     finally:
  207.         win32api.RegCloseKey(key)
  208.     
  209.     # Now de-register with Python itself.
  210.     if helpDesc is None: helpDesc = helpFile
  211.     try:
  212.         win32api.RegDeleteKey(GetRootKey(), 
  213.                              BuildDefaultPythonKey() + "\\Help\\%s" % helpDesc)    
  214.     except win32api.error, (code, fn, desc):
  215.         import winerror
  216.         if code!=winerror.ERROR_FILE_NOT_FOUND:
  217.             raise win32api.error, (code, fn, desc)
  218.  
  219. def RegisterCoreDLL(coredllName = None):
  220.     """Registers the core DLL in the registry.
  221.  
  222.         If no params are passed, the name of the Python DLL used in 
  223.         the current process is used and registered.
  224.     """
  225.     if coredllName is None:
  226.         coredllName = win32api.GetModuleFileName(sys.dllhandle)
  227.         # must exist!
  228.     else:
  229.         try:
  230.             os.stat(coredllName)
  231.         except os.error:
  232.             print "Warning: Registering non-existant core DLL %s" % coredllName
  233.  
  234.     hKey = win32api.RegCreateKey(GetRootKey() , BuildDefaultPythonKey())
  235.     try:
  236.         win32api.RegSetValue(hKey, "Dll", win32con.REG_SZ, coredllName)
  237.     finally:
  238.         win32api.RegCloseKey(hKey)
  239.     # Lastly, setup the current version to point to me.
  240.     win32api.RegSetValue(GetRootKey(), "Software\\Python\\PythonCore\\CurrentVersion", win32con.REG_SZ, sys.winver)
  241.  
  242. def RegisterFileExtensions(defPyIcon, defPycIcon, runCommand):
  243.     """Register the core Python file extensions.
  244.     
  245.        defPyIcon -- The default icon to use for .py files, in 'fname,offset' format.
  246.        defPycIcon -- The default icon to use for .pyc files, in 'fname,offset' format.
  247.        runCommand -- The command line to use for running .py files
  248.     """
  249.     # Register the file extensions.
  250.     pythonFileId = RegistryIDPyFile
  251.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , ".py", win32con.REG_SZ, pythonFileId)
  252.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , pythonFileId , win32con.REG_SZ, "Python File")
  253.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , "%s\\CLSID" % pythonFileId , win32con.REG_SZ, CLSIDPyFile)
  254.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , "%s\\DefaultIcon" % pythonFileId, win32con.REG_SZ, defPyIcon)
  255.     base = "%s\\Shell" % RegistryIDPyFile
  256.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , base + "\\Open", win32con.REG_SZ, "Run")
  257.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , base + "\\Open\\Command", win32con.REG_SZ, runCommand)
  258.  
  259.     # Register the .PYC.
  260.     pythonFileId = RegistryIDPycFile
  261.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , ".pyc", win32con.REG_SZ, pythonFileId)
  262.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , pythonFileId , win32con.REG_SZ, "Compiled Python File")
  263.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , "%s\\DefaultIcon" % pythonFileId, win32con.REG_SZ, defPycIcon)
  264.     base = "%s\\Shell" % pythonFileId
  265.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , base + "\\Open", win32con.REG_SZ, "Run")
  266.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , base + "\\Open\\Command", win32con.REG_SZ, runCommand)
  267.  
  268. def RegisterShellCommand(shellCommand, exeCommand, shellUserCommand = None):
  269.     # Last param for "Open" - for a .py file to be executed by the command line
  270.     # or shell execute (eg, just entering "foo.py"), the Command must be "Open",
  271.     # but you may associate a different name for the right-click menu.
  272.     # In our case, normally we have "Open=Run"
  273.     base = "%s\\Shell" % RegistryIDPyFile
  274.     if shellUserCommand:
  275.         win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , base + "\\%s" % (shellCommand), win32con.REG_SZ, shellUserCommand)
  276.  
  277.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , base + "\\%s\\Command" % (shellCommand), win32con.REG_SZ, exeCommand)
  278.  
  279. def RegisterDDECommand(shellCommand, ddeApp, ddeTopic, ddeCommand):
  280.     base = "%s\\Shell" % RegistryIDPyFile
  281.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , base + "\\%s\\ddeexec" % (shellCommand), win32con.REG_SZ, ddeCommand)
  282.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , base + "\\%s\\ddeexec\\Application" % (shellCommand), win32con.REG_SZ, ddeApp)
  283.     win32api.RegSetValue(win32con.HKEY_CLASSES_ROOT , base + "\\%s\\ddeexec\\Topic" % (shellCommand), win32con.REG_SZ, ddeTopic)
  284.  
  285.