Merge pull request #12 from daniviga/move-dcc-interface

Move decoder interface def into rolling stock

README.md

@@ -2,8 +2,7 @@
 
 [![Django CI](https://github.com/daniviga/django-rma/actions/workflows/django.yml/badge.svg)](https://github.com/daniviga/django-rma/actions/workflows/django.yml)
 
-![image](https://user-images.githubusercontent.com/1818657/175789825-9a03f0ff-a95e-42a2-9611-e14d2817e22f.png)
-
+![Screenshot 2022-07-23 at 22-40-17 Railroad Assets Manager](https://user-images.githubusercontent.com/1818657/180622177-a4bba00e-47da-42b3-a7f6-b24773e69936.png)
 
 A `jff` (just for fun) project that aims to create a
 model railroad assets manager that allows to:
@@ -26,6 +25,8 @@ This project probably doesn't match you needs nor expectations. Be aware.
 
 Your model train may also catch fire while using this software.
 
+Check out [my own instance](https://daniele.mynarrowgauge.org).
+
 ## Components
 
 Project is based on the following technologies and components:
@@ -138,14 +139,18 @@ To be continued ...
 ## Screenshots
 
 ### Frontend
+![Screenshot 2022-07-23 at 22-41-44 Railroad Assets Manager](https://user-images.githubusercontent.com/1818657/180622406-760774a9-f028-44fc-b332-fa74e43307df.png)
+---
+![Screenshot 2022-07-23 at 22-44-35 Railroad Assets Manager](https://user-images.githubusercontent.com/1818657/180622342-40586d75-239a-400c-93a1-1cb9583a7d17.png)
+---
+![Screenshot 2022-07-23 at 22-44-46 Railroad Assets Manager](https://user-images.githubusercontent.com/1818657/180622321-1ab76440-9c6e-4667-9247-dbbcf6c6055c.png)
+
+#### Dark mode
+
+![Screenshot 2022-07-23 at 22-53-43 Railroad Assets Manager](https://user-images.githubusercontent.com/1818657/180622629-65d81eaf-cca4-4f44-b39b-3b0077b43a34.png)
 
-![image](https://user-images.githubusercontent.com/1818657/175789897-9ec4a9bb-9c65-48ef-9b57-ae94e094e6a7.png)
 ---
-![image](https://user-images.githubusercontent.com/1818657/175789901-ef50acd7-8c05-4788-92a2-1bb1280d598c.png)
----
-![image](https://user-images.githubusercontent.com/1818657/175790004-18926d23-28f9-45bb-b279-6c26575ae3a5.png)
----
-![image](https://user-images.githubusercontent.com/1818657/175790008-62eea2cc-1c41-42df-9026-4cf6e8ef712c.png)
+
 
 
 ### Backoffice
@@ -158,8 +163,7 @@ To be continued ...
 
 ### Rest API
 
-![image](https://user-images.githubusercontent.com/1818657/175790064-23ec038e-e8bf-4c39-964c-3118e4295b59.png)
-
+![image](https://user-images.githubusercontent.com/1818657/180622471-ade06c84-c73b-41d5-a2a7-02a95b2ffc02.png)
 
 
 

ram/consist/migrations/0005_alter_consist_notes.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.1 on 2022-08-23 15:54
+
+import ckeditor_uploader.fields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("consist", "0004_alter_consist_company"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="consist",
+            name="notes",
+            field=ckeditor_uploader.fields.RichTextUploadingField(blank=True),
+        ),
+    ]

ram/consist/migrations/0006_md_to_html.py

@@ -0,0 +1,34 @@
+# Generated by Django 4.1 on 2022-08-24 15:30
+
+import markdown
+from django.db import migrations
+
+
+def md_to_html(apps, schema_editor):
+    fields = {
+        "Consist": ["notes"],
+    }
+
+    for m in fields.items():
+        model = apps.get_model("consist", m[0])
+
+        for row in model.objects.all():
+            for field in m[1]:
+                html = markdown.markdown(getattr(row, field))
+                row.__dict__[field] = html
+
+            row.save(update_fields=m[1])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("consist", "0005_alter_consist_notes"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            md_to_html,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

ram/consist/models.py

@@ -2,6 +2,8 @@ from uuid import uuid4
 from django.db import models
 from django.urls import reverse
 
+from ckeditor_uploader.fields import RichTextUploadingField
+
 from metadata.models import Company, Tag
 from roster.models import RollingStock
 
@@ -16,7 +18,7 @@ class Consist(models.Model):
     company = models.ForeignKey(Company, on_delete=models.CASCADE)
     era = models.CharField(max_length=32, blank=True)
     image = models.ImageField(upload_to="images/", null=True, blank=True)
-    notes = models.TextField(blank=True)
+    notes = RichTextUploadingField(blank=True)
     creation_time = models.DateTimeField(auto_now_add=True)
     updated_time = models.DateTimeField(auto_now=True)
 

ram/metadata/admin.py

@@ -20,8 +20,8 @@ class PropertyAdmin(admin.ModelAdmin):
 @admin.register(Decoder)
 class DecoderAdmin(admin.ModelAdmin):
     readonly_fields = ("image_thumbnail",)
-    list_display = ("__str__", "interface")
-    list_filter = ("manufacturer", "interface")
+    list_display = ("__str__", "sound")
+    list_filter = ("manufacturer", "sound")
     search_fields = ("name", "manufacturer__name")
 
 

ram/metadata/migrations/0008_remove_decoder_interface.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.1.2 on 2022-10-31 23:01
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("metadata", "0007_rename_track_scale_tracks"),
+        ("roster", "0013_rollingstock_decoder_interface"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="decoder",
+            name="interface",
+        ),
+    ]

ram/metadata/models.py

@@ -66,9 +66,6 @@ class Decoder(models.Model):
         limit_choices_to={"category": "model"},
     )
     version = models.CharField(max_length=64, blank=True)
-    interface = models.PositiveSmallIntegerField(
-        choices=settings.DECODER_INTERFACES, null=True, blank=True
-    )
     sound = models.BooleanField(default=False)
     image = models.ImageField(upload_to="images/", null=True, blank=True)
 

ram/portal/admin.py

@@ -1,6 +1,38 @@
 from django.contrib import admin
 from solo.admin import SingletonModelAdmin
 
-from portal.models import SiteConfiguration
+from portal.models import SiteConfiguration, Flatpage
 
 admin.site.register(SiteConfiguration, SingletonModelAdmin)
+
+
+@admin.register(Flatpage)
+class FlatpageAdmin(admin.ModelAdmin):
+    readonly_fields = ("path", "creation_time", "updated_time")
+    list_display = ("name", "path", "published", "get_link")
+    list_filter = ("published",)
+    search_fields = ("name",)
+
+    fieldsets = (
+        (
+            None,
+            {
+                "fields": (
+                    "name",
+                    "path",
+                    "content",
+                    "published",
+                )
+            },
+        ),
+        (
+            "Audit",
+            {
+                "classes": ("collapse",),
+                "fields": (
+                    "creation_time",
+                    "updated_time",
+                ),
+            },
+        ),
+    )

ram/portal/migrations/0008_flatpage.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.0.6 on 2022-08-07 15:01
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('portal', '0007_siteconfiguration_items_ordering'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Flatpage',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=256, unique=True)),
+                ('draft', models.BooleanField(default=True)),
+                ('content', models.TextField(blank=True)),
+            ],
+        ),
+    ]

ram/portal/migrations/0009_flatpage_path.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.0.6 on 2022-08-07 15:19
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('portal', '0008_flatpage'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='flatpage',
+            name='path',
+            field=models.CharField(default='', max_length=256, unique=True),
+            preserve_default=False,
+        ),
+    ]

ram/portal/migrations/0010_flatpage_creation_time_flatpage_updated_time.py

@@ -0,0 +1,25 @@
+# Generated by Django 4.0.6 on 2022-08-07 15:46
+
+from django.db import migrations, models
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('portal', '0009_flatpage_path'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='flatpage',
+            name='creation_time',
+            field=models.DateTimeField(auto_now_add=True, default=django.utils.timezone.now),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name='flatpage',
+            name='updated_time',
+            field=models.DateTimeField(auto_now=True),
+        ),
+    ]

ram/portal/migrations/0011_alter_flatpage_content_alter_siteconfiguration_about_and_more.py

@@ -0,0 +1,35 @@
+# Generated by Django 4.1 on 2022-08-23 15:54
+
+import ckeditor.fields
+import ckeditor_uploader.fields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("portal", "0010_flatpage_creation_time_flatpage_updated_time"),
+    ]
+
+    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),
+        ),
+    ]

ram/portal/migrations/0012_md_to_html.py

@@ -0,0 +1,38 @@
+# Generated by Django 4.1 on 2022-08-24 15:00
+
+import markdown
+from django.db import migrations
+
+
+def md_to_html(apps, schema_editor):
+    fields = {
+        "SiteConfiguration": ["about", "footer", "footer_extended"],
+        "Flatpage": ["content"]
+    }
+
+    for m in fields.items():
+        model = apps.get_model("portal", m[0])
+
+        for row in model.objects.all():
+            for field in m[1]:
+                html = markdown.markdown(getattr(row, field))
+                row.__dict__[field] = html
+
+            row.save(update_fields=m[1])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        (
+            "portal",
+            "0011_alter_flatpage_content_alter_siteconfiguration_about_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            md_to_html,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

ram/portal/migrations/0013_remove_flatpage_draft_flatpage_published.py

@@ -0,0 +1,42 @@
+# Generated by Django 4.1 on 2022-08-25 10:18
+
+from django.db import migrations, models
+
+
+def reverse_bool(apps, schema_editor):
+    model = apps.get_model("portal", "Flatpage")
+
+    for row in model.objects.all():
+        row.published = not row.draft
+        row.save(update_fields=["published"])
+
+
+def reverse_bool_back(apps, schema_editor):
+    model = apps.get_model("portal", "Flatpage")
+
+    for row in model.objects.all():
+        row.draft = not row.published
+        row.save(update_fields=["draft"])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("portal", "0012_md_to_html"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="flatpage",
+            name="published",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.RunPython(
+            reverse_bool,
+            reverse_code=reverse_bool_back
+        ),
+        migrations.RemoveField(
+            model_name="flatpage",
+            name="draft",
+        ),
+    ]

ram/portal/models.py

@@ -1,8 +1,15 @@
 import django
 from django.db import models
+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 ram import __version__ as app_version
-from solo.models import SingletonModel
+from ram.utils import slugify
 
 
 class SiteConfiguration(SingletonModel):
@@ -10,7 +17,7 @@ class SiteConfiguration(SingletonModel):
         max_length=256, default="Railroad Assets Manager"
     )
     site_author = models.CharField(max_length=256, blank=True)
-    about = models.TextField(blank=True)
+    about = RichTextField(blank=True)
     items_per_page = models.CharField(
         max_length=2,
         choices=[(str(x * 3), str(x * 3)) for x in range(2, 11)],
@@ -25,8 +32,8 @@ class SiteConfiguration(SingletonModel):
         ],
         default="type",
     )
-    footer = models.TextField(blank=True)
-    footer_extended = models.TextField(blank=True)
+    footer = RichTextField(blank=True)
+    footer_extended = RichTextField(blank=True)
     show_version = models.BooleanField(default=True)
 
     class Meta:
@@ -40,3 +47,31 @@ class SiteConfiguration(SingletonModel):
 
     def django_version(self):
         return django.get_version()
+
+
+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()
+    creation_time = models.DateTimeField(auto_now_add=True)
+    updated_time = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        return self.name
+
+    def get_absolute_url(self):
+        return reverse("flatpage", kwargs={"flatpage": self.path})
+
+    def get_link(self):
+        if self.published:
+            return mark_safe(
+                '<a href="{0}" target="_blank">Link</a>'.format(
+                    self.get_absolute_url()
+                )
+            )
+
+
+@receiver(models.signals.pre_save, sender=Flatpage)
+def tag_pre_save(sender, instance, **kwargs):
+    instance.path = slugify(instance.name)

ram/portal/static/css/main.css

@@ -23,6 +23,15 @@ a.badge, a.badge:hover {
   padding: .5rem;
 }
 
+#nav-journal ul, #nav-journal ol {
+  margin: 0;
+  padding-left: 1rem;
+}
+
+#nav-journal p {
+  margin: 0;
+}
+
 #footer > p {
   display: inline;
 }

ram/portal/templates/base.html

@@ -1,6 +1,6 @@
 {% load static %}
 {% load solo_tags %}
-{% load markdown %}
+{% load show_menu %}
 {% get_solo 'portal.SiteConfiguration' as site_conf %}
 
 <!doctype html>
@@ -71,8 +71,9 @@
                 <li class="nav-item">
                   <a class="nav-link" href="{% url 'scales' %}">Scales</a>
                 </li>
+                {% show_menu %}
               </ul>
-                    {% include 'includes/search.html' %}
+              {% include 'includes/search.html' %}
             </div>
           </div>
         </nav>
@@ -84,7 +85,7 @@
           </div>
         </div>
       </section>
-      <div class="album py-5 bg-light">
+      <div class="album py-4 bg-light">
         <div class="container">
           <a id="rolling-stock"></a>
           <div class="row row-cols-1 row-cols-sm-2 row-cols-md-3 g-3">

ram/portal/templates/companies.html

@@ -1,5 +1,4 @@
 {% extends "base.html" %}
-{% load markdown %}
 
       {% block header %}
         <h1 class="fw-light">Companies</h1>
@@ -57,10 +56,10 @@
       {% block pagination %}
       {% if company.has_other_pages %}
       <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4">
+        <ul class="pagination justify-content-center mt-4 mb-0">
           {% if company.has_previous %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'company_pagination' page=company.previous_page_number %}#rolling-stock" tabindex="-1">Previous</a>
+            <a class="page-link" href="{% url 'companies_pagination' page=company.previous_page_number %}#rolling-stock" tabindex="-1">Previous</a>
           </li>
           {% else %}
           <li class="page-item disabled">
@@ -76,13 +75,13 @@
               {% if i == company.paginator.ELLIPSIS %}
               <li class="page-item"><span class="page-link">{{ i }}</span></li>
               {% else %}
-              <li class="page-item"><a class="page-link" href="{% url 'company_pagination' page=i %}#rolling-stock">{{ i }}</a></li>
+              <li class="page-item"><a class="page-link" href="{% url 'companies_pagination' page=i %}#rolling-stock">{{ i }}</a></li>
               {% endif %}
             {% endif %}
           {% endfor %}
           {% if company.has_next %}
           <li class="page-item">
-            <a class="page-link" href="{% url 'company_pagination' page=company.next_page_number %}#rolling-stock" tabindex="-1">Next</a>
+            <a class="page-link" href="{% url 'companies_pagination' page=company.next_page_number %}#rolling-stock" tabindex="-1">Next</a>
           </li>
           {% else %}
           <li class="page-item disabled">

ram/portal/templates/consist.html

@@ -1,5 +1,4 @@
 {% extends "base.html" %}
-{% load markdown %}
 
       {% block header %}
       <h1 class="fw-light">{{ consist }}</h1>
@@ -103,7 +102,7 @@
       {% block pagination %}
       {% if rolling_stock.has_other_pages %}
       <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4">
+        <ul class="pagination justify-content-center mt-4 mb-0">
           {% if rolling_stock.has_previous %}
           <li class="page-item">
             <a class="page-link" href="{% url 'consist_pagination' uuid=consist.uuid page=rolling_stock.previous_page_number %}#rolling-stock" tabindex="-1">Previous</a>

ram/portal/templates/consists.html

@@ -1,5 +1,4 @@
 {% extends "base.html" %}
-{% load markdown %}
 
       {% block header %}
         <h1 class="fw-light">Consists</h1>
@@ -8,7 +7,17 @@
       {% for c in consist %}
       <div class="col">
         <div class="card shadow-sm">
-          {% if c.image %}<a href="{{ c.get_absolute_url }}"><img src="{{ c.image.url }}" alt="Card image cap"></a>{% endif %}
+          <a href="{{ c.get_absolute_url }}">
+          {% if c.image %}
+            <img src="{{ c.image.url }}" alt="Card image cap">
+          {% else %}
+            {% with c.consist_item.first.rolling_stock as r %}
+            {% for i in r.image.all %}
+              {% if i.is_thumbnail %}<img src="{{ i.image.url }}" alt="Card image cap">{% endif %}
+            {% endfor %}
+            {% endwith %}
+          {% endif %}
+          </a>
           <div class="card-body">
             <p class="card-text" style="position: relative;">
               <strong>{{ c }}</strong>
@@ -60,7 +69,7 @@
       {% block pagination %}
       {% if consist.has_other_pages %}
       <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4">
+        <ul class="pagination justify-content-center mt-4 mb-0">
           {% if consist.has_previous %}
           <li class="page-item">
             <a class="page-link" href="{% url 'consists_pagination' page=consist.previous_page_number %}#rolling-stock" tabindex="-1">Previous</a>

ram/portal/templates/flatpage.html

@@ -0,0 +1,18 @@
+{% extends 'base.html' %}
+
+        {% block header %}
+        <h1 class="fw-light">{{ flatpage.name }}</h1>
+        <small class="text-muted">Updated {{ flatpage.updated_time | date:"M d, Y H:i" }}</small>
+        {% endblock %}
+        {% block extra_content %}
+        <section class="py-4 text-start container">
+          <div class="row">
+            <div class="mx-auto">
+              <div>{{ flatpage.content | safe }} </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:portal_flatpage_change' flatpage.pk %}">Edit</a>{% endif %}
+              </div>
+            </div>
+          </div>
+        </section>
+        {% endblock %}

ram/portal/templates/flatpage_menu.html

@@ -0,0 +1,12 @@
+                {% if menu %}
+                <li class="nav-item dropdown">
+                  <a class="nav-link dropdown-toggle" href="#" id="navbarDropdownMenuLink" role="button" data-bs-toggle="dropdown" aria-expanded="false">
+                    More ...
+                  </a>
+                  <ul class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
+                  {% for m in menu %}
+                    <li><a class="dropdown-item" href="{{ m.get_absolute_url }}">{{ m.name }}</a></li>
+                  {% endfor %}
+                  </ul>
+                </li>
+                {% endif %}

ram/portal/templates/home.html

@@ -1,15 +1,14 @@
 {% extends "base.html" %}
-{% load markdown %}
 
       {% block header %}
         {% if site_conf.about %}<h1 class="fw-light">About</h1>{% endif %}
-        <p class="lead text-muted">{{ site_conf.about | markdown | safe }}</p>
+        <p class="lead text-muted">{{ site_conf.about | safe }}</p>
       {% endblock %}
 
       {% block pagination %}
       {% if rolling_stock.has_other_pages %}
       <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4">
+        <ul class="pagination justify-content-center mt-4 mb-0">
           {% if rolling_stock.has_previous %}
           <li class="page-item">
             <a class="page-link" href="{% url 'index_pagination' page=rolling_stock.previous_page_number %}#rolling-stock" tabindex="-1">Previous</a>

ram/portal/templates/includes/footer.html

@@ -1,15 +1,13 @@
-{% load markdown %}
-
   <footer class="text-muted py-4">
     <div class="container">
       <p class="float-end mb-1">
         <a href="#">Back to top</a>
       </p>
       <div id="footer" class="mb-1">
-          <p>&copy; {% now "Y" %}</p> {{ site_conf.footer | markdown | safe }}
+          <p>&copy; {% now "Y" %}</p> {{ site_conf.footer | safe }}
       </div>
       <div id="footer_extended" class="mb-0">
-        {{ site_conf.footer_extended | markdown | safe }}
+        {{ site_conf.footer_extended | safe }}
       </div>
     </div>
 

ram/portal/templates/includes/login.html

@@ -7,6 +7,7 @@
           <li><a class="dropdown-item" href="{% url 'admin:roster_rollingstock_changelist' %}">Rolling stock</a></li>
           <li><a class="dropdown-item" href="{% url 'admin:consist_consist_changelist' %}">Consists</a></li>
           <li><a class="dropdown-item" href="{% url 'admin:app_list' 'metadata' %}">Metadata</a></li>
+          <li><a class="dropdown-item" href="{% url 'admin:portal_flatpage_changelist' %}">Pages</a></li>
           <li><hr class="dropdown-divider"></li>
           <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>

ram/portal/templates/page.html

@@ -1,5 +1,4 @@
 {% extends 'base.html' %}
-{% load markdown %}
 
         {% block header %}
         <h1 class="fw-light">{{ rolling_stock }}</h1>
@@ -15,7 +14,24 @@
         {% block cards %}
         {% for t in rolling_stock.image.all %}
         <div class="col">
-          <img class="img-thumbnail" src="{{ t.image.url }}" alt="Rolling stock image">
+            <a href="" data-bs-toggle="modal" data-bs-target="#pictureModal{{ forloop.counter }}"><img class="img-thumbnail" src="{{ t.image.url }}" alt="Rolling stock image"></a>
+        </div>
+        <!-- Modal -->
+        <div class="modal fade" id="pictureModal{{ forloop.counter }}" tabindex="-1" aria-labelledby="pictureModalLabel{{ forloop.counter }}" aria-hidden="true">
+          <div class="modal-dialog modal-lg">
+            <div class="modal-content">
+              <div class="modal-header">
+                <h5 class="modal-title" id="pictureModalLabel{{ forloop.counter }}">{{ rolling_stock }}</h5>
+                <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+              </div>
+              <div class="modal-body text-center">
+                  <img class="rounded img-fluid" src="{{ t.image.url }}" alt="Rolling stock image">
+              </div>
+              <div class="modal-footer">
+                <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
+              </div>
+            </div>
+          </div>
         </div>
         {% endfor %}
         {% endblock %}
@@ -31,6 +47,7 @@
                   {% if rolling_stock.decoder %}<button class="nav-link" id="nav-dcc-tab" data-bs-toggle="tab" data-bs-target="#nav-dcc" type="button" role="tab" aria-controls="nav-dcc" aria-selected="false">DCC</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 rolling_stock.document.count > 0 %}<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 rolling_stock_journal.count > 0 %}<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 %}
                  </div>
               </nav>
               <div class="tab-content" id="nav-tabContent">
@@ -85,7 +102,7 @@
                       </tr>
                     </tbody>
                   </table>
-                  {% if rolling_stock.decoder %}
+                  {% if rolling_stock.decoder or rolling_stock.decoder_interface %}
                   <table class="table table-striped">
                     <thead>
                       <tr>
@@ -94,13 +111,19 @@
                     </thead>
                     <tbody>
                       <tr>
-                        <th width="35%" scope="row">Decoder</th>
+                        <th width="35%" scope="row">Interface</th>
+                        <td>{{ rolling_stock.get_decoder_interface_display }}</td>
+                      </tr>
+                      {% if rolling_stock.decoder %}
+                      <tr>
+                        <th scope="row">Decoder</th>
                         <td>{{ rolling_stock.decoder }}</td>
                       </tr>
                       <tr>
                         <th scope="row">Address</th>
                         <td>{{ rolling_stock.address }}</td>
                       </tr>
+                      {% endif %}
                     </tbody>
                   </table>
                   {% endif %}
@@ -213,6 +236,10 @@
                       </tr>
                     </thead>
                     <tbody>
+                      <tr>
+                        <th scope="row">Interface</th>
+                        <td>{{ rolling_stock.get_decoder_interface_display }}</td>
+                      </tr>
                       <tr>
                         <th width="35%" scope="row">Address</th>
                         <td>{{ rolling_stock.address }}</td>
@@ -229,10 +256,6 @@
                         <th scope="row">Version</th>
                         <td>{{ rolling_stock.decoder.version }}</td>
                       </tr>
-                      <tr>
-                        <th scope="row">Interface</th>
-                        <td>{{ rolling_stock.decoder.get_interface_display }}</td>
-                      </tr>
                       <tr>
                         <th scope="row">Sound</th>
                         <td>{{ rolling_stock.decoder.sound | yesno:"Yes,No" }}</td>
@@ -241,7 +264,7 @@
                   </table>
                 </div>
                 <div class="tab-pane fade" id="nav-notes" role="tabpanel" aria-labelledby="nav-notes-tab">
-                  {{ rolling_stock.notes | markdown | safe }}
+                  {{ rolling_stock.notes | safe }}
                 </div>
                 <div class="tab-pane fade" id="nav-documents" role="tabpanel" aria-labelledby="nav-documents-tab">
                   <table class="table table-striped">
@@ -261,6 +284,23 @@
                     </tbody>
                   </table>
                 </div>
+                <div class="tab-pane fade" id="nav-journal" role="tabpanel" aria-labelledby="nav-journal-tab">
+                  <table class="table table-striped">
+                    <thead>
+                      <tr>
+                        <th colspan="3" scope="row">Journal</th>
+                      </tr>
+                    </thead>
+                    <tbody>
+                    {% for j in rolling_stock_journal %}
+                      <tr>
+                          <th width="35%" scope="row">{{ j.date }}</th>
+                        <td>{{ j.log | safe }}</a></td>
+                      </tr>
+                    {% endfor %}
+                    </tbody>
+                  </table>
+                </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:roster_rollingstock_change' rolling_stock.pk %}">Edit</a>{% endif %}

ram/portal/templates/scales.html

@@ -1,5 +1,4 @@
 {% extends "base.html" %}
-{% load markdown %}
 
       {% block header %}
         <h1 class="fw-light">Scales</h1>
@@ -47,7 +46,7 @@
       {% block pagination %}
       {% if scale.has_other_pages %}
       <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4">
+        <ul class="pagination justify-content-center mt-4 mb-0">
           {% if scale.has_previous %}
           <li class="page-item">
             <a class="page-link" href="{% url 'scale_pagination' page=scale.previous_page_number %}#rolling-stock" tabindex="-1">Previous</a>

ram/portal/templates/search.html

@@ -7,7 +7,7 @@
       {% block pagination %}
       {% if rolling_stock.has_other_pages %}
       <nav aria-label="Page navigation example">
-        <ul class="pagination justify-content-center mt-4">
+        <ul class="pagination justify-content-center mt-4 mb-0">
           {% if rolling_stock.has_previous %}
           <li class="page-item">
             <a class="page-link" href="{% url 'filtered_pagination' _filter=filter search=search page=rolling_stock.previous_page_number %}#rolling-stock" tabindex="-1">Previous</a>

ram/portal/templatetags/show_menu.py

@@ -0,0 +1,10 @@
+from django import template
+from portal.views import Flatpage
+
+register = template.Library()
+
+
+@register.inclusion_tag('flatpage_menu.html')
+def show_menu():
+    menu = Flatpage.objects.filter(published=True).order_by("name")
+    return {"menu": menu}

ram/portal/urls.py

@@ -3,6 +3,7 @@ from django.urls import path
 from portal.views import (
     GetHome,
     GetHomeFiltered,
+    GetFlatpage,
     GetRollingStock,
     GetConsist,
     Consists,
@@ -13,6 +14,11 @@ from portal.views import (
 urlpatterns = [
     path("", GetHome.as_view(), name="index"),
     path("<int:page>", GetHome.as_view(), name="index_pagination"),
+    path(
+        "page/<str:flatpage>",
+        GetFlatpage.as_view(),
+        name="flatpage",
+    ),
     path(
         "search",
         GetHomeFiltered.as_view(http_method_names=["post"]),
@@ -32,14 +38,10 @@ urlpatterns = [
     path(
         "companies/<int:page>",
         Companies.as_view(),
-        name="companies_pagination"
+        name="companies_pagination",
     ),
     path("scales", Scales.as_view(), name="scales"),
-    path(
-        "scales/<int:page>",
-        Scales.as_view(),
-        name="scales_pagination"
-    ),
+    path("scales/<int:page>", Scales.as_view(), name="scales_pagination"),
     path(
         "<str:_filter>/<str:search>",
         GetHomeFiltered.as_view(),

ram/portal/views.py

@@ -6,9 +6,10 @@ from django.http import Http404
 from django.db.models import Q
 from django.shortcuts import render
 from django.core.exceptions import ObjectDoesNotExist
-from django.core.paginator import Paginator, EmptyPage, PageNotAnInteger
+from django.core.paginator import Paginator, PageNotAnInteger
 
 from portal.utils import get_site_conf
+from portal.models import Flatpage
 from roster.models import RollingStock
 from consist.models import Consist
 from metadata.models import Company, Scale
@@ -61,6 +62,7 @@ class GetHomeFiltered(View):
                         | Q(rolling_class__description__icontains=s)
                         | Q(rolling_class__type__type__icontains=s)
                         | Q(road_number__icontains=s)
+                        | Q(sku=s)
                         | Q(rolling_class__company__name__icontains=s)
                         | Q(rolling_class__company__country__icontains=s)
                         | Q(manufacturer__name__icontains=s)
@@ -152,6 +154,12 @@ class GetRollingStock(View):
             else rolling_stock.property.filter(property__private=False)
         )
 
+        rolling_stock_journal = (
+            rolling_stock.journal.all()
+            if request.user.is_authenticated
+            else rolling_stock.journal.filter(private=False)
+        )
+
         return render(
             request,
             "page.html",
@@ -159,6 +167,7 @@ class GetRollingStock(View):
                 "rolling_stock": rolling_stock,
                 "class_properties": class_properties,
                 "rolling_stock_properties": rolling_stock_properties,
+                "rolling_stock_journal": rolling_stock_journal,
             },
         )
 
@@ -241,3 +250,19 @@ class Scales(View):
             "scales.html",
             {"scale": scale, "page_range": page_range},
         )
+
+
+class GetFlatpage(View):
+    def get(self, request, flatpage):
+        try:
+            flatpage = Flatpage.objects.get(
+                Q(Q(path=flatpage) & Q(published=True))
+            )
+        except ObjectDoesNotExist:
+            raise Http404
+
+        return render(
+            request,
+            "flatpage.html",
+            {"flatpage": flatpage},
+        )

ram/ram/__init__.py

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

ram/ram/settings.py

@@ -11,6 +11,7 @@ https://docs.djangoproject.com/en/4.0/ref/settings/
 """
 
 import os
+import time
 from pathlib import Path
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
@@ -45,6 +46,8 @@ INSTALLED_APPS = [
     "adminsortable2",
     "django_countries",
     "solo",
+    "ckeditor",
+    "ckeditor_uploader",
     "rest_framework",
     "ram",
     "portal",
@@ -139,6 +142,7 @@ DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
 
 MEDIA_URL = "media/"
 MEDIA_ROOT = STORAGE_DIR / "media"
+CKEDITOR_UPLOAD_PATH = "uploads/"
 
 COUNTRIES_OVERRIDE = {
     "ZZ": "Freelance",

ram/ram/urls.py

@@ -21,6 +21,7 @@ from django.urls import include, path
 
 urlpatterns = [
     path("", lambda r: redirect("portal/")),
+    path("ckeditor/", include("ckeditor_uploader.urls")),
     path("portal/", include("portal.urls")),
     path("ht/", include("health_check.urls")),
     path("admin/", admin.site.urls),

ram/roster/admin.py

@@ -6,6 +6,7 @@ from roster.models import (
     RollingStockImage,
     RollingStockDocument,
     RollingStockProperty,
+    RollingStockJournal,
 )
 
 
@@ -31,6 +32,7 @@ class RollingStockDocInline(admin.TabularInline):
     model = RollingStockDocument
     min_num = 0
     extra = 0
+    classes = ["collapse"]
 
 
 class RollingStockImageInline(admin.TabularInline):
@@ -38,6 +40,7 @@ class RollingStockImageInline(admin.TabularInline):
     min_num = 0
     extra = 0
     readonly_fields = ("image_thumbnail",)
+    classes = ["collapse"]
 
 
 class RollingStockPropertyInline(admin.TabularInline):
@@ -46,12 +49,56 @@ class RollingStockPropertyInline(admin.TabularInline):
     extra = 0
 
 
+class RollingStockJournalInline(admin.TabularInline):
+    model = RollingStockJournal
+    min_num = 0
+    extra = 0
+    classes = ["collapse"]
+
+
+@admin.register(RollingStockDocument)
+class RollingStockDocumentAdmin(admin.ModelAdmin):
+    list_display = (
+        "__str__",
+        "rolling_stock",
+        "description",
+        "download",
+    )
+    search_fields = (
+        "rolling_stock__rolling_class__identifier",
+        "rolling_stock__sku",
+        "description",
+        "file",
+    )
+
+
+@admin.register(RollingStockJournal)
+class RollingJournalDocumentAdmin(admin.ModelAdmin):
+    list_display = (
+        "__str__",
+        "date",
+        "rolling_stock",
+        "private",
+    )
+    list_filter = (
+        "date",
+        "private",
+    )
+    search_fields = (
+        "rolling_stock__rolling_class__identifier",
+        "rolling_stock__road_number",
+        "rolling_stock__sku",
+        "log",
+    )
+
+
 @admin.register(RollingStock)
 class RollingStockAdmin(admin.ModelAdmin):
     inlines = (
         RollingStockPropertyInline,
         RollingStockImageInline,
         RollingStockDocInline,
+        RollingStockJournalInline,
     )
     readonly_fields = ("creation_time", "updated_time")
     list_display = (
@@ -101,6 +148,7 @@ class RollingStockAdmin(admin.ModelAdmin):
             "DCC",
             {
                 "fields": (
+                    "decoder_interface",
                     "decoder",
                     "address",
                 )

ram/roster/migrations/0010_alter_rollingstock_notes.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.1 on 2022-08-23 15:54
+
+import ckeditor_uploader.fields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0009_alter_rollingstock_options_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="rollingstock",
+            name="notes",
+            field=ckeditor_uploader.fields.RichTextUploadingField(blank=True),
+        ),
+    ]

ram/roster/migrations/0011_md_to_html.py

@@ -0,0 +1,34 @@
+# Generated by Django 4.1 on 2022-08-24 15:30
+
+import markdown
+from django.db import migrations
+
+
+def md_to_html(apps, schema_editor):
+    fields = {
+        "RollingStock": ["notes"],
+    }
+
+    for m in fields.items():
+        model = apps.get_model("roster", m[0])
+
+        for row in model.objects.all():
+            for field in m[1]:
+                html = markdown.markdown(getattr(row, field))
+                row.__dict__[field] = html
+
+            row.save(update_fields=m[1])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0010_alter_rollingstock_notes"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            md_to_html,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

ram/roster/migrations/0012_rollingstockjournal.py

@@ -0,0 +1,45 @@
+# Generated by Django 4.1 on 2022-08-27 12:43
+
+import ckeditor_uploader.fields
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0011_md_to_html"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="RollingStockJournal",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("date", models.DateField()),
+                ("log", ckeditor_uploader.fields.RichTextUploadingField()),
+                ("private", models.BooleanField(default=False)),
+                ("creation_time", models.DateTimeField(auto_now_add=True)),
+                ("updated_time", models.DateTimeField(auto_now=True)),
+                (
+                    "rolling_stock",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="journal",
+                        to="roster.rollingstock",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["date", "rolling_stock"],
+            },
+        ),
+    ]

ram/roster/migrations/0013_rollingstock_decoder_interface.py

@@ -0,0 +1,42 @@
+# Generated by Django 4.1 on 2022-10-31 22:27
+
+from django.db import migrations, models
+
+
+def meta_to_roster(apps, schema_editor):
+    model = apps.get_model("roster", "RollingStock")
+
+    for row in model.objects.all():
+        if row.decoder:
+            decoder_interface = row.decoder.interface
+            row.__dict__["decoder_interface"] = decoder_interface
+            row.save(update_fields=["decoder_interface"])
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("roster", "0012_rollingstockjournal"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="rollingstock",
+            name="decoder_interface",
+            field=models.PositiveSmallIntegerField(
+                blank=True,
+                choices=[
+                    (1, "NEM651"),
+                    (2, "NEM652"),
+                    (3, "PluX"),
+                    (4, "21MTC"),
+                    (5, "Next18/Next18S"),
+                ],
+                null=True,
+            ),
+        ),
+        migrations.RunPython(
+            meta_to_roster,
+            reverse_code=migrations.RunPython.noop
+        ),
+    ]

ram/roster/models.py

@@ -3,9 +3,11 @@ import re
 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 django.utils.safestring import mark_safe
 
-# from django.core.files.storage import FileSystemStorage
+from ckeditor_uploader.fields import RichTextUploadingField
 
 from ram.utils import get_image_preview
 from metadata.models import (
@@ -86,6 +88,9 @@ class RollingStock(models.Model):
     )
     scale = models.ForeignKey(Scale, on_delete=models.CASCADE)
     sku = models.CharField(max_length=32, blank=True)
+    decoder_interface = models.PositiveSmallIntegerField(
+        choices=settings.DECODER_INTERFACES, null=True, blank=True
+    )
     decoder = models.ForeignKey(
         Decoder, on_delete=models.CASCADE, null=True, blank=True
     )
@@ -93,7 +98,7 @@ class RollingStock(models.Model):
     era = models.CharField(max_length=32, blank=True)
     production_year = models.SmallIntegerField(null=True, blank=True)
     purchase_date = models.DateField(null=True, blank=True)
-    notes = models.TextField(blank=True)
+    notes = RichTextUploadingField(blank=True)
     tags = models.ManyToManyField(
         Tag, related_name="rolling_stock", blank=True
     )
@@ -141,7 +146,12 @@ class RollingStockDocument(models.Model):
         return "{0}".format(os.path.basename(self.file.name))
 
     def filename(self):
-        return os.path.basename(self.file.name)
+        return self.__str__()
+
+    def download(self):
+        return mark_safe(
+            '<a href="{0}" target="_blank">Link</a>'.format(self.file.url)
+        )
 
 
 class RollingStockImage(models.Model):
@@ -185,6 +195,27 @@ class RollingStockProperty(models.Model):
         verbose_name_plural = "Properties"
 
 
+class RollingStockJournal(models.Model):
+    rolling_stock = models.ForeignKey(
+        RollingStock,
+        on_delete=models.CASCADE,
+        related_name="journal",
+        null=False,
+        blank=False,
+    )
+    date = models.DateField()
+    log = RichTextUploadingField()
+    private = models.BooleanField(default=False)
+    creation_time = models.DateTimeField(auto_now_add=True)
+    updated_time = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        return "{0} - {1}".format(self.rolling_stock, self.date)
+
+    class Meta:
+        ordering = ["date", "rolling_stock"]
+
+
 # @receiver(models.signals.post_delete, sender=Cab)
 # def post_save_image(sender, instance, *args, **kwargs):
 #     try:

requirements.txt

@@ -7,5 +7,6 @@ django-solo
 django-countries
 django-health-check
 django-admin-sortable2
+django-ckeditor
 # psycopg2-binary
 pySerial