#10692 structured citations (development)

Author: GaziYucel

classes/migration/install/MetadataMigration.php

@@ -30,7 +30,6 @@ public function up(): void
             $table->comment('A citation made by an associated publication.');
             $table->bigInteger('citation_id')->autoIncrement();
             $table->bigInteger('publication_id');
-            $table->text('raw_citation')->nullable()->default(null);
             $table->bigInteger('seq')->default(0);
 
             $table->foreign('publication_id', 'citations_publication')

classes/migration/upgrade/v3_5_0/I10692_CitationMigration.php

@@ -15,7 +15,8 @@
 namespace PKP\migration\upgrade\v3_5_0;
 
 use Illuminate\Database\Schema\Blueprint;
-use Illuminate\Support\Facades\Schema as Schema;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Schema;
 use PKP\install\DowngradeNotSupportedException;
 use PKP\migration\Migration;
 
@@ -26,15 +27,19 @@ class I10692_CitationMigration extends Migration
      */
     public function up(): void
     {
+        $this->migrateRawCitations();
+
+        if (Schema::hasColumn('citations', 'raw_citation')) {
+            Schema::table('citations', function (Blueprint $table) {
+                $table->dropColumn('raw_citation');
+            });
+        }
+
         if (Schema::hasColumn('citation_settings', 'setting_type')) {
             Schema::table('citation_settings', function (Blueprint $table) {
                 $table->dropColumn('setting_type');
             });
         }
-
-        Schema::table('citations', function (Blueprint $table) {
-            $table->text('raw_citation')->nullable()->default(null)->change();
-        });
     }
 
     /**
@@ -46,4 +51,31 @@ public function down(): void
     {
         throw new DowngradeNotSupportedException();
     }
+
+    /**
+     * Migrates raw_citations from citations to citation_settings table.
+     * This is needed because of multi-language support.
+     */
+    public function migrateRawCitations(): void
+    {
+        $values = DB::table('citations as c')
+            ->select(
+                'c.citation_id',
+                's.locale',
+                DB::raw("'raw_citation' as setting_name"),
+                DB::raw("c.raw_citation as setting_value")
+            )
+            ->distinct()
+            ->join('publications as p', 'c.publication_id', '=', 'p.publication_id')
+            ->join('submissions as s', 'p.submission_id', '=', 's.submission_id')
+            ->get()
+            ->map(function ($item) {
+                return (array)$item;
+            })
+            ->all();
+
+        DB::table('citation_settings')->upsert($values,
+            ['citation_id', 'locale', 'setting_name'],
+            ['setting_value']);
+    }
 }

schemas/citation.json

@@ -20,6 +20,7 @@
 		"rawCitation": {
 			"type": "string",
 			"description": "Optional metadata that contains references for works cited in this submission as raw text.",
+			"multilingual": true,
 			"validation": [
 				"nullable"
 			]