Disable scales if no items are available

Introduce the concept of catalogs, improve books and code refactoring

.github/workflows/django.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       max-parallel: 2
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.12', '3.13']
 
     steps:
     - uses: actions/checkout@v3

.gitignore

@@ -10,7 +10,6 @@ __pycache__/
 .Python
 build/
 develop-eggs/
-dist/
 downloads/
 eggs/
 .eggs/

README.md

@@ -49,7 +49,7 @@ It has been developed with:
 
 ## Requirements
 
-- Python 3.9+
+- Python 3.10+
 - A USB port when running Arduino hardware (and adaptors if you have a Mac)
 
 ## Web portal installation

ram/bookshelf/admin.py

@@ -1,36 +1,94 @@
 from django.contrib import admin
 from adminsortable2.admin import SortableAdminBase, SortableInlineAdminMixin
 
-from bookshelf.models import BookProperty, BookImage, Book, Author, Publisher
+from bookshelf.models import (
+    BaseBookProperty,
+    BaseBookImage,
+    BaseBookDocument,
+    Book,
+    Author,
+    Publisher,
+    Catalog,
+)
 
 
 class BookImageInline(SortableInlineAdminMixin, admin.TabularInline):
-    model = BookImage
+    model = BaseBookImage
     min_num = 0
     extra = 0
     readonly_fields = ("image_thumbnail",)
     classes = ["collapse"]
+    verbose_name = "Image"
+
+
+class BookDocInline(admin.TabularInline):
+    model = BaseBookDocument
+    min_num = 0
+    extra = 0
+    classes = ["collapse"]
 
 
 class BookPropertyInline(admin.TabularInline):
-    model = BookProperty
+    model = BaseBookProperty
     min_num = 0
     extra = 0
+    autocomplete_fields = ("property",)
+    verbose_name = "Property"
+    verbose_name_plural = "Properties"
 
 
 @admin.register(Book)
 class BookAdmin(SortableAdminBase, admin.ModelAdmin):
-    inlines = (BookImageInline, BookPropertyInline,)
+    inlines = (
+        BookPropertyInline,
+        BookImageInline,
+        BookDocInline,
+    )
     list_display = (
         "title",
         "get_authors",
         "get_publisher",
         "publication_year",
-        "number_of_pages"
+        "number_of_pages",
+        "published",
     )
+    autocomplete_fields = ("authors", "publisher")
+    readonly_fields = ("creation_time", "updated_time")
     search_fields = ("title", "publisher__name", "authors__last_name")
     list_filter = ("publisher__name", "authors")
 
+    fieldsets = (
+        (
+            None,
+            {
+                "fields": (
+                    "published",
+                    "title",
+                    "authors",
+                    "publisher",
+                    "ISBN",
+                    "language",
+                    "number_of_pages",
+                    "publication_year",
+                    "description",
+                    "purchase_date",
+                    "notes",
+                    "tags",
+                )
+            },
+        ),
+        (
+            "Audit",
+            {
+                "classes": ("collapse",),
+                "fields": (
+                    "creation_time",
+                    "updated_time",
+                ),
+            },
+        ),
+    )
+
     @admin.display(description="Publisher")
     def get_publisher(self, obj):
         return obj.publisher.name
@@ -42,7 +100,10 @@ class BookAdmin(SortableAdminBase, admin.ModelAdmin):
 
 @admin.register(Author)
 class AuthorAdmin(admin.ModelAdmin):
-    search_fields = ("first_name", "last_name",)
+    search_fields = (
+        "first_name",
+        "last_name",
+    )
     list_filter = ("last_name",)
 
 
@@ -50,3 +111,59 @@ class AuthorAdmin(admin.ModelAdmin):
 class PublisherAdmin(admin.ModelAdmin):
     list_display = ("name", "country")
     search_fields = ("name",)
+
+
+@admin.register(Catalog)
+class CatalogAdmin(SortableAdminBase, admin.ModelAdmin):
+    inlines = (
+        BookPropertyInline,
+        BookImageInline,
+        BookDocInline,
+    )
+    list_display = (
+        "__str__",
+        "manufacturer",
+        "years",
+        "get_scales",
+        "published",
+    )
+    autocomplete_fields = ("manufacturer",)
+    readonly_fields = ("creation_time", "updated_time")
+    search_fields = ("manufacturer__name", "years", "scales__scale")
+    list_filter = ("manufacturer__name", "publication_year", "scales__scale")
+
+    fieldsets = (
+        (
+            None,
+            {
+                "fields": (
+                    "published",
+                    "manufacturer",
+                    "years",
+                    "scales",
+                    "ISBN",
+                    "language",
+                    "number_of_pages",
+                    "publication_year",
+                    "description",
+                    "purchase_date",
+                    "notes",
+                    "tags",
+                )
+            },
+        ),
+        (
+            "Audit",
+            {
+                "classes": ("collapse",),
+                "fields": (
+                    "creation_time",
+                    "updated_time",
+                ),
+            },
+        ),
+    )
+
+    @admin.display(description="Scales")
+    def get_scales(self, obj):
+        return "/".join(s.scale for s in obj.scales.all())

ram/bookshelf/migrations/0001_initial.py

@@ -1,6 +1,7 @@
 # Generated by Django 4.2.5 on 2023-10-01 20:16
 
-import ckeditor_uploader.fields
+# ckeditor removal
+# import ckeditor_uploader.fields
 from django.db import migrations, models
 import django.db.models.deletion
 import uuid
@@ -47,7 +48,8 @@ class Migration(migrations.Migration):
                 ("ISBN", models.CharField(max_length=13, unique=True)),
                 ("publication_year", models.SmallIntegerField(blank=True, null=True)),
                 ("purchase_date", models.DateField(blank=True, null=True)),
-                ("notes", ckeditor_uploader.fields.RichTextUploadingField(blank=True)),
+                # ("notes", ckeditor_uploader.fields.RichTextUploadingField(blank=True)),
+                ("notes", models.TextField(blank=True)),
                 ("creation_time", models.DateTimeField(auto_now_add=True)),
                 ("updated_time", models.DateTimeField(auto_now=True)),
                 ("authors", models.ManyToManyField(to="bookshelf.author")),

ram/bookshelf/migrations/0009_alter_bookimage_image.py

@@ -0,0 +1,51 @@
+# Generated by Django 4.2.6 on 2023-10-30 13:16
+
+import os
+import sys
+import shutil
+import ram.utils
+import bookshelf.models
+
+from django.db import migrations, models
+from django.conf import settings
+
+
+def move_images(apps, schema_editor):
+    sys.stdout.write("\n  Processing files. Please await...")
+    for r in bookshelf.models.BaseBookImage.objects.all():
+        fname = os.path.basename(r.image.path)
+        new_image = bookshelf.models.book_image_upload(r, fname)
+        new_path = os.path.join(settings.MEDIA_ROOT, new_image)
+        os.makedirs(os.path.dirname(new_path), exist_ok=True)
+        try:
+            shutil.move(r.image.path, new_path)
+        except FileNotFoundError:
+            sys.stderr.write("  !! FileNotFoundError: {}\n".format(new_image))
+            pass
+        r.image.name = new_image
+        r.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("bookshelf", "0008_alter_author_options_alter_publisher_options"),
+    ]
+
+    # Migration is stale and shouldn't be used since model hes been heavily
+    # modified since then. Leaving it here for reference.
+    operations = [
+        #     migrations.AlterField(
+        #         model_name="bookimage",
+        #         name="image",
+        #         field=models.ImageField(
+        #             blank=True,
+        #             null=True,
+        #             storage=ram.utils.DeduplicatedStorage,
+        #             upload_to=bookshelf.models.book_image_upload,
+        #         ),
+        #     ),
+        #     migrations.RunPython(
+        #         move_images,
+        #         reverse_code=migrations.RunPython.noop
+        #     ),
+    ]

ram/bookshelf/migrations/0010_alter_bookimage_image.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2.6 on 2023-11-04 22:53
+
+import bookshelf.models
+from django.db import migrations, models
+import ram.utils
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("bookshelf", "0009_alter_bookimage_image"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="bookimage",
+            name="image",
+            field=models.ImageField(
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to=bookshelf.models.book_image_upload,
+            ),
+        ),
+    ]

ram/bookshelf/migrations/0011_alter_book_language.py

@@ -0,0 +1,121 @@
+# Generated by Django 5.0.1 on 2024-01-20 21:02
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("bookshelf", "0010_alter_bookimage_image"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="book",
+            name="language",
+            field=models.CharField(
+                choices=[
+                    ("af", "Afrikaans"),
+                    ("ar", "Arabic"),
+                    ("ar-dz", "Algerian Arabic"),
+                    ("ast", "Asturian"),
+                    ("az", "Azerbaijani"),
+                    ("bg", "Bulgarian"),
+                    ("be", "Belarusian"),
+                    ("bn", "Bengali"),
+                    ("br", "Breton"),
+                    ("bs", "Bosnian"),
+                    ("ca", "Catalan"),
+                    ("ckb", "Central Kurdish (Sorani)"),
+                    ("cs", "Czech"),
+                    ("cy", "Welsh"),
+                    ("da", "Danish"),
+                    ("de", "German"),
+                    ("dsb", "Lower Sorbian"),
+                    ("el", "Greek"),
+                    ("en", "English"),
+                    ("en-au", "Australian English"),
+                    ("en-gb", "British English"),
+                    ("eo", "Esperanto"),
+                    ("es", "Spanish"),
+                    ("es-ar", "Argentinian Spanish"),
+                    ("es-co", "Colombian Spanish"),
+                    ("es-mx", "Mexican Spanish"),
+                    ("es-ni", "Nicaraguan Spanish"),
+                    ("es-ve", "Venezuelan Spanish"),
+                    ("et", "Estonian"),
+                    ("eu", "Basque"),
+                    ("fa", "Persian"),
+                    ("fi", "Finnish"),
+                    ("fr", "French"),
+                    ("fy", "Frisian"),
+                    ("ga", "Irish"),
+                    ("gd", "Scottish Gaelic"),
+                    ("gl", "Galician"),
+                    ("he", "Hebrew"),
+                    ("hi", "Hindi"),
+                    ("hr", "Croatian"),
+                    ("hsb", "Upper Sorbian"),
+                    ("hu", "Hungarian"),
+                    ("hy", "Armenian"),
+                    ("ia", "Interlingua"),
+                    ("id", "Indonesian"),
+                    ("ig", "Igbo"),
+                    ("io", "Ido"),
+                    ("is", "Icelandic"),
+                    ("it", "Italian"),
+                    ("ja", "Japanese"),
+                    ("ka", "Georgian"),
+                    ("kab", "Kabyle"),
+                    ("kk", "Kazakh"),
+                    ("km", "Khmer"),
+                    ("kn", "Kannada"),
+                    ("ko", "Korean"),
+                    ("ky", "Kyrgyz"),
+                    ("lb", "Luxembourgish"),
+                    ("lt", "Lithuanian"),
+                    ("lv", "Latvian"),
+                    ("mk", "Macedonian"),
+                    ("ml", "Malayalam"),
+                    ("mn", "Mongolian"),
+                    ("mr", "Marathi"),
+                    ("ms", "Malay"),
+                    ("my", "Burmese"),
+                    ("nb", "Norwegian Bokmål"),
+                    ("ne", "Nepali"),
+                    ("nl", "Dutch"),
+                    ("nn", "Norwegian Nynorsk"),
+                    ("os", "Ossetic"),
+                    ("pa", "Punjabi"),
+                    ("pl", "Polish"),
+                    ("pt", "Portuguese"),
+                    ("pt-br", "Brazilian Portuguese"),
+                    ("ro", "Romanian"),
+                    ("ru", "Russian"),
+                    ("sk", "Slovak"),
+                    ("sl", "Slovenian"),
+                    ("sq", "Albanian"),
+                    ("sr", "Serbian"),
+                    ("sr-latn", "Serbian Latin"),
+                    ("sv", "Swedish"),
+                    ("sw", "Swahili"),
+                    ("ta", "Tamil"),
+                    ("te", "Telugu"),
+                    ("tg", "Tajik"),
+                    ("th", "Thai"),
+                    ("tk", "Turkmen"),
+                    ("tr", "Turkish"),
+                    ("tt", "Tatar"),
+                    ("udm", "Udmurt"),
+                    ("ug", "Uyghur"),
+                    ("uk", "Ukrainian"),
+                    ("ur", "Urdu"),
+                    ("uz", "Uzbek"),
+                    ("vi", "Vietnamese"),
+                    ("zh-hans", "Simplified Chinese"),
+                    ("zh-hant", "Traditional Chinese"),
+                ],
+                default="en",
+                max_length=7,
+            ),
+        ),
+    ]

ram/bookshelf/migrations/0012_alter_book_notes.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2024-02-17 12:19
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0011_alter_book_language"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="book",
+            name="notes",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]

ram/bookshelf/migrations/0013_book_description.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2024-03-02 14:31
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0012_alter_book_notes"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="book",
+            name="description",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]

ram/bookshelf/migrations/0014_book_published.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2024-11-04 13:27
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0013_book_description"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="book",
+            name="published",
+            field=models.BooleanField(default=True),
+        ),
+    ]

ram/bookshelf/migrations/0015_alter_book_authors.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2024-11-26 22:21
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0014_book_published"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="book",
+            name="authors",
+            field=models.ManyToManyField(blank=True, to="bookshelf.author"),
+        ),
+    ]

ram/bookshelf/migrations/0016_basebook_book_catalogue.py

@@ -0,0 +1,141 @@
+# Generated by Django 5.1.2 on 2024-11-27 16:35
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+def basebook_to_book(apps, schema_editor):
+    basebook = apps.get_model("bookshelf", "BaseBook")
+    book = apps.get_model("bookshelf", "Book")
+    for row in basebook.objects.all():
+        b = book.objects.create(
+            basebook_ptr=row,
+            title=row.old_title,
+            publisher=row.old_publisher,
+        )
+        b.authors.set(row.old_authors.all())
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0015_alter_book_authors"),
+        ("metadata", "0019_alter_scale_gauge"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="Book",
+            options={"ordering": ["creation_time"]},
+        ),
+        migrations.RenameModel(
+            old_name="BookImage",
+            new_name="BaseBookImage",
+        ),
+        migrations.RenameModel(
+            old_name="BookProperty",
+            new_name="BaseBookProperty",
+        ),
+        migrations.RenameModel(
+            old_name="Book",
+            new_name="BaseBook",
+        ),
+        migrations.RenameField(
+            model_name="basebook",
+            old_name="title",
+            new_name="old_title",
+        ),
+        migrations.RenameField(
+            model_name="basebook",
+            old_name="authors",
+            new_name="old_authors",
+        ),
+        migrations.RenameField(
+            model_name="basebook",
+            old_name="publisher",
+            new_name="old_publisher",
+        ),
+        migrations.AlterModelOptions(
+            name="basebookimage",
+            options={"ordering": ["order"], "verbose_name_plural": "Images"},
+        ),
+        migrations.CreateModel(
+            name="Book",
+            fields=[
+                (
+                    "basebook_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="bookshelf.basebook",
+                    ),
+                ),
+                ("title", models.CharField(max_length=200)),
+                (
+                    "authors",
+                    models.ManyToManyField(
+                        blank=True,
+                        to="bookshelf.author"
+                    ),
+                ),
+                (
+                    "publisher",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="bookshelf.publisher"
+                    ),
+                 ),
+            ],
+            options={
+                "ordering": ["title"],
+            },
+        ),
+        migrations.RunPython(
+            basebook_to_book,
+            reverse_code=migrations.RunPython.noop
+        ),
+        migrations.RemoveField(
+            model_name="basebook",
+            name="old_title",
+        ),
+        migrations.RemoveField(
+            model_name="basebook",
+            name="old_authors",
+        ),
+        migrations.RemoveField(
+            model_name="basebook",
+            name="old_publisher",
+        ),
+        migrations.CreateModel(
+            name="Catalog",
+            fields=[
+                (
+                    "basebook_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="bookshelf.basebook",
+                    ),
+                ),
+                ("years", models.CharField(max_length=12)),
+                (
+                    "manufacturer",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="metadata.manufacturer",
+                    ),
+                ),
+                ("scales", models.ManyToManyField(to="metadata.scale")),
+            ],
+            options={
+                "ordering": ["manufacturer", "publication_year"],
+            },
+            bases=("bookshelf.basebook",),
+        ),
+    ]

ram/bookshelf/migrations/0017_alter_basebook_options_basebookdocument.py

@@ -0,0 +1,52 @@
+# Generated by Django 5.1.2 on 2024-12-22 20:38
+
+import django.db.models.deletion
+import ram.utils
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0016_basebook_book_catalogue"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="basebook",
+            options={},
+        ),
+        migrations.CreateModel(
+            name="BaseBookDocument",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("description", models.CharField(blank=True, max_length=128)),
+                (
+                    "file",
+                    models.FileField(
+                        storage=ram.utils.DeduplicatedStorage(), upload_to="files/"
+                    ),
+                ),
+                ("private", models.BooleanField(default=False)),
+                (
+                    "book",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="document",
+                        to="bookshelf.basebook",
+                    ),
+                ),
+            ],
+            options={
+                "unique_together": {("book", "file")},
+            },
+        ),
+    ]

ram/bookshelf/migrations/0018_alter_basebookdocument_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.1.4 on 2024-12-22 20:44
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("bookshelf", "0017_alter_basebook_options_basebookdocument"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="basebookdocument",
+            options={"verbose_name_plural": "Documents"},
+        ),
+    ]

ram/bookshelf/models.py

@@ -1,14 +1,16 @@
-from uuid import uuid4
+import os
+import shutil
 from django.db import models
 from django.conf import settings
 from django.urls import reverse
 from django_countries.fields import CountryField
 
-from ckeditor_uploader.fields import RichTextUploadingField
+from tinymce import models as tinymce
 
 from metadata.models import Tag
 from ram.utils import DeduplicatedStorage
-from ram.models import Image, PropertyInstance
+from ram.models import BaseModel, Image, Document, PropertyInstance
+from metadata.models import Scale, Manufacturer
 
 
 class Publisher(models.Model):
@@ -37,11 +39,7 @@ class Author(models.Model):
         return f"{self.last_name} {self.first_name[0]}."
 
 
-class Book(models.Model):
-    uuid = models.UUIDField(primary_key=True, default=uuid4, editable=False)
-    title = models.CharField(max_length=200)
-    authors = models.ManyToManyField(Author)
-    publisher = models.ForeignKey(Publisher, on_delete=models.CASCADE)
+class BaseBook(BaseModel):
     ISBN = models.CharField(max_length=17, blank=True)  # 13 + dashes
     language = models.CharField(
         max_length=7,
@@ -50,13 +48,65 @@ class Book(models.Model):
     )
     number_of_pages = models.SmallIntegerField(null=True, blank=True)
     publication_year = models.SmallIntegerField(null=True, blank=True)
+    description = tinymce.HTMLField(blank=True)
     purchase_date = models.DateField(null=True, blank=True)
     tags = models.ManyToManyField(
         Tag, related_name="bookshelf", blank=True
     )
-    notes = RichTextUploadingField(blank=True)
-    creation_time = models.DateTimeField(auto_now_add=True)
-    updated_time = models.DateTimeField(auto_now=True)
+
+    def delete(self, *args, **kwargs):
+        shutil.rmtree(
+            os.path.join(
+                settings.MEDIA_ROOT, "images", "books", str(self.uuid)
+            ),
+            ignore_errors=True
+        )
+        super(BaseBook, self).delete(*args, **kwargs)
+
+
+def book_image_upload(instance, filename):
+    return os.path.join(
+        "images",
+        "books",
+        str(instance.book.uuid),
+        filename
+    )
+
+
+class BaseBookImage(Image):
+    book = models.ForeignKey(
+        BaseBook, on_delete=models.CASCADE, related_name="image"
+    )
+    image = models.ImageField(
+        upload_to=book_image_upload,
+        storage=DeduplicatedStorage,
+    )
+
+
+class BaseBookDocument(Document):
+    book = models.ForeignKey(
+        BaseBook, on_delete=models.CASCADE, related_name="document"
+    )
+
+    class Meta:
+        verbose_name_plural = "Documents"
+        unique_together = ("book", "file")
+
+
+class BaseBookProperty(PropertyInstance):
+    book = models.ForeignKey(
+        BaseBook,
+        on_delete=models.CASCADE,
+        null=False,
+        blank=False,
+        related_name="property",
+    )
+
+
+class Book(BaseBook):
+    title = models.CharField(max_length=200)
+    authors = models.ManyToManyField(Author, blank=True)
+    publisher = models.ForeignKey(Publisher, on_delete=models.CASCADE)
 
     class Meta:
         ordering = ["title"]
@@ -68,26 +118,33 @@ class Book(models.Model):
         return self.publisher.name
 
     def get_absolute_url(self):
-        return reverse("book", kwargs={"uuid": self.uuid})
+        return reverse(
+            "bookshelf_item",
+            kwargs={"selector": "book", "uuid": self.uuid}
+        )
 
 
-class BookImage(Image):
-    book = models.ForeignKey(
-        Book, on_delete=models.CASCADE, related_name="image"
-    )
-    image = models.ImageField(
-        upload_to="images/books/",  # FIXME, find a better way to replace this
-        storage=DeduplicatedStorage,
-        null=True,
-        blank=True
-    )
-
-
-class BookProperty(PropertyInstance):
-    book = models.ForeignKey(
-        Book,
+class Catalog(BaseBook):
+    manufacturer = models.ForeignKey(
+        Manufacturer,
         on_delete=models.CASCADE,
-        null=False,
-        blank=False,
-        related_name="property",
     )
+    years = models.CharField(max_length=12)
+    scales = models.ManyToManyField(Scale)
+
+    class Meta:
+        ordering = ["manufacturer", "publication_year"]
+
+    def __str__(self):
+        scales = self.get_scales
+        return "%s %s %s" % (self.manufacturer.name, self.years, scales)
+
+    def get_absolute_url(self):
+        return reverse(
+            "bookshelf_item",
+            kwargs={"selector": "catalog", "uuid": self.uuid}
+        )
+
+    @property
+    def get_scales(self):
+        return "/".join([s.scale for s in self.scales.all()])

ram/bookshelf/urls.py

@@ -3,5 +3,5 @@ from bookshelf.views import BookList, BookGet
 
 urlpatterns = [
     path("book/list", BookList.as_view()),
-    path("book/get/<str:uuid>", BookGet.as_view()),
+    path("book/get/<uuid:uuid>", BookGet.as_view()),
 ]

ram/bookshelf/views.py

@@ -6,13 +6,16 @@ from bookshelf.serializers import BookSerializer
 
 
 class BookList(ListAPIView):
-    queryset = Book.objects.all()
     serializer_class = BookSerializer
 
+    def get_queryset(self):
+        return Book.objects.get_published(self.request.user)
+
 
 class BookGet(RetrieveAPIView):
-    queryset = Book.objects.all()
     serializer_class = BookSerializer
     lookup_field = "uuid"
-
     schema = AutoSchema(operation_id_base="retrieveBookByUUID")
+
+    def get_queryset(self):
+        return Book.objects.get_published(self.request.user)

ram/consist/admin.py

@@ -8,7 +8,8 @@ class ConsistItemInline(SortableInlineAdminMixin, admin.TabularInline):
     model = ConsistItem
     min_num = 1
     extra = 0
-    readonly_fields = ("address", "type", "company", "era")
+    autocomplete_fields = ("rolling_stock",)
+    readonly_fields = ("preview", "published", "address", "type", "company", "era")
 
 
 @admin.register(Consist)
@@ -18,7 +19,7 @@ class ConsistAdmin(SortableAdminBase, admin.ModelAdmin):
         "creation_time",
         "updated_time",
     )
-    list_display = ("identifier", "company", "era")
+    list_display = ("identifier", "published", "company", "era")
     list_filter = list_display
     search_fields = list_display
     save_as = True
@@ -28,6 +29,7 @@ class ConsistAdmin(SortableAdminBase, admin.ModelAdmin):
             None,
             {
                 "fields": (
+                    "published",
                     "identifier",
                     "consist_address",
                     "company",

ram/consist/migrations/0005_alter_consist_notes.py

@@ -1,6 +1,7 @@
 # Generated by Django 4.1 on 2022-08-23 15:54
 
-import ckeditor_uploader.fields
+# ckeditor removal
+# import ckeditor_uploader.fields
 from django.db import migrations
 
 
@@ -11,9 +12,9 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
-        migrations.AlterField(
-            model_name="consist",
-            name="notes",
-            field=ckeditor_uploader.fields.RichTextUploadingField(blank=True),
-        ),
+        # migrations.AlterField(
+        #     model_name="consist",
+        #     name="notes",
+        #     field=ckeditor_uploader.fields.RichTextUploadingField(blank=True),
+        # ),
     ]

ram/consist/migrations/0009_alter_consist_image.py

@@ -0,0 +1,51 @@
+# Generated by Django 4.2.6 on 2023-10-31 09:41
+
+import os
+import sys
+import shutil
+import ram.utils
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+def move_images(apps, schema_editor):
+    sys.stdout.write("\n  Processing files. Please await...")
+    model = apps.get_model("consist", "Consist")
+    for r in model.objects.all():
+        if not r.image:  # exit the loop if there's no image
+            continue
+        fname = os.path.basename(r.image.path)
+        new_image = os.path.join("images", "consists", fname)
+        new_path = os.path.join(settings.MEDIA_ROOT, new_image)
+        os.makedirs(os.path.dirname(new_path), exist_ok=True)
+        try:
+            shutil.move(r.image.path, new_path)
+        except FileNotFoundError:
+            sys.stderr.write("  !! FileNotFoundError: {}\n".format(new_image))
+            pass
+        r.image.name = new_image
+        r.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("consist", "0008_alter_consist_options"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="consist",
+            name="image",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to="images/consists",
+            ),
+        ),
+        migrations.RunPython(
+            move_images,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

ram/consist/migrations/0010_alter_consist_notes.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2024-02-17 12:19
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("consist", "0009_alter_consist_image"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="consist",
+            name="notes",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]

ram/consist/migrations/0011_alter_consist_consist_address_alter_consist_era.py

@@ -0,0 +1,30 @@
+# Generated by Django 5.0.4 on 2024-04-20 12:49
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("consist", "0010_alter_consist_notes"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="consist",
+            name="consist_address",
+            field=models.SmallIntegerField(
+                blank=True,
+                default=None,
+                help_text="DCC consist address if enabled",
+                null=True,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="consist",
+            name="era",
+            field=models.CharField(
+                blank=True, help_text="Era or epoch of the consist", max_length=32
+            ),
+        ),
+    ]

ram/consist/migrations/0012_consist_published.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2024-11-04 12:37
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("consist", "0011_alter_consist_consist_address_alter_consist_era"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="consist",
+            name="published",
+            field=models.BooleanField(default=True),
+        ),
+    ]

ram/consist/models.py

@@ -1,29 +1,37 @@
-from uuid import uuid4
+import os
+
 from django.db import models
 from django.urls import reverse
+from django.dispatch import receiver
+from django.core.exceptions import ValidationError
 
-from ckeditor_uploader.fields import RichTextUploadingField
-
+from ram.models import BaseModel
 from ram.utils import DeduplicatedStorage
 from metadata.models import Company, Tag
 from roster.models import RollingStock
 
 
-class Consist(models.Model):
-    uuid = models.UUIDField(primary_key=True, default=uuid4, editable=False)
+class Consist(BaseModel):
     identifier = models.CharField(max_length=128, unique=False)
     tags = models.ManyToManyField(Tag, related_name="consist", blank=True)
     consist_address = models.SmallIntegerField(
-        default=None, null=True, blank=True
+        default=None,
+        null=True,
+        blank=True,
+        help_text="DCC consist address if enabled",
     )
     company = models.ForeignKey(Company, on_delete=models.CASCADE)
-    era = models.CharField(max_length=32, blank=True)
-    image = models.ImageField(
-        upload_to="images/", storage=DeduplicatedStorage, null=True, blank=True
+    era = models.CharField(
+        max_length=32,
+        blank=True,
+        help_text="Era or epoch of the consist",
+    )
+    image = models.ImageField(
+        upload_to=os.path.join("images", "consists"),
+        storage=DeduplicatedStorage,
+        null=True,
+        blank=True,
     )
-    notes = RichTextUploadingField(blank=True)
-    creation_time = models.DateTimeField(auto_now_add=True)
-    updated_time = models.DateTimeField(auto_now=True)
 
     def __str__(self):
         return "{0} {1}".format(self.company, self.identifier)
@@ -31,6 +39,12 @@ class Consist(models.Model):
     def get_absolute_url(self):
         return reverse("consist", kwargs={"uuid": self.uuid})
 
+    def clean(self):
+        if self.consist_item.filter(rolling_stock__published=False).exists():
+            raise ValidationError(
+                "You must publish all items in the consist before publishing the consist."  # noqa: E501
+            )
+
     class Meta:
         ordering = ["company", "-creation_time"]
 
@@ -48,6 +62,13 @@ class ConsistItem(models.Model):
     def __str__(self):
         return "{0}".format(self.rolling_stock)
 
+    def published(self):
+        return self.rolling_stock.published
+    published.boolean = True
+
+    def preview(self):
+        return self.rolling_stock.image.first().image_thumbnail(100)
+
     def type(self):
         return self.rolling_stock.rolling_class.type
 
@@ -59,3 +80,14 @@ class ConsistItem(models.Model):
 
     def era(self):
         return self.rolling_stock.era
+
+
+# Unpublish any consist that contains an unpublished rolling stock
+# this signal is called after a rolling stock is saved
+# it is hosted here to avoid circular imports
+@receiver(models.signals.post_save, sender=RollingStock)
+def post_save_unpublish_consist(sender, instance, *args, **kwargs):
+    consists = Consist.objects.filter(consist_item__rolling_stock=instance)
+    for consist in consists:
+        consist.published = False
+        consist.save()

ram/consist/views.py

@@ -5,11 +5,15 @@ from consist.serializers import ConsistSerializer
 
 
 class ConsistList(ListAPIView):
-    queryset = Consist.objects.all()
     serializer_class = ConsistSerializer
 
+    def get_queryset(self):
+        return Consist.objects.get_published(self.request.user)
+
 
 class ConsistGet(RetrieveAPIView):
-    queryset = Consist.objects.all()
     serializer_class = ConsistSerializer
     lookup_field = "uuid"
+
+    def get_queryset(self):
+        return Consist.objects.get_published(self.request.user)

ram/metadata/migrations/0015_alter_company_logo_alter_decoder_image_and_more.py

@@ -0,0 +1,80 @@
+# Generated by Django 4.2.6 on 2023-10-30 13:16
+
+import os
+import sys
+import shutil
+import ram.utils
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+def move_images(apps, schema_editor):
+    fields = {
+        "Company": ["companies", "logo"],
+        "Decoder": ["decoders", "image"],
+        "Manufacturer": ["manufacturers", "logo"],
+    }
+    sys.stdout.write("\n  Processing files. Please await...")
+    for m in fields.items():
+        model = apps.get_model("metadata", m[0])
+        for r in model.objects.all():
+            field = getattr(r, m[1][1])
+            if not field:  # exit the loop if there's no image
+                continue
+            fname = os.path.basename(field.path)
+            new_image = os.path.join("images", m[1][0], fname)
+            new_path = os.path.join(settings.MEDIA_ROOT, new_image)
+            os.makedirs(os.path.dirname(new_path), exist_ok=True)
+            try:
+                shutil.move(field.path, new_path)
+            except FileNotFoundError:
+                sys.stderr.write(
+                    "  !! FileNotFoundError: {}\n".format(new_image)
+                )
+                pass
+            field.name = new_image
+            r.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("metadata", "0014_alter_decoder_options_alter_tag_options"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="company",
+            name="logo",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to="images/companies",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="decoder",
+            name="image",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to="images/decoders",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="manufacturer",
+            name="logo",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to="images/manufacturers",
+            ),
+        ),
+        migrations.RunPython(
+            move_images,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

ram/metadata/migrations/0016_alter_decoderdocument_file.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.6 on 2023-11-04 22:53
+
+from django.db import migrations, models
+import ram.utils
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("metadata", "0015_alter_company_logo_alter_decoder_image_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="decoderdocument",
+            name="file",
+            field=models.FileField(
+                storage=ram.utils.DeduplicatedStorage(), upload_to="files/"
+            ),
+        ),
+    ]

ram/metadata/migrations/0017_alter_property_private.py

@@ -0,0 +1,20 @@
+# Generated by Django 5.0.4 on 2024-04-20 12:49
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("metadata", "0016_alter_decoderdocument_file"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="property",
+            name="private",
+            field=models.BooleanField(
+                default=False, help_text="Property will be only visible to logged users"
+            ),
+        ),
+    ]

ram/metadata/migrations/0018_alter_decoder_options_alter_scale_options_and_more.py

@@ -0,0 +1,69 @@
+# Generated by Django 5.1.2 on 2024-11-04 21:17
+
+import django.db.migrations.operations.special
+import metadata.models
+from django.db import migrations, models
+
+
+def gen_ratio(apps, schema_editor):
+    Scale = apps.get_model('metadata', 'Scale')
+    for row in Scale.objects.all():
+        row.ratio_int = metadata.models.calculate_ratio(row.ratio)
+        row.save(update_fields=['ratio_int'])
+
+
+def convert_tarcks(apps, schema_editor):
+    Scale = apps.get_model("metadata", "Scale")
+    for row in Scale.objects.all():
+        row.tracks = "".join(
+            filter(
+                lambda x: str.isdigit(x) or x == "." or x == ",",
+                row.tracks
+            )
+        )
+        row.save(update_fields=["tracks"])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('metadata', '0017_alter_property_private'),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name='decoder',
+            options={'ordering': ['manufacturer__name', 'name']},
+        ),
+        migrations.AlterModelOptions(
+            name='scale',
+            options={'ordering': ['ratio_int', 'scale']},
+        ),
+        migrations.AddField(
+            model_name='scale',
+            name='ratio_int',
+            field=models.SmallIntegerField(default=0, editable=False),
+        ),
+        migrations.RunPython(
+            code=gen_ratio,
+            reverse_code=django.db.migrations.operations.special.RunPython.noop,
+        ),
+        migrations.AlterField(
+            model_name='scale',
+            name='ratio',
+            field=models.CharField(max_length=16, validators=[metadata.models.calculate_ratio]),
+        ),
+        migrations.AlterModelOptions(
+            name='scale',
+            options={'ordering': ['-ratio_int', '-tracks', 'scale']},
+        ),
+        migrations.RunPython(
+            code=convert_tarcks,
+            reverse_code=django.db.migrations.operations.special.RunPython.noop,
+        ),
+        migrations.AlterField(
+            model_name='scale',
+            name='tracks',
+            field=models.FloatField(help_text='Distance between model tracks in mm'),
+        ),
+    ]

ram/metadata/migrations/0019_alter_scale_gauge.py

@@ -0,0 +1,22 @@
+# Generated by Django 5.1.2 on 2024-11-04 21:32
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("metadata", "0018_alter_decoder_options_alter_scale_options_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="scale",
+            name="gauge",
+            field=models.CharField(
+                blank=True,
+                help_text="Distance between real tracks. Please specify the unit (mm, in, ...)",
+                max_length=16,
+            ),
+        ),
+    ]

ram/metadata/models.py

@@ -1,16 +1,22 @@
+import os
 from django.db import models
 from django.urls import reverse
 from django.conf import settings
 from django.dispatch.dispatcher import receiver
+from django.core.exceptions import ValidationError
 from django_countries.fields import CountryField
 
 from ram.models import Document
 from ram.utils import DeduplicatedStorage, get_image_preview, slugify
+from ram.managers import PublicManager
 
 
 class Property(models.Model):
     name = models.CharField(max_length=128, unique=True)
-    private = models.BooleanField(default=False)
+    private = models.BooleanField(
+        default=False,
+        help_text="Property will be only visible to logged users",
+    )
 
     class Meta:
         verbose_name_plural = "Properties"
@@ -19,6 +25,8 @@ class Property(models.Model):
     def __str__(self):
         return self.name
 
+    objects = PublicManager()
+
 
 class Manufacturer(models.Model):
     name = models.CharField(max_length=128, unique=True)
@@ -28,7 +36,10 @@ class Manufacturer(models.Model):
     )
     website = models.URLField(blank=True)
     logo = models.ImageField(
-        upload_to="images/", storage=DeduplicatedStorage, null=True, blank=True
+        upload_to=os.path.join("images", "manufacturers"),
+        storage=DeduplicatedStorage,
+        null=True,
+        blank=True,
     )
 
     class Meta:
@@ -39,10 +50,11 @@ class Manufacturer(models.Model):
 
     def get_absolute_url(self):
         return reverse(
-            "filtered", kwargs={
+            "filtered",
+            kwargs={
                 "_filter": "manufacturer",
                 "search": self.slug,
-            }
+            },
         )
 
     def logo_thumbnail(self):
@@ -58,7 +70,10 @@ class Company(models.Model):
     country = CountryField()
     freelance = models.BooleanField(default=False)
     logo = models.ImageField(
-        upload_to="images/", storage=DeduplicatedStorage, null=True, blank=True
+        upload_to=os.path.join("images", "companies"),
+        storage=DeduplicatedStorage,
+        null=True,
+        blank=True,
     )
 
     class Meta:
@@ -70,10 +85,11 @@ class Company(models.Model):
 
     def get_absolute_url(self):
         return reverse(
-            "filtered", kwargs={
+            "filtered",
+            kwargs={
                 "_filter": "company",
                 "search": self.slug,
-            }
+            },
         )
 
     def extended_name_pp(self):
@@ -95,11 +111,14 @@ class Decoder(models.Model):
     version = models.CharField(max_length=64, blank=True)
     sound = models.BooleanField(default=False)
     image = models.ImageField(
-        upload_to="images/", storage=DeduplicatedStorage, null=True, blank=True
+        upload_to=os.path.join("images", "decoders"),
+        storage=DeduplicatedStorage,
+        null=True,
+        blank=True,
     )
 
     class Meta(object):
-        ordering = ["manufacturer", "name"]
+        ordering = ["manufacturer__name", "name"]
 
     def __str__(self):
         return "{0} - {1}".format(self.manufacturer, self.name)
@@ -119,28 +138,49 @@ class DecoderDocument(Document):
         unique_together = ("decoder", "file")
 
 
+def calculate_ratio(ratio):
+    try:
+        num, den = ratio.split(":")
+        return int(num) / float(den) * 10000
+    except (ValueError, ZeroDivisionError):
+        raise ValidationError("Invalid ratio format")
+
+
 class Scale(models.Model):
     scale = models.CharField(max_length=32, unique=True)
     slug = models.CharField(max_length=32, unique=True, editable=False)
-    ratio = models.CharField(max_length=16, blank=True)
-    gauge = models.CharField(max_length=16, blank=True)
-    tracks = models.CharField(max_length=16, blank=True)
+    ratio = models.CharField(max_length=16, validators=[calculate_ratio])
+    ratio_int = models.SmallIntegerField(editable=False, default=0)
+    tracks = models.FloatField(
+        help_text="Distance between model tracks in mm",
+    )
+    gauge = models.CharField(
+        max_length=16,
+        blank=True,
+        help_text="Distance between real tracks. Please specify the unit (mm, in, ...)",  # noqa: E501
+    )
 
     class Meta:
-        ordering = ["scale"]
+        ordering = ["-ratio_int", "-tracks", "scale"]
 
     def get_absolute_url(self):
         return reverse(
-            "filtered", kwargs={
+            "filtered",
+            kwargs={
                 "_filter": "scale",
                 "search": self.slug,
-            }
+            },
         )
 
     def __str__(self):
         return str(self.scale)
 
 
+@receiver(models.signals.pre_save, sender=Scale)
+def scale_save(sender, instance, **kwargs):
+    instance.ratio_int = calculate_ratio(instance.ratio)
+
+
 class RollingStockType(models.Model):
     type = models.CharField(max_length=64)
     order = models.PositiveSmallIntegerField()
@@ -155,10 +195,11 @@ class RollingStockType(models.Model):
 
     def get_absolute_url(self):
         return reverse(
-            "filtered", kwargs={
+            "filtered",
+            kwargs={
                 "_filter": "type",
                 "search": self.slug,
-            }
+            },
         )
 
     def __str__(self):
@@ -177,10 +218,11 @@ class Tag(models.Model):
 
     def get_absolute_url(self):
         return reverse(
-            "filtered", kwargs={
+            "filtered",
+            kwargs={
                 "_filter": "tag",
                 "search": self.slug,
-            }
+            },
         )
 
 

ram/portal/admin.py

@@ -6,6 +6,7 @@ from portal.models import SiteConfiguration, Flatpage
 
 @admin.register(SiteConfiguration)
 class SiteConfigurationAdmin(SingletonModelAdmin):
+    readonly_fields = ("site_name",)
     fieldsets = (
         (
             None,

ram/portal/migrations/0011_alter_flatpage_content_alter_siteconfiguration_about_and_more.py

@@ -1,7 +1,8 @@
 # Generated by Django 4.1 on 2022-08-23 15:54
 
-import ckeditor.fields
-import ckeditor_uploader.fields
+# ckeditor dependency removal
+# import ckeditor.fields
+# import ckeditor_uploader.fields
 from django.db import migrations
 
 
@@ -12,24 +13,24 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
-        migrations.AlterField(
-            model_name="flatpage",
-            name="content",
-            field=ckeditor_uploader.fields.RichTextUploadingField(),
-        ),
-        migrations.AlterField(
-            model_name="siteconfiguration",
-            name="about",
-            field=ckeditor.fields.RichTextField(blank=True),
-        ),
-        migrations.AlterField(
-            model_name="siteconfiguration",
-            name="footer",
-            field=ckeditor.fields.RichTextField(blank=True),
-        ),
-        migrations.AlterField(
-            model_name="siteconfiguration",
-            name="footer_extended",
-            field=ckeditor.fields.RichTextField(blank=True),
-        ),
+#         migrations.AlterField(
+#             model_name="flatpage",
+#             name="content",
+#             field=ckeditor_uploader.fields.RichTextUploadingField(),
+#         ),
+#         migrations.AlterField(
+#             model_name="siteconfiguration",
+#             name="about",
+#             field=ckeditor.fields.RichTextField(blank=True),
+#         ),
+#         migrations.AlterField(
+#             model_name="siteconfiguration",
+#             name="footer",
+#             field=ckeditor.fields.RichTextField(blank=True),
+#         ),
+#         migrations.AlterField(
+#             model_name="siteconfiguration",
+#             name="footer_extended",
+#             field=ckeditor.fields.RichTextField(blank=True),
+#         ),
     ]

ram/portal/migrations/0016_remove_siteconfiguration_site_name.py

@@ -0,0 +1,16 @@
+# Generated by Django 5.0.1 on 2024-01-20 21:02
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("portal", "0015_siteconfiguration_use_cdn"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="siteconfiguration",
+            name="site_name",
+        ),
+    ]

ram/portal/migrations/0017_alter_flatpage_content_alter_siteconfiguration_about_and_more.py

@@ -0,0 +1,34 @@
+# Generated by Django 5.0.2 on 2024-02-17 12:19
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("portal", "0016_remove_siteconfiguration_site_name"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="flatpage",
+            name="content",
+            field=tinymce.models.HTMLField(),
+        ),
+        migrations.AlterField(
+            model_name="siteconfiguration",
+            name="about",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+        migrations.AlterField(
+            model_name="siteconfiguration",
+            name="footer",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+        migrations.AlterField(
+            model_name="siteconfiguration",
+            name="footer_extended",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]

ram/portal/models.py

@@ -1,23 +1,21 @@
 import django
 from django.db import models
+from django.conf import settings
 from django.urls import reverse
 from django.dispatch.dispatcher import receiver
 from django.utils.safestring import mark_safe
 from solo.models import SingletonModel
 
-from ckeditor.fields import RichTextField
-from ckeditor_uploader.fields import RichTextUploadingField
+from tinymce import models as tinymce
 
 from ram import __version__ as app_version
+from ram.managers import PublicManager
 from ram.utils import slugify
 
 
 class SiteConfiguration(SingletonModel):
-    site_name = models.CharField(
-        max_length=256, default="Railroad Assets Manager"
-    )
     site_author = models.CharField(max_length=256, blank=True)
-    about = RichTextField(blank=True)
+    about = tinymce.HTMLField(blank=True)
     items_per_page = models.CharField(
         max_length=2,
         choices=[(str(x * 3), str(x * 3)) for x in range(2, 11)],
@@ -32,8 +30,8 @@ class SiteConfiguration(SingletonModel):
         ],
         default="type",
     )
-    footer = RichTextField(blank=True)
-    footer_extended = RichTextField(blank=True)
+    footer = tinymce.HTMLField(blank=True)
+    footer_extended = tinymce.HTMLField(blank=True)
     show_version = models.BooleanField(default=True)
     use_cdn = models.BooleanField(default=True)
     extra_head = models.TextField(blank=True)
@@ -44,6 +42,9 @@ class SiteConfiguration(SingletonModel):
     def __str__(self):
         return "Site Configuration"
 
+    def site_name(self):
+        return settings.SITE_NAME
+
     def version(self):
         return app_version
 
@@ -55,7 +56,7 @@ class Flatpage(models.Model):
     name = models.CharField(max_length=256, unique=True)
     path = models.CharField(max_length=256, unique=True)
     published = models.BooleanField(default=False)
-    content = RichTextUploadingField()
+    content = tinymce.HTMLField()
     creation_time = models.DateTimeField(auto_now_add=True)
     updated_time = models.DateTimeField(auto_now=True)
 
@@ -72,6 +73,8 @@ class Flatpage(models.Model):
             )
         )
 
+    objects = PublicManager()
+
 
 @receiver(models.signals.pre_save, sender=Flatpage)
 def tag_pre_save(sender, instance, **kwargs):

ram/portal/static/bootstrap-icons@1.11.3/font/bootstrap-icons.css

@@ -1,14 +1,14 @@
 /*!
- * Bootstrap Icons v1.11.1 (https://icons.getbootstrap.com/)
- * Copyright 2019-2023 The Bootstrap Authors
+ * Bootstrap Icons v1.11.3 (https://icons.getbootstrap.com/)
+ * Copyright 2019-2024 The Bootstrap Authors
  * Licensed under MIT (https://github.com/twbs/icons/blob/main/LICENSE)
  */
 
 @font-face {
   font-display: block;
   font-family: "bootstrap-icons";
-  src: url("./fonts/bootstrap-icons.woff2?2820a3852bdb9a5832199cc61cec4e65") format("woff2"),
-url("./fonts/bootstrap-icons.woff?2820a3852bdb9a5832199cc61cec4e65") format("woff");
+  src: url("./fonts/bootstrap-icons.woff2?dd67030699838ea613ee6dbda90effa6") format("woff2"),
+url("./fonts/bootstrap-icons.woff?dd67030699838ea613ee6dbda90effa6") format("woff");
 }
 
 .bi::before,

ram/portal/templates/base.html

@@ -16,11 +16,11 @@
     <link rel="icon" href="{% static "favicon.png" %}" sizes="any">
     <link rel="icon" href="{% static "favicon.svg" %}" type="image/svg+xml">
     {% if site_conf.use_cdn %}
-    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/css/bootstrap.min.css" rel="stylesheet">
-    <link href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.1/font/bootstrap-icons.css" rel="stylesheet">
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css" rel="stylesheet">
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.css" rel="stylesheet">
     {% else %}
-    <link href="{% static "bootstrap@5.3.2/dist/css/bootstrap.min.css" %}" rel="stylesheet">
-    <link href="{% static "bootstrap-icons@1.11.1/font/bootstrap-icons.css" %}" rel="stylesheet">
+    <link href="{% static "bootstrap@5.3.3/dist/css/bootstrap.min.css" %}" rel="stylesheet">
+    <link href="{% static "bootstrap-icons@1.11.3/font/bootstrap-icons.css" %}" rel="stylesheet">
     {% endif %}
     <link href="{% static "css/main.css" %}?v={{ site_conf.version }}" rel="stylesheet">
     <style>
@@ -115,19 +115,19 @@
           })
        })()
     </script>
-	<script>
-	  document.addEventListener('DOMContentLoaded', function () {
-		var selectElement = document.getElementById('tabSelector');
-		selectElement.addEventListener('change', function () {
-		  var selectedTabId = this.value;
-		  var tabs = document.querySelectorAll('.tab-pane');
-		  tabs.forEach(function (tab) {
-			tab.classList.remove('show', 'active');
-		  });
-		  document.getElementById(selectedTabId).classList.add('show', 'active');
-		});
-	  });
-	</script>
+    <script>
+      document.addEventListener('DOMContentLoaded', function () {
+      var selectElement = document.getElementById('tabSelector');
+      selectElement.addEventListener('change', function () {
+        var selectedTabId = this.value;
+        var tabs = document.querySelectorAll('.tab-pane');
+        tabs.forEach(function (tab) {
+        tab.classList.remove('show', 'active');
+        });
+        document.getElementById(selectedTabId).classList.add('show', 'active');
+      });
+      });
+    </script>
     {% block extra_head %}
     {{ site_conf.extra_head | safe }}
     {% endblock %}
@@ -180,13 +180,13 @@
                     <li><a class="dropdown-item" href="{% url 'manufacturers' category='model' %}">Manufacturer</a></li>
                     <li><hr class="dropdown-divider"></li>
                     <li class="ps-2 text-secondary">Prototype</li>
-                    <li><a class="dropdown-item" href="{% url 'types' %}">Type</a></li>
+                    <li><a class="dropdown-item" href="{% url 'rolling_stock_types' %}">Type</a></li>
                     <li><a class="dropdown-item" href="{% url 'companies' %}">Company</a></li>
                     <li><a class="dropdown-item" href="{% url 'manufacturers' category='real' %}">Manufacturer</a></li>
                   </ul>
                 </li>
                 {% show_bookshelf_menu %}
-                {% show_flatpages_menu %}
+                {% show_flatpages_menu user %}
               </ul>
               {% include 'includes/search.html' %}
             </div>
@@ -216,9 +216,9 @@
     </main>
     {% include 'includes/footer.html' %}
     {% if site_conf.use_cdn %}
-    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"></script>
     {% else %}
-    <script src="{% static "bootstrap@5.3.2/dist/js/bootstrap.bundle.min.js" %}"></script>
+    <script src="{% static "bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js" %}"></script>
     {% endif %}
   </body>
 </html>

ram/portal/templates/bookshelf/book.html

@@ -1,4 +1,5 @@
 {% extends 'base.html' %}
+{% load dynamic_url %}
 
         {% block header %}
         {% if book.tags.all %}
@@ -27,11 +28,11 @@
             {% if book.image.count > 1 %}
             <button class="carousel-control-prev" type="button" data-bs-target="#carouselControls" data-bs-slide="prev">
               <span class="carousel-control-prev-icon" aria-hidden="true"></span>
-              <span class="visually-hidden">Previous</span>
+              <span class="visually-hidden"><i class="bi bi-chevron-left"></i></span>
             </button>
             <button class="carousel-control-next" type="button" data-bs-target="#carouselControls" data-bs-slide="next">
               <span class="carousel-control-next-icon" aria-hidden="true"></span>
-              <span class="visually-hidden">Next</span>
+              <span class="visually-hidden"><i class="bi bi-chevron-right"></i></span>
             </button>
             {% endif %}
           </div>
@@ -45,35 +46,53 @@
             <div class="mx-auto">
               <nav class="nav nav-tabs d-none d-lg-flex flex-row mb-2" id="nav-tab" role="tablist">
                 <button class="nav-link active" id="nav-summary-tab" data-bs-toggle="tab" data-bs-target="#nav-summary" type="button" role="tab" aria-controls="nav-summary" aria-selected="true">Summary</button>
+                {% if documents %}<button class="nav-link" id="nav-documents-tab" data-bs-toggle="tab" data-bs-target="#nav-documents" type="button" role="tab" aria-controls="nav-documents" aria-selected="false">Documents</button>{% endif %}
                 {% if book.notes %}<button class="nav-link" id="nav-notes-tab" data-bs-toggle="tab" data-bs-target="#nav-notes" type="button" role="tab" aria-controls="nav-notes" aria-selected="false">Notes</button>{% endif %}
               </nav>
               <select class="form-select d-lg-none mb-2" id="tabSelector" aria-label="Tab selector">
                 <option value="nav-summary" selected>Summary</option>
+                {% if documents %}<option value="nav-documents">Documents</option>{% endif %}
                 {% if book.notes %}<option value="nav-notes">Notes</option>{% endif %}
               </select>
               <div class="tab-content" id="nav-tabContent">
                 <div class="tab-pane show active" id="nav-summary" role="tabpanel" aria-labelledby="nav-summary-tab">
                   <table class="table table-striped">
+                    {{ book.description | safe }}
                     <thead>
                       <tr>
+                      {% if type == "catalog" %}
+                        <th colspan="2" scope="row">Catalog</th>
+                      {% elif type == "book" %}
                         <th colspan="2" scope="row">Book</th>
+                      {% endif %}
                       </tr>
                     </thead>
                     <tbody class="table-group-divider">
+                      {% if type == "catalog" %}
+                      <tr>
+                        <th class="w-33" scope="row">Manufacturer</th>
+                        <td>{{ book.manufacturer }}</td>
+                      </tr>
+                      <tr>
+                        <th class="w-33" scope="row">Scales</th>
+                        <td>{{ book.get_scales }}</td>
+                      </tr>
+                      {% elif type == "book" %}
                       <tr>
                         <th class="w-33" scope="row">Title</th>
                         <td>{{ book.title }}</td>
                       </tr>
                       <tr>
-                        <th scope="row">Authors</th>
-                          <td>
-                            <ul class="mb-0 list-unstyled">{% for a in book.authors.all %}<li>{{ a }}</li>{% endfor %}</ul>
-                          </td>
+                        <th class="w-33" scope="row">Authors</th>
+                        <td>
+                          <ul class="mb-0 list-unstyled">{% for a in book.authors.all %}<li>{{ a }}</li>{% endfor %}</ul>
+                        </td>
                       </tr>
                       <tr>
-                        <th scope="row">Publisher</th>
+                        <th class="w-33" scope="row">Publisher</th>
                         <td>{{ book.publisher }}</td>
                       </tr>
+                      {% endif %}
                       <tr>
                         <th scope="row">ISBN</th>
                         <td>{{ book.ISBN|default:"-" }}</td>
@@ -114,12 +133,30 @@
                   </table>
                   {% endif %}
                 </div>
+                <div class="tab-pane" id="nav-documents" role="tabpanel" aria-labelledby="nav-documents-tab">
+                  <table class="table table-striped">
+                    <thead>
+                      <tr>
+                        <th colspan="3" scope="row">Documents</th>
+                      </tr>
+                    </thead>
+                    <tbody class="table-group-divider">
+                    {% for d in documents.all %}
+                      <tr>
+                        <td class="w-33">{{ d.description }}</td>
+                        <td><a href="{{ d.file.url }}" target="_blank">{{ d.filename }}</a></td>
+                        <td class="text-end">{{ d.file.size | filesizeformat }}</td>
+                      </tr>
+                    {% endfor %}
+                    </tbody>
+                  </table>
+                </div>
                 <div class="tab-pane" id="nav-notes" role="tabpanel" aria-labelledby="nav-notes-tab">
                   {{ book.notes | safe }}
                 </div>
               </div>
               <div class="d-grid gap-2 d-md-flex justify-content-md-end">
-                {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% url 'admin:bookshelf_book_change' book.pk %}">Edit</a>{% endif %}
+                {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% dynamic_admin_url 'bookshelf' type book.pk %}">Edit</a>{% endif %}
               </div>
             </div>
           </div>

ram/portal/templates/bookshelf/bookshelf_menu.html

@@ -4,7 +4,12 @@
                     Bookshelf
                   </a>
                   <ul class="dropdown-menu" aria-labelledby="bookshelfDropdownMenuLink">
+                    {% if books_menu %}
                     <li><a class="dropdown-item" href="{% url 'books' %}">Books</a></li>
+                    {% endif %}
+                    {% if catalogs_menu %}
+                    <li><a class="dropdown-item" href="{% url 'catalogs' %}">Catalogs</a></li>
+                    {% endif %}
                   </ul>
                 </li>
                 {% endif %}

ram/portal/templates/cards.html

@@ -6,7 +6,7 @@
       <div class="row row-cols-1 row-cols-md-2 row-cols-lg-3 g-3">
       {% block cards %}
         {% for d in data %}
-        {% if d.type == "rolling_stock" %}
+        {% if d.type == "roster" %}
         {% include "cards/roster.html" %}
         {% elif d.type == "company" %}
         {% include "cards/company.html" %}
@@ -18,7 +18,7 @@
         {% include "cards/consist.html" %}
         {% elif d.type == "manufacturer" %}
         {% include "cards/manufacturer.html" %}
-        {% elif d.type == "book" %}
+        {% elif d.type == "book" or d.type == "catalog" %}
         {% include "cards/book.html" %}
         {% endif %}
         {% endfor %}

ram/portal/templates/cards/book.html

@@ -1,7 +1,8 @@
+{% load dynamic_url %}
         <div class="col">
           <div class="card shadow-sm">
             {% if d.item.image.exists %}
-            <a href="{{d.item.get_absolute_url}}"><img class="card-img-top" src="{{ d.item.image.first.image.url }}" alt="{{ d }}"></a>
+            <a href="{{d.item.get_absolute_url}}"><img class="card-img-top" src="{{ d.item.image.first.image.url }}" alt="{{ d.item }}"></a>
             {% endif %}
             <div class="card-body">
               <p class="card-text" style="position: relative;">
@@ -18,10 +19,24 @@
               <table class="table table-striped">
                 <thead>
                   <tr>
+                    {% if d.type == "catalog" %}
+                    <th colspan="2" scope="row">Catalog</th>
+                    {% elif d.type == "book" %}
                     <th colspan="2" scope="row">Book</th>
+                    {% endif %}
                   </tr>
                 </thead>
                 <tbody class="table-group-divider">
+                  {% if d.type == "catalog" %}
+                  <tr>
+                    <th class="w-33" scope="row">Manufacturer</th>
+                    <td>{{ d.item.manufacturer }}</td>
+                  </tr>
+                  <tr>
+                    <th class="w-33" scope="row">Scales</th>
+                    <td>{{ d.item.get_scales }}</td>
+                  </tr>
+                  {% elif d.type == "book" %}
                   <tr>
                     <th class="w-33" scope="row">Authors</th>
                     <td>
@@ -32,6 +47,7 @@
                     <th class="w-33" scope="row">Publisher</th>
                     <td>{{ d.item.publisher }}</td>
                   </tr>
+                  {% endif %}
                   <tr>
                     <th scope="row">Language</th>
                     <td>{{ d.item.get_language_display }}</td>
@@ -48,7 +64,7 @@
               </table>
               <div class="d-grid gap-2 mb-1 d-md-block">
                 <a class="btn btn-sm btn-outline-primary" href="{{ d.item.get_absolute_url }}">Show all data</a>
-                {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% url 'admin:bookshelf_book_change' d.item.pk %}">Edit</a>{% endif %}
+                {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% dynamic_admin_url 'bookshelf' d.type d.item.pk %}">Edit</a>{% endif %}
               </div>
             </div>
           </div>

ram/portal/templates/cards/consist.html

@@ -2,10 +2,10 @@
         <div class="card shadow-sm">
           <a href="{{ d.item.get_absolute_url }}">
           {% if d.item.image %}
-            <img class="card-img-top" src="{{ d.item.image.url }}" alt="{{ d }}">
+            <img class="card-img-top" src="{{ d.item.image.url }}" alt="{{ d.item }}">
           {% else %}
             {% with d.item.consist_item.first.rolling_stock as r %}
-            <img class="card-img-top" src="{{ r.image.first.image.url }}" alt="{{ d }}">
+            <img class="card-img-top" src="{{ r.image.first.image.url }}" alt="{{ d.item }}">
             {% endwith %}
           {% endif %}
           </a>

ram/portal/templates/cards/roster.html

@@ -2,10 +2,10 @@
         <div class="col">
           <div class="card shadow-sm">
             {% if d.item.image.exists %}
-            <a href="{{d.item.get_absolute_url}}"><img class="card-img-top" src="{{ d.item.image.first.image.url }}" alt="{{ d }}"></a>
+            <a href="{{d.item.get_absolute_url}}"><img class="card-img-top" src="{{ d.item.image.first.image.url }}" alt="{{ d.item }}"></a>
             {% else %}
             <!-- Do not show the "Coming soon" image when running in a single card column mode (e.g. on mobile) -->
-            <a href="{{d.item.get_absolute_url}}"><img class="card-img-top d-none d-sm-block" src="{% static DEFAULT_CARD_IMAGE %}" alt="{{ d }}"></a>
+            <a href="{{d.item.get_absolute_url}}"><img class="card-img-top d-none d-sm-block" src="{% static DEFAULT_CARD_IMAGE %}" alt="{{ d.item }}"></a>
             {% endif %}
             <div class="card-body">
               <p class="card-text" style="position: relative;">
@@ -56,11 +56,11 @@
                   </tr>
                   <tr>
                     <th scope="row">Scale</th>
-                    <td><a href="{% url 'filtered' _filter="scale" search=d.item.scale.slug %}"><abbr title="{{ d.item.scale.ratio }} - {{ d.item.scale.tracks }}">{{ d.item.scale }}</abbr></a></td>
+                    <td><a href="{% url 'filtered' _filter="scale" search=d.item.scale.slug %}"><abbr title="{{ d.item.scale.ratio }} - {{ d.item.scale.tracks }} mm">{{ d.item.scale }}</abbr></a></td>
                   </tr>
                   <tr>
                     <th scope="row">Item number</th>
-                    <td>{{ d.item.item_number }}</td>
+                    <td>{{ d.item.item_number }}{%if d.item.set %} | <a class="badge text-bg-primary" href="{% url 'manufacturer' manufacturer=d.item.manufacturer.slug search=d.item.item_number_slug %}">SET</a>{% endif %}</td>
                   </tr>
                 </tbody>
               </table>

ram/portal/templates/cards/scale.html

@@ -18,17 +18,17 @@
                   <td>{{ d.item.ratio }}</td>
                 </tr>
                 <tr>
-                  <th class="w-33" scope="row">Gauge</th>
-                  <td>{{ d.item.gauge }}</td>
+                  <th class="w-33" scope="row">Tracks</th>
+                  <td>{{ d.item.tracks }} mm</td>
                 </tr>
                 <tr>
-                  <th class="w-33" scope="row">Tracks</th>
-                  <td>{{ d.item.tracks }}</td>
+                  <th class="w-33" scope="row">Gauge</th>
+                  <td>{{ d.item.gauge }}</td>
                 </tr>
               </tbody>
             </table>
             <div class="d-grid gap-2 mb-1 d-md-block">
-              <a class="btn btn-sm btn-outline-primary" href="{% url 'filtered' _filter="scale" search=d.item.slug %}">Show all rolling stock</a>
+              <a class="btn btn-sm btn-outline-primary{% if d.item.num_items == 0 %} disabled{% endif %}" href="{% url 'filtered' _filter="scale" search=d.item.slug %}">Show all rolling stock</a>
               {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% url 'admin:metadata_scale_change' d.item.pk %}">Edit</a>{% endif %}
             </div>
           </div>

ram/portal/templates/companies.html

@@ -1,40 +0,0 @@
-{% extends "cards.html" %}
-      {% block pagination %}
-      {% if data.has_other_pages %}
-      <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4 mb-0">
-          {% if data.has_previous %}
-          <li class="page-item">
-            <a class="page-link" href="{% url 'companies_pagination' page=data.previous_page_number %}#main-content" tabindex="-1">Previous</a>
-          </li>
-          {% else %}
-          <li class="page-item disabled">
-            <span class="page-link">Previous</span>
-          </li>
-          {% endif %}
-          {% for i in page_range %}
-            {% if data.number == i %}
-            <li class="page-item active">
-              <span class="page-link">{{ i }}</span>
-            </li>
-            {% else %}
-              {% if i == data.paginator.ELLIPSIS %}
-              <li class="page-item"><span class="page-link">{{ i }}</span></li>
-              {% else %}
-              <li class="page-item"><a class="page-link" href="{% url 'companies_pagination' page=i %}#main-content">{{ i }}</a></li>
-              {% endif %}
-            {% endif %}
-          {% endfor %}
-          {% if data.has_next %}
-          <li class="page-item">
-            <a class="page-link" href="{% url 'companies_pagination' page=data.next_page_number %}#main-content" tabindex="-1">Next</a>
-          </li>
-          {% else %}
-          <li class="page-item disabled">
-            <span class="page-link">Next</span>
-          </li>
-          {% endif %}
-        </ul>
-      </nav>
-      {% endif %}
-      {% endblock %}

ram/portal/templates/consist.html

@@ -26,14 +26,14 @@
       {% block pagination %}
       {% if data.has_other_pages %}
       <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4 mb-0">
+        <ul class="pagination flex-wrap justify-content-center mt-4 mb-0">
           {% if data.has_previous %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'consist_pagination' uuid=consist.uuid page=data.previous_page_number %}#main-content" tabindex="-1">Previous</a>
+            <a class="page-link" href="{% url 'consist_pagination' uuid=consist.uuid page=data.previous_page_number %}#main-content" tabindex="-1"><i class="bi bi-chevron-left"></i></a>
           </li>
           {% else %}
           <li class="page-item disabled">
-            <span class="page-link">Previous</span>
+            <span class="page-link"><i class="bi bi-chevron-left"></i></span>
           </li>
           {% endif %}
           {% for i in page_range %}
@@ -51,11 +51,11 @@
           {% endfor %}
           {% if data.has_next %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'consist_pagination' uuid=consist.uuid page=data.next_page_number %}#main-content" tabindex="-1">Next</a>
+            <a class="page-link" href="{% url 'consist_pagination' uuid=consist.uuid page=data.next_page_number %}#main-content" tabindex="-1"><i class="bi bi-chevron-right"></i></a>
           </li>
           {% else %}
           <li class="page-item disabled">
-            <span class="page-link">Next</span>
+            <span class="page-link"><i class="bi bi-chevron-right"></i></span>
           </li>
           {% endif %}
         </ul>

ram/portal/templates/consists.html

@@ -1,40 +0,0 @@
-{% extends "cards.html" %}
-      {% block pagination %}
-      {% if data.has_other_pages %}
-      <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4 mb-0">
-          {% if data.has_previous %}
-          <li class="page-item">
-            <a class="page-link" href="{% url 'consists_pagination' page=data.previous_page_number %}#main-content" tabindex="-1">Previous</a>
-          </li>
-          {% else %}
-          <li class="page-item disabled">
-            <span class="page-link">Previous</span>
-          </li>
-          {% endif %}
-          {% for i in page_range %}
-            {% if data.number == i %}
-            <li class="page-item active">
-              <span class="page-link">{{ i }}</span>
-            </li>
-            {% else %}
-              {% if i == data.paginator.ELLIPSIS %}
-              <li class="page-item"><span class="page-link">{{ i }}</span></li>
-              {% else %}
-              <li class="page-item"><a class="page-link" href="{% url 'consists_pagination' page=i %}#main-content">{{ i }}</a></li>
-              {% endif %}
-            {% endif %}
-          {% endfor %}
-          {% if data.has_next %}
-          <li class="page-item">
-            <a class="page-link" href="{% url 'consists_pagination' page=data.next_page_number %}#main-content" tabindex="-1">Next</a>
-          </li>
-          {% else %}
-          <li class="page-item disabled">
-            <span class="page-link">Next</span>
-          </li>
-          {% endif %}
-        </ul>
-      </nav>
-      {% endif %}
-      {% endblock %}

ram/portal/templates/filter.html

@@ -2,14 +2,14 @@
       {% block pagination %}
       {% if data.has_other_pages %}
       <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4 mb-0">
+        <ul class="pagination flex-wrap justify-content-center mt-4 mb-0">
           {% if data.has_previous %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'filtered_pagination' _filter=filter search=search page=data.previous_page_number %}#main-content" tabindex="-1">Previous</a>
+            <a class="page-link" href="{% url 'filtered_pagination' _filter=filter search=search page=data.previous_page_number %}#main-content" tabindex="-1"><i class="bi bi-chevron-left"></i></a>
           </li>
           {% else %}
           <li class="page-item disabled">
-            <span class="page-link">Previous</span>
+            <span class="page-link"><i class="bi bi-chevron-left"></i></span>
           </li>
           {% endif %}
           {% for i in page_range %}
@@ -27,11 +27,11 @@
           {% endfor %}
           {% if data.has_next %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'filtered_pagination' _filter=filter search=search page=data.next_page_number %}#main-content" tabindex="-1">Next</a>
+            <a class="page-link" href="{% url 'filtered_pagination' _filter=filter search=search page=data.next_page_number %}#main-content" tabindex="-1"><i class="bi bi-chevron-right"></i></a>
           </li>
           {% else %}
           <li class="page-item disabled">
-            <span class="page-link">Next</span>
+            <span class="page-link"><i class="bi bi-chevron-right"></i></span>
           </li>
           {% endif %}
         </ul>

ram/portal/templates/home.html

@@ -1,4 +1,4 @@
-{% extends "roster.html" %}
+{% extends "pagination.html" %}
 
       {% block header %}
         <div class="text-muted">{{ site_conf.about | safe }}</div>

ram/portal/templates/includes/login.html

@@ -18,7 +18,12 @@
               <li><a class="dropdown-item" href="{% url 'admin:index' %}">Admin</a></li>
               <li><a class="dropdown-item" href="{% url 'admin:portal_siteconfiguration_changelist' %}">Site configuration</a></li>
               <li><hr class="dropdown-divider"></li>
-              <li><a class="dropdown-item text-danger" href="{% url 'admin:logout' %}?next={{ request.path }}">Logout</a></li>
+              <li>
+                <form id="logout-form" method="post" action="{% url 'admin:logout' %}?next={{ request.path }}">
+                  {% csrf_token %}
+                  <button class="btn btn-link dropdown-item text-danger" type="submit">Log out</button>
+                </form>
+              </li>
             </ul>
             {% else %}
             <a class="nav-link" href="{% url 'admin:login' %}?next={{ request.path }}">Log in</a>

ram/portal/templates/includes/search.html

@@ -1,4 +1,4 @@
-          <form class="d-flex needs-validation" action="{% url 'search' %}" method="post" novalidate>
+          <form class="d-flex needs-validation" action="{% url 'search' %}" method="post" novalidate>{% csrf_token %}
             <div class="input-group has-validation">
               <input class="form-control" type="search" list="datalistOptions" placeholder="Search" aria-label="Search" name="search" id="searchValidation" required>
               <datalist id="datalistOptions">

ram/portal/templates/manufacturer.html

@@ -2,14 +2,14 @@
       {% block pagination %}
       {% if data.has_other_pages %}
       <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4 mb-0">
+        <ul class="pagination flex-wrap justify-content-center mt-4 mb-0">
           {% if data.has_previous %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'books_pagination' page=data.previous_page_number %}#main-content" tabindex="-1">Previous</a>
+            <a class="page-link" href="{% url 'manufacturer_pagination' manufacturer=manufacturer.slug search=search page=data.previous_page_number %}#main-content" tabindex="-1"><i class="bi bi-chevron-left"></i></a>
           </li>
           {% else %}
           <li class="page-item disabled">
-            <span class="page-link">Previous</span>
+            <span class="page-link"><i class="bi bi-chevron-left"></i></span>
           </li>
           {% endif %}
           {% for i in page_range %}
@@ -21,17 +21,17 @@
               {% if i == data.paginator.ELLIPSIS %}
               <li class="page-item"><span class="page-link">{{ i }}</span></li>
               {% else %}
-              <li class="page-item"><a class="page-link" href="{% url 'books_pagination' page=i %}#main-content">{{ i }}</a></li>
+              <li class="page-item"><a class="page-link" href="{% url 'manufacturer_pagination' manufacturer=manufacturer.slug search=search page=i %}#main-content">{{ i }}</a></li>
               {% endif %}
             {% endif %}
           {% endfor %}
           {% if data.has_next %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'books_pagination' page=data.next_page_number %}#main-content" tabindex="-1">Next</a>
+            <a class="page-link" href="{% url 'manufacturer_pagination' manufacturer=manufacturer.slug search=search page=data.next_page_number %}#main-content" tabindex="-1"><i class="bi bi-chevron-right"></i></a>
           </li>
           {% else %}
           <li class="page-item disabled">
-            <span class="page-link">Next</span>
+            <span class="page-link"><i class="bi bi-chevron-right"></i></span>
           </li>
           {% endif %}
         </ul>

ram/portal/templates/pagination.html

@@ -1,16 +1,17 @@
 {% extends "cards.html" %}
+{% load dynamic_url %}
 
       {% block pagination %}
       {% if data.has_other_pages %}
       <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4 mb-0">
+        <ul class="pagination flex-wrap justify-content-center mt-4 mb-0">
           {% if data.has_previous %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'roster_pagination' page=data.previous_page_number %}#main-content" tabindex="-1">Previous</a>
+            <a class="page-link" href="{% dynamic_pagination type page=data.previous_page_number %}#main-content" tabindex="-1"><i class="bi bi-chevron-left"></i></a>
           </li>
           {% else %}
           <li class="page-item disabled">
-            <span class="page-link">Previous</span>
+            <span class="page-link"><i class="bi bi-chevron-left"></i></span>
           </li>
           {% endif %}
           {% for i in page_range %}
@@ -22,17 +23,17 @@
               {% if i == data.paginator.ELLIPSIS %}
               <li class="page-item"><span class="page-link">{{ i }}</span></li>
               {% else %}
-              <li class="page-item"><a class="page-link" href="{% url 'roster_pagination' page=i %}#main-content">{{ i }}</a></li>
+              <li class="page-item"><a class="page-link" href="{% dynamic_pagination type page=i %}#main-content">{{ i }}</a></li>
               {% endif %}
             {% endif %}
           {% endfor %}
           {% if data.has_next %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'roster_pagination' page=data.next_page_number %}#main-content" tabindex="-1">Next</a>
+            <a class="page-link" href="{% dynamic_pagination type page=data.next_page_number %}#main-content" tabindex="-1"><i class="bi bi-chevron-right"></i></a>
           </li>
           {% else %}
           <li class="page-item disabled">
-            <span class="page-link">Next</span>
+            <span class="page-link"><i class="bi bi-chevron-right"></i></span>
           </li>
           {% endif %}
         </ul>

ram/portal/templates/pagination_manufacturers.html

@@ -3,14 +3,14 @@
       {% if data.has_other_pages %}
       {% with data.0.item.category as c %}
       <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4 mb-0">
+        <ul class="pagination flex-wrap justify-content-center mt-4 mb-0">
           {% if data.has_previous %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'manufacturers_pagination' category=c page=data.previous_page_number %}#main-content" tabindex="-1">Previous</a>
+            <a class="page-link" href="{% url 'manufacturers_pagination' category=c page=data.previous_page_number %}#main-content" tabindex="-1"><i class="bi bi-chevron-left"></i></a>
           </li>
           {% else %}
           <li class="page-item disabled">
-            <span class="page-link">Previous</span>
+            <span class="page-link"><i class="bi bi-chevron-left"></i></span>
           </li>
           {% endif %}
           {% for i in page_range %}
@@ -28,11 +28,11 @@
           {% endfor %}
           {% if data.has_next %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'manufacturers_pagination' category=c page=data.next_page_number %}#main-content" tabindex="-1">Next</a>
+            <a class="page-link" href="{% url 'manufacturers_pagination' category=c page=data.next_page_number %}#main-content" tabindex="-1"><i class="bi bi-chevron-right"></i></a>
           </li>
           {% else %}
           <li class="page-item disabled">
-            <span class="page-link">Next</span>
+            <span class="page-link"><i class="bi bi-chevron-right"></i></span>
           </li>
           {% endif %}
         </ul>

ram/portal/templates/rollingstock.html

@@ -27,11 +27,11 @@
             {% if rolling_stock.image.count > 1 %}
             <button class="carousel-control-prev" type="button" data-bs-target="#carouselControls" data-bs-slide="prev">
               <span class="carousel-control-prev-icon" aria-hidden="true"></span>
-              <span class="visually-hidden">Previous</span>
+              <span class="visually-hidden"><i class="bi bi-chevron-left"></i></span>
             </button>
             <button class="carousel-control-next" type="button" data-bs-target="#carouselControls" data-bs-slide="next">
               <span class="carousel-control-next-icon" aria-hidden="true"></span>
-              <span class="visually-hidden">Next</span>
+              <span class="visually-hidden"><i class="bi bi-chevron-right"></i></span>
             </button>
             {% endif %}
           </div>
@@ -52,6 +52,7 @@
                 {% if documents or decoder_documents %}<button class="nav-link" id="nav-documents-tab" data-bs-toggle="tab" data-bs-target="#nav-documents" type="button" role="tab" aria-controls="nav-documents" aria-selected="false">Documents</button>{% endif %}
                 {% if journal %}<button class="nav-link" id="nav-journal-tab" data-bs-toggle="tab" data-bs-target="#nav-journal" type="button" role="tab" aria-controls="nav-journal" aria-selected="false">Journal</button>{% endif %}
                 {% if rolling_stock.notes %}<button class="nav-link" id="nav-notes-tab" data-bs-toggle="tab" data-bs-target="#nav-notes" type="button" role="tab" aria-controls="nav-notes" aria-selected="false">Notes</button>{% endif %}
+                {% if set %}<button class="nav-link" id="nav-set-tab" data-bs-toggle="tab" data-bs-target="#nav-set" type="button" role="tab" aria-controls="nav-set" aria-selected="false">Set</button>{% endif %}
                 {% if consists %}<button class="nav-link" id="nav-consists-tab" data-bs-toggle="tab" data-bs-target="#nav-consists" type="button" role="tab" aria-controls="nav-consists" aria-selected="false">Consists</button>{% endif %}
               </nav>
               <select class="form-select d-lg-none mb-2" id="tabSelector" aria-label="Tab selector">
@@ -63,6 +64,7 @@
                 {% if documents or decoder_documents %}<option value="nav-documents">Documents</option>{% endif %}
                 {% if journal %}<option value="nav-journal">Journal</option>{% endif %}
                 {% if rolling_stock.notes %}<option value="nav-notes">Notes</option>{% endif %}
+                {% if set %}<option value="nav-set">Set</option>{% endif %}
                 {% if consists %}<option value="nav-consists">Consists</option>{% endif %}
               </select>
               {% with class=rolling_stock.rolling_class company=rolling_stock.rolling_class.company %}
@@ -114,11 +116,11 @@
                       </tr>
                       <tr>
                         <th scope="row">Scale</th>
-                        <td><a href="{% url 'filtered' _filter="scale" search=rolling_stock.scale %}"><abbr title="{{ rolling_stock.scale.ratio }} - {{ rolling_stock.scale.tracks }}">{{ rolling_stock.scale }}</abbr></a></td>
+                        <td><a href="{% url 'filtered' _filter="scale" search=rolling_stock.scale %}"><abbr title="{{ rolling_stock.scale.ratio }} - {{ rolling_stock.scale.tracks }} mm">{{ rolling_stock.scale }}</abbr></a></td>
                       </tr>
                       <tr>
                         <th scope="row">Item number</th>
-                        <td>{{ rolling_stock.item_number }}</td>
+                        <td>{{ rolling_stock.item_number }}{%if rolling_stock.set %} | <a class="badge text-bg-primary" href="{% url 'manufacturer' manufacturer=rolling_stock.manufacturer.slug search=rolling_stock.item_number_slug %}">SET</a>{% endif %}</td>
                       </tr>
                     </tbody>
                   </table>
@@ -149,6 +151,7 @@
                   {% endif %}
                 </div>
                 <div class="tab-pane" id="nav-model" role="tabpanel" aria-labelledby="nav-model-tab">
+                  {{ rolling_stock.description | safe }}
                   <table class="table table-striped">
                     <thead>
                       <tr>
@@ -166,11 +169,11 @@
                       </tr>
                       <tr>
                         <th scope="row">Scale</th>
-                        <td><a href="{% url 'filtered' _filter="scale" search=rolling_stock.scale %}"><abbr title="{{ rolling_stock.scale.ratio }} - {{ rolling_stock.scale.tracks }}">{{ rolling_stock.scale }}</abbr></a></td>
+                        <td><a href="{% url 'filtered' _filter="scale" search=rolling_stock.scale %}"><abbr title="{{ rolling_stock.scale.ratio }} - {{ rolling_stock.scale.tracks }} mm">{{ rolling_stock.scale }}</abbr></a></td>
                       </tr>
                       <tr>
                         <th scope="row">Item number</th>
-                        <td>{{ rolling_stock.item_number }}</td>
+                        <td>{{ rolling_stock.item_number }}{%if rolling_stock.set %} | <a class="badge text-bg-primary" href="{% url 'manufacturer' manufacturer=rolling_stock.manufacturer.slug search=rolling_stock.item_number_slug %}">SET</a>{% endif %}</td>
                       </tr>
                       <tr>
                         <th scope="row">Era</th>
@@ -205,6 +208,7 @@
                   {% endif %}
                 </div>
                 <div class="tab-pane" id="nav-class" role="tabpanel" aria-labelledby="nav-class-tab">
+                  {{ class.description | safe }}
                   <table class="table table-striped">
                     <thead>
                       <tr>
@@ -372,6 +376,13 @@
                 <div class="tab-pane" id="nav-notes" role="tabpanel" aria-labelledby="nav-notes-tab">
                   {{ rolling_stock.notes | safe }}
                 </div>
+                <div class="tab-pane" id="nav-set" role="tabpanel" aria-labelledby="nav-set-tab">
+                  <div class="row row-cols-1 row-cols-md-2 row-cols-lg-3 g-3 mb-3">
+                  {% for d in set %}
+                  {% include "cards/roster.html" %}
+                  {% endfor %}
+                  </div>
+                </div>
                 <div class="tab-pane" id="nav-consists" role="tabpanel" aria-labelledby="nav-cosists-tab">
                   <div class="row row-cols-1 row-cols-md-2 row-cols-lg-3 g-3 mb-3">
                   {% for d in consists %}

ram/portal/templates/scales.html

@@ -1,40 +0,0 @@
-{% extends "cards.html" %}
-      {% block pagination %}
-      {% if data.has_other_pages %}
-      <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4 mb-0">
-          {% if data.has_previous %}
-          <li class="page-item">
-            <a class="page-link" href="{% url 'scales_pagination' page=data.previous_page_number %}#main-content" tabindex="-1">Previous</a>
-          </li>
-          {% else %}
-          <li class="page-item disabled">
-            <span class="page-link">Previous</span>
-          </li>
-          {% endif %}
-          {% for i in page_range %}
-            {% if data.number == i %}
-            <li class="page-item active">
-              <span class="page-link">{{ i }}</span>
-            </li>
-            {% else %}
-              {% if i == data.paginator.ELLIPSIS %}
-              <li class="page-item"><span class="page-link">{{ i }}</span></li>
-              {% else %}
-              <li class="page-item"><a class="page-link" href="{% url 'scales_pagination' page=i %}#main-content">{{ i }}</a></li>
-              {% endif %}
-            {% endif %}
-          {% endfor %}
-          {% if data.has_next %}
-          <li class="page-item">
-            <a class="page-link" href="{% url 'scales_pagination' page=data.next_page_number %}#main-content" tabindex="-1">Next</a>
-          </li>
-          {% else %}
-          <li class="page-item disabled">
-            <span class="page-link">Next</span>
-          </li>
-          {% endif %}
-        </ul>
-      </nav>
-      {% endif %}
-      {% endblock %}

ram/portal/templates/search.html

@@ -3,14 +3,14 @@
       {% block pagination %}
       {% if data.has_other_pages %}
       <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4 mb-0">
+        <ul class="pagination flex-wrap justify-content-center mt-4 mb-0">
           {% if data.has_previous %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'search_pagination' search=encoded_search page=data.previous_page_number %}#main-content" tabindex="-1">Previous</a>
+            <a class="page-link" href="{% url 'search_pagination' search=encoded_search page=data.previous_page_number %}#main-content" tabindex="-1"><i class="bi bi-chevron-left"></i></a>
           </li>
           {% else %}
           <li class="page-item disabled">
-            <span class="page-link">Previous</span>
+            <span class="page-link"><i class="bi bi-chevron-left"></i></span>
           </li>
           {% endif %}
           {% for i in page_range %}
@@ -28,11 +28,11 @@
           {% endfor %}
           {% if data.has_next %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'search_pagination' search=encoded_search page=data.next_page_number %}#main-content" tabindex="-1">Next</a>
+            <a class="page-link" href="{% url 'search_pagination' search=encoded_search page=data.next_page_number %}#main-content" tabindex="-1"><i class="bi bi-chevron-right"></i></a>
           </li>
           {% else %}
           <li class="page-item disabled">
-            <span class="page-link">Next</span>
+            <span class="page-link"><i class="bi bi-chevron-right"></i></span>
           </li>
           {% endif %}
         </ul>

ram/portal/templates/types.html

@@ -1,40 +0,0 @@
-{% extends "cards.html" %}
-      {% block pagination %}
-      {% if data.has_other_pages %}
-      <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4 mb-0">
-          {% if data.has_previous %}
-          <li class="page-item">
-            <a class="page-link" href="{% url 'types_pagination' page=data.previous_page_number %}#main-content" tabindex="-1">Previous</a>
-          </li>
-          {% else %}
-          <li class="page-item disabled">
-            <span class="page-link">Previous</span>
-          </li>
-          {% endif %}
-          {% for i in page_range %}
-            {% if data.number == i %}
-            <li class="page-item active">
-              <span class="page-link">{{ i }}</span>
-            </li>
-            {% else %}
-              {% if i == data.paginator.ELLIPSIS %}
-              <li class="page-item"><span class="page-link">{{ i }}</span></li>
-              {% else %}
-              <li class="page-item"><a class="page-link" href="{% url 'types_pagination' page=i %}#main-content">{{ i }}</a></li>
-              {% endif %}
-            {% endif %}
-          {% endfor %}
-          {% if data.has_next %}
-          <li class="page-item">
-            <a class="page-link" href="{% url 'types_pagination' page=data.next_page_number %}#main-content" tabindex="-1">Next</a>
-          </li>
-          {% else %}
-          <li class="page-item disabled">
-            <span class="page-link">Next</span>
-          </li>
-          {% endif %}
-        </ul>
-      </nav>
-      {% endif %}
-      {% endblock %}

ram/portal/templatetags/dynamic_url.py

@@ -0,0 +1,21 @@
+from django import template
+from django.urls import reverse
+
+register = template.Library()
+
+
+@register.simple_tag
+def dynamic_admin_url(app_name, model_name, object_id=None):
+    if object_id:
+        return reverse(
+            f'admin:{app_name}_{model_name}_change',
+            args=[object_id]
+        )
+    return reverse(f'admin:{app_name}_{model_name}_changelist')
+
+
+@register.simple_tag
+def dynamic_pagination(reverse_name, page):
+    if reverse_name.endswith('y'):
+        return reverse(f'{reverse_name[:-1]}ies_pagination', args=[page])
+    return reverse(f'{reverse_name}s_pagination', args=[page])

ram/portal/templatetags/show_menu.py

@@ -1,16 +1,21 @@
 from django import template
 from portal.models import Flatpage
-from bookshelf.models import Book
+from bookshelf.models import Book, Catalog
 
 register = template.Library()
 
 
 @register.inclusion_tag('bookshelf/bookshelf_menu.html')
 def show_bookshelf_menu():
-    return {"bookshelf_menu": Book.objects.exists()}
+    # FIXME: Filter out unpublished books and catalogs?
+    return {
+        "bookshelf_menu": (Book.objects.exists() or Catalog.objects.exists()),
+        "books_menu": Book.objects.exists(),
+        "catalogs_menu": Catalog.objects.exists(),
+    }
 
 
 @register.inclusion_tag('flatpages/flatpages_menu.html')
-def show_flatpages_menu():
-    menu = Flatpage.objects.filter(published=True).order_by("name")
+def show_flatpages_menu(user):
+    menu = Flatpage.objects.get_published(user).order_by("name")
     return {"flatpages_menu": menu}

ram/portal/urls.py

@@ -4,6 +4,7 @@ from portal.views import (
     GetData,
     GetRoster,
     GetObjectsFiltered,
+    GetManufacturerItem,
     GetFlatpage,
     GetRollingStock,
     GetConsist,
@@ -13,14 +14,19 @@ from portal.views import (
     Scales,
     Types,
     Books,
-    GetBook,
+    Catalogs,
+    GetBookCatalog,
     SearchObjects,
 )
 
 urlpatterns = [
     path("", GetData.as_view(template="home.html"), name="index"),
     path("roster", GetRoster.as_view(), name="roster"),
-    path("roster/<int:page>", GetRoster.as_view(), name="roster_pagination"),
+    path(
+        "roster/page/<int:page>",
+        GetRoster.as_view(),
+        name="rosters_pagination"
+    ),
     path(
         "page/<str:flatpage>",
         GetFlatpage.as_view(),
@@ -28,88 +34,122 @@ urlpatterns = [
     ),
     path(
         "consists",
-        Consists.as_view(template="consists.html"),
+        Consists.as_view(),
         name="consists"
     ),
     path(
-        "consists/<int:page>",
-        Consists.as_view(template="consists.html"),
+        "consists/page/<int:page>",
+        Consists.as_view(),
         name="consists_pagination"
     ),
     path("consist/<uuid:uuid>", GetConsist.as_view(), name="consist"),
     path(
-        "consist/<uuid:uuid>/<int:page>",
+        "consist/<uuid:uuid>/page/<int:page>",
         GetConsist.as_view(),
         name="consist_pagination",
     ),
     path(
         "companies",
-        Companies.as_view(template="companies.html"),
+        Companies.as_view(),
         name="companies"
     ),
     path(
-        "companies/<int:page>",
-        Companies.as_view(template="companies.html"),
+        "companies/page/<int:page>",
+        Companies.as_view(),
         name="companies_pagination",
     ),
     path(
         "manufacturers/<str:category>",
-        Manufacturers.as_view(template="manufacturers.html"),
+        Manufacturers.as_view(template="pagination_manufacturers.html"),
         name="manufacturers"
     ),
     path(
-        "manufacturers/<str:category>/<int:page>",
-        Manufacturers.as_view(template="manufacturers.html"),
+        "manufacturers/<str:category>/page/<int:page>",
+        Manufacturers.as_view(template="pagination_manufacturers.html"),
         name="manufacturers_pagination",
     ),
     path(
         "scales",
-        Scales.as_view(template="scales.html"),
+        Scales.as_view(),
         name="scales"
     ),
     path(
-        "scales/<int:page>",
-        Scales.as_view(template="scales.html"),
+        "scales/page/<int:page>",
+        Scales.as_view(),
         name="scales_pagination"
     ),
     path(
         "types",
-        Types.as_view(template="types.html"),
-        name="types"
+        Types.as_view(),
+        name="rolling_stock_types"
     ),
     path(
-        "types/<int:page>",
-        Types.as_view(template="types.html"),
-        name="types_pagination"
+        "types/page/<int:page>",
+        Types.as_view(),
+        name="rolling_stock_types_pagination"
     ),
     path(
         "bookshelf/books",
-        Books.as_view(template="bookshelf/books.html"),
+        Books.as_view(),
         name="books"
     ),
     path(
-        "bookshelf/books/<int:page>",
-        Books.as_view(template="bookshelf/books.html"),
+        "bookshelf/books/page/<int:page>",
+        Books.as_view(),
         name="books_pagination"
     ),
-    path("bookshelf/book/<uuid:uuid>", GetBook.as_view(), name="book"),
+    path(
+        "bookshelf/<str:selector>/<uuid:uuid>",
+        GetBookCatalog.as_view(),
+        name="bookshelf_item"
+    ),
+    path(
+        "bookshelf/catalogs",
+        Catalogs.as_view(),
+        name="catalogs"
+    ),
+    path(
+        "bookshelf/catalogs/page/<int:page>",
+        Catalogs.as_view(),
+        name="catalogs_pagination"
+    ),
     path(
         "search",
         SearchObjects.as_view(http_method_names=["post"]),
         name="search",
     ),
     path(
-        "search/<str:search>/<int:page>",
+        "search/<str:search>/page/<int:page>",
         SearchObjects.as_view(),
         name="search_pagination",
     ),
+    path(
+        "manufacturer/<str:manufacturer>",
+        GetManufacturerItem.as_view(),
+        name="manufacturer",
+    ),
+    path(
+        "manufacturer/<str:manufacturer>/page/<int:page>",
+        GetManufacturerItem.as_view(),
+        name="manufacturer_pagination",
+    ),
+    path(
+        "manufacturer/<str:manufacturer>/<str:search>",
+        GetManufacturerItem.as_view(),
+        name="manufacturer",
+    ),
+    path(
+        "manufacturer/<str:manufacturer>/<str:search>/page/<int:page>",
+        GetManufacturerItem.as_view(),
+        name="manufacturer_pagination",
+    ),
     path(
         "<str:_filter>/<str:search>",
         GetObjectsFiltered.as_view(),
         name="filtered",
     ),
     path(
-        "<str:_filter>/<str:search>/<int:page>",
+        "<str:_filter>/<str:search>/page/<int:page>",
         GetObjectsFiltered.as_view(),
         name="filtered_pagination",
     ),

ram/portal/views.py

@@ -1,13 +1,14 @@
 import base64
 import operator
+from itertools import chain
 from functools import reduce
 from urllib.parse import unquote
 
 from django.views import View
 from django.http import Http404, HttpResponseBadRequest
 from django.db.utils import OperationalError, ProgrammingError
-from django.db.models import Q
-from django.shortcuts import render, get_object_or_404
+from django.db.models import Q, Count
+from django.shortcuts import render, get_object_or_404, get_list_or_404
 from django.core.exceptions import ObjectDoesNotExist
 from django.core.paginator import Paginator
 
@@ -15,13 +16,25 @@ from portal.utils import get_site_conf
 from portal.models import Flatpage
 from roster.models import RollingStock
 from consist.models import Consist
-from bookshelf.models import Book
+from bookshelf.models import Book, Catalog
 from metadata.models import (
-    Company, Manufacturer, Scale, DecoderDocument, RollingStockType, Tag
+    Company,
+    Manufacturer,
+    Scale,
+    RollingStockType,
+    Tag,
 )
 
 
-def order_by_fields():
+def get_items_per_page():
+    try:
+        items_per_page = get_site_conf().items_per_page
+    except (OperationalError, ProgrammingError):
+        items_per_page = 6
+    return items_per_page
+
+
+def get_order_by_field():
     try:
         order_by = get_site_conf().items_ordering
     except (OperationalError, ProgrammingError):
@@ -42,26 +55,33 @@ def order_by_fields():
         return (fields[2], fields[0], fields[1], fields[3])
 
 
+class Render404(View):
+    def get(self, request, exception):
+        return render(request, "base.html", {"title": "404 page not found"})
+
+
 class GetData(View):
     title = "Home"
-    template = "roster.html"
-    item_type = "rolling_stock"
-    queryset = RollingStock.objects.order_by(*order_by_fields())
+    template = "pagination.html"
+    item_type = "roster"
+    filter = Q()  # empty filter by default
+
+    def get_data(self, request):
+        return (
+            RollingStock.objects.get_published(request.user)
+            .order_by(*get_order_by_field())
+            .filter(self.filter)
+        )
 
     def get(self, request, page=1):
-        site_conf = get_site_conf()
-
         data = []
-        for item in self.queryset:
-            data.append({
-                "type": self.item_type,
-                "item": item
-            })
+        for item in self.get_data(request):
+            data.append({"type": self.item_type, "item": item})
 
-        paginator = Paginator(data, site_conf.items_per_page)
+        paginator = Paginator(data, get_items_per_page())
         data = paginator.get_page(page)
         page_range = paginator.get_elided_page_range(
-            data.number, on_each_side=2, on_ends=1
+            data.number, on_each_side=1, on_ends=1
         )
 
         return render(
@@ -78,14 +98,17 @@ class GetData(View):
 
 
 class GetRoster(GetData):
-    title = "Roster"
-    item_type = "rolling_stock"
-    queryset = RollingStock.objects.order_by(*order_by_fields())
+    title = "The Roster"
+    item_type = "roster"
+
+    def get_data(self, request):
+        return RollingStock.objects.get_published(request.user).order_by(
+            *get_order_by_field()
+        )
 
 
 class SearchObjects(View):
     def run_search(self, request, search, _filter, page=1):
-        site_conf = get_site_conf()
         if _filter is None:
             query = reduce(
                 operator.or_,
@@ -126,20 +149,22 @@ class SearchObjects(View):
             raise Http404
 
         # FIXME duplicated code!
+        # FIXME see if it makes sense to filter calatogs and books by scale
+        #       and manufacturer as well
         data = []
-        rolling_stock = (
-            RollingStock.objects.filter(query)
+        roster = (
+            RollingStock.objects.get_published(request.user)
+            .filter(query)
             .distinct()
-            .order_by(*order_by_fields())
+            .order_by(*get_order_by_field())
         )
-        for item in rolling_stock:
-            data.append({
-                "type": "rolling_stock",
-                "item": item
-            })
+        for item in roster:
+            data.append({"type": "roster", "item": item})
+
         if _filter is None:
             consists = (
-                Consist.objects.filter(
+                Consist.objects.get_published(request.user)
+                .filter(
                     Q(
                         Q(identifier__icontains=search)
                         | Q(company__name__icontains=search)
@@ -148,24 +173,24 @@ class SearchObjects(View):
                 .distinct()
             )
             for item in consists:
-                data.append({
-                    "type": "consist",
-                    "item": item
-                })
+                data.append({"type": "consist", "item": item})
             books = (
-                Book.objects.filter(title__icontains=search)
+                Book.objects.get_published(request.user)
+                .filter(title__icontains=search)
                 .distinct()
             )
-            for item in books:
-                data.append({
-                    "type": "book",
-                    "item": item
-                })
+            catalogs = (
+                Catalog.objects.get_published(request.user)
+                .filter(manufacturer__name__icontains=search)
+                .distinct()
+            )
+            for item in list(chain(books, catalogs)):
+                data.append({"type": "book", "item": item})
 
-        paginator = Paginator(data, site_conf.items_per_page)
+        paginator = Paginator(data, get_items_per_page())
         data = paginator.get_page(page)
         page_range = paginator.get_elided_page_range(
-            data.number, on_each_side=2, on_ends=1
+            data.number, on_each_side=1, on_ends=1
         )
 
         return data, paginator.count, page_range
@@ -190,8 +215,7 @@ class SearchObjects(View):
             encoded_search = search
             search = base64.b64decode(search.encode()).decode()
         except Exception:
-            encoded_search = base64.b64encode(
-                search.encode()).decode()
+            encoded_search = base64.b64encode(search.encode()).decode()
         _filter, keyword = self.split_search(search)
         data, matches, page_range = self.run_search(
             request, keyword, _filter, page
@@ -201,7 +225,7 @@ class SearchObjects(View):
             request,
             "search.html",
             {
-                "title": "Search: \"{}\"".format(search),
+                "title": 'Search: "{}"'.format(search),
                 "search": search,
                 "encoded_search": encoded_search,
                 "data": data,
@@ -215,10 +239,64 @@ class SearchObjects(View):
         return self.get(request, search, page)
 
 
+class GetManufacturerItem(View):
+    def get(self, request, manufacturer, search="all", page=1):
+        manufacturer = get_object_or_404(
+            Manufacturer, slug__iexact=manufacturer
+        )
+
+        if search != "all":
+            roster = get_list_or_404(
+                RollingStock.objects.get_published(request.user).order_by(
+                    *get_order_by_field()
+                ),
+                Q(
+                    Q(manufacturer=manufacturer)
+                    & Q(item_number_slug__exact=search)
+                ),
+            )
+            title = "{0}: {1}".format(
+                manufacturer,
+                # all returned records must have the same `item_number``;
+                # just pick it up the first result, otherwise `search`
+                roster.first.item_number if roster else search,
+            )
+        else:
+            roster = (
+                RollingStock.objects.get_published(request.user)
+                .order_by(*get_order_by_field())
+                .filter(
+                    Q(manufacturer=manufacturer)
+                    | Q(rolling_class__manufacturer=manufacturer)
+                )
+            )
+            title = "Manufacturer: {0}".format(manufacturer)
+
+        data = []
+        for item in roster:
+            data.append({"type": "roster", "item": item})
+
+        paginator = Paginator(data, get_items_per_page())
+        data = paginator.get_page(page)
+        page_range = paginator.get_elided_page_range(
+            data.number, on_each_side=1, on_ends=1
+        )
+        return render(
+            request,
+            "manufacturer.html",
+            {
+                "title": title,
+                "manufacturer": manufacturer,
+                "search": search,
+                "data": data,
+                "matches": paginator.count,
+                "page_range": page_range,
+            },
+        )
+
+
 class GetObjectsFiltered(View):
     def run_filter(self, request, search, _filter, page=1):
-        site_conf = get_site_conf()
-
         if _filter == "type":
             title = get_object_or_404(RollingStockType, slug__iexact=search)
             query = Q(rolling_class__type__slug__iexact=search)
@@ -226,12 +304,6 @@ class GetObjectsFiltered(View):
             title = get_object_or_404(Company, slug__iexact=search)
             query = Q(rolling_class__company__slug__iexact=search)
             query_2nd = Q(company__slug__iexact=search)
-        elif _filter == "manufacturer":
-            title = get_object_or_404(Manufacturer, slug__iexact=search)
-            query = Q(
-                Q(rolling_class__manufacturer__slug__iexact=search)
-                | Q(manufacturer__slug__iexact=search)
-            )
         elif _filter == "scale":
             title = get_object_or_404(Scale, slug__iexact=search)
             query = Q(scale__slug__iexact=search)
@@ -245,46 +317,40 @@ class GetObjectsFiltered(View):
         else:
             raise Http404
 
-        rolling_stock = (
-            RollingStock.objects.filter(query)
+        roster = (
+            RollingStock.objects.get_published(request.user)
+            .filter(query)
             .distinct()
-            .order_by(*order_by_fields())
+            .order_by(*get_order_by_field())
         )
 
         data = []
-        for item in rolling_stock:
-            data.append({
-                "type": "rolling_stock",
-                "item": item
-            })
+        for item in roster:
+            data.append({"type": "roster", "item": item})
 
         try:  # Execute only if query_2nd is defined
             consists = (
-                Consist.objects.filter(query_2nd)
+                Consist.objects.get_published(request.user)
+                .filter(query_2nd)
                 .distinct()
             )
             for item in consists:
-                data.append({
-                    "type": "consist",
-                    "item": item
-                })
+                data.append({"type": "consist", "item": item})
             if _filter == "tag":  # Books can be filtered only by tag
                 books = (
-                    Book.objects.filter(query_2nd)
+                    Book.objects.get_published(request.user)
+                    .filter(query_2nd)
                     .distinct()
                 )
                 for item in books:
-                    data.append({
-                        "type": "book",
-                        "item": item
-                    })
+                    data.append({"type": "book", "item": item})
         except NameError:
             pass
 
-        paginator = Paginator(data, site_conf.items_per_page)
+        paginator = Paginator(data, get_items_per_page())
         data = paginator.get_page(page)
         page_range = paginator.get_elided_page_range(
-            data.number, on_each_side=2, on_ends=1
+            data.number, on_each_side=1, on_ends=1
         )
 
         return data, title, paginator.count, page_range
@@ -298,8 +364,7 @@ class GetObjectsFiltered(View):
             request,
             "filter.html",
             {
-                "title": "{0}: {1}".format(
-                    _filter.capitalize(), title),
+                "title": "{0}: {1}".format(_filter.capitalize(), title),
                 "search": search,
                 "filter": _filter,
                 "data": data,
@@ -312,40 +377,44 @@ class GetObjectsFiltered(View):
 class GetRollingStock(View):
     def get(self, request, uuid):
         try:
-            rolling_stock = RollingStock.objects.get(uuid=uuid)
+            rolling_stock = RollingStock.objects.get_published(
+                request.user
+            ).get(uuid=uuid)
         except ObjectDoesNotExist:
             raise Http404
 
         # FIXME there's likely a better and more efficient way of doing this
         # but keeping KISS for now
         decoder_documents = []
-        if request.user.is_authenticated:
-            class_properties = rolling_stock.rolling_class.property.all()
-            properties = rolling_stock.property.all()
-            documents = rolling_stock.document.all()
-            journal = rolling_stock.journal.all()
-            if rolling_stock.decoder:
-                decoder_documents = rolling_stock.decoder.document.all()
-        else:
-            class_properties = rolling_stock.rolling_class.property.filter(
-                property__private=False
+        class_properties = rolling_stock.rolling_class.property.get_public(
+            request.user
+        )
+        properties = rolling_stock.property.get_public(request.user)
+        documents = rolling_stock.document.get_public(request.user)
+        journal = rolling_stock.journal.get_public(request.user)
+        if rolling_stock.decoder:
+            decoder_documents = rolling_stock.decoder.document.get_public(
+                request.user
             )
-            properties = rolling_stock.property.filter(
-                property__private=False
-            )
-            documents = rolling_stock.document.filter(private=False)
-            journal = rolling_stock.journal.filter(private=False)
-            if rolling_stock.decoder:
-                decoder_documents = rolling_stock.decoder.document.filter(
-                    private=False
-                )
 
-        consists = [{
-            "type": "consist",
-            "item": c
-        } for c in Consist.objects.filter(
-            consist_item__rolling_stock=rolling_stock
-        )]  # A dict with "item" is required by the consists card
+        consists = [
+            {"type": "consist", "item": c}
+            for c in Consist.objects.get_published(request.user).filter(
+                consist_item__rolling_stock=rolling_stock
+            )
+        ]  # A dict with "item" is required by the consists card
+
+        set = [
+            {"type": "set", "item": s}
+            for s in RollingStock.objects.get_published(request.user)
+            .filter(
+                Q(
+                    Q(item_number__exact=rolling_stock.item_number)
+                    & Q(set=True)
+                )
+            )
+            .order_by(*get_order_by_field())
+        ]
 
         return render(
             request,
@@ -358,6 +427,7 @@ class GetRollingStock(View):
                 "decoder_documents": decoder_documents,
                 "documents": documents,
                 "journal": journal,
+                "set": set,
                 "consists": consists,
             },
         )
@@ -366,25 +436,33 @@ class GetRollingStock(View):
 class Consists(GetData):
     title = "Consists"
     item_type = "consist"
-    queryset = Consist.objects.all()
+
+    def get_data(self, request):
+        return Consist.objects.get_published(request.user).all()
 
 
 class GetConsist(View):
     def get(self, request, uuid, page=1):
-        site_conf = get_site_conf()
         try:
-            consist = Consist.objects.get(uuid=uuid)
+            consist = Consist.objects.get_published(request.user).get(
+                uuid=uuid
+            )
         except ObjectDoesNotExist:
             raise Http404
-        data = [{
-            "type": "rolling_stock",
-            "item": RollingStock.objects.get(uuid=r.rolling_stock_id)
-        } for r in consist.consist_item.all()]
+        data = [
+            {
+                "type": "roster",
+                "item": RollingStock.objects.get_published(request.user).get(
+                    uuid=r.rolling_stock_id
+                ),
+            }
+            for r in consist.consist_item.all()
+        ]
 
-        paginator = Paginator(data, site_conf.items_per_page)
+        paginator = Paginator(data, get_items_per_page())
         data = paginator.get_page(page)
         page_range = paginator.get_elided_page_range(
-            data.number, on_each_side=2, on_ends=1
+            data.number, on_each_side=1, on_ends=1
         )
 
         return render(
@@ -402,20 +480,25 @@ class GetConsist(View):
 class Manufacturers(GetData):
     title = "Manufacturers"
     item_type = "manufacturer"
-    queryset = None  # Set via method get
+
+    def get_data(self, request):
+        return Manufacturer.objects.filter(self.filter)
 
     # overload get method to filter by category
     def get(self, request, category, page=1):
         if category not in ("real", "model"):
             raise Http404
-        self.queryset = Manufacturer.objects.filter(category=category)
+        self.filter = Q(category=category)
+
         return super().get(request, page)
 
 
 class Companies(GetData):
     title = "Companies"
     item_type = "company"
-    queryset = Company.objects.all()
+
+    def get_data(self, request):
+        return Company.objects.all()
 
 
 class Scales(GetData):
@@ -423,50 +506,72 @@ class Scales(GetData):
     item_type = "scale"
     queryset = Scale.objects.all()
 
+    def get_data(self, request):
+        return Scale.objects.annotate(
+            num_items=Count("rollingstock")
+        )  # .filter(num_items__gt=0) to filter data with no items
+
 
 class Types(GetData):
     title = "Types"
     item_type = "rolling_stock_type"
-    queryset = RollingStockType.objects.all()
+
+    def get_data(self, request):
+        return RollingStockType.objects.all()
 
 
 class Books(GetData):
     title = "Books"
     item_type = "book"
-    queryset = Book.objects.all()
+
+    def get_data(self, request):
+        return Book.objects.get_published(request.user).all()
 
 
-class GetBook(View):
-    def get(self, request, uuid):
+class Catalogs(GetData):
+    title = "Catalogs"
+    item_type = "catalog"
+
+    def get_data(self, request):
+        return Catalog.objects.get_published(request.user).all()
+
+
+class GetBookCatalog(View):
+    def get_object(self, request, uuid, selector):
+        if selector == "book":
+            return Book.objects.get_published(request.user).get(uuid=uuid)
+        elif selector == "catalog":
+            return Catalog.objects.get_published(request.user).get(uuid=uuid)
+        else:
+            raise Http404
+
+    def get(self, request, uuid, selector):
         try:
-            book = Book.objects.get(uuid=uuid)
+            book = self.get_object(request, uuid, selector)
         except ObjectDoesNotExist:
             raise Http404
 
-        book_properties = (
-            book.property.all()
-            if request.user.is_authenticated
-            else book.property.filter(property__private=False)
-        )
+        properties = book.property.get_public(request.user)
+        documents = book.document.get_public(request.user)
         return render(
             request,
             "bookshelf/book.html",
             {
                 "title": book,
-                "book_properties": book_properties,
                 "book": book,
+                "documents": documents,
+                "properties": properties,
+                "type": selector
             },
         )
 
 
 class GetFlatpage(View):
     def get(self, request, flatpage):
-        _filter = Q(published=True)  # Show only published pages
-        if request.user.is_authenticated:
-            _filter = Q()  # Reset the filter if user is authenticated
-
         try:
-            flatpage = Flatpage.objects.filter(_filter).get(path=flatpage)
+            flatpage = Flatpage.objects.get_published(request.user).get(
+                path=flatpage
+            )
         except ObjectDoesNotExist:
             raise Http404
 

ram/ram/__init__.py

@@ -1,4 +1,4 @@
 from ram.utils import git_suffix
 
-__version__ = "0.9.2"
+__version__ = "0.14.2"
 __version__ += git_suffix(__file__)

ram/ram/admin.py

@@ -1,10 +1,4 @@
 from django.contrib import admin
-from django.db.utils import OperationalError, ProgrammingError
-from portal.utils import get_site_conf
+from django.conf import settings
 
-try:
-    site_name = get_site_conf().site_name
-except (OperationalError, ProgrammingError):
-    site_name = "Train Assets Manager"
-
-admin.site.site_header = site_name
+admin.site.site_header = settings.SITE_NAME

ram/ram/management/commands/purge_cache.py

@@ -0,0 +1,13 @@
+from django.core.cache import cache
+from django.core.management.base import BaseCommand, CommandError
+
+
+class Command(BaseCommand):
+    help = "Clear the application cache"
+
+    def handle(self, *args, **options):
+        try:
+            cache.clear()
+            self.stdout.write(self.style.SUCCESS("Cache cleared"))
+        except Exception:
+            raise CommandError("Cache is not active")

ram/ram/managers.py

@@ -0,0 +1,19 @@
+from django.db import models
+from django.core.exceptions import FieldError
+
+
+class PublicManager(models.Manager):
+    def get_published(self, user):
+        if user.is_authenticated:
+            return self.get_queryset()
+        else:
+            return self.get_queryset().filter(published=True)
+
+    def get_public(self, user):
+        if user.is_authenticated:
+            return self.get_queryset()
+        else:
+            try:
+                return self.get_queryset().filter(private=False)
+            except FieldError:
+                return self.get_queryset().filter(property__private=False)

ram/ram/models.py

@@ -1,9 +1,25 @@
 import os
+from uuid import uuid4
 
 from django.db import models
 from django.utils.safestring import mark_safe
+from tinymce import models as tinymce
 
 from ram.utils import DeduplicatedStorage, get_image_preview
+from ram.managers import PublicManager
+
+
+class BaseModel(models.Model):
+    uuid = models.UUIDField(primary_key=True, default=uuid4, editable=False)
+    notes = tinymce.HTMLField(blank=True)
+    creation_time = models.DateTimeField(auto_now_add=True)
+    updated_time = models.DateTimeField(auto_now=True)
+    published = models.BooleanField(default=True)
+
+    class Meta:
+        abstract = True
+
+    objects = PublicManager()
 
 
 class Document(models.Model):
@@ -11,13 +27,12 @@ class Document(models.Model):
     file = models.FileField(
         upload_to="files/",
         storage=DeduplicatedStorage(),
-        null=True,
-        blank=True,
     )
     private = models.BooleanField(default=False)
 
     class Meta:
         abstract = True
+        verbose_name_plural = "Documents"
 
     def __str__(self):
         return "{0}".format(os.path.basename(self.file.name))
@@ -30,15 +45,18 @@ class Document(models.Model):
             '<a href="{0}" target="_blank">Link</a>'.format(self.file.url)
         )
 
+    objects = PublicManager()
+
 
 class Image(models.Model):
     order = models.PositiveIntegerField(default=0, blank=False, null=False)
     image = models.ImageField(
-        upload_to="images/", storage=DeduplicatedStorage, null=True, blank=True
+        upload_to="images/",
+        storage=DeduplicatedStorage,
     )
 
-    def image_thumbnail(self):
-        return get_image_preview(self.image.url)
+    def image_thumbnail(self, max_size=150):
+        return get_image_preview(self.image.url, max_size)
 
     image_thumbnail.short_description = "Preview"
 
@@ -48,6 +66,9 @@ class Image(models.Model):
     class Meta:
         abstract = True
         ordering = ["order"]
+        verbose_name_plural = "Images"
+
+    objects = PublicManager()
 
 
 class PropertyInstance(models.Model):
@@ -63,3 +84,5 @@ class PropertyInstance(models.Model):
     class Meta:
         abstract = True
         verbose_name_plural = "Properties"
+
+    objects = PublicManager()

ram/ram/settings.py

@@ -44,12 +44,11 @@ INSTALLED_APPS = [
     "adminsortable2",
     "django_countries",
     "solo",
-    "ckeditor",
-    "ckeditor_uploader",
+    "tinymce",
     "rest_framework",
     "ram",
     "portal",
-    # "driver",
+    # "driver",  # uncomment this to enable the "driver" API
     "metadata",
     "roster",
     "consist",
@@ -60,7 +59,7 @@ MIDDLEWARE = [
     "django.middleware.security.SecurityMiddleware",
     "django.contrib.sessions.middleware.SessionMiddleware",
     "django.middleware.common.CommonMiddleware",
-    # 'django.middleware.csrf.CsrfViewMiddleware',
+    "django.middleware.csrf.CsrfViewMiddleware",
     "django.contrib.auth.middleware.AuthenticationMiddleware",
     "django.contrib.messages.middleware.MessageMiddleware",
     "django.middleware.clickjacking.XFrameOptionsMiddleware",
@@ -142,17 +141,37 @@ DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
 
 MEDIA_URL = "media/"
 MEDIA_ROOT = STORAGE_DIR / "media"
-CKEDITOR_UPLOAD_PATH = "uploads/"
+
+TINYMCE_DEFAULT_CONFIG = {
+    "height": "500px",
+    "menubar": False,
+    "plugins": "autolink lists link image charmap preview anchor "
+    "searchreplace visualblocks code fullscreen insertdatetime media "
+    "table paste code",
+    "toolbar": "undo redo | "
+    "bold italic underline strikethrough removeformat | "
+    "fontsizeselect formatselect | "
+    "alignleft aligncenter alignright alignjustify | "
+    "outdent indent numlist bullist | "
+    "insertfile image media pageembed template link anchor codesample | "
+    "charmap | "
+    "fullscreen preview code",
+    "images_upload_url": "/tinymce/upload_image",
+}
 
 COUNTRIES_OVERRIDE = {
-    "ZZ": "Freelance",
+    "EU": "Europe",
+    "XX": "None",
 }
 
+SITE_NAME = "Railroad Assets Manger"
+
 # Image used on cards without a custom image uploaded.
 # The file must be placed in the root of the 'static' folder
 DEFAULT_CARD_IMAGE = "coming_soon.svg"
 
 DECODER_INTERFACES = [
+    (0, "Built-in"),
     (1, "NEM651"),
     (2, "NEM652"),
     (3, "PluX"),

ram/ram/urls.py

@@ -13,6 +13,7 @@ Including another URLconf
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+
 from django.apps import apps
 from django.conf import settings
 from django.shortcuts import redirect
@@ -20,9 +21,15 @@ from django.conf.urls.static import static
 from django.contrib import admin
 from django.urls import include, path
 
+from ram.views import UploadImage
+from portal.views import Render404
+
+handler404 = Render404.as_view()
+
 urlpatterns = [
     path("", lambda r: redirect("portal/")),
-    path("ckeditor/", include("ckeditor_uploader.urls")),
+    path("tinymce/", include("tinymce.urls")),
+    path("tinymce/upload_image", UploadImage.as_view(), name="upload_image"),
     path("portal/", include("portal.urls")),
     path("admin/", admin.site.urls),
     path("api/v1/consist/", include("consist.urls")),

ram/ram/utils.py

@@ -44,10 +44,10 @@ def git_suffix(fname):
     return gh
 
 
-def get_image_preview(url):
+def get_image_preview(url, max_size=150):
     return format_html(
-        '<img src="%s" style="max-width: 150px; max-height: 150px;'
-        'background-color: #eee;" />' % url
+        '<img src="{src}" style="max-width: {size}px; max-height: {size}px;'
+        'background-color: #eee;" />'.format(src=url, size=max_size)
     )
 
 

ram/ram/views.py

@@ -0,0 +1,62 @@
+import os
+import datetime
+import posixpath
+
+from pathlib import Path
+from PIL import Image, UnidentifiedImageError
+
+from django.views import View
+from django.conf import settings
+from django.http import (
+    HttpResponseBadRequest,
+    HttpResponseForbidden,
+    JsonResponse,
+)
+from django.utils.text import slugify as slugify
+from django.utils.decorators import method_decorator
+from django.views.decorators.csrf import csrf_exempt
+
+
+@method_decorator(csrf_exempt, name="dispatch")
+class UploadImage(View):
+    def post(self, request):
+        if not request.user.is_authenticated:
+            raise HttpResponseForbidden()
+
+        file_obj = request.FILES["file"]
+        file_name, file_extension = os.path.splitext(file_obj.name)
+        file_name = slugify(file_name) + file_extension
+
+        try:
+            Image.open(file_obj)
+        except UnidentifiedImageError:
+            return HttpResponseBadRequest()
+
+        today = datetime.date.today()
+        container = (
+            "uploads",
+            today.strftime("%Y"),
+            today.strftime("%m"),
+            today.strftime("%d"),
+        )
+
+        dir_path = os.path.join(settings.MEDIA_ROOT, *(p for p in container))
+        file_path = os.path.normpath(os.path.join(dir_path, file_name))
+        # even if we apply slugify to the file name, add more hardening
+        # to avoid any path transversal risk
+        if not file_path.startswith(str(settings.MEDIA_ROOT)):
+            return HttpResponseBadRequest()
+
+        Path(dir_path).mkdir(parents=True, exist_ok=True)
+        with open(file_path, "wb+") as f:
+            for chunk in file_obj.chunks():
+                f.write(chunk)
+
+            return JsonResponse(
+                {
+                    "message": "Image uploaded successfully",
+                    "location": posixpath.join(
+                        settings.MEDIA_URL, *(p for p in container), file_name
+                    ),
+                }
+            )

ram/roster/admin.py

@@ -16,11 +16,13 @@ class RollingClassPropertyInline(admin.TabularInline):
     model = RollingClassProperty
     min_num = 0
     extra = 0
+    autocomplete_fields = ("property",)
 
 
 @admin.register(RollingClass)
 class RollingClass(admin.ModelAdmin):
     inlines = (RollingClassPropertyInline,)
+    autocomplete_fields = ("manufacturer",)
     list_display = ("__str__", "type", "company")
     list_filter = ("company", "type__category", "type")
     search_fields = (
@@ -50,6 +52,7 @@ class RollingStockPropertyInline(admin.TabularInline):
     model = RollingStockProperty
     min_num = 0
     extra = 0
+    autocomplete_fields = ("property",)
 
 
 class RollingStockJournalInline(admin.TabularInline):
@@ -104,9 +107,11 @@ class RollingStockAdmin(SortableAdminBase, admin.ModelAdmin):
         RollingStockDocInline,
         RollingStockJournalInline,
     )
-    readonly_fields = ("creation_time", "updated_time")
+    autocomplete_fields = ("rolling_class",)
+    readonly_fields = ("preview", "creation_time", "updated_time")
     list_display = (
         "__str__",
+        "published",
         "address",
         "manufacturer",
         "scale",
@@ -136,12 +141,16 @@ class RollingStockAdmin(SortableAdminBase, admin.ModelAdmin):
             None,
             {
                 "fields": (
+                    "preview",
+                    "published",
                     "rolling_class",
                     "road_number",
                     "scale",
                     "manufacturer",
                     "item_number",
+                    "set",
                     "era",
+                    "description",
                     "production_year",
                     "purchase_date",
                     "notes",

ram/roster/migrations/0010_alter_rollingstock_notes.py

@@ -1,6 +1,7 @@
 # Generated by Django 4.1 on 2022-08-23 15:54
 
-import ckeditor_uploader.fields
+# ckeditor removal
+# import ckeditor_uploader.fields
 from django.db import migrations
 
 
@@ -11,9 +12,9 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
-        migrations.AlterField(
-            model_name="rollingstock",
-            name="notes",
-            field=ckeditor_uploader.fields.RichTextUploadingField(blank=True),
-        ),
+        # migrations.AlterField(
+        #     model_name="rollingstock",
+        #     name="notes",
+        #     field=ckeditor_uploader.fields.RichTextUploadingField(blank=True),
+        # ),
     ]

ram/roster/migrations/0012_rollingstockjournal.py

@@ -1,6 +1,7 @@
 # Generated by Django 4.1 on 2022-08-27 12:43
 
-import ckeditor_uploader.fields
+# ckeditor removal
+# import ckeditor_uploader.fields
 from django.db import migrations, models
 import django.db.models.deletion
 
@@ -25,7 +26,8 @@ class Migration(migrations.Migration):
                     ),
                 ),
                 ("date", models.DateField()),
-                ("log", ckeditor_uploader.fields.RichTextUploadingField()),
+                # ("log", ckeditor_uploader.fields.RichTextUploadingField()),
+                ("log", models.TextField()),
                 ("private", models.BooleanField(default=False)),
                 ("creation_time", models.DateTimeField(auto_now_add=True)),
                 ("updated_time", models.DateTimeField(auto_now=True)),

ram/roster/migrations/0020_alter_rollingstockimage_image.py

@@ -0,0 +1,49 @@
+# Generated by Django 4.2.6 on 2023-10-30 13:16
+
+import os
+import sys
+import shutil
+import ram.utils
+import roster.models
+
+from django.db import migrations, models
+from django.conf import settings
+
+
+def move_images(apps, schema_editor):
+    sys.stdout.write("\n  Processing files. Please await...")
+    for r in roster.models.RollingStockImage.objects.all():
+        fname = os.path.basename(r.image.path)
+        new_image = roster.models.rolling_stock_image_upload(r, fname)
+        new_path = os.path.join(settings.MEDIA_ROOT, new_image)
+        os.makedirs(os.path.dirname(new_path), exist_ok=True)
+        try:
+            shutil.move(r.image.path, new_path)
+        except FileNotFoundError:
+            sys.stderr.write("  !! FileNotFoundError: {}\n".format(new_image))
+            pass
+        r.image.name = new_image
+        r.save()
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("roster", "0019_rollingstockdocument_private"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="rollingstockimage",
+            name="image",
+            field=models.ImageField(
+                blank=True,
+                null=True,
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to=roster.models.rolling_stock_image_upload,
+            ),
+        ),
+        migrations.RunPython(
+            move_images,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

ram/roster/migrations/0021_alter_rollingstockdocument_file_and_more.py

@@ -0,0 +1,29 @@
+# Generated by Django 4.2.6 on 2023-11-04 22:53
+
+from django.db import migrations, models
+import ram.utils
+import roster.models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("roster", "0020_alter_rollingstockimage_image"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="rollingstockdocument",
+            name="file",
+            field=models.FileField(
+                storage=ram.utils.DeduplicatedStorage(), upload_to="files/"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="rollingstockimage",
+            name="image",
+            field=models.ImageField(
+                storage=ram.utils.DeduplicatedStorage,
+                upload_to=roster.models.rolling_stock_image_upload,
+            ),
+        ),
+    ]

ram/roster/migrations/0022_alter_rollingstock_notes_and_more.py

@@ -0,0 +1,24 @@
+# Generated by Django 5.0.2 on 2024-02-17 12:19
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0021_alter_rollingstockdocument_file_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="rollingstock",
+            name="notes",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+        migrations.AlterField(
+            model_name="rollingstockjournal",
+            name="log",
+            field=tinymce.models.HTMLField(),
+        ),
+    ]

ram/roster/migrations/0023_alter_rollingclass_description.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2024-03-02 13:30
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0022_alter_rollingstock_notes_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="rollingclass",
+            name="description",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]

ram/roster/migrations/0024_rollingstock_description.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.0.2 on 2024-03-02 14:30
+
+import tinymce.models
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0023_alter_rollingclass_description"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="rollingstock",
+            name="description",
+            field=tinymce.models.HTMLField(blank=True),
+        ),
+    ]

ram/roster/migrations/0025_rollingstock_set_alter_rollingstock_era_and_more.py

@@ -0,0 +1,40 @@
+# Generated by Django 5.0.4 on 2024-04-20 12:55
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0024_rollingstock_description"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="rollingstock",
+            name="set",
+            field=models.BooleanField(default=False, help_text="Part of a set"),
+        ),
+        migrations.AlterField(
+            model_name="rollingstock",
+            name="era",
+            field=models.CharField(
+                blank=True, help_text="Era or epoch of the model", max_length=32
+            ),
+        ),
+        migrations.AlterField(
+            model_name="rollingstock",
+            name="item_number",
+            field=models.CharField(
+                blank=True, help_text="Catalog item number or code", max_length=32
+            ),
+        ),
+        migrations.AlterField(
+            model_name="rollingstockjournal",
+            name="private",
+            field=models.BooleanField(
+                default=False,
+                help_text="Journal log will be visible only to logged users",
+            ),
+        ),
+    ]

ram/roster/migrations/0026_rollingstock_item_number_slug.py

@@ -0,0 +1,31 @@
+# Generated by Django 5.0.4 on 2024-04-23 21:10
+
+from django.db import migrations, models
+from ram.utils import slugify
+
+
+def gen_item_number_slug(apps, schema_editor):
+    RollingStock = apps.get_model('roster', 'RollingStock')
+    for row in RollingStock.objects.all():
+        if row.item_number:
+            row.item_number_slug = slugify(row.item_number)
+            row.save(update_fields=['item_number_slug'])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0025_rollingstock_set_alter_rollingstock_era_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="rollingstock",
+            name="item_number_slug",
+            field=models.CharField(blank=True, editable=False, max_length=32),
+        ),
+        migrations.RunPython(
+            gen_item_number_slug,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

ram/roster/migrations/0027_alter_rollingstock_decoder_interface.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.0.4 on 2024-04-30 09:06
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0026_rollingstock_item_number_slug"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="rollingstock",
+            name="decoder_interface",
+            field=models.PositiveSmallIntegerField(
+                blank=True,
+                choices=[
+                    (0, "Built-in"),
+                    (1, "NEM651"),
+                    (2, "NEM652"),
+                    (3, "PluX"),
+                    (4, "21MTC"),
+                    (5, "Next18/Next18S"),
+                ],
+                null=True,
+            ),
+        ),
+    ]

ram/roster/migrations/0028_rollingstock_published.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2024-11-04 12:37
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0027_alter_rollingstock_decoder_interface"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="rollingstock",
+            name="published",
+            field=models.BooleanField(default=True),
+        ),
+    ]

ram/roster/migrations/0029_alter_rollingstockimage_options.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.1.2 on 2024-12-22 20:38
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0028_rollingstock_published"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="rollingstockimage",
+            options={"ordering": ["order"], "verbose_name_plural": "Images"},
+        ),
+    ]

ram/roster/models.py

@@ -1,14 +1,16 @@
+import os
 import re
-from uuid import uuid4
+import shutil
 from django.db import models
 from django.urls import reverse
 from django.conf import settings
 from django.dispatch import receiver
 
-from ckeditor_uploader.fields import RichTextUploadingField
+from tinymce import models as tinymce
 
-from ram.models import Document, Image, PropertyInstance
-from ram.utils import get_image_preview
+from ram.models import BaseModel, Document, Image, PropertyInstance
+from ram.utils import DeduplicatedStorage
+from ram.managers import PublicManager
 from metadata.models import (
     Scale,
     Manufacturer,
@@ -23,7 +25,7 @@ class RollingClass(models.Model):
     identifier = models.CharField(max_length=128, unique=False)
     type = models.ForeignKey(RollingStockType, on_delete=models.CASCADE)
     company = models.ForeignKey(Company, on_delete=models.CASCADE)
-    description = models.CharField(max_length=256, blank=True)
+    description = tinymce.HTMLField(blank=True)
     manufacturer = models.ForeignKey(
         Manufacturer,
         on_delete=models.CASCADE,
@@ -52,8 +54,7 @@ class RollingClassProperty(PropertyInstance):
     )
 
 
-class RollingStock(models.Model):
-    uuid = models.UUIDField(primary_key=True, default=uuid4, editable=False)
+class RollingStock(BaseModel):
     rolling_class = models.ForeignKey(
         RollingClass,
         on_delete=models.CASCADE,
@@ -72,7 +73,20 @@ class RollingStock(models.Model):
         limit_choices_to={"category": "model"},
     )
     scale = models.ForeignKey(Scale, on_delete=models.CASCADE)
-    item_number = models.CharField(max_length=32, blank=True)
+    item_number = models.CharField(
+        max_length=32,
+        blank=True,
+        help_text="Catalog item number or code",
+    )
+    item_number_slug = models.CharField(
+        max_length=32,
+        blank=True,
+        editable=False
+    )
+    set = models.BooleanField(
+        default=False,
+        help_text="Part of a set",
+    )
     decoder_interface = models.PositiveSmallIntegerField(
         choices=settings.DECODER_INTERFACES, null=True, blank=True
     )
@@ -80,15 +94,17 @@ class RollingStock(models.Model):
         Decoder, on_delete=models.CASCADE, null=True, blank=True
     )
     address = models.SmallIntegerField(default=None, null=True, blank=True)
-    era = models.CharField(max_length=32, blank=True)
+    era = models.CharField(
+        max_length=32,
+        blank=True,
+        help_text="Era or epoch of the model",
+    )
     production_year = models.SmallIntegerField(null=True, blank=True)
     purchase_date = models.DateField(null=True, blank=True)
-    notes = RichTextUploadingField(blank=True)
+    description = tinymce.HTMLField(blank=True)
     tags = models.ManyToManyField(
         Tag, related_name="rolling_stock", blank=True
     )
-    creation_time = models.DateTimeField(auto_now_add=True)
-    updated_time = models.DateTimeField(auto_now=True)
 
     class Meta:
         ordering = ["rolling_class", "road_number_int"]
@@ -100,12 +116,24 @@ class RollingStock(models.Model):
     def get_absolute_url(self):
         return reverse("rolling_stock", kwargs={"uuid": self.uuid})
 
+    def preview(self):
+        return self.image.first().image_thumbnail(350)
+
     def country(self):
         return str(self.rolling_class.company.country)
 
     def company(self):
         return str(self.rolling_class.company)
 
+    def delete(self, *args, **kwargs):
+        shutil.rmtree(
+            os.path.join(
+                settings.MEDIA_ROOT, "images", "rollingstock", str(self.uuid)
+            ),
+            ignore_errors=True
+        )
+        super(RollingStock, self).delete(*args, **kwargs)
+
 
 @receiver(models.signals.pre_save, sender=RollingStock)
 def pre_save_running_number(sender, instance, *args, **kwargs):
@@ -126,10 +154,23 @@ class RollingStockDocument(Document):
         unique_together = ("rolling_stock", "file")
 
 
+def rolling_stock_image_upload(instance, filename):
+    return os.path.join(
+        "images",
+        "rollingstock",
+        str(instance.rolling_stock.uuid),
+        filename
+    )
+
+
 class RollingStockImage(Image):
     rolling_stock = models.ForeignKey(
         RollingStock, on_delete=models.CASCADE, related_name="image"
     )
+    image = models.ImageField(
+        upload_to=rolling_stock_image_upload,
+        storage=DeduplicatedStorage,
+    )
 
 
 class RollingStockProperty(PropertyInstance):
@@ -151,8 +192,11 @@ class RollingStockJournal(models.Model):
         blank=False,
     )
     date = models.DateField()
-    log = RichTextUploadingField()
-    private = models.BooleanField(default=False)
+    log = tinymce.HTMLField()
+    private = models.BooleanField(
+        default=False,
+        help_text="Journal log will be visible only to logged users",
+    )
     creation_time = models.DateTimeField(auto_now_add=True)
     updated_time = models.DateTimeField(auto_now=True)
 
@@ -162,6 +206,8 @@ class RollingStockJournal(models.Model):
     class Meta:
         ordering = ["date", "rolling_stock"]
 
+    objects = PublicManager()
+
 
 # @receiver(models.signals.post_delete, sender=Cab)
 # def post_save_image(sender, instance, *args, **kwargs):

ram/roster/urls.py

@@ -3,7 +3,7 @@ from roster.views import RosterList, RosterGet, RosterAddress, RosterClass
 
 urlpatterns = [
     path("list", RosterList.as_view()),
-    path("get/<str:uuid>", RosterGet.as_view()),
+    path("get/<uuid:uuid>", RosterGet.as_view()),
     path("address/<int:address>", RosterAddress.as_view()),
     path("class/<str:class>", RosterClass.as_view()),
 ]