evewiki 0.0.1.dev1__tar.gz

evewiki-0.0.1.dev1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ryan Cunning
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

evewiki-0.0.1.dev1/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: evewiki
+Version: 0.0.1.dev1
+Summary: Wiki plugin app for Alliance Auth.
+Author-email: Ryan Cunning <ryan.cunning@gmail.com>
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.2
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+License-File: LICENSE
+Requires-Dist: allianceauth>=3
+Project-URL: Changelog, https://gitlab.com/cunningdesigns/aa-wiki/-/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://gitlab.com/cunningdesigns/aa-wiki
+Project-URL: Homepage, https://gitlab.com/cunningdesigns/aa-wiki
+Project-URL: Source, https://gitlab.com/cunningdesigns/aa-wiki
+Project-URL: Tracker, https://gitlab.com/cunningdesigns/aa-wiki/-/issues
+
+# aa-wiki
+
+Wiki plugin for [AllianceAuth](https://gitlab.com/allianceauth/allianceauth) to curate content.
+
+## Features
+
+- Create and organise pages in a hierarchical structure using `slugs`
+- Supports markdown with both rich and raw editing modes
+- Version History
+- Event logging
+- Restrict content by user's `groups` and/or `states`
+
+## Permissions
+
+Users need to have at least `basic_access` interactions with the application
+
+| Name                  | Description                                              |
+|-----------------------|----------------------------------------------------------|
+| `basic_access`        | Basic access to load content                             |
+| `editor_access`       | Grant the necessary controls and access to edit content  |
+
+
+## Settings
+
+List of settings that can be modified for the application
+You can alter them by adding a record to the `Settings` section/table in the `evewiki` section of the Admin site
+
+| Name                          | Description                                                                                      | Default |
+|-------------------------------|--------------------------------------------------------------------------------------------------|---------|
+| `hierarchy_max_display_depth` | Limit the depth of the tree for the hierarchy on the main display                                | 10      |
+| `max_versions`                | No one has infinite disk space, a sensible limit which can be modified to clear down the history | 1000    |
+
+## Installation
+
+*Assumes setup of AA as per the [documentation](https://allianceauth.readthedocs.io/en/latest/installation-containerized/docker.html)*
+Final folder structure would look like
+```plaintext
+aa-dev
+├─ aa-docker
+└─ aa-wiki
+
+```
+
+Traverse into the `aa-dev` folder and clone the repo
+```bash
+git clone https://gitlab.com/cunningdesigns/aa-wiki.git
+```
+
+Traverse to `../aa-docker` folder
+
+Bind-mount the plugin-folder in `aa-docker/docker-compose.yml`
+```yaml
+x-allianceauth-base:
+  volumes:
+    - ../aa-wiki:/home/allianceauth/evewiki
+```
+
+___
+*there has to be a better way*
+> Replace `aa-wiki/evewiki/views.py` with content from [example plugin](https://gitlab.com/ErikKalkoken/allianceauth-example-plugin/-/blob/master/example/views.py?ref_type=heads)
+
+> Comment out lines 11,12 & 14 on `aa-wiki/evewiki/urls.py`
+___
+
+Start the containers (may require sudo)
+```bash
+docker compose --env-file=.env up -d
+```
+
+Open a terminal in the gunicorn container, initiate the plugin install
+```bash
+docker compose exec allianceauth_gunicorn bash
+pip install -e ../evewiki
+```
+
+add `evewiki` to `aa-docker/conf/local.py`
+
+Apply migrations and exit
+```bash
+python manage.py migrate
+```
+
+restart AA
+```bash
+docker compose restart allianceauth_gunicorn
+```
+
+___
+*there has to be a better way*
+> Remember to undo the modifications to `evewiki/evewiki/views.py` & `evewiki/evewiki/urls.py`
+___
+

evewiki-0.0.1.dev1/README.md

@@ -0,0 +1,91 @@
+# aa-wiki
+
+Wiki plugin for [AllianceAuth](https://gitlab.com/allianceauth/allianceauth) to curate content.
+
+## Features
+
+- Create and organise pages in a hierarchical structure using `slugs`
+- Supports markdown with both rich and raw editing modes
+- Version History
+- Event logging
+- Restrict content by user's `groups` and/or `states`
+
+## Permissions
+
+Users need to have at least `basic_access` interactions with the application
+
+| Name                  | Description                                              |
+|-----------------------|----------------------------------------------------------|
+| `basic_access`        | Basic access to load content                             |
+| `editor_access`       | Grant the necessary controls and access to edit content  |
+
+
+## Settings
+
+List of settings that can be modified for the application
+You can alter them by adding a record to the `Settings` section/table in the `evewiki` section of the Admin site
+
+| Name                          | Description                                                                                      | Default |
+|-------------------------------|--------------------------------------------------------------------------------------------------|---------|
+| `hierarchy_max_display_depth` | Limit the depth of the tree for the hierarchy on the main display                                | 10      |
+| `max_versions`                | No one has infinite disk space, a sensible limit which can be modified to clear down the history | 1000    |
+
+## Installation
+
+*Assumes setup of AA as per the [documentation](https://allianceauth.readthedocs.io/en/latest/installation-containerized/docker.html)*
+Final folder structure would look like
+```plaintext
+aa-dev
+├─ aa-docker
+└─ aa-wiki
+
+```
+
+Traverse into the `aa-dev` folder and clone the repo
+```bash
+git clone https://gitlab.com/cunningdesigns/aa-wiki.git
+```
+
+Traverse to `../aa-docker` folder
+
+Bind-mount the plugin-folder in `aa-docker/docker-compose.yml`
+```yaml
+x-allianceauth-base:
+  volumes:
+    - ../aa-wiki:/home/allianceauth/evewiki
+```
+
+___
+*there has to be a better way*
+> Replace `aa-wiki/evewiki/views.py` with content from [example plugin](https://gitlab.com/ErikKalkoken/allianceauth-example-plugin/-/blob/master/example/views.py?ref_type=heads)
+
+> Comment out lines 11,12 & 14 on `aa-wiki/evewiki/urls.py`
+___
+
+Start the containers (may require sudo)
+```bash
+docker compose --env-file=.env up -d
+```
+
+Open a terminal in the gunicorn container, initiate the plugin install
+```bash
+docker compose exec allianceauth_gunicorn bash
+pip install -e ../evewiki
+```
+
+add `evewiki` to `aa-docker/conf/local.py`
+
+Apply migrations and exit
+```bash
+python manage.py migrate
+```
+
+restart AA
+```bash
+docker compose restart allianceauth_gunicorn
+```
+
+___
+*there has to be a better way*
+> Remember to undo the modifications to `evewiki/evewiki/views.py` & `evewiki/evewiki/urls.py`
+___

evewiki-0.0.1.dev1/evewiki/__init__.py

@@ -0,0 +1,6 @@
+"""Wiki plugin app for Alliance Auth."""
+
+# pylint: disable = invalid-name
+default_app_config = "evewiki.apps.EveWikiConfig"
+
+__version__ = "0.0.1.dev1"

evewiki-0.0.1.dev1/evewiki/admin.py

@@ -0,0 +1,16 @@
+"""Admin site."""
+
+from django.contrib import admin
+
+from .models.logs import Log
+from .models.page_versions import PageVersion
+from .models.pages import Page
+from .models.settings import Setting
+
+# from django.contrib import admin
+
+# Register your models for the admin site here.
+admin.site.register(Page)
+admin.site.register(Setting)
+admin.site.register(PageVersion)
+admin.site.register(Log)

evewiki-0.0.1.dev1/evewiki/app_settings.py

@@ -0,0 +1,5 @@
+"""App settings."""
+
+from django.conf import settings
+
+EXAMPLE_SETTING_ONE = getattr(settings, "EXAMPLE_SETTING_ONE", None)

evewiki-0.0.1.dev1/evewiki/apps.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig
+
+from . import __version__
+
+
+class EveWikiConfig(AppConfig):
+    name = "evewiki"
+    label = "evewiki"
+    verbose_name = f"evewiki v{__version__}"

evewiki-0.0.1.dev1/evewiki/auth_hooks.py

@@ -0,0 +1,35 @@
+from django.utils.translation import gettext_lazy as _
+
+from allianceauth import hooks
+from allianceauth.services.hooks import MenuItemHook, UrlHook
+
+from . import urls
+
+
+class EveWikiMenuItem(MenuItemHook):
+    """This class ensures only authorized users will see the menu entry"""
+
+    def __init__(self):
+        # setup menu entry for sidebar
+        MenuItemHook.__init__(
+            self,
+            _("wiki"),
+            "fas fa-tree fa-fw",
+            "evewiki:index",
+            navactive=["evewiki:"],
+        )
+
+    def render(self, request):
+        if request.user.has_perm("evewiki.basic_access"):
+            return MenuItemHook.render(self, request)
+        return ""
+
+
+@hooks.register("menu_item_hook")
+def register_menu():
+    return EveWikiMenuItem()
+
+
+@hooks.register("url_hook")
+def register_urls():
+    return UrlHook(urls, "evewiki", r"^evewiki/")

evewiki-0.0.1.dev1/evewiki/forms.py

@@ -0,0 +1,29 @@
+from django import forms
+
+from .models.pages import Page
+
+
+class PageForm(forms.ModelForm):
+
+    # Customised ddl inferring additional context via text-indentation
+    parent = forms.ChoiceField(
+        choices=Page.list(),
+        required=False,
+        label="Path",
+        help_text=Page._meta.get_field("parent").help_text,
+    )
+
+    class Meta:
+        model = Page
+        fields = ["title", "parent", "slug", "priority", "states", "groups"]
+
+    def clean(self):
+        """
+        Django needs a little help to turn the custom `parent` field back into a model.
+        """
+        cleaned_data = super().clean()
+        parent_id = cleaned_data["parent"]
+        cleaned_data["parent"] = (
+            Page.objects.get(pk=int(parent_id)) if parent_id else None
+        )
+        return cleaned_data

evewiki-0.0.1.dev1/evewiki/migrations/0001_initial.py

@@ -0,0 +1,190 @@
+# Generated by Django 4.2.21 on 2025-05-27 00:35
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ("auth", "0012_alter_user_first_name_max_length"),
+        ("authentication", "0024_alter_userprofile_language"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="General",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+            ],
+            options={
+                "permissions": (
+                    ("basic_access", "Can access this app"),
+                    ("editor_access", "Can edit this app"),
+                ),
+                "managed": False,
+                "default_permissions": (),
+            },
+        ),
+        migrations.CreateModel(
+            name="Log",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("user", models.TextField(blank=True, default="", null=True)),
+                ("action", models.TextField(blank=True, default="", null=True)),
+                ("details", models.TextField(blank=True, default="", null=True)),
+                ("created", models.DateTimeField(auto_now_add=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name="Page",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "title",
+                    models.CharField(
+                        help_text="Required: Displayed above content and in menu",
+                        max_length=255,
+                    ),
+                ),
+                (
+                    "slug",
+                    models.CharField(
+                        help_text="Required: Indentifier for path and links",
+                        max_length=255,
+                    ),
+                ),
+                (
+                    "priority",
+                    models.IntegerField(
+                        default=10,
+                        help_text="Required: Sort order for pages on the same path",
+                    ),
+                ),
+                ("content", models.TextField(blank=True, default="", null=True)),
+                (
+                    "groups",
+                    models.ManyToManyField(
+                        blank=True,
+                        default=None,
+                        help_text="Optional: Restrict Page to specific Groups",
+                        related_name="+",
+                        to="auth.group",
+                        verbose_name="groups",
+                    ),
+                ),
+                (
+                    "parent",
+                    models.ForeignKey(
+                        blank=True,
+                        help_text="Required: Oragnise page hierarchy",
+                        null=True,
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="children",
+                        to="evewiki.page",
+                    ),
+                ),
+                (
+                    "states",
+                    models.ManyToManyField(
+                        blank=True,
+                        default=None,
+                        help_text="Optional: Restrict Page to specific States",
+                        related_name="+",
+                        to="authentication.state",
+                        verbose_name="states",
+                    ),
+                ),
+            ],
+        ),
+        migrations.CreateModel(
+            name="Setting",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "hierarchy_max_display_depth",
+                    models.IntegerField(
+                        default=10,
+                        help_text="Limit the depth of the tree for the hierarchy on the main display",
+                    ),
+                ),
+                (
+                    "max_versions",
+                    models.IntegerField(
+                        default=1000,
+                        help_text="No one has infinite disk space, a sensible limit which can be modified to clear down the history",
+                    ),
+                ),
+            ],
+        ),
+        migrations.CreateModel(
+            name="PageVersion",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("content", models.TextField(blank=True, default="", null=True)),
+                ("created", models.DateTimeField(auto_now_add=True)),
+                (
+                    "page",
+                    models.ForeignKey(
+                        blank=True,
+                        help_text="Page being edited",
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        to="evewiki.page",
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        blank=True,
+                        help_text="User editing the page",
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        to="authentication.userprofile",
+                    ),
+                ),
+            ],
+        ),
+    ]

evewiki-0.0.1.dev1/evewiki/models/logs.py

@@ -0,0 +1,15 @@
+from django.db import models
+
+
+class Log(models.Model):
+    """
+    No relationships just a log.
+    """
+
+    user = models.TextField(default="", blank=True, null=True)
+
+    action = models.TextField(default="", blank=True, null=True)
+
+    details = models.TextField(default="", blank=True, null=True)
+
+    created = models.DateTimeField(auto_now_add=True)

evewiki-0.0.1.dev1/evewiki/models/page_versions.py

@@ -0,0 +1,48 @@
+from django.db import models
+
+from allianceauth.authentication.models import UserProfile
+
+from .pages import Page
+from .settings import Setting
+
+
+class PageVersion(models.Model):
+    """
+    Previous edits have value
+    """
+
+    page = models.ForeignKey(
+        Page,
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        help_text="Page being edited",
+    )
+
+    user = models.ForeignKey(
+        UserProfile,
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        help_text="User editing the page",
+    )
+
+    content = models.TextField(default="", blank=True, null=True)
+
+    created = models.DateTimeField(auto_now_add=True)
+
+    def save(self, *args, **kwargs):
+        """
+        Clean up old versions when saving
+        """
+        super().save(*args, **kwargs)
+        if self.page_id:
+            # Get the IDs of old versions to delete
+            settings = Setting.get_settings()
+            old_version_ids = list(
+                PageVersion.objects.filter(page=self.page)
+                .order_by("-created")
+                .values_list("id", flat=True)[settings.max_versions :]
+            )
+            if old_version_ids:
+                PageVersion.objects.filter(id__in=old_version_ids).delete()