PKPInstall.inc.php

<?php
 
import('lib.pkp.classes.install.Installer');
import('classes.core.Services');
 
use Illuminate\Database\Capsule\Manager as Capsule;
 
class PKPInstall extends Installer {
 
   function __construct($xmlDescriptor, $params, $isPlugin) {
      parent::__construct($xmlDescriptor, $params, $isPlugin);
   }
 
   function isUpgrade() {
      return false;
   }
 
   function preInstall() {
      if(!isset($this->currentVersion)) {
         $this->currentVersion = Version::fromString('');
      }
 
      $this->locale = $this->getParam('locale');
      $this->installedLocales = $this->getParam('additionalLocales');
      if (!isset($this->installedLocales) || !is_array($this->installedLocales)) {
         $this->installedLocales = array();
      }
      if (!in_array($this->locale, $this->installedLocales) && AppLocale::isLocaleValid($this->locale)) {
         array_push($this->installedLocales, $this->locale);
      }
 
      // Connect to database
      $conn = new DBConnection(
         $driver = $this->getParam('databaseDriver'),
         $this->getParam('databaseHost'),
         $this->getParam('databaseUsername'),
         $this->getParam('databasePassword'),
         $this->getParam('createDatabase') ? null : $this->getParam('databaseName'),
         false,
         $connectionCharset = $this->getParam('connectionCharset') == '' ? false : $this->getParam('connectionCharset')
      );
 
      $this->dbconn =& $conn->getDBConn();
 
      if (!$conn->isConnected()) {
         $this->setError(INSTALLER_ERROR_DB, $this->dbconn->errorMsg());
         return false;
      }
 
      // Map valid config options to Illuminate database drivers
      $driver = strtolower($driver);
      if (substr($driver, 0, 8) === 'postgres') {
         $driver = 'pgsql';
      } else {
         $driver = 'mysql';
      }
 
      $capsule = new Capsule;
      $capsule->addConnection([
         'driver'    => $driver,
         'host'      => $this->getParam('databaseHost'),
         'database'  => $this->getParam('databaseName'),
         'username'  => $this->getParam('databaseUsername'),
         'password'  => $this->getParam('databasePassword'),
         'charset'   => $connectionCharset == 'latin1'?'latin1':'utf8',
         'collation' => 'utf8_general_ci',
      ]);
      $capsule->setAsGlobal();
 
      DBConnection::getInstance($conn);
 
      return parent::preInstall();
   }
 
 
   //
   // Installer actions
   //
 
   function getCreateDirectories() {
      return array('site');
   }
 
   function createDirectories() {
      // Check if files directory exists and is writeable
      if (!(file_exists($this->getParam('filesDir')) &&  is_writeable($this->getParam('filesDir')))) {
         // Files upload directory unusable
         $this->setError(INSTALLER_ERROR_GENERAL, 'installer.installFilesDirError');
         return false;
      } else {
         // Create required subdirectories
         $dirsToCreate = $this->getCreateDirectories();
         import('lib.pkp.classes.file.FileManager');
         $fileManager = new FileManager();
         foreach ($dirsToCreate as $dirName) {
            $dirToCreate = $this->getParam('filesDir') . '/' . $dirName;
            if (!file_exists($dirToCreate)) {
               if (!$fileManager->mkdir($dirToCreate)) {
                  $this->setError(INSTALLER_ERROR_GENERAL, 'installer.installFilesDirError');
                  return false;
               }
            }
         }
      }
 
      // Check if public files directory exists and is writeable
      $publicFilesDir = Config::getVar('files', 'public_files_dir');
      if (!(file_exists($publicFilesDir) &&  is_writeable($publicFilesDir))) {
         // Public files upload directory unusable
         $this->setError(INSTALLER_ERROR_GENERAL, 'installer.publicFilesDirError');
         return false;
      } else {
         // Create required subdirectories
         $dirsToCreate = $this->getCreateDirectories();
         import('lib.pkp.classes.file.FileManager');
         $fileManager = new FileManager();
         foreach ($dirsToCreate as $dirName) {
            $dirToCreate = $publicFilesDir . '/' . $dirName;
            if (!file_exists($dirToCreate)) {
               if (!$fileManager->mkdir($dirToCreate)) {
                  $this->setError(INSTALLER_ERROR_GENERAL, 'installer.publicFilesDirError');
                  return false;
               }
            }
         }
      }
 
      return true;
   }
 
   function createDatabase() {
      if (!$this->getParam('createDatabase')) {
         return true;
      }
 
      // Get database creation sql
      $dbdict = NewDataDictionary($this->dbconn);
 
      list($sql) = $dbdict->CreateDatabase($this->getParam('databaseName'));
      unset($dbdict);
 
      if (!$this->executeSQL($sql)) {
         return false;
      }
 
      // Re-connect to the created database
      $this->dbconn->disconnect();
 
      $conn = new DBConnection(
         $this->getParam('databaseDriver'),
         $this->getParam('databaseHost'),
         $this->getParam('databaseUsername'),
         $this->getParam('databasePassword'),
         $this->getParam('databaseName'),
         true,
         $this->getParam('connectionCharset') == '' ? false : $this->getParam('connectionCharset')
      );
 
      DBConnection::getInstance($conn);
 
      $this->dbconn =& $conn->getDBConn();
 
      if (!$conn->isConnected()) {
         $this->setError(INSTALLER_ERROR_DB, $this->dbconn->errorMsg());
         return false;
      }
 
      return true;
   }
 
   function createConfig() {
      $request = Application::get()->getRequest();
      return $this->updateConfig(
         array(
            'general' => array(
               'installed' => 'On',
               'base_url' => $request->getBaseUrl(),
               'enable_beacon' => $this->getParam('enableBeacon')?'On':'Off',
            ),
            'database' => array(
               'driver' => $this->getParam('databaseDriver'),
               'host' => $this->getParam('databaseHost'),
               'username' => $this->getParam('databaseUsername'),
               'password' => $this->getParam('databasePassword'),
               'name' => $this->getParam('databaseName')
            ),
            'i18n' => array(
               'locale' => $this->getParam('locale'),
               'client_charset' => $this->getParam('clientCharset'),
               'connection_charset' => $this->getParam('connectionCharset') == '' ? 'Off' : $this->getParam('connectionCharset'),
            ),
            'files' => array(
               'files_dir' => $this->getParam('filesDir')
            ),
            'oai' => array(
               'repository_id' => $this->getParam('oaiRepositoryId')
            )
         )
      );
   }
 
   function createData() {
      $siteLocale = $this->getParam('locale');
 
      // Add initial site administrator user
      $userDao = DAORegistry::getDAO('UserDAO', $this->dbconn);
      $user = $userDao->newDataObject();
      $user->setUsername($this->getParam('adminUsername'));
      $user->setPassword(Validation::encryptCredentials($this->getParam('adminUsername'), $this->getParam('adminPassword'), $this->getParam('encryption')));
      $user->setGivenName($user->getUsername(), $siteLocale);
      $user->setFamilyName($user->getUsername(), $siteLocale);
      $user->setEmail($this->getParam('adminEmail'));
      $user->setInlineHelp(1);
      if (!$userDao->insertObject($user)) {
         $this->setError(INSTALLER_ERROR_DB, $this->dbconn->errorMsg());
         return false;
      }
 
      // Create an admin user group
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_DEFAULT);
      $userGroupDao = DAORegistry::getDAO('UserGroupDAO', $this->dbconn);
      $adminUserGroup = $userGroupDao->newDataObject();
      $adminUserGroup->setRoleId(ROLE_ID_SITE_ADMIN);
      $adminUserGroup->setContextId(CONTEXT_ID_NONE);
      $adminUserGroup->setDefault(true);
      foreach ($this->installedLocales as $locale) {
         $name = __('default.groups.name.siteAdmin', array(), $locale);
         $namePlural = __('default.groups.plural.siteAdmin', array(), $locale);
         $adminUserGroup->setData('name', $name, $locale);
         $adminUserGroup->setData('namePlural', $namePlural, $locale);
      }
      if (!$userGroupDao->insertObject($adminUserGroup)) {
         $this->setError(INSTALLER_ERROR_DB, $this->dbconn->errorMsg());
         return false;
      }
 
      // Put the installer into this user group
      $userGroupDao->assignUserToGroup($user->getId(), $adminUserGroup->getId());
 
      // Add initial site data
      $siteDao = DAORegistry::getDAO('SiteDAO', $this->dbconn);
      $site = $siteDao->newDataObject();
      $site->setRedirect(0);
      $site->setMinPasswordLength(INSTALLER_DEFAULT_MIN_PASSWORD_LENGTH);
      $site->setPrimaryLocale($siteLocale);
      $site->setInstalledLocales($this->installedLocales);
      $site->setSupportedLocales($this->installedLocales);
      if (!$siteDao->insertSite($site)) {
         $this->setError(INSTALLER_ERROR_DB, $this->dbconn->errorMsg());
         return false;
      }
 
      // Install email template list and data for each locale
      foreach ($this->installedLocales as $locale) {
         AppLocale::requireComponents(LOCALE_COMPONENT_APP_EMAIL, $locale);
      }
      $emailTemplateDao = DAORegistry::getDAO('EmailTemplateDAO'); /* @var $emailTemplateDao EmailTemplateDAO */
      $emailTemplateDao->installEmailTemplates($emailTemplateDao->getMainEmailTemplatesFilename(), $this->installedLocales);
 
      // Install default site settings
      $schemaService = Services::get('schema');
      $site = $schemaService->setDefaults(SCHEMA_SITE, $site, $site->getSupportedLocales(), $site->getPrimaryLocale());
      $site->setData('contactEmail', $this->getParam('adminEmail'), $site->getPrimaryLocale());
      $siteDao->updateObject($site);
 
      return true;
   }
}