classes/install/form/InstallForm.inc.php

Go to the documentation of this file.

<?php

//$Id$

import('install.Install');
import('site.VersionCheck');
import('form.Form');

class InstallForm extends Form {

   var $supportedLocales;

   var $localesComplete;

   var $supportedClientCharsets;

   var $supportedConnectionCharsets;

   var $supportedDatabaseCharsets;

   var $supportedDatabaseDrivers;

   function InstallForm() {
      parent::Form('install/install.tpl');

      // FIXME Move the below options to an external configuration file?
      $this->supportedLocales = AppLocale::getAllLocales();
      $this->localesComplete = array();
      foreach ($this->supportedLocales as $key => $name) {
         $this->localesComplete[$key] = AppLocale::isLocaleComplete($key);
      }

      $this->supportedClientCharsets = array (
         'utf-8' => 'Unicode (UTF-8)',
         'iso-8859-1' => 'Western (ISO-8859-1)'
      );

      $this->supportedConnectionCharsets = array (
         '' => __('common.notApplicable'),
         'utf8' => 'Unicode (UTF-8)'
      );

      $this->supportedDatabaseCharsets = array (
         '' => __('common.notApplicable'),
         'utf8' => 'Unicode (UTF-8)'
      );

      $this->supportedEncryptionAlgorithms = array (
         'md5' => 'MD5'
      );
      if (function_exists('sha1')) {
         $this->supportedEncryptionAlgorithms['sha1'] = 'SHA1';
      }

      $this->supportedDatabaseDrivers = array (
         // <adodb-driver> => array(<php-module>, <name>)
         'mysql' => array('mysql', 'MySQL'),
         'postgres' => array('pgsql', 'PostgreSQL'),
         'oracle' => array('oci8', 'Oracle'),
         'mssql' => array('mssql', 'MS SQL Server'),
         'fbsql' => array('fbsql', 'FrontBase'),
         'ibase' => array('ibase', 'Interbase'),
         'firebird' => array('ibase', 'Firebird'),
         'informix' => array('ifx', 'Informix'),
         'sybase' => array('sybase', 'Sybase'),
         'odbc' => array('odbc', 'ODBC'),
      );

      // Validation checks for this form
      $this->addCheck(new FormValidatorInSet($this, 'locale', 'required', 'installer.form.localeRequired', array_keys($this->supportedLocales)));
      $this->addCheck(new FormValidatorCustom($this, 'locale', 'required', 'installer.form.localeRequired', array('AppLocale', 'isLocaleValid')));
      $this->addCheck(new FormValidatorInSet($this, 'clientCharset', 'required', 'installer.form.clientCharsetRequired', array_keys($this->supportedClientCharsets)));
      $this->addCheck(new FormValidator($this, 'filesDir', 'required', 'installer.form.filesDirRequired'));
      $this->addCheck(new FormValidatorInSet($this, 'encryption', 'required', 'installer.form.encryptionRequired', array_keys($this->supportedEncryptionAlgorithms)));
      $this->addCheck(new FormValidator($this, 'adminUsername', 'required', 'installer.form.usernameRequired'));
      $this->addCheck(new FormValidatorAlphaNum($this, 'adminUsername', 'required', 'installer.form.usernameAlphaNumeric'));
      $this->addCheck(new FormValidator($this, 'adminPassword', 'required', 'installer.form.passwordRequired'));
      $this->addCheck(new FormValidatorCustom($this, 'adminPassword', 'required', 'installer.form.passwordsDoNotMatch', create_function('$password,$form', 'return $password == $form->getData(\'adminPassword2\');'), array(&$this)));
      $this->addCheck(new FormValidatorEmail($this, 'adminEmail', 'required', 'installer.form.emailRequired'));
      $this->addCheck(new FormValidatorInSet($this, 'databaseDriver', 'required', 'installer.form.databaseDriverRequired', array_keys($this->supportedDatabaseDrivers)));
      $this->addCheck(new FormValidator($this, 'databaseName', 'required', 'installer.form.databaseNameRequired'));
      $this->addCheck(new FormValidatorPost($this));
   }

   function display() {
      $templateMgr =& TemplateManager::getManager();
      $templateMgr->assign('localeOptions', $this->supportedLocales);
      $templateMgr->assign('localesComplete', $this->localesComplete);
      $templateMgr->assign('clientCharsetOptions', $this->supportedClientCharsets);
      $templateMgr->assign('connectionCharsetOptions', $this->supportedConnectionCharsets);
      $templateMgr->assign('databaseCharsetOptions', $this->supportedDatabaseCharsets);
      $templateMgr->assign('encryptionOptions', $this->supportedEncryptionAlgorithms);
      $templateMgr->assign('databaseDriverOptions', $this->checkDBDrivers());
      $templateMgr->assign('supportsMBString', String::hasMBString() ? __('common.yes') : __('common.no'));
      $templateMgr->assign('phpIsSupportedVersion', version_compare(PHP_REQUIRED_VERSION, PHP_VERSION) != 1);
      $templateMgr->assign('phpRequiredVersion', PHP_REQUIRED_VERSION);
      $templateMgr->assign('phpVersion', PHP_VERSION);
      $templateMgr->assign('version', VersionCheck::getCurrentCodeVersion());

      parent::display();
   }

   function initData() {
      $cwd = getcwd();
      if (Core::isWindows()) {
         // Replace backslashes with slashes for the default files directory.
         $cwd = str_replace('\\', '/', $cwd);
      }

      $this->_data = array(
         'locale' => AppLocale::getLocale(),
         'additionalLocales' => array(),
         'clientCharset' => 'utf-8',
         'connectionCharset' => '',
         'databaseCharset' => '',
         'encryption' => 'md5',
         'filesDir' =>  $cwd . '/files',
         'skipFilesDir' =>  0,
         'databaseDriver' => 'mysql',
         'databaseHost' => 'localhost',
         'databaseUsername' => 'ocs',
         'databasePassword' => '',
         'databaseName' => 'ocs',
         'createDatabase' => 1,
         'oaiRepositoryId' => 'ocs.' . Request::getServerHost()
      );
   }

   function readInputData() {
      $this->readUserVars(array(
         'locale',
         'additionalLocales',
         'clientCharset',
         'connectionCharset',
         'databaseCharset',
         'filesDir',
         'skipFilesDir',
         'encryption',
         'adminUsername',
         'adminPassword',
         'adminPassword2',
         'adminEmail',
         'databaseDriver',
         'databaseHost',
         'databaseUsername',
         'databasePassword',
         'databaseName',
         'createDatabase',
         'oaiRepositoryId'
      ));

      if ($this->getData('additionalLocales') == null || !is_array($this->getData('additionalLocales'))) {
         $this->setData('additionalLocales', array());
      }
   }

   function execute() {
      $templateMgr =& TemplateManager::getManager();
      $installer = new Install($this->_data);

      // FIXME Use logger?

      if ($installer->execute()) {
         if (!$installer->wroteConfig()) {
            // Display config file contents for manual replacement
            $templateMgr->assign(array('writeConfigFailed' => true, 'configFileContents' => $installer->getConfigContents()));
         }

         $templateMgr->display('install/installComplete.tpl');

      } else {
         switch ($installer->getErrorType()) {
            case INSTALLER_ERROR_DB:
               $this->dbInstallError($installer->getErrorMsg());
               break;
            default:
               $this->installError($installer->getErrorMsg());
               break;
         }
      }

      $installer->destroy();
   }

   function checkDBDrivers() {
      $dbDrivers = array();
      foreach ($this->supportedDatabaseDrivers as $driver => $info) {
         list($module, $name) = $info;
         if (!extension_loaded($module)) {
            $name = '[ ' . $name . ' ]';
         }
         $dbDrivers[$driver] = $name;
      }
      return $dbDrivers;
   }

   function installError($errorMsg) {
      $templateMgr =& TemplateManager::getManager();
      $templateMgr->assign(array('isInstallError' => true, 'errorMsg' => $errorMsg));
      $this->display();
   }

   function dbInstallError($errorMsg) {
      $templateMgr =& TemplateManager::getManager();
      $templateMgr->assign(array('isInstallError' => true, 'dbErrorMsg' => empty($errorMsg) ? __('common.error.databaseErrorUnknown') : $errorMsg));
      $this->display();
   }

}

?>

---