master/html/ImportExportPlugin_8inc_8php_source.html

<?php


import('lib.pkp.classes.plugins.Plugin');


abstract class ImportExportPlugin extends Plugin {

   var $_request;


   abstract function executeCLI($scriptName, &$args);


   abstract function usage($scriptName);


   function getActions($request, $actionArgs) {

      $dispatcher = $request->getDispatcher();

      import('lib.pkp.classes.linkAction.request.RedirectAction');

      return array_merge(

         array(

            new LinkAction(

               'settings',

               new RedirectAction($dispatcher->url(

                  $request, ROUTE_PAGE,

                  null, 'management', 'importexport', array('plugin', $this->getName())

               )),

               __('manager.importExport'),

               null

            ),

         ),

         parent::getActions($request, $actionArgs)

      );

   }


   function display($args, $request) {

      $templateMgr = TemplateManager::getManager($request);

      $templateMgr->registerPlugin('function', 'plugin_url', array($this, 'pluginUrl'));

      $this->_request = $request; // Store this for use by the pluginUrl function

      $templateMgr->assign([

         'breadcrumbs' => [

            [

               'id' => 'tools',

               'name' => __('navigation.tools'),

               'url' => $request->getRouter()->url($request, null, 'management', 'tools'),

            ],

            [

               'id' => $this->getPluginPath(),

               'name' => $this->getDisplayName()

            ],

         ],

         'pageTitle' => $this->getDisplayName(),

      ]);

   }


   function pluginUrl($params, $smarty) {

      $dispatcher = $this->_request->getDispatcher();

      return $dispatcher->url($this->_request, ROUTE_PAGE, null, 'management', 'importexport', array_merge(array('plugin', $this->getName(), isset($params['path'])?$params['path']:array())));

   }


   function isRelativePath($url) {

      // FIXME This is not very comprehensive, but will work for now.

      if ($this->isAllowedMethod($url)) return false;

      if ($url[0] == '/') return false;

      return true;

   }


   function isAllowedMethod($url) {

      $allowedPrefixes = array(

         'http://',

         'ftp://',

         'https://',

         'ftps://'

      );

      foreach ($allowedPrefixes as $prefix) {

         if (substr($url, 0, strlen($prefix)) === $prefix) return true;

      }

      return false;

   }


   function getPluginSettingsPrefix() {

      return '';

   }


   function getExportPath() {

      return Config::getVar('files', 'files_dir') . '/temp/';

   }


   function getExportFileName($basePath, $objectsFileNamePart, $context, $extension = '.xml') {

      return $basePath . $this->getPluginSettingsPrefix() . '-' . date('Ymd-His') .'-' . $objectsFileNamePart .'-' . $context->getId() . $extension;

   }


   function displayXMLValidationErrors($errors, $xml) {

      AppLocale::requireComponents(LOCALE_COMPONENT_APP_MANAGER, LOCALE_COMPONENT_PKP_MANAGER);

      if (defined('SESSION_DISABLE_INIT')) {

         echo __('plugins.importexport.common.validationErrors') . "\n";

         foreach ($errors as $error) {

            echo trim($error->message) . "\n";

         }

         libxml_clear_errors();

         echo __('plugins.importexport.common.invalidXML') . "\n";

         echo $xml . "\n";

      } else {

         $charset = Config::getVar('i18n', 'client_charset');

         header('Content-type: text/html; charset=' . $charset);

         echo '<html><body>';

         echo '<h2>' . __('plugins.importexport.common.validationErrors') . '</h2>';

         foreach ($errors as $error) {

            echo '<p>' . trim($error->message) . '</p>';

         }

         libxml_clear_errors();

         echo '<h3>' . __('plugins.importexport.common.invalidXML') . '</h3>';

         echo '<p><pre>' . htmlspecialchars($xml) . '</pre></p>';

         echo '</body></html>';

      }

      fatalError(__('plugins.importexport.common.error.validation'));

   }


}