config module

Configuration logic.

This module and its Config class contain the application logic handling the configuration of Back In Time. The handling of the configuration file itself is separated in the module configfile.

Development notes:

Some of the methods have code comments starting with #? ` instead of `# `. These special comments are used to generate the manpage `backintime-config. The script create-manpage-backintime-config.py parses this module for that.

class config.Config(config_path=None, data_path=None)

Bases: ConfigFileWithProfiles

APP_NAME = 'Back In Time'

AT_EVERY_BOOT = 1

CONFIG_VERSION = 6

Latest or highest possible version of Back in Time’s config file.

COPYRIGHT = 'Copyright (C) 2008-2024 Oprea Dan, Bart de Koning, Richard Bailey, Germar Reitze, Christian Buhtz, Michael Büker, Jürgen Altfeld et al.'

CUSTOM_HOUR = 19

DAY = 20

DEFAULT_EXCLUDE = ['.gvfs', '.cache/*', '.thumbnails*', '.local/share/[Tt]rash*', '*.backup*', '*~', '.dropbox*', '/proc/*', '/sys/*', '/dev/*', '/run/*', '/etc/mtab', '/var/cache/apt/archives/*.deb', 'lost+found/*', '/tmp/*', '/var/tmp/*', '/var/backups/*', '.Private', '/swapfile', 'SingletonLock', 'SingletonCookie', 'lock']

DEFAULT_REDIRECT_STDERR_IN_CRON = False

DEFAULT_REDIRECT_STDOUT_IN_CRON = True

DEFAULT_RUN_IONICE_FROM_CRON = True

DEFAULT_RUN_IONICE_FROM_USER = False

DEFAULT_RUN_IONICE_ON_REMOTE = False

DEFAULT_RUN_NICE_FROM_CRON = True

DEFAULT_RUN_NICE_ON_REMOTE = False

DEFAULT_RUN_NOCACHE_ON_LOCAL = False

DEFAULT_RUN_NOCACHE_ON_REMOTE = False

DEFAULT_SSH_PREFIX = 'PATH=/opt/bin:/opt/sbin:\\$PATH'

DISK_UNIT_GB = 20

DISK_UNIT_MB = 10

ENCODE = <encfstools.Bounce object>

HOUR = 10

MONTH = 40

NONE = 0

PLUGIN_MANAGER = <pluginmanager.PluginManager object>

REPEATEDLY = 25

SYSTEM_ENTRY_MESSAGE = '#Back In Time system entry, this will be edited by the gui:'

The string is used in crontab file to mark entries as owned by Back In Time. WARNING: Don’t modify that string in code because it is used as match target while parsing the crontab file.

UDEV = 27

WEEK = 30

YEAR = 80

anacronJobIdentify(profile_id=None)

anacronSpool()

anacronSpoolFile(profile_id=None)

anacrontab(suffix='')

Deprecated since 1.1. Just keep this to delete old anacrontab files

anacrontabFiles()

list existing old anacrontab files

appInstanceFile()

backupOnRestore(profile_id=None)

backupScheduled(profile_id=None)

check if profile is supposed to be run this time

bwlimit(profile_id=None)

bwlimitEnabled(profile_id=None)

canBackup(profile_id=None)

Checks if snapshots_path exists

checkConfig()

continueOnErrors(profile_id=None)

copyLinks(profile_id=None)

copyUnsafeLinks(profile_id=None)

createNewCrontab(oldCrontab)

cronCmd(profile_id)

cronEnvFile()

cronLine(profile_id)

customBackupTime(profile_id=None)

decrement_manual_starts_countdown()

Counts down to -1.

See manual_starts_countdown() for details.

dontRemoveNamedSnapshots(profile_id=None)

encfsconfigBackupFolder(profile_id=None)

exclude(profile_id=None)

Gets the exclude patterns

excludeBySize(profile_id=None)

excludeBySizeEnabled(profile_id=None)

excludeV4(profile_id=None)

Gets the exclude patterns: conf version 4

fileId(profile_id=None)

globalFlock()

hashCollision()

host()

hostUserProfile(profile_id=None)

hostUserProfileDefault(profile_id=None)

include(profile_id=None)

includeV4(profile_id=None)

incrementHashCollision()

ioniceOnCron(profile_id=None)

ioniceOnRemote(profile_id=None)

ioniceOnUser(profile_id=None)

isConfigured(profile_id=None)

Checks if the program is configured

keepOnlyOneSnapshot(profile_id=None)

keyringServiceName(profile_id=None, mode=None, pw_id=1)

keyringUserName(profile_id=None)

language() → str

language_used

ISO-639 language code of the used language. See tools._determine_current_used_language_code() for details.

lastSnapshotSymlink(profile_id=None)

localEncfsPath(profile_id=None)

logLevel(profile_id=None)

manual_starts_countdown() → int

Countdown value about how often the users started the Back In Time GUI.

It is an internal variable not meant to be used or manipulated be the users. At the end of the countown the ApproachTranslatorDialog is presented to the user.

minFreeInodes(profile_id=None)

minFreeInodesEnabled(profile_id=None)

minFreeSpace(profile_id=None)

minFreeSpaceEnabled(profile_id=None)

minFreeSpaceMib(profile_id=None)

modeNeedPassword(mode, pw_id=1)

niceOnCron(profile_id=None)

niceOnRemote(profile_id=None)

noSnapshotOnBattery(profile_id=None)

nocacheOnLocal(profile_id=None)

nocacheOnRemote(profile_id=None)

notify(profile_id=None)

olderThan(time, value, unit)

return True if time is older than months, weeks, days or hours

oneFileSystem(profile_id=None)

password(parent=None, profile_id=None, mode=None, pw_id=1, only_from_keyring=False)

passwordCacheFifo()

passwordCacheFolder()

passwordCacheInfo()

passwordCachePid()

passwordSave(profile_id=None, mode=None)

passwordUseCache(profile_id=None, mode=None)

pid()

preparePath(path)

preserveAcl(profile_id=None)

preserveXattr(profile_id=None)

redirectStderrInCron(profile_id=None)

redirectStdoutInCron(profile_id=None)

removeOldCrontab(crontab)

removeOldSnapshots(profile_id=None)

removeOldSnapshotsDate(profile_id=None)

removeOldSnapshotsEnabled(profile_id=None)

restoreInstanceFile(profile_id=None)

restoreLogFile(profile_id=None)

rsyncOptions(profile_id=None)

rsyncOptionsEnabled(profile_id=None)

save()

Save all options to file.

Parameters:

filename (str) – full path

Returns:

True if successful

Return type:

bool

scheduleDay(profile_id=None)

scheduleMode(profile_id=None)

scheduleRepeatedPeriod(profile_id=None)

scheduleRepeatedUnit(profile_id=None)

scheduleTime(profile_id=None)

scheduleWeekday(profile_id=None)

setBackupOnRestore(value, profile_id=None)

setBwlimit(enabled, value, profile_id=None)

setContinueOnErrors(value, profile_id=None)

setCopyLinks(value, profile_id=None)

setCopyUnsafeLinks(value, profile_id=None)

setCurrentHashId(hash_id)

setCustomBackupTime(value, profile_id=None)

setDontRemoveNamedSnapshots(value, profile_id=None)

setExclude(values, profile_id=None)

setExcludeBySize(enabled, value, profile_id=None)

setGlobalFlock(value)

setHostUserProfile(host, user, profile, profile_id=None)

setInclude(values, profile_id=None)

setIoniceOnCron(value, profile_id=None)

setIoniceOnRemote(value, profile_id=None)

setIoniceOnUser(value, profile_id=None)

setKeepOnlyOneSnapshot(value, profile_id=None)

setLanguage(language: str)

setLocalEncfsPath(value, profile_id=None)

setLogLevel(value, profile_id=None)

setMinFreeInodes(enabled, value, profile_id=None)

setMinFreeSpace(enabled, value, unit, profile_id=None)

setNiceOnCron(value, profile_id=None)

setNiceOnRemote(value, profile_id=None)

setNoSnapshotOnBattery(value, profile_id=None)

setNocacheOnLocal(value, profile_id=None)

setNocacheOnRemote(value, profile_id=None)

setNotify(value, profile_id=None)

setOneFileSystem(value, profile_id=None)

setPassword(password, profile_id=None, mode=None, pw_id=1)

setPasswordSave(value, profile_id=None, mode=None)

setPasswordUseCache(value, profile_id=None, mode=None)

setPreserveAcl(value, profile_id=None)

setPreserveXattr(value, profile_id=None)

setRedirectStderrInCron(value, profile_id=None)

setRedirectStdoutInCron(value, profile_id=None)

setRemoveOldSnapshots(enabled, value, unit, profile_id=None)

setRsyncOptions(enabled, value, profile_id=None)

setScheduleDay(value, profile_id=None)

setScheduleMode(value, profile_id=None)

setScheduleRepeatedPeriod(value, profile_id=None)

setScheduleRepeatedUnit(value, profile_id=None)

setScheduleTime(value, profile_id=None)

setScheduleWeekday(value, profile_id=None)

setSmartRemove(value, keep_all, keep_one_per_day, keep_one_per_week, keep_one_per_month, profile_id=None)

setSmartRemoveRunRemoteInBackground(value, profile_id=None)

setSnapshotsMode(value, profile_id=None)

setSnapshotsPath(value, profile_id=None, mode=None)

Sets the snapshot path to value, initializes, and checks it

setSshCheckCommands(value, profile_id=None)

setSshCheckPingHost(value, profile_id=None)

setSshCipher(value, profile_id=None)

setSshHost(value, profile_id=None)

setSshMaxArgLength(value, profile_id=None)

setSshPort(value, profile_id=None)

setSshPrefix(enabled, value, profile_id=None)

setSshPrivateKeyFile(value, profile_id=None)

setSshSnapshotsPath(value, profile_id=None)

setSshUser(value, profile_id=None)

setTakeSnapshotRegardlessOfChanges(value, profile_id=None)

setUseChecksum(value, profile_id=None)

setupCron()

smartRemove(profile_id=None)

smartRemoveRunRemoteInBackground(profile_id=None)

snapshotsFullPath(profile_id=None)

Returns the full path for the snapshots: …/backintime/machine/user/profile_id/

snapshotsMode(profile_id=None)

snapshotsPath(profile_id=None, mode=None, tmp_mount=False)

snapshotsSymlink(profile_id=None, tmp_mount=False)

sshCheckCommands(profile_id=None)

sshCheckPingHost(profile_id=None)

sshCipher(profile_id=None)

sshCommand(cmd=None, custom_args=None, port=True, cipher=True, user_host=True, ionice=True, nice=True, quote=False, prefix=True, profile_id=None)

Return SSH command with all arguments.

Parameters:

• cmd (list) – command that should run on remote host

• custom_args (list) – additional arguments paste to the command

• port (bool) – use port from config

• cipher (bool) – use cipher from config

• user_host (bool) – use user@host from config

• ionice (bool) – use ionice if configured

• nice (bool) – use nice if configured

• quote (bool) – quote remote command

• prefix (bool) – use prefix from config before remote command

• profile_id (str) – profile ID that should be used in config

Returns:

ssh command with chosen arguments

Return type:

list

sshDefaultArgs(profile_id=None)

Default arguments used for ssh and sshfs commands.

Returns:

arguments for ssh

Return type:

list

sshHost(profile_id=None)

sshHostUserPortPathCipher(profile_id=None)

sshMaxArgLength(profile_id=None)

sshPort(profile_id=None)

sshPrefix(profile_id=None)

sshPrefixCmd(profile_id=None, cmd_type=<class 'str'>)

sshPrefixEnabled(profile_id=None)

sshPrivateKeyFile(profile_id=None)

sshPrivateKeyFolder()

sshSnapshotsFullPath(profile_id=None)

Returns the full path for the snapshots: …/backintime/machine/user/profile_id/

sshSnapshotsPath(profile_id=None)

sshUser(profile_id=None)

tag(profile_id=None)

takeSnapshotInstanceFile(profile_id=None)

takeSnapshotLogFile(profile_id=None)

takeSnapshotMessageFile(profile_id=None)

takeSnapshotProgressFile(profile_id=None)

takeSnapshotRegardlessOfChanges(profile_id=None)

takeSnapshotUserCallback()

udevRulesPath()

useChecksum(profile_id=None)

user()

portable way to get username cc by-sa 3.0 http://stackoverflow.com/a/19865396/1139841 author: techtonik http://stackoverflow.com/users/239247/techtonik

userCallbackNoLogging(profile_id=None)