diff engine/extensions/fife_utils.py @ 273:815354ba295e

* Added function to fife_utils: getUserDataDirectory. Returns the proper path to save setting and data files depending on OS. * Made rio_de_hola save its settings in the proper location.
author cheesesucker@33b003aa-7bff-0310-803a-e67f0ece8222
date Tue, 16 Jun 2009 14:24:26 +0000
parents 9a1529f9625e
children cf77afb273c4
line wrap: on
line diff
--- a/engine/extensions/fife_utils.py	Tue Jun 16 11:28:35 2009 +0000
+++ b/engine/extensions/fife_utils.py	Tue Jun 16 14:24:26 2009 +0000
@@ -1,13 +1,78 @@
-import fife, re
+import fife, re, sys, os
 
-__all__ = ['is_fife_exc']
+__all__ = ['is_fife_exc', 'getUserDataDirectory']
 
 _exc_re = re.compile(r'_\[(\w+)\]_')
 
+""" This file contains some functions that may be useful """
+
 def is_fife_exc(type, original_exc):
+	""" Checks if an exception is of given type.
+	Example:
+		try:
+			obj = self.model.createObject(str(id), str(nspace), parent)
+		except RuntimeError, e:
+			if is_fife_exc(fife.NameClash, e):
+				raise NameClash('Tried to create already existing object, ignoring')
+			raise
+	"""
 	ret = False
 	m = _exc_re.search(str(original_exc))
 	if m:
 		if m.group(1) == type('').getTypeStr():
 			ret = True
 	return ret
+
+def getUserDataDirectory(vendor, appname):
+	""" Gets the proper location to save configuration and data files, depending on depending on OS.
+	
+	Windows: %APPDATA%\vendor\appname
+	Mac: ~/Library/Application Support/vendor/appname
+	Linux/Unix/Other: ~/.vendor/appname
+	
+	See:
+	Brian Vanderburg II @ http://mail.python.org/pipermail/python-list/2008-May/660779.html
+	"""
+	dir = ""
+
+	# WINDOWS
+	if os.name == "nt":
+
+		# Try env APPDATA or USERPROFILE or HOMEDRIVE/HOMEPATH
+		if "APPDATA" in os.environ:
+			dir = os.environ["APPDATA"]
+
+		if ((dir is None) or (not os.path.isdir(dir))) and ("USERPROFILE" in os.environ):
+			dir = os.environ["USERPROFILE"]
+			if os.path.isdir(os.path.join(dir, "Application Data")):
+				dir = os.path.join(dir, "Application Data")
+
+		if ((dir is None) or (not os.path.isdir(dir))) and ("HOMEDRIVE" in os.environ) and ("HOMEPATH" in os.environ):
+			dir = os.environ["HOMEDRIVE"] + os.environ["HOMEPATH"]
+			if os.path.isdir(os.path.join(dir, "Application Data")):
+				dir = os.path.join(dir, "Application Data")
+
+		if (dir is None) or (not os.path.isdir(dir)):
+			dir = os.path.expanduser("~")
+			
+		# On windows, add vendor and app name
+		dir = os.path.join(dir, vendor, appname)
+
+	# Mac
+	elif os.name == "mac": # ?? may not be entirely correct
+		dir = os.path.expanduser("~")
+		dir = os.path.join(dir, "Library", "Application Support")
+		dir = os.path.join(dir, vendor, appname)
+
+	# Unix/Linux/all others
+	if dir is None:
+		dir = os.path.expanduser("~")
+		dir = os.path.join(dir, "."+vendor, appname)
+		
+	# Create vendor/appname folder if it doesn't exist
+	if not os.path.isdir(dir):
+		os.makedirs(dir)
+		
+	print dir
+
+	return dir