punkweb-bb 0.2.3__py3-none-any.whl → 0.3.0__py3-none-any.whl

punkweb_bb/templates/punkweb_bb/partials/thread_delete.html

@@ -1,11 +1,7 @@
-{% extends 'punkweb_bb/base_modal.html' %}
+{% extends 'punkweb_bb/base_delete_modal.html' %}
 
 {% block title %}Delete Thread{% endblock %}
 
-{% block content %}
-<p>Are you sure you want to delete this thread? This action cannot be undone!</p>
-<div class="modal__actions">
-  <button class="modal__cancel pw-button default">Cancel</button>
-  <button class="pw-button raised danger" hx-delete="{% url 'punkweb_bb:thread_delete' thread.id %}">Delete</button>
-</div>
-{% endblock %}
+{% block object_type %}thread{% endblock %}
+
+{% block delete_url %}{% url 'punkweb_bb:thread_delete' thread.id %}{% endblock %}

punkweb_bb/templates/punkweb_bb/partials/thread_move.html

@@ -0,0 +1,24 @@
+{% extends 'punkweb_bb/base_modal.html' %}
+
+{% block title %}Move Thread{% endblock %}
+
+{% block content %}
+<form class="threadMoveForm" action="{% url 'punkweb_bb:thread_move' thread.id %}" method="post">
+  {% csrf_token %}
+  {% for field in form %}
+  <div class="threadMoveForm__field">
+    <label class="pw-input-label" for="{{ field.id_for_label }}">{{ field.label }}</label>
+    {{ field }}
+  </div>
+  {% endfor %}
+  {% if form.non_field_errors %}
+  {{ form.non_field_errors }}
+  {% endif %}
+  <div class="threadMoveForm__actions">
+    <button class="modal__cancel pw-button default">Cancel</button>
+    <button class="pw-button raised primary" type="submit">Move</button>
+  </div>
+</form>
+{{form.media.css}}
+{{form.media.js}}
+{% endblock %}

punkweb_bb/templates/punkweb_bb/profile.html

@@ -1,5 +1,5 @@
 {% extends 'punkweb_bb/base.html' %}
-{% load static styled_username %}
+{% load static render styled_username %}
 
 {% block title_prefix %}{{ user.username }} | {% endblock%}
 {% block og_title_prefix %}{{ user.username }} | {% endblock %}
@@ -76,7 +76,7 @@
               <a href="{% url 'punkweb_bb:thread' thread.id %}">{{ thread.title }}</a>
             </div>
             <p class="profile__thread__preview">
-              {{ thread.content.rendered|striptags|truncatechars:120 }}
+              {{ thread.content|render|striptags|truncatechars:120 }}
             </p>
             <div class="profile__thread__date">
               <time datetime="{{thread.created_at|date:'c'}}">

punkweb_bb/templates/punkweb_bb/shoutbox/shout_list.html

@@ -1,11 +1,11 @@
-{% load shoutbox_bbcode can_delete styled_username %}
+{% load shoutbox_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 | safe | shoutbox_bbcode }}</span>
+    <span>{{ shout.content|shoutbox_render }}</span>
   </div>
   {% if shout|can_delete:request.user %}
   <div class="shoutbox__shout__actions">

punkweb_bb/templates/punkweb_bb/subcategory.html

@@ -101,7 +101,7 @@
                 {{thread.user|styled_username}}
               </a>
               •
-              <time datetime="{{thread.created_at|date:'c'}}">{{thread.created_at | date:'m j, Y'}}</time>
+              <time datetime="{{thread.created_at|date:'c'}}">{{thread.created_at | date:'M j, Y'}}</time>
           </td>
           <td>{{thread.post_count}}</td>
           <td>{{thread.view_count | humanize_int}}</td>

punkweb_bb/templates/punkweb_bb/thread.html

@@ -1,12 +1,12 @@
 {% extends 'punkweb_bb/base.html' %}
-{% load static can_delete can_edit can_post styled_username %}
+{% load static render styled_username can_delete can_edit can_post %}
 
 {% block title_prefix %}{{thread.title}} | {% endblock %}
 {% block og_title_prefix %}{{thread.title}} | {% endblock %}
 
 {% block extra_head %}
-<meta name="description" content="{{thread.content.rendered|striptags|truncatechars:120}}" />
-<meta property="og:description" content="{{thread.content.rendered|striptags|truncatechars:120}}" />
+<meta name="description" content="{{thread.content|render|striptags|truncatechars:120}}" />
+<meta property="og:description" content="{{thread.content|render|striptags|truncatechars:120}}" />
 <link rel="stylesheet" href="{% static 'punkweb_bb/css/post-form.css' %}" />
 <link rel="stylesheet" href="{% static 'punkweb_bb/css/thread.css' %}" />
 <link rel="stylesheet" href="{% static 'punkweb_bb/css/thread-form.css' %}" />
@@ -42,7 +42,7 @@
 <div class="pw-card fluid margin">
   <div class="pw-card-header">
     <div class="thread__date">
-      <time datetime="{{thread.created_at|date:'c'}}">{{thread.created_at | date:'M d, Y'}}</time>
+      <time datetime="{{thread.created_at|date:'c'}}">{{thread.created_at | date:'M j, Y'}}</time>
     </div>
   </div>
   <div class="thread">
@@ -75,7 +75,7 @@
         <div class="thread__user__details__row">
           <div class="thread__user__details__label">Joined:</div>
           <div class="thread__user__details__value">
-            <time datetime="{{thread.user.date_joined|date:'c'}}">{{thread.user.date_joined | date:'M d, Y'}}</time>
+            <time datetime="{{thread.user.date_joined|date:'c'}}">{{thread.user.date_joined | date:'M j, Y'}}</time>
           </div>
         </div>
         <div class="thread__user__details__row">
@@ -86,10 +86,20 @@
     </div>
     <div class="thread__main">
       <div class="thread__content">
-        {{thread.content.rendered}}
+        {{thread.content|render}}
       </div>
-      {% if thread|can_delete:request.user or thread|can_edit:request.user or perms.punkweb_bb.pin_thread or perms.punkweb_bb.close_thread %}
+      {% if thread|can_delete:request.user or thread|can_edit:request.user or perms.punkweb_bb.pin_thread or perms.punkweb_bb.close_thread or perms.punkweb_bb.move_thread %}
       <div class="thread__actions">
+        {% if perms.punkweb_bb.move_thread %}
+        <a 
+          class="pw-icon-button default rounded"
+          title="Move"
+          hx-get="{% url 'punkweb_bb:thread_move' thread.id %}"
+          hx-target="#modal-portal"
+        >
+          <span class="material-symbols-outlined">move_item</span>
+        </a>
+        {% endif %}
         {% if perms.punkweb_bb.pin_thread %}
         <a 
           class="pw-icon-button default rounded"
@@ -139,9 +149,9 @@
         {% endif %}
       </div>
       {% endif %}
-      {% if thread.user.profile.signature.rendered %}
+      {% if thread.user.profile.signature|render %}
       <div class="thread__signature">
-        {{thread.user.profile.signature.rendered}}
+        {{thread.user.profile.signature|render}}
       </div>
       {% endif %}
     </div>
@@ -153,7 +163,7 @@
 <div id="post-{{post.id}}" class="pw-card fluid margin">
   <div class="pw-card-header thread__header">
     <div class="thread__date">
-      <time datetime="{{post.created_at|date:'c'}}">{{post.created_at | date:'M d, Y'}}</time>
+      <time datetime="{{post.created_at|date:'c'}}">{{post.created_at | date:'M j, Y'}}</time>
     </div>
     <a class="thread__index" href="{{post.get_absolute_url}}">#{{post.index}}</a>
   </div>
@@ -191,7 +201,7 @@
         <div class="thread__user__details__row">
           <div class="thread__user__details__label">Joined:</div>
           <div class="thread__user__details__value">
-            <time datetime="{{post.user.date_joined|date:'c'}}">{{post.user.date_joined | date:'M d, Y'}}</time>
+            <time datetime="{{post.user.date_joined|date:'c'}}">{{post.user.date_joined | date:'M j, Y'}}</time>
           </div>
         </div>
         <div class="thread__user__details__row">
@@ -202,7 +212,7 @@
     </div>
     <div class="thread__main">
       <div class="thread__content">
-        {{post.content.rendered}}
+        {{post.content|render}}
       </div>
       {% if post|can_delete:request.user or post|can_edit:request.user %}
       <div class="thread__actions">
@@ -228,9 +238,9 @@
         {% endif %}
       </div>
       {% endif %}
-      {% if post.user.profile.signature.rendered %}
+      {% if post.user.profile.signature|render %}
       <div class="thread__signature">
-        {{post.user.profile.signature.rendered}}
+        {{post.user.profile.signature|render}}
       </div>
       {% endif %}
     </div>

punkweb_bb/templates/punkweb_bb/widgets/markdown-editor.html

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

punkweb_bb/templatetags/render.py

@@ -0,0 +1,48 @@
+import html
+from io import StringIO
+
+import markdown as md
+from django import template
+from django.template.defaultfilters import stringfilter
+from django.utils.safestring import mark_safe
+from precise_bbcode.bbcode import get_parser
+
+from punkweb_bb.settings import RENDERER
+
+register = template.Library()
+
+
+def unmark_element(element, stream=None):
+    if stream is None:
+        stream = StringIO()
+    if element.text:
+        stream.write(element.text)
+    for sub in element:
+        unmark_element(sub, stream)
+    if element.tail:
+        stream.write(element.tail)
+    return stream.getvalue()
+
+
+md.Markdown.output_formats["plain"] = unmark_element
+unmark = md.Markdown(output_format="plain")
+unmark.stripTopLevelTags = False
+
+
+@register.filter(is_safe=True)
+@stringfilter
+def render(value):
+    if RENDERER == "bbcode":
+        parser = get_parser()
+        rendered = parser.render(value)
+    elif RENDERER == "markdown":
+        escaped = html.escape(value, quote=False)
+        rendered = md.markdown(escaped, extensions=["markdown.extensions.fenced_code"])
+
+    return mark_safe(rendered)
+
+
+@register.filter()
+@stringfilter
+def unmarkdown(value):
+    return unmark.convert(value)

punkweb_bb/templatetags/shoutbox_render.py

@@ -0,0 +1,22 @@
+import html
+from django import template
+from django.template.defaultfilters import stringfilter
+from django.utils.safestring import mark_safe
+
+from punkweb_bb.parsers import get_shoutbox_parser
+from punkweb_bb.settings import RENDERER
+
+register = template.Library()
+
+
+@register.filter(is_safe=True)
+@stringfilter
+def shoutbox_render(value):
+    if RENDERER == "bbcode":
+        parser = get_shoutbox_parser()
+        rendered = parser.render(value)
+    elif RENDERER == "markdown":
+        escaped = html.escape(value, quote=False)
+        rendered = escaped
+
+    return mark_safe(rendered)

punkweb_bb/tests.py

@@ -422,7 +422,7 @@ class SettingsViewTestCase(TestCase):
         )
 
         self.user.profile.refresh_from_db()
-        self.assertEqual(self.user.profile._signature_rendered, "<strong>test</strong>")
+        self.assertEqual(self.user.profile.signature, "[b]test[/b]")
 
         self.assertEqual(response.status_code, 200)
 
@@ -546,7 +546,7 @@ class ThreadUpdateViewTestCase(TestCase):
         self.assertRedirects(response, self.thread.get_absolute_url())
         self.thread.refresh_from_db()
         self.assertEqual(self.thread.title, "edit")
-        self.assertEqual(self.thread._content_rendered, "edit")
+        self.assertEqual(self.thread.content, "edit")
 
 
 class ThreadDeleteViewTestCase(TestCase):
@@ -675,7 +675,7 @@ class PostUpdateViewTestCase(TestCase):
 
         self.assertRedirects(response, self.post.get_absolute_url())
         self.post.refresh_from_db()
-        self.assertEqual(self.post._content_rendered, "edit")
+        self.assertEqual(self.post.content, "edit")
 
 
 class PostDeleteViewTestCase(TestCase):

punkweb_bb/urls.py

@@ -61,6 +61,7 @@ urlpatterns = [
     ),
     path("thread/<str:thread_id>/pin/", views.thread_pin_view, name="thread_pin"),
     path("thread/<str:thread_id>/close/", views.thread_close_view, name="thread_close"),
+    path("thread/<str:thread_id>/move/", views.thread_move_view, name="thread_move"),
     path("post/<str:post_id>/delete/", views.post_delete_view, name="post_delete"),
     path("post/<str:post_id>/update/", views.post_update_view, name="post_update"),
     path("shout-list/", views.shout_list_view, name="shout_list"),

punkweb_bb/utils.py

@@ -1,5 +1,19 @@
-from django.contrib.auth.models import Group
 from django.utils.text import slugify
+from precise_bbcode.bbcode import get_parser
+from punkweb_bb.settings import RENDERER
+
+
+def get_editor_widget():
+    if RENDERER == "bbcode":
+        from punkweb_bb.widgets import BBCodeEditorWidget
+
+        return BBCodeEditorWidget()
+    elif RENDERER == "markdown":
+        from punkweb_bb.widgets import MarkdownEditorWidget
+
+        return MarkdownEditorWidget()
+    else:
+        raise ValueError("Invalid renderer")
 
 
 def get_unique_slug(model, field):
@@ -31,8 +45,9 @@ def get_styled_username(user):
     group = get_highest_priority_group(user)
 
     if group:
+        parser = get_parser()
         username_style = group.style.username_style
-        styled_username = username_style.rendered.replace("{USER}", user.username)
+        styled_username = parser.render(username_style.replace("{USER}", user.username))
         return styled_username
     else:
         return user.username
@@ -42,6 +57,7 @@ def get_styled_group_name(group):
     if group.style is None:
         return group.name
     else:
+        parser = get_parser()
         username_style = group.style.username_style
-        styled_group_name = username_style.rendered.replace("{USER}", group.name)
+        styled_group_name = parser.render(username_style.replace("{USER}", group.name))
         return styled_group_name

punkweb_bb/views.py

@@ -14,6 +14,7 @@ from punkweb_bb.forms import (
     SignUpForm,
     SubcategoryModelForm,
     ThreadModelForm,
+    ThreadMoveForm,
 )
 from punkweb_bb.guests import guest_list
 from punkweb_bb.models import Category, Post, Shout, Subcategory, Thread
@@ -406,11 +407,11 @@ def thread_delete_view(request, thread_id):
 
 @login_required(login_url="/login/")
 def thread_pin_view(request, thread_id):
-    thread = get_object_or_404(Thread, pk=thread_id)
-
     if not request.user.has_perm("punkweb_bb.pin_thread"):
         return HttpResponseForbidden("You do not have permission to pin threads.")
 
+    thread = get_object_or_404(Thread, pk=thread_id)
+
     thread.is_pinned = not thread.is_pinned
     thread.save()
 
@@ -419,17 +420,47 @@ def thread_pin_view(request, thread_id):
 
 @login_required(login_url="/login/")
 def thread_close_view(request, thread_id):
-    thread = get_object_or_404(Thread, pk=thread_id)
-
     if not request.user.has_perm("punkweb_bb.close_thread"):
         return HttpResponseForbidden("You do not have permission to close threads.")
 
+    thread = get_object_or_404(Thread, pk=thread_id)
+
     thread.is_closed = not thread.is_closed
     thread.save()
 
     return htmx_redirect(thread.get_absolute_url())
 
 
+@login_required(login_url="/login/")
+def thread_move_view(request, thread_id):
+    if not request.user.has_perm("punkweb_bb.move_thread"):
+        return HttpResponseForbidden("You do not have permission to move threads.")
+
+    thread = get_object_or_404(Thread, pk=thread_id)
+
+    if request.method == "POST":
+        form = ThreadMoveForm(request.POST)
+
+        if form.is_valid():
+            thread.subcategory = form.cleaned_data["subcategory"]
+            thread.save()
+
+            return redirect(thread)
+
+    initial_data = {
+        "subcategory": thread.subcategory,
+    }
+
+    form = ThreadMoveForm(data=initial_data)
+
+    context = {
+        "thread": thread,
+        "form": form,
+    }
+
+    return render(request, "punkweb_bb/partials/thread_move.html", context=context)
+
+
 @login_required(login_url="/login/")
 def post_create_view(request, thread_id):
     thread = get_object_or_404(Thread, pk=thread_id)

punkweb_bb/widgets.py

@@ -20,3 +20,23 @@ class BBCodeEditorWidget(forms.Textarea):
             "/static/punkweb_bb/editor/bbcode-editor-tags.js",
             "/static/punkweb_bb/editor/bbcode-editor.js",
         )
+
+
+class MarkdownEditorWidget(forms.Textarea):
+    template_name = "punkweb_bb/widgets/markdown-editor.html"
+
+    def __init__(self, *args, **kwargs):
+        super(MarkdownEditorWidget, self).__init__(*args, **kwargs)
+        self.attrs["class"] = "markdown-editor"
+
+    class Media:
+        css = {
+            "all": (
+                "/static/punkweb_bb/vendor/tiny-markdown-editor/dist/tiny-mde.min.css",
+            )
+        }
+        js = (
+            "/static/punkweb_bb/vendor/jquery-3.7.0.min.js",
+            "/static/punkweb_bb/vendor/tiny-markdown-editor/dist/tiny-mde.min.js",
+            "/static/punkweb_bb/editor/markdown-editor.js",
+        )

{punkweb_bb-0.2.3.dist-info → punkweb_bb-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: punkweb-bb
-Version: 0.2.3
+Version: 0.3.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
@@ -17,6 +17,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: django >=4.0
 Requires-Dist: django-precise-bbcode
+Requires-Dist: markdown
 Requires-Dist: expiringdict
 Requires-Dist: pillow
 
@@ -32,20 +33,35 @@ Check out [punkweb.net](https://punkweb.net/board/) for documentation, support a
 
 - [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/)
 - [SCEditor](https://www.sceditor.com/)
+- [TinyMDE](https://github.com/jefago/tiny-markdown-editor)
 - [PrismJS](https://prismjs.com/)
 
 ## Requirements
 
 - Python 3.9+
-- Django 4.2+
+- 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.
+
+BBCode is the default renderer, but you can switch to Markdown by setting the following in your Django settings module:
+
+```python
+PUNKWEB_BB = {
+  "RENDERER": "markdown",
+}
+```
+
 ## Installation
 
 ```bash
@@ -62,16 +78,7 @@ INSTALLED_APPS = [
 ]
 ```
 
-_Note_: `precise_bbcode` is required. It must be installed before `punkweb_bb`.
-
-Add the following middleware to your `MIDDLEWARE` setting:
-
-```python
-MIDDLEWARE = [
-    ...
-    "punkweb_bb.middleware.ProfileOnlineCacheMiddleware",
-]
-```
+_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:
 
@@ -114,6 +121,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"
   "FAVICON": "punkweb_bb/favicon.ico",
   "OG_IMAGE": None, # Used for Open Graph meta tags, must be a full URL!
   "SHOUTBOX_ENABLED": True,
@@ -138,39 +146,46 @@ coverage run && coverage html
 ```
 
 ```bash
-Found 57 test(s).
+Found 59 test(s).
 Creating test database for alias 'default'...
 System check identified no issues (0 silenced).
-.........................................................
+...........................................................
 ----------------------------------------------------------------------
-Ran 57 tests in 8.824s
+Ran 59 tests in 9.166s
 
 OK
 Destroying test database for alias 'default'...
-Name                                         Stmts   Miss  Cover
-----------------------------------------------------------------
-punkweb_bb/__init__.py                           0      0   100%
-punkweb_bb/admin.py                             41      1    98%
-punkweb_bb/admin_forms.py                       28      0   100%
-punkweb_bb/apps.py                               6      0   100%
-punkweb_bb/bbcode_tags.py                      115      3    97%
-punkweb_bb/context_processors.py                 3      0   100%
-punkweb_bb/forms.py                             35      0   100%
-punkweb_bb/middleware.py                        10      0   100%
-punkweb_bb/mixins.py                            11      0   100%
-punkweb_bb/models.py                           124      0   100%
-punkweb_bb/pagination.py                        11      4    64%
-punkweb_bb/parsers.py                           50      2    96%
-punkweb_bb/response.py                           3      0   100%
-punkweb_bb/settings.py                           6      0   100%
-punkweb_bb/signals.py                            9      0   100%
-punkweb_bb/templatetags/__init__.py              0      0   100%
-punkweb_bb/templatetags/humanize_int.py          9      5    44%
-punkweb_bb/templatetags/shoutbox_bbcode.py       9      0   100%
-punkweb_bb/tests.py                            410      0   100%
-punkweb_bb/urls.py                               4      0   100%
-punkweb_bb/views.py                            174     17    90%
-punkweb_bb/widgets.py                            8      0   100%
-----------------------------------------------------------------
-TOTAL                                         1066     32    97%
+Name                                           Stmts   Miss  Cover
+------------------------------------------------------------------
+punkweb_bb/__init__.py                             0      0   100%
+punkweb_bb/admin.py                               43      0   100%
+punkweb_bb/admin_forms.py                         34      0   100%
+punkweb_bb/apps.py                                 6      0   100%
+punkweb_bb/context_processors.py                   3      0   100%
+punkweb_bb/forms.py                               47      0   100%
+punkweb_bb/guests.py                              13      0   100%
+punkweb_bb/middleware.py                          14      0   100%
+punkweb_bb/mixins.py                              11      0   100%
+punkweb_bb/models.py                             153      1    99%
+punkweb_bb/pagination.py                          11      4    64%
+punkweb_bb/parsers.py                             50     36    28%
+punkweb_bb/response.py                             3      0   100%
+punkweb_bb/settings.py                            11      0   100%
+punkweb_bb/signals.py                              9      0   100%
+punkweb_bb/templatetags/__init__.py                0      0   100%
+punkweb_bb/templatetags/can_delete.py              5      0   100%
+punkweb_bb/templatetags/can_edit.py                5      0   100%
+punkweb_bb/templatetags/can_post.py                5      0   100%
+punkweb_bb/templatetags/humanize_int.py            9      5    44%
+punkweb_bb/templatetags/render.py                 36     12    67%
+punkweb_bb/templatetags/shoutbox_render.py        18      2    89%
+punkweb_bb/templatetags/styled_group_name.py       7      1    86%
+punkweb_bb/templatetags/styled_username.py         6      0   100%
+punkweb_bb/tests.py                              418      0   100%
+punkweb_bb/urls.py                                 4      0   100%
+punkweb_bb/utils.py                               42     24    43%
+punkweb_bb/views.py                              304    118    61%
+punkweb_bb/widgets.py                             16      0   100%
+------------------------------------------------------------------
+TOTAL                                           1283    203    84%
 ```