247 lines
8.6 KiB
Python
247 lines
8.6 KiB
Python
# Copyright (C) 2006 Jean-Marie Traissard <jim AT lapin.org>
|
|
# Junglecow J <junglecow AT gmail.com>
|
|
# Copyright (C) 2006-2014 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>
|
|
# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com>
|
|
#
|
|
# 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/>.
|
|
|
|
from typing import Dict # pylint: disable=unused-import
|
|
from typing import List
|
|
from typing import Generator
|
|
from typing import Optional # pylint: disable=unused-import
|
|
from typing import Tuple
|
|
|
|
import os
|
|
import sys
|
|
import tempfile
|
|
from pathlib import Path
|
|
|
|
import gajim
|
|
from gajim.common.i18n import _
|
|
from gajim.common.const import PathType, PathLocation
|
|
from gajim.common.types import PathTuple
|
|
|
|
|
|
def get(key: str) -> str:
|
|
return _paths[key]
|
|
|
|
|
|
def get_plugin_dirs() -> List[str]:
|
|
if gajim.IS_FLATPAK:
|
|
return ['/app/plugins',
|
|
_paths['PLUGINS_BASE']]
|
|
return [_paths['PLUGINS_BASE'],
|
|
_paths['PLUGINS_USER']]
|
|
|
|
|
|
def get_paths(type_: PathType) -> Generator[str, None, None]:
|
|
for key, value in _paths.items():
|
|
path_type = value[2]
|
|
if type_ != path_type:
|
|
continue
|
|
yield _paths[key]
|
|
|
|
|
|
def override_path(*args, **kwargs):
|
|
_paths.add(*args, **kwargs)
|
|
|
|
|
|
def set_separation(active: bool) -> None:
|
|
_paths.profile_separation = active
|
|
|
|
|
|
def set_profile(profile: str) -> None:
|
|
_paths.profile = profile
|
|
|
|
|
|
def set_config_root(config_root: str) -> None:
|
|
_paths.custom_config_root = str(Path(config_root).resolve())
|
|
|
|
|
|
def init() -> None:
|
|
_paths.init()
|
|
|
|
|
|
def create_paths() -> None:
|
|
for path in get_paths(PathType.FOLDER):
|
|
if not isinstance(path, Path):
|
|
path_ = Path(path)
|
|
|
|
if path_.is_file():
|
|
print(_('%s is a file but it should be a directory') % path_)
|
|
print(_('Gajim will now exit'))
|
|
sys.exit()
|
|
|
|
if not path_.exists():
|
|
for parent_path in reversed(path_.parents):
|
|
# Create all parent folders
|
|
# don't use mkdir(parent=True), as it ignores `mode`
|
|
# when creating the parents
|
|
if not parent_path.exists():
|
|
print(('creating %s directory') % parent_path)
|
|
parent_path.mkdir(mode=0o700)
|
|
print(('creating %s directory') % path_)
|
|
path_.mkdir(mode=0o700)
|
|
|
|
|
|
class ConfigPaths:
|
|
def __init__(self) -> None:
|
|
self._paths = {} # type: Dict[str, PathTuple]
|
|
self.profile = ''
|
|
self.profile_separation = False
|
|
self.custom_config_root = None # type: Optional[str]
|
|
|
|
if os.name == 'nt':
|
|
try:
|
|
# Documents and Settings\[User Name]\Application Data\Gajim
|
|
self.config_root = self.cache_root = self.data_root = \
|
|
os.path.join(os.environ['appdata'], 'Gajim')
|
|
except KeyError:
|
|
# win9x, in cwd
|
|
self.config_root = self.cache_root = self.data_root = '.'
|
|
else:
|
|
expand = os.path.expanduser
|
|
base = os.getenv('XDG_CONFIG_HOME')
|
|
if base is None or base[0] != '/':
|
|
base = expand('~/.config')
|
|
self.config_root = os.path.join(base, 'gajim')
|
|
base = os.getenv('XDG_CACHE_HOME')
|
|
if base is None or base[0] != '/':
|
|
base = expand('~/.cache')
|
|
self.cache_root = os.path.join(base, 'gajim')
|
|
base = os.getenv('XDG_DATA_HOME')
|
|
if base is None or base[0] != '/':
|
|
base = expand('~/.local/share')
|
|
self.data_root = os.path.join(base, 'gajim')
|
|
|
|
import pkg_resources
|
|
basedir = pkg_resources.resource_filename("gajim", ".")
|
|
|
|
source_paths = [
|
|
('DATA', os.path.join(basedir, 'data')),
|
|
('STYLE', os.path.join(basedir, 'data', 'style')),
|
|
('EMOTICONS', os.path.join(basedir, 'data', 'emoticons')),
|
|
('GUI', os.path.join(basedir, 'data', 'gui')),
|
|
('ICONS', os.path.join(basedir, 'data', 'icons')),
|
|
('HOME', os.path.expanduser('~')),
|
|
('PLUGINS_BASE', os.path.join(basedir, 'data', 'plugins')),
|
|
]
|
|
|
|
for path in source_paths:
|
|
self.add(*path)
|
|
|
|
def __getitem__(self, key: str) -> str:
|
|
location, path, _ = self._paths[key]
|
|
if location == PathLocation.CONFIG:
|
|
return os.path.join(self.config_root, path)
|
|
if location == PathLocation.CACHE:
|
|
return os.path.join(self.cache_root, path)
|
|
if location == PathLocation.DATA:
|
|
return os.path.join(self.data_root, path)
|
|
return path
|
|
|
|
def items(self) -> Generator[Tuple[str, PathTuple], None, None]:
|
|
for key, value in self._paths.items():
|
|
yield (key, value)
|
|
|
|
def _prepare(self, path: str, unique: bool) -> str:
|
|
if os.name == 'nt':
|
|
path = path.capitalize()
|
|
if self.profile:
|
|
if unique or self.profile_separation:
|
|
return '%s.%s' % (path, self.profile)
|
|
return path
|
|
|
|
def add(self,
|
|
name: str,
|
|
path: str,
|
|
location: PathLocation = None,
|
|
path_type: PathType = None,
|
|
unique: bool = False) -> None:
|
|
if path and location is not None:
|
|
path = self._prepare(path, unique)
|
|
self._paths[name] = (location, path, path_type)
|
|
|
|
def init(self):
|
|
if self.custom_config_root:
|
|
self.config_root = self.custom_config_root
|
|
self.cache_root = self.data_root = self.custom_config_root
|
|
|
|
user_dir_paths = [
|
|
('TMP', tempfile.gettempdir()),
|
|
('MY_CONFIG', '', PathLocation.CONFIG, PathType.FOLDER),
|
|
('MY_CACHE', '', PathLocation.CACHE, PathType.FOLDER),
|
|
('MY_DATA', '', PathLocation.DATA, PathType.FOLDER),
|
|
]
|
|
|
|
for path in user_dir_paths:
|
|
self.add(*path)
|
|
|
|
# These paths are unique per profile
|
|
unique_profile_paths = [
|
|
# Data paths
|
|
('SECRETS_FILE', 'secrets', PathLocation.DATA, PathType.FILE),
|
|
('MY_PEER_CERTS', 'certs', PathLocation.DATA, PathType.FOLDER),
|
|
('DEBUG', 'debug', PathLocation.DATA, PathType.FOLDER),
|
|
('PLUGINS_DATA', 'plugins_data', PathLocation.DATA, PathType.FOLDER),
|
|
|
|
# Config paths
|
|
('CONFIG_FILE', 'config', PathLocation.CONFIG, PathType.FILE),
|
|
('PLUGINS_CONFIG_DIR',
|
|
'pluginsconfig', PathLocation.CONFIG, PathType.FOLDER),
|
|
('MY_CERT', 'localcerts', PathLocation.CONFIG, PathType.FOLDER),
|
|
]
|
|
|
|
for path in unique_profile_paths:
|
|
self.add(*path, unique=True)
|
|
|
|
# These paths are only unique per profile if the commandline arg
|
|
# `separate` is passed
|
|
paths = [
|
|
# Data paths
|
|
('LOG_DB', 'logs.db', PathLocation.DATA, PathType.FILE),
|
|
('MY_CACERTS', 'cacerts.pem', PathLocation.DATA, PathType.FILE),
|
|
('PLUGINS_DOWNLOAD', 'plugins_download', PathLocation.CACHE, PathType.FOLDER),
|
|
('PLUGINS_USER', 'plugins', PathLocation.DATA, PathType.FOLDER),
|
|
('MY_EMOTS',
|
|
'emoticons', PathLocation.DATA, PathType.FOLDER_OPTIONAL),
|
|
('MY_ICONSETS',
|
|
'iconsets', PathLocation.DATA, PathType.FOLDER_OPTIONAL),
|
|
('MY_MOOD_ICONSETS',
|
|
'moods', PathLocation.DATA, PathType.FOLDER_OPTIONAL),
|
|
('MY_ACTIVITY_ICONSETS',
|
|
'activities', PathLocation.DATA, PathType.FOLDER_OPTIONAL),
|
|
|
|
# Cache paths
|
|
('CACHE_DB', 'cache.db', PathLocation.CACHE, PathType.FILE),
|
|
('AVATAR', 'avatars', PathLocation.CACHE, PathType.FOLDER),
|
|
('BOB', 'bob', PathLocation.CACHE, PathType.FOLDER),
|
|
|
|
# Config paths
|
|
('MY_THEME', 'theme', PathLocation.CONFIG, PathType.FOLDER),
|
|
|
|
]
|
|
|
|
for path in paths:
|
|
self.add(*path)
|
|
|
|
|
|
_paths = ConfigPaths()
|
|
|
|
# For backwards compatibility needed
|
|
# some plugins use that
|
|
gajimpaths = _paths
|