Mirrors/sysPass
2
0
Fork 0
mirror of https://github.com/nuxsmin/sysPass.git synced 2026-03-07 00:46:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

* [ADD] Unit testing. Work in progress

Browse Source 
* [MOD] Improved backup process. Work in progress
This commit is contained in:
nuxsmin
2018-07-10 00:58:54 +02:00
parent ff8713768d
commit 81569a06f9
7 changed files with 145 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
app/modules/api/Controllers/ConfigController.php
View File

@@ -49,7 +49,7 @@ class ConfigController extends ControllerBase
$this->setupApi(ActionsInterface::BACKUP_CONFIG);
$this->dic->get(FileBackupService::class)
->doBackup();
->doBackup(BACKUP_PATH);
$this->eventDispatcher->notifyEvent('run.backup.end',
new Event($this, EventMessage::factory()

2
app/modules/web/Controllers/ConfigBackupController.php
View File

@@ -57,7 +57,7 @@ class ConfigBackupController extends SimpleControllerBase
SessionContext::close();
$this->dic->get(FileBackupService::class)
->doBackup();
->doBackup(BACKUP_PATH);
$this->eventDispatcher->notifyEvent('run.backup.end',
new Event($this, EventMessage::factory()

105
lib/SP/Services/Backup/FileBackupService.php
View File

@@ -2,8 +2,8 @@
/**
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2018, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
@@ -24,9 +24,6 @@
namespace SP\Services\Backup;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\NotFoundExceptionInterface;
use SP\Bootstrap;
use SP\Config\ConfigData;
use SP\Core\Events\Event;
use SP\Core\Events\EventMessage;
@@ -51,36 +48,53 @@ class FileBackupService extends Service
* @var ConfigData
*/
protected $configData;
/**
* @var string
*/
protected $path;
/**
* @var string
*/
protected $backupFileApp;
/**
* @var string
*/
protected $backupFileDb;
/**
* Realizar backup de la BBDD y aplicación.
*
* @throws ContainerExceptionInterface
* @throws NotFoundExceptionInterface
* @param string $path
*
* @throws ServiceException
*/
public function doBackup()
public function doBackup(string $path)
{
$this->path = $path;
$this->checkBackupDir();
$siteName = Util::getAppInfo('appname');
// Generar hash unico para evitar descargas no permitidas
$backupUniqueHash = sha1(uniqid('sysPassBackup', true));
$this->configData->setBackupHash($backupUniqueHash);
$this->config->saveConfig($this->configData);
$bakFileApp = BACKUP_PATH . DIRECTORY_SEPARATOR . $siteName . '-' . $backupUniqueHash . '.tar';
$bakFileDB = BACKUP_PATH . DIRECTORY_SEPARATOR . $siteName . '_db-' . $backupUniqueHash . '.sql';
$this->backupFileApp = $this->path . DIRECTORY_SEPARATOR . $siteName . '-' . $backupUniqueHash . '.tar';
$this->backupFileDb = $this->path . DIRECTORY_SEPARATOR . $siteName . '_db-' . $backupUniqueHash . '.sql';
try {
$this->checkBackupDir();
$this->deleteOldBackups();
$this->eventDispatcher->notifyEvent('run.backup.start',
new Event($this,
EventMessage::factory()->addDescription(__u('Realizar Backup'))));
$this->backupTables('*', new FileHandler($bakFileDB));
$this->backupApp($bakFileApp);
$this->backupTables('*', new FileHandler($this->backupFileDb));
$this->backupApp($this->backupFileApp);
$this->configData->setBackupHash($backupUniqueHash);
$this->config->saveConfig($this->configData);
} catch (ServiceException $e) {
throw $e;
} catch (\Exception $e) {
@@ -102,12 +116,14 @@ class FileBackupService extends Service
*/
private function checkBackupDir()
{
if (@mkdir(BACKUP_PATH, 0750) === false && is_dir(BACKUP_PATH) === false) {
if (is_dir($this->path) === false
&& @mkdir($this->path, 0750) === false
) {
throw new ServiceException(
sprintf(__('No es posible crear el directorio de backups ("%s")'), BACKUP_PATH));
sprintf(__('No es posible crear el directorio de backups ("%s")'), $this->path));
}
if (!is_writable(BACKUP_PATH)) {
if (!is_writable($this->path)) {
throw new ServiceException(
__u('Compruebe los permisos del directorio de backups'));
}
@@ -120,8 +136,8 @@ class FileBackupService extends Service
*/
private function deleteOldBackups()
{
array_map('unlink', glob(BACKUP_PATH . DIRECTORY_SEPARATOR . '*.tar.gz'));
array_map('unlink', glob(BACKUP_PATH . DIRECTORY_SEPARATOR . '*.sql'));
array_map('unlink', glob($this->path . DIRECTORY_SEPARATOR . '*.tar.gz'));
array_map('unlink', glob($this->path . DIRECTORY_SEPARATOR . '*.sql'));
}
/**
@@ -130,6 +146,7 @@ class FileBackupService extends Service
*
* @param string|array $tables
* @param FileHandler $fileHandler
*
* @throws \Exception
* @throws \SP\Storage\FileException
*/
@@ -154,13 +171,17 @@ class FileBackupService extends Service
$lineSeparator = PHP_EOL . PHP_EOL;
$dbname = $this->configData->getDbName();
$dbname = $db->getDbHandler()->getDatabaseName();
$sqlOut = '--' . PHP_EOL;
$sqlOut = '-- ' . PHP_EOL;
$sqlOut .= '-- sysPass DB dump generated on ' . time() . ' (START)' . PHP_EOL;
$sqlOut .= '--' . PHP_EOL;
$sqlOut .= '-- ' . PHP_EOL;
$sqlOut .= '-- Please, do not alter this file, it could break your DB' . PHP_EOL;
$sqlOut .= '--' . PHP_EOL . PHP_EOL;
$sqlOut .= '-- ' . PHP_EOL;
$sqlOut .= 'SET AUTOCOMMIT = 0;' . PHP_EOL;
$sqlOut .= 'SET FOREIGN_KEY_CHECKS = 0;' . PHP_EOL;
$sqlOut .= 'SET UNIQUE_CHECKS = 0;' . PHP_EOL;
$sqlOut .= '-- ' . PHP_EOL;
$sqlOut .= 'CREATE DATABASE IF NOT EXISTS `' . $dbname . '`;' . PHP_EOL . PHP_EOL;
$sqlOut .= 'USE `' . $dbname . '`;' . PHP_EOL . PHP_EOL;
@@ -174,7 +195,7 @@ class FileBackupService extends Service
$queryData->setQuery('SHOW CREATE TABLE ' . $tableName);
// Consulta para crear la tabla
$txtCreate = $db->doQuery($queryData);
$txtCreate = $db->doQuery($queryData)->getData();
if (isset($txtCreate->{'Create Table'})) {
$sqlOut = '-- ' . PHP_EOL;
@@ -184,7 +205,7 @@ class FileBackupService extends Service
$sqlOut .= $txtCreate->{'Create Table'} . ';' . PHP_EOL . PHP_EOL;
$fileHandler->write($sqlOut);
} elseif ($txtCreate->{'Create View'}) {
} elseif (isset($txtCreate->{'Create View'})) {
$sqlOutViews .= '-- ' . PHP_EOL;
$sqlOutViews .= '-- View ' . strtoupper($tableName) . PHP_EOL;
$sqlOutViews .= '-- ' . PHP_EOL;
@@ -234,11 +255,15 @@ class FileBackupService extends Service
}
}
$sqlOut = '--' . PHP_EOL;
$sqlOut = '-- ' . PHP_EOL;
$sqlOut .= 'SET AUTOCOMMIT = 1;' . PHP_EOL;
$sqlOut .= 'SET FOREIGN_KEY_CHECKS = 1;' . PHP_EOL;
$sqlOut .= 'SET UNIQUE_CHECKS = 1;' . PHP_EOL;
$sqlOut .= '-- ' . PHP_EOL;
$sqlOut .= '-- sysPass DB dump generated on ' . time() . ' (END)' . PHP_EOL;
$sqlOut .= '--' . PHP_EOL;
$sqlOut .= '-- ' . PHP_EOL;
$sqlOut .= '-- Please, do not alter this file, it could break your DB' . PHP_EOL;
$sqlOut .= '--' . PHP_EOL . PHP_EOL;
$sqlOut .= '-- ' . PHP_EOL . PHP_EOL;
$fileHandler->write($sqlOut);
$fileHandler->close();
@@ -248,6 +273,7 @@ class FileBackupService extends Service
* Realizar un backup de la aplicación y comprimirlo.
*
* @param string $backupFile nombre del archivo de backup
*
* @return bool
* @throws ServiceException
*/
@@ -277,7 +303,7 @@ class FileBackupService extends Service
}
$archive = new \PharData($backupFile);
$archive->buildFromDirectory(Bootstrap::$SERVERROOT, '/^(?!backup).*$/');
$archive->buildFromDirectory(APP_ROOT, '/^(?!backup).*$/');
$archive->compress(\Phar::GZ);
unlink($backupFile);
@@ -289,18 +315,35 @@ class FileBackupService extends Service
* Realizar un backup de la aplicación y comprimirlo usando aplicaciones del SO Linux.
*
* @param string $backupFile nombre del archivo de backup
*
* @return int Con el código de salida del comando ejecutado
*/
private function backupAppLegacyLinux($backupFile)
{
$compressedFile = $backupFile . '.gz';
$command = 'tar czf ' . $compressedFile . ' ' . BASE_PATH . ' --exclude "' . BACKUP_PATH . '" 2>&1';
$command = 'tar czf ' . $compressedFile . ' ' . BASE_PATH . ' --exclude "' . $this->path . '" 2>&1';
exec($command, $resOut, $resBakApp);
return $resBakApp;
}
/**
* @return string
*/
public function getBackupFileApp(): string
{
return $this->backupFileApp;
}
/**
* @return string
*/
public function getBackupFileDb(): string
{
return $this->backupFileDb;
}
/**
* @throws \Psr\Container\ContainerExceptionInterface
* @throws \Psr\Container\NotFoundExceptionInterface

9
lib/SP/Storage/Database/DBStorageInterface.php
View File

@@ -2,8 +2,8 @@
/**
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2018, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
@@ -56,4 +56,9 @@ interface DBStorageInterface
* @return mixed
*/
public function getConnectionUri();
/**
* @return string
*/
public function getDatabaseName();
}

8
lib/SP/Storage/Database/MySQLHandler.php
View File

@@ -187,4 +187,12 @@ class MySQLHandler implements DBStorageInterface
return $this->db;
}
/**
* @return string
*/
public function getDatabaseName()
{
return $this->connectionData->getDbName();
}
}

53
tests/Services/Backup/FileBackupServiceTest.php Normal file
View File

@@ -0,0 +1,53 @@
<?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\Tests\Services\Backup;
use PHPUnit\Framework\TestCase;
use SP\Services\Backup\FileBackupService;
use function SP\Tests\setupContext;
/**
* Class FileBackupServiceTest
*
* @package SP\Tests\Services\Backup
*/
class FileBackupServiceTest extends TestCase
{
/**
* @throws \DI\DependencyException
* @throws \DI\NotFoundException
* @throws \SP\Core\Context\ContextException
* @throws \SP\Services\ServiceException
*/
public function testDoBackup()
{
$dic = setupContext();
$service = $dic->get(FileBackupService::class);
$service->doBackup(RESOURCE_DIR);
$this->assertFileExists($service->getBackupFileApp() . '.gz');
$this->assertFileExists($service->getBackupFileDb());
}
}

1
tests/bootstrap.php
View File

@@ -83,6 +83,7 @@ function setupContext()
$context->setConfig(new ConfigData());
$context->setTrasientKey('_masterpass', '12345678900');
$userData = new UserLoginResponse();
$userData->setId(1);
$userData->setUserGroupId(1);