1

#!/usr/bin/python

     2

     3

"""

     4

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

     5

     6

    Testing goes something like:

     7

        sudo sh -c "PYTHONPATH=. rsync -e './scripts/pvlbackup-rsync-wrapper --debug -C --' -ax testing:lvm:asdf:test test/tmp"

     8

"""

     9

    11

from pvl.backup.rsync import RSyncCommandFormatError

    12

from pvl.backup.invoke import InvokeError

    13

from pvl.backup import rsync

    14

    15

import optparse

    16

import shlex

    17

import os

    18

import logging

    19

    20

log = logging.getLogger()

    21

    22

# command-line options

    23

options = None

    24

    25

def parse_options (argv) :

    26

    """

    27

        Parse command-line arguments.

    28

    """

    29

    30

#    import sys; sys.stderr.write("%s\n" % (argv, ))

    31

    32

    parser = optparse.OptionParser(

    33

            prog        = argv[0],

    34

    35

            # module docstring

    36

            description = __doc__,

    38

    )

    39

    40

    # logging

    41

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

    42

    43

    general.add_option('-q', '--quiet',      dest='loglevel', action='store_const', const=logging.WARNING, help="Less output")

    44

    general.add_option('-v', '--verbose',    dest='loglevel', action='store_const', const=logging.INFO,  help="More output")

    45

    general.add_option('-D', '--debug',      dest='loglevel', action='store_const', const=logging.DEBUG, help="Even more output")

    46

    47

    parser.add_option_group(general)

    48

    49

    #

    50

    parser.add_option('-c', '--command',    metavar='CMD', default=os.environ.get('SSH_ORIGINAL_COMMAND'),

    51

            help="rsync command to execute")

    52

    53

    parser.add_option('-C', '--given-command', action='store_true', default=False,

    54

            help="use given command in `rsync -e %prog` format")

    55

    56

    parser.add_option('-R', '--readonly',   action='store_true', default=False,

    57

            help="restrict to read/source mode")

    58

    59

    parser.add_option('-P', '--restrict-path', metavar='PATH', default=False,

    60

            help="restrict to given path prefix")

    61

    62

    # defaults

    63

    parser.set_defaults(

    64

        loglevel    = logging.WARNING,

    65

    )

    66

    67

    # parse

    68

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

    69

    70

    # configure

    71

    logging.basicConfig(

    72

        format  = '%(levelname)6s %(name)s : %(funcName)s : %(message)s',

    73

        level   = options.loglevel,

    74

    )

    75

    76

    return options, args

    77

    78

def rsync_wrapper (command, restrict='lvm:') :

    79

    """

    80

        Wrap given rsync command.

    81

    82

        Parses the command, the source path, and then executes rsync within the source path (which may be a special

    83

        pseudo-path with additional handling).

    84

    """

    85

    86

    try :

    87

        # parse the rsync command sent by the client

    88

        rsync_cmd, rsync_options, source_path, dest_path = rsync.parse_command(command, 

    89

                restrict_readonly   = options.readonly,

    90

            )

    91

    92

    except RSyncCommandFormatError, e:

    93

        log.error("invalid rsync command: %r: %s", command, e)

    94

        return 2

    95

    96

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

    97

    path = dest_path

    98

    99

    try :

   100

        # parse the source path as given by the client, may be a real path or pseudo-path

   101

        source = rsync.parse_source(path,

   102

                restrict_path       = options.restrict_path,

   103

            )

   104

   105

    except RSyncCommandFormatError, e:

   106

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

   107

        return 2

   108

   109

    try :

   110

        # run rsync within the source (may perform additional stuff like snapshotting...)

   111

        source.execute(rsync_options)

   112

   113

    except InvokeError, e:

   114

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

   115

        return e.exit

   116

   117

    # ok

   118

    return 0

   119

   120

def main (argv) :

   121

    global options

   122

   123

    # global options + args

   124

    options, args = parse_options(argv)

   125

   126

    # command required

   127

    if options.given_command :

   128

        # from args (as given by `rsync -e pvlbackup-rsync-wrapper`) -> 'pvlbackup-rsync-wrapper <host> (<command> ...)'

   129

        host = args.pop(0)

   130

        command_parts = args

   131

   132

        log.debug("using command from args: %r", command_parts)

   133

   134

    # args

   135

    elif args :

   136

        log.error("No arguments are handled")

   137

        return 2

   138

   139

    elif options.command:

   140

        # as given

   141

        command_parts = shlex.split(options.command)

   142

   143

    else :

   144

        log.error("SSH_ORIGINAL_COMMAND not given")

   145

        return 2

   146

   147

   148

    # run

   149

    try :

   150

        return rsync_wrapper(command_parts)

   151

   152

    except Exception, e:

   153

        log.error("Internal error:", exc_info=e)

   154

        return 3

   155

   156

    # ok

   157

    return 0

   158

   159

if __name__ == '__main__' :

   160

    import sys

   161

   162

    sys.exit(main(sys.argv))

   163