#!/usr/bin/env python # Copyright (c) 2005-2010 ActiveState Software Inc. # License: MIT """Cross-platform application utilities. Mainly this includes some method for determining application-specific dirs. Utility Functions: user_data_dir(...) path to user-specific app data dir site_data_dir(...) path to all users shared app data dir user_cache_dir(...) path to user-specific app cache dir """ # Dev Notes: # - MSDN on where to store app data files: # http://support.microsoft.com/default.aspx?scid=kb;en-us;310294#XSLTH3194121123120121120120 # #TODO: # - Add cross-platform versions of other abstracted dir locations, like # a prefs dir, something like bundle/Contents/SharedSupport # on OS X, etc. # http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/Concepts/UserPreferences.html # http://developer.apple.com/documentation/MacOSX/Conceptual/BPFileSystem/index.html # http://msdn.microsoft.com/library/default.asp?url=/library/en-us/shellcc/platform/shell/reference/enums/csidl.asp __version_info__ = (1, 0, 1) __version__ = '.'.join(map(str, __version_info__)) __author__ = "Trent Mick" import sys import os class Error(Exception): pass def user_data_dir(appname, owner=None, version=None, csidl=None): """Return full path to the user-specific data dir for this application. "appname" is the name of application. "owner" (only required and used on Windows) is the name of the owner or distributing body for this application. Typically it is the owning company name. "version" is an optional version path element to append to the path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be ".". "csidl" is an optional special folder to use - only applies to Windows. Typical user data directories are: Win XP: C:\Documents and Settings\USER\Application Data\\ Mac OS X: ~/Library/Application Support/ Unix: ~/. From Windows NT and onwards, the user data directory was split into the local app data directory and the roaming app data directory. Komodo 6 uses the local one for it's user data directory - Komodo 5 used the roaming one. For Unix there is no *real* standard here. For example, Firefox uses: "~/.mozilla/firefox" which is a "~/./"-type scheme. """ if sys.platform.startswith("win"): if owner is None: raise Error("must specify 'owner' on Windows") path = os.path.join(_get_win_folder(csidl or "CSIDL_LOCAL_APPDATA"), owner, appname) elif sys.platform == 'darwin': #XXX Folder.FSFindFolder() fails with error -43 on x86. See 42669. basepath = os.path.expanduser('~/Library/Application Support') path = os.path.join(basepath, appname) else: path = os.path.expanduser("~/." + appname.lower()) if version: path = os.path.join(path, version) return path def roaming_user_data_dir(appname, owner=None, version=None): """Retrieve the Komodo 5 user data directory.""" return user_data_dir(appname, owner=owner, version=version, csidl="CSIDL_APPDATA") def site_data_dir(appname, owner=None, version=None): """Return full path to the user-shared data dir for this application. "appname" is the name of application. "owner" (only required and used on Windows) is the name of the owner or distributing body for this application. Typically it is the owning company name. "version" is an optional version path element to append to the path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be ".". Typical user data directories are: Win XP: C:\Documents and Settings\All Users\Application Data\\ Mac OS X: /Library/Application Support/ Unix: /etc/ """ if sys.platform.startswith("win"): if owner is None: raise Error("must specify 'owner' on Windows") path = os.path.join(_get_win_folder("CSIDL_COMMON_APPDATA"), owner, appname) elif sys.platform == 'darwin': basepath = os.path.expanduser('/Library/Application Support') path = os.path.join(basepath, appname) else: path = "/etc/"+appname.lower() if version: path = os.path.join(path, version) return path def user_cache_dir(appname, owner=None, version=None): """Return full path to the user-specific cache dir for this application. "appname" is the name of application. "owner" (only required and used on Windows) is the name of the owner or distributing body for this application. Typically it is the owning company name. "version" is an optional version path element to append to the path. You might want to use this if you want multiple versions of your app to be able to run independently. If used, this would typically be ".". Typical user cache directories are: Win XP: C:\Documents and Settings\USER\Local Settings\Application Data\\ Mac OS X: ~/Library/Caches/ Unix: ~/./caches For Unix there is no *real* standard here. Note that we are returning the *same dir as the user_data_dir()* for Unix. Use accordingly. """ if sys.platform.startswith("win"): if owner is None: raise Error("must specify 'owner' on Windows") path = os.path.join(_get_win_folder("CSIDL_LOCAL_APPDATA"), owner, appname) elif sys.platform == 'darwin': basepath = os.path.expanduser('~/Library/Caches') path = os.path.join(basepath, appname) else: path = os.path.expanduser("~/.%s/caches" % appname.lower()) if version: path = os.path.join(path, version) return path #---- internal support stuff def _get_win_folder_from_registry(csidl_name): """This is a fallback technique at best. I'm not sure if using the registry for this guarantees us the correct answer for all CSIDL_* names. """ import _winreg shell_folder_name = { "CSIDL_APPDATA": "AppData", "CSIDL_COMMON_APPDATA": "Common AppData", "CSIDL_LOCAL_APPDATA": "Local AppData", }[csidl_name] key = _winreg.OpenKey(_winreg.HKEY_CURRENT_USER, r"Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders") dir, type = _winreg.QueryValueEx(key, shell_folder_name) return dir def _get_win_folder_with_ctypes(csidl_name): import ctypes csidl_const = { "CSIDL_APPDATA": 26, "CSIDL_COMMON_APPDATA": 35, "CSIDL_LOCAL_APPDATA": 28, }[csidl_name] buf = ctypes.create_unicode_buffer(1024) ctypes.windll.shell32.SHGetFolderPathW(None, csidl_const, None, 0, buf) has_high_char = False for c in buf: if ord(c) > 255: has_high_char = True break if has_high_char: buf2 = ctypes.create_unicode_buffer(1024) if ctypes.windll.kernel32.GetShortPathNameW(buf.value, buf2, 1024): buf = buf2 return buf.value if sys.platform == "win32": try: import ctypes _get_win_folder = _get_win_folder_with_ctypes except ImportError: _get_win_folder = _get_win_folder_from_registry #---- self test code if __name__ == "__main__": print "applib: user data dir:", user_data_dir("Komodo", "ActiveState") print "applib: site data dir:", site_data_dir("Komodo", "ActiveState") print "applib: user cache dir:", user_cache_dir("Komodo", "ActiveState")