Added Prohibited List (STOCD#105)

Author: Kraust

OSCR_django/settings.py

@@ -52,6 +52,7 @@
     "combatlog.apps.CombatLogConfig",
     "ladder.apps.LadderConfig",
     "ui.apps.UIConfig",
+    "system.apps.SystemConfig",
 ]
 
 MIDDLEWARE = [

OSCR_django/urls.py

@@ -36,6 +36,7 @@
     path("", include("ladder.urls.ladder_entry")),
     path("", include("ladder.urls.variant")),
     path("", include("ui.urls.ui")),
+    path("", include("system.urls.update")),
 ]
 
 if settings.ADMIN_PATH:

VERSION

@@ -1 +1 @@
-2024.9.2.1
+2025.3.29.0

combatlog/admin.py

@@ -6,7 +6,7 @@
 
 from ladder.models import LadderEntry
 
-from .models import CombatLog, Metadata
+from .models import Ability, CombatLog, Metadata
 
 
 class LadderEntryInline(admin.StackedInline):
@@ -28,3 +28,8 @@ class MetadataAdmin(admin.ModelAdmin):
 class CombatLogAdmin(admin.ModelAdmin):
     inlines = [LadderEntryInline]
     exclude = ["metadata"]
+
+
+@admin.register(Ability)
+class AbilityAdmin(admin.ModelAdmin):
+    exclude = []

combatlog/fixtures/ability.json

@@ -0,0 +1,18 @@
+[
+    {
+        "model": "combatlog.Ability",
+        "pk": 1,
+        "fields": {
+            "name": "Dilithium Detonator Charge",
+            "prohibited": true
+        }
+    },
+    {
+        "model": "combatlog.Ability",
+        "pk": 2,
+        "fields": {
+            "name": "Dilithium Destructor Charge",
+            "prohibited": true
+        }
+    }
+]

combatlog/migrations/0004_ability.py

@@ -0,0 +1,24 @@
+# Generated by Django 5.1.7 on 2025-04-29 20:49
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('combatlog', '0003_metadata_damage_in_metadata_damage_out_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Ability',
+            fields=[
+                ('id', models.AutoField(primary_key=True, serialize=False)),
+                ('name', models.TextField()),
+                ('prohibited', models.BooleanField()),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

combatlog/models/__init__.py

@@ -1,2 +1,3 @@
 from .combatlog import *
 from .metadata import *
+from .ability import *

combatlog/models/ability.py

@@ -0,0 +1,15 @@
+"""Metadata Models"""
+
+from django.db import models
+
+from core.models import BaseModel
+
+
+class Ability(BaseModel):
+    """Combat Log Model"""
+
+    name = models.TextField()
+    prohibited = models.BooleanField()
+
+    def __str__(self):
+        return self.name + " (prohibited)" if self.prohibited else ""

combatlog/models/combatlog.py

@@ -15,6 +15,7 @@
 from core.models import BaseModel
 from ladder.models import BlockedHandle, Ladder, LadderEntry
 
+from .ability import Ability
 from .metadata import Metadata
 
 LOGGER = logging.getLogger("django")
@@ -99,6 +100,19 @@ def get_build(self, damage_out):
             return "Unknown"
         return damage_out[0]["name"]
 
+    def check_breakdown(self, damage_out):
+        """
+        Return the 'build' from the damage out entry.
+        This is a hack that will just return the top DPS ability.
+        """
+        if not len(damage_out):
+            return {"valid": True, "ability": ""}
+        for ability in damage_out:
+            for ab in Ability.objects.filter(prohibited=True):
+                if ab.name == ability["name"]:
+                    return {"valid": False, "ability": ab.name}
+        return {"valid": True, "ability": ""}
+
     def update_metadata_from_remote(self):
         """Updates Metadata from remote storage"""
         data = self.get_data()
@@ -135,6 +149,7 @@ def update_metadata_file(self, file, force=False):
         )
 
         # Add the damage out to the player.
+        valid_map = {}
         for idx, player in enumerate(players):
             handle = f"{player[1]['name']}{player[1]['handle']}"
             for damage_out_player in damage_out["players"]:
@@ -143,6 +158,9 @@ def update_metadata_file(self, file, force=False):
                     players[idx][1]["build"] = self.get_build(
                         damage_out_player["breakdown"]
                     )
+                    valid_map[handle] = self.check_breakdown(
+                        damage_out_player["breakdown"]
+                    )
                     break
 
         if len(players) == 0:
@@ -190,8 +208,7 @@ def update_metadata_file(self, file, force=False):
 
         if len(ladders) == 0:
             raise APIException(
-                f"{combat.map} ({combat.difficulty} Difficulty) at {
-                    combat.start_time} has no matching ladder"
+                f"{combat.map} ({combat.difficulty} Difficulty) at {combat.start_time} has no matching ladder"
             )
 
         for _, player in players:
@@ -200,6 +217,19 @@ def update_metadata_file(self, file, force=False):
                 if ladder.is_solo and len(players) != 1:
                     continue
 
+                valid = valid_map.get(full_name, None)
+                print(valid)
+                if valid and not valid["valid"]:
+                    results.append(
+                        {
+                            "name": full_name,
+                            "updated": False,
+                            "detail": f"{valid['ability']} is a prohibited ability. Ladder entry will not be updated.",
+                            "value": player.get(ladder.metric),
+                        }
+                    )
+                    continue
+
                 combat_time = ladder.combat_time_threshold(combat, players)
                 if player["combat_time"] < combat_time:
                     results.append(
@@ -228,8 +258,7 @@ def update_metadata_file(self, file, force=False):
                     and player.get(ladder.metric) > ladder.manual_review_threshold
                 ):
                     visible = False
-                    manual_review = f", but result needs to be manually reviewed. Combat Log ID #{
-                        self.pk}"
+                    manual_review = f", but result needs to be manually reviewed. Combat Log ID #{self.pk}"
                 else:
                     visible = True
                     manual_review = ""

core/models/base.py

@@ -1,4 +1,4 @@
-""" Base Model """
+"""Base Model"""
 
 from django.db import models
 
@@ -19,3 +19,4 @@ class BaseNameModel(models.Model):
 
     class Meta:
         abstract = True
+        get_latest_by = "pk"