"""
This module contains the default configuration and state values and functions to return
existing config or state instances for a specified config_name.
"""
from __future__ import annotations
import threading
from packaging.version import Version
from .user import UserConfig, DefaultsType
from .. import __version__
from ..utils.appdirs import get_conf_path, get_data_path
[docs]CONFIG_DIR_NAME = "maestral"
# =============================================================================
# Defaults
# =============================================================================
[docs]DEFAULTS_CONFIG: DefaultsType = {
"auth": {
"account_id": "", # dropbox account id, must match the saved account key
"keyring": "automatic", # keychain backend to use for credential storage
},
"app": {
"notification_level": 15, # desktop notification level, default: FILECHANGE
"log_level": 20, # log level for journal and file, default: INFO
"update_notification_interval": 60 * 60 * 24 * 7, # default: weekly
},
"sync": {
"path": "", # dropbox folder location
"excluded_items": [], # files and folders excluded from sync
"reindex_interval": 60 * 60 * 24 * 14, # default: every fortnight
"max_cpu_percent": 20.0, # max usage target per cpu core, default: 20%
"keep_history": 60 * 60 * 24 * 7, # default: one week
"upload": True, # if download sync is enabled
"download": True, # if upload sync is enabled
},
}
[docs]DEFAULTS_STATE: DefaultsType = {
"account": { # account state, periodically updated from dropbox servers
"email": "",
"display_name": "",
"abbreviated_name": "",
"type": "",
"usage": "",
"usage_type": "", # private vs business
"path_root_type": "user", # the root folder type: team or user
"path_root_nsid": "", # the namespace id of the root path
"home_path": "", # the path of the user folder if not the root path
},
"auth": {
"token_access_type": "", # will be updated on completed OAuth
},
"app": { # app state
"updated_scripts_completed": __version__,
"update_notification_last": 0.0,
},
"sync": { # sync state, updated by monitor
"cursor": "", # remote cursor: represents last state synced from dropbox
"lastsync": 0.0, # local cursor: time-stamp of last upload
"last_reindex": 0.0, # time-stamp of full last reindexing
"indexing_counter": 0, # counter for indexing progress between restarts
"did_finish_indexing": False, # indicates completed indexing
"pending_uploads": [], # incomplete uploads to retry on next sync
"pending_downloads": [], # incomplete downloads to retry on next sync
},
}
[docs]KEY_SECTION_MAP = {"version": "main"}
for section_name, section_values in DEFAULTS_CONFIG.items():
for key in section_values.keys():
KEY_SECTION_MAP[key] = section_name
# IMPORTANT NOTES:
# 1. If you want to *change* the default value of a current option, you need to
# do a MINOR update in config version, e.g. from 3.0 to 3.1
# 2. If you want to *remove* options that are no longer needed in our codebase,
# or if you want to *rename* options, then you need to do a MAJOR update in
# version, e.g. from 3.0 to 4.0
# 3. You don't need to touch this value if you're just adding a new option
[docs]CONF_VERSION = Version("18.0")
# =============================================================================
# Factories
# =============================================================================
def _get_conf(
config_name: str,
config_path: str,
defaults: DefaultsType,
registry: dict[str, UserConfig],
):
try:
conf = registry[config_name]
except KeyError:
try:
conf = UserConfig(
config_path,
defaults=defaults,
version=CONF_VERSION,
backup=True,
)
except OSError:
conf = UserConfig(
config_path,
defaults=defaults,
version=CONF_VERSION,
backup=True,
load=False,
)
registry[config_name] = conf
return conf
_config_instances: dict[str, UserConfig] = {}
_config_lock = threading.Lock()
[docs]def MaestralConfig(config_name: str) -> UserConfig:
"""
Returns an existing config instance or creates a new one.
:param config_name: Name of maestral configuration to run. A new config file will
be created if none exists for the given config_name.
:return: Maestral config instance which saves any changes to the drive.
"""
global _config_instances
with _config_lock:
config_path = get_conf_path(CONFIG_DIR_NAME, f"{config_name}.ini")
return _get_conf(config_name, config_path, DEFAULTS_CONFIG, _config_instances)
_state_instances: dict[str, UserConfig] = {}
_state_lock = threading.Lock()
[docs]def MaestralState(config_name: str) -> UserConfig:
"""
Returns an existing state instance or creates a new one.
:param config_name: Name of maestral configuration to run. A new state file will
be created if none exists for the given config_name.
:return: Maestral state instance which saves any changes to the drive.
"""
global _state_instances
with _state_lock:
state_path = get_data_path(CONFIG_DIR_NAME, f"{config_name}.state")
return _get_conf(config_name, state_path, DEFAULTS_STATE, _state_instances)