PKPNavigationMenuService.inc.php

<?php
 
namespace PKP\Services;
import('lib.pkp.classes.navigationMenu.NavigationMenuItemAssignment');
import('lib.pkp.classes.navigationMenu.NavigationMenuItem');
 
class PKPNavigationMenuService {
 
   public function getMenuItemTypes() {
      \AppLocale::requireComponents(LOCALE_COMPONENT_APP_COMMON, LOCALE_COMPONENT_PKP_USER);
      $types = array(
         NMI_TYPE_CUSTOM => array(
            'title' => __('manager.navigationMenus.customPage'),
            'description' => __('manager.navigationMenus.customPage.description'),
         ),
         NMI_TYPE_REMOTE_URL => array(
            'title' => __('manager.navigationMenus.remoteUrl'),
            'description' => __('manager.navigationMenus.remoteUrl.description'),
         ),
         NMI_TYPE_ABOUT => array(
            'title' => __('navigation.about'),
            'description' => __('manager.navigationMenus.about.description'),
            'conditionalWarning' => __('manager.navigationMenus.about.conditionalWarning'),
         ),
         NMI_TYPE_EDITORIAL_TEAM => array(
            'title' => __('about.editorialTeam'),
            'description' => __('manager.navigationMenus.editorialTeam.description'),
            'conditionalWarning' => __('manager.navigationMenus.editorialTeam.conditionalWarning'),
         ),
         NMI_TYPE_SUBMISSIONS => array(
            'title' => __('about.submissions'),
            'description' => __('manager.navigationMenus.submissions.description'),
         ),
         NMI_TYPE_ANNOUNCEMENTS => array(
            'title' => __('announcement.announcements'),
            'description' => __('manager.navigationMenus.announcements.description'),
            'conditionalWarning' => __('manager.navigationMenus.announcements.conditionalWarning'),
         ),
         NMI_TYPE_USER_LOGIN => array(
            'title' => __('navigation.login'),
            'description' => __('manager.navigationMenus.login.description'),
            'conditionalWarning' => __('manager.navigationMenus.loggedIn.conditionalWarning'),
         ),
         NMI_TYPE_USER_REGISTER => array(
            'title' => __('navigation.register'),
            'description' => __('manager.navigationMenus.register.description'),
            'conditionalWarning' => __('manager.navigationMenus.loggedIn.conditionalWarning'),
         ),
         NMI_TYPE_USER_DASHBOARD => array(
            'title' => __('navigation.dashboard'),
            'description' => __('manager.navigationMenus.dashboard.description'),
            'conditionalWarning' => __('manager.navigationMenus.loggedOut.conditionalWarning'),
         ),
         NMI_TYPE_USER_PROFILE => array(
            'title' => __('common.viewProfile'),
            'description' => __('manager.navigationMenus.profile.description'),
            'conditionalWarning' => __('manager.navigationMenus.loggedOut.conditionalWarning'),
         ),
         NMI_TYPE_ADMINISTRATION => array(
            'title' => __('navigation.admin'),
            'description' => __('manager.navigationMenus.administration.description'),
            'conditionalWarning' => __('manager.navigationMenus.loggedOut.conditionalWarning'),
         ),
         NMI_TYPE_USER_LOGOUT => array(
            'title' => __('user.logOut'),
            'description' => __('manager.navigationMenus.logOut.description'),
            'conditionalWarning' => __('manager.navigationMenus.loggedOut.conditionalWarning'),
         ),
         NMI_TYPE_CONTACT => array(
            'title' => __('about.contact'),
            'description' => __('manager.navigationMenus.contact.description'),
            'conditionalWarning' => __('manager.navigationMenus.contact.conditionalWarning'),
         ),
         NMI_TYPE_SEARCH => array(
            'title' => __('common.search'),
            'description' => __('manager.navigationMenus.search.description'),
         ),
         NMI_TYPE_PRIVACY => array(
            'title' => __('manager.setup.privacyStatement'),
            'description' => __('manager.navigationMenus.privacyStatement.description'),
            'conditionalWarning' => __('manager.navigationMenus.privacyStatement.conditionalWarning'),
         ),
      );
 
      \HookRegistry::call('NavigationMenus::itemTypes', array(&$types));
 
      return $types;
   }
 
   public function getMenuItemCustomEditTemplates() {
      $templates = array(
         NMI_TYPE_CUSTOM => array(
            'template' => 'core:controllers/grid/navigationMenus/customNMIType.tpl',
         ),
         NMI_TYPE_REMOTE_URL => array(
            'template' => 'core:controllers/grid/navigationMenus/remoteUrlNMIType.tpl',
         ),
      );
 
      \HookRegistry::call('NavigationMenus::itemCustomTemplates', array(&$templates));
 
      return $templates;
   }
 
   function getDisplayStatus(&$navigationMenuItem, &$navigationMenu) {
      $request = \Application::get()->getRequest();
      $dispatcher = $request->getDispatcher();
      $templateMgr = \TemplateManager::getManager($request);
 
      $isUserLoggedIn = \Validation::isLoggedIn();
      $isUserLoggedInAs = \Validation::isLoggedInAs();
      $context = $request->getContext();
      $currentUser = $request->getUser();
 
      $contextId = $context ? $context->getId() : CONTEXT_ID_NONE;
 
      // Transform an item title if the title includes a {$variable}
      $this->transformNavMenuItemTitle($templateMgr, $navigationMenuItem);
 
      $menuItemType = $navigationMenuItem->getType();
 
      // Conditionally hide some items
      switch ($menuItemType) {
         case NMI_TYPE_ANNOUNCEMENTS:
            $navigationMenuItem->setIsDisplayed($context && $context->getData('enableAnnouncements'));
            break;
         case NMI_TYPE_EDITORIAL_TEAM:
            $navigationMenuItem->setIsDisplayed($context && $context->getLocalizedData('editorialTeam'));
            break;
         case NMI_TYPE_CONTACT:
            $navigationMenuItem->setIsDisplayed($context && ($context->getData('mailingAddress') || $context->getData('contactName')));
            break;
         case NMI_TYPE_USER_REGISTER:
            $navigationMenuItem->setIsDisplayed(!$isUserLoggedIn && !($context && $context->getData('disableUserReg')));
            break;
         case NMI_TYPE_USER_LOGIN:
            $navigationMenuItem->setIsDisplayed(!$isUserLoggedIn);
            break;
         case NMI_TYPE_USER_LOGOUT:
         case NMI_TYPE_USER_PROFILE:
         case NMI_TYPE_USER_DASHBOARD:
            $navigationMenuItem->setIsDisplayed($isUserLoggedIn);
            break;
         case NMI_TYPE_ADMINISTRATION:
            $navigationMenuItem->setIsDisplayed($isUserLoggedIn && $currentUser->hasRole(array(ROLE_ID_SITE_ADMIN), CONTEXT_SITE));
            break;
         case NMI_TYPE_SEARCH:
            $navigationMenuItem->setIsDisplayed($context);
            break;
         case NMI_TYPE_PRIVACY:
            $navigationMenuItem->setIsDisplayed($context && $context->getLocalizedData('privacyStatement'));
            break;
      }
 
      if ($navigationMenuItem->getIsDisplayed()) {
         // Adjust some titles
         switch ($menuItemType) {
            case NMI_TYPE_USER_LOGOUT:
               if ($isUserLoggedInAs) {
                  $userName = $request->getUser() ? ' ' . $request->getUser()->getUserName() : '';
                  $navigationMenuItem->setTitle(__('user.logOutAs') . $userName, \AppLocale::getLocale());
               }
               break;
            case NMI_TYPE_USER_DASHBOARD:
               $templateMgr->assign('navigationMenuItem', $navigationMenuItem);
               if ($currentUser->hasRole(array(ROLE_ID_MANAGER, ROLE_ID_ASSISTANT, ROLE_ID_REVIEWER, ROLE_ID_AUTHOR), $contextId) || $currentUser->hasRole(array(ROLE_ID_SITE_ADMIN), CONTEXT_SITE)) {
                  $displayTitle = $templateMgr->fetch('frontend/components/navigationMenus/dashboardMenuItem.tpl');
                  $navigationMenuItem->setTitle($displayTitle, \AppLocale::getLocale());
               }
               break;
         }
 
         // Set the URL
         switch ($menuItemType) {
            case NMI_TYPE_ANNOUNCEMENTS:
               $navigationMenuItem->setUrl($dispatcher->url(
                  $request,
                  ROUTE_PAGE,
                  null,
                  'announcement',
                  null,
                  null
               ));
               break;
            case NMI_TYPE_ABOUT:
               $navigationMenuItem->setUrl($dispatcher->url(
                  $request,
                  ROUTE_PAGE,
                  null,
                  'about',
                  null,
                  null
               ));
               break;
            case NMI_TYPE_SUBMISSIONS:
               $navigationMenuItem->setUrl($dispatcher->url(
                  $request,
                  ROUTE_PAGE,
                  null,
                  'about',
                  'submissions',
                  null
               ));
               break;
            case NMI_TYPE_EDITORIAL_TEAM:
               $navigationMenuItem->setUrl($dispatcher->url(
                  $request,
                  ROUTE_PAGE,
                  null,
                  'about',
                  'editorialTeam',
                  null
               ));
               break;
            case NMI_TYPE_CONTACT:
               $navigationMenuItem->setUrl($dispatcher->url(
                  $request,
                  ROUTE_PAGE,
                  null,
                  'about',
                  'contact',
                  null
               ));
               break;
            case NMI_TYPE_USER_LOGOUT:
               $navigationMenuItem->setUrl($dispatcher->url(
                  $request,
                  ROUTE_PAGE,
                  null,
                  'login',
                  $isUserLoggedInAs ? 'signOutAsUser' : 'signOut',
                  null
               ));
               break;
            case NMI_TYPE_USER_PROFILE:
               $navigationMenuItem->setUrl($dispatcher->url(
                  $request,
                  ROUTE_PAGE,
                  null,
                  'user',
                  'profile',
                  null
               ));
               break;
            case NMI_TYPE_ADMINISTRATION:
               $contextPath = 'index';
               $user = $request->getUser();
               $contextDao = \Application::getContextDAO();
               $workingContexts = $contextDao->getAvailable($user?$user->getId():null);
               if ($workingContexts && $workingContexts->getCount() == 1) {
                  $workingContext = $workingContexts->next();
                  $contextPath = $workingContext->getPath();
               }
               $navigationMenuItem->setUrl($dispatcher->url(
                  $request,
                  ROUTE_PAGE,
                  $contextPath,
                  'admin',
                  'index',
                  null
               ));
               break;
            case NMI_TYPE_USER_DASHBOARD:
               if ($currentUser->hasRole(array(ROLE_ID_MANAGER, ROLE_ID_ASSISTANT, ROLE_ID_REVIEWER, ROLE_ID_AUTHOR), $contextId) || $currentUser->hasRole(array(ROLE_ID_SITE_ADMIN), CONTEXT_SITE)) {
                  $navigationMenuItem->setUrl($dispatcher->url(
                     $request,
                     ROUTE_PAGE,
                     null,
                     'submissions',
                     null,
                     null
                  ));
               } else {
                  $navigationMenuItem->setUrl($dispatcher->url(
                     $request,
                     ROUTE_PAGE,
                     null,
                     'user',
                     'profile',
                     null
                  ));
               }
 
               break;
            case NMI_TYPE_USER_REGISTER:
               $navigationMenuItem->setUrl($dispatcher->url(
                  $request,
                  ROUTE_PAGE,
                  null,
                  'user',
                  'register',
                  null
               ));
               break;
            case NMI_TYPE_USER_LOGIN:
               $navigationMenuItem->setUrl($dispatcher->url(
                  $request,
                  ROUTE_PAGE,
                  null,
                  'login',
                  null,
                  null
               ));
               break;
            case NMI_TYPE_CUSTOM:
               if ($navigationMenuItem->getPath()) {
                  $path = explode("/", $navigationMenuItem->getPath());
                  $page = array_shift($path);
                  $op = array_shift($path);
                  $navigationMenuItem->setUrl($dispatcher->url(
                     $request,
                     ROUTE_PAGE,
                     null,
                     $page,
                     $op,
                     $path
                  ));
               }
               break;
            case NMI_TYPE_SEARCH:
               $navigationMenuItem->setUrl($dispatcher->url(
                  $request,
                  ROUTE_PAGE,
                  null,
                  'search',
                  'search',
                  null
               ));
               break;
            case NMI_TYPE_PRIVACY:
               $navigationMenuItem->setUrl($dispatcher->url(
                  $request,
                  ROUTE_PAGE,
                  null,
                  'about',
                  'privacy',
                  null
               ));
               break;
            case NMI_TYPE_REMOTE_URL:
               $navigationMenuItem->setUrl($navigationMenuItem->getLocalizedRemoteUrl());
               break;
         }
      }
 
      \HookRegistry::call('NavigationMenus::displaySettings', array($navigationMenuItem, $navigationMenu));
 
      $templateMgr->assign('navigationMenuItem', $navigationMenuItem);
   }
 
   public function loadMenuTree(&$navigationMenu) {
      $navigationMenuItemDao = \DAORegistry::getDAO('NavigationMenuItemDAO');
      $items = $navigationMenuItemDao->getByMenuId($navigationMenu->getId())->toArray();
 
      $navigationMenuItemAssignmentDao = \DAORegistry::getDAO('NavigationMenuItemAssignmentDAO');
      $assignments = $navigationMenuItemAssignmentDao->getByMenuId($navigationMenu->getId())
            ->toArray();
 
      foreach ($assignments as $assignment) {
         foreach($items as $item) {
            if ($item->getId() === $assignment->getMenuItemId()) {
               $assignment->setMenuItem($item);
               break;
            }
         }
      }
 
      // Create an array of parent items and array of child items sorted by
      // their parent id as the array key
      $navigationMenu->menuTree = array();
      $children = array();
      foreach ($assignments as $assignment) {
         if (!$assignment->getParentId()) {
            $navigationMenu->menuTree[] = $assignment;
         } else {
            if (!isset($children[$assignment->getParentId()])) {
               $children[$assignment->getParentId()] = array();
            }
 
            $children[$assignment->getParentId()][] = $assignment;
         }
      }
 
      // Assign child items to parent in array
      for ($i = 0; $i < count($navigationMenu->menuTree); $i++) {
         $assignmentId = $navigationMenu->menuTree[$i]->getMenuItemId();
         if (isset($children[$assignmentId])) {
            $navigationMenu->menuTree[$i]->children = $children[$assignmentId];
         }
      }
 
      $navigationMenuDao = \DAORegistry::getDAO('NavigationMenuDAO');
      $cache = $navigationMenuDao->getCache($navigationMenu->getId());
      $json = json_encode($navigationMenu);
      $cache->setEntireCache($json);
   }
 
   public function getMenuTree(&$navigationMenu) {
      $navigationMenuDao = \DAORegistry::getDAO('NavigationMenuDAO');
      $cache = $navigationMenuDao->getCache($navigationMenu->getId());
      if ($cache->cache) {
         $navigationMenu = json_decode($cache->cache, true);
         $navigationMenu = $this->arrayToObject('NavigationMenu', $navigationMenu);
         $this->loadMenuTreeDisplayState($navigationMenu);
         return;
      }
      $this->loadMenuTree($navigationMenu);
      $this->loadMenuTreeDisplayState($navigationMenu);
   }
 
   private function loadMenuTreeDisplayState(&$navigationMenu) {
      foreach ($navigationMenu->menuTree as $assignment) {
         $nmi = $assignment->getMenuItem();
         if ($assignment->children) {
            foreach($assignment->children as $childAssignment) {
               $childNmi = $childAssignment->getMenuItem();
               $this->getDisplayStatus($childNmi, $navigationMenu);
 
               if ($childNmi->getIsDisplayed()) {
                  $nmi->setIsChildVisible(true);
               }
            }
         }
         $this->getDisplayStatus($nmi, $navigationMenu);
      }
   }
 
   function arrayToObject($class, $array) {
      if ($class == 'NavigationMenu') {
         $obj = new \NavigationMenu();
      } else if ($class == 'NavigationMenuItem') {
         $obj = new \NavigationMenuItem();
      } else if ($class == 'NavigationMenuItemAssignment') {
         $obj = new \NavigationMenuItemAssignment();
      }
      foreach($array as $k => $v) {
         if(strlen($k)) {
            if(is_array($v) && $k == 'menuTree') {
               $treeChildren = array();
               foreach($v as $treeChild) {
                  array_push($treeChildren, $this->arrayToObject('NavigationMenuItemAssignment', $treeChild));
               }
               $obj->{$k} = $treeChildren;
            } else if(is_array($v) && $k == 'navigationMenuItem') {
               $obj->{$k} = $this->arrayToObject('NavigationMenuItem', $v); //RECURSION
            } else if(is_array($v) && $k == 'children') {
               $treeChildren = array();
               foreach($v as $treeChild) {
                  array_push($treeChildren, $this->arrayToObject('NavigationMenuItemAssignment', $treeChild));
               }
               $obj->{$k} = $treeChildren;
            } else {
               $obj->{$k} = $v;
            }
         }
      }
 
      // should call transformNavMenuItemTitle because some
      // request don't have all template variables in place
      if ($class == 'NavigationMenuItem') {
         $templateMgr = \TemplateManager::getManager(\Application::get()->getRequest());
         $this->transformNavMenuItemTitle($templateMgr, $obj);
      }
 
      return $obj;
   }
 
   public function transformNavMenuItemTitle($templateMgr, &$navigationMenuItem) {
      $this->setNMITitleLocalized($navigationMenuItem);
 
      $title = $navigationMenuItem->getLocalizedTitle();
      $prefix = '{$';
      $postfix = '}';
 
      $prefixPos = strpos($title, $prefix);
      $postfixPos = strpos($title, $postfix);
 
      if ($prefixPos !== false && $postfixPos !== false && ($postfixPos - $prefixPos) > 0){
         $titleRepl = substr($title, $prefixPos + strlen($prefix), $postfixPos - $prefixPos - strlen($prefix));
 
         $templateReplaceTitle = $templateMgr->getTemplateVars($titleRepl);
         if ($templateReplaceTitle) {
            $navigationMenuItem->setTitle($templateReplaceTitle, \AppLocale::getLocale());
         }
      }
   }
 
   public function populateNMIAssignmentContainedObjects(&$nmiAssignment) {
      // Set NMI
      $navigationMenuItemDao = \DAORegistry::getDAO('NavigationMenuItemDAO');
      $nmiAssignment->setMenuItem($navigationMenuItemDao->getById($nmiAssignment->getMenuItemId()));
 
      // Set Children
      $navigationMenuItemAssignmentDao = \DAORegistry::getDAO('NavigationMenuItemAssignmentDAO');
      $nmiAssignment->children = $navigationMenuItemAssignmentDao->getByMenuIdAndParentId($nmiAssignment->getMenuId(), $nmiAssignment->getId())
         ->toArray();
 
      // Recursive call to populate NMI and children properties of NMIAssignment's children
      foreach ($nmiAssignment->children as $assignmentChild) {
         $this->populateNMIAssignmentContainedObjects($assignmentChild);
      }
   }
 
   private function _hasNMTreeNMIAssignmentWithChildOfNMIType($navigationMenu, $navigationMenuItem, $nmiType, $isDisplayed = true) {
      foreach($navigationMenu->menuTree as $nmiAssignment) {
            $nmi = $nmiAssignment->getMenuItem();
         if(isset($nmi) && $nmi->getId() == $navigationMenuItem->getId()) {
            foreach($nmiAssignment->children as $childNmiAssignment){
               $childNmi = $childNmiAssignment->getMenuItem();
               if (isset($nmi) && $childNmi->getType() == $nmiType) {
                  if($isDisplayed) {
                     return $childNmi->getIsDisplayed();
                  } else {
                     return true;
                  }
               }
            }
         }
      }
 
      return false;
   }
 
   public function setNMITitleLocalized($nmi) {
      if ($nmi) {
         \AppLocale::requireComponents(LOCALE_COMPONENT_PKP_COMMON, LOCALE_COMPONENT_PKP_MANAGER, LOCALE_COMPONENT_APP_COMMON, LOCALE_COMPONENT_PKP_USER);
         if ($localisedTitle = $nmi->getLocalizedTitle()) {
            $nmi->setTitle($localisedTitle, \AppLocale::getLocale());
         } elseif ($nmi->getTitleLocaleKey() === '{$loggedInUsername}') {
            $nmi->setTitle($nmi->getTitleLocaleKey(), \AppLocale::getLocale());
         } else {
            $nmi->setTitle(__($nmi->getTitleLocaleKey()), \AppLocale::getLocale());
         }
      }
   }
 
   public function setAllNMILocalisedTitles($nmi) {
      if ($nmi) {
         $supportedFormLocales = \AppLocale::getSupportedFormLocales();
 
         foreach ($supportedFormLocales as $supportedFormLocale => $supportedFormLocaleValue) {
            \AppLocale::requireComponents(
               LOCALE_COMPONENT_PKP_COMMON,
               LOCALE_COMPONENT_PKP_MANAGER,
               LOCALE_COMPONENT_APP_COMMON,
               LOCALE_COMPONENT_PKP_USER,
               $supportedFormLocale
            );
 
            if ($localisedTitle = $nmi->getTitle($supportedFormLocale)) {
               $nmi->setTitle($localisedTitle, $supportedFormLocale);
            } else {
               $nmi->setTitle(__($nmi->getTitleLocaleKey(), array(), $supportedFormLocale), $supportedFormLocale);
            }
         }
      }
   }
 
   public function _callbackHandleCustomNavigationMenuItems($hookName, $args) {
      $request = \Application::get()->getRequest();
 
      $page =& $args[0];
      $op =& $args[1];
 
      // Construct a path to look for
      $path = $page;
      if ($op !== 'index') $path .= "/$op";
      if ($arguments = $request->getRequestedArgs()) $path .= '/' . implode('/', $arguments);
 
      // Look for a static page with the given path
      $navigationMenuItemDao = \DAORegistry::getDAO('NavigationMenuItemDAO');
 
      $context = $request->getContext();
      $contextId = $context?$context->getId():CONTEXT_ID_NONE;
      $customNMI = $navigationMenuItemDao->getByPath($contextId, $path);
 
      // Check if a custom NMI with the requested path existes
      if ($customNMI) {
         // Trick the handler into dealing with it normally
         $page = 'pages';
         $op = 'view';
 
 
         // It is -- attach the custom NMI handler.
         define('HANDLER_CLASS', 'NavigationMenuItemHandler');
         import('lib.pkp.pages.navigationMenu.NavigationMenuItemHandler');
 
         \NavigationMenuItemHandler::setPage($customNMI);
 
         return true;
      }
 
      return false;
   }
}