Retrieve user/pass crossref

robertocamargo · November 4, 2019, 1:02pm

Hi i’m working in a plugin development (OJS 3x).

How can I retrieve the full DOI number from the current article and user/pass (crossref)?

Best

Roberto

ctgraham · November 4, 2019, 5:27pm

The existing CrossRef export plugin might be a good reference for this. DOIs are a subtype of Public Identifiers, so if you have a Submission object, you can check for such a stored pubId:

github.com

pkp/ojs/blob/d782213eb7e02f5ac28c917312d42df8f2a6f979/plugins/importexport/crossref/filter/ArticleCrossrefXmlFilter.inc.php#L178



		// license
		if ($submission->getLicenseUrl()) {
			$licenseNode = $doc->createElementNS($deployment->getAINamespace(), 'ai:program');
			$licenseNode->setAttribute('name', 'AccessIndicators');
			$licenseNode->appendChild($node = $doc->createElementNS($deployment->getAINamespace(), 'ai:license_ref', htmlspecialchars($submission->getLicenseUrl(), ENT_COMPAT, 'UTF-8')));
			$journalArticleNode->appendChild($licenseNode);
		}

		// DOI data
		$doiDataNode = $this->createDOIDataNode($doc, $submission->getStoredPubId('doi'), $request->url($context->getPath(), 'article', 'view', $submission->getBestArticleId(), null, null, true));
		// append galleys files and collection nodes to the DOI data node
		$articleGalleyDao = DAORegistry::getDAO('ArticleGalleyDAO');
		$galleys = $articleGalleyDao->getBySubmissionId($submission->getId());
		// All full-texts, PDF full-texts and remote galleys for text-mining and as-crawled URL
		$submissionGalleys = $pdfGalleys = $remoteGalleys = array();
		// preferred PDF full-text for the as-crawled URL
		$pdfGalleyInArticleLocale = null;
		// get immediatelly also supplementary files for component list
		$componentGalleys = array();
		$genreDao = DAORegistry::getDAO('GenreDAO');

The Crossref plugin stores the username and password in its own settings:

github.com

pkp/ojs/blob/d782213eb7e02f5ac28c917312d42df8f2a6f979/plugins/importexport/crossref/CrossRefExportPlugin.inc.php#L133-L134


		$username = $this->getSetting($context->getId(), 'username');
		$password = $this->getSetting($context->getId(), 'password');

To access these settings from another plugin, you’ll need an accessor which can perform similarly to:

github.com

pkp/pkp-lib/blob/e6b8ff663f58ad720fcca8b3fba85236ec67d6a3/classes/plugins/Plugin.inc.php#L441-L459


	/**
	 * Retrieve a plugin setting within the given context
	 *
	 * @param $contextId int Context ID
	 * @param $name string Setting name
	 */
	function getSetting($contextId, $name) {
		if (!defined('RUNNING_UPGRADE') && !Config::getVar('general', 'installed')) return null;

		// Construct the argument list and call the plug-in settings DAO
		$arguments = array(
			$contextId,
			$this->getName(),
			$name,
		);

		$pluginSettingsDao = DAORegistry::getDAO('PluginSettingsDAO');
		return call_user_func_array(array(&$pluginSettingsDao, 'getSetting'), $arguments);
	}

but, with the CrossRef plugin’s name rather than your own plugin’s name.

Alternately, since getSetting() isn’t declared private, you could instanciate a CrossRefExportPlugin and call its getSetting() within your plugin.

Out of curiosity, what functionality are you adding to the Crossref integration? Might it be added as part of the Crossref plugin itself?

robertocamargo · November 4, 2019, 5:45pm

Hi @ctgraham, thank you.

I am working “cited-by” functionality, retrieving all information related to that article.