ImmersionThemePlugin.inc.php

<?php
 
import('lib.pkp.classes.plugins.ThemePlugin');
class ImmersionThemePlugin extends ThemePlugin {
 
   public function init() {
 
      $this->addStyle(
         'fonts',
         'https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700,700i|Spectral:400,400i,700,700i',
         array('baseUrl' => ''));
 
      // Adding styles (JQuery UI, Bootstrap, Tag-it)
      $this->addStyle('app-css', 'resources/dist/app.min.css');
      $this->addStyle('less', 'resources/less/import.less');
 
      // Styles for HTML galleys
      $this->addStyle('htmlGalley', 'templates/plugins/generic/htmlArticleGalley/css/default.css', array('contexts' => 'htmlGalley'));
 
      // Adding scripts (JQuery, Popper, Bootstrap, JQuery UI, Tag-it, Theme's JS)
      $this->addScript('app-js', 'resources/dist/app.min.js');
 
      // Add navigation menu areas for this theme
      $this->addMenuArea(array('primary', 'user'));
 
      // Option to show section description on the journal's homepage; turned off by default
      $this->addOption('sectionDescriptionSetting', 'FieldOptions', array(
         'label' => __('plugins.themes.immersion.options.sectionDescription.label'),
         'description' => __('plugins.themes.immersion.options.sectionDescription.description'),
         'type' => 'radio',
         'options' => array(
            [
               'value' => 'disable',
               'label'  => __('plugins.themes.immersion.options.sectionDescription.disable'),
            ],
            [
               'value' => 'enable',
               'label'  => __('plugins.themes.immersion.options.sectionDescription.enable'),
            ],
         )
      ));
 
      $this->addOption('journalDescription', 'FieldOptions', array(
         'label' => __('plugins.themes.immersion.options.journalDescription.label'),
         'description' => __('plugins.themes.immersion.options.journalDescription.description'),
         'type' => 'radio',
         'options' => array(
            [
               'value' => 0,
               'label' => __('plugins.themes.immersion.options.journalDescription.disable'),
            ],
            [
               'value' => 1,
               'label' => __('plugins.themes.immersion.options.journalDescription.enable'),
            ],
         )
      ));
 
      $this->addOption('journalDescriptionColour', 'FieldColor', array(
         'label' => __('plugins.themes.immersion.options.journalDescriptionColour.label'),
         'description' => __('plugins.themes.immersion.options.journalDescriptionColour.description'),
         'default' => '#000',
      ));
 
      $this->addOption('immersionAnnouncementsColor', 'FieldColor', array(
         'label' => __('plugins.themes.immersion.announcements.colorPick'),
         'default' => '#000',
      ));
 
 
      // Additional data to the templates
      HookRegistry::register ('TemplateManager::display', array($this, 'addIssueTemplateData'));
      HookRegistry::register ('TemplateManager::display', array($this, 'addSiteWideData'));
      HookRegistry::register ('TemplateManager::display', array($this, 'homepageAnnouncements'));
      HookRegistry::register ('TemplateManager::display', array($this, 'homepageJournalDescription'));
      HookRegistry::register ('issueform::display', array($this, 'addToIssueForm'));
 
      // Check if CSS embedded to the HTML galley
      HookRegistry::register('TemplateManager::display', array($this, 'hasEmbeddedCSS'));
 
      // Additional variable for the issue form
      HookRegistry::register('issuedao::getAdditionalFieldNames', array($this, 'addIssueDAOFieldNames'));
      HookRegistry::register('issueform::initdata', array($this, 'initDataIssueFormFields'));
      HookRegistry::register('issueform::readuservars', array($this, 'readIssueFormFields'));
      HookRegistry::register('issueform::execute', array($this, 'executeIssueFormFields'));
 
      // Load colorpicker on issue management page
      $this->addStyle('spectrum', '/resources/dist/spectrum-1.8.0.css', [
         'contexts' => 'backend-manageIssues',
      ]);
      $this->addScript('spectrum', '/resources/dist/spectrum-1.8.0.js', [
         'contexts' => 'backend-manageIssues',
      ]);
   }
 
   public function getDisplayName() {
      return __('plugins.themes.immersion.name');
   }
 
   public function getDescription() {
      return __('plugins.themes.immersion.description');
   }
 
   public function addIssueTemplateData($hookname, $args) {
 
      /* @var $request Request
       * @var $context Context
       * @var $templateMgr TemplateManager
       * @var $issueDao IssueDAO
       * @var $issue Issue
       * @var $publishedArticleDao PublishedArticleDAO
       * @var $sectionDao SectionDAO
       * @var $sections array
       * @var $section Section
       */
 
      $templateMgr = $args[0];
      $template = $args[1];
      $request = $this->getRequest();
 
      if ($template !== 'frontend/pages/issue.tpl' && $template !== 'frontend/pages/indexJournal.tpl') return false;
 
      $journal = $request->getJournal();
 
      $issueDao = DAORegistry::getDAO('IssueDAO');
 
      if ($template === 'frontend/pages/indexJournal.tpl') {
         $issue = $issueDao->getCurrent($journal->getId(), true);
      } else {
         $issue = $templateMgr->get_template_vars('issue');
      }
 
      if (!$issue) return false;
 
      $publishedSubmissionsInSection = $templateMgr->get_template_vars('publishedSubmissions');
 
      // Section color
      $immersionSectionColors = $issue->getData('immersionSectionColor');
      $sectionDao = DAORegistry::getDAO('SectionDAO');
      $sections = $sectionDao->getByIssueId($issue->getId());
      $lastSectionColor = null;
 
      // Section description; check if this option and BrowseBySection plugin is enabled
      $sectionDescriptionSetting = $this->getOption('sectionDescriptionSetting');
      $pluginSettingsDAO = DAORegistry::getDAO('PluginSettingsDAO');
      $request = PKPApplication::getRequest();
      $context = $request->getContext();
      $contextId = $context ? $context->getId() : 0;
      $browseBySectionSettings = $pluginSettingsDAO->getPluginSettings($contextId, 'browsebysectionplugin');
      $locale = AppLocale::getLocale();
 
      foreach ($publishedSubmissionsInSection as $sectionId => $publishedArticlesBySection) {
         foreach ($sections as $section) {
            if ($section->getId() == $sectionId) {
               // Set section and its background color
               $publishedSubmissionsInSection[$sectionId]['section'] = $section;
               $publishedSubmissionsInSection[$sectionId]['sectionColor'] = $immersionSectionColors[$sectionId];
 
               // Check if section background color is dark
               $isSectionDark = false;
               if ($immersionSectionColors[$sectionId] && $this->isColourDark($immersionSectionColors[$sectionId])) {
                  $isSectionDark = true;
               }
               $publishedSubmissionsInSection[$sectionId]['isSectionDark'] = $isSectionDark;
 
               // Section description
               if ($sectionDescriptionSetting == 'enable' && $browseBySectionSettings['enabled'] && $section->getData('browseByDescription', $locale)) {
                  $publishedSubmissionsInSection[$sectionId]['sectionDescription'] = $section->getData('browseByDescription', $locale);
               }
 
               // Need only the color of the last section that contains articles
               if ($publishedSubmissionsInSection[$sectionId]['articles'] && $immersionSectionColors[$sectionId]) {
                  $lastSectionColor = $immersionSectionColors[$sectionId];
               }
            }
         }
      }
 
      $templateMgr->assign(array(
         'publishedSubmissions' => $publishedSubmissionsInSection,
         'lastSectionColor' => $lastSectionColor
      ));
   }
 
   public function homepageAnnouncements($hookname, $args) {
 
      $templateMgr = $args[0];
      $template = $args[1];
 
      if ($template !== 'frontend/pages/indexJournal.tpl') return false;
 
      $request = $this->getRequest();
      $journal = $request->getJournal();
 
      // Announcements on index journal page
      $announcementsIntro = $journal->getLocalizedData('announcementsIntroduction');
      $immersionAnnouncementsColor = $this->getOption('immersionAnnouncementsColor');
 
      $isAnnouncementDark = false;
      if ($immersionAnnouncementsColor && $this->isColourDark($immersionAnnouncementsColor)) {
         $isAnnouncementDark = true;
      }
 
      $templateMgr->assign(array(
         'announcementsIntroduction'=> $announcementsIntro,
         'isAnnouncementDark' => $isAnnouncementDark,
         'immersionAnnouncementsColor' => $immersionAnnouncementsColor
      ));
   }
 
   public function addSiteWideData($hookname, $args) {
      $templateMgr = $args[0];
 
      $request = $this->getRequest();
      $journal = $request->getJournal();
 
      if (!defined('SESSION_DISABLE_INIT')) {
 
         // Check locales
         if ($journal) {
            $locales = $journal->getSupportedLocaleNames();
         } else {
            $locales = $request->getSite()->getSupportedLocaleNames();
         }
 
         // Load login form
         $loginUrl = $request->url(null, 'login', 'signIn');
         if (Config::getVar('security', 'force_login_ssl')) {
            $loginUrl = PKPString::regexp_replace('/^http:/', 'https:', $loginUrl);
         }
 
         $orcidImageUrl = $this->getPluginPath() . '/templates/images/orcid.png';
 
         if ($request->getContext()) {
            $templateMgr->assign('immersionHomepageImage', $journal->getLocalizedSetting('homepageImage'));
         }
 
         $templateMgr->assign(array(
            'languageToggleLocales' => $locales,
            'loginUrl' => $loginUrl,
            'orcidImageUrl' => $orcidImageUrl
         ));
      }
   }
 
   public function homepageJournalDescription($hookName, $args) {
      $templateMgr = $args[0];
      $template = $args[1];
 
      if ($template != "frontend/pages/indexJournal.tpl") return false;
 
      $journalDescriptionColour = $this->getOption('journalDescriptionColour');
      $isJournalDescriptionDark = false;
      if ($journalDescriptionColour && $this->isColourDark($journalDescriptionColour)) {
         $isJournalDescriptionDark = true;
      }
 
      $templateMgr->assign(array(
         'showJournalDescription' => $this->getOption('journalDescription'),
         'journalDescriptionColour' => $journalDescriptionColour,
         'isJournalDescriptionDark' => $isJournalDescriptionDark
      ));
   }
 
   public function addIssueDAOFieldNames($hookName, $args) {
      $fields =& $args[1];
      $fields[] = 'immersionSectionColor';
   }
 
 
   public function initDataIssueFormFields($hookName, $args) {
      $issueForm = $args[0];
      $issueForm->setData('immersionSectionColor', $issueForm->issue->getData('immersionSectionColor'));
   }
 
   public function readIssueFormFields($hookName, $args) {
      $issueForm =& $args[0];
      $request = $this->getRequest();
 
      $issueForm->setData('immersionSectionColor', $request->getUserVar('immersionSectionColor'));
   }
 
   public function executeIssueFormFields($hookName, $args) {
      $issueForm = $args[0];
      $issue = $args[1];
 
      // The issueform::execute hook fires twice, once at the start of the
      // method when no issue exists. Only update the object during the
      // second request
      if (!$issue) {
         return;
      }
 
      $issue->setData('immersionSectionColor', $issueForm->getData('immersionSectionColor'));
 
      $issueDao = DAORegistry::getDAO('IssueDAO');
      $issueDao->updateObject($issue);
   }
 
   public function addToIssueForm($hookName, $args) {
      $issueForm = $args[0];
 
      // Display only if available as per IssueForm::fetch()
      if ($issueForm->issue) {
         $request = $this->getRequest();
 
         $sectionDao = DAORegistry::getDAO('SectionDAO');
         $sections = $sectionDao->getByIssueId($issueForm->issue->getId());
 
         $templateMgr = TemplateManager::getManager($request);
 
         $templateMgr->assign('sections', $sections);
      }
   }
 
   public function hasEmbeddedCSS($hookName, $args) {
      $templateMgr = $args[0];
      $template = $args[1];
      $request = $this->getRequest();
 
      // Return false if not a galley page
      if ($template !== 'plugins/plugins/generic/htmlArticleGalley/generic/htmlArticleGalley:display.tpl') return false;
 
      $articleArrays = $templateMgr->get_template_vars('article');
 
      // Deafult styling for HTML galley
      $boolEmbeddedCss = false;
      foreach ($articleArrays->getGalleys() as $galley) {
         if ($galley->getFileType() === 'text/html') {
            $submissionFile = $galley->getFile();
 
            $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO');
            import('lib.pkp.classes.submission.SubmissionFile'); // Constants
            $embeddableFiles = array_merge(
               $submissionFileDao->getLatestRevisions($submissionFile->getSubmissionId(), SUBMISSION_FILE_PROOF),
               $submissionFileDao->getLatestRevisionsByAssocId(ASSOC_TYPE_SUBMISSION_FILE, $submissionFile->getFileId(), $submissionFile->getSubmissionId(), SUBMISSION_FILE_DEPENDENT)
            );
 
            foreach ($embeddableFiles as $embeddableFile) {
               if ($embeddableFile->getFileType() == 'text/css') {
                  $boolEmbeddedCss = true;
               }
            }
         }
 
      }
 
      $templateMgr->assign(array(
         'boolEmbeddedCss' => $boolEmbeddedCss,
         'themePath' => $request->getBaseUrl() . "/" . $this->getPluginPath(),
      ));
   }
}