classes/plugins/Plugin.inc.php

<?php

// $Id: Plugin.inc.php,v 1.25 2008/07/01 01:16:10 asmecher Exp $


class Plugin {
   var $pluginPath;

   var $pluginCategory;

   function Plugin() {
   }

   function getPluginPath() {
      return $this->pluginPath;
   }

   function getCategory() {
      return $this->pluginCategory;
   }

   function getSeq() {
      return 0;
   }

   function register($category, $path) {
      $this->pluginPath = $path;
      $this->pluginCategory = $category;
      if ($this->getInstallSchemaFile()) {
         HookRegistry::register ('Installer::postInstall', array(&$this, 'updateSchema'));
      }
      if ($this->getInstallSitePluginSettingsFile()) {
         HookRegistry::register ('Installer::postInstall', array(&$this, 'installSiteSettings'));
      }
      if ($this->getNewJournalPluginSettingsFile()) {
         HookRegistry::register ('JournalSiteSettingsForm::execute', array(&$this, 'installJournalSettings'));
      }
      if ($this->getInstallDataFile()) {
         HookRegistry::register ('Installer::postInstall', array(&$this, 'installData'));
      }
      return true;
   }

   function addLocaleData($locale = null) {
      if ($locale == '') $locale = Locale::getLocale();
      $localeFilename = $this->getLocaleFilename($locale);
      if ($localeFilename) {
         Locale::registerLocaleFile($locale, $this->getLocaleFilename($locale));
         return true;
      }
      return false;
   }

   function getLocaleFilename($locale) {
      return $this->getPluginPath() . DIRECTORY_SEPARATOR . 'locale' . DIRECTORY_SEPARATOR . $locale . DIRECTORY_SEPARATOR . 'locale.xml';
   }

   function addHelpData($locale = null) {
      if ($locale == '') $locale = Locale::getLocale();
      $help =& Help::getHelp();
      import('help.PluginHelpMappingFile');
      $pluginHelpMapping =& new PluginHelpMappingFile($this);
      $help->addMappingFile($pluginHelpMapping);
      return true;
   }

   function getHelpMappingFilename() {
      return $this->getPluginPath() . DIRECTORY_SEPARATOR . 'help.xml';
   }

   function getName() {
      return 'Plugin';
   }

   function getDisplayName() {
      return $this->getName();
   }

   function getDescription() {
      return 'This is the base plugin class. It contains no concrete implementation. Its functions must be overridden by subclasses to provide actual functionality.';
   }

   function getTemplatePath() {
      $basePath = dirname(dirname(dirname(__FILE__)));
      return "file:$basePath/" . $this->getPluginPath() . '/';
   }

   function import($class) {
      require_once($this->getPluginPath() . '/' . str_replace('.', '/', $class) . '.inc.php');
   }

   function getSetting($journalId, $name) {
      if (!Config::getVar('general', 'installed')) return null;
      if (defined('RUNNING_UPGRADE')) {
         // Bug #2504: Make sure plugin_settings table is not
         // used if it's not available.
         $versionDao =& DAORegistry::getDAO('VersionDAO');
         $version =& $versionDao->getCurrentVersion();
         if ($version->compare('2.1.0') < 0) return null;
      }
      $pluginSettingsDao =& DAORegistry::getDAO('PluginSettingsDAO');
      return $pluginSettingsDao->getSetting($journalId, $this->getName(), $name);
   }

   function updateSetting($journalId, $name, $value, $type = null) {
      $pluginSettingsDao =& DAORegistry::getDAO('PluginSettingsDAO');
      $pluginSettingsDao->updateSetting($journalId, $this->getName(), $name, $value, $type);
   }

   function isSitePlugin() {
      return false;
   }

   function getManagementVerbs() {
      return null;
   }

   function manage($verb, $args) {
      return false;
   }

   function smartyPluginUrl($params, &$smarty) {
      $path = array($this->getCategory(), $this->getName());
      if (is_array($params['path'])) {
         $params['path'] = array_merge($path, $params['path']);
      } elseif (!empty($params['path'])) {
         $params['path'] = array_merge($path, array($params['path']));
      } else {
         $params['path'] = $path;
      }
      return $smarty->smartyUrl($params, $smarty);
   }

   function getInstallSchemaFile() {
      return null;
   }

   function updateSchema($hookName, $args) {
      $installer =& $args[0];
      $result =& $args[1];

      $schemaXMLParser = &new adoSchema($installer->dbconn, $installer->dbconn->charSet);
      $sql = $schemaXMLParser->parseSchema($this->getInstallSchemaFile());
      if ($sql) {
         $result = $installer->executeSQL($sql);
      } else {
         $installer->setError(INSTALLER_ERROR_DB, str_replace('{$file}', $this->getInstallSchemaFile(), Locale::translate('installer.installParseDBFileError')));
         $result = false;
      }
      return false;
   }

   function getNewJournalPluginSettingsFile() {
      return null;
   }

   function installJournalSettings($hookName, $args) {
      $journal =& $args[1];
      $isNewJournal = $args[3];

      if (!$isNewJournal) return false;

      $pluginSettingsDao =& DAORegistry::getDAO('PluginSettingsDAO');
      $pluginSettingsDao->installSettings($journal->getJournalId(), $this->getName(), $this->getNewJournalPluginSettingsFile());

      return false;
   }



   function getInstallSitePluginSettingsFile() {
      return null;
   }

   function installSiteSettings($hookName, $args) {
      $installer =& $args[0];
      $result =& $args[1];

      // Settings are only installed during automated installs. FIXME!
      if (!$installer->getParam('manualInstall')) {
         $pluginSettingsDao =& DAORegistry::getDAO('PluginSettingsDAO');
         $pluginSettingsDao->installSettings(0, $this->getName(), $this->getInstallSitePluginSettingsFile());
      }

      return false;
   }

   function getInstallDataFile() {
      return null;
   }

   function installData($hookName, $args) {
      $installer =& $args[0];
      $result =& $args[1];

      $sql = $installer->dataXMLParser->parseData($this->getInstallDataFile());
      if ($sql) {
         $result = $installer->executeSQL($sql);
      } else {
         $installer->setError(INSTALLER_ERROR_DB, str_replace('{$file}', $this->getInstallDataFile(), Locale::translate('installer.installParseDBFileError')));
         $result = false;
      }
      return false;
   }
}
?>

---