collective.bbcodesnippets 2.0.0__py3-none-any.whl

collective/bbcodesnippets/__init__.py

@@ -0,0 +1,5 @@
+from . import tinymce  # noqa F401
+from zope.i18nmessageid import MessageFactory
+
+
+_ = MessageFactory("collective.bbcodesnippets")

collective/bbcodesnippets/configure.zcml

@@ -0,0 +1,106 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:genericsetup="http://namespaces.zope.org/genericsetup"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:i18n="http://namespaces.zope.org/i18n"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    i18n_domain="collective.bbcodesnippets">
+
+  <!-- <i18n:registerTranslations directory="locales" /> -->
+
+  <include package="Products.CMFPlone" />
+  <include package="plone.restapi" />
+
+  <include file="formatters.zcml" />
+
+  <!-- Controlpanel -->
+  <genericsetup:registerProfile
+      name="default"
+      title="BBCode Snippets"
+      directory="profiles/default"
+      description="Installs the collective.bbcodesnippets add-on."
+      provides="Products.GenericSetup.interfaces.EXTENSION"
+      post_handler=".setuphandlers.post_install"
+      />
+
+  <genericsetup:registerProfile
+      name="uninstall"
+      title="BBCode Snippets (uninstall)"
+      directory="profiles/uninstall"
+      description="Uninstalls the collective.bbcodesnippets add-on."
+      provides="Products.GenericSetup.interfaces.EXTENSION"
+      post_handler=".setuphandlers.uninstall"
+      />
+
+  <!-- Has to go after the default profile definition -->
+  <include package=".upgrades" />
+
+  <utility
+      factory=".setuphandlers.HiddenProfiles"
+      name="collective.bbcodesnippets-hiddenprofiles"
+      />
+
+  
+  <!-- Controlpanel -->
+  <browser:page
+      name="bbcodesnippets-controlpanel"
+      for="plone.base.interfaces.IPloneSiteRoot"
+      permission="plone.app.controlpanel.Markup"
+      class=".controlpanel.BBCodeControlPanel"
+      layer=".interfaces.IBBCodeSnippetsLayer"
+      />
+  <utility
+      component=".controlpanel.available_formatters_vocabulary_factory"
+      name="bbcodesnippets.available_formatters_vocabulary"
+   />
+  
+  <!-- transformer -->
+  <adapter
+      name="collective.bbcodesnippets.transform"
+      factory=".transform.BBCodeSnippetsTransform"
+  />  
+  
+  <!-- Toolbar Menu -->
+  <adapter for="* .interfaces.IBBCodeSnippetsLayer"
+      name="plone.contentmenu.bbcodesnippets_menu_item"
+      factory=".menu.BBCodeSnippetesMainMenuItem"
+      provides="plone.app.contentmenu.interfaces.IContentMenuItem" />
+
+  <browser:menu
+      id="bbcodesnippets_menu"
+      title="BBCode Snippets"
+      class=".menu.BBCodeSnippetesMenu"
+  />
+  
+  <!-- Restapi -->
+  <plone:service
+    method="GET"
+    for="zope.interface.Interface"
+    layer=".interfaces.IBBCodeSnippetsLayer"
+    factory=".restapi.EnabledSnippetsGet"
+    name="@bbcodesnippets_enabled"
+    permission="zope2.View"
+    />
+
+  <!-- Publish static files -->
+  <plone:static
+      name="collective.bbcodesnippets"
+      type="plone"
+      directory="static"
+      />
+
+  <!-- indexer -->
+  <adapter
+    factory=".indexer.has_bbcode"
+    name="has_bbcode"
+  />
+      
+  <!-- Demo -->
+  <browser:page
+      name="bbcodesnippets-demo"
+      for="plone.base.interfaces.IPloneSiteRoot"
+      permission="plone.app.controlpanel.Markup"
+      class=".demo.DemoView"
+      template="demo.pt"
+      />
+</configure>

collective/bbcodesnippets/controlpanel.py

@@ -0,0 +1,49 @@
+from . import _
+from .interfaces import IFormatterFactory
+from operator import itemgetter
+from plone.app.registry.browser import controlpanel
+from plone.app.vocabularies.terms import TermWithDescription
+from z3c.form.browser.checkbox import CheckBoxFieldWidget
+from zope import schema
+from zope.component import getUtilitiesFor
+from zope.interface import Interface
+from zope.interface import provider
+from zope.schema.interfaces import IVocabularyFactory
+from zope.schema.vocabulary import SimpleVocabulary
+
+
+@provider(IVocabularyFactory)
+def available_formatters_vocabulary_factory(context):
+    terms = []
+    for name, factory in sorted(getUtilitiesFor(IFormatterFactory), key=itemgetter(0)):
+        terms.append(TermWithDescription(name, name, name, description=factory.__doc__))
+    return SimpleVocabulary(terms)
+
+
+class IBBCodeSnippetsSettings(Interface):
+    formatters = schema.List(
+        title=_("Available Formatters"),
+        description=_("Selected formatters will be enabled in the portal."),
+        value_type=schema.Choice(
+            vocabulary="bbcodesnippets.available_formatters_vocabulary",
+        ),
+        default=[],
+        missing_value=[],
+        required=False,
+    )
+
+
+class BBCodeControlPanelForm(controlpanel.RegistryEditForm):
+    id = "BBCodeControlPanel"
+    label = _("BBCode Snippets")
+    description = _("BBCode snippets settings.")
+    schema = IBBCodeSnippetsSettings
+    schema_prefix = "bbcodesnippets"
+
+    def updateFields(self):
+        super().updateFields()
+        self.fields["formatters"].widgetFactory = CheckBoxFieldWidget
+
+
+class BBCodeControlPanel(controlpanel.ControlPanelFormWrapper):
+    form = BBCodeControlPanelForm

collective/bbcodesnippets/demo.pt

@@ -0,0 +1,17 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" xmlns:tal="http://xml.zope.org/namespaces/tal" xmlns:metal="http://xml.zope.org/namespaces/metal" xmlns:i18n="http://xml.zope.org/namespaces/i18n" lang="en" metal:use-macro="context/@@main_template/macros/master" i18n:domain="kup.akivdb">
+
+<body>
+  <metal:content-core fill-slot="content-title">
+    <h1>BBCode Snippets Demo</h1>
+  </metal:content-core>
+  <metal:content-core fill-slot="content-core">
+    <metal:block define-macro="content-core">
+      <article tal:repeat="docssnippet python:view.docsnippets()"> 
+        <h2 tal:define="snippet python:docssnippet['snippet']">${python:docssnippet['name']} <a class="small" title="Copy ${snippet} to clipboard" href="javascript:navigator.clipboard.writeText('${snippet}');">Copy</a></h2>
+        <p class="small">[${python:'X' if docssnippet['enabled'] else '-'}] enabled</p>
+        <tal tal:replace="structure python:docssnippet['demo']" >Demo</tal>
+      </article>
+    </metal:block>
+  </metal:content-core>
+</body>
+</html>

collective/bbcodesnippets/demo.py

@@ -0,0 +1,18 @@
+from .interfaces import IFormatterFactory
+from plone import api
+from Products.Five.browser import BrowserView
+from zope.component import getUtilitiesFor
+
+
+class DemoView(BrowserView):
+    def docsnippets(self):
+        enabled = api.portal.get_registry_record("bbcodesnippets.formatters")
+        for name, factory in getUtilitiesFor(IFormatterFactory):
+            if not factory.__doc__:
+                continue
+            yield {
+                "name": name,
+                "snippet": factory.__bbcode_copy_snippet__,
+                "demo": factory.__doc__,
+                "enabled": name in enabled,
+            }

collective/bbcodesnippets/formatters.py

@@ -0,0 +1,303 @@
+from .interfaces import IFormatterFactory
+from zope.interface import provider
+
+import bbcode
+import re
+
+
+class copy_snippet:
+    def __init__(self, snippet):
+        self.__bbcode_copy_snippet__ = snippet
+
+    def __call__(self, func):
+        func.__bbcode_copy_snippet__ = self.__bbcode_copy_snippet__
+        return func
+
+
+class template_snippet:
+    def __init__(self, snippet):
+        self.__bbcode_template_snippet__ = snippet
+
+    def __call__(self, func):
+        func.__bbcode_template_snippet__ = self.__bbcode_template_snippet__
+        return func
+
+
+# parts of this code are inspired by and partly taken from
+# https://github.com/dcwatson/bbcode/blob/master/bbcode.py
+
+
+# b 	[b]test[/b] 	<strong>test</strong>
+# i 	[i]test[/i] 	<em>test</em>
+# u 	[u]test[/u] 	<u>test</u>
+# s 	[s]test[/s] 	<strike>test</strike>
+# hr 	[hr] 	<hr />
+# br 	[br] 	<br />
+# sub 	x[sub]3[/sub] 	x<sub>3</sub>
+# sup 	x[sup]3[/sup] 	x<sup>3</sup>
+# list/* 	[list][*] item[/list] 	<ul><li>item</li></ul>
+# quote 	[quote]hello[/quote] 	<blockquote>hello</blockquote>
+# code 	[code]x = 3[/code] 	<code>x = 3</code>
+# center 	[center]hello[/center] 	<div style="text-align:center;">hello</div>
+# color 	[color=red]red[/color] 	<span style="color:red;">red</span>
+# url 	[url=www.apple.com]Apple[/url] 	<a href="http://www.apple.com">Apple</a>
+
+TEMPLATES = {
+    "url": '<a rel="nofollow" href="{href}">{text}</a>',
+}
+
+
+def make_simple_formatter(tag_name, format_string, **kwargs):
+    """
+    Creates a formatter that takes the tag options dictionary, puts a value key
+    in it, and uses it as a format dictionary to the given format string.
+    """
+
+    def _render(name, value, options, parent, context):
+        fmt = {}
+        if options:
+            fmt.update(options)
+        fmt.update({"value": value})
+        return format_string % fmt
+
+    return _render
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[b][/b]")
+@template_snippet("[b]$TEXT[/b]$CURSOR")
+def b_factory():
+    """Bold or strong text: <pre>A [b]bold[/b] text.</pre><br />
+    Example:<br />
+    A [b]bold[/b] text.
+    """
+    return make_simple_formatter("b", "<strong>%(value)s</strong>"), {}
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[i][/i]")
+@template_snippet("[i]$TEXT[/i]$CURSOR")
+def i_factory():
+    """Italic or emphasised text: <pre>An [i]italic/emphasised[/i] text.</pre><br />
+    Example:<br />
+    An [i]italic/emphasised[/i] text.
+    """
+    return make_simple_formatter("i", "<em>%(value)s</em>"), {}
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[u][/u]")
+@template_snippet("[u]$TEXT[/u]$CURSOR")
+def u_factory():
+    """Underlined or unarticulated text: <pre>An [u]underlined[u] text.</pre><br />
+    Example:<br />
+    An [u]underlined[/u] text.
+    """
+    return make_simple_formatter("u", "<u>%(value)s</u>"), {}
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[s][/s]")
+@template_snippet("[s]$TEXT[/s]$CURSOR")
+def s_factory():
+    """Strike through or deleted text: [s]test[/s]"""
+    return make_simple_formatter("s", "<del>%(value)s</del>"), {}
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[sub][/sub]")
+@template_snippet("[sub]$TEXT[/sub]$CURSOR")
+def sub_factory():
+    """Subscript text: <pre>H[sub]2[/sub]O</pre><br />
+    Example:<br />
+    H[sub]2[/sub]O
+    """
+    return make_simple_formatter("sub", "<sub>%(value)s</sub>"), {}
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[sup][/sup]")
+@template_snippet("[sup]$TEXT[/sup]$CURSOR")
+def sup_factory():
+    """Superscript text: <pre>r[sup]2[/sup]</pre><br />
+    Example:<br />
+    r[sup]2[/sup]
+    """
+    return make_simple_formatter("sup", "<sup>%(value)s</sup>"), {}
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[hr]")
+@template_snippet("$TEXT[hr]$CURSOR")
+def hr_factory():
+    """Horizontal ruler: <pre>Above ruler[hr]Below ruler</pre><br />
+    Example:<br />
+
+    Above ruler[hr]Below ruler
+    """
+    return make_simple_formatter("hr", "<hr />"), {"standalone": True}
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[br]")
+@template_snippet("$TEXT[br]$CURSOR")
+def br_factory():
+    """Line break in text: <pre>A line[br]break in the text.</pre><br />
+    Example:<br />
+    A line[br]break in the text.
+    """
+    return make_simple_formatter("br", "<br />"), {"standalone": True}
+
+
+@provider(IFormatterFactory)
+@copy_snippet("""\
+[list]
+    [*] item
+[/list]
+""")
+@template_snippet("""\
+[list]
+    [*] $TEXT
+    [*] $CURSOR
+[/list]
+""")
+def list_factory():
+    """List with bullets or numbers. Use '*' for bullet points or for numbers one out of '1', '01, 'a', 'A', 'i' or 'I'.
+    Bullet points: [list][*] item[/list]
+    Numbered: [list][1] item[/list]
+    """
+
+    def _render_list(name, value, options, parent, context):
+        list_type = options["list"] if (options and "list" in options) else "*"
+        css_opts = {
+            "1": "decimal",
+            "01": "decimal-leading-zero",
+            "a": "lower-alpha",
+            "A": "upper-alpha",
+            "i": "lower-roman",
+            "I": "upper-roman",
+        }
+        tag = "ol" if list_type in css_opts else "ul"
+        css = (
+            f' style="list-style-type: {css_opts[list_type]};"'
+            if list_type in css_opts
+            else ""
+        )
+        return f"<{tag}{css}>{value}</{tag}>"
+
+    return _render_list, {
+        "transform_newlines": False,
+        "strip": True,
+        "swallow_trailing_newline": True,
+    }
+
+
+@provider(IFormatterFactory)
+def list_item_factory():
+    # no doc string, so will not appear in documentation, helper for list
+    def _render_list_item(name, value, options, parent, context):
+        if not parent or parent.tag_name != "list":
+            return f"[*]{value}<br />"
+
+        return f"<li>{value}</li>"
+
+    return _render_list_item, {
+        "newline_closes": True,
+        "transform_newlines": False,
+        "same_tag_closes": True,
+        "strip": True,
+        "level": 1,
+    }
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[quote][/quote]")
+@template_snippet("[quote]$TEXT[/quote]$CURSOR")
+def quote_factory():
+    return make_simple_formatter("quote", "<blockquote>%(value)s</blockquote>"), {
+        "strip": True,
+        "swallow_trailing_newline": True,
+    }
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[code][/code]")
+@template_snippet("[code]$TEXT[/code]$CURSOR")
+def code_factory():
+    """Code text: <pre>Some random Code: [code]print("Hello World")[/code]</pre><br />
+    Example:<br />
+    Some random Code: [code]print("Hello World")[/code]
+    """
+
+    return make_simple_formatter("code", "<code>%(value)s</code>"), {
+        "render_embedded": False,
+        "transform_newlines": False,
+        "swallow_trailing_newline": True,
+        "replace_cosmetic": False,
+    }
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[color=red][/color]")
+@template_snippet("[color=$CURSOR]$TEXT[/color]")
+def color_factory():
+    def _render_color(name, value, options, parent, context):
+        if "color" in options:
+            color = options["color"].strip()
+        elif options:
+            color = next(iter(options.keys())).strip()
+        else:
+            return value
+        match = re.match(r"^([a-z]+)|^(#[a-f0-9]{3,6})", color, re.I)
+        color = match.group() if match else "inherit"
+        return f'<span style="color:{color};">{value}</span>'
+
+    return _render_color(), {}
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[center][/center]")
+@template_snippet("[center]$TEXT[/center]$CURSOR")
+def center_factory():
+    """Centered text: <pre>[center]centered text[/center]</pre><br />
+    Example:<br />
+    [center]centered text[/center]
+    """
+    return (
+        make_simple_formatter(
+            "center", '<div style="text-align:center;">%(value)s</div>'
+        ),
+        {},
+    )
+
+
+@provider(IFormatterFactory)
+@copy_snippet("[url=https://plone.org]Plone[/url]")
+@template_snippet("[url=$CURSOR]$TEXT[/url]")
+def url_factory():
+    """A hyper link in the text: <pre>Welcome to [url=www.plone.org]Plone[/url]!</pre><br />
+    Example:<br />
+    Welcome to [url=www.plone.org]Plone[/url]!
+    """
+
+    def _render_url(name, value, options, parent, context):
+        if options and "url" in options:
+            href = options["url"]
+            # Option values are not escaped for HTML output.
+            for find, repl in bbcode.Parser.REPLACE_ESCAPE:
+                value = value.replace(find, repl)
+        else:
+            href = value
+        # Completely ignore javascript: and data: "links".
+        if re.sub(r"[^a-z0-9+]", "", href.lower().split(":", 1)[0]) in (
+            "javascript",
+            "data",
+            "vbscript",
+        ):
+            return ""
+        # Only add the missing https:// if it looks like it starts with a domain name.
+        if "://" not in href and bbcode._domain_re.match(href):
+            href = "https://" + href
+        return TEMPLATES["url"].format(href=href.replace('"', "%22"), text=value)
+
+    return _render_url, {"replace_links": False, "replace_cosmetic": False}

collective/bbcodesnippets/formatters.zcml

@@ -0,0 +1,65 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope">
+
+  <utility
+      name="b"
+      component=".formatters.b_factory"
+  />
+  <utility
+      name="i"
+      component=".formatters.i_factory"
+  />
+  <utility
+      name="u"
+      component=".formatters.u_factory"
+  />
+  <utility
+      name="s"
+      component=".formatters.s_factory"
+  />
+  <utility
+      name="sub"
+      component=".formatters.sub_factory"
+  />
+  <utility
+      name="sup"
+      component=".formatters.sup_factory"
+  />
+  <utility
+      name="hr"
+      component=".formatters.hr_factory"
+  />
+  <utility
+      name="br"
+      component=".formatters.br_factory"
+  />
+  <utility
+      name="list"
+      component=".formatters.list_factory"
+  />
+  <utility
+      name="list_item"
+      component=".formatters.list_item_factory"
+  />
+  <utility
+      name="quote"
+      component=".formatters.quote_factory"
+  />
+  <utility
+      name="code"
+      component=".formatters.code_factory"
+  />
+  <!-- <utility
+      name="color"
+      component=".formatters.color_factory"
+  /> -->
+  <utility
+      name="center"
+      component=".formatters.center_factory"
+  />
+  <utility
+      name="url"
+      component=".formatters.url_factory"
+  />
+
+</configure>

collective/bbcodesnippets/indexer.py

@@ -0,0 +1,28 @@
+from plone.app.textfield.interfaces import IRichText
+from plone.app.textfield.interfaces import IRichTextValue
+from plone.base.utils import safe_text
+from plone.dexterity.content import iterSchemata
+from plone.indexer.decorator import indexer
+from zope.interface import Interface
+
+import re
+
+
+_DETECTOR_RE = re.compile(r".*\[[a-z].*?\]")
+
+
+@indexer(Interface)
+def has_bbcode(obj):
+    for schema in iterSchemata(obj):
+        for field_name in schema:
+            field = schema.get(field_name, None)
+            value = getattr(obj, field_name, None)
+            if isinstance(value, bytes):
+                value = safe_text(value)
+            elif IRichText.providedBy(field):
+                if not IRichTextValue.providedBy(value):
+                    continue
+                value = value.raw
+            if isinstance(value, str) and _DETECTOR_RE.search(value):
+                return True
+    return False

collective/bbcodesnippets/interfaces.py

@@ -0,0 +1,20 @@
+from zope.browsermenu.interfaces import IBrowserMenu
+from zope.interface import Interface
+from zope.publisher.interfaces.browser import IDefaultBrowserLayer
+
+
+class IBBCodeSnippetsLayer(IDefaultBrowserLayer):
+    """Marker interface that defines a browser layer."""
+
+
+class IFormatterFactory(Interface):
+    def __call__():
+        """create a new bbcode formatter."""
+
+
+class IBBCodeSnippetesMainMenuItem(IBrowserMenu):
+    """The main BBCode menu item."""
+
+
+class IBBCodeSnippetesMenu(IBrowserMenu):
+    """The BBCode menu."""