1. Thomas Waldmann
  2. moin-2.0

Source

moin-2.0 / MoinMoin / script / maint / serialization.py

# Copyright: 2011 MoinMoin:ThomasWaldmann
# License: GNU GPL v2 (or any later version), see LICENSE.txt for details.

"""
MoinMoin - backend serialization / deserialization
"""

import sys

from flask import current_app as app
from flask.ext.script import Command, Option

from MoinMoin.storage.middleware.serialization import serialize, deserialize

from MoinMoin import log
logging = log.getLogger(__name__)

def open_file(filename, mode):
    if filename is None:
        # Guess the IO stream from the mode:
        if "a" in mode or "w" in mode:
            stream = sys.stdout
        elif "r" in mode:
            stream = sys.stdin
        else:
            raise ValueError("Invalid mode string. Must contain 'r', 'w' or 'a'")

        # On Windows force the stream to be in binary mode if it's needed.
        if sys.platform == "win32" and "b" in mode:
            import os, msvcrt
            msvcrt.setmode(stream.fileno(), os.O_BINARY)

        f = stream
    else:
        f = open(filename, mode)
    return f

class Serialize(Command):
    description = 'Serialize the backend into a file.'

    option_list = [
        Option('--file', '-f', dest='filename', type=unicode, required=False,
               help='Filename of the output file.'),
        Option('--backends', '-b', dest='backends', type=unicode, required=False,
               help='Backend names to serialize (comma separated).'),
        Option('--all-backends', '-a', dest='all_backends', action='store_true', default=False,
               help='Serialize all configured backends.'),
    ]

    def run(self, filename=None, backends=None, all_backends=False):
        if filename is None:
            f = sys.stdout
        else:
            f = open(filename, "wb")
        with f as f:
            existing_backends = set(app.cfg.backend_mapping)
            if all_backends:
                backends = set(app.cfg.backend_mapping)
            elif backends:
                backends = set(backends.split(','))
            if backends:
                # low level - directly serialize some backend contents -
                # this does not use the index:
                if backends.issubset(existing_backends):
                    for backend_name in backends:
                        backend = app.cfg.backend_mapping.get(backend_name)
                        serialize(backend, f)
                else:
                    print "Error: Wrong backend name given."
                    print "Given Backends: %r" % backends
                    print "Configured Backends: %r" % existing_backends


class Deserialize(Command):
    description = 'Deserialize a file into the backend.'

    option_list = [
        Option('--file', '-f', dest='filename', type=unicode, required=False,
               help='Filename of the input file.'),
    ]

    def run(self, filename=None):
        with open_file(filename, "rb") as f:
            deserialize(f, app.storage.backend)