view MoinMoin/converter/ @ 1752:bff62fea804a

fix for #29 Transcluded csv page is not wrapped with object overlay; updated other converters to consistently return rather than table, object, etc.
author Roger Haase <>
date Sun, 26 Aug 2012 14:03:02 -0700
parents 614005b5edb3
children 0fbb4321de4a
line wrap: on
line source
# Copyright: 2010 MoinMoin:ThomasWaldmann
# License: GNU GPL v2 (or any later version), see LICENSE.txt for details.

MoinMoin - Archives converter (e.g. zip, tar)

Make a DOM Tree representation of an archive (== list contents of it in a table).

from datetime import datetime
import tarfile
import zipfile

from ._table import TableMixin

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

from MoinMoin.i18n import _, L_, N_
from MoinMoin.util.iri import Iri
from MoinMoin.util.tree import moin_page, xlink

class ArchiveException(Exception):
    exception class used in case of trouble with opening/listing an archive

class ArchiveConverter(TableMixin):
    Base class for archive converters, convert an archive to a DOM table
    with an archive listing.
    def _factory(cls, input, output, **kw):
        return cls()

    def process_name(self, member_name):
        attrib = {
            xlink.href: Iri(scheme='wiki', authority='', path='/'+self.item_name, query=u'do=get&member={0}'.format(member_name)),
        return moin_page.a(attrib=attrib, children=[member_name, ])

    def process_datetime(self, dt):
        return dt.isoformat()

    def process_size(self, size):
        return unicode(size)

    def __call__(self, rev, contenttype=None, arguments=None):
        self.item_name =
            contents = self.list_contents(
            contents = [(self.process_size(size),
                        ) for size, dt, name in contents]
            table = self.build_dom_table(contents, head=[_("Size"), _("Date"), _("Name")], cls='zebra')
            body = moin_page.body(children=(table, ))
            return, ))
        except ArchiveException as err:
            logging.exception("An exception within archive file handling occurred:")
            # XXX we also use a table for error reporting, could be
            # something more adequate, though:
            return self.build_dom_table([[str(err)]])

    def list_contents(self, fileobj):
        analyze archive we get as fileobj and return data for table rendering.

        We return a list of rows, each row is a list of cells.

        Usually each row is [size, datetime, name] for each archive member.

        In case of problems, it shall raise ArchiveException(error_msg).
        raise NotImplementedError

class TarConverter(ArchiveConverter):
    Support listing tar files.
    def list_contents(self, fileobj):
            rows = []
            tf =, mode='r')
            for tinfo in tf.getmembers():
            return rows
        except tarfile.TarError as err:
            raise ArchiveException(str(err))

class ZipConverter(ArchiveConverter):
    Support listing zip files.
    def list_contents(self, fileobj):
            rows = []
            zf = zipfile.ZipFile(fileobj, mode='r')
            for zinfo in zf.filelist:
                    datetime(*zinfo.date_time), # y,m,d,h,m,s
            return rows
        except (RuntimeError, zipfile.BadZipfile) as err:
            # RuntimeError is raised by zipfile stdlib module in case of
            # problems (like inconsistent slash and backslash usage in the
            # archive or a defective zip file).
            raise ArchiveException(str(err))

from . import default_registry
from MoinMoin.util.mime import Type, type_moin_document
default_registry.register(TarConverter._factory, Type('application/x-tar'), type_moin_document)
default_registry.register(TarConverter._factory, Type('application/x-gtar'), type_moin_document)
default_registry.register(ZipConverter._factory, Type('application/zip'), type_moin_document)