SubscriptionSSOPlugin.inc.php

<?php
 
import('lib.pkp.classes.plugins.GenericPlugin');
 
class SubscriptionSSOPlugin extends GenericPlugin {
   function register($category, $path, $mainContextId = null) {
      $success = parent::register($category, $path, $mainContextId);
      if (!Config::getVar('general', 'installed') || defined('RUNNING_UPGRADE')) return true;
      if ($success && $this->getEnabled()) {
         $this->addLocaleData();
         HookRegistry::register('LoadHandler',array(&$this, 'loadHandlerCallback'));
         HookRegistry::register('IssueAction::subscribedUser', array(&$this, 'subscribedUserCallback'));
         return true;
      }
      return $success;
   }
 
   function loadHandlerCallback($hookName, $args) {
      $request = Application::get()->getRequest();
      $journal = $request->getJournal();
      if (!$journal) return false;
 
      $incomingParameterName = $this->getSetting($journal->getId(), 'incomingParameterName');
      // Using $_GET rather than Request because this may be case
      // sensitive (e.g. differentiating myid from myId)
      if ($incomingParameterName != '' && isset($_GET[$incomingParameterName])) {
         $incomingKey = $_GET[$incomingParameterName];
 
         // This is an incoming authorization. Contact the remote service.
         $verificationUrl = $this->getSetting($journal->getId(), 'verificationUrl');
         $ch = curl_init();
         curl_setopt($ch, CURLOPT_URL, $verificationUrl . urlencode($incomingKey));
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1) ;
         curl_setopt($ch, CURLOPT_HEADER, 0);
         $result = curl_exec($ch);
         curl_close($ch);
 
         // Verify the result.
         $resultRegexp = $this->getSetting($journal->getId(), 'resultRegexp');
         if (preg_match($resultRegexp, $result)) {
            // Successfully validated.
            $_SESSION['subscriptionSSOTimestamp'] = time();
         } else {
            // Failed to validate.
            unset($_SESSION['subscriptionSSOTimestamp']);
            $request->redirectUrl($this->getSetting($journal->getId(), 'redirectUrl'));
         }
      }
      return false;
   }
 
   function subscribedUserCallback($hookName, $args) {
      // Exclude the index and issue pages.
      $request = Application::get()->getRequest();
      if (in_array($request->getRequestedPage(), array('', 'index', 'search'))) return false;
      // Capture issue galley requests, but not e.g. issue archive
      if ($request->getRequestedPage() == 'issue' && count($request->getRequestedArgs()) != 2) return false;
 
      // Permit an abstract view.
      if ($request->getRequestedPage() == 'article' && $request->getRequestedOp() == 'view' && count($request->getRequestedArgs())==1) return false;
 
      $journal = $args[1];
      $result =& $args[4]; // Reference required
      $result = isset($_SESSION['subscriptionSSOTimestamp']) && $_SESSION['subscriptionSSOTimestamp'] + ($this->getSetting($journal->getId(), 'hoursValid') * 3600) > time();
      if (!$result) {
         // If we're not subscribed, redirect.
         $request->redirectUrl($this->getSetting($journal->getId(), 'redirectUrl') . '?redirectUrl=' . urlencode($request->getRequestUrl()));
      }
   }
 
   function getActions($request, $actionArgs) {
      $router = $request->getRouter();
      import('lib.pkp.classes.linkAction.request.AjaxModal');
      return array_merge(
         $this->getEnabled()?array(
            new LinkAction(
               'settings',
               new AjaxModal(
                  $router->url($request, null, null, 'manage', null, array_merge($actionArgs, array('verb' => 'settings'))),
                  $this->getDisplayName()
               ),
               __('manager.plugins.settings'),
               null
            ),
         ):array(),
         parent::getActions($request, $actionArgs)
      );
   }
 
   function manage($args, $request) {
      $context = $request->getContext();
      $templateMgr = TemplateManager::getManager($request);
 
      switch ($request->getUserVar('verb')) {
         case 'settings':
            $this->import('SubscriptionSSOSettingsForm');
            $form = new SubscriptionSSOSettingsForm($this, $context->getId());
            if ($request->getUserVar('save')) {
               $form->readInputData();
               if ($form->validate()) {
                  $form->execute();
                  return new JSONMessage();
               }
            } else {
               $form->initData();
            }
            return new JSONMessage(true, $form->fetch($request));
      }
      return parent::manage($args, $request);
   }
 
   function getDisplayName() {
      return __('plugins.generic.subscriptionSSO.name');
   }
 
   function getDescription() {
      return __('plugins.generic.subscriptionSSO.description');
   }
}