moin/2.0: MoinMoin/items/content.py comparison

comparison MoinMoin/items/content.py @ 1649:5dc142ab43d2

Keep itemtype and contenttype in Item and Content subclasses. Class decorators named @register are provided as helpers in items and items.content modules.

author	Cheer Xiao <xiaqqaix@gmail.com>
date	Wed, 08 Aug 2012 22:51:16 +0800
parents	1a2c53092ea1
children	fa66e4447d63

comparison

equal deleted inserted replaced

-:1a2c53092ea1
+:5dc142ab43d2
 """
 return self._register(self.Entry(factory, content_type, priority))
 content_registry = RegistryContent()
+def register(cls):
+content_registry.register(cls._factory, Type(cls.contenttype))
+return cls
 def conv_serialize(doc, namespaces, method='polyglot'):
 out = array('u')
 flaskg.clock.start('conv_serialize')
 query = And(terms)
 revs = flaskg.storage.search(query, sortedby=NAME_EXACT, limit=None)
 return [rev.meta[NAME] for rev in revs]
+@register
 class NonExistentContent(Content):
 """Dummy Content to use with NonExistent."""
+contenttype = 'application/x-nonexistent'
 def do_get(self, force_attachment=False, mimetype=None):
 abort(404)
 def _convert(self, doc):
 abort(404)
-content_registry.register(NonExistentContent._factory, Type('application/x-nonexistent'))
+@register
 class Binary(Content):
 """ An arbitrary binary item, fallback class for every item mimetype. """
+contenttype = '*/*'
 # XXX reads item rev data into memory!
 def get_data(self):
 if self.rev is not None:
 return self.rev.data.read()
 return send_file(file=file_to_send,
 mimetype=content_type,
 as_attachment=as_attachment, attachment_filename=filename,
 cache_timeout=10, # wiki data can change rapidly
 add_etags=True, etag=hash, conditional=True)
-content_registry.register(Binary._factory, Type('*/*'))
 class RenderableBinary(Binary):
 """ Base class for some binary stuff that renders with a object tag. """
 self.item._save(meta, data, name=self.name, action=u'SAVE', comment='')
 data.close()
 os.remove(temp_fname)
+@register
 class ApplicationXTar(TarMixin, Application):
 """
 Tar items
 """
+contenttype = 'application/x-tar'
-content_registry.register(ApplicationXTar._factory, Type('application/x-tar'))
-content_registry.register(ApplicationXTar._factory, Type('application/x-gtar'))
+@register
+class ApplicationXGTar(ApplicationXTar):
+"""
+Compressed tar items
+"""
+contenttype = 'application/x-gtar'
 class ZipMixin(object):
 """
 ZipMixin offers additional functionality for zip-like items to list and
 def put_member(self, name, content, content_length, expected_members):
 raise NotImplementedError
+@register
 class ApplicationZip(ZipMixin, Application):
 """
 Zip items
 """
+contenttype = 'application/zip'
-content_registry.register(ApplicationZip._factory, Type('application/zip'))
+@register
 class PDF(Application):
 """ PDF """
+contenttype = 'application/pdf'
-content_registry.register(PDF._factory, Type('application/pdf'))
+@register
 class Video(Binary):
 """ Base class for video/* """
+contenttype = 'video/*'
-content_registry.register(Video._factory, Type('video/*'))
+@register
 class Audio(Binary):
 """ Base class for audio/* """
+contenttype = 'audio/*'
-content_registry.register(Audio._factory, Type('audio/*'))
+@register
 class Image(Binary):
 """ Base class for image/* """
+contenttype = 'image/*'
-content_registry.register(Image._factory, Type('image/*'))
 class RenderableImage(RenderableBinary):
 """ Base class for renderable Image mimetypes """
+@register
 class SvgImage(RenderableImage):
 """ SVG images use <object> tag mechanism from RenderableBinary base class """
+contenttype = 'image/svg+xml'
-content_registry.register(SvgImage._factory, Type('image/svg+xml'))
 class RenderableBitmapImage(RenderableImage):
 """ PNG/JPEG/GIF images use <img> tag (better browser support than <object>) """
 # if mimetype is also transformable, please register in TransformableImage ONLY!
 return Response(data, headers=headers)
 def _render_data_diff_text(self, oldrev, newrev):
 return super(TransformableBitmapImage, self)._render_data_diff_text(oldrev, newrev)
-content_registry.register(TransformableBitmapImage._factory, Type('image/png'))
-content_registry.register(TransformableBitmapImage._factory, Type('image/jpeg'))
+@register
-content_registry.register(TransformableBitmapImage._factory, Type('image/gif'))
+class PNG(TransformableBitmapImage):
+""" PNG image. """
+contenttype = 'image/png'
+@register
+class JPEG(TransformableBitmapImage):
+""" JPEG image. """
+contenttype = 'image/jpeg'
+@register
+class GIF(TransformableBitmapImage):
+""" GIF image. """
+contenttype = 'image/gif'
+@register
 class Text(Binary):
 """ Base class for text/* """
+contenttype = 'text/*'
 class ModifyForm(Binary.ModifyForm):
 template = 'modify_text.html'
 data_text = String.using(strip=False, optional=True).with_properties(placeholder=L_("Type your text here"))
 rows = ROWS_DATA
 # TODO: Real output format
 html_conv = reg.get(type_moin_document, Type('application/x-xhtml-moin-page'))
 doc = html_conv(doc)
 return conv_serialize(doc, {html.namespace: ''})
-content_registry.register(Text._factory, Type('text/*'))
 class MarkupItem(Text):
 """
 some kind of item with markup
 (internal links and transcluded items)
 """
+@register
 class MoinWiki(MarkupItem):
 """ MoinMoin wiki markup """
+contenttype = 'text/x.moin.wiki'
-content_registry.register(MoinWiki._factory, Type('text/x.moin.wiki'))
+@register
 class CreoleWiki(MarkupItem):
 """ Creole wiki markup """
+contenttype = 'text/x.moin.creole'
-content_registry.register(CreoleWiki._factory, Type('text/x.moin.creole'))
+@register
 class MediaWiki(MarkupItem):
 """ MediaWiki markup """
+contenttype = 'text/x-mediawiki'
-content_registry.register(MediaWiki._factory, Type('text/x-mediawiki'))
+@register
 class ReST(MarkupItem):
 """ ReStructured Text markup """
+contenttype = 'text/x-rst'
-content_registry.register(ReST._factory, Type('text/x-rst'))
+@register
 class HTML(Text):
 """
 HTML markup
 Note: As we use html_in converter to convert this to DOM and later some
 output converterter to produce output format (e.g. html_out for html
 output), all(?) unsafe stuff will get lost.
 Note: If raw revision data is accessed, unsafe stuff might be present!
 """
+contenttype = 'text/html'
 class ModifyForm(Text.ModifyForm):
 template = "modify_text_html.html"
-content_registry.register(HTML._factory, Type('text/html'))
+@register
 class DocBook(MarkupItem):
 """ DocBook Document """
+contenttype = 'application/docbook+xml'
 def _convert(self, doc):
 from emeraldtree import ElementTree as ET
 from MoinMoin.converter import default_registry as reg
 doc = self._expand_document(doc)
 mimetype=content_type,
 as_attachment=as_attachment, attachment_filename=None,
 cache_timeout=10, # wiki data can change rapidly
 add_etags=False, etag=None, conditional=True)
-content_registry.register(DocBook._factory, Type('application/docbook+xml'))
 class Draw(TarMixin, Image):
 """
 Base class for *Draw that use special Java/Javascript applets to modify and store data in a tar file.
 """
 def handle_post():
 raise NotImplementedError
+@register
 class TWikiDraw(Draw):
 """
 drawings by TWikiDraw applet. It creates three files which are stored as tar file.
 """
+contenttype = 'application/x-twikidraw'
 class ModifyForm(Draw.ModifyForm):
 template = "modify_twikidraw.html"
 help = ""
 return Markup(image_map + u'<img src="{0}" alt="{1}" usemap="#{2}" />'.format(png_url, title, mapid))
 else:
 return Markup(u'<img src="{0}" alt="{1}" />'.format(png_url, title))
-content_registry.register(TWikiDraw._factory, Type('application/x-twikidraw'))
+@register
 class AnyWikiDraw(Draw):
 """
 drawings by AnyWikiDraw applet. It creates three files which are stored as tar file.
 """
+contenttype = 'application/x-anywikidraw'
 class ModifyForm(Draw.ModifyForm):
 template = "modify_anywikidraw.html"
 help = ""
 def _load(self, item):
 title = _('Clickable drawing: %(filename)s', filename=self.name)
 return Markup(image_map + u'<img src="{0}" alt="{1}" usemap="#{2}" />'.format(png_url, title, mapid))
 else:
 return Markup(u'<img src="{0}" alt="{1}" />'.format(png_url, title))
-content_registry.register(AnyWikiDraw._factory, Type('application/x-anywikidraw'))
+@register
 class SvgDraw(Draw):
 """ drawings by svg-edit. It creates two files (svg, png) which are stored as tar file. """
+contenttype = 'application/x-svgdraw'
 class ModifyForm(Draw.ModifyForm):
 template = "modify_svg-edit.html"
 help = ""
 # of items and also rendering them with the code in base class could work
 item_name = self.name
 drawing_url = url_for('frontend.get_item', item_name=item_name, member='drawing.svg', rev=self.rev.revid)
 png_url = url_for('frontend.get_item', item_name=item_name, member='drawing.png', rev=self.rev.revid)
 return Markup(u'<img src="{0}" alt="{1}" />'.format(png_url, drawing_url))
-content_registry.register(SvgDraw._factory, Type('application/x-svgdraw'))

Mercurial > moin > 2.0

comparison MoinMoin/items/content.py @ 1649:5dc142ab43d2