scripts/pvlbackup-rsync-wrapper
author Tero Marttila <terom@paivola.fi>
Tue, 21 Feb 2012 16:28:48 +0200
changeset 25 d2bee6bc173a
parent 12 fbfdde7326f4
child 28 82bcde9e21c4
permissions -rwxr-xr-x
version: 0.2.2
#!/usr/bin/python

"""
    SSH authorized_keys command="..." wrapper for rsync.
"""

from pvl.backup.rsync import RSyncCommandFormatError
from pvl.backup.invoke import InvokeError
from pvl.backup import rsync

import optparse
import os
import logging

log = logging.getLogger()

# command-line options
options = None

def parse_options (argv) :
    """
        Parse command-line arguments.
    """

    parser = optparse.OptionParser(
            prog        = argv[0],

            # module docstring
            description = __doc__,
    )

    # logging
    general = optparse.OptionGroup(parser, "General Options")

    general.add_option('-q', '--quiet',      dest='loglevel', action='store_const', const=logging.WARNING, help="Less output")
    general.add_option('-v', '--verbose',    dest='loglevel', action='store_const', const=logging.INFO,  help="More output")
    general.add_option('-D', '--debug',      dest='loglevel', action='store_const', const=logging.DEBUG, help="Even more output")

    parser.add_option_group(general)

    #
    parser.add_option('-c', '--command',    metavar='CMD', default=os.environ.get('SSH_ORIGINAL_COMMAND'),
            help="rsync command to execute")

    parser.add_option('-R', '--readonly',   action='store_true', default=False,
            help="restrict to read/source mode")

    parser.add_option('-P', '--restrict-path', metavar='PATH', default=False,
            help="restrict to given path prefix")

    # defaults
    parser.set_defaults(
        loglevel    = logging.WARNING,
    )

    # parse
    options, args = parser.parse_args(argv[1:])

    # configure
    logging.basicConfig(
        format  = '%(levelname)6s %(name)s : %(funcName)s : %(message)s',
        level   = options.loglevel,
    )

    return options, args

def rsync_wrapper (command, restrict='lvm:') :
    """
        Wrap given rsync command.

        Parses the command, the source path, and then executes rsync within the source path (which may be a special
        pseudo-path with additional handling).
    """

    try :
        # parse the rsync command sent by the client
        rsync_cmd, rsync_options, source_path, dest_path = rsync.parse_command(command, 
                restrict_readonly   = options.readonly,
            )

    except RSyncCommandFormatError, e:
        log.error("invalid rsync command: %r: %s", command, e)
        return 2

    # XXX: the real path is always given second..
    path = dest_path

    try :
        # parse the source path as given by the client, may be a real path or pseudo-path
        source = rsync.parse_source(path,
                restrict_path       = options.restrict_path,
            )

    except RSyncCommandFormatError, e:
        log.error("invalid rsync source: %r: %s", path, e)
        return 2

    try :
        # run rsync within the source (may perform additional stuff like snapshotting...)
        source.execute(rsync_options)

    except InvokeError, e:
        log.error("%s failed: %d", e.cmd, e.exit)
        return e.exit

    # ok
    return 0

def main (argv) :
    global options

    # global options + args
    options, args = parse_options(argv)

    # args
    if args :
        log.error("No arguments are handled")
        return 2

    # command required
    if not options.command:
        log.error("SSH_ORIGINAL_COMMAND not given")
        return 2

    try :
        # handle it
        return rsync_wrapper(options.command)

    except Exception, e:
        log.error("Internal error:", exc_info=e)
        return 3

    # ok
    return 0

if __name__ == '__main__' :
    import sys

    sys.exit(main(sys.argv))