punkweb-bb 0.3.0__tar.gz → 0.4.0__tar.gz

punkweb_bb-0.4.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include README.md
+recursive-include punkweb_bb *
+recursive-exclude punkweb_bb/static/punkweb_bb/vendor/tiny-markdown-editor/node_modules *

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: punkweb_bb
-Version: 0.3.0
+Version: 0.4.0
 Summary: Django application that provides a simple and modern forum board software for your Django website.
 Home-page: https://github.com/Punkweb/PunkwebBB
 Author: Punkweb
@@ -20,17 +20,15 @@ License-File: LICENSE
 
 PunkwebBB is a Django application that provides a simple and modern forum board software for your Django website.
 
-This is the successor to [punkweb-boards](https://github.com/Punkweb/punkweb-boards).
-
 Check out [punkweb.net](https://punkweb.net/board/) for documentation, support and a live demonstration of the software.
 
 ## Built with
 
 - [Django](https://www.djangoproject.com/)
-- [django-precise-bbcode](https://github.com/ellmetha/django-precise-bbcode)
-- [Markdown](https://python-markdown.github.io/)
 - [HTMX](https://htmx.org/)
 - [jQuery](https://jquery.com/)
+- [bbcode](https://pypi.org/project/bbcode/)
+- [Markdown](https://pypi.org/project/Markdown/)
 - [SCEditor](https://www.sceditor.com/)
 - [TinyMDE](https://github.com/jefago/tiny-markdown-editor)
 - [PrismJS](https://prismjs.com/)
@@ -39,21 +37,18 @@ Check out [punkweb.net](https://punkweb.net/board/) for documentation, support a
 
 - Python 3.9+
 - Django 4.0+
-- django-precise-bbcode 1.2+
-- markdown 3.6+
-- Pillow
 
 It may work with older versions of Python and Django, but it has not been tested.
 
 ## BBCode or Markdown?
 
-PunkwebBB supports both BBCode and Markdown. You'll want to decide before installing which renderer you want to use, as switching between them will cause existing threads, posts, signatures, etc. to render incorrectly! Switching will not affect the database schema, but it will affect the content.
+PunkwebBB supports both BBCode and Markdown. You'll want to decide before installing which parser you want to use, as switching between them will cause existing threads, posts, signatures, etc. to render incorrectly! Switching will not affect the database schema, but it will affect the content.
 
-BBCode is the default renderer, but you can switch to Markdown by setting the following in your Django settings module:
+BBCode is the default parser, but you can switch to Markdown by setting the following in your Django settings module:
 
 ```python
 PUNKWEB_BB = {
-  "RENDERER": "markdown",
+  "PARSER": "markdown",
 }
 ```
 
@@ -63,18 +58,15 @@ PUNKWEB_BB = {
 pip install punkweb-bb
 ```
 
-Add `precise_bbcode` and `punkweb_bb` to your `INSTALLED_APPS` in your Django settings module:
+Add `punkweb_bb` to your `INSTALLED_APPS` in your Django settings module:
 
 ```python
 INSTALLED_APPS = [
     ...
-    "precise_bbcode",
     "punkweb_bb",
 ]
 ```
 
-_Note_: `precise_bbcode` is required even if using the Markdown renderer! It must be installed before `punkweb_bb`.
-
 Add the following context processor to your `TEMPLATES` setting:
 
 ```python
@@ -116,7 +108,7 @@ These are the default settings for PunkwebBB, which can be overridden in your Dj
 PUNKWEB_BB = {
   "SITE_NAME": "PUNKWEB",
   "SITE_TITLE": "PunkwebBB",
-  "RENDERER": "bbcode", # "bbcode" or "markdown"
+  "PARSER": "bbcode", # "bbcode" or "markdown"
   "FAVICON": "punkweb_bb/favicon.ico",
   "OG_IMAGE": None, # Used for Open Graph meta tags, must be a full URL!
   "SHOUTBOX_ENABLED": True,

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/README.md

@@ -2,17 +2,15 @@
 
 PunkwebBB is a Django application that provides a simple and modern forum board software for your Django website.
 
-This is the successor to [punkweb-boards](https://github.com/Punkweb/punkweb-boards).
-
 Check out [punkweb.net](https://punkweb.net/board/) for documentation, support and a live demonstration of the software.
 
 ## Built with
 
 - [Django](https://www.djangoproject.com/)
-- [django-precise-bbcode](https://github.com/ellmetha/django-precise-bbcode)
-- [Markdown](https://python-markdown.github.io/)
 - [HTMX](https://htmx.org/)
 - [jQuery](https://jquery.com/)
+- [bbcode](https://pypi.org/project/bbcode/)
+- [Markdown](https://pypi.org/project/Markdown/)
 - [SCEditor](https://www.sceditor.com/)
 - [TinyMDE](https://github.com/jefago/tiny-markdown-editor)
 - [PrismJS](https://prismjs.com/)
@@ -21,21 +19,18 @@ Check out [punkweb.net](https://punkweb.net/board/) for documentation, support a
 
 - Python 3.9+
 - Django 4.0+
-- django-precise-bbcode 1.2+
-- markdown 3.6+
-- Pillow
 
 It may work with older versions of Python and Django, but it has not been tested.
 
 ## BBCode or Markdown?
 
-PunkwebBB supports both BBCode and Markdown. You'll want to decide before installing which renderer you want to use, as switching between them will cause existing threads, posts, signatures, etc. to render incorrectly! Switching will not affect the database schema, but it will affect the content.
+PunkwebBB supports both BBCode and Markdown. You'll want to decide before installing which parser you want to use, as switching between them will cause existing threads, posts, signatures, etc. to render incorrectly! Switching will not affect the database schema, but it will affect the content.
 
-BBCode is the default renderer, but you can switch to Markdown by setting the following in your Django settings module:
+BBCode is the default parser, but you can switch to Markdown by setting the following in your Django settings module:
 
 ```python
 PUNKWEB_BB = {
-  "RENDERER": "markdown",
+  "PARSER": "markdown",
 }
 ```
 
@@ -45,18 +40,15 @@ PUNKWEB_BB = {
 pip install punkweb-bb
 ```
 
-Add `precise_bbcode` and `punkweb_bb` to your `INSTALLED_APPS` in your Django settings module:
+Add `punkweb_bb` to your `INSTALLED_APPS` in your Django settings module:
 
 ```python
 INSTALLED_APPS = [
     ...
-    "precise_bbcode",
     "punkweb_bb",
 ]
 ```
 
-_Note_: `precise_bbcode` is required even if using the Markdown renderer! It must be installed before `punkweb_bb`.
-
 Add the following context processor to your `TEMPLATES` setting:
 
 ```python
@@ -98,7 +90,7 @@ These are the default settings for PunkwebBB, which can be overridden in your Dj
 PUNKWEB_BB = {
   "SITE_NAME": "PUNKWEB",
   "SITE_TITLE": "PunkwebBB",
-  "RENDERER": "bbcode", # "bbcode" or "markdown"
+  "PARSER": "bbcode", # "bbcode" or "markdown"
   "FAVICON": "punkweb_bb/favicon.ico",
   "OG_IMAGE": None, # Used for Open Graph meta tags, must be a full URL!
   "SHOUTBOX_ENABLED": True,

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/punkweb_bb/admin.py

@@ -1,5 +1,4 @@
 from django.contrib import admin
-from django.utils.safestring import mark_safe
 
 from punkweb_bb.admin_forms import (
     BoardProfileAdminModelForm,

punkweb_bb-0.4.0/punkweb_bb/bbcode.py

@@ -0,0 +1,155 @@
+import bbcode
+
+
+def render_color(name, value, options, parent, context):
+    if "color" in options:
+        color = options["color"].strip()
+        return f'<span style="color: {color}">{value}</span>'
+    return value
+
+
+def render_shadow(name, value, options, parent, context):
+    if "shadow" in options:
+        shadow = options["shadow"].strip()
+        return f'<span id="bbcode-shadow" style="text-shadow: 0px 0px 1em {shadow}">{value}</span>'
+    return value
+
+
+def render_font(name, value, options, parent, context):
+    if "font" in options:
+        font = options["font"].strip()
+        return f'<span style="font-family:{font};">{value}</span>'
+    return value
+
+
+def render_quote(name, value, options, parent, context):
+    if "quote" in options:
+        return f'<blockquote><cite>{options["quote"]} said: </cite>{value}</blockquote>'
+    return f"<blockquote>{value}</blockquote>"
+
+
+def render_code(name, value, options, parent, context):
+    if "code" in options:
+        language = options["code"].strip()
+        return f'<pre><code class="language-{language}">{value}</code></pre>'
+    return f"<pre><code>{value}</code></pre>"
+
+
+def render_img(name, value, options, parent, context):
+    if "width" in options:
+        width = options["width"]
+    if "height" in options:
+        height = options["height"]
+
+    if "width" in options and "height" in options:
+        return f'<img src="{value}" alt="{value}" width="{width}" height="{height}" />'
+    elif "width" in options:
+        return f'<img src="{value}" alt="{value}" width="{width}" />'
+    elif "height" in options:
+        return f'<img src="{value}" alt="{value}" height="{height}" />'
+
+    return f'<img src="{value}" alt="{value}" />'
+
+
+def render_url(name, value, options, parent, context):
+    if "url" in options:
+        url = options["url"]
+        return f'<a href="{url}">{value}</a>'
+    return f'<a href="{value}">{value}</a>'
+
+
+def render_size(name, value, options, parent, context):
+    if "size" in options:
+        size = options["size"].strip()
+        return f'<font size="{size}">{value}</font>'
+    return value
+
+
+def init_default_tags(parser):
+    parser.add_simple_formatter("b", "<strong>%(value)s</strong>")
+    parser.add_simple_formatter("i", "<em>%(value)s</em>")
+    parser.add_simple_formatter("u", "<u>%(value)s</u>")
+    parser.add_simple_formatter("s", "<s>%(value)s</s>")
+    parser.add_simple_formatter("sub", "<sub>%(value)s</sub>")
+    parser.add_simple_formatter("sup", "<sup>%(value)s</sup>")
+    parser.add_simple_formatter("escape", "%(value)s", render_embedded=False)
+
+    parser.add_formatter("font", render_font)
+    parser.add_formatter("color", render_color)
+    parser.add_formatter("shadow", render_shadow)
+    parser.add_formatter("url", render_url, replace_links=False, replace_cosmetic=False)
+
+
+_parser = None
+_shoutbox_parser = None
+
+
+def get_parser():
+    global _parser
+    if _parser is None:
+        _parser = bbcode.Parser(install_defaults=False)
+        init_default_tags(_parser)
+
+        _parser.add_simple_formatter("hr", "<hr />", standalone=True)
+        _parser.add_simple_formatter(
+            "center", '<div style="text-align: center">%(value)s</div>'
+        )
+        _parser.add_simple_formatter(
+            "left", '<div style="text-align: left">%(value)s</div>'
+        )
+        _parser.add_simple_formatter(
+            "right", '<div style="text-align: right">%(value)s</div>'
+        )
+        _parser.add_simple_formatter(
+            "ol",
+            "<ol>%(value)s</ol>",
+            transform_newlines=False,
+            strip=True,
+            swallow_trailing_newline=True,
+        )
+        _parser.add_simple_formatter(
+            "ul",
+            "<ul>%(value)s</ul>",
+            transform_newlines=False,
+            strip=True,
+            swallow_trailing_newline=True,
+        )
+        _parser.add_simple_formatter(
+            "li",
+            "<li>%(value)s</li>",
+            newline_closes=True,
+            transform_newlines=False,
+            same_tag_closes=True,
+            strip=True,
+        )
+
+        _parser.add_formatter("size", render_size)
+        _parser.add_formatter(
+            "img",
+            render_img,
+            render_embedded=False,
+            replace_links=False,
+            replace_cosmetic=False,
+        )
+        _parser.add_formatter(
+            "quote", render_quote, strip=True, swallow_trailing_newline=True
+        )
+        _parser.add_formatter(
+            "code",
+            render_code,
+            render_embedded=False,
+            transform_newlines=False,
+            replace_links=False,
+            replace_cosmetic=False,
+            strip=True,
+            swallow_trailing_newline=True,
+        )
+    return _parser
+
+
+def get_shoutbox_parser():
+    global _shoutbox_parser
+    if _shoutbox_parser is None:
+        _shoutbox_parser = bbcode.Parser(install_defaults=False)
+        init_default_tags(_shoutbox_parser)
+    return _shoutbox_parser

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/punkweb_bb/settings.py

@@ -4,7 +4,7 @@ PUNKWEB_BB = getattr(settings, "PUNKWEB_BB", {})
 
 SITE_NAME = PUNKWEB_BB.get("SITE_NAME", "PUNKWEB")
 SITE_TITLE = PUNKWEB_BB.get("SITE_TITLE", "PunkwebBB")
-RENDERER = PUNKWEB_BB.get("RENDERER", "bbcode")
+PARSER = PUNKWEB_BB.get("PARSER", "bbcode")
 FAVICON = PUNKWEB_BB.get("FAVICON", "punkweb_bb/favicon.ico")
 OG_IMAGE = PUNKWEB_BB.get("OG_IMAGE", None)
 SHOUTBOX_ENABLED = PUNKWEB_BB.get("SHOUTBOX_ENABLED", True)

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/punkweb_bb/static/punkweb_bb/css/punkweb-modal.css

@@ -4,6 +4,7 @@
   display: flex;
   flex-direction: column;
   justify-content: center;
+  padding: 2rem;
 
   position: fixed;
   top: 0;
@@ -28,6 +29,7 @@
   border-radius: 0.25rem;
   box-shadow: 0 0.5rem 1rem 0 rgba(0, 0, 0, 0.25);
   background-color: white;
+  overflow: auto;
   position: relative;
   width: fit-content;
 

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/punkweb_bb/static/punkweb_bb/css/punkweb.css

@@ -181,7 +181,7 @@ blockquote cite {
   border-bottom: 1px solid var(--border);
   color: var(--table-header-text);
   font-size: 0.875rem;
-  font-weight: 500;
+  font-weight: 700;
   padding: 0.75rem 1rem;
   text-align: left;
 }
@@ -664,7 +664,7 @@ blockquote cite {
 .pw-input-label {
   display: block;
   font-size: 0.875rem;
-  font-weight: 500;
+  font-weight: 700;
 }
 
 /** Card **/

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/punkweb_bb/static/punkweb_bb/css/subcategory.css

@@ -11,6 +11,10 @@
   gap: 1rem;
 }
 
+.subcategory__header__name h1 {
+  margin: 0;
+}
+
 .subcategory__header__actions {
   align-items: center;
   display: flex;

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/punkweb_bb/static/punkweb_bb/editor/bbcode-editor-content.css

@@ -8,12 +8,16 @@ body {
   line-height: 1.5;
   overflow: visible;
 }
+
 html {
   height: 100%;
 }
 
 * {
   box-sizing: border-box;
+}
+
+body {
   margin: 0;
   padding: 0;
 }
@@ -56,11 +60,6 @@ a {
   text-decoration: none;
 }
 
-ul,
-ol {
-  padding-inline-start: 2rem;
-}
-
 code {
   display: block;
   background: #f5f2f0;

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/punkweb_bb/static/punkweb_bb/editor/bbcode-editor.js

@@ -1,12 +1,7 @@
 $(function () {
   $(document).ready(function () {
     $(".bbcode-editor").sceditor({
-      emoticonsCompat: true,
       emoticonsEnabled: false,
-      emoticonsRoot: "/media/precise_bbcode/smilies/",
-      emoticons: {
-        dropdown: {},
-      },
       format: "bbcode",
       icons: "material",
       style: "/static/punkweb_bb/editor/bbcode-editor-content.css",

punkweb_bb-0.4.0/punkweb_bb/static/punkweb_bb/editor/markdown-editor.js

@@ -0,0 +1,49 @@
+function initMarkdownEditor(containerElement) {
+  var editorElement = containerElement.querySelector(".markdown-editor");
+  var toolbarElement = containerElement.querySelector(
+    "#markdown-editor-toolbar"
+  );
+
+  var editor = null;
+
+  if (!containerElement.querySelector(".TinyMDE")) {
+    editor = new TinyMDE.Editor({
+      textarea: editorElement,
+    });
+  }
+
+  if (editor && !toolbarElement.querySelector(".TMCommandBar")) {
+    var toolbar = new TinyMDE.CommandBar({
+      element: toolbarElement,
+      editor: editor,
+      commands: [
+        "bold",
+        "italic",
+        "strikethrough",
+        "|",
+        "h1",
+        "h2",
+        "|",
+        "ul",
+        "ol",
+        "|",
+        "blockquote",
+        "code",
+        "insertLink",
+        "insertImage",
+        "hr",
+      ],
+    });
+  }
+}
+
+$(function () {
+  $(document).ready(function () {
+    var editorElements = document.querySelectorAll(
+      ".markdown-editor-container"
+    );
+    editorElements.forEach((element) => {
+      initMarkdownEditor(element);
+    });
+  });
+});

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/punkweb_bb/templates/punkweb_bb/bbcode.html

@@ -1,6 +1,5 @@
 {% extends "punkweb_bb/base.html" %}
-
-{% load bbcode_tags %}
+{% load render %}
 
 {% block content %}
 
@@ -11,7 +10,7 @@
     <div>
       <h4>{{ code.0 }}</h4>
       <pre>{{ code.1 }}</pre>
-      {% bbcode code.1 %}
+      {{ code.1|render }}
     </div>
     {% endfor %}
   </div>

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/punkweb_bb/templates/punkweb_bb/shoutbox/shout_list.html

@@ -1,11 +1,11 @@
-{% load shoutbox_render styled_username can_delete %}
+{% load render styled_username can_delete %}
 
 {% for shout in shouts %}
 <div class="shoutbox__shout">
   <div class="shoutbox__shout__content">
     <time datetime="{{shout.created_at|date:'c'}}">{{shout.created_at | date:'g:i A'}}</time>
     <span><a href="{% url 'punkweb_bb:profile' shout.user.id %}">{{shout.user|styled_username}}</a>: </span>
-    <span>{{ shout.content|shoutbox_render }}</span>
+    <span>{{ shout.content|render_shout }}</span>
   </div>
   {% if shout|can_delete:request.user %}
   <div class="shoutbox__shout__actions">

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/punkweb_bb/templates/punkweb_bb/widgets/markdown-editor.html

@@ -1,3 +1,4 @@
 <div class="markdown-editor-container">
+  <div id="markdown-editor-toolbar"></div>
   {% include "django/forms/widgets/textarea.html" %}
 </div>

punkweb_bb-0.4.0/punkweb_bb/templatetags/render.py

@@ -0,0 +1,35 @@
+import html
+
+import markdown as md
+from django import template
+from django.template.defaultfilters import stringfilter
+from django.utils.safestring import mark_safe
+
+from punkweb_bb.bbcode import get_parser, get_shoutbox_parser
+from punkweb_bb.settings import PARSER
+
+register = template.Library()
+
+
+@register.filter(is_safe=True)
+@stringfilter
+def render(value):
+    if PARSER == "bbcode":
+        parser = get_parser()
+        rendered = parser.format(value)
+        return mark_safe(rendered)
+    elif PARSER == "markdown":
+        escaped = html.escape(value)
+        rendered = md.markdown(escaped, extensions=["markdown.extensions.fenced_code"])
+        return mark_safe(rendered)
+    return value
+
+
+@register.filter(is_safe=True)
+@stringfilter
+def render_shout(value):
+    if PARSER == "bbcode":
+        parser = get_shoutbox_parser()
+        rendered = parser.format(value)
+        return mark_safe(rendered)
+    return value

{punkweb_bb-0.3.0 → punkweb_bb-0.4.0}/punkweb_bb/utils.py

@@ -1,19 +1,17 @@
+from django.forms import Textarea
 from django.utils.text import slugify
-from precise_bbcode.bbcode import get_parser
-from punkweb_bb.settings import RENDERER
 
+from punkweb_bb.bbcode import get_parser
+from punkweb_bb.settings import PARSER
+from punkweb_bb.widgets import BBCodeEditorWidget, MarkdownEditorWidget
 
-def get_editor_widget():
-    if RENDERER == "bbcode":
-        from punkweb_bb.widgets import BBCodeEditorWidget
 
+def get_editor_widget():
+    if PARSER == "bbcode":
         return BBCodeEditorWidget()
-    elif RENDERER == "markdown":
-        from punkweb_bb.widgets import MarkdownEditorWidget
-
+    elif PARSER == "markdown":
         return MarkdownEditorWidget()
-    else:
-        raise ValueError("Invalid renderer")
+    return Textarea(attrs={"class": "pw-input"})
 
 
 def get_unique_slug(model, field):
@@ -47,17 +45,17 @@ def get_styled_username(user):
     if group:
         parser = get_parser()
         username_style = group.style.username_style
-        styled_username = parser.render(username_style.replace("{USER}", user.username))
-        return styled_username
-    else:
-        return user.username
+        rendered = parser.format(username_style.replace("{USER}", user.username))
+        return rendered
+
+    return user.username
 
 
 def get_styled_group_name(group):
-    if group.style is None:
-        return group.name
-    else:
+    if group.style is not None:
         parser = get_parser()
         username_style = group.style.username_style
-        styled_group_name = parser.render(username_style.replace("{USER}", group.name))
-        return styled_group_name
+        rendered = parser.format(username_style.replace("{USER}", group.name))
+        return rendered
+
+    return group.name