FreedomBox/actions/backups

#!/usr/bin/python3
# -*- mode: python -*-
#
# This file is part of FreedomBox.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
"""
Configuration helper for backups.
"""

import argparse
import glob
import json
import os
import subprocess
import sys
import tarfile

REPOSITORY = '/var/lib/freedombox/borgbackup'


def parse_arguments():
    """Return parsed command line arguments as dictionary."""
    parser = argparse.ArgumentParser()
    subparsers = parser.add_subparsers(dest='subcommand', help='Sub command')

    subparsers.add_parser(
        'setup', help='Create repository if it does not already exist')
    subparsers.add_parser('info', help='Show repository information')
    subparsers.add_parser('list', help='List repository contents')

    create = subparsers.add_parser('create', help='Create archive')
    create.add_argument('--name', help='Archive name', required=True)
    create.add_argument('--paths', help='Paths to include in archive',
                        nargs='+')

    delete = subparsers.add_parser('delete', help='Delete archive')
    delete.add_argument('--name', help='Archive name', required=True)

    extract = subparsers.add_parser('extract', help='Extract archive contents')
    extract.add_argument('--name', help='Archive name', required=True)
    extract.add_argument('--destination', help='Extract destination',
                         required=True)

    export = subparsers.add_parser('export',
                                   help='Export archive contents as tarball')
    export.add_argument('--name', help='Archive name', required=True)
    export.add_argument('--filename', help='Tarball file name', required=True)

    list_exports = subparsers.add_parser(
        'list-exports', help='List exported backup archive files')
    list_exports.add_argument('--location', required=True,
                              help='location to check')

    get_export_apps = subparsers.add_parser(
        'get-export-apps',
        help='Get list of apps included in exported archive file')
    get_export_apps.add_argument(
        '--filename', help='Tarball file name', required=True)

    restore = subparsers.add_parser(
        'restore', help='Restore files from an exported archive')
    restore.add_argument('--filename', help='Tarball file name', required=True)

    subparsers.required = True
    return parser.parse_args()


def subcommand_setup(_):
    """Create repository if it does not already exist."""
    try:
        subprocess.run(['borg', 'info', REPOSITORY], check=True)
    except:
        path = os.path.dirname(REPOSITORY)
        if not os.path.exists(path):
            os.makedirs(path)

        subprocess.run(['borg', 'init', '--encryption', 'none', REPOSITORY])


def subcommand_info(_):
    """Show repository information."""
    subprocess.run(['borg', 'info', '--json', REPOSITORY], check=True)


def subcommand_list(_):
    """List repository contents."""
    subprocess.run(['borg', 'list', '--json', REPOSITORY], check=True)


def subcommand_create(arguments):
    """Create archive."""
    paths = filter(os.path.exists, arguments.paths)
    subprocess.run([
        'borg',
        'create',
        '--json',
        REPOSITORY + '::' + arguments.name,
    ] + list(paths), check=True)


def subcommand_delete(arguments):
    """Delete archive."""
    subprocess.run(['borg', 'delete', REPOSITORY + '::' + arguments.name],
                   check=True)


def subcommand_extract(arguments):
    """Extract archive contents."""
    prev_dir = os.getcwd()
    env = dict(os.environ, LANG='C.UTF-8')
    try:
        os.chdir(os.path.expanduser(arguments.destination))
        subprocess.run(['borg', 'extract', REPOSITORY + '::' + arguments.name],
                       env=env, check=True)
    finally:
        os.chdir(prev_dir)


def subcommand_export(arguments):
    """Export archive contents as tarball."""
    path = os.path.dirname(arguments.filename)
    if not os.path.exists(path):
        os.makedirs(path)

    subprocess.run([
        'borg', 'export-tar', REPOSITORY + '::' + arguments.name,
        arguments.filename
    ], check=True)


def subcommand_list_exports(arguments):
    """List exported backup archive files."""
    exports = []
    path = arguments.location
    if path[-1] != '/':
        path += '/'

    path += 'FreedomBox-backups/'
    if os.path.exists(path):
        for filename in glob.glob(path + '*.tar.gz'):
            exports.append(os.path.basename(filename))

    print(json.dumps(exports))


def subcommand_get_export_apps(arguments):
    """Get list of apps included in exported archive file."""
    manifest = None
    with tarfile.open(arguments.filename) as t:
        filenames = t.getnames()
        for name in filenames:
            if 'var/lib/plinth/backups-manifests/' in name \
               and name.endswith('.json'):
                manifest_data = t.extractfile(name).read()
                manifest = json.loads(manifest_data)
                break

    if manifest:
        for app in manifest:
            print(app['name'])


def subcommand_restore(arguments):
    """Restore files from an exported archive."""
    locations_data = ''.join(sys.stdin)
    locations = json.loads(locations_data)

    found_file = False
    with tarfile.open(arguments.filename) as t:
        for member in t.getmembers():
            path = '/' + member.name
            if path in locations['files']:
                t.extract(member, '/')
                found_file = True
            else:
                for d in locations['directories']:
                    if path.startswith(d):
                        t.extract(member, '/')
                        found_file = True
                        break

    if not found_file:
        print('No matching files or directories found in archive:', locations)
        sys.exit(1)


def main():
    """Parse arguments and perform all duties."""
    arguments = parse_arguments()

    subcommand = arguments.subcommand.replace('-', '_')
    subcommand_method = globals()['subcommand_' + subcommand]
    subcommand_method(arguments)


if __name__ == '__main__':
    main()