Production Update (version...?)

.github/workflows/cd_prod.yml

@@ -0,0 +1,45 @@
+name: Deploy to Production Server
+on: workflow_dispatch
+
+concurrency:
+  group: production
+  cancel-in-progress: true
+
+jobs:
+  deploy-production:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the current repo
+        uses: actions/checkout@v5
+      - name: Install SSH Key
+        uses: shimataro/ssh-key-action@v2
+        with:
+          key: ${{ secrets.KEY }}
+          known_hosts: ${{ secrets.KNOWN_HOSTS }}
+      - name: Stop the current Docker containers running
+        run: |
+          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST_PROD }} ${{ secrets.USERNAME }}@${{ secrets.HOST_PROD }} \
+            "cd /virtual-instrument-museum &&
+             sudo docker compose stop"
+      - name: Fetch new updates from remote `origin` and log current branches
+        run: |
+          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST_PROD }} ${{ secrets.USERNAME }}@${{ secrets.HOST_PROD }} \
+            "cd /virtual-instrument-museum &&
+             sudo git fetch origin -v &&
+             sudo git branch -v"
+      - name: Checkout to `main` branch and pull new changes 
+        run: |
+          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST_PROD }} ${{ secrets.USERNAME }}@${{ secrets.HOST_PROD }} \
+            "cd /virtual-instrument-museum &&
+             sudo git checkout main &&
+             sudo git pull origin main"
+      - name: Build docker images
+        run: |
+          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST_PROD }} ${{ secrets.USERNAME }}@${{ secrets.HOST_PROD }} \
+            "cd /virtual-instrument-museum &&
+             sudo docker compose build --no-cache"
+      - name: Start the services
+        run: |
+          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST_PROD }} ${{ secrets.USERNAME }}@${{ secrets.HOST_PROD }} \
+            "cd /virtual-instrument-museum &&
+             sudo docker compose up -d"

.github/workflows/cd_stage.yml

@@ -1,5 +1,5 @@
 name: Deploy to staging Server
-on: 
+on:
   push:
     branches:
       - "develop"
@@ -21,16 +21,27 @@ jobs:
           known_hosts: ${{ secrets.KNOWN_HOSTS }}
       - name: Stop docker swarm and cleanup services
         run: |
-          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST2 }} ${{ secrets.USERNAME }}@${{ secrets.HOST }} "cd /virtual_instrument_museum && sudo docker compose stop"
+          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST2 }} ${{ secrets.USERNAME }}@${{ secrets.HOST }} \
+            "cd /virtual_instrument_museum &&
+             sudo docker compose stop"
       - name: Log git branch we're on
         run: |
-          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST2 }} ${{ secrets.USERNAME }}@${{ secrets.HOST }} "cd /virtual_instrument_museum && sudo git branch --all -v"
+          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST2 }} ${{ secrets.USERNAME }}@${{ secrets.HOST }} \
+            "cd /virtual_instrument_museum &&
+             sudo git branch --all -v"
       - name: Fetch on dev branch
         run: |
-          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST2 }} ${{ secrets.USERNAME }}@${{ secrets.HOST }} "cd /virtual_instrument_museum && sudo git fetch origin develop && sudo git merge origin/develop"
+          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST2 }} ${{ secrets.USERNAME }}@${{ secrets.HOST }} \
+            "cd /virtual_instrument_museum &&
+             sudo git fetch origin develop &&
+             sudo git merge origin/develop"
       - name: Build docker images
         run: |
-          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST2 }} ${{ secrets.USERNAME }}@${{ secrets.HOST }} "cd /virtual_instrument_museum && sudo docker compose build"
+          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST2 }} ${{ secrets.USERNAME }}@${{ secrets.HOST }} \
+            "cd /virtual_instrument_museum &&
+             sudo docker compose build --no-cache"
       - name: Start the service
         run: |
-          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST2 }} ${{ secrets.USERNAME }}@${{ secrets.HOST }} "cd /virtual_instrument_museum && sudo docker compose up -d"
+          ssh -J ${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST1 }},${{ secrets.PROXY_USERNAME }}@${{ secrets.PROXY_HOST2 }} ${{ secrets.USERNAME }}@${{ secrets.HOST }} \
+            "cd /virtual_instrument_museum &&
+             sudo docker compose up -d"

.github/workflows/frontend_format.yml

@@ -20,7 +20,9 @@ jobs:
         run: poetry install --no-root
 
       - name: Run djlint via Poetry
-        run: poetry run djlint . --check --extension html --exclude "migrations/*"
+        run: |
+          cd web-app/django/VIM/templates/
+          poetry run djlint . --check --extension html --exclude "migrations/*"
 
       - name: Set up Node.js
         uses: actions/setup-node@v4

prettierrc.yml

@@ -10,3 +10,6 @@ overrides:
   - files: "*.js"
     options:
       trailingComma: "es5"
+  - files: "*.html"
+    options:
+      parser: django

web-app/django/VIM/apps/instruments/admin.py

@@ -2,6 +2,31 @@
 from VIM.apps.instruments.models import Instrument, InstrumentName, Language, AVResource
 
 admin.site.register(Instrument)
-admin.site.register(InstrumentName)
 admin.site.register(Language)
 admin.site.register(AVResource)
+
+
+@admin.register(InstrumentName)
+class InstrumentNameAdmin(admin.ModelAdmin):
+    list_filter = ("verification_status", "on_wikidata")  # Filter by status
+    search_fields = (
+        "name",
+        "source_name",
+        "instrument__wikidata_id",
+    )  # Search by name, source name, and instrument wikidata ID
+
+    def get_readonly_fields(self, request, obj=None):
+        """
+        Make all fields except 'verification_status' read-only for users in the 'reviewer' group.
+        """
+        if request.user.groups.filter(name="reviewer").exists():
+            return (
+                "instrument",
+                "language",
+                "name",
+                "source_name",
+                "umil_label",
+                "contributor",
+                "on_wikidata",
+            )
+        return super().get_readonly_fields(request, obj)

web-app/django/VIM/apps/instruments/management/commands/import_instruments.py

@@ -4,6 +4,8 @@
 import os
 from typing import Optional
 import requests
+from django.conf import settings
+from django.contrib.auth import get_user_model
 from django.core.management.base import BaseCommand
 from django.db import transaction
 from VIM.apps.instruments.models import Instrument, InstrumentName, Language, AVResource
@@ -23,6 +25,12 @@ class Command(BaseCommand):
     def __init__(self):
         super().__init__()
         self.language_map: dict[str, Language] = {}
+        User = get_user_model()
+        self.default_contributor = User.objects.get(username=settings.DDMAL_USERNAME)
+        if not self.default_contributor:
+            raise ValueError(
+                f"Default contributor {settings.DDMAL_USERNAME} not found in the database."
+            )
 
     def parse_instrument_data(
         self, instrument_id: str, instrument_data: dict
@@ -48,6 +56,11 @@ def parse_instrument_data(
         ins_names: dict[str, str] = {
             value["language"]: value["value"] for key, value in ins_labels.items()
         }
+        ins_aliases: dict = instrument_data["aliases"]
+        ins_aliases_dict: dict[str, list[str]] = {
+            key: [alias["value"] for alias in value]
+            for key, value in ins_aliases.items()
+        }
         # Get Hornbostel-Sachs and MIMO classifications, if available
         ins_hbs: Optional[list[dict]] = instrument_data["claims"].get("P1762")
         ins_mimo: Optional[list[dict]] = instrument_data["claims"].get("P3763")
@@ -64,6 +77,7 @@ def parse_instrument_data(
             "ins_names": ins_names,
             "hornbostel_sachs_class": hbs_class,
             "mimo_class": mimo_class,
+            "ins_aliases": ins_aliases_dict,
         }
         return parsed_data
 
@@ -80,7 +94,7 @@ def get_instrument_data(self, instrument_ids: list[str]) -> list[dict]:
         ins_ids_str: str = "|".join(instrument_ids)
         url = (
             "https://www.wikidata.org/w/api.php?action=wbgetentities&"
-            f"ids={ins_ids_str}&format=json&props=labels|descriptions|claims"
+            f"ids={ins_ids_str}&format=json&props=labels|descriptions|claims|aliases"
         )
         response = requests.get(url, timeout=10)
         response_entities = response.json()["entities"]
@@ -103,7 +117,10 @@ def create_database_objects(
         thumbnail_img_path [str]: Path to the thumbnail of the instrument image
         """
         ins_names = instrument_attrs.pop("ins_names")
+        ins_aliases = instrument_attrs.pop("ins_aliases")
         instrument, _ = Instrument.objects.update_or_create(**instrument_attrs)
+
+        # Create or update instrument labels in the database (umil_label=True)
         for lang, name in ins_names.items():
             # Skip if the language code is not found in the database.
             # This commonly happens for codes like "mul" (multiple languages),
@@ -121,7 +138,34 @@ def create_database_objects(
                 language=self.language_map[lang],
                 name=name,
                 source_name="Wikidata",
+                umil_label=True,
+                contributor=self.default_contributor,
+                verification_status="verified",
+                on_wikidata=True,
             )
+
+        # Create or update instrument aliases in the database (umil_label=False)
+        for lang, aliases in ins_aliases.items():
+            # Skip if the language code is not found in the database.
+            if lang not in self.language_map:
+                self.stdout.write(
+                    self.style.WARNING(
+                        f"Skipping language {lang} for instrument {instrument.wikidata_id} as the language is not found in the database."
+                    )
+                )
+                continue
+            for alias in aliases:
+                InstrumentName.objects.update_or_create(
+                    instrument=instrument,
+                    language=self.language_map[lang],
+                    name=alias,
+                    source_name="Wikidata",
+                    umil_label=False,
+                    contributor=self.default_contributor,
+                    verification_status="verified",
+                    on_wikidata=True,
+                )
+
         img_obj = AVResource.objects.create(
             instrument=instrument,
             type="image",

web-app/django/VIM/apps/instruments/migrations/0003_alter_avresource_instrument_and_more.py

@@ -5,7 +5,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("instruments", "0002_instrument_thumbnail"),
     ]

web-app/django/VIM/apps/instruments/migrations/0006_instrumentname_contributor_instrumentname_is_alias_and_more.py

@@ -0,0 +1,48 @@
+# Generated by Django 4.2.5 on 2025-05-30 15:29
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("instruments", "0005_remove_language_wikidata_id"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="instrumentname",
+            name="contributor",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="User who contributed this name",
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                to=settings.AUTH_USER_MODEL,
+            ),
+        ),
+        migrations.AddField(
+            model_name="instrumentname",
+            name="is_alias",
+            field=models.BooleanField(
+                default=False,
+                help_text="Is this an alias for the instrument? If true, it will not be used as the main name.",
+            ),
+        ),
+        migrations.AddField(
+            model_name="instrumentname",
+            name="status",
+            field=models.CharField(
+                choices=[
+                    ("verified", "Verified"),
+                    ("unverified", "Unverified"),
+                    ("uploaded", "Uploaded"),
+                ],
+                default="unverified",
+                help_text="Status of the name entry",
+                max_length=20,
+            ),
+        ),
+    ]

web-app/django/VIM/apps/instruments/migrations/0007_instrumentname_is_approved_and_more.py

@@ -0,0 +1,45 @@
+# Generated by Django 4.2.5 on 2025-06-16 13:54
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        (
+            "instruments",
+            "0006_instrumentname_contributor_instrumentname_is_alias_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="instrumentname",
+            name="is_approved",
+            field=models.BooleanField(
+                default=False,
+                help_text="When a name is approved to be visible on UMIL and uploaded to Wikidata.",
+            ),
+        ),
+        migrations.AddField(
+            model_name="instrumentname",
+            name="on_wikidata",
+            field=models.BooleanField(
+                default=False, help_text="Is this name already on Wikidata?"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="instrumentname",
+            name="status",
+            field=models.CharField(
+                choices=[
+                    ("verified", "Verified"),
+                    ("unverified", "Unverified"),
+                    ("needs_review", "Needs Review"),
+                    ("rejected", "Rejected"),
+                ],
+                default="unverified",
+                help_text="Status of the name entry",
+                max_length=20,
+            ),
+        ),
+    ]

web-app/django/VIM/apps/instruments/migrations/0008_rename_status_instrumentname_verification_status_and_more.py

@@ -0,0 +1,54 @@
+# Generated by Django 4.2.5 on 2025-08-07 17:10
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("instruments", "0007_instrumentname_is_approved_and_more"),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name="instrumentname",
+            old_name="status",
+            new_name="verification_status",
+        ),
+        migrations.RemoveField(
+            model_name="instrumentname",
+            name="is_alias",
+        ),
+        migrations.RemoveField(
+            model_name="instrumentname",
+            name="is_approved",
+        ),
+        migrations.AddField(
+            model_name="instrumentname",
+            name="umil_label",
+            field=models.BooleanField(
+                default=False,
+                help_text="Is this the label for the instrument? If true, it will be used as the main name.",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="instrumentname",
+            name="contributor",
+            field=models.ForeignKey(
+                help_text="User who contributed this name",
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                to=settings.AUTH_USER_MODEL,
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="instrumentname",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(("umil_label", True)),
+                fields=("instrument", "language"),
+                name="unique_umil_label_per_instrument_language",
+            ),
+        ),
+    ]