punkweb-bb 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

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/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/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/static/punkweb_bb/css/punkweb.css

@@ -646,3 +646,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/templates/punkweb_bb/index.html

@@ -171,16 +171,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>

punkweb_bb/tests.py

@@ -299,14 +299,14 @@ class IndexViewTestCase(TestCase):
             username="staff", password="staff", is_staff=True
         )
 
-    def test_users_online(self):
+    def test_members_online(self):
         response = self.client.get(self.url)
-        self.assertEqual(len(response.context["users_online"]), 0)
+        self.assertEqual(len(response.context["members_online"]), 0)
 
         self.client.force_login(self.user)
         response = self.client.get(self.url)
 
-        self.assertEqual(len(response.context["users_online"]), 1)
+        self.assertEqual(len(response.context["members_online"]), 1)
 
     def test_staff_online(self):
         response = self.client.get(self.url)
@@ -317,6 +317,17 @@ class IndexViewTestCase(TestCase):
 
         self.assertEqual(len(response.context["staff_online"]), 1)
 
+    def test_guests_online(self):
+        response = self.client.get(self.url)
+        self.assertEqual(response.context["guests_online"], 1)
+
+    def test_total_online(self):
+        response = self.client.get(self.url)
+        self.client.force_login(self.user)
+        response = self.client.get(self.url)
+
+        self.assertEqual(response.context["total_online"], 2)
+
     def test_newest_user(self):
         response = self.client.get(self.url)
         self.assertEqual(response.context["newest_user"], self.staff_user)

punkweb_bb/views.py

@@ -6,6 +6,7 @@ from django.http import HttpResponseForbidden
 from django.shortcuts import get_object_or_404, redirect, render
 from django.utils import timezone
 
+from punkweb_bb.guests import guest_list
 from punkweb_bb.forms import (
     BoardProfileModelForm,
     LoginForm,
@@ -31,8 +32,12 @@ def index_view(request):
 
     users = User.objects.select_related("profile").all()
     newest_user = users.order_by("-profile__created_at").first()
+
     users_online = [user for user in users if user.profile.is_online]
+    members_online = [user for user in users_online if not user.is_staff]
     staff_online = [user for user in users_online if user.is_staff]
+    guests_online = guest_list.length()
+    total_online = len(members_online) + len(staff_online) + guests_online
 
     context = {
         "categories": categories,
@@ -41,8 +46,10 @@ def index_view(request):
         "post_count": post_count,
         "users": users,
         "newest_user": newest_user,
-        "users_online": users_online,
+        "members_online": members_online,
         "staff_online": staff_online,
+        "guests_online": guests_online,
+        "total_online": total_online,
     }
     return render(request, "punkweb_bb/index.html", context=context)
 

{punkweb_bb-0.1.3.dist-info → punkweb_bb-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: punkweb-bb
-Version: 0.1.3
+Version: 0.1.4
 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: expiringdict
 Requires-Dist: pillow
 
 # PunkwebBB
@@ -115,6 +116,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.dist-info → punkweb_bb-0.1.4.dist-info}/RECORD

@@ -5,17 +5,18 @@ punkweb_bb/apps.py,sha256=GCDLy9B9vumeCsaauQ7LN4FOqE02mXWXECIz8G6KZCQ,207
 punkweb_bb/bbcode_tags.py,sha256=yNayXcZoRcRVZsdVrKIdKOV7bwlApFfq_CVfh1im7SY,4419
 punkweb_bb/context_processors.py,sha256=BEOGvWVukvxJUxWZBIc32ioB-mGqImSEBuhhZjqI2G0,146
 punkweb_bb/forms.py,sha256=O1lzmgumdnSEjBKi10c7ODftIqRmvtEIdNj1IODCikk,1977
-punkweb_bb/middleware.py,sha256=lF1w7XM07s1kcrOWodzErHop9zpIE5SEE52YLMAbDKg,456
+punkweb_bb/guests.py,sha256=Nvn4ZVJvQSQs_f-GeSwNn79Qp8ap_CAoXpYfRTqSbxg,467
+punkweb_bb/middleware.py,sha256=NrYv6nyAYKGcu-qKRnZmCyLghtJ4MUHvt3m5NS8HJbo,628
 punkweb_bb/mixins.py,sha256=XfiThPL7rB71IfukS1ikvYQhfg8RwgSVgsm10Ul1ezM,395
 punkweb_bb/models.py,sha256=Y5w80EQ85Mut71xiDVMALqLXdydlTxOiZEljmnH5g-E,5519
 punkweb_bb/pagination.py,sha256=OgoZuJsq9MKMvBKYylJVPaNtM9ni3K8OAvOdi-eGr3M,409
 punkweb_bb/parsers.py,sha256=VjWSPqpVfypHLHP0NrfLqXB-1b0W6oFuGIzoAiPi71I,2732
 punkweb_bb/response.py,sha256=dETGVC9Xrsq02pQzmIIWbSUt472lJ4fgLwBKrXnP3t4,130
-punkweb_bb/settings.py,sha256=rYKMQxbC6rfzOQgcjAoBuMEgKHOITvOX1PrKTweEYKk,312
+punkweb_bb/settings.py,sha256=ebJahIZHt1fYdhxB9wWDlWj5KhzExUtaXyoFLy8uR6k,517
 punkweb_bb/signals.py,sha256=bVdfg942Mwq-fYDZ1Z52Q0V2BCk1lgzGz8JVZFPnzJ8,365
-punkweb_bb/tests.py,sha256=BXkvqtr1JbE2WQYkgjse3wp9ky3cwOzQcVHoqNhHJmw,25989
+punkweb_bb/tests.py,sha256=eMvY9tnOkTd_zWs_Qs0Z6X-MtVSv4TtJSZfTy4beGp4,26368
 punkweb_bb/urls.py,sha256=_mRAtaZoKzPZ_uuOCFy6_lOwFCavv26p5kMKD9MH4c4,1538
-punkweb_bb/views.py,sha256=HDJCM8PgDkQu96UbZLFyjSD2K9WIjLhWEO-QBM3APmk,10723
+punkweb_bb/views.py,sha256=9g9s2rOpgfoGUdPAL9OZrWveudxOG4J5_bd9Mqd_TJI,11036
 punkweb_bb/widgets.py,sha256=eF6CB5nnh_6XJadpDzDKgd9incd0VIR63Rnzdr8T2n0,840
 punkweb_bb/__pycache__/__init__.cpython-311.pyc,sha256=3PyxCxoznfadaGt0a7re4j0Ky9z9hblufpcwPB85kK8,161
 punkweb_bb/__pycache__/admin.cpython-311.pyc,sha256=rAPYqRy7hAVZn3qST3ypYdulvH9IBhzWEgvbbAMIMIY,3679
@@ -24,17 +25,18 @@ punkweb_bb/__pycache__/apps.cpython-311.pyc,sha256=lw328DOwOp1F8FWTFYb3qV1EoBNgR
 punkweb_bb/__pycache__/bbcode_tags.cpython-311.pyc,sha256=QI4BJt5plqLMiAvlVAxibuNONi69PJFQpotpS50olro,8534
 punkweb_bb/__pycache__/context_processors.cpython-311.pyc,sha256=P7rEsodXonYexbS5vUaUKVJ9tIx1pOVk6NQWVvWNvS8,392
 punkweb_bb/__pycache__/forms.cpython-311.pyc,sha256=JRbtAaXyXgG9eDdBjKBkSn8qeZtdxRc7L2_ceE-MpW8,4680
-punkweb_bb/__pycache__/middleware.cpython-311.pyc,sha256=gZN0oVrPh9nIUUni_DvPrhMOYPR98SXrYxgHIsUXX-0,1249
+punkweb_bb/__pycache__/guests.cpython-311.pyc,sha256=vgZJcZGyHZkllCAhXHGgajHh7YM1ntXinSed3ojIK6I,1581
+punkweb_bb/__pycache__/middleware.cpython-311.pyc,sha256=KbZ6z2Q7eCRX3dB7mnRUpn58mb_O8sXpOw_sqVfQsgM,1560
 punkweb_bb/__pycache__/mixins.cpython-311.pyc,sha256=eP1NjqDNYMYXrC45DNkrTqVAUv1vsGBrqPy5U5CB_aw,1478
 punkweb_bb/__pycache__/models.cpython-311.pyc,sha256=9W03p0j5_dYnQ4YffZUrN_A5-Bvkbpvfmpr5rOkzyAQ,12308
 punkweb_bb/__pycache__/pagination.cpython-311.pyc,sha256=r54xmtiRp5dm1n2Xa7oElMFFaYFY0RzmMuF3Er4UqEA,990
 punkweb_bb/__pycache__/parsers.cpython-311.pyc,sha256=pp8JZt9V3HhquQMGrhglwLc53GxgNFWjjSnK3Bpxf8o,5335
 punkweb_bb/__pycache__/response.cpython-311.pyc,sha256=CEPckYWZkOrdU2Vow-ni0ZrWEUBww0uJzyr_wv---mM,448
-punkweb_bb/__pycache__/settings.cpython-311.pyc,sha256=ZjE994_MuSW_9Dn_ufsUH-vrld-BvqEwoCF7YL9tbrA,665
+punkweb_bb/__pycache__/settings.cpython-311.pyc,sha256=earWFaFtg8IPqfOz9I6wdpI9bJtxjxsTwG7LoTCPmtw,947
 punkweb_bb/__pycache__/signals.cpython-311.pyc,sha256=AHChn7hDdrOmCAwKIKKuFOY-4hyBP9uwTkyb5bnFV-Q,864
-punkweb_bb/__pycache__/tests.cpython-311.pyc,sha256=3CM8FL8P1YXVcgShhXqXjg3Yo3T1amKXlVtHRUZ2d7o,50877
+punkweb_bb/__pycache__/tests.cpython-311.pyc,sha256=D5pfsajoulTkeQ4RnDEc_HZZ9AH-ZIo3cPnh6BACaHY,51829
 punkweb_bb/__pycache__/urls.cpython-311.pyc,sha256=80TvNUws6ip1FCts6bubO3DGQJ2yOlB-WReK-qaTnGY,2304
-punkweb_bb/__pycache__/views.cpython-311.pyc,sha256=bjqhbTnN0-pvIygCzh0NXY6lNJUjMpz8B51EIlpay94,15592
+punkweb_bb/__pycache__/views.cpython-311.pyc,sha256=IidhDNPCjZExmP26hujz3nKocJlf4bFlVxgbP2xM6Is,16108
 punkweb_bb/__pycache__/widgets.cpython-311.pyc,sha256=-RcQ3JapLHw8Bbi4FP05kQJJIa7bnliKPaFpkDCOWvQ,1552
 punkweb_bb/migrations/0001_initial.py,sha256=3RGsylygBcWx1kIPhSzOb9v_2yvowsxKfxuSinKKuS0,8950
 punkweb_bb/migrations/0002_thread_view_count.py,sha256=JJZT53Mp8Ofht3oIi67s-0wzCdpYyu8wOeCi_B8q8Yo,388
@@ -50,7 +52,7 @@ punkweb_bb/static/punkweb_bb/css/members.css,sha256=1Fz0uVDbs3RnuXNjOtnGnK2jok3L
 punkweb_bb/static/punkweb_bb/css/post-form.css,sha256=rEiYplAobLjjUYAcnjNqIjyIVhe9O5hAlPJ3STW-K14,321
 punkweb_bb/static/punkweb_bb/css/profile.css,sha256=yfNJT_D-05deqiBrdIgPeCSO_DFSL8-fGEEHnGrCIYM,916
 punkweb_bb/static/punkweb_bb/css/punkweb-modal.css,sha256=ctwo5bgbAW-k0uqrufDbqeQfAh87-BZ-5gPm8aJHeT4,1296
-punkweb_bb/static/punkweb_bb/css/punkweb.css,sha256=UZT592v_krB8DPFf6YN1zlKmmFiCAXdS_KqO98GrKNM,11284
+punkweb_bb/static/punkweb_bb/css/punkweb.css,sha256=4-s3mmZa-HMiPS-pNyfMqo7RPaq1KlEewril-tQbmls,11745
 punkweb_bb/static/punkweb_bb/css/settings.css,sha256=ulQQFTu8slk2rYOmhvci5v-AVnguUuDhKQDhyQOsQNU,308
 punkweb_bb/static/punkweb_bb/css/shoutbox.css,sha256=-aPkQHelFsy8IYhURqTPEMIsd1ivS9mf-4ha3xHyAms,333
 punkweb_bb/static/punkweb_bb/css/subcategory.css,sha256=1wjszJbkCJL-UJRFqOWSmX4yr60ekx0YtswZouUsY7s,536
@@ -191,7 +193,7 @@ punkweb_bb/static/punkweb_bb/vendor/sceditor-3.2.0/minified/themes/content/defau
 punkweb_bb/templates/punkweb_bb/base.html,sha256=Gu2ZVeP0p7GnsfXFxByXRd9LT4DNXx0O1czSGjwYg0w,4037
 punkweb_bb/templates/punkweb_bb/base_modal.html,sha256=OCbtsMWeNCO0Tl1PmHCcGkwoi1OZjeIK_VhNTzMor7M,460
 punkweb_bb/templates/punkweb_bb/bbcode.html,sha256=1EGBejsOMZOPi6P39oR6E35VdqnfR6wYWeKDl4Xr_js,396
-punkweb_bb/templates/punkweb_bb/index.html,sha256=2y8gS6UzoJkVXvmw5PEuuxyYIarlNjGzTmmNMuNWNJ8,8127
+punkweb_bb/templates/punkweb_bb/index.html,sha256=jflA40dpl9aId0a6E_oE2PBjlvWK25cmbN9OoePzeqM,8703
 punkweb_bb/templates/punkweb_bb/login.html,sha256=ZUOmbyZREzS7Sw02Lfb9zpRJQQWwJgolnj9lcBKnOtg,1087
 punkweb_bb/templates/punkweb_bb/members.html,sha256=ceRCRX0AN7V8d7paz9495y8aQByMUKDWVWL2GzoGbus,2729
 punkweb_bb/templates/punkweb_bb/profile.html,sha256=MW1JWLs_lLpg62DDcvcZJRwrHquYA5nCwQqL1v9ZGCo,2948
@@ -213,8 +215,8 @@ punkweb_bb/templatetags/__pycache__/__init__.cpython-311.pyc,sha256=VEPKwaIhqpKp
 punkweb_bb/templatetags/__pycache__/humanize_count.cpython-311.pyc,sha256=UKD6_5RX8YpYpg-LPrgGxBkW56THsbYY51cKTYdKwRY,621
 punkweb_bb/templatetags/__pycache__/humanize_int.cpython-311.pyc,sha256=csY5ek-bevYVeM91hYFKozuKWXCTXb7M-7Bokwdxhrk,619
 punkweb_bb/templatetags/__pycache__/shoutbox_bbcode.cpython-311.pyc,sha256=Jhg9qW-nQe6IDr45rE0ZgeDYF4E61S7kYAYpbMo5ZQ8,833
-punkweb_bb-0.1.3.dist-info/LICENSE,sha256=YYysF07B-kyXSO7IWFB9f49ZXa6LIFUTVsR1Ogmhp8s,1507
-punkweb_bb-0.1.3.dist-info/METADATA,sha256=thU9kjReWNpjs73xcTkXgnO0LKX_-g_wELf87WiE-0Q,4930
-punkweb_bb-0.1.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-punkweb_bb-0.1.3.dist-info/top_level.txt,sha256=sWuGdGnk0ejOXiFDzlBqrNs2VbPEx0_i8UwWXn4SuHU,11
-punkweb_bb-0.1.3.dist-info/RECORD,,
+punkweb_bb-0.1.4.dist-info/LICENSE,sha256=YYysF07B-kyXSO7IWFB9f49ZXa6LIFUTVsR1Ogmhp8s,1507
+punkweb_bb-0.1.4.dist-info/METADATA,sha256=6ypsD63FEqGSzezKYpfi0ppzLVrsYv4cbGLXcjnGHdE,5107
+punkweb_bb-0.1.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+punkweb_bb-0.1.4.dist-info/top_level.txt,sha256=sWuGdGnk0ejOXiFDzlBqrNs2VbPEx0_i8UwWXn4SuHU,11
+punkweb_bb-0.1.4.dist-info/RECORD,,