mirror of
https://github.com/nuxsmin/sysPass.git
synced 2026-03-03 07:04:07 +01:00
4d6104b839
* [ADD] Upgrade service. Work in progress. * [MOD] Context based session data. Added collection class to manage session properties. * [MOD] Code refactoring. * [MOD] Improved theme icons load by caching objects.
555 lines
18 KiB
PHP
555 lines
18 KiB
PHP
<?php
|
|
|
|
/**
|
|
* sysPass
|
|
*
|
|
* @author nuxsmin
|
|
* @link https://syspass.org
|
|
* @copyright 2012-2018, Rubén Domínguez nuxsmin@$syspass.org
|
|
*
|
|
* This file is part of sysPass.
|
|
*
|
|
* sysPass is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* sysPass is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
namespace SP\Core\Upgrade;
|
|
|
|
use SP\Config\Config;
|
|
use SP\Config\ConfigData;
|
|
use SP\Core\Dic\InjectableTrait;
|
|
use SP\Core\Exceptions\SPException;
|
|
use SP\Core\SessionFactory as CoreSession;
|
|
use SP\Core\Upgrade\User as UserUpgrade;
|
|
use SP\Http\Request;
|
|
use SP\Log\Email;
|
|
use SP\Log\Log;
|
|
use SP\Mgmt\CustomFields\CustomFieldsUtil;
|
|
use SP\Mgmt\Profiles\ProfileUtil;
|
|
use SP\Mgmt\Users\User;
|
|
use SP\Mgmt\Users\UserMigrate;
|
|
use SP\Mgmt\Users\UserPreferencesUtil;
|
|
use SP\Services\Task\TaskFactory;
|
|
use SP\Storage\DbWrapper;
|
|
use SP\Storage\QueryData;
|
|
use SP\Util\Util;
|
|
|
|
defined('APP_ROOT') || die();
|
|
|
|
/**
|
|
* Esta clase es la encargada de realizar las operaciones actualización de la aplicación.
|
|
*/
|
|
class Upgrade
|
|
{
|
|
use InjectableTrait;
|
|
|
|
/**
|
|
* @var array Versiones actualizables
|
|
*/
|
|
private static $dbUpgrade = ['110', '112.1', '112.2', '112.3', '112.13', '112.19', '112.20', '120.01', '120.02', '130.16011001', '130.16100601', '200.17011302', '200.17011701', '210.17022601', '213.17031402', '220.17050101'];
|
|
private static $cfgUpgrade = ['112.4', '130.16020501', '200.17011202'];
|
|
private static $auxUpgrade = ['120.01', '120.02', '200.17010901', '200.17011202'];
|
|
private static $appUpgrade = ['210.17022601'];
|
|
/**
|
|
* @var string Versión de la BBDD
|
|
*/
|
|
private static $currentDbVersion;
|
|
|
|
/**
|
|
* @var Config
|
|
*/
|
|
protected $config;
|
|
/**
|
|
* @var ConfigData
|
|
*/
|
|
protected $configData;
|
|
/**
|
|
* @var Log
|
|
*/
|
|
protected $log;
|
|
|
|
/**
|
|
* Upgrade constructor.
|
|
*
|
|
* @param Config $config
|
|
* @param Log $log
|
|
* @throws \SP\Core\Dic\ContainerException
|
|
*/
|
|
public function __construct(Config $config, Log $log)
|
|
{
|
|
$this->injectDependencies();
|
|
$this->config = $config;
|
|
}
|
|
|
|
/**
|
|
* Inicia el proceso de actualización de la BBDD.
|
|
*
|
|
* @param int $version con la versión de la BBDD actual
|
|
* @return bool
|
|
* @throws SPException
|
|
*/
|
|
public function doUpgrade($version)
|
|
{
|
|
self::$currentDbVersion = UserUpgrade::fixVersionNumber(ConfigDB::getValue('version'));
|
|
|
|
foreach (self::$dbUpgrade as $dbVersion) {
|
|
if (Util::checkVersion($version, $dbVersion)) {
|
|
if ($this->auxPreDbUpgrade($dbVersion) === false) {
|
|
throw new SPException(__('Error al aplicar la actualización auxiliar', false), SPException::CRITICAL, __('Compruebe el registro de eventos para más detalles', false));
|
|
}
|
|
|
|
if ($this->upgradeDB($dbVersion) === false) {
|
|
throw new SPException(__('Error al aplicar la actualización de la Base de Datos', false), SPException::CRITICAL, __('Compruebe el registro de eventos para más detalles', false));
|
|
}
|
|
}
|
|
}
|
|
|
|
foreach (self::$appUpgrade as $appVersion) {
|
|
if (Util::checkVersion($version, $appVersion)
|
|
&& $this->appUpgrades($appVersion) === false
|
|
) {
|
|
throw new SPException(__('Error al aplicar la actualización de la aplicación', false), SPException::CRITICAL, __('Compruebe el registro de eventos para más detalles', false));
|
|
}
|
|
}
|
|
|
|
foreach (self::$auxUpgrade as $auxVersion) {
|
|
if (Util::checkVersion($version, $auxVersion)
|
|
&& $this->auxUpgrades($auxVersion) === false
|
|
) {
|
|
throw new SPException(__('Error al aplicar la actualización auxiliar', false), SPException::CRITICAL, __('Compruebe el registro de eventos para más detalles', false));
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
/**
|
|
* Aplicar actualizaciones auxiliares antes de actualizar la BBDD
|
|
*
|
|
* @param $version
|
|
* @return bool
|
|
*/
|
|
private function auxPreDbUpgrade($version)
|
|
{
|
|
switch ($version) {
|
|
case '130.16011001':
|
|
debugLog(__FUNCTION__ . ': ' . $version);
|
|
|
|
return $this->upgradeDB('130.00000000');
|
|
case '130.16100601':
|
|
debugLog(__FUNCTION__ . ': ' . $version);
|
|
|
|
return
|
|
Account::fixAccountsId()
|
|
&& UserUpgrade::fixUsersId(Request::analyze('userid', 0))
|
|
&& Group::fixGroupId(Request::analyze('groupid', 0))
|
|
&& Profile::fixProfilesId(Request::analyze('profileid', 0))
|
|
&& Category::fixCategoriesId(Request::analyze('categoryid', 0))
|
|
&& Customer::fixCustomerId(Request::analyze('customerid', 0));
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Actualiza la BBDD según la versión.
|
|
*
|
|
* @param int $version con la versión a actualizar
|
|
* @returns bool
|
|
*/
|
|
private function upgradeDB($version)
|
|
{
|
|
$LogMessage = $this->log->getLogMessage();
|
|
$LogMessage->setAction(__('Actualizar BBDD', false));
|
|
$LogMessage->addDetails(__('Versión', false), $version);
|
|
|
|
$queries = $this->getQueriesFromFile($version);
|
|
|
|
if (count($queries) === 0 || Util::checkVersion(self::$currentDbVersion, $version) === false) {
|
|
$LogMessage->addDescription(__('No es necesario actualizar la Base de Datos.', false));
|
|
|
|
debugLog($LogMessage->composeText());
|
|
|
|
return true;
|
|
}
|
|
|
|
TaskFactory::$Message->setTask(__('Actualizar BBDD'));
|
|
TaskFactory::$Message->setMessage(sprintf('%s : %s', __('Versión'), $version));
|
|
TaskFactory::update();
|
|
|
|
debugLog(__FUNCTION__ . ': ' . $version);
|
|
|
|
$Data = new QueryData();
|
|
|
|
foreach ($queries as $query) {
|
|
try {
|
|
$Data->setQuery($query);
|
|
DbWrapper::getQuery($Data);
|
|
} catch (SPException $e) {
|
|
$LogMessage->addDescription(__('Error al aplicar la actualización de la Base de Datos', false));
|
|
$LogMessage->addDetails('ERROR', sprintf('%s (%s)', $e->getMessage(), $e->getCode()));
|
|
$this->log->setLogLevel(Log::ERROR);
|
|
$this->log->writeLog();
|
|
|
|
Email::sendEmail($LogMessage);
|
|
return false;
|
|
}
|
|
}
|
|
|
|
ConfigDB::setValue('version', $version);
|
|
|
|
self::$currentDbVersion = $version;
|
|
|
|
$LogMessage->addDescription(__('Actualización de la Base de Datos realizada correctamente.', false));
|
|
$this->log->writeLog();
|
|
|
|
Email::sendEmail($LogMessage);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Obtener las consultas de actualización desde un archivo
|
|
*
|
|
* @param $filename
|
|
* @return array|bool
|
|
*/
|
|
private function getQueriesFromFile($filename)
|
|
{
|
|
$file = SQL_PATH . DIRECTORY_SEPARATOR . str_replace('.', '', $filename) . '.sql';
|
|
|
|
$queries = [];
|
|
|
|
if (file_exists($file) && $handle = fopen($file, 'rb')) {
|
|
while (!feof($handle)) {
|
|
$buffer = stream_get_line($handle, 1000000, ";\n");
|
|
|
|
if (strlen(trim($buffer)) > 0) {
|
|
$queries[] = str_replace("\n", '', $buffer);
|
|
}
|
|
}
|
|
}
|
|
|
|
return $queries;
|
|
}
|
|
|
|
/**
|
|
* Actualizaciones de la aplicación
|
|
*
|
|
* @param $version
|
|
* @return bool
|
|
* @throws \SP\Core\Exceptions\SPException
|
|
*/
|
|
private function appUpgrades($version)
|
|
{
|
|
switch ($version) {
|
|
case '210.17022601':
|
|
$dbResult = true;
|
|
|
|
if (Util::checkVersion(self::$currentDbVersion, $version)) {
|
|
$dbResult = $this->upgradeDB($version);
|
|
}
|
|
|
|
$masterPass = Request::analyzeEncrypted('masterkey');
|
|
$UserData = User::getItem()->getByLogin(Request::analyze('userlogin'));
|
|
|
|
if (!is_object($UserData)) {
|
|
throw new SPException(__('Error al obtener los datos del usuario', false), SPException::ERROR);
|
|
}
|
|
|
|
CoreSession::setUserData($UserData);
|
|
|
|
return $dbResult === true
|
|
&& !empty($masterPass)
|
|
&& Crypt::migrate($masterPass);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Aplicar actualizaciones auxiliares.
|
|
*
|
|
* @param $version int El número de versión
|
|
* @return bool
|
|
*/
|
|
private function auxUpgrades($version)
|
|
{
|
|
try {
|
|
switch ($version) {
|
|
case '120.01':
|
|
debugLog(__FUNCTION__ . ': ' . $version);
|
|
|
|
return (ProfileUtil::migrateProfiles() && UserMigrate::migrateUsersGroup());
|
|
case '120.02':
|
|
debugLog(__FUNCTION__ . ': ' . $version);
|
|
|
|
return UserMigrate::setMigrateUsers();
|
|
case '200.17010901':
|
|
debugLog(__FUNCTION__ . ': ' . $version);
|
|
|
|
return CustomFieldsUtil::migrateCustomFields() && UserPreferencesUtil::migrate();
|
|
case '200.17011202':
|
|
debugLog(__FUNCTION__ . ': ' . $version);
|
|
|
|
return UserPreferencesUtil::migrate();
|
|
}
|
|
} catch (SPException $e) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Comprueba si es necesario actualizar la configuración.
|
|
*
|
|
* @param int $version con el número de versión actual
|
|
* @returns bool
|
|
*/
|
|
public function needConfigUpgrade($version)
|
|
{
|
|
return Util::checkVersion($version, self::$cfgUpgrade);
|
|
}
|
|
|
|
/**
|
|
* Migrar valores de configuración.
|
|
*
|
|
* @param int $version El número de versión
|
|
* @return bool
|
|
*/
|
|
public function upgradeConfig($version)
|
|
{
|
|
$count = 0;
|
|
|
|
foreach (self::$cfgUpgrade as $upgradeVersion) {
|
|
if (Util::checkVersion($version, $upgradeVersion)) {
|
|
switch ($upgradeVersion) {
|
|
case '200.17011202':
|
|
debugLog(__FUNCTION__ . ': ' . $version);
|
|
|
|
$this->configData->setSiteTheme('material-blue');
|
|
$this->configData->setConfigVersion($upgradeVersion);
|
|
$this->config->saveConfig(null, false);
|
|
$count++;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
return $count > 0;
|
|
}
|
|
|
|
/**
|
|
* Actualizar el archivo de configuración a formato XML
|
|
*
|
|
* @param $version
|
|
* @return bool
|
|
*/
|
|
public function upgradeOldConfigFile($version)
|
|
{
|
|
$LogMessage = $this->log->getLogMessage();
|
|
$LogMessage->setAction(__('Actualizar Configuración', false));
|
|
|
|
// Include the file, save the data from $CONFIG
|
|
include OLD_CONFIG_FILE;
|
|
|
|
if (isset($CONFIG) && is_array($CONFIG)) {
|
|
|
|
$paramMapper = function ($mapFrom, $mapTo) use ($CONFIG, $LogMessage) {
|
|
if (isset($CONFIG[$mapFrom])) {
|
|
$LogMessage->addDetails(__('Parámetro', false), $mapFrom);
|
|
$this->configData->{$mapTo}($CONFIG[$mapFrom]);
|
|
}
|
|
};
|
|
|
|
foreach (self::getConfigParams() as $mapTo => $mapFrom) {
|
|
if (method_exists($this->configData, $mapTo)) {
|
|
if (is_array($mapFrom)) {
|
|
/** @var array $mapFrom */
|
|
foreach ($mapFrom as $param) {
|
|
$paramMapper($mapFrom, $param);
|
|
}
|
|
} else {
|
|
if (isset($CONFIG[$mapFrom])) {
|
|
$paramMapper($mapFrom, $mapTo);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$oldFile = OLD_CONFIG_FILE . '.old.' . time();
|
|
|
|
try {
|
|
|
|
$this->configData->setSiteTheme('material-blue');
|
|
$this->configData->setConfigVersion($version);
|
|
$this->config->saveConfig(null, false);
|
|
|
|
rename(OLD_CONFIG_FILE, $oldFile);
|
|
|
|
$LogMessage->addDetails(__('Versión', false), $version);
|
|
$this->log->setLogLevel(Log::NOTICE);
|
|
$this->log->writeLog();
|
|
|
|
return true;
|
|
} catch (\Exception $e) {
|
|
$LogMessage->addDescription(__('Error al actualizar la configuración', false));
|
|
$LogMessage->addDetails(__('Archivo', false), $oldFile);
|
|
$this->log->setLogLevel(Log::ERROR);
|
|
$this->log->writeLog();
|
|
}
|
|
|
|
// We are here...wrong
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Devuelve array de métodos y parámetros de configuración
|
|
*
|
|
* @return array
|
|
*/
|
|
private static function getConfigParams()
|
|
{
|
|
return [
|
|
'setAccountCount' => 'account_count',
|
|
'setAccountLink' => 'account_link',
|
|
'setCheckUpdates' => 'checkupdates',
|
|
'setCheckNotices' => 'checknotices',
|
|
'setDbHost' => 'dbhost',
|
|
'setDbName' => 'dbname',
|
|
'setDbPass' => 'dbpass',
|
|
'setDbUser' => 'dbuser',
|
|
'setDebug' => 'debug',
|
|
'setDemoEnabled' => 'demo_enabled',
|
|
'setGlobalSearch' => 'globalsearch',
|
|
'setInstalled' => 'installed',
|
|
'setMaintenance' => 'maintenance',
|
|
'setPasswordSalt' => 'passwordsalt',
|
|
'setSessionTimeout' => 'session_timeout',
|
|
'setSiteLang' => 'sitelang',
|
|
'setConfigVersion' => 'version',
|
|
'setConfigHash' => 'config_hash',
|
|
'setProxyEnabled' => 'proxy_enabled',
|
|
'setProxyPass' => 'proxy_pass',
|
|
'setProxyPort' => 'proxy_port',
|
|
'setProxyServer' => 'proxy_server',
|
|
'setProxyUser' => 'proxy_user',
|
|
'setResultsAsCards' => 'resultsascards',
|
|
'setSiteTheme' => 'sitetheme',
|
|
'setAccountPassToImage' => 'account_passtoimage',
|
|
'setFilesAllowedExts' => ['allowed_exts', 'files_allowed_exts'],
|
|
'setFilesAllowedSize' => ['allowed_size', 'files_allowed_size'],
|
|
'setFilesEnabled' => ['filesenabled', 'files_enabled'],
|
|
'setLdapBase' => ['ldapbase', 'ldap_base'],
|
|
'setLdapBindPass' => ['ldapbindpass', 'ldap_bindpass'],
|
|
'setLdapBindUser' => ['ldapbinduser', 'ldap_binduser'],
|
|
'setLdapEnabled' => ['ldapenabled', 'ldap_enabled'],
|
|
'setLdapGroup' => ['ldapgroup', 'ldap_group'],
|
|
'setLdapServer' => ['ldapserver', 'ldap_server'],
|
|
'setLdapAds' => 'ldap_ads',
|
|
'setLdapDefaultGroup' => 'ldap_defaultgroup',
|
|
'setLdapDefaultProfile' => 'ldap_defaultprofile',
|
|
'setLogEnabled' => ['logenabled', 'log_enabled'],
|
|
'setMailEnabled' => ['mailenabled', 'mail_enabled'],
|
|
'setMailFrom' => ['mailfrom', 'mail_from'],
|
|
'setMailPass' => ['mailpass', 'mail_pass'],
|
|
'setMailPort' => ['mailport', 'mail_port'],
|
|
'setMailRequestsEnabled' => ['mailrequestsenabled', 'mail_requestsenabled'],
|
|
'setMailAuthenabled' => 'mail_authenabled',
|
|
'setMailSecurity' => ['mailsecurity', 'mail_security'],
|
|
'setMailServer' => ['mailserver', 'mail_server'],
|
|
'setMailUser' => ['mailuser', 'mail_user'],
|
|
'setWikiEnabled' => ['wikienabled', 'wiki_enabled'],
|
|
'setWikiFilter' => ['wikifilter', 'wiki_filter'],
|
|
'setWikiPageUrl' => ['wikipageurl' . 'wiki_pageurl'],
|
|
'setWikiSearchUrl' => ['wikisearchurl', 'wiki_searchurl']
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Comrpueba y actualiza la versión de la BBDD.
|
|
*
|
|
* @return void
|
|
* @throws \Defuse\Crypto\Exception\EnvironmentIsBrokenException
|
|
*/
|
|
public function checkDbVersion()
|
|
{
|
|
$appVersion = Util::getVersionStringNormalized();
|
|
$databaseVersion = UserUpgrade::fixVersionNumber(ConfigDB::getValue('version'));
|
|
|
|
if (Util::checkVersion($databaseVersion, $appVersion)
|
|
&& Request::analyze('nodbupgrade', 0) === 0
|
|
&& Util::checkVersion($databaseVersion, self::$dbUpgrade)
|
|
&& !$this->configData->isMaintenance()
|
|
) {
|
|
$this->setUpgradeKey('db');
|
|
|
|
// FIXME: send link for upgrading
|
|
throw new \RuntimeException('Needs upgrade');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Establecer la key de actualización
|
|
*
|
|
* @param string $type Tipo de actualización
|
|
* @throws \Defuse\Crypto\Exception\EnvironmentIsBrokenException
|
|
*/
|
|
private function setUpgradeKey($type)
|
|
{
|
|
$upgradeKey = $this->configData->getUpgradeKey();
|
|
|
|
if (empty($upgradeKey)) {
|
|
$this->configData->setUpgradeKey(Util::generateRandomBytes(32));
|
|
}
|
|
|
|
$this->configData->setMaintenance(true);
|
|
$this->config->saveConfig(null, false);
|
|
|
|
// Init::initError(
|
|
// __('La aplicación necesita actualizarse'),
|
|
// sprintf(__('Si es un administrador pulse en el enlace: %s'), '<a href="index.php?a=upgrade&type=' . $type . '">' . __('Actualizar') . '</a>'));
|
|
}
|
|
|
|
/**
|
|
* Comrpueba y actualiza la versión de la aplicación.
|
|
*
|
|
* @return void
|
|
* @throws \Defuse\Crypto\Exception\EnvironmentIsBrokenException
|
|
*/
|
|
public function checkAppVersion()
|
|
{
|
|
$appVersion = UserUpgrade::fixVersionNumber($this->configData->getConfigVersion());
|
|
|
|
if (Util::checkVersion($appVersion, self::$appUpgrade) && !$this->configData->isMaintenance()) {
|
|
$this->setUpgradeKey('app');
|
|
|
|
// FIXME: send link for upgrading
|
|
throw new \RuntimeException('Needs upgrade');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param Config $config
|
|
* @param Log $log
|
|
*/
|
|
public function inject(Config $config, Log $log)
|
|
{
|
|
$this->config = $config;
|
|
$this->configData = $config->getConfigData();
|
|
$this->log = $log;
|
|
}
|
|
} |