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
0
d5fd342015d3 initial rsync-lvm-server script
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     1
#!/usr/bin/python
d5fd342015d3 initial rsync-lvm-server script
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
     2
8
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
     3
"""
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
     4
    SSH authorized_keys command="..." wrapper for rsync.
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
     5
"""
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
     6
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents: 4
diff changeset
     7
from pvl.backup.rsync import RSyncCommandFormatError
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents: 4
diff changeset
     8
from pvl.backup.invoke import InvokeError
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents: 4
diff changeset
     9
from pvl.backup import rsync
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    10
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents: 4
diff changeset
    11
import optparse
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents: 4
diff changeset
    12
import os
0
d5fd342015d3 initial rsync-lvm-server script
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    13
import logging
d5fd342015d3 initial rsync-lvm-server script
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    14
d5fd342015d3 initial rsync-lvm-server script
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    15
log = logging.getLogger()
d5fd342015d3 initial rsync-lvm-server script
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
    16
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    17
# command-line options
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    18
options = None
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    19
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    20
def parse_options (argv) :
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    21
    """
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    22
        Parse command-line arguments.
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    23
    """
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    24
8
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    25
    parser = optparse.OptionParser(
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    26
            prog        = argv[0],
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    27
8
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    28
            # module docstring
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    29
            description = __doc__,
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    30
    )
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    31
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    32
    # logging
8
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    33
    general = optparse.OptionGroup(parser, "General Options")
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    34
8
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    35
    general.add_option('-q', '--quiet',      dest='loglevel', action='store_const', const=logging.WARNING, help="Less output")
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    36
    general.add_option('-v', '--verbose',    dest='loglevel', action='store_const', const=logging.INFO,  help="More output")
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    37
    general.add_option('-D', '--debug',      dest='loglevel', action='store_const', const=logging.DEBUG, help="Even more output")
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    38
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    39
    parser.add_option_group(general)
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    40
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    41
    #
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    42
    parser.add_option('-c', '--command',    metavar='CMD', default=os.environ.get('SSH_ORIGINAL_COMMAND'),
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    43
            help="rsync command to execute")
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    44
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    45
    parser.add_option('-R', '--readonly',   action='store_true', default=False,
8
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    46
            help="restrict to read/source mode")
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    47
8
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    48
    parser.add_option('-P', '--restrict-path', metavar='PATH', default=False,
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    49
            help="restrict to given path prefix")
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    50
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    51
    # defaults
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    52
    parser.set_defaults(
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    53
        loglevel    = logging.WARNING,
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    54
    )
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    55
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    56
    # parse
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    57
    options, args = parser.parse_args(argv[1:])
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    58
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    59
    # configure
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    60
    logging.basicConfig(
11
f8dd32bf0e89 logging format
Tero Marttila <terom@paivola.fi>
parents: 8
diff changeset
    61
        format  = '%(levelname)6s %(name)s : %(funcName)s : %(message)s',
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    62
        level   = options.loglevel,
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    63
    )
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    64
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    65
    return options, args
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    66
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    67
def rsync_wrapper (command, restrict='lvm:') :
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    68
    """
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    69
        Wrap given rsync command.
8
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    70
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    71
        Parses the command, the source path, and then executes rsync within the source path (which may be a special
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    72
        pseudo-path with additional handling).
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    73
    """
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    74
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    75
    try :
8
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    76
        # parse the rsync command sent by the client
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents: 4
diff changeset
    77
        rsync_cmd, rsync_options, source_path, dest_path = rsync.parse_command(command, 
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    78
                restrict_readonly   = options.readonly,
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    79
            )
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    80
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    81
    except RSyncCommandFormatError, e:
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    82
        log.error("invalid rsync command: %r: %s", command, e)
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    83
        return 2
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    84
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    85
    # XXX: the real path is always given second..
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    86
    path = dest_path
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    87
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    88
    try :
8
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    89
        # parse the source path as given by the client, may be a real path or pseudo-path
5
23371d26fdd0 split up into pvl.backup package
Tero Marttila <terom@paivola.fi>
parents: 4
diff changeset
    90
        source = rsync.parse_source(path,
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    91
                restrict_path       = options.restrict_path,
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    92
            )
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    93
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    94
    except RSyncCommandFormatError, e:
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    95
        log.error("invalid rsync source: %r: %s", path, e)
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    96
        return 2
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    97
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
    98
    try :
8
5ae35c5afc69 docdoc/--help
Tero Marttila <terom@paivola.fi>
parents: 6
diff changeset
    99
        # run rsync within the source (may perform additional stuff like snapshotting...)
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   100
        source.execute(rsync_options)
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   101
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   102
    except InvokeError, e:
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   103
        log.error("%s failed: %d", e.cmd, e.exit)
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   104
        return e.exit
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   105
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   106
    # ok
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   107
    return 0
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   108
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   109
def main (argv) :
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   110
    global options
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   111
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   112
    # global options + args
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   113
    options, args = parse_options(argv)
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   114
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   115
    # args
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   116
    if args :
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   117
        log.error("No arguments are handled")
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   118
        return 2
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   119
12
fbfdde7326f4 rsync-snapshot: manage --link-dest'd interval snapshots
Tero Marttila <terom@paivola.fi>
parents: 11
diff changeset
   120
    # command required
3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   121
    if not options.command:
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   122
        log.error("SSH_ORIGINAL_COMMAND not given")
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   123
        return 2
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   124
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   125
    try :
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   126
        # handle it
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   127
        return rsync_wrapper(options.command)
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   128
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   129
    except Exception, e:
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   130
        log.error("Internal error:", exc_info=e)
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   131
        return 3
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   132
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   133
    # ok
d9e3a4ed5569 fully implemented
Tero Marttila <terom@paivola.fi>
parents: 2
diff changeset
   134
    return 0
0
d5fd342015d3 initial rsync-lvm-server script
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   135
d5fd342015d3 initial rsync-lvm-server script
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   136
if __name__ == '__main__' :
d5fd342015d3 initial rsync-lvm-server script
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   137
    import sys
d5fd342015d3 initial rsync-lvm-server script
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   138
d5fd342015d3 initial rsync-lvm-server script
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   139
    sys.exit(main(sys.argv))
d5fd342015d3 initial rsync-lvm-server script
Tero Marttila <terom@paivola.fi>
parents:
diff changeset
   140