punkweb-bb 0.4.2__tar.gz → 0.5.0__tar.gz

{punkweb_bb-0.4.2 → punkweb_bb-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: punkweb_bb
-Version: 0.4.2
+Version: 0.5.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
@@ -40,18 +40,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
@@ -67,19 +55,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",
 ]
 ```
 
@@ -100,6 +81,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:
@@ -112,6 +97,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
@@ -138,7 +125,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'...
@@ -148,30 +135,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%
 ```

{punkweb_bb-0.4.2 → punkweb_bb-0.5.0}/README.md

@@ -22,18 +22,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
@@ -49,19 +37,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",
 ]
 ```
 
@@ -82,6 +63,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:
@@ -94,6 +79,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
@@ -120,7 +107,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'...
@@ -130,30 +117,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%
 ```

{punkweb_bb-0.4.2 → punkweb_bb-0.5.0}/punkweb_bb/bbcode.py

@@ -56,8 +56,8 @@ def add_url_tag(parser):
 def add_quote_tag(parser):
     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>"
+            return f'<blockquote class="pw-blockquote"><cite>{options["quote"]} said: </cite>{value}</blockquote>'
+        return f'<blockquote class="pw-blockquote">{value}</blockquote>'
 
     parser.add_formatter(
         "quote", _render_quote, strip=True, swallow_trailing_newline=True
@@ -114,7 +114,8 @@ def add_spoiler_tag(parser):
     def _render_spoiler(name, value, options, parent, context):
         if "spoiler" in options:
             summary = options["spoiler"]
-            return f"<details><summary>{summary}</summary>{value}</details>"
+            return f'<details class="pw-details"><summary>{summary}</summary>{value}</details>'
+        return f'<details class="pw-details"><summary>Click to reveal</summary>{value}</details>'
 
     parser.add_formatter(
         "spoiler", _render_spoiler, strip=True, swallow_trailing_newline=True

punkweb_bb-0.5.0/punkweb_bb/decorators.py

@@ -0,0 +1,17 @@
+from functools import wraps
+
+from django.core.exceptions import PermissionDenied
+from django.shortcuts import redirect
+
+
+def redirect_if_authenticated(redirect_url="punkweb_bb:index"):
+    def decorator(view_func):
+        @wraps(view_func)
+        def _wrapper_view(request, *args, **kwargs):
+            if request.user.is_authenticated:
+                return redirect(redirect_url)
+            return view_func(request, *args, **kwargs)
+
+        return _wrapper_view
+
+    return decorator

{punkweb_bb-0.4.2 → punkweb_bb-0.5.0}/punkweb_bb/forms.py

@@ -6,10 +6,7 @@ from punkweb_bb.utils import get_editor_widget
 
 
 class LoginForm(AuthenticationForm):
-    """
-    Override the default AuthenticationForm to add CSS classes to the
-    username and password fields.
-    """
+    template_name = "punkweb_bb/forms/stacked_form.html"
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -21,6 +18,8 @@ class LoginForm(AuthenticationForm):
 
 
 class SignUpForm(UserCreationForm):
+    template_name = "punkweb_bb/forms/stacked_form.html"
+
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
@@ -31,19 +30,45 @@ class SignUpForm(UserCreationForm):
         self.fields["password2"].widget.attrs.update({"class": "pw-input fluid"})
 
 
+class FilterUsersForm(forms.Form):
+    template_name = "punkweb_bb/forms/inline_form.html"
+
+    search = forms.CharField(
+        required=False,
+        widget=forms.TextInput(attrs={"class": "pw-input", "placeholder": "Search"}),
+    )
+    sort_by = forms.ChoiceField(
+        required=False,
+        choices=(
+            ("", "-----------"),
+            ("username", "Username (A-Z)"),
+            ("-username", "Username (Z-A)"),
+            ("date_joined", "Date Joined (Oldest)"),
+            ("-date_joined", "Date Joined (Newest)"),
+        ),
+        widget=forms.Select(attrs={"class": "pw-input"}),
+    )
+
+
 class BoardProfileModelForm(forms.ModelForm):
+    template_name = "punkweb_bb/forms/stacked_form.html"
+
     class Meta:
         model = BoardProfile
         fields = (
             "image",
+            "bio",
             "signature",
         )
         widgets = {
+            "bio": get_editor_widget(),
             "signature": get_editor_widget(),
         }
 
 
 class CategoryModelForm(forms.ModelForm):
+    template_name = "punkweb_bb/forms/stacked_form.html"
+
     class Meta:
         model = Category
         fields = (
@@ -59,6 +84,8 @@ class CategoryModelForm(forms.ModelForm):
 
 
 class PostModelForm(forms.ModelForm):
+    template_name = "punkweb_bb/forms/stacked_form.html"
+
     class Meta:
         model = Post
         fields = ("content",)
@@ -77,24 +104,30 @@ class ShoutModelForm(forms.ModelForm):
 
 
 class SubcategoryModelForm(forms.ModelForm):
+    template_name = "punkweb_bb/forms/stacked_form.html"
+
     class Meta:
         model = Subcategory
         fields = (
+            "category",
             "name",
             "description",
             "order",
             "staff_post_only",
         )
         widgets = {
-            "name": forms.TextInput(attrs={"autofocus": True, "class": "pw-input"}),
-            "description": get_editor_widget(),
-            "order": forms.TextInput(
-                attrs={"class": "pw-input", "min": "0", "type": "number"}
+            "name": forms.TextInput(
+                attrs={"autofocus": True, "class": "pw-input fluid"}
             ),
+            "category": forms.Select(attrs={"class": "pw-input fluid"}),
+            "description": get_editor_widget(),
+            "order": forms.NumberInput(attrs={"class": "pw-input", "min": "0"}),
         }
 
 
 class ThreadModelForm(forms.ModelForm):
+    template_name = "punkweb_bb/forms/stacked_form.html"
+
     class Meta:
         model = Thread
         fields = (
@@ -102,14 +135,18 @@ class ThreadModelForm(forms.ModelForm):
             "content",
         )
         widgets = {
-            "title": forms.TextInput(attrs={"autofocus": True, "class": "pw-input"}),
+            "title": forms.TextInput(
+                attrs={"autofocus": True, "class": "pw-input fluid"}
+            ),
             "content": get_editor_widget(),
         }
 
 
 class ThreadMoveForm(forms.Form):
+    template_name = "punkweb_bb/forms/stacked_form.html"
+
     subcategory = forms.ModelChoiceField(
         queryset=Subcategory.objects.all(),
         empty_label="Select a subcategory",
-        widget=forms.Select(attrs={"class": "pw-input"}),
+        widget=forms.Select(attrs={"class": "pw-input fluid"}),
     )

punkweb_bb-0.5.0/punkweb_bb/middleware.py

@@ -0,0 +1,49 @@
+from django.core.cache import cache
+from django.core.exceptions import ValidationError
+from django.core.validators import validate_ipv46_address
+from django.utils import timezone
+
+from punkweb_bb.guests import guest_list
+
+
+class ProfileOnlineCacheMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        if request.user.is_authenticated:
+            cache.set(
+                f"profile_online_{request.user.profile.id}", timezone.now(), 60 * 5
+            )
+        else:
+            ip = self.get_client_ip(request)
+            guest_list.add(ip)
+
+        guest_list.clear_expired()
+
+        response = self.get_response(request)
+
+        return response
+
+    def get_client_ip(self, request):
+        headers = (
+            "HTTP_X_FORWARDED_FOR",
+            "HTTP_X_REAL_IP",
+            "HTTP_CLIENT_IP",
+            "HTTP_X_CLIENT_IP",
+            "HTTP_X_CLUSTER_CLIENT_IP",
+            "HTTP_FORWARDED_FOR",
+            "HTTP_FORWARDED",
+            "REMOTE_ADDR",
+        )
+
+        for header in headers:
+            if request.META.get(header, None):
+                ip = request.META[header].split(",")[0].strip()
+                try:
+                    validate_ipv46_address(ip)
+                    return ip
+                except ValidationError:
+                    pass
+
+        return ""

{punkweb_bb-0.4.2 → punkweb_bb-0.5.0}/punkweb_bb/migrations/0001_initial.py

@@ -3,7 +3,6 @@
 from django.conf import settings
 from django.db import migrations, models
 import django.db.models.deletion
-import precise_bbcode.fields
 import punkweb_bb.models
 import uuid
 
@@ -57,15 +56,9 @@ class Migration(migrations.Migration):
                 ("updated_at", models.DateTimeField(auto_now=True)),
                 ("name", models.CharField(max_length=255)),
                 ("slug", models.SlugField(max_length=1024, unique=True)),
-                (
-                    "_description_rendered",
-                    models.TextField(blank=True, editable=False, null=True),
-                ),
                 (
                     "description",
-                    precise_bbcode.fields.BBCodeTextField(
-                        blank=True, no_rendered_field=True, null=True
-                    ),
+                    models.TextField(blank=True, null=True),
                 ),
                 ("order", models.PositiveIntegerField(default=0)),
                 ("staff_post_only", models.BooleanField(default=False)),
@@ -99,13 +92,9 @@ class Migration(migrations.Migration):
                 ("created_at", models.DateTimeField(auto_now_add=True)),
                 ("updated_at", models.DateTimeField(auto_now=True)),
                 ("title", models.CharField(max_length=255)),
-                (
-                    "_content_rendered",
-                    models.TextField(blank=True, editable=False, null=True),
-                ),
                 (
                     "content",
-                    precise_bbcode.fields.BBCodeTextField(no_rendered_field=True),
+                    models.TextField(),
                 ),
                 ("is_pinned", models.BooleanField(default=False)),
                 ("is_closed", models.BooleanField(default=False)),
@@ -173,13 +162,9 @@ class Migration(migrations.Migration):
                 ),
                 ("created_at", models.DateTimeField(auto_now_add=True)),
                 ("updated_at", models.DateTimeField(auto_now=True)),
-                (
-                    "_content_rendered",
-                    models.TextField(blank=True, editable=False, null=True),
-                ),
                 (
                     "content",
-                    precise_bbcode.fields.BBCodeTextField(no_rendered_field=True),
+                    models.TextField(),
                 ),
                 (
                     "thread",
@@ -224,15 +209,9 @@ class Migration(migrations.Migration):
                         upload_to=punkweb_bb.models.profile_image_upload_to,
                     ),
                 ),
-                (
-                    "_signature_rendered",
-                    models.TextField(blank=True, editable=False, null=True),
-                ),
                 (
                     "signature",
-                    precise_bbcode.fields.BBCodeTextField(
-                        blank=True, max_length=1024, no_rendered_field=True, null=True
-                    ),
+                    models.TextField(blank=True, max_length=1024, null=True),
                 ),
                 (
                     "user",

{punkweb_bb-0.4.2 → punkweb_bb-0.5.0}/punkweb_bb/migrations/0004_groupstyle.py

@@ -2,7 +2,6 @@
 
 from django.db import migrations, models
 import django.db.models.deletion
-import precise_bbcode.fields
 import uuid
 
 
@@ -34,13 +33,9 @@ class Migration(migrations.Migration):
                         default=0, help_text="Highest priority is displayed"
                     ),
                 ),
-                (
-                    "_username_style_rendered",
-                    models.TextField(blank=True, editable=False, null=True),
-                ),
                 (
                     "username_style",
-                    precise_bbcode.fields.BBCodeTextField(no_rendered_field=True),
+                    models.TextField(),
                 ),
                 (
                     "group",

{punkweb_bb-0.4.2 → punkweb_bb-0.5.0}/punkweb_bb/migrations/0006_remove_boardprofile__signature_rendered_and_more.py

@@ -10,26 +10,6 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
-        migrations.RemoveField(
-            model_name="boardprofile",
-            name="_signature_rendered",
-        ),
-        migrations.RemoveField(
-            model_name="groupstyle",
-            name="_username_style_rendered",
-        ),
-        migrations.RemoveField(
-            model_name="post",
-            name="_content_rendered",
-        ),
-        migrations.RemoveField(
-            model_name="subcategory",
-            name="_description_rendered",
-        ),
-        migrations.RemoveField(
-            model_name="thread",
-            name="_content_rendered",
-        ),
         migrations.AlterField(
             model_name="boardprofile",
             name="signature",

punkweb_bb-0.5.0/punkweb_bb/migrations/0007_boardprofile_bio.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.11 on 2024-06-06 02:56
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("punkweb_bb", "0006_remove_boardprofile__signature_rendered_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="boardprofile",
+            name="bio",
+            field=models.TextField(blank=True, max_length=1024),
+        ),
+    ]

{punkweb_bb-0.4.2 → punkweb_bb-0.5.0}/punkweb_bb/models.py

@@ -23,6 +23,7 @@ def profile_image_upload_to(instance, filename):
 class BoardProfile(UUIDPrimaryKeyMixin, TimestampMixin):
     user = models.OneToOneField(User, related_name="profile", on_delete=models.CASCADE)
     image = models.ImageField(upload_to=profile_image_upload_to, blank=True, null=True)
+    bio = models.TextField(max_length=1024, blank=True)
     signature = models.TextField(max_length=1024, blank=True)
 
     class Meta: