Ver 0.0.2

Author: foresle

.dockerignore

@@ -0,0 +1,8 @@
+/venv/
+/.idea/
+.env
+db.sqlite3
+/staticfiles/
+/dump.rdb
+/prod.env
+/celerybeat-schedule

.gitignore

@@ -4,3 +4,5 @@
 db.sqlite3
 /staticfiles/
 /dump.rdb
+/prod.env
+/celerybeat-schedule

README.md

@@ -1,4 +1,29 @@
+# synapse_admin
+
 "synapse_admin" is a web-based administration tool built using Django framework for managing Matrix Synapse servers. 
-It provides an intuitive interface for managing user accounts, rooms, permissions, and other configurations. 
+
+It provides an intuitive interface for managing user accounts, ~~rooms~~, ~~permissions~~, and other configurations. 
+
 With features like real-time user activity monitoring and detailed logs, "synapse_admin" simplifies the management of Matrix Synapse servers, making it easier for administrators to manage their Matrix-based communication platforms. 
-The project is open source and contributions are welcome from the community."
+
+The project is open source and contributions are welcome from the community.
+
+![Dashboard page](screenshots/1.png)
+
+_Dashboard page_
+
+![Users page](screenshots/2.png)
+
+_Users page_
+
+![Server notices page](screenshots/3.png)
+
+_Server notices page_
+
+![User page](screenshots/4.png)
+
+_User page_
+
+![Init page](screenshots/5.png)
+
+_Init page_

dashboard/tasks.py

@@ -0,0 +1,22 @@
+from celery import Celery
+from django.conf import settings
+
+from .helpers import load_media_statistics, load_server_map
+
+app = Celery()
+
+
+@app.task
+def update_media_statistics_info() -> None:
+    load_media_statistics(
+        access_token=settings.MATRIX_ADMIN_TOKEN,
+        server_name=settings.MATRIX_DOMAIN
+    )
+
+
+@app.task
+def update_server_map() -> None:
+    load_server_map(
+        access_token=settings.MATRIX_ADMIN_TOKEN,
+        server_name=settings.MATRIX_DOMAIN
+    )

dashboard/views.py

@@ -45,11 +45,22 @@ def get_context_data(self, **kwargs):
                 access_token=settings.MATRIX_ADMIN_TOKEN
             )
 
-        # Sorts users by last creation_ts and slice last week
         users: dict = cache.get('users', {})
+
+        # Sorts users by last creation_ts and slice last week
         last_week: datetime.datetime = datetime.datetime.now() - datetime.timedelta(weeks=1)
         new_users: list = [user for user in users.values() if user['created_at'] > last_week]
+
+        # Sorts users by last_seen_at and filter for today
+        today: datetime.date = datetime.datetime.now().date()
+        active_users_today: list = sorted(
+            [user for user in users.values() if
+             user['last_seen_at'] != 'Unknown' and user['last_seen_at'].date() == today],
+            key=lambda k: k['last_seen_at'], reverse=True
+        )
+
         context['new_users_for_last_week'] = new_users
+        context['active_users_today'] = active_users_today
         context['cached_users_updated_at'] = cached_users_updated_at
 
         context['amount_of_uploaded_media'] = convert_size(

docker-compose-prod.yaml

@@ -0,0 +1,40 @@
+version: "3.9"
+
+services:
+  web:
+    build: .
+    command: sh -c "python manage.py collectstatic --noinput && gunicorn project.wsgi -b 0.0.0.0:8000"
+    volumes:
+      - .:/app
+    ports:
+      - "8000:8000"
+    env_file: prod.env
+    depends_on:
+      - redis
+    restart: unless-stopped
+
+  redis:
+    image: redis
+    ports:
+      - "6379:6379"
+    restart: unless-stopped
+
+  celery:
+    build: .
+    command: celery -A project worker -l INFO
+    env_file: prod.env
+    volumes:
+      - ".:/app"
+    depends_on:
+      - redis
+    restart: unless-stopped
+
+  celery-beat:
+    build: .
+    command: celery -A project beat -l INFO
+    env_file: prod.env
+    volumes:
+      - ".:/app"
+    depends_on:
+      - redis
+    restart: unless-stopped

load_presentation_mode_data.py

@@ -0,0 +1,156 @@
+import datetime
+import os
+import random
+from django.core.cache import cache
+from django.conf import settings
+
+from dashboard.helpers import convert_size
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'project.settings')
+
+now_datetime: datetime.datetime = datetime.datetime.now()
+
+# Set init successful
+cache.set(
+    'init_successful',
+    True,
+    60 * 60  # 1 hour
+)
+
+# Set random users
+users = {}
+for i in range(0, 20):
+    user_name: str = f'@user_{i}:matrix.test.server'
+
+    user = {
+        'name': user_name,
+        'name_without_server_name_ending': user_name[:-(len('matrix.test.server') + 1)],
+        'display_name': f'@user_{i}',
+        'is_admin': random.getrandbits(1),
+        'is_deactivated': random.getrandbits(1),
+        'created_at': now_datetime - datetime.timedelta(
+            days=random.randint(2, 20), hours=random.randint(1, 6), minutes=random.randint(1, 60)
+        ),
+        'avatar_mxc_url': None,
+        'last_seen_ip': '127.0.0.1',
+        'last_seen_at': now_datetime - datetime.timedelta(
+            days=random.randint(0, 2), hours=random.randint(1, 4), minutes=random.randint(1, 60)
+        ),
+        'last_seen_country': random.choice(('🇺🇸', '🇺🇦', '🏳️‍🌈'))
+    }
+
+    users[user_name] = user
+
+cache.set(
+    settings.CACHED_USERS,
+    users,
+    60 * 60  # 1 hour
+)
+cache.set(
+    settings.CACHED_USERS_UPDATED_AT,
+    now_datetime,
+    60 * 60  # 1 hour
+)
+
+# Set media statistics
+media_statistics = []
+
+for user in users.values():
+    media_count: int = random.randint(0, 100)
+
+    media_statistics.append(
+        {
+            'user_id': user['name'],
+            'displayname': user['name_without_server_name_ending'],
+            'media_count': media_count,
+            'media_length': media_count * random.randint(100000, 900000)
+        }
+    )
+
+cache.set(
+    settings.CACHED_MEDIA_STATISTICS,
+    media_statistics,
+    60 * 60  # 1 hour
+)
+cache.set(
+    settings.CACHED_MEDIA_STATISTICS_UPDATED_AT,
+    now_datetime,
+    60 * 60  # 1 hour
+)
+
+for user_statistics in media_statistics:
+    try:
+        users[user_statistics['user_id']]['upload_media_count'] = user_statistics['media_count']
+        users[user_statistics['user_id']]['size_of_upload_media'] = convert_size(user_statistics['media_length'])
+    except KeyError:
+        continue
+
+cache.set(
+    settings.CACHED_USERS,
+    users,
+    60 * 60  # 1 hour
+)
+
+# Set server map
+server_map: dict = {
+    'nodes': [
+        {
+            'color': '#99a9af',
+            'size': random.randint(10, 30),
+            'id': '!420C1B7875A242ADB6:matrix.org',
+            'label': '#public_room_1:matrix.test.server',
+            'shape': 'dot'
+        },
+        {
+            'color': '#99a9af',
+            'size': random.randint(10, 30),
+            'id': '!420C1B7875A242ADB7:matrix.org',
+            'label': '#public_room_2:matrix.test.server',
+            'shape': 'dot'
+        }
+    ],
+    'edges': []
+}
+
+for user in users.values():
+    server_map['nodes'].append(
+        {
+            'color': '#326051',
+            'size': 5,
+            'id': user['name'],
+            'label': user['name_without_server_name_ending'],
+            'shape': 'dot'
+        }
+    )
+
+    if random.getrandbits(1):
+        server_map['edges'].append(
+            {
+                'from': user['name'],
+                'to': server_map['nodes'][random.getrandbits(1)]['id']
+            }
+        )
+
+for user in users.values():
+    if random.getrandbits(1):
+        first_user = random.choice(tuple(users.values()))
+        second_user = random.choice(tuple(users.values()))
+
+        if first_user != second_user:
+            server_map['edges'].append(
+                {
+                    'from': first_user['name'],
+                    'to': second_user['name']
+                }
+            )
+
+cache.set(
+    settings.CACHED_SERVER_MAP,
+    server_map,
+    60 * 60  # 1 hour
+)
+cache.set(
+    settings.CACHED_SERVER_MAP_UPDATED_AT,
+    now_datetime,
+    60 * 60  # 1 hour
+)

project/__init__.py

@@ -0,0 +1,3 @@
+from .celery import app as celery_app
+
+__all__ = ('celery_app',)

project/celery.py

@@ -0,0 +1,8 @@
+import os
+from celery import Celery
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'project.settings')
+
+app = Celery('project')
+app.config_from_object('django.conf:settings', namespace='CELERY')
+app.autodiscover_tasks()

project/settings.py

@@ -11,7 +11,6 @@
 
 ALLOWED_HOSTS = []
 
-
 INSTALLED_APPS = [
     'django.contrib.auth',
     'django.contrib.contenttypes',
@@ -35,6 +34,7 @@
     'django.contrib.auth.middleware.AuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'whitenoise.middleware.WhiteNoiseMiddleware',
 ]
 
 ROOT_URLCONF = 'project.urls'
@@ -80,7 +80,6 @@
     },
 ]
 
-
 LANGUAGE_CODE = 'en-us'
 TIME_ZONE = 'Europe/Kiev'
 USE_I18N = True
@@ -91,6 +90,7 @@
 STATICFILES_DIRS = (
     BASE_DIR / 'static',
 )
+STATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'
 
 DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
 
@@ -134,3 +134,20 @@
 
 CACHED_MEDIA_STATISTICS: str = 'media_statistics'
 CACHED_MEDIA_STATISTICS_UPDATED_AT: str = 'media_statistics_updated_at'
+
+# CELERY
+CELERY_BEAT_SCHEDULE = {
+    'update_users_info_every_30m': {
+        'task': 'users.tasks.update_users_info',
+        'schedule': 60 * 30
+    },
+    'update_media_statistics_info_every_1h': {
+        'task': 'dashboard.tasks.update_media_statistics_info',
+        'schedule': 60 * 60
+    },
+    'update_server_map_every_12h': {
+        'task': 'users.tasks.dashboard.tasks.update_server_map',
+        'schedule': 60 * 60 * 12
+    },
+}
+CELERY_BROKER_URL = env('REDIS_LOCATION', default='redis://redis:6379/')