Make marker types and playerclasses capable of being campaign specific

Author: PhilippMDoerner

sql/V1.12__add_link_types.sql

@@ -1,3 +1,4 @@
+-- WIKIENTRIES_RELATIONSHIP_TYPE
 CREATE TABLE "wikientries_relationship_type" (
   "id" integer NOT NULL PRIMARY KEY AUTOINCREMENT,
   "name" varchar(50) NOT NULL,
@@ -25,6 +26,7 @@ VALUES (
     '2024-12-13 12:00:00',
     '2024-12-13 12:00:00'
   );
+-- WIKIENTRIES_RELATIONSHIP - ADD LINK_TYPE_ID AND CAMPAIGN_ID 
 -- Migrate wikientries_relationships to a table that has a link_type_id fk column
 CREATE TABLE wikientries_relationships_new (
   "id" integer NOT NULL PRIMARY KEY AUTOINCREMENT,
@@ -34,7 +36,7 @@ CREATE TABLE wikientries_relationships_new (
   "weight" integer,
   "creation_datetime" datetime NOT NULL,
   "update_datetime" datetime NOT NULL,
-  "campaign_id" integer,
+  "campaign_id" integer REFERENCES "wikientries_campaign" ("id") DEFERRABLE INITIALLY DEFERRED,
   "link_type_id" integer NOT NULL DEFAULT 1,
   FOREIGN KEY (link_type_id) REFERENCES wikientries_relationship_type (id)
 );
@@ -64,4 +66,71 @@ FROM wikientries_relationships;
 DROP TABLE wikientries_relationships;
 -- Rename the new table to the old table's name
 ALTER TABLE wikientries_relationships_new
-  RENAME TO wikientries_relationships;
+  RENAME TO wikientries_relationships;
+-- MAP_MARKERTYPE ADD CAMPAIGN_ID COLUMN
+-- Extend map marker type to have an optional campaign_id column
+CREATE TABLE map_markertype_new (
+  "id" integer NOT NULL PRIMARY KEY AUTOINCREMENT,
+  "name" varchar(50) NOT NULL,
+  "icon" varchar(20) NOT NULL,
+  "is_text_marker" bool NOT NULL,
+  "creation_datetime" datetime NOT NULL,
+  "update_datetime" datetime NOT NULL,
+  "fontawesome_type" varchar(4) NOT NULL,
+  "color" varchar(20) NOT NULL,
+  "campaign_id" integer REFERENCES "wikientries_campaign" ("id") DEFERRABLE INITIALLY DEFERRED
+);
+-- Copy the data from the old table to the new table
+INSERT INTO map_markertype_new (
+    "id",
+    "name",
+    "icon",
+    "is_text_marker",
+    "creation_datetime",
+    "update_datetime",
+    "fontawesome_type",
+    "color",
+    "campaign_id"
+  )
+SELECT "id",
+  "name",
+  "icon",
+  "is_text_marker",
+  "creation_datetime",
+  "update_datetime",
+  "fontawesome_type",
+  "color",
+  NULL AS "campaign_id"
+FROM map_markertype;
+-- Drop the old table
+DROP TABLE map_markertype;
+-- Rename the new table to the old table's name
+ALTER TABLE map_markertype_new
+  RENAME TO map_markertype;
+-- WIKIENTRIES_PLAYERCLASS ADD CAMPAIGN_ID COLUMN
+CREATE TABLE "wikientries_playerclass_new" (
+  "id" integer NOT NULL PRIMARY KEY AUTOINCREMENT,
+  "name" varchar(200) NOT NULL UNIQUE,
+  "campaign_id" integer REFERENCES "wikientries_campaign" ("id") DEFERRABLE INITIALLY DEFERRED,
+  "creation_datetime" datetime NOT NULL,
+  "update_datetime" datetime NOT NULL
+);
+-- Copy the data from the old table to the new table
+INSERT INTO wikientries_playerclass_new (
+    "id",
+    "name",
+    "campaign_id",
+    "creation_datetime",
+    "update_datetime"
+  )
+SELECT "id",
+  "name",
+  NULL,
+  "creation_datetime",
+  "update_datetime"
+FROM wikientries_playerclass;
+-- Drop the old table
+DROP TABLE wikientries_playerclass;
+-- Rename the new table to the old table's name
+ALTER TABLE wikientries_playerclass_new
+  RENAME TO wikientries_playerclass;

src/applications/mapMarkerType/markerTypeModel.nim

@@ -2,8 +2,10 @@ import norm/[model, pragmas]
 import lowdb/sqlite
 import std/[strutils, options]
 import constructor/defaults
+import ../campaign/campaignModel
 import ../../utils/djangoDateTime/[djangoDateTimeType]
 import ../../applicationSettings
+import ../../applicationConstants
 
 type FontAwesomeType* = enum 
   ##Determines whehter an icon is supposed to come from 4.7 or 5
@@ -30,6 +32,7 @@ type MarkerType*  {.defaults, tableName: MARKERTYPE_TABLE.} = ref object of Mode
   update_datetime*: DjangoDateTime = djangoDateTimeType.now()
   fontawesome_type*: FontAwesomeType = FontAwesomeType.VERSION5 
   color*: string = ""
+  campaign_id* {.fk: Campaign.}: int64 = MODEL_INIT_ID
 
 implDefaults(MarkerType, {DefaultFlag.defExported, DefaultFlag.defTypeConstr})
 

src/applications/mapMarkerType/markerTypeRepository.nim

@@ -0,0 +1,26 @@
+import std/[strformat]
+import norm/[sqlite]
+import ./markerTypeModel
+import ../genericRawRepository
+import ../../applicationSettings
+
+proc getMarkerTypes*(con: DbConn, campaignName: string): seq[MarkerType] =
+  const getMarkerTypesSQL: string = fmt """
+    SELECT 
+      typ.name,
+      typ.icon,
+      typ.is_text_marker,
+      typ.creation_datetime,
+      typ.update_datetime,
+      typ.fontawesome_type,
+      typ.color,
+      typ.campaign_id,
+      typ.id
+    FROM {MARKERTYPE_TABLE} AS typ
+    LEFT JOIN wikientries_campaign AS camp ON camp.id = typ.campaign_id
+    WHERE 
+      camp.name = ? OR typ.campaign_id IS NULL
+  """
+  
+  let queryParams: array[1, DbValue] = [campaignName.dbValue()]
+  return con.rawSelectRows(getMarkerTypesSQL, MarkerType, queryParams)

src/applications/mapMarkerType/markerTypeRoutes.nim

@@ -62,7 +62,7 @@ proc addMarkerTypeRoutes*(app: Prologue) =
     app.addRoute(
         re fmt"/markertype/{CAMPAIGN_NAME_PATTERN}/overview", 
         handler = createReadListHandler(
-            readListProc = getMarkerTypes, 
+            readListProc = getCampaignMarkerTypes, 
             checkPermission = checkReadMarkerTypeListPermission, 
             serialize = serializeMarkerTypes
         ),  

src/applications/mapMarkerType/markerTypeService.nim

@@ -1,9 +1,14 @@
-import ../genericArticleRepository
-import markerTypeModel
 import norm/sqlite
-export markerTypeModel
+import markerTypeModel
+import markerTypeRepository
+import ../genericArticleRepository
 import ../allUrlParams
 
+export markerTypeModel
+
 proc getMarkerTypes*(connection: DbConn, requestParams: ReadWithoutParams): seq[MarkerType] =
     ## lists all campaign entries using a limited but performant representation of a MarkerType
     result = connection.getList(MarkerType)
+
+proc getCampaignMarkerTypes*(con: DbConn, params: ReadListParams): seq[MarkerType] =
+    return con.getMarkerTypes(params.campaignName)

src/applications/nodeMap/nodeMapRepository.nim

@@ -177,7 +177,7 @@ proc getLinkTypes*(con: DbConn, campaignName: string): seq[CustomLinkType] =
       typ.creation_datetime,
       typ.update_datetime,
       typ.id
-    FROM wikientries_relationship_type AS typ
+    FROM {RELATIONSHIP_KIND_TABLE} AS typ
     LEFT JOIN wikientries_campaign AS camp ON camp.id = typ.campaign_id
     WHERE 
       camp.name = ? OR typ.campaign_id IS NULL

src/applications/playerclass/playerClassModel.nim

@@ -1,12 +1,14 @@
 import norm/[model, pragmas]
+import ../character/characterModel
+import ../campaign/campaignModel
 import ../../applicationSettings
 import ../../applicationConstants
-import ../character/characterModel
 import ../../utils/djangoDateTime/djangoDateTimeType
 import constructor/defaults
 
 type PlayerClass* {.defaults, tableName: PLAYERCLASS_TABLE.} = ref object of Model
     name*: string = ""
+    campaign_id* {.fk: Campaign.}: int64 = MODEL_INIT_ID
     update_datetime*: DjangoDateTime = djangoDateTimeType.now()
     creation_datetime*: DjangoDateTime = djangoDateTimeType.now()
 implDefaults(PlayerClass, {DefaultFlag.defExported, DefaultFlag.defTypeConstr})

src/applications/playerclass/playerClassRepository.nim

@@ -0,0 +1,22 @@
+import std/[strformat]
+import norm/[sqlite]
+import ./playerClassModel
+import ../genericRawRepository
+import ../../applicationSettings
+
+proc getPlayerClasses*(con: DbConn, campaignName: string): seq[PlayerClass] =
+  const getPlayerClassesSQL: string = fmt """
+    SELECT 
+      typ.name,
+      typ.campaign_id,
+      typ.update_datetime,
+      ty.creation_datetime,
+      typ.id
+    FROM {PLAYERCLASS_TABLE} AS typ
+    LEFT JOIN wikientries_campaign AS camp ON camp.id = typ.campaign_id
+    WHERE 
+      camp.name = ? OR typ.campaign_id IS NULL
+  """
+  
+  let queryParams: array[1, DbValue] = [campaignName.dbValue()]
+  return con.rawSelectRows(getPlayerClassesSQL, PlayerClass, queryParams)

src/applications/playerclass/playerClassRoutes.nim

@@ -46,7 +46,7 @@ proc addPlayerClassRoutes*(app: Prologue) =
     app.addRoute(
         re fmt"/player_class/{CAMPAIGN_NAME_PATTERN}/overview/", 
         handler = createReadListHandler[ReadListParams, PlayerClass, PlayerClassSerializable](
-          getPlayerClasses,
+          getCampaignPlayerClasses,
           checkPlayerClassPermission,
           serializePlayerClasses
         ),  

src/applications/playerclass/playerClassService.nim

@@ -1,10 +1,14 @@
+import norm/sqlite
+import playerClassModel
+import playerClassRepository
 import ../allUrlParams
 import ../genericArticleRepository
-import playerClassModel
-import norm/sqlite
 
 proc getPlayerClasses*(connection: DbConn, params: ReadListParams): seq[PlayerClass] =
   result = connection.getList(PlayerClass)
 
 proc createPlayerClassConnection*(connection: DbConn, params: CreateParams, newEntry: var PlayerClassConnection): PlayerClassConnection =
-  result = connection.createEntryInTransaction(newEntry)
+  result = connection.createEntryInTransaction(newEntry)
+  
+proc getCampaignPlayerClasses*(connection: DbConn, params: ReadListParams): seq[PlayerClass] =
+  result = connection.getPlayerClasses(params.campaignName)