view MoinMoin/script/migration/moin19/ @ 1973:286e315935ae

refactor usage of constants don't import from config module, but from constants.* use uppercase for constant names
author Thomas Waldmann <tw AT waldmann-edv DOT de>
date Sun, 10 Feb 2013 22:50:21 +0100
parents 2bd864ed640e
children 87272c032485
line wrap: on
line source
# Copyright: 2008 MoinMoin:JohannesBerg
# Copyright: 2008-2011 MoinMoin:ThomasWaldmann
# License: GNU GPL v2 (or any later version), see LICENSE.txt for details.

MoinMoin - import content and user data from a moin 1.9 compatible storage
           into the moin2 storage.


* translate revno numbering into revid parents
* ACLs for attachments

import sys
import os
import re
import codecs
import hashlib
from StringIO import StringIO

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

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

from ._utils19 import quoteWikinameFS, unquoteWikiname, split_body
from ._logfile19 import LogFile

                                     USERID, MTIME, EXTRA, COMMENT, TAGS, SIZE, HASH_ALGORITHM, ITEMID, REVID)
from MoinMoin.constants.contenttypes import CONTENTTYPE_USER

UID_OLD = 'old_user_id' # dynamic field *_id, so we don't have to change schema

from import NoSuchRevisionError
from MoinMoin.util.mimetype import MimeType
from MoinMoin.util.crypto import make_uuid
from import serialize_rev
from MoinMoin import security

CHARSET = 'utf-8'

ACL_RIGHTS_CONTENTS = ['read', 'write', 'create', 'destroy', 'admin', ]


CONTENTTYPE_DEFAULT = u'text/plain;charset=utf-8'
CONTENTTYPE_MOINWIKI = u'text/;charset=utf-8'
    'text/wiki': CONTENTTYPE_MOINWIKI,
    'text/moin-wiki': CONTENTTYPE_MOINWIKI,
    'creole': u'text/x.moin.creole;charset=utf-8',
    'text/creole': u'text/x.moin.creole;charset=utf-8',
    'rst': u'text/rst;charset=utf-8',
    'text/rst': u'text/rst;charset=utf-8',
    'plain': u'text/plain;charset=utf-8',
    'text/plain': u'text/plain;charset=utf-8',

class ImportMoin19(Command):
    description = 'Import data from a moin 1.9 wiki.'

    option_list = [
        Option('--data_dir', '-d', dest='data_dir', type=unicode, required=True,
               help='moin 1.9 data_dir (contains pages and users subdirectories).'),

    def run(self, data_dir=None):
        indexer =
        backend = indexer.backend # backend without indexing
        print "Users..."
        for rev in UserBackend(os.path.join(data_dir, 'user')): # assumes user/ below data_dir

        print "Pages/Attachments..."
        for rev in PageBackend(data_dir, deleted_mode=DELETED_MODE_KILL, default_markup=u'wiki'):

        print "Building the index..."

        print "Fix userids..."
        userid_map = dict([(rev.meta[UID_OLD], rev.meta[ITEMID]) for rev in indexer.documents(contenttype=CONTENTTYPE_USER)])
        for mountpoint, revid in backend:
            meta, data = backend.retrieve(mountpoint, revid)
            if USERID in meta:
                    meta[USERID] = userid_map[meta[USERID]]
                except KeyError:
                    # user profile lost, but userid referred by revision
                    print "lost {0!r}".format(meta[USERID])
                    del meta[USERID]
      , data)
            elif meta.get(CONTENTTYPE) == CONTENTTYPE_USER:
                meta.pop(UID_OLD, None) # not needed any more
      , data)

        print "Rebuilding the index..."

class KillRequested(Exception):
    """raised if item killing is requested by DELETED_MODE"""

class PageBackend(object):
    moin 1.9 page directory
    def __init__(self, path, deleted_mode=DELETED_MODE_KEEP,
        :param path: storage path (data_dir)
        :param deleted_mode: 'kill' - just ignore deleted pages (pages with
                                      non-existing current revision) and their attachments
                                      as if they were not there.
                                      Non-deleted pages (pages with an existing current
                                      revision) that have non-current deleted revisions
                                      will be treated as for 'keep'.
                             'keep' - keep deleted pages as items with empty revisions,
                                      keep their attachments. (default)
        :param default_markup: used if a page has no #format line, moin 1.9's default
                               'wiki' and we also use this default here.
        self._path = path
        assert deleted_mode in (DELETED_MODE_KILL, DELETED_MODE_KEEP, )
        self.deleted_mode = deleted_mode
        self.format_default = default_markup
        self.item_category_regex = re.compile(item_category_regex, re.UNICODE)

    def __iter__(self):
        pages_dir = os.path.join(self._path, 'pages')
        for f in os.listdir(pages_dir):
            itemname = unquoteWikiname(f)
                item = PageItem(self, os.path.join(pages_dir, f), itemname)
            except Exception as err:
                logging.exception("PageItem {0!r} raised exception:".format(itemname))
                for rev in item.iter_revisions():
                    yield rev
                for rev in item.iter_attachments():
                    yield rev

class PageItem(object):
    moin 1.9 page
    def __init__(self, backend, path, itemname):
        self.backend = backend = itemname
        self.path = path
        currentpath = os.path.join(self.path, 'current')
        with open(currentpath, 'r') as f:
            self.current = int(
        editlogpath = os.path.join(self.path, 'edit-log')
        self.editlog = EditLog(editlogpath)
        self.acl = None # TODO
        self.itemid = make_uuid()
        if backend.deleted_mode == DELETED_MODE_KILL:
            revpath = os.path.join(self.path, 'revisions', '{0:08d}'.format(self.current))
            PageRevision(self, self.current, revpath) # will raise exception if killing is requested

    def iter_revisions(self):
        revisionspath = os.path.join(self.path, 'revisions')
            # rather use this or a range(1, self.current+1)?
            fnames = os.listdir(revisionspath)
        except OSError:
            fnames = []
        for fname in fnames:
                revno = int(fname)
                yield PageRevision(self, revno, os.path.join(revisionspath, fname))
            except Exception as err:
                logging.exception("PageRevision {0!r} {1!r} raised exception:".format(, fname))

    def iter_attachments(self):
        attachmentspath = os.path.join(self.path, 'attachments')
            fnames = os.listdir(attachmentspath)
        except OSError:
            fnames = []
        for fname in fnames:
            attachname = fname.decode('utf-8')
                yield AttachmentRevision(, attachname, os.path.join(attachmentspath, fname), self.editlog, self.acl)
            except Exception as err:
                logging.exception("AttachmentRevision {0!r}/{1!r} raised exception:".format(, attachname))

class PageRevision(object):
    moin 1.9 page revision
    def __init__(self, item, revno, path):
        item_name =
        itemid = item.itemid
        editlog = item.editlog
        self.backend = item.backend
        # we just read the page and parse it here, makes the rest of the code simpler:
            with, 'r', CHARSET) as f:
                content =
        except (IOError, OSError):
            if revno == item.current and self.backend.deleted_mode == DELETED_MODE_KILL:
                raise KillRequested('deleted_mode wants killing/ignoring')
            # handle deleted revisions (for all revnos with 0<=revno<=current) here
            # we prepare some values for the case we don't find a better value in edit-log:
            meta = {MTIME: -1, # fake, will get 0 in the end
                    NAME: item_name, # will get overwritten with name from edit-log
                                     # if we have an entry there
                revpath = os.path.join(item.path, 'revisions', '{0:08d}'.format(revno-1))
                previous_meta = PageRevision(item, revno-1, revpath).meta
                # if this page revision is deleted, we have no on-page metadata.
                # but some metadata is required, thus we have to copy it from the
                # (non-deleted) revision revno-1:
                for key in [ACL, NAME, CONTENTTYPE, MTIME, ]:
                    if key in previous_meta:
                        meta[key] = previous_meta[key]
            except NoSuchRevisionError:
                pass # should not happen
            meta[MTIME] += 1 # it is now either 0 or prev rev mtime + 1
            data = u''
                editlog_data = editlog.find_rev(revno)
            except KeyError:
                if 0 <= revno <= item._fs_current:
                    editlog_data = { # make something up
                        ACTION: u'SAVE/DELETE',
                    raise NoSuchRevisionError('Item {0!r} has no revision {1} (not even a deleted one)!'.format(, revno))
                editlog_data = editlog.find_rev(revno)
            except KeyError:
                if 1 <= revno <= item.current:
                    editlog_data = { # make something up
                        MTIME: int(os.path.getmtime(path)),
                        ACTION: u'SAVE',
            meta, data = split_body(content)
        format = meta.pop('format', self.backend.format_default)
        data = self._process_data(meta, data)
        data = data.encode(CHARSET)
        size, hash_name, hash_digest = hash_hexdigest(data)
        meta[hash_name] = hash_digest
        meta[SIZE] = size
        meta[ITEMID] = itemid
        meta[REVID] = make_uuid()
        self.meta = {}
        for k, v in meta.iteritems():
            if isinstance(v, list):
                v = tuple(v)
            self.meta[k] = v = StringIO(data)

        acl_line = self.meta.get(ACL)
        if acl_line is not None:
            self.meta[ACL] = regenerate_acl(acl_line)

    def _process_data(self, meta, data):
        """ In moin 1.x markup, not all metadata is stored in the page's header.
            E.g. categories are stored in the footer of the page content. For
            moin2, we extract that stuff from content and put it into metadata.
            data = process_categories(meta, data, self.backend.item_category_regex)
        return data

def process_categories(meta, data, item_category_regex):
    # process categories to tags
    # find last ---- in the data plus the categories below it
    m ='\n\r?\s*-----*', data[::-1])
    if m:
        start = m.start()
        end = m.end()
        # categories are after the ---- line
        if start > 0:
            categories = data[-start:]
            categories = u''
        # remove the ---- line from the content
        data = data[:-end]
        if categories:
            # for CategoryFoo, group 'all' matches CategoryFoo, group 'key' matches just Foo
            # we use 'all' so we don't need to rename category items
            matches = list(item_category_regex.finditer(categories))
            if matches:
                tags = ['all') for m in matches]
                meta.setdefault(TAGS, []).extend(tags)
                # remove everything between first and last category from the content
                start = matches[0].start()
                end = matches[-1].end()
                rest = categories[:start] + categories[end:]
                data += u'\r\n' + rest.lstrip()
        data = data.rstrip() + u'\r\n'
    return data

class AttachmentRevision(object):
    moin 1.9 attachment (there is no revisioning, just 1 revision per attachment)
    def __init__(self, item_name, attach_name, attpath, editlog, acl):
            meta = editlog.find_attach(attach_name)
        except KeyError:
            meta = { # make something up
                MTIME: int(os.path.getmtime(attpath)),
                ACTION: u'SAVE',
        meta[NAME] = u'{0}/{1}'.format(item_name, attach_name)
        if acl is not None:
            meta[ACL] = acl
        meta[CONTENTTYPE] = unicode(MimeType(filename=attach_name).content_type())
        f = open(attpath, 'rb')
        size, hash_name, hash_digest = hash_hexdigest(f) = f
        meta[hash_name] = hash_digest
        meta[SIZE] = size
        meta[ITEMID] = make_uuid()
        meta[REVID] = make_uuid()
        self.meta = meta

class EditLog(LogFile):
    """ Access the edit-log and return metadata as the new api wants it. """
    def __init__(self, filename, buffer_size=4096):
        LogFile.__init__(self, filename, buffer_size)
        self._NUM_FIELDS = 9

    def parser(self, line):
        """ Parse edit-log line into fields """
        fields = line.strip().split(u'\t')
        fields = (fields + [u''] * self._NUM_FIELDS)[:self._NUM_FIELDS]
        result = dict(zip(keys, fields))
        # do some conversions/cleanups/fallbacks:
        result[MTIME] = int(long(result[MTIME] or 0) / 1000000) # convert usecs to secs
        result['__rev'] = int(result['__rev']) - 1 # old storage is 1-based, we want 0-based
        result[NAME] = unquoteWikiname(result[NAME])
        action = result[ACTION]
        extra = result[EXTRA]
        if extra:
            if action.startswith('ATT'):
                result[NAME] += u'/' + extra # append filename to pagename
                # keep EXTRA for find_attach
            elif action == 'SAVE/RENAME':
                if extra:
                    result[NAME_OLD] = extra
                del result[EXTRA]
                result[ACTION] = u'RENAME'
            elif action == 'SAVE/REVERT':
                if extra:
                    result[REVERTED_TO] = int(extra)
                del result[EXTRA]
                result[ACTION] = u'REVERT'
        userid = result[USERID]
        #if userid:
        #    result[USERID] = self.idx.user_uuid(old_id=userid, refcount=True)
        return result

    def find_rev(self, revno):
        """ Find metadata for some revno revision in the edit-log. """
        for meta in self:
            if meta['__rev'] == revno:
            raise KeyError
        del meta['__rev']
        meta = dict([(k, v) for k, v in meta.items() if v]) # remove keys with empty values
        if meta.get(ACTION) == u'SAVENEW':
            # replace SAVENEW with just SAVE
            meta[ACTION] = u'SAVE'
        return meta

    def find_attach(self, attachname):
        """ Find metadata for some attachment name in the edit-log. """
        for meta in self.reverse(): # use reverse iteration to get the latest upload's data
            if (meta['__rev'] == 99999998 and  # 99999999-1 because of 0-based
                meta[ACTION] == 'ATTNEW' and
                meta[EXTRA] == attachname):
            raise KeyError
        del meta['__rev']
        del meta[EXTRA] # we have full name in NAME
        meta[ACTION] = u'SAVE'
        meta = dict([(k, v) for k, v in meta.items() if v]) # remove keys with empty values
        return meta

def regenerate_acl(acl_string, acl_rights_valid=ACL_RIGHTS_CONTENTS):
    """ recreate ACL string to remove invalid rights """
    assert isinstance(acl_string, unicode)
    result = []
    for modifier, entries, rights in security.ACLStringIterator(acl_rights_valid, acl_string):
        if (entries, rights) == (['Default'], []):
                          u','.join(rights) # iterator has removed invalid rights
    result = u' '.join(result)
    logging.debug("regenerate_acl {0!r} -> {1!r}".format(acl_string, result))
    return result

def _decode_list(line):
    Decode list of items from user data file

    :param line: line containing list of items, encoded with _encode_list
    :rtype: list of unicode strings
    :returns: list of items in encoded in line
    items = [item.strip() for item in line.split('\t')]
    items = [item for item in items if item]
    return tuple(items)

def _decode_dict(line):
    Decode dict of key:value pairs from user data file

    :param line: line containing a dict, encoded with _encode_dict
    :rtype: dict
    :returns: dict  unicode:unicode items
    items = [item.strip() for item in line.split('\t')]
    items = [item for item in items if item]
    items = [item.split(':', 1) for item in items]
    return dict(items)

class UserRevision(object):
    moin 1.9 user
    def __init__(self, path, uid):
        self.path = path
        self.uid = uid
        meta = self._process_usermeta(self._parse_userprofile())
        meta[UID_OLD] = uid
        meta[ITEMID] = make_uuid()
        meta[REVID] = make_uuid()
        meta[SIZE] = 0
        meta[ACTION] = u'SAVE'
        self.meta = meta = StringIO('')

    def _parse_userprofile(self):
        with, self.uid), "r", CHARSET) as meta_file:
            metadata = {}
            for line in meta_file:
                if line.startswith('#') or line.strip() == "":
                key, value = line.strip().split('=', 1)
                # Decode list values
                if key.endswith('[]'):
                    key = key[:-2]
                    value = _decode_list(value)

                # Decode dict values
                elif key.endswith('{}'):
                    key = key[:-2]
                    value = _decode_dict(value)

                metadata[key] = value
        return metadata

    def _process_usermeta(self, metadata):
        # stuff we want to have stored as boolean:
        bool_defaults = [ # taken from cfg.checkbox_defaults
            ('show_comments', 'False'),
            ('edit_on_doubleclick', 'True'),
            ('scroll_page_after_edit', 'True'),
            ('want_trivial', 'False'),
            ('mailto_author', 'False'),
            ('disabled', 'False'),
        for key, default in bool_defaults:
            metadata[key] = metadata.get(key, default) in ['True', 'true', '1']

        # stuff we want to have stored as integer:
        int_defaults = [
            ('edit_rows', '0'),
        for key, default in int_defaults:
            metadata[key] = int(metadata.get(key, default))

        # rename last_saved to MTIME, int MTIME should be enough:
        metadata[MTIME] = int(float(metadata.get('last_saved', '0')))

        # rename aliasname to display_name:
        metadata['display_name'] = metadata.get('aliasname')

        # rename subscribed_pages to subscribed_items
        metadata['subscribed_items'] = metadata.get('subscribed_pages', [])

        # convert bookmarks from usecs (and str) to secs (int)
        metadata['bookmarks'] = [(interwiki, int(long(bookmark)/1000000))
                                 for interwiki, bookmark in metadata.get('bookmarks', {}).items()]

        # stuff we want to get rid of:
        kill = ['aliasname', # renamed to display_name
                'real_language', # crap (use 'language')
                'wikiname_add_spaces', # crap magic (you get it like it is)
                'recoverpass_key', # user can recover again if needed
                'editor_default', # not used any more
                'editor_ui', # not used any more
                'external_target', # ancient, not used any more
                'passwd', # ancient, not used any more (use enc_password)
                'show_emoticons', # ancient, not used any more
                'show_fancy_diff', # kind of diff display now depends on mimetype
                'show_fancy_links', # not used any more (now link rendering depends on theme)
                'show_toolbar', # not used any more
                'show_topbottom', # crap
                'show_nonexist_qm', # crap, can be done by css
                'show_page_trail', # theme decides whether to show trail
                'remember_last_visit', # we show trail, user can click there
                'remember_me', # don't keep sessions open for a long time
                'subscribed_pages', # renamed to subscribed_items
                'edit_cols', # not used any more
                'jid', # no jabber support
                'tz_offset', # we have real timezone now
                'date_fmt', # not used any more
                'datetime_fmt', # not used any more
                'last_saved', # renamed to MTIME
                'email_subscribed_events', # XXX no support yet
                'jabber_subscribed_events', # XXX no support yet
        for key in kill:
            if key in metadata:
                del metadata[key]

        # finally, remove some empty values (that have empty defaults anyway or
        # make no sense when empty):
        empty_kill = ['aliasname', 'display_name', 'bookmarks', 'enc_password',
                      'language', 'css_url', 'email', ] # XXX check subscribed_items, quicklinks
        for key in empty_kill:
            if key in metadata and metadata[key] in [u'', tuple(), {}, [], ]:
                del metadata[key]

        # moin2 only supports passlib generated hashes, drop everything else
        # (users need to do pw recovery in case they are affected)
        pw = metadata.get('enc_password')
        if pw is not None:
            if pw.startswith('{PASSLIB}'):
                # take it, but strip the prefix as moin2 does not use that any more
                metadata['enc_password'] = pw[len('{PASSLIB}'):]
                # drop old, unsupported (and also more or less unsafe) hashing scheme
                del metadata['enc_password']

        # TODO quicklinks and subscribed_items - check for non-interwiki elements and convert them to interwiki

        return metadata

class UserBackend(object):
    moin 1.9 user directory
    def __init__(self, path):
        :param path: user_dir path
        self.path = path

    def __iter__(self):
        user_re = re.compile(r'^\d+\.\d+(\.\d+)?$')
        for uid in os.listdir(self.path):
            if user_re.match(uid):
                    rev = UserRevision(self.path, uid)
                except Exception as err:
                    logging.exception("Exception in user item processing {0}".format(uid))
                    yield rev

def hash_hexdigest(content, bufsize=4096):
    size = 0
    hash =
    if hasattr(content, "read"):
        while True:
            buf =
            size += len(buf)
            if not buf:
    elif isinstance(content, str):
        size = len(content)
        raise ValueError("unsupported content object: {0!r}".format(content))
    return size, HASH_ALGORITHM, unicode(hash.hexdigest())