# -*- coding:utf-8 -*-
## src/common/configpaths.py
##
## Copyright (C) 2006 Jean-Marie Traissard <jim AT lapin.org>
##                    Junglecow J <junglecow AT gmail.com>
## Copyright (C) 2006-2007 Yann Leboulanger <asterix AT lagaule.org>
## Copyright (C) 2007 Brendan Taylor <whateley AT gmail.com>
## Copyright (C) 2008 Jonathan Schleifer <js-gajim AT webkeks.org>
##
## This file is part of Gajim.
##
## Gajim is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published
## by the Free Software Foundation; version 3 only.
##
## Gajim is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Gajim. If not, see <http://www.gnu.org/licenses/>.
##

import os
import sys
import tempfile
import defs
HAVE_XDG = True
try:
	import xdg.BaseDirectory
except:
	HAVE_XDG = False

(
TYPE_CONFIG,
TYPE_CACHE,
TYPE_DATA
) = range(3)

# Note on path and filename encodings:
#
# In general it is very difficult to do this correctly.
# We may pull information from environment variables, and what encoding that is
# in is anyone's guess. Any information we request directly from the file
# system will be in filesystemencoding, and (parts of) paths that we write in
# this source code will be in whatever encoding the source is in. (I hereby
# declare this file to be UTF-8 encoded.)
#
# To make things more complicated, modern Windows filesystems use UTF-16, but
# the API tends to hide this from us.
#
# I tried to minimize problems by passing Unicode strings to OS functions as
# much as possible. Hopefully this makes the function return an Unicode string
# as well. If not, we get an 8-bit string in filesystemencoding, which we can
# happily pass to functions that operate on files and directories, so we can
# just leave it as is. Since these paths are meant to be internal to Gajim and
# not displayed to the user, Unicode is not really necessary here.

def fse(s):
	"""
	Convert from filesystem encoding if not already Unicode
	"""
	return unicode(s, sys.getfilesystemencoding())

def windowsify(s):
	if os.name == 'nt':
		return s.capitalize()
	return s

class ConfigPaths:
	def __init__(self):
		# {'name': (type, path), } type can be TYPE_CONFIG, TYPE_CACHE, TYPE_DATA
		# or None
		self.paths = {}

		if os.name == 'nt':
			try:
				# Documents and Settings\[User Name]\Application Data\Gajim

				# How are we supposed to know what encoding the environment
				# variable 'appdata' is in? Assuming it to be in filesystem
				# encoding.
				self.config_root = self.cache_root = self.data_root = \
					os.path.join(fse(os.environ[u'appdata']), u'Gajim')
			except KeyError:
				# win9x, in cwd
				self.config_root = self.cache_root = self.data_root = u'.'
		else: # Unices
			# Pass in an Unicode string, and hopefully get one back.
			if HAVE_XDG:
				self.config_root = xdg.BaseDirectory.load_first_config('gajim')
				if not self.config_root:
					# Folder doesn't exist yet.
					self.config_root = os.path.join(xdg.BaseDirectory.\
						xdg_config_dirs[0], u'gajim')

				self.cache_root = os.path.join(xdg.BaseDirectory.xdg_cache_home,
					u'gajim')

				self.data_root = xdg.BaseDirectory.save_data_path('gajim')
				if not self.data_root:
					self.data_root = os.path.join(xdg.BaseDirectory.\
						xdg_data_dirs[0], u'gajim')
			else:
				expand = os.path.expanduser
				base = os.getenv('XDG_CONFIG_HOME') or expand(u'~/.config')
				self.config_root = os.path.join(base, u'gajim')
				base = os.getenv('XDG_CACHE_HOME') or expand(u'~/.cache')
				self.cache_root = os.path.join(base, u'gajim')
				base = os.getenv('XDG_DATA_HOME') or expand(u'~/.local/share')
				self.data_root = os.path.join(base, u'gajim')

	def add(self, name, type_, path):
		self.paths[name] = (type_, path)

	def __getitem__(self, key):
		type_, path = self.paths[key]
		if type_ == TYPE_CONFIG:
			return os.path.join(self.config_root, path)
		elif type_ == TYPE_CACHE:
			return os.path.join(self.cache_root, path)
		elif type_ == TYPE_DATA:
			return os.path.join(self.data_root, path)
		return path

	def get(self, key, default=None):
		try:
			return self[key]
		except KeyError:
			return default

	def iteritems(self):
		for key in self.paths.iterkeys():
			yield (key, self[key])

	def init(self, root=None):
		if root is not None:
			self.config_root = self.cache_root = self.data_root = root

		d = {'MY_DATA': '', 'LOG_DB': u'logs.db', 'MY_CACERTS': u'cacerts.pem',
			'MY_EMOTS': u'emoticons', 'MY_ICONSETS': u'iconsets',
			'MY_MOOD_ICONSETS': u'moods', 'MY_ACTIVITY_ICONSETS': u'activities'}
		for name in d:
			self.add(name, TYPE_DATA, windowsify(d[name]))

		d = {'MY_CACHE': '', 'CACHE_DB': u'cache.db', 'VCARD': u'vcards',
			'AVATAR': u'avatars'}
		for name in d:
			self.add(name, TYPE_CACHE, windowsify(d[name]))

		self.add('MY_CONFIG', TYPE_CONFIG, '')

		basedir = fse(os.environ.get(u'GAJIM_BASEDIR', defs.basedir))
		self.add('DATA', None, os.path.join(basedir, windowsify(u'data')))
		self.add('ICONS', None, os.path.join(basedir, windowsify(u'icons')))
		self.add('HOME', None, fse(os.path.expanduser('~')))
		try:
			self.add('TMP', None, fse(tempfile.gettempdir()))
		except IOError, e:
			print >> sys.stderr, 'Error opening tmp folder: %s\nUsing %s' % (
				str(e), os.path.expanduser('~'))
			self.add('TMP', None, fse(os.path.expanduser('~')))

		try:
			import svn_config
			svn_config.configure(self)
		except (ImportError, AttributeError):
			pass

	def init_profile(self, profile=''):
		conffile = windowsify(u'config')
		pidfile = windowsify(u'gajim')
		secretsfile = windowsify(u'secrets')

		if len(profile) > 0:
			conffile += u'.' + profile
			pidfile += u'.' + profile
			secretsfile += u'.' + profile
		pidfile += u'.pid'
		self.add('CONFIG_FILE', TYPE_CONFIG, conffile)
		self.add('PID_FILE', TYPE_CACHE, pidfile)
		self.add('SECRETS_FILE', TYPE_DATA, secretsfile)

gajimpaths = ConfigPaths()

# vim: se ts=3: