src/pyams_utils/text.py
changeset 1 3f89629b9e54
child 35 ff081a708652
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/pyams_utils/text.py	Thu Feb 19 00:46:48 2015 +0100
@@ -0,0 +1,140 @@
+#
+# Copyright (c) 2008-2015 Thierry Florac <tflorac AT ulthar.net>
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+
+__docformat__ = 'restructuredtext'
+
+
+# import standard library
+import html
+import docutils.core
+
+# import interfaces
+from pyams_utils.interfaces.tales import ITALESExtension
+from pyams_utils.interfaces.text import IHTMLRenderer
+from pyramid.interfaces import IRequest
+from zope.schema.interfaces import IVocabularyFactory
+
+# import packages
+from pyams_utils.adapter import ContextRequestViewAdapter, adapter_config
+from pyams_utils.request import check_request
+from zope.component import adapter
+from zope.interface import implementer, provider, Interface
+from zope.schema.vocabulary import SimpleVocabulary, SimpleTerm, getVocabularyRegistry
+
+
+def get_text_start(text, length, max=0):
+    """Get first words of given text with maximum given length
+    
+    If @max is specified, text is shortened only if remaining text is longer than @max
+    
+    @param text: initial text
+    @param length: maximum length of resulting text
+    @param max: if > 0, @text is shortened only if remaining text is longer than max
+
+    >>> from pyams_utils.text import get_text_start
+    >>> get_text_start('This is a long string', 10)
+    'This is a&#133;'
+    >>> get_text_start('This is a long string', 20)
+    'This is a long&#133;'
+    >>> get_text_start('This is a long string', 20, 7)
+    'This is a long string'
+    """
+    result = text or ''
+    if length > len(result):
+        return result
+    index = length - 1
+    text_length = len(result)
+    while (index > 0) and (result[index] != ' '):
+        index -= 1
+    if (index > 0) and (text_length > index + max):
+        return result[:index] + '&#133;'
+    return text
+
+
+@adapter_config(name='text', context=(str, IRequest), provides=IHTMLRenderer)
+class BaseHTMLRenderer(object):
+    """Raw text renderer utility class"""
+
+    def __init__(self, context, request):
+        self.context = context
+        self.request = request
+
+    def render(self, **kwargs):
+        return self.context
+
+
+@adapter_config(name='text', context=(str, IRequest), provides=IHTMLRenderer)
+class TextRenderer(BaseHTMLRenderer):
+    """Render raw text to HTML"""
+
+    def render(self, **kwargs):
+        return html.escape(self.context).replace('\n', '<br />\n')
+
+
+@adapter_config(name='rest', context=(str, IRequest), provides=IHTMLRenderer)
+class ReStructuredTextRenderer(BaseHTMLRenderer):
+    """Render reStructuredText to HTML"""
+
+    def render(self, **kwargs):
+        """Render reStructuredText to HTML"""
+        overrides = {
+            'halt_level': 6,
+            'input_encoding': 'unicode',
+            'output_encoding': 'unicode',
+            'initial_header_level': 3,
+        }
+        if 'settings' in kwargs:
+            overrides.update(kwargs['settings'])
+        parts = docutils.core.publish_parts(self.context,
+                                            writer_name='html',
+                                            settings_overrides=overrides)
+        return ''.join((parts['body_pre_docinfo'], parts['docinfo'], parts['body']))
+
+
+def text_to_html(text, renderer='text'):
+    """Convert text to HTML using the given renderer"""
+    request = check_request()
+    registry = request.registry
+    renderer = registry.queryMultiAdapter((text, request), IHTMLRenderer, name=renderer)
+    if renderer is not None:
+        return renderer.render()
+
+
+@adapter_config(name='html', context=(Interface, Interface, Interface), provides=ITALESExtension)
+class HTMLTalesExtension(ContextRequestViewAdapter):
+    """extension:html TALES expression"""
+
+    def render(self, context):
+        if context is None:
+            context = self.context
+        renderer = self.request.registry.queryMultiAdapter((context, self.request, self.view), IHTMLRenderer)
+        if renderer is not None:
+            return renderer.render()
+        elif isinstance(context, str):
+            return text_to_html(context, 'text')
+        else:
+            return str(context)
+
+
+@provider(IVocabularyFactory)
+class RenderersVocabulary(SimpleVocabulary):
+    """Text renderers vocabulary"""
+
+    def __init__(self):
+        request = check_request()
+        registry = request.registry
+        translate = registry.localizer.translate
+        terms = [SimpleTerm(name, name, translate(adapt.title).label)
+                 for name, adapt in registry.getAdapters(('', request), IHTMLRenderer)]
+        super(RenderersVocabulary, self).__init__(terms)
+
+getVocabularyRegistry().register('PyAMS HTML renderers', RenderersVocabulary)