Mods::getAuthorFromOrcidApi() - Code Metrics - Inspection of "[pull] master from kitodo:master" - Erikmitk/kitodo-presentation - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#123)

unknown
created 2024-05-28 09:32 UTC
Mods::getAuthorFromOrcidApi() A

↳ Parent: Mods
Complexity

Conditions	2
Paths	2
Size

Total Lines	12
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	2
eloc	8
c	1
b	0
f	0
nc	2
nop	3
dl	0
loc	12
rs	10
<?php

/**
 * (c) Kitodo. Key to digital objects e.V. <[email protected]>
 *
 * This file is part of the Kitodo and TYPO3 projects.
 *
 * @license GNU General Public License version 3 or later.
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 */

namespace Kitodo\Dlf\Format;

use Kitodo\Dlf\Api\Orcid\Profile as OrcidProfile;
use Kitodo\Dlf\Api\Viaf\Profile as ViafProfile;
use Kitodo\Dlf\Common\MetadataInterface;

/**
 * Metadata MODS format class for the 'dlf' extension
 *
 * @package TYPO3
 * @subpackage dlf
 *
 * @access public
 */
class Mods implements MetadataInterface
{
    /**
     * @access private
     * @var \SimpleXMLElement The metadata XML
     **/
    private $xml;

    /**
     * @access private
     * @var array The metadata array
     **/
    private $metadata;

    /**
     * @access private
     * @var bool The metadata array
     **/
    private $useExternalApis;

    /**
     * This extracts the essential MODS metadata from XML
     *
     * @access public
     *
     * @param \SimpleXMLElement $xml The XML to extract the metadata from
     * @param array &$metadata The metadata array to fill
     * @param bool $useExternalApis true if external APIs should be called, false otherwise
     *
     * @return void
     */
    public function extractMetadata(\SimpleXMLElement $xml, array &$metadata, bool $useExternalApis): void
    {
        $this->xml = $xml;
        $this->metadata = $metadata;
        $this->useExternalApis = $useExternalApis;

        $this->xml->registerXPathNamespace('mods', 'http://www.loc.gov/mods/v3');

        $this->getAuthors();
        $this->getHolders();
        $this->getPlaces();
        $this->getYears();

        $metadata = $this->metadata;
    }

    /**
     * Get "author" and "author_sorting".
     *
     * @access private
     *
     * @return void
     */
    private function getAuthors(): void
    {
        $authors = $this->xml->xpath('./mods:name[./mods:role/mods:roleTerm[@type="code" and @authority="marcrelator"]="aut"]');

        // Get "author" and "author_sorting" again if that was too sophisticated.
        if (empty($authors)) {
            // Get all names which do not have any role term assigned and assume these are authors.
            $authors = $this->xml->xpath('./mods:name[not(./mods:role)]');
        }
        if (!empty($authors)) {
            for ($i = 0, $j = count($authors); $i < $j; $i++) {
                $authors[$i]->registerXPathNamespace('mods', 'http://www.loc.gov/mods/v3');

                $identifier = $authors[$i]->xpath('./mods:name/mods:nameIdentifier[@type="orcid"]');
                if ($this->useExternalApis && !empty((string) $identifier[0])) {
                    $this->getAuthorFromOrcidApi((string) $identifier[0], $authors, $i);
                } else {
                    $this->getAuthorFromXml($authors, $i);
                }
            }
        }
    }

    /**
     * Get author from ORCID API.
     *
     * @access private
     *
     * @param string $orcidId
     * @param array $authors
     * @param int $i
     *
     * @return void
     */
    private function getAuthorFromOrcidApi(string $orcidId, array $authors, int $i): void
    {
        $profile = new OrcidProfile($orcidId);
        $name = $profile->getFullName();
        if (!empty($name)) {
            $this->metadata['author'][$i] = [
                'name' => $name,
                'url' => 'https://orcid.org/' . $orcidId
            ];
        } else {
            //fallback into display form
            $this->getAuthorFromXmlDisplayForm($authors, $i);
        }
    }

    /**
     * Get author from XML.
     *
     * @access private
     *
     * @param array $authors
     * @param int $i
     *
     * @return void
     */
    private function getAuthorFromXml(array $authors, int $i): void
    {
        $this->getAuthorFromXmlDisplayForm($authors, $i);

        $nameParts = $authors[$i]->xpath('./mods:namePart');

        if (empty($this->metadata['author'][$i]) && $nameParts) {
            $name = [];
            $k = 4;
            foreach ($nameParts as $namePart) {
                if (
                    isset($namePart['type'])
                    && (string) $namePart['type'] == 'family'
                ) {
                    $name[0] = (string) $namePart;
                } elseif (
                    isset($namePart['type'])
                    && (string) $namePart['type'] == 'given'
                ) {
                    $name[1] = (string) $namePart;
                } elseif (
                    isset($namePart['type'])
                    && (string) $namePart['type'] == 'termsOfAddress'
                ) {
                    $name[2] = (string) $namePart;
                } elseif (
                    isset($namePart['type'])
                    && (string) $namePart['type'] == 'date'
                ) {
                    $name[3] = (string) $namePart;
                } else {
                    $name[$k] = (string) $namePart;
                }
                $k++;
            }
            ksort($name);
            $this->metadata['author'][$i] = trim(implode(', ', $name));
        }
        // Append "valueURI" to name using Unicode unit separator.
        if (isset($authors[$i]['valueURI'])) {
            $this->metadata['author'][$i] .= pack('C', 31) . (string) $authors[$i]['valueURI'];
        }
    }

    /**
     * Get author from XML display form.
     *
     * @access private
     *
     * @param array $authors
     * @param int $i
     *
     * @return void
     */
    private function getAuthorFromXmlDisplayForm(array $authors, int $i): void
    {
        $displayForm = $authors[$i]->xpath('./mods:displayForm');
        if ($displayForm) {
            $this->metadata['author'][$i] = (string) $displayForm[0];
        }
    }

    /**
     * Get holder.
     *
     * @access private
     *
     * @return void
     */
    private function getHolders(): void
    {
        $holders = $this->xml->xpath('./mods:name[./mods:role/mods:roleTerm[@type="code" and @authority="marcrelator"]="prv"]');

        if (!empty($holders)) {
            for ($i = 0, $j = count($holders); $i < $j; $i++) {
                $holders[$i]->registerXPathNamespace('mods', 'http://www.loc.gov/mods/v3');

                $identifier = $holders[$i]->xpath('./mods:name/mods:nameIdentifier[@type="viaf"]');
                if ($this->useExternalApis && !empty((string) $identifier[0])) {
                    $this->getHolderFromViafApi((string) $identifier[0], $holders, $i);
                } else {
                    $this->getHolderFromXml($holders, $i);
                }
            }
        }
    }

    /**
     * Get holder from VIAF API.
     *
     * @access private
     *
     * @param string $viafId
     * @param array $holders
     * @param int $i
     *
     * @return void
     */
    private function getHolderFromViafApi(string $viafId, array $holders, int $i): void
    {
        $profile = new ViafProfile($viafId);
        $name = $profile->getFullName();
        if (!empty($name)) {
            $this->metadata['holder'][$i] = [
                'name' => $name,
                'url' => 'http://viaf.org/viaf/' . $viafId
            ];
        } else {
            //fallback into display form
            $this->getHolderFromXmlDisplayForm($holders, $i);
        }
    }

    /**
     * Get holder from XML.
     *
     * @access private
     *
     * @param array $holders
     * @param int $i
     *
     * @return void
     */
    private function getHolderFromXml(array $holders, int $i): void
    {
        $this->getHolderFromXmlDisplayForm($holders, $i);
        // Append "valueURI" to name using Unicode unit separator.
        if (isset($holders[$i]['valueURI'])) {
            $this->metadata['holder'][$i] .= pack('C', 31) . (string) $holders[$i]['valueURI'];
        }
    }

    /**
     * Get holder from XML display form.
     *
     * @access private
     * 
     * @param array $holders
     * @param int $i
     *
     * @return void
     */
    private function getHolderFromXmlDisplayForm(array $holders, int $i): void
    {
        // Check if there is a display form.
        $displayForm = $holders[$i]->xpath('./mods:displayForm');
        if ($displayForm) {
            $this->metadata['holder'][$i] = (string) $displayForm[0];
        }
    }

    /**
     * Get "place" and "place_sorting".
     *
     * @access private
     *
     * @return void
     */
    private function getPlaces(): void
    {
        $places = $this->xml->xpath('./mods:originInfo[not(./mods:edition="[Electronic ed.]")]/mods:place/mods:placeTerm');
        // Get "place" and "place_sorting" again if that was to sophisticated.
        if (empty($places)) {
            // Get all places and assume these are places of publication.
            $places = $this->xml->xpath('./mods:originInfo/mods:place/mods:placeTerm');
        }
        if (!empty($places)) {
            foreach ($places as $place) {
                $this->metadata['place'][] = (string) $place;
                if (!$this->metadata['place_sorting'][0]) {
                    $this->metadata['place_sorting'][0] = preg_replace('/[[:punct:]]/', '', (string) $place);
                }
            }
        }
    }

    /**
     * Get "year" and "year_sorting".
     *
     * @access private
     *
     * @return void
     */
    private function getYears(): void
    {
        // Get "year_sorting".
        $yearsSorting = $this->xml->xpath('./mods:originInfo[not(./mods:edition="[Electronic ed.]")]/mods:dateOther[@type="order" and @encoding="w3cdtf"]');
        if ($yearsSorting) {

            foreach ($yearsSorting as $yearSorting) {
                $this->metadata['year_sorting'][0] = (int) $yearSorting;
            }
        }
        // Get "year" and "year_sorting" if not specified separately.
        $years = $this->xml->xpath('./mods:originInfo[not(./mods:edition="[Electronic ed.]")]/mods:dateIssued[@keyDate="yes"]');
        // Get "year" and "year_sorting" again if that was to sophisticated.
        if (empty($years)) {
            // Get all dates and assume these are dates of publication.
            $years = $this->xml->xpath('./mods:originInfo/mods:dateIssued');
        }
        if (!empty($years)) {
            foreach ($years as $year) {
                $this->metadata['year'][] = (string) $year;
                if (!$this->metadata['year_sorting'][0]) {
                    $yearSorting = str_ireplace('x', '5', preg_replace('/[^\d.x]/i', '', (string) $year));
                    if (
                        strpos($yearSorting, '.')
                        strpos(/** @scrutinizer ignore-type */ $yearSorting, '.')
                        || strlen($yearSorting) < 3
                        || strlen(/** @scrutinizer ignore-type */ $yearSorting) < 3
                    ) {
                        $yearSorting = (((int) trim($yearSorting, '.') - 1) * 100) + 50;
                        $yearSorting = (((int) trim(/** @scrutinizer ignore-type */ $yearSorting, '.') - 1) * 100) + 50;
                    }
                    $this->metadata['year_sorting'][0] = (int) $yearSorting;
                }
            }
        }
    }
}

Erikmitk / kitodo-presentation

Pull Request — master (#123)

Mods::getAuthorFromOrcidApi() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
