Merge branch 'addMetricsImport-784' into 'main'

Import journal metrics See merge request softwares-pkp/plugins_ojs/fullJournalTransfer!53
lepidus · May 3, 2024 · 643a749 · 643a749
2 parents 203c752 + 11da17f
commit 643a749
Show file tree

Hide file tree

Showing 11 changed files with 375 additions and 37 deletions.
diff --git a/FullJournalImportExportDeployment.inc.php b/FullJournalImportExportDeployment.inc.php
@@ -17,13 +17,21 @@ class FullJournalImportExportDeployment extends NativeImportExportDeployment
     private $navigationMenuItemDBIds;
     private $reviewFormDBIds;
     private $reviewFormElementDBIds;
+    private $representationDBIds;
+    private $issueDBIds;
+    private $issueGalleyDBIds;
+    private $submissionDBIds;
 
     public function __construct($context, $user = null)
     {
         parent::__construct($context, $user);
         $this->setNavigationMenuItemDBIds([]);
         $this->setReviewFormDBIds([]);
         $this->setReviewFormElementDBIds([]);
+        $this->setRepresentationDBIds([]);
+        $this->setIssueDBIds([]);
+        $this->setIssueGalleyDBIds([]);
+        $this->setSubmissionDBIds([]);
     }
 
     public function getSchemaFilename()
@@ -189,4 +197,96 @@ public function setReviewFormElementDBId($reviewFormElementDBId, $DBId)
     {
         return $this->reviewFormElementDBIds[$reviewFormElementDBId] = $DBId;
     }
+
+    public function getRepresentationDBIds()
+    {
+        return $this->representationDBIds;
+    }
+
+    public function setRepresentationDBIds($representationDBIds)
+    {
+        return $this->representationDBIds = $representationDBIds;
+    }
+
+    public function getRepresentationDBId($representationDBId)
+    {
+        if (array_key_exists($representationDBId, $this->representationDBIds)) {
+            return $this->representationDBIds[$representationDBId];
+        }
+        return null;
+    }
+
+    public function setRepresentationDBId($representationDBId, $DBId)
+    {
+        return $this->representationDBIds[$representationDBId] = $DBId;
+    }
+
+    public function getIssueDBIds()
+    {
+        return $this->issueDBIds;
+    }
+
+    public function setIssueDBIds($issueDBIds)
+    {
+        return $this->issueDBIds = $issueDBIds;
+    }
+
+    public function getIssueDBId($issueDBId)
+    {
+        if (array_key_exists($issueDBId, $this->issueDBIds)) {
+            return $this->issueDBIds[$issueDBId];
+        }
+        return null;
+    }
+
+    public function setIssueDBId($issueDBId, $DBId)
+    {
+        return $this->issueDBIds[$issueDBId] = $DBId;
+    }
+
+    public function getIssueGalleyDBIds()
+    {
+        return $this->issueGalleyDBIds;
+    }
+
+    public function setIssueGalleyDBIds($issueGalleyDBIds)
+    {
+        return $this->issueGalleyDBIds = $issueGalleyDBIds;
+    }
+
+    public function getIssueGalleyDBId($issueGalleyDBId)
+    {
+        if (array_key_exists($issueGalleyDBId, $this->issueGalleyDBIds)) {
+            return $this->issueGalleyDBIds[$issueGalleyDBId];
+        }
+        return null;
+    }
+
+    public function setIssueGalleyDBId($issueGalleyDBId, $DBId)
+    {
+        return $this->issueGalleyDBIds[$issueGalleyDBId] = $DBId;
+    }
+
+    public function getSubmissionDBIds()
+    {
+        return $this->submissionDBIds;
+    }
+
+    public function setSubmissionDBIds($submissionDBIds)
+    {
+        return $this->submissionDBIds = $submissionDBIds;
+    }
+
+    public function getSubmissionDBId($submissionDBId)
+    {
+        if (array_key_exists($submissionDBId, $this->submissionDBIds)) {
+            return $this->submissionDBIds[$submissionDBId];
+        }
+        return null;
+    }
+
+    public function setSubmissionDBId($submissionDBId, $DBId)
+    {
+        return $this->submissionDBIds[$submissionDBId] = $DBId;
+    }
 }
diff --git a/README.md b/README.md
@@ -60,9 +60,6 @@ php tools/importExport.php FullJournalImportExportPlugin import [targzFileName]
 - Stage Assignments
 - Editor Decisions
 - Discussions
-
-**To Do**:
-
 - Metrics
 
 ## Running Tests

diff --git a/filter/filterConfig.xml b/filter/filterConfig.xml
@@ -159,6 +159,13 @@
             description="plugins.importexport.fullJournalTransfer.description"
             inputType="xml::schema(plugins/importexport/fullJournalTransfer/fullJournal.xsd)"
             outputType="class::classes.submission.Submission[]" />
+        <!-- Extended Publication native XML input -->
+        <filterGroup
+            symbolic="native-xml=>extended-publication"
+            displayName="plugins.importexport.fullJournalTransfer.displayName"
+            description="plugins.importexport.fullJournalTransfer.description"
+            inputType="xml::schema(plugins/importexport/fullJournalTransfer/fullJournal.xsd)"
+            outputType="class::classes.publication.Publication[]" />
         <!-- ExtendedIssue native XML output -->
         <filterGroup
             symbolic="extended-issue=>native-xml"
@@ -259,6 +266,10 @@
             inGroup="native-xml=>extended-article"
             class="plugins.importexport.fullJournalTransfer.filter.import.NativeXmlExtendedArticleFilter"
             isTemplate="0" />
+        <filter
+            inGroup="native-xml=>extended-publication"
+            class="plugins.importexport.fullJournalTransfer.filter.import.NativeXmlExtendedPublicationFilter"
+            isTemplate="0" />
         <filter
             inGroup="extended-issue=>native-xml"
             class="plugins.importexport.fullJournalTransfer.filter.export.ExtendedIssueNativeXmlFilter"

diff --git a/filter/import/NativeXmlExtendedArticleFilter.inc.php b/filter/import/NativeXmlExtendedArticleFilter.inc.php
@@ -9,6 +9,24 @@ public function getClassName()
         return 'plugins.importexport.fullJournalTransfer.filter.import.NativeXmlExtendedArticleFilter';
     }
 
+    public function handleElement($node)
+    {
+        $submission = parent::handleElement($node);
+        $deployment = $this->getDeployment();
+
+        if ($submission) {
+            for ($childNode = $node->firstChild; $childNode !== null; $childNode = $childNode->nextSibling) {
+                if (
+                    is_a($childNode, 'DOMElement')
+                    && $childNode->tagName == 'id'
+                    && $childNode->getAttribute('type') == 'internal'
+                ) {
+                    $deployment->setSubmissionDBId($childNode->textContent, $submission->getId());
+                }
+            }
+        }
+    }
+
     public function handleChildElement($node, $submission)
     {
         if ($node->tagName === 'stage') {
@@ -350,4 +368,18 @@ public function parseArticleFile($node)
         $reviewRoundFileDoc->appendChild($reviewRoundFileDoc->importNode($node, true));
         return $importFilter->execute($reviewRoundFileDoc);
     }
+
+    public function getImportFilter($elementName)
+    {
+        if ($elementName == 'publication') {
+            $importClass = 'extended-publication';
+
+            $filterDao = DAORegistry::getDAO('FilterDAO');
+            $importFilters = $filterDao->getObjectsByGroup('native-xml=>' . $importClass);
+            $importFilter = array_shift($importFilters);
+            return $importFilter;
+        }
+
+        return parent::getImportFilter($elementName);
+    }
 }
diff --git a/filter/import/NativeXmlExtendedIssueFilter.inc.php b/filter/import/NativeXmlExtendedIssueFilter.inc.php
@@ -19,6 +19,26 @@ public function getSingularElementName()
         return 'extended_issue';
     }
 
+    public function handleElement($node)
+    {
+        $issue = parent::handleElement($node);
+        $deployment = $this->getDeployment();
+
+        if ($issue) {
+            for ($childNode = $node->firstChild; $childNode !== null; $childNode = $childNode->nextSibling) {
+                if (
+                    is_a($childNode, 'DOMElement')
+                    && $childNode->tagName == 'id'
+                    && $childNode->getAttribute('type') == 'internal'
+                ) {
+                    $deployment->setIssueDBId($childNode->textContent, $issue->getId());
+                }
+            }
+        }
+
+        return $issue;
+    }
+
     public function handleChildElement($node, $issue, $processOnlyChildren)
     {
         $deployment = $this->getDeployment();
@@ -104,4 +124,25 @@ public function parseArticle($node, $issue)
         $articleDoc->appendChild($articleDoc->importNode($node, true));
         return $importFilter->execute($articleDoc);
     }
+
+    public function parseIssueGalley($n, $issue)
+    {
+        $deployment = $this->getDeployment();
+        $importedObjects = parent::parseIssueGalley($n, $issue);
+
+        $issueGalley = array_shift($importedObjects);
+        if (is_a($issueGalley, 'IssueGalley')) {
+            for ($childNode = $n->firstChild; $childNode !== null; $childNode = $childNode->nextSibling) {
+                if (
+                    is_a($childNode, 'DOMElement')
+                    && $childNode->tagName == 'id'
+                    && $childNode->getAttribute('type') == 'internal'
+                ) {
+                    $deployment->setIssueGalleyDBId($childNode->textContent, $issueGalley->getId());
+                }
+            }
+        }
+
+        return $importedObjects;
+    }
 }
diff --git a/filter/import/NativeXmlExtendedPublicationFilter.inc.php b/filter/import/NativeXmlExtendedPublicationFilter.inc.php
@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * Copyright (c) 2014-2021 Simon Fraser University
+ * Copyright (c) 2000-2021 John Willinsky
+ * Copyright (c) 2014-2024 Lepidus Tecnologia
+ * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
+ */
+
+import('plugins.importexport.native.filter.NativeXmlPublicationFilter');
+
+class NativeXmlExtendedPublicationFilter extends NativeXmlPublicationFilter
+{
+    public function getClassName()
+    {
+        return 'plugins.importexport.fullJournalTransfer.filter.import.NativeXmlExtendedPublicationFilter';
+    }
+
+    public function handleChildElement($n, $publication)
+    {
+        $deployment = $this->getDeployment();
+        if ($n->tagName == 'article_galley') {
+            $articleGalleys = $this->parseArticleGalley($n, $publication);
+            $articleGalley = array_shift($articleGalleys);
+            if (is_a($articleGalley, 'ArticleGalley')) {
+                for ($childNode = $n->firstChild; $childNode !== null; $childNode = $childNode->nextSibling) {
+                    if (
+                        is_a($childNode, 'DOMElement')
+                        && $childNode->tagName == 'id'
+                        && $childNode->getAttribute('type') == 'internal'
+                    ) {
+                        $deployment->setRepresentationDBId($childNode->textContent, $articleGalley->getId());
+                    }
+                }
+            }
+            return;
+        }
+        parent::handleChildElement($n, $publication);
+    }
+}
diff --git a/filter/import/NativeXmlJournalFilter.inc.php b/filter/import/NativeXmlJournalFilter.inc.php
@@ -129,6 +129,7 @@ public function handleChildElement($node, $journal)
             'extended_issues' => 'parseIssues',
             'extended_issue' => 'parseIssue',
             'extended_articles' => 'parseArticles',
+            'metrics' => 'parseMetrics'
         ];
 
         if ($node instanceof DOMElement) {
@@ -427,6 +428,48 @@ public function parseArticle($node, $journal)
         return $importFilter->execute($articleDoc);
     }
 
+    public function parseMetrics($node, $journal)
+    {
+        $deployment = $this->getDeployment();
+
+        $metricKeys = [
+            'assoc_type', 'day', 'country_id', 'region', 'city', 'file_type', 'metric', 'metric_type', 'load_id'
+        ];
+
+        for ($childNode = $node->firstChild; $childNode !== null; $childNode = $childNode->nextSibling) {
+            if (is_a($childNode, 'DOMElement') && $childNode->tagName  === 'metric') {
+                $record = [];
+                foreach ($metricKeys as $key) {
+                    $record[$key] = $childNode->getAttribute($key);
+                }
+                $oldAssocId = $childNode->getAttribute('assoc_id');
+                switch ($record['assoc_type']) {
+                    case ASSOC_TYPE_SUBMISSION_FILE:
+                    case ASSOC_TYPE_SUBMISSION_FILE_COUNTER_OTHER:
+                        $record['assoc_id'] = $deployment->getSubmissionFileDBId($oldAssocId);
+                        break;
+                    case ASSOC_TYPE_REPRESENTATION:
+                        $record['assoc_id'] = $deployment->getRepresentationDBId($oldAssocId);
+                        break;
+                    case ASSOC_TYPE_SUBMISSION:
+                        $record['assoc_id'] = $deployment->getSubmissionDBId($oldAssocId);
+                        break;
+                    case Application::getContextAssocType():
+                        $record['assoc_id'] = $journal->getId();
+                        break;
+                    case ASSOC_TYPE_ISSUE_GALLEY:
+                        $record['assoc_id'] = $deployment->getIssueGalleyDBId($oldAssocId);
+                        break;
+                    case ASSOC_TYPE_ISSUE:
+                        $record['assoc_id'] = $deployment->getIssueDBId($oldAssocId);
+                        break;
+                }
+                $metricsDAO = DAORegistry::getDAO('MetricsDAO');
+                $metricsDAO->insertRecord($record);
+            }
+        }
+    }
+
     private function getSimpleJournalNodeMapping()
     {
         return [