backintime-common 1.0.34-0.1 / usr / share / backintime / common / backintime.py

#    Back In Time
#    Copyright (C) 2008-2009 Oprea Dan, Bart de Koning, Richard Bailey
#
#    This program 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; either version 2 of the License, or
#    (at your option) any later version.
#
#    This program 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 this program; if not, write to the Free Software Foundation, Inc.,
#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

#print into file like it is done in Python3
from __future__ import print_function
import os
import os.path
import stat
import sys
import gettext

import config
import logger
import snapshots
import tools
import sshtools
import mount
import password
import encfstools
import cli

_=gettext.gettext


def take_snapshot_now_async( cfg ):
    cmd = ''
    if cfg.is_run_ionice_from_user_enabled():
        cmd += 'ionice -c2 -n7 '
    cmd += 'backintime '
    if '1' != cfg.get_current_profile():
        cmd += '--profile-id %s ' % cfg.get_current_profile()
    if not cfg._LOCAL_CONFIG_PATH is cfg._DEFAULT_CONFIG_PATH:
        cmd += '--config %s ' % cfg._LOCAL_CONFIG_PATH
    cmd += '--backup &'

    os.system( cmd )


def take_snapshot( cfg, force = True ):
    logger.openlog()
    tools.load_env(cfg)
    snapshots.Snapshots( cfg ).take_snapshot( force )
    logger.closelog()

def _mount(cfg):
    try:
        hash_id = mount.Mount(cfg = cfg).mount()
    except mount.MountException as ex:
        logger.error(str(ex))
        sys.exit(1)
    else:
        cfg.set_current_hash_id(hash_id)

def _umount(cfg):
    try:
        mount.Mount(cfg = cfg).umount(cfg.current_hash_id)
    except mount.MountException as ex:
        logger.error(str(ex))


def print_version( cfg, app_name ):
    print('')
    print('Back In Time')
    print('Version: ' + cfg.VERSION)
    print('')
    print('Back In Time comes with ABSOLUTELY NO WARRANTY.')
    print('This is free software, and you are welcome to redistribute it')
    print("under certain conditions; type `%s --license\' for details." % app_name)
    print('')


def print_help( cfg ):
    print('OPTIONS (use these before other actions):')
    print('--profile <profile name>')
    print('\tSelect profile by name')
    print('--profile-id <profile id>')
    print('\tSelect profile by id')
    print('--keep-mount')
    print('\tDon\'t unmount on exit. Only valid with')
    print('\t--snapshots-list-path and --last-snapshot-path.')
    print('--quiet')
    print('\tBe quiet. Suppress messages on stdout.')
    print('--config PATH')
    print('\tread config from PATH.')
    print('--checksum')
    print('\tforce to use checksum for checking if files have been changed.')
    print('')
    print('ACTIONS:')
    print('-b | --backup')
    print('\tTake a snapshot (and exit)')
    print('--backup-job')
    print('\tUsed for cron job: take a snapshot (and exit)')
    print('--snapshots-path')
    print('\tShow the path where is saves the snapshots (and exit)')
    print('--snapshots-list')
    print('\tShow the list of snapshots IDs (and exit)')
    print('--snapshots-list-path')
    print('\tShow the paths to snapshots (and exit)')
    print('--last-snapshot')
    print('\tShow the ID of the last snapshot (and exit)')
    print('--last-snapshot-path')
    print('\tShow the path to the last snapshot (and exit)')
    print('--unmount')
    print('\tUnmount the profile.')
    print('--benchmark-cipher [file-size]')
    print('\tShow a benchmark of all ciphers for ssh transfer (and exit)')
    print('--pw-cache [start|stop|restart|reload|status]')
    print('\tControl Password Cache for non-interactive cronjobs')
    print('--decode [encoded_PATH]')
    print('\tDecode PATH. If no PATH is specified on command line')
    print('\ta list of filenames will be read from stdin.')
    print('--restore [WHAT [WHERE [SNAPSHOT_ID]]]')
    print('\tRestore file WHAT to path WHERE from snapshot SNAPSHOT_ID.')
    print('\tIf arguments are missing they will be prompted.')
    print('-v | --version')
    print('\tShow version (and exit)')
    print('--license')
    print('\tShow license (and exit)')
    print('-h | --help')
    print('\tShow this help (and exit)')
    print('')


def start_app( app_name = 'backintime', extra_args = [] ):
    force_stdout = sys.stdout
    if '--quiet' in sys.argv:
        f = open(os.devnull, 'w')
        sys.stdout = f

    config_path = None
    if '--config' in sys.argv:
        i = sys.argv.index('--config')
        try:
            path = sys.argv[i + 1]
            if os.path.isfile(path):
                config_path = path
        except IndexError:
            pass

    cfg = config.Config(config_path)
    print_version( cfg, app_name )

    skip = False
    index = 0
    keep_mount = False
    
    for arg in sys.argv[ 1 : ]:
        index = index + 1

        if skip:
            skip = False
            continue

        if arg == '--profile':
            if not cfg.set_current_profile_by_name( sys.argv[index + 1] ):
                print("Profile not found: %s" % sys.argv[index + 1], file=sys.stderr)
                sys.exit(0)
            skip = True
            continue

        if arg == '--profile-id':
            if not cfg.set_current_profile( sys.argv[index + 1] ):
                print("Profile id not found: %s" % sys.argv[index + 1], file=sys.stderr)
                sys.exit(0)
            skip = True
            continue

        if arg == '--backup' or arg == '-b':
            take_snapshot( cfg, True )
            sys.exit(0)

        if arg == '--backup-job':
            take_snapshot( cfg, False )
            sys.exit(0)

        if arg == '--version' or arg == '-v':
            sys.exit(0)

        if arg == '--license':
            print(cfg.get_license())
            sys.exit(0)

        if arg == '--help' or arg == '-h':
            print_help( cfg )
            sys.exit(0)

        if arg == '--snapshots-path':
            if not cfg.is_configured():
                print("The application is not configured !", file=sys.stderr)
            else:
                print("SnapshotsPath: %s" % cfg.get_snapshots_full_path(), file=force_stdout)
            sys.exit(0)

        if arg == '--snapshots-list':
            if not cfg.is_configured():
                print("The application is not configured !", file=sys.stderr)
            else:
                _mount(cfg)
                _list = snapshots.Snapshots( cfg ).get_snapshots_list()
                if len( _list ) <= 0:
                    print("There are no snapshots", file=sys.stderr)
                else:
                    for snapshot_id in _list:
                        print("SnapshotID: %s" % snapshot_id, file=force_stdout)
                _umount(cfg)
            sys.exit(0)

        if arg == '--snapshots-list-path':
            if not cfg.is_configured():
                print("The application is not configured !", file=sys.stderr)
            else:
                _mount(cfg)
                s = snapshots.Snapshots( cfg )
                _list = s.get_snapshots_list()
                if len( _list ) <= 0:
                    print("There are no snapshots", file=sys.stderr)
                else:
                    for snapshot_id in _list:
                        print("SnapshotPath: %s" % s.get_snapshot_path( snapshot_id ), file=force_stdout)
                if not keep_mount:
                    _umount(cfg)
            sys.exit(0)

        if arg == '--last-snapshot':
            if not cfg.is_configured():
                print("The application is not configured !", file=sys.stderr)
            else:
                _mount(cfg)
                _list = snapshots.Snapshots( cfg ).get_snapshots_list()
                if len( _list ) <= 0:
                    print("There are no snapshots", file=sys.stderr)
                else:
                    print("SnapshotID: %s" % _list[0], file=force_stdout)
                _umount(cfg)
            sys.exit(0)

        if arg == '--last-snapshot-path':
            if not cfg.is_configured():
                print("The application is not configured !", file=sys.stderr)
            else:
                _mount(cfg)
                s = snapshots.Snapshots( cfg )
                _list = s.get_snapshots_list()
                if len( _list ) <= 0:
                    print("There are no snapshots", file=sys.stderr)
                else:
                    print("SnapshotPath: %s" % s.get_snapshot_path( _list[0] ), file=force_stdout)
                if not keep_mount:
                    _umount(cfg)
            sys.exit(0)
            
        if arg == '--keep-mount':
            keep_mount = True
            continue
            
        if arg == '--unmount':
            _mount(cfg)
            _umount(cfg)
            sys.exit(0)

        if arg == '--benchmark-cipher':
            if not cfg.is_configured():
                print("The application is not configured !", file=sys.stderr)
            else:
                try:
                    size = sys.argv[index + 1]
                except IndexError:
                    size = '40'
                if cfg.get_snapshots_mode() in ['ssh', 'ssh_encfs']:
                    ssh = sshtools.SSH(cfg=cfg)
                    ssh.benchmark_cipher(size)
                else:
                    print('ssh is not configured !', file=sys.stderr)
            sys.exit(0)

        if arg == '--pw-cache':
            if not cfg.is_configured():
                print("The application is not configured !", file=sys.stderr)
                sys.exit(0)
            else:
                logger.openlog()
                daemon = password.Password_Cache(cfg)
                try:
                    if sys.argv[index + 1].startswith('-'):
                        daemon.run()
                    elif 'start' == sys.argv[index + 1]:
                        daemon.start()
                    elif 'stop' == sys.argv[index + 1]:
                        daemon.stop()
                    elif 'restart' == sys.argv[index + 1]:
                        daemon.restart()
                    elif 'reload' == sys.argv[index + 1]:
                        daemon.reload()
                    elif 'status' == sys.argv[index + 1]:
                        print('Backintime Password Cache:', end=' ', file=force_stdout)
                        if daemon.status():
                            print('running', file=force_stdout)
                        else:
                            print('not running', file=force_stdout)
                    else:
                        print("Unknown command")
                        print("usage: %s %s start|stop|restart|reload|status" % (sys.argv[0], sys.argv[index]))
                        sys.exit(2)
                except IndexError:
                    daemon.run()
                logger.closelog()
                sys.exit(0)

        if arg == '--decode':
            if not cfg.is_configured():
                print("The application is not configured !", file=sys.stderr)
                sys.exit(0)
            else:
                mode = cfg.get_snapshots_mode()
                if not mode in ['local_encfs', 'ssh_encfs']:
                    print('Profile \'%s\' is not encrypted.' % cfg.get_profile_name(), file=sys.stderr)
                path = ''
                _list = []
                try:
                    path = sys.argv[index + 1]
                except IndexError:
                    pass
                if len(path) > 0:
                    _list.append(path)
                else:
                    while True:
                        try:
                            path = raw_input()
                        except EOFError:
                            break
                        if len(path) <= 0:
                            break
                        _list.append(path)
                
                _mount(cfg)
                decode = encfstools.Decode(cfg)
                ret = decode.list(list)
                decode.close()
                _umount(cfg)
                
                print('\n'.join(ret), file=force_stdout)
                sys.exit(0)

        if arg == '--restore':
            if not cfg.is_configured():
                print("The application is not configured !", file=sys.stderr)
                sys.exit(0)
            what = None
            where = None
            snapshot_id = None
            
            try:
                what = sys.argv[index + 1]
                where = sys.argv[index + 2]
                snapshot_id = sys.argv[index + 3]
            except IndexError:
                pass
            
            _mount(cfg)
            cli.restore(cfg, snapshot_id, what, where)
            _umount(cfg)
            sys.exit(0)

        if arg == '--checksum':
            print('Force using checksum')
            cfg.force_use_checksum = True
            continue

        if arg == '--snapshots' or arg == '-s':
            continue

        if arg == '--gnome' or arg == '--kde4' or arg == '--kde3':
            continue

        if arg == '--quiet':
            continue

        if arg == '--config':
            skip = True
            continue

        if arg[0] == '-':
            if not arg[0] in extra_args:
                print("Ignore option: %s" % arg)
            continue

    return cfg


if __name__ == '__main__':
    start_app()