Fix data retreival issue on GetData (#35)

* Add a boolean to define item as part of a set
* Add contextual help in admin
* Introduce support to sets and to item code lookup
Also review the url path for pagination

.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.10', '3.11', '3.12']
 
     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/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,49 @@
+# 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.BookImage.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"),
+    ]
+
+    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/models.py

@@ -1,10 +1,12 @@
+import os
+import shutil
 from uuid import uuid4
 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
@@ -50,11 +52,12 @@ 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)
+    notes = tinymce.HTMLField(blank=True)
     creation_time = models.DateTimeField(auto_now_add=True)
     updated_time = models.DateTimeField(auto_now=True)
 
@@ -70,16 +73,32 @@ class Book(models.Model):
     def get_absolute_url(self):
         return reverse("book", kwargs={"uuid": self.uuid})
 
+    def delete(self, *args, **kwargs):
+        shutil.rmtree(
+            os.path.join(
+                settings.MEDIA_ROOT, "images", "books", str(self.uuid)
+            ),
+            ignore_errors=True
+        )
+        super(Book, self).delete(*args, **kwargs)
+
+
+def book_image_upload(instance, filename):
+    return os.path.join(
+        "images",
+        "books",
+        str(instance.book.uuid),
+        filename
+    )
+
 
 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
+        upload_to=book_image_upload,
         storage=DeduplicatedStorage,
-        null=True,
-        blank=True
     )
 
 

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/models.py

@@ -1,8 +1,10 @@
+import os
+
 from uuid import uuid4
 from django.db import models
 from django.urls import reverse
 
-from ckeditor_uploader.fields import RichTextUploadingField
+from tinymce import models as tinymce
 
 from ram.utils import DeduplicatedStorage
 from metadata.models import Company, Tag
@@ -14,14 +16,24 @@ class Consist(models.Model):
     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",
     )
-    notes = RichTextUploadingField(blank=True)
+    image = models.ImageField(
+        upload_to=os.path.join("images", "consists"),
+        storage=DeduplicatedStorage,
+        null=True,
+        blank=True,
+    )
+    notes = tinymce.HTMLField(blank=True)
     creation_time = models.DateTimeField(auto_now_add=True)
     updated_time = models.DateTimeField(auto_now=True)
 

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/models.py

@@ -1,3 +1,4 @@
+import os
 from django.db import models
 from django.urls import reverse
 from django.conf import settings
@@ -10,7 +11,10 @@ from ram.utils import DeduplicatedStorage, get_image_preview, slugify
 
 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"
@@ -28,7 +32,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:
@@ -58,7 +65,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:
@@ -95,7 +105,10 @@ 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):

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,20 @@
 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.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 +29,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 +41,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 +55,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)
 

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 %}
@@ -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

@@ -54,6 +54,7 @@
               <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>
                         <th colspan="2" scope="row">Book</th>

ram/portal/templates/cards/book.html

@@ -1,7 +1,7 @@
         <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;">

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;">
@@ -60,7 +60,7 @@
                   </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 search=d.item.item_number %}">SET</a>{% endif %}</td>
                   </tr>
                 </tbody>
               </table>

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

@@ -0,0 +1,40 @@
+{% 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 'manufacturer_pagination' manufacturer=manufacturer search=search 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 'manufacturer_pagination' manufacturer=manufacturer 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 'manufacturer_pagination' manufacturer=manufacturer search=search 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/rollingstock.html

@@ -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 %}
@@ -118,7 +120,7 @@
                       </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 search=rolling_stock.item_number %}">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>
@@ -170,7 +173,7 @@
                       </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 search=rolling_stock.item_number %}">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/urls.py

@@ -4,6 +4,7 @@ from portal.views import (
     GetData,
     GetRoster,
     GetObjectsFiltered,
+    GetManufacturerItem,
     GetFlatpage,
     GetRollingStock,
     GetConsist,
@@ -20,7 +21,11 @@ from portal.views import (
 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="roster_pagination"
+    ),
     path(
         "page/<str:flatpage>",
         GetFlatpage.as_view(),
@@ -32,13 +37,13 @@ urlpatterns = [
         name="consists"
     ),
     path(
-        "consists/<int:page>",
+        "consists/page/<int:page>",
         Consists.as_view(template="consists.html"),
         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",
     ),
@@ -48,7 +53,7 @@ urlpatterns = [
         name="companies"
     ),
     path(
-        "companies/<int:page>",
+        "companies/page/<int:page>",
         Companies.as_view(template="companies.html"),
         name="companies_pagination",
     ),
@@ -58,7 +63,7 @@ urlpatterns = [
         name="manufacturers"
     ),
     path(
-        "manufacturers/<str:category>/<int:page>",
+        "manufacturers/<str:category>/page/<int:page>",
         Manufacturers.as_view(template="manufacturers.html"),
         name="manufacturers_pagination",
     ),
@@ -68,7 +73,7 @@ urlpatterns = [
         name="scales"
     ),
     path(
-        "scales/<int:page>",
+        "scales/page/<int:page>",
         Scales.as_view(template="scales.html"),
         name="scales_pagination"
     ),
@@ -78,7 +83,7 @@ urlpatterns = [
         name="types"
     ),
     path(
-        "types/<int:page>",
+        "types/page/<int:page>",
         Types.as_view(template="types.html"),
         name="types_pagination"
     ),
@@ -88,7 +93,7 @@ urlpatterns = [
         name="books"
     ),
     path(
-        "bookshelf/books/<int:page>",
+        "bookshelf/books/page/<int:page>",
         Books.as_view(template="bookshelf/books.html"),
         name="books_pagination"
     ),
@@ -99,17 +104,37 @@ urlpatterns = [
         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

@@ -7,7 +7,7 @@ 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.shortcuts import render, get_object_or_404, get_list_or_404
 from django.core.exceptions import ObjectDoesNotExist
 from django.core.paginator import Paginator
 
@@ -21,7 +21,15 @@ from metadata.models import (
 )
 
 
-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):
@@ -46,19 +54,22 @@ class GetData(View):
     title = "Home"
     template = "roster.html"
     item_type = "rolling_stock"
-    queryset = RollingStock.objects.order_by(*order_by_fields())
+    filter = Q()  # empty filter by default
+
+    def get_data(self):
+        return RollingStock.objects.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:
+        for item in self.get_data():
             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
@@ -80,12 +91,13 @@ class GetData(View):
 class GetRoster(GetData):
     title = "Roster"
     item_type = "rolling_stock"
-    queryset = RollingStock.objects.order_by(*order_by_fields())
+
+    def get_data(self):
+        return RollingStock.objects.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_,
@@ -130,7 +142,7 @@ class SearchObjects(View):
         rolling_stock = (
             RollingStock.objects.filter(query)
             .distinct()
-            .order_by(*order_by_fields())
+            .order_by(*get_order_by_field())
         )
         for item in rolling_stock:
             data.append({
@@ -162,7 +174,7 @@ class SearchObjects(View):
                     "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
@@ -215,10 +227,58 @@ class SearchObjects(View):
         return self.get(request, search, page)
 
 
+class GetManufacturerItem(View):
+    def get(self, request, manufacturer, search="all", page=1):
+        if search != "all":
+            rolling_stock = get_list_or_404(
+                RollingStock.objects.order_by(*get_order_by_field()),
+                Q(
+                    Q(manufacturer__name__iexact=manufacturer)
+                    & Q(item_number__exact=search)
+                )
+            )
+            title = "{0}: {1}".format(
+                rolling_stock[0].manufacturer,
+                search
+            )
+        else:
+            rolling_stock = get_list_or_404(
+                RollingStock.objects.order_by(*get_order_by_field()),
+                Q(rolling_class__manufacturer__slug__iexact=manufacturer)
+                | Q(manufacturer__slug__iexact=manufacturer)
+            )
+            title = "Manufacturer: {0}".format(
+                    get_object_or_404(Manufacturer, slug__iexact=manufacturer)
+                )
+
+        data = []
+        for item in rolling_stock:
+            data.append({
+                "type": "rolling_stock",
+                "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=2, 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 +286,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)
@@ -248,7 +302,7 @@ class GetObjectsFiltered(View):
         rolling_stock = (
             RollingStock.objects.filter(query)
             .distinct()
-            .order_by(*order_by_fields())
+            .order_by(*get_order_by_field())
         )
 
         data = []
@@ -281,7 +335,7 @@ class GetObjectsFiltered(View):
         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
@@ -347,6 +401,16 @@ class GetRollingStock(View):
             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.filter(
+                Q(
+                    Q(item_number__exact=rolling_stock.item_number)
+                    & Q(set=True)
+                )
+        ).order_by(*get_order_by_field())]
+
         return render(
             request,
             "rollingstock.html",
@@ -358,6 +422,7 @@ class GetRollingStock(View):
                 "decoder_documents": decoder_documents,
                 "documents": documents,
                 "journal": journal,
+                "set": set,
                 "consists": consists,
             },
         )
@@ -366,12 +431,13 @@ class GetRollingStock(View):
 class Consists(GetData):
     title = "Consists"
     item_type = "consist"
-    queryset = Consist.objects.all()
+
+    def get_data(self):
+        return Consist.objects.all()
 
 
 class GetConsist(View):
     def get(self, request, uuid, page=1):
-        site_conf = get_site_conf()
         try:
             consist = Consist.objects.get(uuid=uuid)
         except ObjectDoesNotExist:
@@ -381,7 +447,7 @@ class GetConsist(View):
             "item": RollingStock.objects.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
@@ -402,20 +468,25 @@ class GetConsist(View):
 class Manufacturers(GetData):
     title = "Manufacturers"
     item_type = "manufacturer"
-    queryset = None  # Set via method get
+
+    def get_data(self):
+        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):
+        return Company.objects.all()
 
 
 class Scales(GetData):
@@ -423,17 +494,24 @@ class Scales(GetData):
     item_type = "scale"
     queryset = Scale.objects.all()
 
+    def get_data(self):
+        return Scale.objects.all()
+
 
 class Types(GetData):
     title = "Types"
     item_type = "rolling_stock_type"
-    queryset = RollingStockType.objects.all()
+
+    def get_data(self):
+        return RollingStockType.objects.all()
 
 
 class Books(GetData):
     title = "Books"
     item_type = "book"
-    queryset = Book.objects.all()
+
+    def get_data(self):
+        return Book.objects.all()
 
 
 class GetBook(View):

ram/ram/__init__.py

@@ -1,4 +1,4 @@
 from ram.utils import git_suffix
 
-__version__ = "0.9.2"
+__version__ = "0.12.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/models.py

@@ -11,8 +11,6 @@ class Document(models.Model):
     file = models.FileField(
         upload_to="files/",
         storage=DeduplicatedStorage(),
-        null=True,
-        blank=True,
     )
     private = models.BooleanField(default=False)
 
@@ -34,7 +32,8 @@ class Document(models.Model):
 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):

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,12 +141,31 @@ 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"

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,12 @@ from django.conf.urls.static import static
 from django.contrib import admin
 from django.urls import include, path
 
+from ram.views import UploadImage
+
 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/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

@@ -141,7 +141,9 @@ class RollingStockAdmin(SortableAdminBase, admin.ModelAdmin):
                     "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/models.py

@@ -1,14 +1,16 @@
+import os
 import re
+import shutil
 from uuid import uuid4
 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.utils import DeduplicatedStorage
 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,
@@ -72,7 +74,15 @@ 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",
+    )
+    set = models.BooleanField(
+        default=False,
+        help_text="Part of a set",
+    )
     decoder_interface = models.PositiveSmallIntegerField(
         choices=settings.DECODER_INTERFACES, null=True, blank=True
     )
@@ -80,13 +90,18 @@ 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
     )
+    notes = tinymce.HTMLField(blank=True)
     creation_time = models.DateTimeField(auto_now_add=True)
     updated_time = models.DateTimeField(auto_now=True)
 
@@ -106,6 +121,15 @@ class RollingStock(models.Model):
     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 +150,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 +188,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)
 

requirements-prod.txt

@@ -1,2 +1,2 @@
 gunicorn
-pylibmc
+# Optional: # pylibmc

requirements.txt

@@ -7,7 +7,7 @@ django-solo
 django-countries
 django-health-check
 django-admin-sortable2
-django-ckeditor
+django-tinymce
 # Optional: # psycopg2-binary
 # Optional: # pySerial
 # Required by django-countries and not always installed