Store collection descriptions in MARC 520 summary fields

Instead of only carrying the collection description in the local
996f subfield, also write it to a standard MARC 520 summary field
(a subfield), so the description is available for the regular
summary-based display and indexing.

Assisted-by: OpenCode / big-pickle (opencode)
Signed-off-by: Stefan Weil <sw@weilnetz.de>

Author: stweil

module/VuFindConsole/src/VuFindConsole/Command/Util/AlmaCollectionsCommand.php

@@ -124,8 +124,9 @@ protected function configure()
             '',
             'Each collection is written to a file collection-<mms_id>.xml together with the',
             'records of all member titles (GET /bibs/collections/{pid}/bibs). The records are',
-            'augmented with a local MARC 996 field containing the VuFind hierarchy fields and',
-            'the collection description; see the mappings in import/marc.properties.',
+            'augmented with a MARC 520 summary field containing the collection description and',
+            'a local MARC 996 field containing the VuFind hierarchy fields; see the mappings in',
+            'import/marc.properties.',
             '',
             'To display the member records on the collection page, enable the Collections',
             'module (collections = true in the [Collections] section of config.ini) and add',
@@ -153,8 +154,9 @@ protected function configure()
                 InputOption::VALUE_REQUIRED,
                 'Write the MARCXML record of each collection to the given directory instead of '
                 . 'displaying the overview (default: local/harvest/Collections). The records are '
-                . 'augmented with a local MARC 996 field containing the VuFind hierarchy fields '
-                . 'and the collection description; see the mappings in import/marc.properties.'
+                . 'augmented with a MARC 520 summary field containing the collection description '
+                . 'and a local MARC 996 field containing the VuFind hierarchy fields; see the '
+                . 'mappings in import/marc.properties.'
             );
     }
 
@@ -443,6 +445,24 @@ protected function extractRecord(string $body): ?DOMNode
         return $nodes->item(0);
     }
 
+    /**
+     * Add a MARC 520 summary field with the collection description to a record.
+     *
+     * @param DOMNode $record      MARCXML record element
+     * @param string  $description Description of the collection
+     *
+     * @return void
+     */
+    protected function addSummaryField(DOMNode $record, string $description): void
+    {
+        $datafield = $record->ownerDocument->createElement('datafield');
+        $datafield->setAttribute('tag', '520');
+        $datafield->setAttribute('ind1', ' ');
+        $datafield->setAttribute('ind2', ' ');
+        $this->addSubfield($datafield, 'a', $description);
+        $record->appendChild($datafield);
+    }
+
     /**
      * Add a MARC 996 data field with the VuFind hierarchy fields to a record.
      *
@@ -461,6 +481,10 @@ protected function addHierarchyField(
         string $description,
         array $ancestors
     ): void {
+        if ('' !== $description) {
+            $this->addSummaryField($record, $description);
+        }
+
         $isTop = empty($ancestors);
         $topId = $isTop ? $mmsId : $ancestors[0];
         $parentId = $isTop ? null : end($ancestors);

module/VuFindConsole/tests/unit-tests/src/VuFindTest/Command/Util/AlmaCollectionsCommandTest.php

@@ -126,6 +126,12 @@ public function testDownloadAllCollections(): void
         );
         $this->assertArrayNotHasKey('c', $parent);
 
+        // The collection description is also stored in a MARC 520 summary field.
+        $this->assertSame(
+            ['a' => 'Test collection'],
+            $this->getSummaryField(file_get_contents($parentFile))
+        );
+
         // Sub-collection: parent and top IDs point to the parent collection.
         $child = $this->getHierarchyField(file_get_contents($childFile));
         $this->assertSame(
@@ -134,6 +140,10 @@ public function testDownloadAllCollections(): void
              'f' => 'Child collection'],
             $child
         );
+        $this->assertSame(
+            ['a' => 'Child collection'],
+            $this->getSummaryField(file_get_contents($childFile))
+        );
     }
 
     /**
@@ -165,7 +175,8 @@ public function testDownloadSingleCollection(): void
     }
 
     /**
-     * Test that a collection without a description gets no 996f subfield.
+     * Test that a collection without a description gets no 996f subfield
+     * and no 520 field.
      *
      * @return void
      */
@@ -185,10 +196,10 @@ public function testDownloadWithoutDescription(): void
         $commandTester = new CommandTester($this->getCommand($httpService));
         $commandTester->execute(['--output' => $this->outputDir]);
         $this->assertSame(0, $commandTester->getStatusCode());
-        $field = $this->getHierarchyField(
-            file_get_contents($this->outputDir . '/collection-9919814834502561.xml')
-        );
+        $record = file_get_contents($this->outputDir . '/collection-9919814834502561.xml');
+        $field = $this->getHierarchyField($record);
         $this->assertArrayNotHasKey('f', $field);
+        $this->assertSame([], $this->getSummaryField($record));
     }
 
     /**
@@ -273,6 +284,30 @@ protected function getCommand(HttpService $httpService): AlmaCollectionsCommand
         );
     }
 
+    /**
+     * Extract the summary values of the MARC 520 field from a record.
+     *
+     * @param string $xml MARCXML record
+     *
+     * @return array
+     */
+    protected function getSummaryField(string $xml): array
+    {
+        $dom = new DOMDocument();
+        $this->assertTrue($dom->loadXML($xml));
+        $xpath = new DOMXPath($dom);
+        $nodes = $xpath->query('//datafield[@tag="520"]');
+        $this->assertNotFalse($nodes);
+        if (0 === $nodes->length) {
+            return [];
+        }
+        $result = [];
+        foreach ($nodes->item(0)->getElementsByTagName('subfield') as $subfield) {
+            $result[$subfield->getAttribute('code')] = $subfield->textContent;
+        }
+        return $result;
+    }
+
     /**
      * Extract the hierarchy values of the MARC 996 field from a record.
      *