<?php
/**
* @defgroup install Install
* Implements a software installer, including a flexible upgrader that can
* manage schema changes, data representation changes, etc.
*/
/**
* @file classes/install/PKPInstall.php
*
* Copyright (c) 2014-2021 Simon Fraser University
* Copyright (c) 2000-2021 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class PKPInstall
*
* @ingroup install
*
* @see Installer, InstallForm
*
* @brief Perform system installation.
*
* This script will:
* - Create the database (optionally), and install the database tables and initial data.
* - Update the config file with installation parameters.
*/
namespace PKP\install;
use APP\core\Application;
use APP\core\Services;
use APP\facades\Repo;
use Illuminate\Support\Facades\Config as FacadesConfig;
use PKP\config\Config;
use PKP\core\Core;
use PKP\core\PKPString;
use PKP\db\DAORegistry;
use PKP\facades\Locale;
use PKP\file\FileManager;
use PKP\security\Role;
use PKP\security\Validation;
use PKP\services\PKPSchemaService;
use PKP\site\SiteDAO;
use PKP\site\Version;
class PKPInstall extends Installer
{
/** @var int Minimum password length */
public const MIN_PASSWORD_LENGTH = 6;
/**
* Returns true iff this is an upgrade process.
*/
public function isUpgrade()
{
return false;
}
/**
* Pre-installation.
*
* @return bool
*/
public 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 = [];
}
if (!in_array($this->locale, $this->installedLocales) && Locale::isLocaleValid($this->locale)) {
array_push($this->installedLocales, $this->locale);
}
// Map valid config options to Illuminate database drivers
$driver = strtolower($this->getParam('databaseDriver'));
if (substr($driver, 0, 8) === 'postgres') {
$driver = 'pgsql';
} else {
$driver = 'mysql';
}
$config = FacadesConfig::get('database');
$config['default'] = $driver;
$config['connections'][$driver] = [
'driver' => $driver,
'host' => $this->getParam('databaseHost'),
'port' => $this->getParam('databasePort'),
'unix_socket' => $this->getParam('unixSocket'),
'database' => $this->getParam('databaseName'),
'username' => $this->getParam('databaseUsername'),
'password' => $this->getParam('databasePassword'),
'charset' => 'utf8',
'collation' => 'utf8_general_ci',
];
FacadesConfig::set('database', $config);
return parent::preInstall();
}
//
// Installer actions
//
/**
* Get the names of the directories to create.
*
* @return array
*/
public function getCreateDirectories()
{
return ['site'];
}
/**
* Create required files directories
* FIXME No longer needed since FileManager will auto-create?
*
* @return bool
*/
public 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::INSTALLER_ERROR_GENERAL, 'installer.installFilesDirError');
return false;
} else {
// Create required subdirectories
$dirsToCreate = $this->getCreateDirectories();
$dirsToCreate[] = 'usageStats';
$fileManager = new FileManager();
foreach ($dirsToCreate as $dirName) {
$dirToCreate = $this->getParam('filesDir') . '/' . $dirName;
if (!file_exists($dirToCreate)) {
if (!$fileManager->mkdir($dirToCreate)) {
$this->setError(Installer::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::INSTALLER_ERROR_GENERAL, 'installer.publicFilesDirError');
return false;
} else {
// Create required subdirectories
$dirsToCreate = $this->getCreateDirectories();
$fileManager = new FileManager();
foreach ($dirsToCreate as $dirName) {
$dirToCreate = $publicFilesDir . '/' . $dirName;
if (!file_exists($dirToCreate)) {
if (!$fileManager->mkdir($dirToCreate)) {
$this->setError(Installer::INSTALLER_ERROR_GENERAL, 'installer.publicFilesDirError');
return false;
}
}
}
}
return true;
}
/**
* Write the configuration file.
*
* @return bool
*/
public function createConfig()
{
$request = Application::get()->getRequest();
return $this->updateConfig(
[
'general' => [
'installed' => 'On',
'base_url' => $request->getBaseUrl(),
'enable_beacon' => $this->getParam('enableBeacon') ? 'On' : 'Off',
'allowed_hosts' => json_encode([$request->getServerHost(null, false)]),
'time_zone' => $this->getParam('timeZone')
],
'database' => [
'driver' => $this->getParam('databaseDriver'),
'host' => $this->getParam('databaseHost'),
'username' => $this->getParam('databaseUsername'),
'password' => $this->getParam('databasePassword'),
'name' => $this->getParam('databaseName')
],
'i18n' => [
'locale' => $this->getParam('locale'),
'connection_charset' => 'utf8',
],
'files' => [
'files_dir' => $this->getParam('filesDir')
],
'oai' => [
'repository_id' => $this->getParam('oaiRepositoryId')
]
]
);
}
/**
* Create initial required data.
*
* @return bool
*/
public function createData()
{
$siteLocale = $this->getParam('locale');
// Add initial site administrator user
$user = Repo::user()->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->setDateRegistered(Core::getCurrentDate());
$user->setInlineHelp(1);
Repo::user()->add($user);
// Create an admin user group
$adminUserGroup = Repo::userGroup()->newDataObject();
$adminUserGroup->setRoleId(Role::ROLE_ID_SITE_ADMIN);
$adminUserGroup->setContextId(\PKP\core\PKPApplication::CONTEXT_ID_NONE);
$adminUserGroup->setDefault(true);
foreach ($this->installedLocales as $locale) {
$name = __('default.groups.name.siteAdmin', [], $locale);
$namePlural = __('default.groups.plural.siteAdmin', [], $locale);
$adminUserGroup->setData('name', $name, $locale);
$adminUserGroup->setData('namePlural', $namePlural, $locale);
}
Repo::userGroup()->add($adminUserGroup);
// Put the installer into this user group
Repo::userGroup()->assignUserToGroup($user->getId(), $adminUserGroup->getId());
// Add initial site data
/** @var SiteDAO */
$siteDao = DAORegistry::getDAO('SiteDAO');
$site = $siteDao->newDataObject();
$site->setRedirect(0);
$site->setMinPasswordLength(static::MIN_PASSWORD_LENGTH);
$site->setPrimaryLocale($siteLocale);
$site->setInstalledLocales($this->installedLocales);
$site->setSupportedLocales($this->installedLocales);
$site->setUniqueSiteID(PKPString::generateUUID());
$siteDao->insertSite($site);
Repo::emailTemplate()->dao->installEmailTemplates(Repo::emailTemplate()->dao->getMainEmailTemplatesFilename(), $this->installedLocales);
// Install default site settings
$schemaService = Services::get('schema');
$site = $schemaService->setDefaults(PKPSchemaService::SCHEMA_SITE, $site, $site->getSupportedLocales(), $site->getPrimaryLocale());
$site->setData('contactEmail', $this->getParam('adminEmail'), $site->getPrimaryLocale());
$siteDao->updateObject($site);
return true;
}
}
if (!PKP_STRICT_MODE) {
class_alias('\PKP\install\PKPInstall', '\PKPInstall');
}
|