9578053 Jan 22 2022 distfiles.gentoo.org/distfiles/gajim-1.3.3-2.tar.gz
This commit is contained in:
emdee
parent
a5b3822651
commit
4c1b226bff
1045 changed files with 753037 additions and 18 deletions
234
gajim/common/configpaths.py
Normal file
234
gajim/common/configpaths.py
Normal file
|
|
@ -0,0 +1,234 @@
|
|||
# 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
|
||||
|
||||
from gi.repository import GLib
|
||||
|
||||
import gajim
|
||||
from gajim.common.i18n import _
|
||||
from gajim.common.const import PathType, PathLocation
|
||||
from gajim.common.types import PathTuple
|
||||
|
||||
|
||||
def get(key: str) -> Path:
|
||||
return _paths[key]
|
||||
|
||||
|
||||
def get_plugin_dirs() -> List[Path]:
|
||||
if gajim.IS_FLATPAK:
|
||||
return [Path(_paths['PLUGINS_BASE']),
|
||||
Path('/app/plugins')]
|
||||
return [Path(_paths['PLUGINS_BASE']),
|
||||
Path(_paths['PLUGINS_USER'])]
|
||||
|
||||
|
||||
def get_paths(type_: PathType) -> Generator[Path, 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 = Path(config_root).resolve()
|
||||
|
||||
|
||||
def init() -> None:
|
||||
_paths.init()
|
||||
|
||||
|
||||
def create_paths() -> None:
|
||||
for path in get_paths(PathType.FOLDER):
|
||||
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[Path]
|
||||
|
||||
if os.name == 'nt':
|
||||
if gajim.IS_PORTABLE:
|
||||
application_path = Path(sys.executable).parent
|
||||
self.config_root = self.cache_root = self.data_root = \
|
||||
application_path.parent / 'UserData'
|
||||
else:
|
||||
# Documents and Settings\[User Name]\Application Data\Gajim
|
||||
self.config_root = self.cache_root = self.data_root = \
|
||||
Path(os.environ['appdata']) / 'Gajim'
|
||||
else:
|
||||
self.config_root = Path(GLib.get_user_config_dir()) / 'gajim'
|
||||
self.cache_root = Path(GLib.get_user_cache_dir()) / 'gajim'
|
||||
self.data_root = Path(GLib.get_user_data_dir()) / 'gajim'
|
||||
|
||||
if sys.version_info < (3, 9):
|
||||
import pkg_resources
|
||||
basedir = Path(pkg_resources.resource_filename("gajim", "."))
|
||||
else:
|
||||
import importlib.resources
|
||||
basedir = importlib.resources.files('gajim')
|
||||
|
||||
source_paths = [
|
||||
('DATA', basedir / 'data'),
|
||||
('STYLE', basedir / 'data' / 'style'),
|
||||
('EMOTICONS', basedir / 'data' / 'emoticons'),
|
||||
('GUI', basedir / 'data' / 'gui'),
|
||||
('ICONS', basedir / 'data' / 'icons'),
|
||||
('HOME', Path.home()),
|
||||
('PLUGINS_BASE', basedir / 'data' / 'plugins'),
|
||||
]
|
||||
|
||||
for path in source_paths:
|
||||
self.add(*path)
|
||||
|
||||
def __getitem__(self, key: str) -> Path:
|
||||
location, path, _ = self._paths[key]
|
||||
if location == PathLocation.CONFIG:
|
||||
return self.config_root / path
|
||||
if location == PathLocation.CACHE:
|
||||
return self.cache_root / path
|
||||
if location == PathLocation.DATA:
|
||||
return 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: Path, unique: bool) -> Path:
|
||||
if os.name == 'nt':
|
||||
path = Path(str(path).capitalize())
|
||||
if self.profile:
|
||||
if unique or self.profile_separation:
|
||||
return Path(f'{path}.{self.profile}')
|
||||
return path
|
||||
|
||||
def add(self,
|
||||
name: str,
|
||||
path: Path,
|
||||
location: PathLocation = None,
|
||||
path_type: PathType = None,
|
||||
unique: bool = False) -> None:
|
||||
if 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', Path(tempfile.gettempdir())),
|
||||
('MY_CONFIG', Path(), PathLocation.CONFIG, PathType.FOLDER),
|
||||
('MY_CACHE', Path(), PathLocation.CACHE, PathType.FOLDER),
|
||||
('MY_DATA', Path(), 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),
|
||||
('CERT_STORE', 'cert_store', PathLocation.DATA, PathType.FOLDER),
|
||||
('DEBUG', 'debug', PathLocation.DATA, PathType.FOLDER),
|
||||
('PLUGINS_DATA', 'plugins_data', PathLocation.DATA, PathType.FOLDER),
|
||||
|
||||
# Config paths
|
||||
('SETTINGS', 'settings.sqlite', PathLocation.CONFIG, PathType.FILE),
|
||||
('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),
|
||||
('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),
|
||||
|
||||
# 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()
|
||||
Loading…
Add table
Add a link
Reference in a new issue