punkweb-bb 0.4.3__py3-none-any.whl → 0.5.1__py3-none-any.whl

punkweb_bb/templates/punkweb_bb/thread_update.html

@@ -5,7 +5,10 @@
 
 {% block extra_head %}
 {{form.media.css}}
-<link rel="stylesheet" href="{% static 'punkweb_bb/css/thread-form.css' %}" />
+{% endblock %}
+
+{% block extra_script %}
+{{form.media.js}}
 {% endblock %}
 
 {% block content %}
@@ -33,18 +36,10 @@
 <div class="pw-card fluid">
   <div class="pw-card-header">Edit Thread</div>
   <div class="pw-card-content">
-    <form class="threadForm" action="{% url 'punkweb_bb:thread_update' thread.id %}" method="post">
+    <form class="pw-form" action="{% url 'punkweb_bb:thread_update' thread.id %}" method="post">
       {% csrf_token %}
-      {% for field in form %}
-      <div class="threadForm__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="threadForm__actions">
+      {{ form }}
+      <div class="pw-form-actions end">
         <a class="pw-button default" href="{{thread.get_absolute_url}}">Cancel</a>
         <button class="pw-button raised primary" type="submit">Save</button>
       </div>
@@ -52,8 +47,4 @@
   </div>
 </div>
 
-{% endblock %}
-
-{% block extra_script %}
-{{form.media.js}}
 {% endblock %}

punkweb_bb/templatetags/punkweb_bb.py

@@ -0,0 +1,9 @@
+from django import template
+from punkweb_bb import settings
+
+register = template.Library()
+
+
+@register.simple_tag
+def punkweb_bb(setting_name, default=None):
+    return getattr(settings, setting_name, default)

punkweb_bb/urls.py

@@ -68,4 +68,5 @@ urlpatterns = [
     path("shout-create/", views.shout_create_view, name="shout_create"),
     path("shout/<str:shout_id>/delete/", views.shout_delete_view, name="shout_delete"),
     path("bbcode/", views.bbcode_view, name="bbcode"),
+    path("search/", views.search_view, name="search"),
 ]

punkweb_bb/views.py

@@ -1,13 +1,16 @@
 from django.contrib.auth import authenticate, get_user_model, login, logout
-from django.contrib.auth.decorators import login_required
-from django.http import HttpResponseForbidden
+from django.contrib.auth.decorators import login_required, permission_required
+from django.core.exceptions import PermissionDenied
+from django.db.models import Count
 from django.shortcuts import get_object_or_404, redirect, render
 from django.urls import reverse
 from django.utils import timezone
 
+from punkweb_bb.decorators import redirect_if_authenticated
 from punkweb_bb.forms import (
     BoardProfileModelForm,
     CategoryModelForm,
+    FilterUsersForm,
     LoginForm,
     PostModelForm,
     ShoutModelForm,
@@ -18,17 +21,21 @@ from punkweb_bb.forms import (
 )
 from punkweb_bb.guests import guest_list
 from punkweb_bb.models import Category, Post, Shout, Subcategory, Thread
-from punkweb_bb.pagination import paginate_qs
+from punkweb_bb.pagination import paginate
 from punkweb_bb.response import htmx_redirect
+from punkweb_bb.searching import search_threads
 from punkweb_bb.utils import get_unique_slug
 
 User = get_user_model()
 
 
-def signup_view(request):
-    if request.user.is_authenticated:
-        return redirect("punkweb_bb:index")
+def check_object_permission(obj, func, user):
+    if not getattr(obj, func)(user):
+        raise PermissionDenied
+
 
+@redirect_if_authenticated()
+def signup_view(request):
     if request.method == "POST":
         form = SignUpForm(request.POST)
 
@@ -45,12 +52,10 @@ def signup_view(request):
     return render(request, "punkweb_bb/signup.html", context)
 
 
+@redirect_if_authenticated()
 def login_view(request):
-    if request.user.is_authenticated:
-        return redirect("punkweb_bb:index")
-
     if request.method == "POST":
-        form = LoginForm(request, request.POST)
+        form = LoginForm(request=request, data=request.POST)
 
         if form.is_valid():
             username = form.cleaned_data["username"]
@@ -111,24 +116,65 @@ def index_view(request):
 def profile_view(request, user_id):
     user = get_object_or_404(User, pk=user_id)
 
+    # Get top threads by post count
+    top_threads = user.threads.annotate(count_posts=Count("posts")).order_by(
+        "-count_posts"
+    )[:5]
+
+    # Get top subcategories by thread count
+    top_subcategories = (
+        user.threads.values("subcategory")
+        .annotate(count_threads=Count("subcategory"))
+        .order_by("-count_threads")
+    )
+    for subcategory in top_subcategories:
+        subcategory["subcategory"] = Subcategory.objects.get(
+            pk=subcategory["subcategory"]
+        )
+
+    threads_qs = user.threads.all().order_by("-created_at")
+    posts_qs = user.posts.all().order_by("-created_at")
+
+    threads = paginate(request, threads_qs)
+    posts = paginate(request, posts_qs)
+
     context = {
         "user": user,
+        "top_threads": top_threads,
+        "top_subcategories": top_subcategories,
+        "threads": threads,
+        "posts": posts,
     }
+
     return render(request, "punkweb_bb/profile.html", context=context)
 
 
 def members_view(request):
-    users = paginate_qs(
-        request, User.objects.select_related("profile").order_by("username")
-    )
+    users_qs = User.objects.all()
+
+    form = FilterUsersForm(request.GET)
+    if form.is_valid():
+        search = form.cleaned_data["search"]
+        sort_by = form.cleaned_data["sort_by"]
+        if search:
+            users_qs = users_qs.filter(username__icontains=search)
+        if sort_by:
+            users_qs = users_qs.order_by(sort_by)
+        else:
+            users_qs = users_qs.order_by("username")
+
+        users_qs = users_qs.select_related("profile")
+
+    users = paginate(request, users_qs)
 
     context = {
+        "form": form,
         "users": users,
     }
     return render(request, "punkweb_bb/members.html", context=context)
 
 
-@login_required(login_url="/login/")
+@login_required()
 def settings_view(request):
     if request.method == "POST":
         form = BoardProfileModelForm(
@@ -151,11 +197,9 @@ def settings_view(request):
     return render(request, "punkweb_bb/settings.html", context=context)
 
 
-@login_required(login_url="/login/")
+@login_required()
+@permission_required("punkweb_bb.view_category", raise_exception=True)
 def category_create_view(request):
-    if not request.user.has_perm("punkweb_bb.add_category"):
-        return HttpResponseForbidden("You do not have permission to create categories.")
-
     if request.method == "POST":
         form = CategoryModelForm(request.POST)
 
@@ -174,11 +218,9 @@ def category_create_view(request):
     return render(request, "punkweb_bb/category_create.html", context=context)
 
 
-@login_required(login_url="/login/")
+@login_required()
+@permission_required("punkweb_bb.change_category", raise_exception=True)
 def category_update_view(request, category_slug):
-    if not request.user.has_perm("punkweb_bb.change_category"):
-        return HttpResponseForbidden("You do not have permission to change categories.")
-
     category = get_object_or_404(Category, slug=category_slug)
 
     if request.method == "POST":
@@ -198,11 +240,9 @@ def category_update_view(request, category_slug):
     return render(request, "punkweb_bb/category_update.html", context=context)
 
 
-@login_required(login_url="/login/")
+@login_required()
+@permission_required("punkweb_bb.delete_category", raise_exception=True)
 def category_delete_view(request, category_slug):
-    if not request.user.has_perm("punkweb_bb.delete_category"):
-        return HttpResponseForbidden("You do not have permission to delete categories.")
-
     category = get_object_or_404(Category, slug=category_slug)
 
     if request.method == "DELETE":
@@ -220,7 +260,7 @@ def category_delete_view(request, category_slug):
 def subcategory_view(request, subcategory_slug):
     subcategory = get_object_or_404(Subcategory, slug=subcategory_slug)
 
-    threads = paginate_qs(request, subcategory.threads.all())
+    threads = paginate(request, subcategory.threads.all())
 
     context = {
         "subcategory": subcategory,
@@ -229,13 +269,9 @@ def subcategory_view(request, subcategory_slug):
     return render(request, "punkweb_bb/subcategory.html", context=context)
 
 
-@login_required(login_url="/login/")
+@login_required()
+@permission_required("punkweb_bb.add_subcategory", raise_exception=True)
 def subcategory_create_view(request, category_slug):
-    if not request.user.has_perm("punkweb_bb.add_subcategory"):
-        return HttpResponseForbidden(
-            "You do not have permission to create subcategories."
-        )
-
     category = get_object_or_404(Category, slug=category_slug)
 
     if request.method == "POST":
@@ -249,7 +285,7 @@ def subcategory_create_view(request, category_slug):
 
             return redirect(subcategory)
     else:
-        form = SubcategoryModelForm()
+        form = SubcategoryModelForm(initial={"category": category})
 
     context = {
         "category": category,
@@ -258,13 +294,9 @@ def subcategory_create_view(request, category_slug):
     return render(request, "punkweb_bb/subcategory_create.html", context=context)
 
 
-@login_required(login_url="/login/")
+@login_required()
+@permission_required("punkweb_bb.change_subcategory", raise_exception=True)
 def subcategory_update_view(request, subcategory_slug):
-    if not request.user.has_perm("punkweb_bb.change_subcategory"):
-        return HttpResponseForbidden(
-            "You do not have permission to change subcategories."
-        )
-
     subcategory = get_object_or_404(Subcategory, slug=subcategory_slug)
 
     if request.method == "POST":
@@ -284,13 +316,9 @@ def subcategory_update_view(request, subcategory_slug):
     return render(request, "punkweb_bb/subcategory_update.html", context=context)
 
 
-@login_required(login_url="/login/")
+@login_required()
+@permission_required("punkweb_bb.delete_subcategory", raise_exception=True)
 def subcategory_delete_view(request, subcategory_slug):
-    if not request.user.has_perm("punkweb_bb.delete_subcategory"):
-        return HttpResponseForbidden(
-            "You do not have permission to delete subcategories."
-        )
-
     subcategory = get_object_or_404(Subcategory, slug=subcategory_slug)
 
     if request.method == "DELETE":
@@ -307,14 +335,11 @@ def subcategory_delete_view(request, subcategory_slug):
     )
 
 
-@login_required(login_url="/login/")
+@login_required()
 def thread_create_view(request, subcategory_slug):
     subcategory = get_object_or_404(Subcategory, slug=subcategory_slug)
 
-    if not subcategory.can_post(request.user):
-        return HttpResponseForbidden(
-            "You do not have permission to post in this subcategory."
-        )
+    check_object_permission(subcategory, "can_post", request.user)
 
     if request.method == "POST":
         form = ThreadModelForm(request.POST)
@@ -339,7 +364,7 @@ def thread_create_view(request, subcategory_slug):
 def thread_view(request, thread_id):
     thread = get_object_or_404(Thread, pk=thread_id)
 
-    posts = paginate_qs(request, thread.posts.all())
+    posts = paginate(request, thread.posts.all())
 
     post_form = PostModelForm()
 
@@ -358,14 +383,11 @@ def thread_view(request, thread_id):
     return render(request, "punkweb_bb/thread.html", context=context)
 
 
-@login_required(login_url="/login/")
+@login_required()
 def thread_update_view(request, thread_id):
     thread = get_object_or_404(Thread, pk=thread_id)
 
-    if not thread.can_edit(request.user):
-        return HttpResponseForbidden(
-            "You do not have permission to change this thread."
-        )
+    check_object_permission(thread, "can_edit", request.user)
 
     if request.method == "POST":
         form = ThreadModelForm(request.POST, instance=thread)
@@ -384,14 +406,11 @@ def thread_update_view(request, thread_id):
     return render(request, "punkweb_bb/thread_update.html", context=context)
 
 
-@login_required(login_url="/login/")
+@login_required()
 def thread_delete_view(request, thread_id):
     thread = get_object_or_404(Thread, pk=thread_id)
 
-    if not thread.can_delete(request.user):
-        return HttpResponseForbidden(
-            "You do not have permission to delete this thread."
-        )
+    check_object_permission(thread, "can_delete", request.user)
 
     if request.method == "DELETE":
         thread.delete()
@@ -405,11 +424,9 @@ def thread_delete_view(request, thread_id):
     return render(request, "punkweb_bb/partials/thread_delete.html", context=context)
 
 
-@login_required(login_url="/login/")
+@login_required()
+@permission_required("punkweb_bb.pin_thread", raise_exception=True)
 def thread_pin_view(request, 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
@@ -418,11 +435,9 @@ def thread_pin_view(request, thread_id):
     return htmx_redirect(thread.get_absolute_url())
 
 
-@login_required(login_url="/login/")
+@login_required()
+@permission_required("punkweb_bb.close_thread", raise_exception=True)
 def thread_close_view(request, 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
@@ -431,11 +446,9 @@ def thread_close_view(request, thread_id):
     return htmx_redirect(thread.get_absolute_url())
 
 
-@login_required(login_url="/login/")
+@login_required()
+@permission_required("punkweb_bb.move_thread", raise_exception=True)
 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":
@@ -461,14 +474,11 @@ def thread_move_view(request, thread_id):
     return render(request, "punkweb_bb/partials/thread_move.html", context=context)
 
 
-@login_required(login_url="/login/")
+@login_required()
 def post_create_view(request, thread_id):
     thread = get_object_or_404(Thread, pk=thread_id)
 
-    if not thread.can_post(request.user):
-        return HttpResponseForbidden(
-            "You do not have permission to post in this thread."
-        )
+    check_object_permission(thread, "can_post", request.user)
 
     form = PostModelForm(request.POST)
 
@@ -481,12 +491,11 @@ def post_create_view(request, thread_id):
         return redirect(post)
 
 
-@login_required(login_url="/login/")
+@login_required()
 def post_update_view(request, post_id):
     post = get_object_or_404(Post, pk=post_id)
 
-    if not post.can_edit(request.user):
-        return HttpResponseForbidden("You do not have permission to change this post.")
+    check_object_permission(post, "can_edit", request.user)
 
     if request.method == "POST":
         form = PostModelForm(request.POST, instance=post)
@@ -506,12 +515,11 @@ def post_update_view(request, post_id):
     return render(request, "punkweb_bb/partials/post_update.html", context=context)
 
 
-@login_required(login_url="/login/")
+@login_required()
 def post_delete_view(request, post_id):
     post = get_object_or_404(Post, pk=post_id)
 
-    if not post.can_delete(request.user):
-        return HttpResponseForbidden("You do not have permission to delete this post.")
+    check_object_permission(post, "can_delete", request.user)
 
     if request.method == "DELETE":
         post.delete()
@@ -563,12 +571,11 @@ def shout_create_view(request):
             )
 
 
-@login_required(login_url="/login/")
+@login_required()
 def shout_delete_view(request, shout_id):
     shout = get_object_or_404(Shout, pk=shout_id)
 
-    if not shout.can_delete(request.user):
-        return HttpResponseForbidden("You do not have permission to delete this shout.")
+    check_object_permission(shout, "can_delete", request.user)
 
     if request.method == "DELETE":
         shout.delete()
@@ -622,6 +629,7 @@ class ThreadModelForm(forms.ModelForm):
 [/code]
 """,
         ),
+        ("Spoiler", "[spoiler=Title]Content[/spoiler]"),
         ("Ordered List", "[ol][li]Item 1[/li][li]Item 2[/li][/ol]"),
         ("Unordered List", "[ul][li]Item 1[/li][li]Item 2[/li][/ul]"),
         ("Escape", "[escape][b]Escaped bbcode[/b][/escape]"),
@@ -632,3 +640,20 @@ class ThreadModelForm(forms.ModelForm):
     }
 
     return render(request, "punkweb_bb/bbcode.html", context=context)
+
+
+def search_view(request):
+    query = request.GET.get("q", "")
+
+    print(query)
+
+    matching_threads = search_threads(query)
+
+    print(matching_threads)
+
+    context = {
+        "query": query,
+        "threads": matching_threads,
+    }
+
+    return render(request, "punkweb_bb/search.html", context=context)

punkweb_bb/widgets.py

@@ -10,15 +10,14 @@ class BBCodeEditorWidget(forms.Textarea):
         css = {
             "all": (
                 "/static/punkweb_bb/vendor/sceditor-3.2.0/minified/themes/square.min.css",
-                "/static/punkweb_bb/editor/bbcode-editor.css",
             )
         }
         js = (
             "/static/punkweb_bb/vendor/jquery-3.7.0.min.js",
             "/static/punkweb_bb/vendor/sceditor-3.2.0/minified/jquery.sceditor.bbcode.min.js",
             "/static/punkweb_bb/vendor/sceditor-3.2.0/minified/icons/material.js",
-            "/static/punkweb_bb/editor/bbcode-editor-tags.js",
-            "/static/punkweb_bb/editor/bbcode-editor.js",
+            "/static/punkweb_bb/js/bbcode-editor-tags.js",
+            "/static/punkweb_bb/js/bbcode-editor.js",
         )
 
 
@@ -38,5 +37,5 @@ class MarkdownEditorWidget(forms.Textarea):
         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",
+            "/static/punkweb_bb/js/markdown-editor.js",
         )

{punkweb_bb-0.4.3.dist-info → punkweb_bb-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: punkweb-bb
-Version: 0.4.3
+Version: 0.5.1
 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
@@ -45,18 +45,6 @@ Check out [punkweb.net](https://punkweb.net/board/) for documentation, support a
 
 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 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 parser, but you can switch to Markdown by setting the following in your Django settings module:
-
-```python
-PUNKWEB_BB = {
-  "PARSER": "markdown",
-}
-```
-
 ## Installation
 
 ```bash
@@ -72,19 +60,12 @@ INSTALLED_APPS = [
 ]
 ```
 
-Add the following context processor to your `TEMPLATES` setting:
+**_Optionally:_** Add the following middleware to your `MIDDLEWARE` setting, at the end of the list:
 
 ```python
-TEMPLATES = [
-    {
-        ...
-        "OPTIONS": {
-            "context_processors": [
-                ...
-                "punkweb_bb.context_processors.punkweb_bb",
-            ],
-        },
-    },
+MIDDLEWARE = [
+    ...
+    "punkweb_bb.middleware.ProfileOnlineCacheMiddleware",
 ]
 ```
 
@@ -105,6 +86,10 @@ And finally, install the models:
 python manage.py migrate
 ```
 
+## Deprecated notice (v0.5.0)
+
+If you were using the package before v0.5.0, there was a step in the README to add a context processor. This is no longer necessary, as it's been removed, so you may get an error that it doesn't exist. If you see this error, you can safely remove the context processor from your settings.
+
 ## Configuration
 
 These are the default settings for PunkwebBB, which can be overridden in your Django settings module:
@@ -117,6 +102,8 @@ PUNKWEB_BB = {
   "FAVICON": "punkweb_bb/favicon.ico",
   "OG_IMAGE": None, # Used for Open Graph meta tags, must be a full URL!
   "SHOUTBOX_ENABLED": True,
+  "SHOUTBOX_POLLING_ENABLED": True,
+  "SHOUTBOX_POLLING_INTERVAL": 30, # in seconds
   "DISCORD_WIDGET_ENABLED": False,
   "DISCORD_WIDGET_THEME": "dark",
   "DISCORD_SERVER_ID": None, # Found under Server Settings > Widget > Server ID
@@ -143,7 +130,7 @@ Creating test database for alias 'default'...
 System check identified no issues (0 silenced).
 ...........................................................
 ----------------------------------------------------------------------
-Ran 59 tests in 8.994s
+Ran 59 tests in 8.594s
 
 OK
 Destroying test database for alias 'default'...
@@ -153,30 +140,32 @@ punkweb_bb/__init__.py                             0      0   100%
 punkweb_bb/admin.py                               42      0   100%
 punkweb_bb/admin_forms.py                         34      0   100%
 punkweb_bb/apps.py                                 6      0   100%
-punkweb_bb/bbcode.py                              82     68    17%
-punkweb_bb/context_processors.py                   3      0   100%
-punkweb_bb/forms.py                               47      0   100%
+punkweb_bb/bbcode.py                             118     46    61%
+punkweb_bb/decorators.py                          12      0   100%
+punkweb_bb/forms.py                               59      0   100%
 punkweb_bb/guests.py                              13      0   100%
-punkweb_bb/middleware.py                          14      0   100%
+punkweb_bb/middleware.py                          27      3    89%
 punkweb_bb/mixins.py                              11      0   100%
-punkweb_bb/models.py                             153      1    99%
+punkweb_bb/models.py                             154      1    99%
 punkweb_bb/pagination.py                          11      4    64%
 punkweb_bb/response.py                             3      0   100%
-punkweb_bb/settings.py                            11      0   100%
+punkweb_bb/searching.py                            8      5    38%
+punkweb_bb/settings.py                            13      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                 28      7    75%
+punkweb_bb/templatetags/punkweb_bb.py              6      0   100%
+punkweb_bb/templatetags/render.py                 38     16    58%
 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     23    45%
-punkweb_bb/views.py                              304    118    61%
-punkweb_bb/widgets.py                             16      0   100%
+punkweb_bb/utils.py                               44     26    41%
+punkweb_bb/views.py                              319    123    61%
+punkweb_bb/widgets.py                             16      2    88%
 ------------------------------------------------------------------
-TOTAL                                           1288    227    82%
+TOTAL                                           1402    232    83%
 ```