AdminHandler.inc.php

<?php
 
import('classes.handler.Handler');
 
class AdminHandler extends Handler {
 
   var $_isBackendPage = true;
 
   function __construct() {
      parent::__construct();
 
      $this->addRoleAssignment(
         [ROLE_ID_SITE_ADMIN],
         [
            'index',
            'contexts',
            'settings',
            'wizard',
            'systemInfo',
            'phpinfo',
            'expireSessions',
            'clearTemplateCache',
            'clearDataCache',
            'downloadScheduledTaskLogFile',
            'clearScheduledTaskLogFiles',
         ]
      );
   }
 
   function authorize($request, &$args, $roleAssignments) {
      import('lib.pkp.classes.security.authorization.PKPSiteAccessPolicy');
      $this->addPolicy(new PKPSiteAccessPolicy($request, null, $roleAssignments));
      $returner = parent::authorize($request, $args, $roleAssignments);
 
      // Admin shouldn't access this page from a specific context
      if ($request->getContext()) {
         return false;
      }
 
      return $returner;
   }
 
   function initialize($request) {
      AppLocale::requireComponents(
         LOCALE_COMPONENT_PKP_ADMIN,
         LOCALE_COMPONENT_APP_MANAGER,
         LOCALE_COMPONENT_APP_ADMIN,
         LOCALE_COMPONENT_APP_COMMON,
         LOCALE_COMPONENT_PKP_USER,
         LOCALE_COMPONENT_PKP_MANAGER
      );
      $templateMgr = TemplateManager::getManager($request);
 
      $templateMgr->assign([
         'pageComponent' => 'AdminPage',
      ]);
 
      if ($request->getRequestedOp() !== 'index') {
         $router = $request->getRouter();
         $templateMgr->assign([
            'breadcrumbs' => [
               [
                  'id' => 'admin',
                  'url' => $router->url($request, 'index', 'admin'),
                  'name' => __('navigation.admin'),
               ]
            ]
         ]);
      }
 
      if (Config::getVar('general', 'show_upgrade_warning')) {
         import('lib.pkp.classes.site.VersionCheck');
         if ($latestVersion = VersionCheck::checkIfNewVersionExists()) {
            $currentVersion = VersionCheck::getCurrentDBVersion();
            $templateMgr->assign([
               'currentVersion' => $currentVersion,
               'newVersionAvailable' => true,
               'latestVersion' => $latestVersion,
            ]);
         }
      }
 
      return parent::initialize($request);
   }
 
   function index($args, $request) {
      $this->setupTemplate($request);
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->assign([
         'pageTitle' => __('admin.siteAdmin'),
      ]);
      $templateMgr->display('admin/index.tpl');
   }
 
   function contexts($args, $request) {
      $this->setupTemplate($request);
      $templateMgr = TemplateManager::getManager($request);
      $breadcrumbs = $templateMgr->get_template_vars('breadcrumbs');
      $breadcrumbs[] = [
         'id' => 'contexts',
         'name' => __('admin.hostedContexts'),
      ];
      $templateMgr->assign([
         'breadcrumbs' => $breadcrumbs,
         'pageTitle' => __('admin.hostedContexts'),
      ]);
      $templateMgr->display('admin/contexts.tpl');
   }
 
   function settings($args, $request) {
      $this->setupTemplate($request);
      $site = $request->getSite();
      $dispatcher = $request->getDispatcher();
 
      $apiUrl = $dispatcher->url($request, ROUTE_API, CONTEXT_ID_ALL, 'site');
      $themeApiUrl = $dispatcher->url($request, ROUTE_API, CONTEXT_ID_ALL, 'site/theme');
      $temporaryFileApiUrl = $dispatcher->url($request, ROUTE_API, CONTEXT_ID_ALL, 'temporaryFiles');
 
      import('classes.file.PublicFileManager');
      $publicFileManager = new PublicFileManager();
      $baseUrl = $request->getBaseUrl() . '/' . $publicFileManager->getSiteFilesPath();
 
      $supportedLocales = $site->getSupportedLocales();
      $localeNames = AppLocale::getAllLocales();
      $locales = array_map(function($localeKey) use ($localeNames) {
         return ['key' => $localeKey, 'label' => $localeNames[$localeKey]];
      }, $supportedLocales);
 
      $siteAppearanceForm = new \PKP\components\forms\site\PKPSiteAppearanceForm($apiUrl, $locales, $site, $baseUrl, $temporaryFileApiUrl);
      $siteConfigForm = new \PKP\components\forms\site\PKPSiteConfigForm($apiUrl, $locales, $site);
      $siteInformationForm = new \PKP\components\forms\site\PKPSiteInformationForm($apiUrl, $locales, $site);
      $themeForm = new \PKP\components\forms\context\PKPThemeForm($themeApiUrl, $locales);
 
      $templateMgr = TemplateManager::getManager($request);
 
      $templateMgr->setState([
         'components' => [
            FORM_SITE_APPEARANCE => $siteAppearanceForm->getConfig(),
            FORM_SITE_CONFIG => $siteConfigForm->getConfig(),
            FORM_SITE_INFO => $siteInformationForm->getConfig(),
            FORM_THEME => $themeForm->getConfig(),
         ],
      ]);
 
      $breadcrumbs = $templateMgr->get_template_vars('breadcrumbs');
      $breadcrumbs[] = [
         'id' => 'settings',
         'name' => __('admin.siteSettings'),
      ];
      $templateMgr->assign([
         'breadcrumbs' => $breadcrumbs,
         'pageTitle' => __('admin.siteSettings'),
         'componentAvailability' => $this->siteSettingsAvailability($request),
      ]);
 
      $templateMgr->display('admin/settings.tpl');
   }
 
   private function siteSettingsAvailability($request) {
      $tabsSingleContextAvailability = [
         'siteSetup',
         'languages',
      ];
 
      $tabs = [
         'siteSetup',
         'siteAppearance',
         'sitePlugins',
         'siteConfig',
         'siteInfo',
         'languages',
         'navigationMenus',
         'siteTheme',
         'siteAppearanceSetup',
      ];
 
      $singleContextSite = (Services::get('context')->getCount() == 1);
 
      $tabsAvailability = array();
 
      foreach ($tabs as $tab) {
         $tabsAvailability[$tab] = true;
         if ($singleContextSite && !in_array($tab, $tabsSingleContextAvailability)) {
            $tabsAvailability[$tab] = false;
         }
      }
 
      return $tabsAvailability;
   }
 
   public function wizard($args, $request) {
      $this->setupTemplate($request);
      $router = $request->getRouter();
      $dispatcher = $request->getDispatcher();
 
      if (!isset($args[0]) || !ctype_digit((string) $args[0])) {
         $request->getDispatcher()->handle404();
      }
 
      import('classes.core.Services');
      $contextService = Services::get('context');
      $context = $contextService->get((int) $args[0]);
 
      if (empty($context)) {
         $request->getDispatcher()->handle404();
      }
 
      $apiUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), 'contexts/' . $context->getId());
      $themeApiUrl = $dispatcher->url($request, ROUTE_API, $context->getPath(), 'contexts/' . $context->getId() . '/theme');
      $sitemapUrl = $router->url($request, $context->getPath(), 'sitemap');
 
      $supportedFormLocales = $context->getSupportedFormLocales();
      $localeNames = AppLocale::getAllLocales();
      $locales = array_map(function($localeKey) use ($localeNames) {
         return ['key' => $localeKey, 'label' => $localeNames[$localeKey]];
      }, $supportedFormLocales);
 
      $contextForm = new APP\components\forms\context\ContextForm($apiUrl, $locales, $request->getBaseUrl(), $context);
      $themeForm = new PKP\components\forms\context\PKPThemeForm($themeApiUrl, $locales, $context);
      $indexingForm = new PKP\components\forms\context\PKPSearchIndexingForm($apiUrl, $locales, $context, $sitemapUrl);
 
      $templateMgr = TemplateManager::getManager($request);
 
      $templateMgr->setState([
         'components' => [
            FORM_CONTEXT => $contextForm->getConfig(),
            FORM_SEARCH_INDEXING => $indexingForm->getConfig(),
            FORM_THEME => $themeForm->getConfig(),
         ],
      ]);
 
      $breadcrumbs = $templateMgr->get_template_vars('breadcrumbs');
      $breadcrumbs[] = [
         'id' => 'contexts',
         'name' => __('admin.hostedContexts'),
         'url' => $router->url($request, 'index', 'admin', 'contexts'),
      ];
      $breadcrumbs[] = [
         'id' => 'wizard',
         'name' => __('manager.settings.wizard'),
      ];
 
      $templateMgr->assign([
         'breadcrumbs' => $breadcrumbs,
         'editContext' => $context,
         'pageTitle' => __('manager.settings.wizard'),
      ]);
 
      $templateMgr->display('admin/contextSettings.tpl');
   }
 
   function systemInfo($args, $request) {
      $this->setupTemplate($request, true);
 
      $versionDao = DAORegistry::getDAO('VersionDAO'); /* @var $versionDao VersionDAO */
      $currentVersion = $versionDao->getCurrentVersion();
 
      if ($request->getUserVar('versionCheck')) {
         $latestVersionInfo = VersionCheck::getLatestVersion();
         $latestVersionInfo['patch'] = VersionCheck::getPatch($latestVersionInfo);
      }
 
      $versionDao = DAORegistry::getDAO('VersionDAO'); /* @var $versionDao VersionDAO */
      $versionHistory = $versionDao->getVersionHistory();
 
      $dbconn = DBConnection::getConn();
      $dbServerInfo = $dbconn->ServerInfo();
      $serverInfo = [
         'admin.server.platform' => PHP_OS,
         'admin.server.phpVersion' => phpversion(),
         'admin.server.apacheVersion' => $_SERVER['SERVER_SOFTWARE'],
         'admin.server.dbDriver' => Config::getVar('database', 'driver'),
         'admin.server.dbVersion' => (empty($dbServerInfo['description']) ? $dbServerInfo['version'] : $dbServerInfo['description'])
      ];
 
      $templateMgr = TemplateManager::getManager($request);
 
      $breadcrumbs = $templateMgr->get_template_vars('breadcrumbs');
      $breadcrumbs[] = [
         'id' => 'wizard',
         'name' => __('admin.systemInformation'),
      ];
 
      $templateMgr->assign([
         'breadcrumbs' => $breadcrumbs,
         'currentVersion' => $currentVersion,
         'latestVersionInfo' => $latestVersionInfo,
         'pageTitle' => __('admin.systemInformation'),
         'versionHistory' => $versionHistory,
         'serverInfo' => $serverInfo,
         'configData' => Config::getData(),
      ]);
 
      $templateMgr->display('admin/systemInfo.tpl');
   }
 
   function phpinfo() {
      phpinfo();
   }
 
   function expireSessions($args, $request) {
      $sessionDao = DAORegistry::getDAO('SessionDAO'); /* @var $sessionDao SessionDAO */
      $sessionDao->deleteAllSessions();
      $request->redirect(null, 'admin');
   }
 
   function clearTemplateCache($args, $request) {
      $templateMgr = TemplateManager::getManager($request);
      $templateMgr->clearTemplateCache();
      $templateMgr->clearCssCache();
      $request->redirect(null, 'admin');
   }
 
   function clearDataCache($args, $request) {
      // Clear the CacheManager's caches
      $cacheManager = CacheManager::getManager();
      $cacheManager->flush();
 
      // Clear ADODB's cache
      $userDao = DAORegistry::getDAO('UserDAO'); // As good as any
      $userDao->flushCache();
 
      $request->redirect(null, 'admin');
   }
 
   function downloadScheduledTaskLogFile() {
      $request = Application::get()->getRequest();
 
      $file = basename($request->getUserVar('file'));
      import('lib.pkp.classes.scheduledTask.ScheduledTaskHelper');
      ScheduledTaskHelper::downloadExecutionLog($file);
   }
 
   function clearScheduledTaskLogFiles() {
      import('lib.pkp.classes.scheduledTask.ScheduledTaskHelper');
      ScheduledTaskHelper::clearExecutionLogs();
 
      $request = Application::get()->getRequest();
      $request->redirect(null, 'admin');
   }
}