BrowseBySectionPlugin.inc.php

<?php
 
import('lib.pkp.classes.plugins.GenericPlugin');
 
define('BROWSEBYSECTION_DEFAULT_PER_PAGE', 30);
define('BROWSEBYSECTION_NMI_TYPE', 'BROWSEBYSECTION_NMI_');
 
class BrowseBySectionPlugin extends GenericPlugin {
 
   public function register($category, $path, $mainContextId = NULL) {
      $success = parent::register($category, $path);
      if (!Config::getVar('general', 'installed') || defined('RUNNING_UPGRADE')) return $success;
      if ($success && $this->getEnabled()) {
         HookRegistry::register('LoadHandler', array($this, 'loadPageHandler'));
         HookRegistry::register('sectiondao::getAdditionalFieldNames', array($this, 'addSectionDAOFieldNames'));
         HookRegistry::register('sectiondao::getLocaleFieldNames', array($this, 'addSectionDAOLocaleFieldNames'));
         HookRegistry::register('Templates::Manager::Sections::SectionForm::AdditionalMetadata', array($this, 'addSectionFormFields'));
         HookRegistry::register('sectionform::initdata', array($this, 'initDataSectionFormFields'));
         HookRegistry::register('sectionform::readuservars', array($this, 'readSectionFormFields'));
         HookRegistry::register('sectionform::execute', array($this, 'executeSectionFormFields'));
         HookRegistry::register('NavigationMenus::itemTypes', array($this, 'addMenuItemTypes'));
         HookRegistry::register('NavigationMenus::displaySettings', array($this, 'setMenuItemDisplayDetails'));
         HookRegistry::register('SitemapHandler::createJournalSitemap', array($this, 'addSitemapURLs'));
         $this->_registerTemplateResource();
      }
      return $success;
   }
 
   public function getDisplayName() {
      return __('plugins.generic.browseBySection.name');
   }
 
   public function getDescription() {
      return __('plugins.generic.browseBySection.description');
   }
 
   public function loadPageHandler($hookName, $args) {
      $page = $args[0];
 
      if ($this->getEnabled() && $page === 'section') {
         $this->import('pages/BrowseBySectionHandler');
         define('HANDLER_CLASS', 'BrowseBySectionHandler');
         return true;
      }
 
      return false;
   }
 
   public function addSectionDAOFieldNames($hookName, $args) {
      $fields =& $args[1];
      $fields[] = 'browseByEnabled';
      $fields[] = 'browseByPath';
      $fields[] = 'browseByPerPage';
   }
 
   public function addSectionDAOLocaleFieldNames($hookName, $args) {
      $fields =& $args[1];
      $fields[] = 'browseByDescription';
   }
 
   public function addSectionFormFields($hookName, $args) {
      $smarty =& $args[1];
      $output =& $args[2];
      $output .= $smarty->fetch($this->getTemplateResource('controllers/grids/settings/section/form/sectionFormAdditionalFields.tpl'));
 
      return false;
   }
 
   public function initDataSectionFormFields($hookName, $args) {
      $sectionForm = $args[0];
      $request = Application::get()->getRequest();
      $context = $request->getContext();
      $contextId = $context ? $context->getId() : CONTEXT_ID_NONE;
 
      $sectionDao = DAORegistry::getDAO('SectionDAO');
      $section = $sectionDao->getById($sectionForm->getSectionId(), $contextId);
 
      if ($section) {
         $sectionForm->setData('browseByEnabled', $section->getData('browseByEnabled'));
         $sectionForm->setData('browseByPath', $section->getData('browseByPath'));
         $sectionForm->setData('browseByPerPage', $section->getData('browseByPerPage'));
         $sectionForm->setData('browseByDescription', $section->getData('browseByDescription'));
      }
   }
 
   public function readSectionFormFields($hookName, $args) {
      $sectionForm =& $args[0];
      $request = Application::get()->getRequest();
 
      $sectionForm->setData('browseByEnabled', $request->getUserVar('browseByEnabled'));
      $sectionForm->setData('browseByPath', $request->getUserVar('browseByPath'));
      $sectionForm->setData('browseByPerPage', $request->getUserVar('browseByPerPage'));
      $sectionForm->setData('browseByDescription', $request->getUserVar('browseByDescription', null));
   }
 
   public function executeSectionFormFields($hookName, $args) {
      $sectionDao = DAORegistry::getDAO('SectionDAO');
      $sectionForm = $args[0];
      $section = $sectionDao->getById($sectionForm->getSectionId(), Application::getRequest()->getContext()->getId());
 
      $section->setData('browseByEnabled', $sectionForm->getData('browseByEnabled'));
      $section->setData('browseByDescription', $sectionForm->getData('browseByDescription'));
 
      // Force a valid browseByPath
      $browseByPath = $sectionForm->getData('browseByPath') ? $sectionForm->getData('browseByPath') : '';
      if (empty($browseByPath)) {
         $browseByPath = strtolower($section->getTitle(PKPLocale::getPrimaryLocale()));
      }
      $section->setData('browseByPath', preg_replace('/[^A-Za-z0-9-_]/', '', str_replace(' ', '-', $browseByPath)));
 
      // Force a valid browseByPerPage
      $browseByPerPage = $sectionForm->getData('browseByPerPage') ? $sectionForm->getData('browseByPerPage') : '';
      if (!ctype_digit((string) $browseByPerPage)) {
         $browseByPerPage = null;
      }
      $section->setData('browseByPerPage', $browseByPerPage);
 
      $sectionDao->updateObject($section);
   }
 
   public function addMenuItemTypes($hookName, $args) {
      $types =& $args[0];
      $request = Application::get()->getRequest();
      $context = $request->getContext();
      $contextId = $context ? $context->getId() : CONTEXT_ID_NONE;
 
      $sectionDao = DAORegistry::getDAO('SectionDAO');
      $sections = $sectionDao->getByContextId($contextId);
 
      while ($section = $sections->next()) {
         if ($section->getData('browseByEnabled')) {
            $types[BROWSEBYSECTION_NMI_TYPE . $section->getId()] = array(
               'title' => __('plugins.generic.browseBySection.navMenuItem', array('name' => $section->getLocalizedTitle())),
               'description' => __('plugins.generic.browseBySection.navMenuItem.description'),
            );
         }
      }
   }
 
   public function setMenuItemDisplayDetails($hookName, $args) {
      $navigationMenuItem =& $args[0];
      $typePrefixLength = strlen(BROWSEBYSECTION_NMI_TYPE);
 
      if (substr($navigationMenuItem->getType(), 0, $typePrefixLength) === BROWSEBYSECTION_NMI_TYPE) {
         $request = Application::get()->getRequest();
         $context = $request->getContext();
         $contextId = $context ? $context->getId() : CONTEXT_ID_NONE;
         $sectionId = substr($navigationMenuItem->getType(), $typePrefixLength);
         $sectionDao = DAORegistry::getDAO('SectionDAO');
         $section = $sectionDao->getById($sectionId, $contextId);
         if (!$section->getData('browseByEnabled')) {
            $navigationMenuItem->setIsDisplayed(false);
         } else {
            $sectionPath = $section->getData('browseByPath') ? $section->getData('browseByPath') : $sectionId;
            $dispatcher = $request->getDispatcher();
            $navigationMenuItem->setUrl($dispatcher->url(
               $request,
               ROUTE_PAGE,
               null,
               'section',
               'view',
               htmlspecialchars($sectionPath)
            ));
         }
      }
   }
 
   function addSitemapURLs($hookName, $args) {
      $doc = $args[0];
      $rootNode = $doc->documentElement;
 
      $request = Application::getRequest();
      $context = $request->getContext();
      if ($context) {
         $sectionDao = DAORegistry::getDAO('SectionDAO');
         $sections = $sectionDao->getByContextId($context->getId());
         while ($section = $sections->next()) {
            if ($section->getData('browseByEnabled')) {
               $sectionPath = $section->getData('browseByPath') ? $section->getData('browseByPath') : $section->getId();
               // Create and append sitemap XML "url" element
               $url = $doc->createElement('url');
               $url->appendChild($doc->createElement('loc', htmlspecialchars($request->url($context->getPath(), 'section', 'view', $sectionPath), ENT_COMPAT, 'UTF-8')));
               $rootNode->appendChild($url);
            }
         }
      }
      return false;
   }
}