django-nativemojo 0.1.15__py3-none-any.whl → 0.1.16__py3-none-any.whl

mojo/apps/docit/migrations/0001_initial.py

@@ -0,0 +1,113 @@
+# Generated by Django 4.2.21 on 2025-08-30 18:43
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+import mojo.models.rest
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('account', '0013_pushconfig_test_mode_alter_pushconfig_apns_enabled_and_more'),
+        ('fileman', '0011_alter_filerendition_original_file'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Book',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('title', models.CharField(help_text='Book title', max_length=200)),
+                ('slug', models.SlugField(help_text='URL-friendly identifier', max_length=200, unique=True)),
+                ('description', models.TextField(blank=True, help_text='Brief description of the book content')),
+                ('order_priority', models.IntegerField(db_index=True, default=0, help_text='Higher values appear first in listings')),
+                ('permissions', models.CharField(blank=True, help_text='Comma-separated permission strings for fine-grained access control', max_length=500)),
+                ('config', models.JSONField(default=dict, help_text='Book-specific settings, plugin configuration, and custom access rules')),
+                ('is_active', models.BooleanField(db_index=True, default=True, help_text='Whether this book is active and visible')),
+                ('created', models.DateTimeField(auto_now_add=True, db_index=True)),
+                ('modified', models.DateTimeField(auto_now=True, db_index=True)),
+                ('created_by', models.ForeignKey(help_text='User who created this book', on_delete=django.db.models.deletion.PROTECT, related_name='created_books', to=settings.AUTH_USER_MODEL)),
+                ('group', models.ForeignKey(help_text='Owning group for this book', on_delete=django.db.models.deletion.CASCADE, to='account.group')),
+                ('modified_by', models.ForeignKey(help_text='User who last modified this book', on_delete=django.db.models.deletion.PROTECT, related_name='modified_books', to=settings.AUTH_USER_MODEL)),
+                ('user', models.ForeignKey(help_text='Book owner for permission checks', on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'Book',
+                'verbose_name_plural': 'Books',
+                'ordering': ['-order_priority', 'title'],
+            },
+            bases=(models.Model, mojo.models.rest.MojoModel),
+        ),
+        migrations.CreateModel(
+            name='Page',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('title', models.CharField(help_text='Page title', max_length=200)),
+                ('slug', models.SlugField(help_text='URL-friendly identifier (unique within book)', max_length=200)),
+                ('content', models.TextField(help_text='Raw markdown content')),
+                ('order_priority', models.IntegerField(db_index=True, default=0, help_text='Higher values appear first in listings')),
+                ('metadata', models.JSONField(default=dict, help_text='Frontmatter and additional page metadata')),
+                ('is_published', models.BooleanField(db_index=True, default=True, help_text='Whether this page is published and visible')),
+                ('created', models.DateTimeField(auto_now_add=True, db_index=True)),
+                ('modified', models.DateTimeField(auto_now=True, db_index=True)),
+                ('book', models.ForeignKey(help_text='Book this page belongs to', on_delete=django.db.models.deletion.CASCADE, related_name='pages', to='docit.book')),
+                ('created_by', models.ForeignKey(help_text='User who created this page', on_delete=django.db.models.deletion.PROTECT, related_name='created_pages', to=settings.AUTH_USER_MODEL)),
+                ('modified_by', models.ForeignKey(help_text='User who last modified this page', on_delete=django.db.models.deletion.PROTECT, related_name='modified_pages', to=settings.AUTH_USER_MODEL)),
+                ('parent', models.ForeignKey(blank=True, help_text='Parent page for hierarchical organization', null=True, on_delete=django.db.models.deletion.CASCADE, related_name='children', to='docit.page')),
+                ('user', models.ForeignKey(help_text='Page owner (inherited from book for permissions)', on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'Page',
+                'verbose_name_plural': 'Pages',
+                'ordering': ['-order_priority', 'title'],
+                'unique_together': {('book', 'slug')},
+            },
+            bases=(models.Model, mojo.models.rest.MojoModel),
+        ),
+        migrations.CreateModel(
+            name='Asset',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('order_priority', models.IntegerField(db_index=True, default=0, help_text='Higher values appear first in asset lists')),
+                ('alt_text', models.CharField(blank=True, help_text='Alternative text for images and accessibility', max_length=200)),
+                ('description', models.TextField(blank=True, help_text='Detailed description of the asset')),
+                ('created', models.DateTimeField(auto_now_add=True, db_index=True)),
+                ('modified', models.DateTimeField(auto_now=True, db_index=True)),
+                ('book', models.ForeignKey(help_text='Book this asset belongs to', on_delete=django.db.models.deletion.CASCADE, related_name='assets', to='docit.book')),
+                ('created_by', models.ForeignKey(help_text='User who created this asset', on_delete=django.db.models.deletion.PROTECT, related_name='created_assets', to=settings.AUTH_USER_MODEL)),
+                ('file', models.ForeignKey(blank=True, help_text='Associated file from fileman', null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='docit_assets', to='fileman.file')),
+                ('user', models.ForeignKey(help_text='Asset owner (inherited from book for permissions)', on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'Asset',
+                'verbose_name_plural': 'Assets',
+                'ordering': ['-order_priority', 'id'],
+            },
+            bases=(models.Model, mojo.models.rest.MojoModel),
+        ),
+        migrations.CreateModel(
+            name='PageRevision',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('content', models.TextField(help_text='Markdown content snapshot at time of revision')),
+                ('version', models.IntegerField(db_index=True, help_text='Sequential version number for this page')),
+                ('change_summary', models.CharField(blank=True, help_text='Brief description of changes made in this revision', max_length=200)),
+                ('created', models.DateTimeField(auto_now_add=True, db_index=True)),
+                ('modified', models.DateTimeField(auto_now=True, db_index=True)),
+                ('created_by', models.ForeignKey(help_text='User who created this revision', on_delete=django.db.models.deletion.PROTECT, related_name='created_revisions', to=settings.AUTH_USER_MODEL)),
+                ('page', models.ForeignKey(help_text='Page this revision belongs to', on_delete=django.db.models.deletion.CASCADE, related_name='revisions', to='docit.page')),
+                ('user', models.ForeignKey(help_text='User for permission inheritance (from page/book)', on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'verbose_name': 'Page Revision',
+                'verbose_name_plural': 'Page Revisions',
+                'ordering': ['-version'],
+                'unique_together': {('page', 'version')},
+            },
+            bases=(models.Model, mojo.models.rest.MojoModel),
+        ),
+    ]

mojo/apps/docit/migrations/0002_alter_book_modified_by_alter_page_modified_by.py

@@ -0,0 +1,26 @@
+# Generated by Django 4.2.21 on 2025-08-30 19:06
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('docit', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='book',
+            name='modified_by',
+            field=models.ForeignKey(default=None, help_text='User who last modified this book', null=True, on_delete=django.db.models.deletion.PROTECT, related_name='modified_books', to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.AlterField(
+            model_name='page',
+            name='modified_by',
+            field=models.ForeignKey(default=None, help_text='User who last modified this page', null=True, on_delete=django.db.models.deletion.PROTECT, related_name='modified_pages', to=settings.AUTH_USER_MODEL),
+        ),
+    ]

mojo/apps/docit/migrations/0003_alter_book_group.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.21 on 2025-08-30 21:48
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('account', '0013_pushconfig_test_mode_alter_pushconfig_apns_enabled_and_more'),
+        ('docit', '0002_alter_book_modified_by_alter_page_modified_by'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='book',
+            name='group',
+            field=models.ForeignKey(blank=True, default=None, help_text='Owning group for this book', null=True, on_delete=django.db.models.deletion.CASCADE, to='account.group'),
+        ),
+    ]

mojo/apps/docit/models/__init__.py

@@ -0,0 +1,17 @@
+"""
+DocIt Models
+
+Export all DocIt models for clean imports
+"""
+
+from .book import Book
+from .page import Page
+from .page_revision import PageRevision
+from .asset import Asset
+
+__all__ = [
+    'Book',
+    'Page',
+    'PageRevision',
+    'Asset'
+]

mojo/apps/docit/models/asset.py

@@ -0,0 +1,231 @@
+from django.db import models
+from mojo.models import MojoModel
+from mojo.helpers import logit
+
+
+class Asset(models.Model, MojoModel):
+    """
+    Files associated with a book (images, documents, etc.)
+
+    Assets provide a way to attach files to documentation books,
+    with support for organization, metadata, and access control.
+    """
+
+    # Relationships
+    book = models.ForeignKey(
+        'docit.Book',
+        on_delete=models.CASCADE,
+        related_name='assets',
+        help_text="Book this asset belongs to"
+    )
+    file = models.ForeignKey(
+        'fileman.File',
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True,
+        related_name='docit_assets',
+        help_text="Associated file from fileman"
+    )
+
+    # Organization
+    order_priority = models.IntegerField(
+        default=0,
+        db_index=True,
+        help_text="Higher values appear first in asset lists"
+    )
+
+    # Optional metadata
+    alt_text = models.CharField(
+        max_length=200,
+        blank=True,
+        help_text="Alternative text for images and accessibility"
+    )
+    description = models.TextField(
+        blank=True,
+        help_text="Detailed description of the asset"
+    )
+
+    # Ownership and tracking (inherits from book permissions)
+    user = models.ForeignKey(
+        'account.User',
+        on_delete=models.PROTECT,
+        help_text="Asset owner (inherited from book for permissions)"
+    )
+    created_by = models.ForeignKey(
+        'account.User',
+        on_delete=models.PROTECT,
+        related_name='created_assets',
+        help_text="User who created this asset"
+    )
+
+    # Standard MOJO timestamps
+    created = models.DateTimeField(
+        auto_now_add=True,
+        editable=False,
+        db_index=True
+    )
+    modified = models.DateTimeField(
+        auto_now=True,
+        db_index=True
+    )
+
+    class Meta:
+        ordering = ['-order_priority', 'id']
+        verbose_name = 'Asset'
+        verbose_name_plural = 'Assets'
+
+    class RestMeta:
+        VIEW_PERMS = ['all']
+        SAVE_PERMS = ['manage_docit', 'owner']
+        DELETE_PERMS = ['manage_docit', 'owner']
+        CREATED_BY_OWNER_FIELD = 'created_by'
+        GRAPHS = {
+            'default': {
+                "fields": [
+                    'id', 'alt_text', 'description', 'order_priority', 'created'
+                ],
+                "graphs": {
+                    "user": "basic",
+                    "book": "default",
+                    "created_by": "basic",
+                    "file": "basic"
+                }
+            },
+            'detail': {
+                "fields": [
+                    'id', 'alt_text', 'description', 'order_priority',
+                    'file', 'book', 'created', 'created_by'
+                ],
+                "graphs": {
+                    "user": "basic",
+                    "book": "default",
+                    "created_by": "basic",
+                    "file": "basic"
+                }
+            },
+            'list': {
+                "fields": [
+                    'id', 'alt_text', 'order_priority'
+                ],
+                "graphs": {
+                    "user": "basic",
+                    "book": "default",
+                    "created_by": "basic",
+                    "file": "basic"
+                }
+            },
+            'file_info': {
+                "fields": [
+                    'id', 'alt_text', 'file', 'order_priority'
+                ],
+                "graphs": {
+                    "user": "basic",
+                    "book": "default",
+                    "created_by": "basic",
+                    "file": "basic"
+                }
+            }
+        }
+
+    def __str__(self):
+        if self.file:
+            return f"{self.book.title} / {self.filename}"
+        return f"{self.book.title} / Asset #{self.id}"
+
+    def save(self, *args, **kwargs):
+        """Override save to inherit user from book and log operations"""
+
+        # Inherit user from book if not set
+        if not self.user_id and self.book_id:
+            self.user = self.book.user
+
+        # Log the operation
+        if self.pk:
+            logit.info(f"Updating asset in book {self.book.title} (ID: {self.pk})")
+        else:
+            logit.info(f"Creating new asset in book {self.book.title}")
+
+        super().save(*args, **kwargs)
+
+    def delete(self, *args, **kwargs):
+        """Override delete to log the operation"""
+        logit.info(f"Deleting asset from book {self.book.title} (ID: {self.pk})")
+        super().delete(*args, **kwargs)
+
+    @property
+    def filename(self):
+        """Get the filename from the associated file"""
+        if self.file:
+            return self.file.name
+        return None
+
+    @property
+    def file_size(self):
+        """Get the file size from the associated file"""
+        if self.file:
+            return self.file.size
+        return None
+
+    @property
+    def file_type(self):
+        """Get the file type/category from the associated file"""
+        if self.file:
+            return self.file.category
+        return None
+
+    @property
+    def is_image(self):
+        """Check if asset is an image"""
+        if self.file:
+            return self.file.category == 'image'
+        return False
+
+    @property
+    def is_document(self):
+        """Check if asset is a document"""
+        if self.file:
+            return self.file.category == 'document'
+        return False
+
+    @property
+    def file_url(self):
+        """Get the URL to access the file"""
+        if self.file:
+            return self.file.url
+        return None
+
+    @property
+    def thumbnail_url(self):
+        """Get thumbnail URL for images"""
+        if self.file and self.is_image:
+            # This assumes fileman has thumbnail support
+            return getattr(self.file, 'thumbnail_url', None)
+        return None
+
+    def get_display_name(self):
+        """Get the best display name for this asset"""
+        if self.alt_text:
+            return self.alt_text
+        if self.filename:
+            return self.filename
+        return f"Asset #{self.id}"
+
+    def can_user_access(self, user):
+        """
+        Check if user can access this asset
+
+        Assets inherit access control from their parent book
+        """
+        return self.book.can_user_view(user)
+
+    def get_file_extension(self):
+        """Get file extension from filename"""
+        if self.filename:
+            return self.filename.split('.')[-1].lower() if '.' in self.filename else ''
+        return None
+
+    def get_mime_type(self):
+        """Get MIME type from the file"""
+        if self.file:
+            return getattr(self.file, 'mime_type', None)
+        return None

mojo/apps/docit/models/book.py

@@ -0,0 +1,227 @@
+from django.db import models
+from django.utils.text import slugify
+from mojo.models import MojoModel
+from mojo.helpers import logit
+
+
+class Book(models.Model, MojoModel):
+    """
+    Top-level documentation collection
+
+    A Book represents a complete documentation collection that can contain
+    multiple pages organized hierarchically, along with associated assets.
+    """
+
+    # Basic fields
+    title = models.CharField(max_length=200, help_text="Book title")
+    slug = models.SlugField(
+        unique=True,
+        max_length=200,
+        help_text="URL-friendly identifier"
+    )
+    description = models.TextField(
+        blank=True,
+        help_text="Brief description of the book content"
+    )
+
+    # Ordering and permissions
+    order_priority = models.IntegerField(
+        default=0,
+        db_index=True,
+        help_text="Higher values appear first in listings"
+    )
+    permissions = models.CharField(
+        max_length=500,
+        blank=True,
+        help_text="Comma-separated permission strings for fine-grained access control"
+    )
+
+    # Configuration
+    config = models.JSONField(
+        default=dict,
+        help_text="Book-specific settings, plugin configuration, and custom access rules"
+    )
+
+    # Status
+    is_active = models.BooleanField(
+        default=True,
+        db_index=True,
+        help_text="Whether this book is active and visible"
+    )
+
+    # Ownership and tracking
+    group = models.ForeignKey(
+        'account.Group',
+        on_delete=models.CASCADE,
+        null=True,
+        blank=True,
+        default=None,
+        help_text="Owning group for this book"
+    )
+    user = models.ForeignKey(
+        'account.User',
+        on_delete=models.PROTECT,
+        help_text="Book owner for permission checks"
+    )
+    created_by = models.ForeignKey(
+        'account.User',
+        on_delete=models.PROTECT,
+        related_name='created_books',
+        help_text="User who created this book"
+    )
+    modified_by = models.ForeignKey(
+        'account.User',
+        on_delete=models.PROTECT,
+        related_name='modified_books',
+        null=True,
+        default=None,
+        help_text="User who last modified this book"
+    )
+
+    # Standard MOJO timestamps
+    created = models.DateTimeField(
+        auto_now_add=True,
+        editable=False,
+        db_index=True
+    )
+    modified = models.DateTimeField(
+        auto_now=True,
+        db_index=True
+    )
+
+    class Meta:
+        ordering = ['-order_priority', 'title']
+        verbose_name = 'Book'
+        verbose_name_plural = 'Books'
+
+    class RestMeta:
+        VIEW_PERMS = ['all']
+        SAVE_PERMS = ['manage_docit', 'owner']
+        DELETE_PERMS = ['manage_docit', 'owner']
+        CREATED_BY_OWNER_FIELD = 'created_by'
+        UPDATED_BY_OWNER_FIELD = 'modified_by'
+        GRAPHS = {
+            'default': {
+                "fields": [
+                    'id', 'title', 'slug', 'description',
+                    'is_active', 'created', 'modified'
+                ],
+                "graphs": {
+                    "user": "basic",
+                    "group": "basic",
+                    "created_by": "basic",
+                    "modified_by": "basic"
+                }
+            },
+            'detail': {
+                "fields": [
+                    'id', 'title', 'slug', 'description', 'order_priority',
+                    'config', 'is_active', 'created', 'modified',
+                    'created_by', 'modified_by'
+                ],
+                "graphs": {
+                    "user": "basic",
+                    "group": "basic",
+                    "created_by": "basic",
+                    "modified_by": "basic"
+                }
+            },
+            'list': {
+                "fields": [
+                    'id', 'title', 'slug', 'description', 'is_active'
+                ],
+                "graphs": {
+                    # "user": "basic",
+                    "group": "basic",
+                    # "created_by": "basic",
+                    # "modified_by": "basic"
+                }
+            }
+        }
+
+    def __str__(self):
+        return self.title
+
+    def save(self, *args, **kwargs):
+        """Override save to auto-generate slug and log operations"""
+
+        # Auto-generate slug from title if not provided
+        if not self.slug:
+            self.slug = slugify(self.title.replace('_', '-'))
+
+            # Handle duplicate slugs by appending a counter
+            counter = 1
+            original_slug = self.slug
+            while Book.objects.filter(slug=self.slug).exclude(pk=self.pk).exists():
+                self.slug = f"{original_slug}-{counter}"
+                counter += 1
+
+        if (not hasattr(self, "user") or self.user is None) and self.created_by:
+            self.user = self.created_by
+
+        # Log the operation
+        if self.pk:
+            logit.info(f"Updating book: {self.title} (ID: {self.pk})")
+        else:
+            logit.info(f"Creating new book: {self.title}")
+
+        super().save(*args, **kwargs)
+
+    def delete(self, *args, **kwargs):
+        """Override delete to log the operation"""
+        logit.info(f"Deleting book: {self.title} (ID: {self.pk})")
+        super().delete(*args, **kwargs)
+
+    def get_pages(self, published_only=True):
+        """Get all pages in this book"""
+        queryset = self.pages.all()
+        if published_only:
+            queryset = queryset.filter(is_published=True)
+        return queryset.order_by('-order_priority', 'title')
+
+    def get_root_pages(self, published_only=True):
+        """Get top-level pages (no parent) in this book"""
+        queryset = self.pages.filter(parent__isnull=True)
+        if published_only:
+            queryset = queryset.filter(is_published=True)
+        return queryset.order_by('-order_priority', 'title')
+
+    def get_assets(self):
+        """Get all assets associated with this book"""
+        return self.assets.all().order_by('-order_priority', 'id')
+
+    def can_user_view(self, user):
+        """
+        Check if a user can view this book
+
+        This provides fine-grained access control beyond the basic RestMeta permissions.
+        The Book model handles detailed access logic here.
+        """
+        # Inactive books are not viewable
+        if not self.is_active:
+            return False
+
+        # Owner can always view
+        if self.user == user:
+            return True
+
+        # Group members can view if no specific restrictions
+        if user and user.groups.filter(id=self.group.id).exists():
+            return True
+
+        # Check custom permissions if defined
+        if self.permissions:
+            # This is where we'd implement custom permission logic
+            # For now, return True for basic implementation
+            return True
+
+        # Default to allowing view (since RestMeta has public view)
+        return True
+
+    def get_page_count(self):
+        """Get total number of published pages in this book"""
+        return self.pages.filter(is_published=True).count()
+
+    def get_asset_count(self):
+        """Get total number of assets in this book"""
+        return self.assets.count()