hub_list_backups.py

#!/usr/bin/python3
#
# Copyright (c) 2011 Alon Swartz <alon@turnkeylinux.org>
# Copyright (c) 2022 TUrnKey GNU/Linux <admin@turnkeylinux.org>
#
# This file is part of HubTools.
#
# HubTools 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 3 of the License, or (at your
# option) any later version.
#
"""
List backup records

By default uses a built-in format, unless a user-specified format is specified.
Format variables:

    %backup_id          Backup ID
    %label              Descriptive label
    %turnkey_version    Appliance version code
    %server_id          Associated server id
    %created            Date the backup record was created
    %updated            Date the backup record was last updated
    %size               Aggregate size of backup, in bytes
    %address            Backup target address
    %skpp               Secret Key Passphrase Protection (bool)

Examples:

    hub-list-backups
    hub-list-backups "backup_id=%backup_id label=%label size=%{size}bytes"

Environment variables:

    HUB_APIKEY          Displayed in your Hub account's user profile
"""
import os
import sys
import getopt

from hublib import Hub
from hublib.formatter import Formatter, fmt_backup_header, fmt_backup
from hublib.utils import fatal


def usage(e=None):
    if e:
        print("error: " + str(e), file=sys.stderr)

    print("Syntax: %s [ <format> ]" % (sys.argv[0]), file=sys.stderr)
    print(__doc__, file=sys.stderr)

    sys.exit(1)


def main():
    try:
        opts, args = getopt.gnu_getopt(sys.argv[1:], "h", ["help"])
    except getopt.GetoptError as e:
        usage(e)

    for opt, val in opts:
        if opt in ('-h', '--help'):
            usage()

    if args:
        if len(args) != 1:
            usage("incorrect number of arguments")

        format = args[0]
    else:
        format = None

    apikey = os.getenv('HUB_APIKEY', None)
    if not apikey:
        fatal("HUB_APIKEY not specified in environment")

    hub = Hub(apikey)
    backups = hub.backups.get()

    if backups:
        if format:
            format = Formatter(format)
            for backup in backups:
                print(format(backup))
        else:
            print(fmt_backup_header())
            for backup in backups:
                print(fmt_backup(backup))


if __name__ == "__main__":
    main()