[FEATURE] Two-level metadata: Model and appearance

.gitignore

@@ -1,3 +1,4 @@
+*.bak
 /.buildpath
 /.cache
 /.idea/

Classes/Common/Helper.php

@@ -440,7 +440,7 @@ public static function getIndexNameFromUid(int $uid, string $table, int $pid = -
  if (
  !$uid
  // NOTE: Only use tables that don't have too many entries!
- || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures', 'tx_dlf_solrcores'])
+ || !in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_metadatasubentries','tx_dlf_structures', 'tx_dlf_solrcores'])
  ) {
  self::log('Invalid UID "' . $uid . '" or table "' . $table . '"', LOG_SEVERITY_ERROR);
  return '';
@@ -846,7 +846,7 @@ public static function translate(string $indexName, string $table, string $pid):
  // Check if we already got a translation.
  if (empty($labels[$table][$pid][$languageContentId][$indexName])) {
  // Check if this table is allowed for translation.
- if (in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_structures'])) {
+ if (in_array($table, ['tx_dlf_collections', 'tx_dlf_libraries', 'tx_dlf_metadata', 'tx_dlf_metadatasubentries', 'tx_dlf_structures'])) {
  $additionalWhere = $queryBuilder->expr()->in($table . '.sys_language_uid', [-1, 0]);
  if ($languageContentId > 0) {
  $additionalWhere = $queryBuilder->expr()->andX(

Classes/Common/Indexer.php

@@ -516,6 +516,7 @@ private static function processMetadata($document, $metadata, &$solrDoc): array
  {
  $autocomplete = [];
  foreach ($metadata as $indexName => $data) {
+ // TODO: Include also subentries if available.
  if (
  !empty($data)
  && substr($indexName, -8) !== '_sorting'
@@ -551,6 +552,7 @@ private static function processMetadata($document, $metadata, &$solrDoc): array
  */
  private static function addFaceting($doc, &$solrDoc): void
  {
+ // TODO: Include also subentries if available.
  foreach ($doc->metadataArray[$doc->toplevelId] as $indexName => $data) {
  if (
  !empty($data)

Classes/Common/MetsDocument.php

@@ -520,7 +520,6 @@
  if (!$this->extractAndProcessMetadata($dmdId, $mdSectionType, $metadata, $cPid, $hasMetadataSection)) {
  continue;
  }
-
  $hasMetadataSection[$mdSectionType] = true;
  }
 
@@ -533,6 +532,66 @@
  }
  }
 
+ /**
+ * @param array $allSubentries
+ * @param string $parentIndex
+ * @param \DOMNode $parentNode
+ * @return array|false
+ */
+ private function getSubentries($allSubentries, string $parentIndex, \DOMNode $parentNode)
+ {
+ $domXPath = new \DOMXPath($parentNode->ownerDocument);
+ $this->registerNamespaces($domXPath);
+ $theseSubentries = [];
+ foreach ($allSubentries as $subentry) {
+ if ($subentry['parent_index_name'] == $parentIndex) {
+ $values = $domXPath->evaluate($subentry['xpath'], $parentNode);
+ if (!empty($subentry['xpath']) && ($values)) {
+ $theseSubentries = array_merge($theseSubentries, $this->getSubentryValue($values, $subentry));
+ }
+ // Set default value if applicable.
+ if (
+ empty($theseSubentries[$subentry['index_name']][0])
+ && strlen($subentry['default_value']) > 0
+ ) {
+ $theseSubentries[$subentry['index_name']] = [$subentry['default_value']];
+ }
+ }
+ }
+ if (empty($theseSubentries)) {
+ return false;
+ }
+ return $theseSubentries;
+ }
+
+ /**
+ * @param $values
+ * @param $subentry
+ * @return array
+ */
+ private function getSubentryValue($values, $subentry)
+ {
+ $theseSubentries = [];
+ if (
+ ($values instanceof \DOMNodeList
+ && $values->length > 0) || is_string($values)
+ ) {
+ if (is_string($values)) {
+ // if concat is used evaluate returns a string
+ $theseSubentries[$subentry['index_name']][] = trim($values);
+ } else {
+ foreach ($values as $value) {
+ if (!empty(trim((string) $value->nodeValue))) {
+ $theseSubentries[$subentry['index_name']][] = trim((string) $value->nodeValue);
+ }
+ }
+ }
+ } elseif (!($values instanceof \DOMNodeList)) {
+ $theseSubentries[$subentry['index_name']] = [trim((string) $values->nodeValue)];
+ }
+ return $theseSubentries;
+ }
+
  /**
  * Get logical unit type.
  *
@@ -605,8 +664,13 @@
  */
  private function processAdditionalMetadata(array $additionalMetadata, \DOMXPath $domXPath, \DOMElement $domNode, array &$metadata): void
  {
+ $subentries = [];
+ if (isset($additionalMetadata['subentries'])) {
+ $subentries = $additionalMetadata['subentries'];
+ unset($additionalMetadata['subentries']);
+ }
  foreach ($additionalMetadata as $resArray) {
- $this->setMetadataFieldValues($resArray, $domXPath, $domNode, $metadata);
+ $this->setMetadataFieldValues($resArray, $domXPath, $domNode, $metadata, $subentries);
  $this->setDefaultMetadataValue($resArray, $metadata);
  $this->setSortableMetadataValue($resArray, $domXPath, $domNode, $metadata);
  }
@@ -621,17 +685,23 @@
  * @param \DOMXPath $domXPath
  * @param \DOMElement $domNode
  * @param array $metadata
+ * @param array $subentryResults
  *
  * @return void
  */
- private function setMetadataFieldValues(array $resArray, \DOMXPath $domXPath, \DOMElement $domNode, array &$metadata): void
+ private function setMetadataFieldValues(array $resArray, \DOMXPath $domXPath, \DOMElement $domNode, array &$metadata, array $subentryResults): void
  {
  if ($resArray['format'] > 0 && !empty($resArray['xpath'])) {
  $values = $domXPath->evaluate($resArray['xpath'], $domNode);
  if ($values instanceof \DOMNodeList && $values->length > 0) {
  $metadata[$resArray['index_name']] = [];
  foreach ($values as $value) {
- $metadata[$resArray['index_name']][] = trim((string) $value->nodeValue);
+ $subentries = $this->getSubentries($subentryResults, $resArray['index_name'], $value);
+ if ($subentries) {
+ $metadata[$resArray['index_name']][] = $subentries;
+ } else {
+ $metadata[$resArray['index_name']][] = trim((string) $value->nodeValue);
+ }
  }
  } elseif (!($values instanceof \DOMNodeList)) {
  $metadata[$resArray['index_name']] = [trim((string) $values)];
@@ -670,17 +740,25 @@
  */
  private function setSortableMetadataValue(array $resArray, \DOMXPath $domXPath, \DOMElement $domNode, array &$metadata): void
  {
- if (!empty($metadata[$resArray['index_name']]) && $resArray['is_sortable']) {
+ $indexName = $resArray['index_name'];
+ $currentMetadata = $metadata[$indexName][0];
+
+ if (!empty($metadata[$indexName]) && $resArray['is_sortable']) {
  if ($resArray['format'] > 0 && !empty($resArray['xpath_sorting'])) {
  $values = $domXPath->evaluate($resArray['xpath_sorting'], $domNode);
  if ($values instanceof \DOMNodeList && $values->length > 0) {
- $metadata[$resArray['index_name'] . '_sorting'][0] = trim((string) $values->item(0)->nodeValue);
+ $metadata[$indexName . '_sorting'][0] = trim((string) $values->item(0)->nodeValue);
  } elseif (!($values instanceof \DOMNodeList)) {
- $metadata[$resArray['index_name'] . '_sorting'][0] = trim((string) $values);
+ $metadata[$indexName . '_sorting'][0] = trim((string) $values);
  }
  }
- if (empty($metadata[$resArray['index_name'] . '_sorting'][0])) {
- $metadata[$resArray['index_name'] . '_sorting'][0] = $metadata[$resArray['index_name']][0];
+ if (empty($metadata[$indexName . '_sorting'][0])) {
+ if (is_array($currentMetadata)) {
+ $sortingValue = implode(',', array_column($currentMetadata, 0));
+ $metadata[$indexName . '_sorting'][0] = $sortingValue;
+ } else {
+ $metadata[$indexName . '_sorting'][0] = $currentMetadata;
+ }
  }
  }
  }
@@ -768,6 +846,7 @@
  ->getRestrictions()
  ->removeByType(HiddenRestriction::class);
  // Get all metadata with configured xpath and applicable format first.
+ // Exclude metadata with subentries, we will fetch them later.
  $resultWithFormat = $queryBuilder
  ->select(
  'tx_dlf_metadata.index_name AS index_name',
@@ -806,7 +885,7 @@
  // Get all metadata without a format, but with a default value next.
  $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
  ->getQueryBuilderForTable('tx_dlf_metadata');
-  // Get hidden records, too.
+ // Get hidden records, too.
  $queryBuilder
  ->getRestrictions()
  ->removeByType(HiddenRestriction::class);
@@ -826,7 +905,52 @@
  )
  ->execute();
  // Merge both result sets.
- return array_merge($resultWithFormat->fetchAllAssociative(), $resultWithoutFormat->fetchAllAssociative());
+ $allResults = array_merge($resultWithFormat->fetchAllAssociative(), $resultWithoutFormat->fetchAllAssociative());
+
+ // Get subentries separately.
+ $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
+ ->getQueryBuilderForTable('tx_dlf_metadata');
+ // Get hidden records, too.
+ $queryBuilder
+ ->getRestrictions()
+ ->removeByType(HiddenRestriction::class);
+ $subentries = $queryBuilder
+ ->select(
+ 'tx_dlf_subentries_joins.index_name AS index_name',
+ 'tx_dlf_metadata.index_name AS parent_index_name',
+ 'tx_dlf_subentries_joins.xpath AS xpath',
+ 'tx_dlf_subentries_joins.default_value AS default_value'
+ )
+ ->from('tx_dlf_metadata')
+ ->innerJoin(
+ 'tx_dlf_metadata',
+ 'tx_dlf_metadataformat',
+ 'tx_dlf_metadataformat_joins',
+ $queryBuilder->expr()->eq(
+ 'tx_dlf_metadataformat_joins.parent_id',
+ 'tx_dlf_metadata.uid'
+ )
+ )
+ ->innerJoin(
+ 'tx_dlf_metadataformat_joins',
+ 'tx_dlf_metadatasubentries',
+ 'tx_dlf_subentries_joins',
+ $queryBuilder->expr()->eq(
+ 'tx_dlf_subentries_joins.parent_id',
+ 'tx_dlf_metadataformat_joins.uid'
+ )
+ )
+ ->where(
+ $queryBuilder->expr()->eq('tx_dlf_metadata.pid', (int) $cPid),
+ $queryBuilder->expr()->gt('tx_dlf_metadataformat_joins.subentries', 0),
+ $queryBuilder->expr()->eq('tx_dlf_subentries_joins.l18n_parent', 0),
+ $queryBuilder->expr()->eq('tx_dlf_subentries_joins.pid', (int) $cPid)
+ )
+ ->orderBy('tx_dlf_subentries_joins.sorting')
+ ->execute();
+ $subentriesResult = $subentries->fetchAll();
+
+ return array_merge($allResults, ['subentries' => $subentriesResult]);
  }
 
  /**

Classes/Controller/MetadataController.php

@@ -171,6 +171,17 @@ protected function printMetadata(array $metadata): void
  foreach ($section as $name => $value) {
  // NOTE: Labels are to be escaped in Fluid template
 
+ $metadata[$i][$name] = is_array($value)
+ ? implode($this->settings['separator'], $value)
+ : $value;
+
+ if ($metadata[$i][$name] === 'Array') {
+ $metadata[$i][$name] = [];
+ foreach ($value as $subKey => $subValue) {
+ $metadata[$i][$name][$subKey] = $subValue;
+ }
+ }
+
  $this->parseMetadata($i, $name, $value, $metadata);
 
  if (is_array($metadata[$i][$name])) {
@@ -372,6 +383,8 @@ private function parseMetadata(int $i, string $name, $value, array &$metadata) :
  foreach ($metadata[$i][$name] as &$langValue) {
  $langValue = Helper::getLanguageName($langValue);
  }
+ } elseif (!empty($value)) {
+ $metadata[$i][$name][0] = $metadata[$i][$name][0];
  }
  }
 

Classes/Domain/Model/MetadataFormat.php

@@ -12,6 +12,8 @@
 
 namespace Kitodo\Dlf\Domain\Model;
 
+use TYPO3\CMS\Extbase\Annotation as Extbase;
+use TYPO3\CMS\Extbase\Persistence\ObjectStorage;
 use TYPO3\CMS\Extbase\DomainObject\AbstractEntity;
 
 /**
@@ -55,11 +57,36 @@ class MetadataFormat extends AbstractEntity
  protected $xpathSorting;
 
  /**
+ * Collection of ``tx_dlf_metadatasubentries`` specified with this metadata entry.
+ *
+ * @var \TYPO3\CMS\Extbase\Persistence\ObjectStorage<\Kitodo\Dlf\Domain\Model\MetadataSubentry>
+ * @Extbase\ORM\Lazy
+ * @Extbase\ORM\Cascade("remove")
+ */
+ protected $subentries;
+
+ /**
+ * Whether or not the field is mandatory. Not used at the moment (originally planned to be used in METS validator).
+ *
+ * @var int
  * @access protected
- * @var int Whether or not the field is mandatory. Not used at the moment (originally planned to be used in METS validator).
  */
  protected $mandatory;
 
+ /**
+ * constructor
+ */
+ public function __construct()
+ {
+ // Do not remove the next line: It would break the functionality
+ $this->initStorageObjects();
+ }
+
+ protected function initStorageObjects()
+ {
+ $this->subentries = new ObjectStorage();
+ }
+
  /**
  * @return int
  */
@@ -124,6 +151,40 @@ public function setXpathSorting(string $xpathSorting): void
  $this->xpathSorting = $xpathSorting;
  }
 
+ public function getSubentries()
+ {
+ return $this->subentries;
+ }
+
+ public function setSubentries(ObjectStorage $subentries): void
+ {
+ $this->subentries = $subentries;
+ }
+
+ /**
+ * Adds a Subentry
+ *
+ * @param \Kitodo\Dlf\Domain\Model\MetadataSubentry $subentry
+ *
+ * @return void
+ */
+ public function addSubentry(MetadataSubentry $subentry)
+ {
+ $this->subentries->attach($subentry);
+ }
+
+ /**
+ * Removes a Subentry
+ *
+ * @param \Kitodo\Dlf\Domain\Model\MetadataSubentry $subentryToRemove
+ *
+ * @return void
+ */
+ public function removeSubentry(MetadataSubentry $subentryToRemove)
+ {
+ $this->subentries->detach($subentryToRemove);
+ }
+
  /**
  * @return int
  */