ManagementHandler.inc.php

<?php
 
// Import the base Handler.
import('classes.handler.Handler');
 
class ManagementHandler extends Handler {
 
   var $_isBackendPage = true;
 
 
   //
   // Overridden methods from Handler
   //
   function initialize($request) {
      parent::initialize($request);
 
      // Load manager locale components.
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_MANAGER, LOCALE_COMPONENT_APP_MANAGER, LOCALE_COMPONENT_PKP_GRID);
 
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign('pageComponent', 'SettingsPage');
   }
 
   function authorize($request, &$args, $roleAssignments) {
      import('lib.pkp.classes.security.authorization.ContextAccessPolicy');
      $this->addPolicy(new ContextAccessPolicy($request, $roleAssignments));
      return parent::authorize($request, $args, $roleAssignments);
   }
 
   function settings($args, $request) {
      $path = array_shift($args);
      switch($path) {
         case 'index':
         case '':
         case 'context':
            $this->context($args, $request);
            break;
         case 'website':
            $this->website($args, $request);
            break;
         case 'workflow':
            $this->workflow($args, $request);
            break;
         case 'distribution':
            $this->distribution($args, $request);
            break;
         case 'access':
            $this->access($args, $request);
            break;
         case 'announcements':
            $this->announcements($args, $request);
            break;
         default:
            assert(false);
            $request->getDispatcher()->handle404();
      }
   }
 
   function context($args, $request) {
      $templateMgr = TemplateManager::getManager($request);
      $this->setupTemplate($request);
      $context = $request->getContext();
      $dispatcher = $request->getDispatcher();
 
      $apiUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), 'contexts/' . $context->getId());
      $publicFileApiUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), '_uploadPublicFile');
 
      $supportedFormLocales = $context->getSupportedFormLocales();
      $localeNames = AppLocale::getAllLocales();
      $locales = array_map(function($localeKey) use ($localeNames) {
         return ['key' => $localeKey, 'label' => $localeNames[$localeKey]];
      }, $supportedFormLocales);
 
      $contactForm = new PKP\components\forms\context\PKPContactForm($apiUrl, $locales, $context);
      $mastheadForm = new APP\components\forms\context\MastheadForm($apiUrl, $locales, $context, $publicFileApiUrl);
 
      $templateMgr->setState([
         'components' => [
            FORM_CONTACT => $contactForm->getConfig(),
            FORM_MASTHEAD => $mastheadForm->getConfig(),
         ],
      ]);
 
      // Display a warning message if there is a new version of OJS available
      if (Config::getVar('general', 'show_upgrade_warning')) {
         import('lib.pkp.classes.site.VersionCheck');
         if ($latestVersion = VersionCheck::checkIfNewVersionExists()) {
            $templateMgr->assign('newVersionAvailable', true);
            $templateMgr->assign('latestVersion', $latestVersion);
            $currentVersion = VersionCheck::getCurrentDBVersion();
            $templateMgr->assign('currentVersion', $currentVersion->getVersionString());
 
            // Get contact information for site administrator
            $roleDao = DAORegistry::getDAO('RoleDAO'); /* @var $roleDao RoleDAO */
            $siteAdmins = $roleDao->getUsersByRoleId(ROLE_ID_SITE_ADMIN);
            $templateMgr->assign('siteAdmin', $siteAdmins->next());
         }
      }
 
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_SUBMISSION);
      $templateMgr->assign('pageTitle', __('manager.setup'));
      $templateMgr->display('management/context.tpl');
   }
 
   function website($args, $request) {
      $templateMgr = TemplateManager::getManager($request);
      $this->setupTemplate($request);
      $context = $request->getContext();
      $dispatcher = $request->getDispatcher();
      $router = $request->getRouter();
 
      $contextApiUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), 'contexts/' . $context->getId());
      $themeApiUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), 'contexts/' . $context->getId() . '/theme');
      $temporaryFileApiUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), 'temporaryFiles');
      $publicFileApiUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), '_uploadPublicFile');
 
      import('classes.file.PublicFileManager');
      $publicFileManager = new PublicFileManager();
      $baseUrl = $request->getBaseUrl() . '/' . $publicFileManager->getContextFilesPath($context->getId());
 
      $supportedFormLocales = $context->getSupportedFormLocales();
      $localeNames = AppLocale::getAllLocales();
      $locales = array_map(function($localeKey) use ($localeNames) {
         return ['key' => $localeKey, 'label' => $localeNames[$localeKey]];
      }, $supportedFormLocales);
 
      $announcementSettingsForm = new \PKP\components\forms\context\PKPAnnouncementSettingsForm($contextApiUrl, $locales, $context);
      $appearanceAdvancedForm = new \APP\components\forms\context\AppearanceAdvancedForm($contextApiUrl, $locales, $context, $baseUrl, $temporaryFileApiUrl, $publicFileApiUrl);
      $appearanceSetupForm = new \APP\components\forms\context\AppearanceSetupForm($contextApiUrl, $locales, $context, $baseUrl, $temporaryFileApiUrl, $publicFileApiUrl);
      $informationForm = new \PKP\components\forms\context\PKPInformationForm($contextApiUrl, $locales, $context, $publicFileApiUrl);
      $listsForm = new \PKP\components\forms\context\PKPListsForm($contextApiUrl, $locales, $context);
      $privacyForm = new \PKP\components\forms\context\PKPPrivacyForm($contextApiUrl, $locales, $context, $publicFileApiUrl);
      $themeForm = new \PKP\components\forms\context\PKPThemeForm($themeApiUrl, $locales, $context);
 
      $templateMgr->setConstants([
         'FORM_ANNOUNCEMENT_SETTINGS',
      ]);
 
      $templateMgr->setState([
         'components' => [
            FORM_ANNOUNCEMENT_SETTINGS => $announcementSettingsForm->getConfig(),
            FORM_APPEARANCE_ADVANCED => $appearanceAdvancedForm->getConfig(),
            FORM_APPEARANCE_SETUP => $appearanceSetupForm->getConfig(),
            FORM_INFORMATION => $informationForm->getConfig(),
            FORM_LISTS => $listsForm->getConfig(),
            FORM_PRIVACY => $privacyForm->getConfig(),
            FORM_THEME => $themeForm->getConfig(),
         ],
         'announcementsNavLink' => [
            'name' => __('announcement.announcements'),
            'url' => $router->url($request, null, 'management', 'settings', 'announcements'),
            'isCurrent' => false,
         ],
      ]);
 
      $templateMgr->assign('pageTitle', __('manager.website.title'));
      $templateMgr->display('management/website.tpl');
   }
 
   function workflow($args, $request) {
      $templateMgr = TemplateManager::getManager($request);
      $this->setupTemplate($request);
      $context = $request->getContext();
      $dispatcher = $request->getDispatcher();
 
      $contextApiUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), 'contexts/' . $context->getId());
      $emailTemplatesApiUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), 'emailTemplates');
 
      AppLocale::requireComponents(
         LOCALE_COMPONENT_PKP_SUBMISSION,
         LOCALE_COMPONENT_APP_SUBMISSION,
         LOCALE_COMPONENT_PKP_EDITOR,
         LOCALE_COMPONENT_APP_EDITOR,
         LOCALE_COMPONENT_PKP_MANAGER,
         LOCALE_COMPONENT_APP_MANAGER
      );
 
      $supportedFormLocales = $context->getSupportedFormLocales();
      $localeNames = AppLocale::getAllLocales();
      $locales = array_map(function($localeKey) use ($localeNames) {
         return ['key' => $localeKey, 'label' => $localeNames[$localeKey]];
      }, $supportedFormLocales);
 
      $authorGuidelinesForm = new \PKP\components\forms\context\PKPAuthorGuidelinesForm($contextApiUrl, $locales, $context);
      $metadataSettingsForm = new \APP\components\forms\context\MetadataSettingsForm($contextApiUrl, $context);
      $emailSetupForm = new \PKP\components\forms\context\PKPEmailSetupForm($contextApiUrl, $locales, $context);
      $reviewGuidanceForm = new \APP\components\forms\context\ReviewGuidanceForm($contextApiUrl, $locales, $context);
      $reviewSetupForm = new \PKP\components\forms\context\PKPReviewSetupForm($contextApiUrl, $locales, $context);
 
      $emailTemplatesListPanel = new \APP\components\listPanels\EmailTemplatesListPanel(
         'emailTemplates',
         __('manager.emails.emailTemplates'),
         $locales,
         [
            'apiUrl' => $emailTemplatesApiUrl,
            'count' => 200,
            'items' => [],
            'itemsMax' => 0,
            'lazyLoad' => true,
         ]
      );
 
      $templateMgr->setState([
         'components' => [
            FORM_AUTHOR_GUIDELINES => $authorGuidelinesForm->getConfig(),
            FORM_METADATA_SETTINGS => $metadataSettingsForm->getConfig(),
            FORM_EMAIL_SETUP => $emailSetupForm->getConfig(),
            FORM_REVIEW_GUIDANCE => $reviewGuidanceForm->getConfig(),
            FORM_REVIEW_SETUP => $reviewSetupForm->getConfig(),
            'emailTemplates' => $emailTemplatesListPanel->getConfig(),
         ],
      ]);
      $templateMgr->assign('pageTitle', __('manager.workflow.title'));
   }
 
   function distribution($args, $request) {
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_SUBMISSION, LOCALE_COMPONENT_APP_SUBMISSION);
      $templateMgr = TemplateManager::getManager($request);
      $this->setupTemplate($request);
      $context = $request->getContext();
      $router = $request->getRouter();
      $dispatcher = $request->getDispatcher();
 
      $apiUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), 'contexts/' . $context->getId());
      $sitemapUrl = $router->url($request, $context->getPath(), 'sitemap');
      $paymentsUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), '_payments');
 
      $supportedFormLocales = $context->getSupportedFormLocales();
      $localeNames = AppLocale::getAllLocales();
      $locales = array_map(function($localeKey) use ($localeNames) {
         return ['key' => $localeKey, 'label' => $localeNames[$localeKey]];
      }, $supportedFormLocales);
 
      $licenseForm = new \APP\components\forms\context\LicenseForm($apiUrl, $locales, $context);
      $searchIndexingForm = new \PKP\components\forms\context\PKPSearchIndexingForm($apiUrl, $locales, $context, $sitemapUrl);
 
      $paymentSettingsForm = new \PKP\components\forms\context\PKPPaymentSettingsForm($paymentsUrl, $locales, $context);
      $templateMgr->setConstants([
         'FORM_PAYMENT_SETTINGS',
      ]);
 
      $templateMgr->setState([
         'components' => [
            FORM_LICENSE => $licenseForm->getConfig(),
            FORM_SEARCH_INDEXING => $searchIndexingForm->getConfig(),
            FORM_PAYMENT_SETTINGS => $paymentSettingsForm->getConfig(),
         ],
         'paymentsNavLink' => [
            'name' => __('common.payments'),
            'url' => $router->url($request, null, 'payments'),
            'isCurrent' => false,
         ],
      ]);
      $templateMgr->assign('pageTitle', __('manager.distribution.title'));
   }
 
   function announcements($args, $request) {
      $templateMgr = TemplateManager::getManager($request);
      $this->setupTemplate($request);
 
      $apiUrl = $request->getDispatcher()->url($request, ROUTE_API, $request->getContext()->getPath(), 'announcements');
 
      $supportedFormLocales = $request->getContext()->getSupportedFormLocales();
      $localeNames = AppLocale::getAllLocales();
      $locales = array_map(function($localeKey) use ($localeNames) {
         return ['key' => $localeKey, 'label' => $localeNames[$localeKey]];
      }, $supportedFormLocales);
 
      $announcementForm = new \PKP\components\forms\announcement\PKPAnnouncementForm($apiUrl, $locales, $request->getContext());
 
      $getParams = [
         'contextIds' => $request->getContext()->getId(),
         'count' => 30,
      ];
      $announcementsIterator = Services::get('announcement')->getMany($getParams);
      $itemsMax = Services::get('announcement')->getMax($getParams);
      $items = [];
      foreach ($announcementsIterator as $announcement) {
         $items[] = Services::get('announcement')->getSummaryProperties($announcement, [
            'request' => $request,
            'announcementContext' => $request->getContext(),
         ]);
      }
 
      $announcementsListPanel = new \PKP\components\listPanels\PKPAnnouncementsListPanel(
         'announcements',
         __('manager.setup.announcements'),
         [
            'apiUrl' => $apiUrl,
            'form' => $announcementForm,
            'getParams' => $getParams,
            'items' => $items,
            'itemsMax' => $itemsMax,
         ]
      );
 
      $templateMgr->setState([
         'components' => [
            $announcementsListPanel->id => $announcementsListPanel->getConfig(),
         ],
      ]);
 
      $templateMgr->assign([
         'pageTitle' => __('manager.setup.announcements'),
      ]);
 
      $templateMgr->display('management/announcements.tpl');
   }
 
   function access($args, $request) {
      $templateMgr = TemplateManager::getManager($request);
      $this->setupTemplate($request);
      $context = $request->getContext();
      $dispatcher = $request->getDispatcher();
 
      $apiUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), 'contexts/' . $context->getId());
 
      $userAccessForm = new \APP\components\forms\context\UserAccessForm($apiUrl, $context);
 
      $templateMgr->setState([
         'components' => [
            FORM_USER_ACCESS => $userAccessForm->getConfig(),
         ],
      ]);
 
      $templateMgr->assign('pageTitle', __('navigation.access'));
      $templateMgr->display('management/access.tpl');
   }
}