ORCID-Plugin: ORCID button does not show at registration page

michaelk · January 20, 2023, 3:25pm

Dear community,

we run an OJS-installation (v. 3.3.0.8) with an up do date ORCID-Plugin (v1.1.3.4). Although the plugin is enabled, globally configured in config.inc.php, and client ID and client secret are valid, there is not ORCID-Button at the registration page of the journal - see https://region.wu.ac.at/ojs/index.php/region/user/register.

Apart from that, the plugin seems to work: users can connect to their ORCID-account via Edit profile → Public.

Have you any clue or hint why the ORCID button does not show at the registration page?

Thanks for your help, kind regards,

Michael.

ctgraham · January 20, 2023, 10:28pm

In the source code on your registration page, it looks like the plugin is successfully adding the orcidProfile stylesheet:
<link rel="stylesheet" href="https://region.wu.ac.at/ojs/plugins/generic/orcidProfile/css/orcidProfile.css?v=3.3.0.8" type="text/css" />
so, the handleTemplateDisplay() callback is working:

github.com

pkp/orcidProfile/blob/454f9468a96a076ef0cbc8a45bd32fc9d8d61d81/OrcidProfilePlugin.inc.php#L271-L278


      
          		// Assign our private stylesheet, for front and back ends.
          		$templateMgr->addStyleSheet(
          			'orcidProfile',
          			$request->getBaseUrl() . '/' . $this->getStyleSheet(),
          			array(
          				'contexts' => array('frontend', 'backend')
          			)
          		);

The code next looks to see if the current template is named “frontend/pages/userRegister.tpl”, and if so, it registers an outputFilter:

github.com

pkp/orcidProfile/blob/454f9468a96a076ef0cbc8a45bd32fc9d8d61d81/OrcidProfilePlugin.inc.php#L280-L284


      
          		switch ($template) {
          			case 'frontend/pages/userRegister.tpl':
          				$templateMgr->registerFilter("output", array($this, 'registrationFilter'));
          				break;
          		}

Possible ways to go wrong at this point could be a theme which uses a different name for the registration page, or some other plugin with removes the output filter, or some other plugin which overrides the TemplateManager entirely. What themes and plugins are you using? Does the problem resolve if you change the theme or disable other plugins?

If the output filter is successfully being called, it checks to see if there is a journal in context (there is, in your case), and then it modifies the form based on a regular expression which your current page source seems to match:

github.com

pkp/orcidProfile/blob/454f9468a96a076ef0cbc8a45bd32fc9d8d61d81/OrcidProfilePlugin.inc.php#L308


      
          	 * Output filter adds ORCiD interaction to registration form.
          	 *
          	 * @param $output string
          	 * @param $templateMgr TemplateManager
          	 * @return string
          	 */
          	function registrationFilter($output, $templateMgr) {
          		$request = Application::get()->getRequest();
          		$context = $request->getContext();
          		if ($context != null) {
          			if (preg_match('/<form[^>]+id="register"[^>]+>/', $output, $matches, PREG_OFFSET_CAPTURE)) {
          				$match = $matches[0][0];
          				$offset = $matches[0][1];
          				$targetOp = 'register';
          				$templateMgr->assign(array(
          					'targetOp' => $targetOp,
          					'orcidUrl' => $this->getOrcidUrl(),
          					'orcidOAuthUrl' => $this->buildOAuthUrl('orcidAuthorize', array('targetOp' => $targetOp)),
          					'orcidIcon' => $this->getIcon(),
          				));

michaelk · January 23, 2023, 4:11pm

Hi Clinton,
thank you very much for your detailed answer - it helped us a lot, as one of your assumptions was correct: a self-developed plugin was to blame. We disabled it and now the ORCID-Button on the registration page shows up again.
Best regards,
Michael

gunthermaier · January 25, 2023, 4:40pm

Dear Clinton,
thank you for your help identifying the source of the problem. I am the author of the “self-developed plugin” ha Michael mentioned. The code is on Gihub a “gunthermaier/specialIssueTOC”. I tried to correct my code, but cannot find any potential problem.Would you mind taking a look? Your help will be highly appreciated
Best
Gunther