punkweb-bb 0.1.3__tar.gz → 0.2.0__tar.gz

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: punkweb_bb
-Version: 0.1.3
+Version: 0.2.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
@@ -22,7 +22,7 @@ PunkwebBB is a Django application that provides a simple and modern forum board
 
 This is the successor to [punkweb-boards](https://github.com/Punkweb/punkweb-boards).
 
-Check out [punkweb.net](https://punkweb.net/board/) for a live demo and more information!
+Check out [punkweb.net](https://punkweb.net/board/) for documentation, support and a live demonstration of the software.
 
 ## Built with
 
@@ -112,6 +112,9 @@ PUNKWEB_BB = {
   "SITE_TITLE": "PunkwebBB",
   "FAVICON": "punkweb_bb/favicon.ico",
   "SHOUTBOX_ENABLED": True,
+  "DISCORD_WIDGET_ENABLED": False,
+  "DISCORD_WIDGET_THEME": "dark",
+  "DISCORD_SERVER_ID": None, # Found under Server Settings > Widget > Server ID
 }
 ```
 

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/README.md

@@ -4,7 +4,7 @@ PunkwebBB is a Django application that provides a simple and modern forum board
 
 This is the successor to [punkweb-boards](https://github.com/Punkweb/punkweb-boards).
 
-Check out [punkweb.net](https://punkweb.net/board/) for a live demo and more information!
+Check out [punkweb.net](https://punkweb.net/board/) for documentation, support and a live demonstration of the software.
 
 ## Built with
 
@@ -94,6 +94,9 @@ PUNKWEB_BB = {
   "SITE_TITLE": "PunkwebBB",
   "FAVICON": "punkweb_bb/favicon.ico",
   "SHOUTBOX_ENABLED": True,
+  "DISCORD_WIDGET_ENABLED": False,
+  "DISCORD_WIDGET_THEME": "dark",
+  "DISCORD_SERVER_ID": None, # Found under Server Settings > Widget > Server ID
 }
 ```
 

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/punkweb_bb/forms.py

@@ -1,7 +1,7 @@
 from django import forms
 from django.contrib.auth.forms import AuthenticationForm, UserCreationForm
 
-from punkweb_bb.models import BoardProfile, Post, Shout, Thread
+from punkweb_bb.models import BoardProfile, Category, Post, Shout, Subcategory, Thread
 from punkweb_bb.widgets import BBCodeEditorWidget
 
 
@@ -43,6 +43,21 @@ class BoardProfileModelForm(forms.ModelForm):
         }
 
 
+class CategoryModelForm(forms.ModelForm):
+    class Meta:
+        model = Category
+        fields = (
+            "name",
+            "order",
+        )
+        widgets = {
+            "name": forms.TextInput(attrs={"autofocus": True, "class": "pw-input"}),
+            "order": forms.TextInput(
+                attrs={"class": "pw-input", "min": "0", "type": "number"}
+            ),
+        }
+
+
 class PostModelForm(forms.ModelForm):
     class Meta:
         model = Post
@@ -55,6 +70,30 @@ class PostModelForm(forms.ModelForm):
         }
 
 
+class ShoutModelForm(forms.ModelForm):
+    class Meta:
+        model = Shout
+        fields = ("content",)
+
+
+class SubcategoryModelForm(forms.ModelForm):
+    class Meta:
+        model = Subcategory
+        fields = (
+            "name",
+            "description",
+            "order",
+            "staff_post_only",
+        )
+        widgets = {
+            "name": forms.TextInput(attrs={"autofocus": True, "class": "pw-input"}),
+            "description": BBCodeEditorWidget(),
+            "order": forms.TextInput(
+                attrs={"class": "pw-input", "min": "0", "type": "number"}
+            ),
+        }
+
+
 class ThreadModelForm(forms.ModelForm):
     class Meta:
         model = Thread
@@ -66,9 +105,3 @@ class ThreadModelForm(forms.ModelForm):
             "title": forms.TextInput(attrs={"autofocus": True, "class": "pw-input"}),
             "content": BBCodeEditorWidget(),
         }
-
-
-class ShoutModelForm(forms.ModelForm):
-    class Meta:
-        model = Shout
-        fields = ("content",)

punkweb_bb-0.2.0/punkweb_bb/guests.py

@@ -0,0 +1,20 @@
+from expiringdict import ExpiringDict
+
+
+class GuestList:
+    def __init__(self):
+        self.__guests = ExpiringDict(max_len=2048, max_age_seconds=60 * 5)
+
+    def length(self):
+        return len(self.__guests)
+
+    def add(self, ip):
+        if not self.__guests.get(ip, None):
+            self.__guests[ip] = True
+
+    def clear_expired(self):
+        for key in list(self.__guests.keys()):
+            _ = self.__guests.get(key, None)
+
+
+guest_list = GuestList()

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/punkweb_bb/middleware.py

@@ -1,6 +1,8 @@
 from django.core.cache import cache
 from django.utils import timezone
 
+from punkweb_bb.guests import guest_list
+
 
 class ProfileOnlineCacheMiddleware:
     def __init__(self, get_response):
@@ -11,6 +13,11 @@ class ProfileOnlineCacheMiddleware:
             cache.set(
                 f"profile_online_{request.user.profile.id}", timezone.now(), 60 * 5
             )
+        else:
+            ip = request.META.get("REMOTE_ADDR")
+            guest_list.add(ip)
+
+        guest_list.clear_expired()
 
         response = self.get_response(request)
 

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/punkweb_bb/models.py

@@ -79,6 +79,9 @@ class Subcategory(UUIDPrimaryKeyMixin, TimestampMixin):
             "order",
         )
 
+    def can_post(self, user):
+        return not self.staff_post_only or user.is_staff
+
     @property
     def thread_count(self):
         return self.threads.count()
@@ -120,6 +123,15 @@ class Thread(UUIDPrimaryKeyMixin, TimestampMixin):
     def __str__(self):
         return f"{self.title}"
 
+    def can_edit(self, user):
+        return user == self.user or user.has_perm("punkweb_bb.change_thread")
+
+    def can_delete(self, user):
+        return user == self.user or user.has_perm("punkweb_bb.delete_thread")
+
+    def can_post(self, user):
+        return not self.is_closed
+
     @property
     def post_count(self):
         return self.posts.count()
@@ -143,6 +155,12 @@ class Post(UUIDPrimaryKeyMixin, TimestampMixin):
     def __str__(self):
         return f"{self.thread} > {self.user} > {self.created_at}"
 
+    def can_edit(self, user):
+        return user == self.user or user.has_perm("punkweb_bb.change_post")
+
+    def can_delete(self, user):
+        return user == self.user or user.has_perm("punkweb_bb.delete_post")
+
     @property
     def index(self):
         # Returns the index of the post in the thread, starting with 1
@@ -180,3 +198,6 @@ class Shout(UUIDPrimaryKeyMixin, TimestampMixin):
 
     def __str__(self):
         return f"{self.user} > {self.created_at}"
+
+    def can_delete(self, user):
+        return user == self.user or user.has_perm("punkweb_bb.delete_shout")

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/punkweb_bb/settings.py

@@ -6,3 +6,6 @@ SITE_NAME = PUNKWEB_BB.get("SITE_NAME", "PUNKWEB")
 SITE_TITLE = PUNKWEB_BB.get("SITE_TITLE", "PunkwebBB")
 FAVICON = PUNKWEB_BB.get("FAVICON", "punkweb_bb/favicon.ico")
 SHOUTBOX_ENABLED = PUNKWEB_BB.get("SHOUTBOX_ENABLED", True)
+DISCORD_WIDGET_ENABLED = PUNKWEB_BB.get("DISCORD_WIDGET_ENABLED", False)
+DISCORD_WIDGET_THEME = PUNKWEB_BB.get("DISCORD_WIDGET_THEME", "dark")
+DISCORD_SERVER_ID = PUNKWEB_BB.get("DISCORD_SERVER_ID", None)

punkweb_bb-0.2.0/punkweb_bb/static/punkweb_bb/css/category-form.css

@@ -0,0 +1,24 @@
+.categoryForm {
+  display: flex;
+  flex-direction: column;
+  gap: 1rem;
+}
+
+.categoryForm__field {
+  align-items: start;
+  display: flex;
+  flex-direction: column;
+  gap: 0.5rem;
+}
+
+.categoryForm .errorlist {
+  color: var(--oc-red-9);
+  margin: 0;
+}
+
+.categoryForm__actions {
+  align-items: center;
+  display: flex;
+  justify-content: flex-end;
+  gap: 1rem;
+}

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/punkweb_bb/static/punkweb_bb/css/index.css

@@ -7,6 +7,12 @@
   flex: 1;
 }
 
+.index__category__actions {
+  align-items: center;
+  display: flex;
+  gap: 0.25rem;
+}
+
 .index__sidebar {
   flex: 0 0 20rem;
 }

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/punkweb_bb/static/punkweb_bb/css/punkweb.css

@@ -406,6 +406,67 @@ blockquote cite {
   width: 2rem;
 }
 
+.pw-icon-button .material-symbols-outlined {
+  display: block;
+  font-size: 1.125rem;
+}
+
+.pw-icon-button.xs {
+  height: 1rem;
+  line-height: 1rem;
+  max-height: 1rem;
+  max-width: 1rem;
+  min-height: 1rem;
+  min-width: 1rem;
+  width: 1rem;
+}
+
+.pw-icon-button.xs .material-symbols-outlined {
+  font-size: 0.875rem;
+}
+
+.pw-icon-button.sm {
+  height: 1.5rem;
+  line-height: 1.5rem;
+  max-height: 1.5rem;
+  max-width: 1.5rem;
+  min-height: 1.5rem;
+  min-width: 1.5rem;
+  width: 1.5rem;
+}
+
+.pw-icon-button.sm .material-symbols-outlined {
+  font-size: 1rem;
+}
+
+.pw-icon-button.lg {
+  height: 2.5rem;
+  line-height: 2.5rem;
+  max-height: 2.5rem;
+  max-width: 2.5rem;
+  min-height: 2.5rem;
+  min-width: 2.5rem;
+  width: 2.5rem;
+}
+
+.pw-icon-button.lg .material-symbols-outlined {
+  font-size: 1.25rem;
+}
+
+.pw-icon-button.xl {
+  height: 3rem;
+  line-height: 3rem;
+  max-height: 3rem;
+  max-width: 3rem;
+  min-height: 3rem;
+  min-width: 3rem;
+  width: 3rem;
+}
+
+.pw-icon-button.sl .material-symbols-outlined {
+  font-size: 1.5rem;
+}
+
 .pw-icon-button:disabled {
   background-color: var(--oc-gray-5) !important;
   border-color: var(--oc-gray-5) !important;
@@ -413,11 +474,6 @@ blockquote cite {
   cursor: not-allowed;
 }
 
-.pw-icon-button .material-symbols-outlined {
-  display: block;
-  font-size: 1.125rem;
-}
-
 .pw-icon-button.rounded {
   border-radius: 100%;
 }
@@ -646,3 +702,26 @@ blockquote cite {
 .pw-breadcrumb-item.active {
   color: var(--breadcrumb-active);
 }
+
+/* Callout */
+
+.pw-callout {
+  background-color: var(--oc-gray-1);
+  border: 1px solid var(--border);
+  border-radius: 0.25rem;
+  color: var(--oc-gray-9);
+  padding: 0.5rem 1rem;
+  width: 100%;
+}
+
+.pw-callout.primary {
+  background-color: var(--primary-0);
+  border-color: 1px solid var(--primary-4);
+  color: var(--primary-9);
+}
+
+.pw-callout.danger {
+  background-color: var(--oc-red-0);
+  border-color: 1px solid var(--oc-red-4);
+  color: var(--oc-red-9);
+}

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/punkweb_bb/static/punkweb_bb/css/shoutbox.css

@@ -3,16 +3,27 @@
   display: flex;
   flex-direction: column;
   height: 12rem;
-  gap: 0.25rem;
   overflow-y: auto;
-  padding: 1rem;
 }
 
 .shoutbox__shout {
+  align-items: center;
+  display: flex;
+  justify-content: space-between;
   font-size: 0.75rem;
+  padding: 0.25rem 1rem;
   white-space: wrap;
 }
 
+.shoutbox__shout:hover {
+  background-color: var(--oc-gray-1);
+}
+
+.shoutbox__shout__actions {
+  align-items: center;
+  display: flex;
+}
+
 .shoutbox__form {
   padding: 0.5rem 0;
 }

punkweb_bb-0.2.0/punkweb_bb/static/punkweb_bb/css/subcategory-form.css

@@ -0,0 +1,24 @@
+.subcategoryForm {
+  display: flex;
+  flex-direction: column;
+  gap: 1rem;
+}
+
+.subcategoryForm__field {
+  align-items: start;
+  display: flex;
+  flex-direction: column;
+  gap: 0.5rem;
+}
+
+.subcategoryForm .errorlist {
+  color: var(--oc-red-9);
+  margin: 0;
+}
+
+.subcategoryForm__actions {
+  align-items: center;
+  display: flex;
+  justify-content: flex-end;
+  gap: 1rem;
+}

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/punkweb_bb/static/punkweb_bb/css/subcategory.css

@@ -5,6 +5,18 @@
   margin: 2rem 0;
 }
 
+.subcategory__header__name {
+  align-items: center;
+  display: flex;
+  gap: 1rem;
+}
+
+.subcategory__header__actions {
+  align-items: center;
+  display: flex;
+  gap: 0.5rem;
+}
+
 .thread__title {
   align-items: center;
   display: flex;

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/punkweb_bb/static/punkweb_bb/css/thread.css

@@ -55,6 +55,25 @@
   color: var(--body-fg);
 }
 
+.thread__user__groups {
+  display: flex;
+  flex-direction: column;
+  gap: 0.5rem;
+  width: 100%;
+}
+
+.thread__user__group {
+  background-color: var(--primary-8);
+  border: 1px solid var(--primary-9);
+  border-radius: 0.25rem;
+  color: var(--text-on-primary);
+  display: flex;
+  font-size: 0.875rem;
+  justify-content: center;
+  padding: 0.5rem;
+  width: 100%;
+}
+
 .thread__main {
   display: flex;
   flex-direction: column;

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/punkweb_bb/static/punkweb_bb/css/variables.css

@@ -12,6 +12,7 @@
 
   --text-dark: var(--oc-gray-9);
   --text-light: var(--oc-gray-0);
+  --text-on-primary: var(--oc-gray-0);
 
   --body-bg: var(--oc-white);
   --body-fg: var(--text-dark);

punkweb_bb-0.2.0/punkweb_bb/templates/punkweb_bb/category_create.html

@@ -0,0 +1,50 @@
+{% extends 'punkweb_bb/base.html' %}
+{% load static %}
+
+{% block title_prefix %}Create Category | {% endblock %}
+
+{% block extra_head %}
+{{form.media.css}}
+<link rel="stylesheet" href="{% static 'punkweb_bb/css/category-form.css' %}" />
+{% endblock %}
+
+{% block content %}
+
+<nav>
+  <ul class="pw-breadcrumb">
+    <li class="pw-breadcrumb-item">
+      <a href="{% url 'punkweb_bb:index' %}">Home</a>
+    </li>
+    <li class="pw-breadcrumb-item active">
+      Create Category
+    </li>
+  </ul>
+</nav>
+
+<div class="pw-card fluid">
+  <div class="pw-card-header">Create Category</div>
+  <div class="pw-card-content">
+    <form class="categoryForm" action="{% url 'punkweb_bb:category_create' %}" method="post">
+      {% csrf_token %}
+      {% for field in form %}
+      <div class="categoryForm__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="categoryForm__actions">
+        <a class="pw-button default" href="{% url 'punkweb_bb:index' %}" type="submit">Cancel</a>
+        <button class="pw-button raised primary" type="submit">Create</button>
+      </div>
+    </form>
+  </div>
+</div>
+
+{% endblock %}
+
+{% block extra_script %}
+{{form.media.js}}
+{% endblock %}

punkweb_bb-0.2.0/punkweb_bb/templates/punkweb_bb/category_update.html

@@ -0,0 +1,53 @@
+{% extends 'punkweb_bb/base.html' %}
+{% load static %}
+
+{% block title_prefix %}Edit Category | {% endblock %}
+
+{% block extra_head %}
+{{form.media.css}}
+<link rel="stylesheet" href="{% static 'punkweb_bb/css/category-form.css' %}" />
+{% endblock %}
+
+{% block content %}
+
+<nav>
+  <ul class="pw-breadcrumb">
+    <li class="pw-breadcrumb-item">
+      <a href="{% url 'punkweb_bb:index' %}">Home</a>
+    </li>
+    <li class="pw-breadcrumb-item">
+      <a href="{{category.get_absolute_url}}">{{category.name}}</a>
+    </li>
+    <li class="pw-breadcrumb-item active">
+      Edit
+    </li>
+  </ul>
+</nav>
+
+<div class="pw-card fluid">
+  <div class="pw-card-header">Edit Category</div>
+  <div class="pw-card-content">
+    <form class="categoryForm" action="{% url 'punkweb_bb:category_update' category.slug %}" method="post">
+      {% csrf_token %}
+      {% for field in form %}
+      <div class="categoryForm__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="categoryForm__actions">
+        <a class="pw-button default" href="{{category.get_absolute_url}}">Cancel</a>
+        <button class="pw-button raised primary" type="submit">Save</button>
+      </div>
+    </form>
+  </div>
+</div>
+
+{% endblock %}
+
+{% block extra_script %}
+{{form.media.js}}
+{% endblock %}

{punkweb_bb-0.1.3 → punkweb_bb-0.2.0}/punkweb_bb/templates/punkweb_bb/index.html

@@ -38,12 +38,35 @@
               </tr>
             </thead>
             <tbody>
+              {% if perms.punkweb_bb.add_subcategory or perms.punkweb_bb.change_category or perms.punkweb_bb.delete_category %}
+              <tr>
+                <td colspan="4">
+                  <div class="index__category__actions">
+                    {% if perms.punkweb_bb.add_subcategory %}
+                    <a class="pw-button ghost xs" href="{% url 'punkweb_bb:subcategory_create' category.slug %}">
+                      Create Subcategory
+                    </a>
+                    {% endif %}
+                    {% if perms.punkweb_bb.change_category %}
+                    <a class="pw-button ghost xs" href="{% url 'punkweb_bb:category_update' category.slug %}">
+                      Edit
+                    </a>
+                    {% endif %}
+                    {% if perms.punkweb_bb.delete_category %}
+                    <a class="pw-button ghost danger xs" hx-get="{% url 'punkweb_bb:category_delete' category.slug %}" hx-target="#modal-portal">
+                      Delete
+                    </a>
+                    {% endif %}
+                  </div>
+                </td>
+              </tr>
+              {% endif %}
               {% for subcategory in category.subcategories.all %}
               <tr>
                 <td>
                   <a href="{{subcategory.get_absolute_url}}" title="{{subcategory.name}}">{{subcategory.name}}</a>
                   <div>
-                    {{subcategory.description}}
+                    {{subcategory.description.rendered}}
                   </div>
                 </td>
                 <td>{{subcategory.thread_count}}</td>
@@ -110,6 +133,9 @@
         </div>
       </div>
       {% endfor %}
+      {% if perms.punkweb_bb.add_category %}
+      <a class="pw-button ghost xs" href="{% url 'punkweb_bb:category_create' %}">Create Category</a>
+      {% endif %}
     </div>
     <div class="index__sidebar">
       <div class="pw-card fluid">
@@ -171,16 +197,29 @@
             </div>
             {% endif %}
             <div class="index__statistics__row">
-              <div class="index__statistics__label">Members online:</div>
-              <div class="index__statistics__value">{{users_online|length}}</div>
-            </div>
-            <div class="index__statistics__row">
-              <div class="index__statistics__label">Staff online:</div>
-              <div class="index__statistics__value">{{staff_online|length}}</div>
+              <div class="index__statistics__label">Users online:</div>
+              <div class="index__statistics__value">{{total_online}} ({{members_online|length}} members, {{staff_online|length}} staff, {{guests_online}} guests)</div>
             </div>
           </div>
         </div>
       </div>
+      {% if punkweb_bb.settings.DISCORD_WIDGET_ENABLED %}
+      {% if punkweb_bb.settings.DISCORD_SERVER_ID %}
+      <iframe
+        src="https://discord.com/widget?id={{ punkweb_bb.settings.DISCORD_SERVER_ID }}&theme={{ punkweb_bb.settings.DISCORD_WIDGET_THEME|default:'dark' }}"
+        width="100%"
+        height="384"
+        allowtransparency="true"
+        frameborder="0"
+        sandbox="allow-popups allow-popups-to-escape-sandbox allow-same-origin allow-scripts">
+      </iframe>
+      {% else %}
+      <div class="pw-callout danger">
+        <h4>Discord Widget Error</h4>
+        <p><code>DISCORD_SERVER_ID</code> not configured in settings module.</p>
+      </div>
+      {% endif %}
+      {% endif %}
     </div>
   </div>
 </div>