| Server IP : 172.66.157.178 / Your IP : 172.16.20.3 Web Server : Apache/2.4.25 (Debian) System : Linux f64a392e70de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 User : application ( 1000) PHP Version : 5.6.40 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /app/plugins/importexport/crossref/classes/ |
Upload File : |
<?php
/**
* @file plugins/importexport/.../classes/DOIExportDom.inc.php
*
* Copyright (c) 2013-2019 Simon Fraser University
* Copyright (c) 2003-2019 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class DOIExportDom
* @ingroup plugins_importexport_..._classes
*
* @brief Onix for DOI (O4DOI) XML export format implementation.
*/
import('lib.pkp.classes.xml.XMLCustomWriter');
define('DOI_EXPORT_FILETYPE_PDF', 'PDF');
define('DOI_EXPORT_FILETYPE_HTML', 'HTML');
define('DOI_EXPORT_FILETYPE_XML', 'XML');
define('DOI_EXPORT_FILETYPE_PS', 'PostScript');
define('DOI_EXPORT_XMLNS_XSI' , 'http://www.w3.org/2001/XMLSchema-instance');
define('DOI_EXPORT_XMLNS_JATS', 'http://www.ncbi.nlm.nih.gov/JATS1');
define('DOI_EXPORT_XMLNS_AI', 'http://www.crossref.org/AccessIndicators.xsd');
class DOIExportDom {
//
// Public properties
//
/** @var array */
var $_errors = array();
/**
* Retrieve export error details.
* @return array
*/
function getErrors() {
return $this->_errors;
}
/**
* Add an error to the errors list.
* @param $errorTranslationKey string An i18n key.
* @param $param string|null An additional translation parameter.
*/
function _addError($errorTranslationKey, $param = null) {
$this->_errors[] = array($errorTranslationKey, $param);
}
//
// Protected properties
//
/** @var XMLNode|DOMImplementation */
var $_doc;
/**
* Get the XML document.
* @return XMLNode|DOMImplementation
*/
function &getDoc() {
return $this->_doc;
}
/** @var Request */
var $_request;
/**
* Get the current request.
* @return Request
*/
function &getRequest() {
return $this->_request;
}
/**
* Are we in test mode?
* @return boolean
*/
function getTestMode() {
$request =& $this->getRequest();
return ($request->getUserVar('testMode') == '1');
}
/** @var DOIExportPlugin */
var $_plugin;
/**
* Get a plug-in setting.
* @return mixed
*/
function getPluginSetting($settingName) {
$plugin =& $this->_plugin;
$journal =& $this->getJournal();
$settingValue = $plugin->getSetting($journal->getId(), $settingName);
assert(!empty($settingValue));
return $settingValue;
}
/** @var Journal */
var $_journal;
/**
* Get the journal (a.k.a. serial title) of this
* O4DOI message.
* @return Journal
*/
function &getJournal() {
return $this->_journal;
}
/** @var PubObjectCache A cache for publication objects */
var $_cache;
/**
* Get the object cache.
* @return PubObjectCache
*/
function &getCache() {
return $this->_cache;
}
//
// Constructor
//
/**
* Constructor
* @param $request Request
* @param $plugin DOIExportPlugin
* @param $journal Journal
* @param $objectCache PubObjectCache
*/
function DOIExportDom(&$request, &$plugin, &$journal, &$objectCache) {
// Configure the DOM.
$this->_doc =& XMLCustomWriter::createDocument();
$this->_request =& $request;
$this->_plugin =& $plugin;
$this->_journal =& $journal;
$this->_cache =& $objectCache;
}
//
// Public methods
//
/**
* Generate the XML document.
*
* This method either returns a fully validated XML document
* containing all given objects for export or it returns a boolean
* 'false' to indicate an error.
*
* If one or more errors occur then DOIExportDom::getErrors()
* will return localized error details for display by the client.
*
* @param $objects array An array of issues, articles or galleys. The
* array must not contain more than one object type.
*
* @return XMLNode|DOMImplementation|boolean An XML document or 'false'
* if an error occurred.
*/
function &generate(&$objects) {
assert(false);
}
//
// Protected template methods
//
/**
* The DOM's root element.
* @return string
*/
function getRootElementName() {
assert(false);
}
/**
* Return the XML namespace.
* @return string
*/
function getNamespace() {
assert(false);
}
/**
* Return the XML schema version.
* @return string
*/
function getXmlSchemaVersion() {
return '';
}
/**
* Return the XML schema location.
* @return string
*/
function getXmlSchemaLocation() {
assert(false);
}
//
// Protected helper methods
//
/**
* Generate the XML root element.
*
* @return XMLNode|DOMImplementation
*/
function &rootElement() {
// Create the root element and make it the document element of the document.
$rootElement =& XMLCustomWriter::createElement($this->getDoc(), $this->getRootElementName());
// Add root-level attributes.
XMLCustomWriter::setAttribute($rootElement, 'xmlns', $this->getNamespace());
XMLCustomWriter::setAttribute($rootElement, 'xmlns:xsi', DOI_EXPORT_XMLNS_XSI);
if ($this->getXMLSchemaVersion() != '') {
XMLCustomWriter::setAttribute($rootElement, 'version', $this->getXMLSchemaVersion());
}
XMLCustomWriter::setAttribute($rootElement, 'xmlns:jats', DOI_EXPORT_XMLNS_JATS);
XMLCustomWriter::setAttribute($rootElement, 'xmlns:ai', DOI_EXPORT_XMLNS_AI);
XMLCustomWriter::setAttribute($rootElement, 'xsi:schemaLocation', $this->getXmlSchemaLocation());
return $rootElement;
}
/**
* Create an XML element with a text node.
*
* FIXME: Move this to XMLCustomWriter? I leave the decision up to PKP...
*
* @param $name string
* @param $value string
* @param $attributes array An array with the attribute names as array
* keys and attribute values as array values.
*
* @return XMLNode|DOMImplementation
*/
function &createElementWithText($name, $value, $attributes = array()) {
$element =& XMLCustomWriter::createElement($this->getDoc(), $name);
$elementContent =& XMLCustomWriter::createTextNode($this->getDoc(), PKPString::html2text($value));
XMLCustomWriter::appendChild($element, $elementContent);
foreach($attributes as $attributeName => $attributeValue) {
XMLCustomWriter::setAttribute($element, $attributeName, $attributeValue);
}
return $element;
}
/**
* Retrieve all the OJS publication objects containing the
* data required to generate the given O4DOI schema.
*
* @param $object Issue|PublishedArticle|ArticleGalley The object to export.
*
* @return array An array with the required OJS objects.
*/
function &retrievePublicationObjects(&$object) {
// Initialize local variables.
$nullVar = null;
$journal =& $this->getJournal();
$cache =& $this->getCache();
// Assign the object itself.
$publicationObjects = array();
switch (true) {
case is_a($object, 'Issue'):
$cache->add($object, $nullVar);
$publicationObjects['issue'] =& $object;
break;
case is_a($object, 'PublishedArticle'):
$cache->add($object, $nullVar);
$publicationObjects['article'] =& $object;
break;
case is_a($object, 'ArticleGalley'):
$publicationObjects['galley'] =& $object;
break;
}
// Retrieve the article related to article files.
if (is_a($object, 'ArticleFile')) {
$articleId = $object->getArticleId();
if ($cache->isCached('articles', $articleId)) {
$article =& $cache->get('articles', $articleId);
} else {
$articleDao =& DAORegistry::getDAO('PublishedArticleDAO'); /* @var $articleDao PublishedArticleDAO */
$article =& $articleDao->getPublishedArticleByArticleId($articleId, $journal->getId());
if ($article) $cache->add($article, $nullVar);
}
assert(is_a($article, 'PublishedArticle'));
$cache->add($object, $article);
$publicationObjects['article'] =& $article;
}
// Retrieve the issue if it's not yet there.
if (!isset($publicationObjects['issue'])) {
assert(isset($publicationObjects['article']));
$issueId = $publicationObjects['article']->getIssueId();
if ($cache->isCached('issues', $issueId)) {
$issue =& $cache->get('issues', $issueId);
} else {
$issueDao =& DAORegistry::getDAO('IssueDAO'); /* @var $issueDao IssueDAO */
$issue =& $issueDao->getIssueById($issueId, $journal->getId());
if ($issue) $cache->add($issue, $nullVar);
}
assert(is_a($issue, 'Issue'));
$publicationObjects['issue'] =& $issue;
}
return $publicationObjects;
}
/**
* Retrieve all articles for the given issue
* and commit them to the cache.
* @param $issue Issue
* @return array
*/
function &retrieveArticlesByIssue(&$issue) {
$articlesByIssue = array();
$cache =& $this->getCache();
$issueId = $issue->getId();
if (!$cache->isCached('articlesByIssue', $issueId)) {
$articleDao =& DAORegistry::getDAO('PublishedArticleDAO'); /* @var $articleDao PublishedArticleDAO */
$articles =& $articleDao->getPublishedArticles($issueId);
if (!empty($articles)) {
foreach ($articles as $article) {
$cache->add($article, $nullVar);
unset($article);
}
$cache->markComplete('articlesByIssue', $issueId);
$articlesByIssue = $cache->get('articlesByIssue', $issueId);
}
} else {
$articlesByIssue = $cache->get('articlesByIssue', $issueId);
}
return $articlesByIssue;
}
/**
* Retrieve all galleys for the given article
* and commit them to the cache.
* @param $article PublishedArticle
* @return array
*/
function &retrieveGalleysByArticle(&$article) {
$galleysByArticle = array();
$cache =& $this->getCache();
$articleId = $article->getId();
if (!$cache->isCached('galleysByArticle', $articleId)) {
$galleyDao =& DAORegistry::getDAO('ArticleGalleyDAO'); /* @var $galleyDao ArticleGalleyDAO */
$galleys =& $galleyDao->getGalleysByArticle($articleId);
if (!empty($galleys)) {
foreach($galleys as $galley) {
$cache->add($galley, $article);
unset($galley);
}
$cache->markComplete('galleysByArticle', $articleId);
$galleysByArticle = $cache->get('galleysByArticle', $articleId);
}
} else {
$galleysByArticle = $cache->get('galleysByArticle', $articleId);
}
return $galleysByArticle;
}
/**
* Identify the locale precedence for this export.
* @param $article PublishedArticle
* @param $galley ArticleGalley
* @return array A list of valid PKP locales in descending
* order of priority.
*/
function getObjectLocalePrecedence(&$article, &$galley) {
$locales = array();
if (is_a($galley, 'ArticleGalley') && AppLocale::isLocaleValid($galley->getLocale())) {
$locales[] = $galley->getLocale();
}
if (is_a($article, 'Submission')) {
// First try to translate the article language into a locale.
$articleLocale = $this->translateLanguageToLocale($article->getLanguage());
if (!is_null($articleLocale)) {
$locales[] = $articleLocale;
}
// Use the article locale as fallback only
// as this is the primary locale of article meta-data, not
// necessarily of the article itself.
if(AppLocale::isLocaleValid($article->getLocale())) {
$locales[] = $article->getLocale();
}
}
// Use the journal locale as fallback.
$journal =& $this->getJournal();
$locales[] = $journal->getPrimaryLocale();
// Use form locales as fallback.
$formLocales = array_keys($journal->getSupportedFormLocaleNames());
// Sort form locales alphabetically so that
// we get a well-defined order.
sort($formLocales);
foreach($formLocales as $formLocale) {
if (!in_array($formLocale, $locales)) $locales[] = $formLocale;
}
assert(!empty($locales));
return $locales;
}
/**
* Try to translate an ISO language code to an OJS locale.
* @param $language string 2- or 3-letter ISO language code
* @return string|null An OJS locale or null if no matching
* locale could be found.
*/
function translateLanguageToLocale($language) {
$locale = null;
if (strlen($language) == 2) {
$language = AppLocale::get3LetterFrom2LetterIsoLanguage($language);
}
if (strlen($language) == 3) {
$language = AppLocale::getLocaleFrom3LetterIso($language);
}
if (AppLocale::isLocaleValid($language)) {
$locale = $language;
}
return $locale;
}
/**
* Identify the primary translation from an array of
* localized data.
* @param $localizedData array An array of localized
* data (key: locale, value: localized data).
* @param $localePrecedence array An array of locales
* by descending priority.
* @return mixed|null The value of the primary locale
* or null if no primary translation could be found.
*/
function getPrimaryTranslation($localizedData, $localePrecedence) {
// Check whether we have localized data at all.
if (!is_array($localizedData) || empty($localizedData)) return null;
// Try all locales from the precedence list first.
foreach($localePrecedence as $locale) {
if (isset($localizedData[$locale]) && !empty($localizedData[$locale])) {
return $localizedData[$locale];
}
}
// As a fallback: use any translation by alphabetical
// order of locales.
ksort($localizedData);
foreach($localizedData as $locale => $value) {
if (!empty($value)) return $value;
}
// If we found nothing (how that?) return null.
return null;
}
/**
* Re-order localized data by locale precedence.
* @param $localizedData array An array of localized
* data (key: locale, value: localized data).
* @param $localePrecedence array An array of locales
* by descending priority.
* @return array Re-ordered localized data.
*/
function getTranslationsByPrecedence($localizedData, $localePrecedence) {
$reorderedLocalizedData = array();
// Check whether we have localized data at all.
if (!is_array($localizedData) || empty($localizedData)) return $reorderedLocalizedData;
// Order by explicit locale precedence first.
foreach($localePrecedence as $locale) {
if (isset($localizedData[$locale]) && !empty($localizedData[$locale])) {
$reorderedLocalizedData[$locale] = $localizedData[$locale];
}
unset($localizedData[$locale]);
}
// Order any remaining values alphabetically by locale
// and amend the re-ordered array.
ksort($localizedData);
$reorderedLocalizedData = array_merge($reorderedLocalizedData, $localizedData);
return $reorderedLocalizedData;
}
/**
* Generate a proprietary ID for the given objects.
*
* The idea is to produce an idea that is globally unique within
* an OJS installation so that we can uniquely identify the exported
* object just by knowing the proprietary ID.
*
* We're using the internal ID rather than the "best ID" as the
* "best ID" can be changed by the end user while the internal ID
* is an automatically assigned database ID that cannot be changed
* without DBA access.
*
* @param $journal Journal
* @param $issue Issue
* @param $articleOrArticleFile PublishedArticle|ArticleFile An object representing an article.
* @param $articleFile ArticleGalley|SuppFile
*
* @return string The proprietary ID for the given objects.
*/
function getProprietaryId(&$journal, $issue = null, $articleOrArticleFile = null, $articleFile = null) {
$proprietaryId = $journal->getId();
if ($issue) $proprietaryId .= '-' . $issue->getId();
if ($articleOrArticleFile) {
assert($issue);
$proprietaryId .= '-';
if (is_a($articleOrArticleFile, 'PublishedArticle')) {
$proprietaryId .= $articleOrArticleFile->getId();
} else {
assert(is_a($articleOrArticleFile, 'ArticleFile'));
$proprietaryId .= $articleOrArticleFile->getArticleId();
}
}
if ($articleFile) {
assert($articleOrArticleFile);
$proprietaryId .= '-';
if (is_a($articleFile, 'ArticleGalley')) {
$proprietaryId .= 'g';
} else {
assert(is_a($articleFile, 'SuppFile'));
$proprietaryId .= 's';
}
$proprietaryId .= $articleFile->getId();
}
return $proprietaryId;
}
/**
* Identify the publisher of the journal.
* @param $localePrecedence array
* @return string
*/
function getPublisher($localePrecedence) {
$journal =& $this->getJournal();
$publisher = $journal->getSetting('publisherInstitution');
if (empty($publisher)) {
// Use the journal title if no publisher is set.
// This corresponds to the logic implemented for OAI interfaces, too.
$publisher = $this->getPrimaryTranslation($journal->getTitle(null), $localePrecedence);
}
assert(!empty($publisher));
return $publisher;
}
/**
* Identify the article subject class and code.
* @param $article PublishedArticle
* @param $objectLocalePrecedence array
* @return array The subject class and code.
*/
function getSubjectClass(&$article, $objectLocalePrecedence) {
$journal =& $this->getJournal();
$subjectSchemeTitle = $this->getPrimaryTranslation($journal->getSetting('metaSubjectClassTitle', null), $objectLocalePrecedence);
$subjectSchemeUrl = $this->getPrimaryTranslation($journal->getSetting('metaSubjectClassUrl', null), $objectLocalePrecedence);
if (empty($subjectSchemeTitle)) {
$subjectSchemeName = $subjectSchemeUrl;
} else {
if (empty($subjectSchemeUrl)) {
$subjectSchemeName = $subjectSchemeTitle;
} else {
$subjectSchemeName = "$subjectSchemeTitle ($subjectSchemeUrl)";
}
}
$subjectCode = $this->getPrimaryTranslation($article->getSubjectClass(null), $objectLocalePrecedence);
return array($subjectSchemeName, $subjectCode);
}
/**
* Try to identify the resource type of the
* given article file.
* @param $articleFile ArticleFile
* @return string|null One of the DOI_EXPORT_FILTYPE_* constants or null.
*/
function getFileType($articleFile) {
// Identify the galley type.
$resourceType = null;
if (is_a($articleFile, 'ArticleXMLGalley')) {
return DOI_EXPORT_FILETYPE_XML;
}
if (is_a($articleFile, 'ArticleHTMLGalley')) {
return DOI_EXPORT_FILETYPE_HTML;
}
if (is_null($resourceType)) {
// Try to guess the resource type from the MIME type.
$fileType = $articleFile->getFileType();
if (!empty($fileType)) {
switch (true) {
case strstr($fileType, 'html'):
return DOI_EXPORT_FILETYPE_HTML;
case strstr($fileType, 'pdf'):
return DOI_EXPORT_FILETYPE_PDF;
case strstr($fileType, 'postscript'):
return DOI_EXPORT_FILETYPE_PS;
case strstr($fileType, 'xml'):
return DOI_EXPORT_FILETYPE_XML;
default:
return null;
}
}
}
}
}
?>