Shikiryu/Shikiryu_Backup
1
0
Fork 0
mirror of https://github.com/Chouchen/Shikiryu_Backup.git synced 2021-06-30 16:02:14 +02:00
Code Issues Packages Releases Wiki Activity

Add some PHPCS corrections

Browse Source
This commit is contained in:
Shikiryu 2016-07-03 21:54:35 +02:00
parent dd2a6bd7d7
commit ab7887ce84
13 changed files with 238 additions and 200 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
app/code/Scenario.php
View File

@ -7,7 +7,8 @@ use Shikiryu\Backup\Transport\TransportAbstract;
use Shikiryu\Backup\Backup\Factory as BackupFactory;
use Shikiryu\Backup\Transport\Factory as TransportFactory;
class Scenario {
class Scenario
{
/* @var $backup BackupAbstract */
private $backup;
@ -103,5 +104,4 @@ class Scenario {
isset($scenario['transport']) &&
count($scenario['transport']) === 1;
}
}

14
app/code/Transport/Dropbox.php
View File

@ -7,7 +7,11 @@ use Shikiryu\Backup\Transport\TransportAbstract;
class Dropbox extends TransportAbstract
{
/**
* Dropbox Client
*
* @var Client
*/
private $dropbox;
protected $token = '';
@ -26,21 +30,21 @@ class Dropbox extends TransportAbstract
public function send()
{
$sent = true;
$files = $this->backup->getFilesToBackup();
$files = $this->backup->getFilesTobackup();
foreach ($files as $file => $name) {
$file = fopen($file, 'r');
$upload = $this->dropbox->uploadFile($this->folder.'/'.$name, \Dropbox\WriteMode::force(), $file);
if (!$upload) {
$sent = false;
echo 'DROPBOX upload manquée de '.$file.' vers '.$this->folder.$name;
echo 'DROPBOX upload manqu<EFBFBD>e de '.$file.' vers '.$this->folder.$name;
}
}
$streams = $this->backup->getStreamsToBackup();
$streams = $this->backup->getStreamsTobackup();
foreach ($streams as $stream => $name) {
$upload = $this->dropbox->uploadFileFromString($this->folder.'/'.$name, \Dropbox\WriteMode::force(), $stream);
if (!$upload) {
$sent = false;
echo 'DROPBOX upload manquée de '.$file.' vers '.$this->folder.$name;
echo 'DROPBOX upload manqu<EFBFBD>e de '.$file.' vers '.$this->folder.$name;
}
}
return $sent;

4
app/code/Transport/Email.php
View File

@ -147,8 +147,8 @@ class Email extends TransportAbstract
*/
public function __construct(BackupAbstract $backup, array $config) {
parent::__construct($backup, $config);
$this->setFiles($this->backup->getFilesToBackup());
$this->setStreams($this->backup->getStreamsToBackup());
$this->setFiles($this->backup->getFilesTobackup());
$this->setStreams($this->backup->getStreamsTobackup());
$this->email_to = $this->config['to'];
$this->email_from = $this->config['from'];
$this->encoding = $this->config['encoding'];

34
app/code/Transport/FTP.php
View File

@ -1,4 +1,5 @@
<?php
namespace Shikiryu\Backup\Transport;
class Ftp extends TransportAbstract
@ -14,12 +15,13 @@ class Ftp extends TransportAbstract
private $files;
private $streams;
public function __construct($backup, $config) {
public function __construct($backup, $config)
{
parent::__construct($backup, $config);
// $this->path = $this->config['path'];
if (!empty($this->folder)) {
$this->folder = sprintf('/%s/', ltrim(rtrim($this->folder, '/'),'/'));
$this->folder = sprintf('/%s/', ltrim(rtrim($this->folder, '/'), '/'));
}
$this->connection = ftp_connect($this->host);
@ -29,11 +31,12 @@ class Ftp extends TransportAbstract
$login = @ftp_login($this->connection, $this->login, $this->password);
if ($login === false) {
throw new \Exception(sprintf('Connexion FTP %s refusée avec %s et %s', $this->host, $this->login, $this->password));
$msg = sprintf('Connexion FTP %s refusée avec %s et %s', $this->host, $this->login, $this->password);
throw new \Exception($msg);
}
$this->setFiles($this->backup->getFilesToBackup());
$this->setStreams($this->backup->getStreamsToBackup());
$this->setFiles($this->backup->getFilesTobackup());
$this->setStreams($this->backup->getStreamsTobackup());
}
private function setFiles($files = array())
@ -44,7 +47,8 @@ class Ftp extends TransportAbstract
return $this;
}
private function setStreams($streams = array()) {
private function setStreams($streams = array())
{
if (is_array($streams) && !empty($streams)) {
$this->streams = $streams;
}
@ -58,7 +62,7 @@ class Ftp extends TransportAbstract
{
$sent = true;
ftp_pasv($this->connection, true);
if (!empty($this->files)){
if (!empty($this->files)) {
foreach ($this->files as $file => $name) {
$upload = ftp_put($this->connection, $this->folder.$name, $file, FTP_BINARY);
if (!$upload) {
@ -68,10 +72,11 @@ class Ftp extends TransportAbstract
}
}
if (!empty($this->streams)){
if (!empty($this->streams)) {
foreach ($this->streams as $name => $stream) {
if (count(explode('.', $name)) < 2)
if (count(explode('.', $name)) < 2) {
$name = 'backup' . $name . '.txt';
}
file_put_contents($name, $stream);
$upload = ftp_put($this->connection, $this->folder.$name, $name, FTP_ASCII);
if (!$upload) {
@ -93,15 +98,4 @@ class Ftp extends TransportAbstract
{
ftp_close($this->connection);
}
}
?>

67
app/code/Transport/Folder.php
View File

@ -2,43 +2,46 @@
namespace Shikiryu\Backup\Transport;
use Shikiryu\Backup\Backup\BackupAbstract;
class Folder extends TransportAbstract
{
/** @var string */
protected $folder;
/**
* Folder to backup
*
* @var string
*/
protected $folder;
public function __construct(BackupAbstract $backup, array $config = array())
{
parent::__construct($backup, $config);
public function __construct(BackupAbstract $backup, array $config = array())
{
parent::__construct($backup, $config);
if (!empty($this->folder)) {
$this->folder = sprintf('%s/', rtrim($this->folder, '/'));
}
}
if (!empty($this->folder)) {
$this->folder = sprintf('%s/', rtrim($this->folder, '/'));
}
}
/**
* @return bool
*
* @throws \Exception
*/
public function send()
{
foreach ($this->backup->getFilesToBackup() as $file => $name) {
if (copy($file, $this->folder . $name) === false) {
throw new \Exception(sprintf('Copy of %s in %s failed', $name, $this->folder));
};
}
foreach ($this->backup->getStreamsToBackup() as $name => $file) {
if (count(explode('.', $name)) < 2) {
$name = 'backup' . $name . '.txt';
}
if (file_put_contents($this->folder . $name, $file) === false) {
throw new \Exception(sprintf('Saving of %s in %s failed', $name, $this->folder));
}
}
return true;
}
/**
* @return bool
*
* @throws \Exception
*/
public function send()
{
foreach ($this->backup->getFilesTobackup() as $file => $name) {
if (copy($file, $this->folder . $name) === false) {
throw new \Exception(sprintf('Copy of %s in %s failed', $name, $this->folder));
};
}
foreach ($this->backup->getStreamsTobackup() as $name => $file) {
if (count(explode('.', $name)) < 2) {
$name = 'backup' . $name . '.txt';
}
if (file_put_contents($this->folder . $name, $file) === false) {
throw new \Exception(sprintf('Saving of %s in %s failed', $name, $this->folder));
}
}
return true;
}
}

16
app/code/Transport/SFTP.php
View File

@ -6,7 +6,7 @@ use phpseclib\Net\SFTP as LibSFTP;
class Sftp extends TransportAbstract
{
/** @var string */
/** @var string */
protected $host;
/** @var int */
protected $port = 22;
@ -16,7 +16,7 @@ class Sftp extends TransportAbstract
protected $password;
/** @var string */
protected $folder;
/** @var LibSFTP */
/** @var LibSFTP */
private $connection;
/**
@ -42,23 +42,23 @@ class Sftp extends TransportAbstract
public function send()
{
$sent = true;
$files = $this->backup->getFilesToBackup();
if (!empty($files)){
$files = $this->backup->getFilesTobackup();
if (!empty($files)) {
foreach ($files as $file => $name) {
$upload = $this->connection->put($this->folder.'/'.$name, $file, LibSFTP::SOURCE_LOCAL_FILE);
if (!$upload) {
$sent = false;
echo 'SFTP upload manquée de '.$file.' vers '.$this->folder.$name;
echo 'SFTP upload manqu<EFBFBD>e de '.$file.' vers '.$this->folder.$name;
}
}
}
$streams = $this->backup->getStreamsToBackup();
if (!empty($streams)){
$streams = $this->backup->getStreamsTobackup();
if (!empty($streams)) {
foreach ($streams as $name => $stream) {
$upload = $this->connection->put($this->folder.'/'.$name, $stream);
if (!$upload) {
echo 'SFTP upload manquée de '.$name.' vers '.$this->folder.$name;
echo 'SFTP upload manqu<EFBFBD>e de '.$name.' vers '.$this->folder.$name;
$sent = false;
}
}

4
app/code/Transport/TransportAbstract.php
View File

@ -7,7 +7,7 @@ use Shikiryu\Backup\Backup\BackupAbstract;
abstract class TransportAbstract
{
/** @var BackupAbstract */
/** @var BackupAbstract */
protected $backup;
/** @var array */
protected $config;
@ -25,5 +25,5 @@ abstract class TransportAbstract
/**
* @return bool
*/
public abstract function send();
abstract public function send();
}

136
app/code/backup/BackupAbstract.php
View File

@ -4,15 +4,29 @@ namespace Shikiryu\Backup\Backup;
abstract class BackupAbstract
{
/** @var array */
/**
* Options
*
* @var array
*/
protected $options;
/** @var string[] */
protected $_filesToBackup = [];
/** @var string[] */
protected $_streamsToBackup = [];
/**
* File path to backup
*
* @var string[]
*/
protected $files_to_backup = [];
/**
* Streams to backup
*
* @var string[]
*/
protected $streams_to_backup = [];
/**
* @param array $config
* Constructor
*
* @param array $config array of options and parameters
*/
function __construct($config = array())
{
@ -29,45 +43,53 @@ abstract class BackupAbstract
/**
* Magic setter method
*
* @param $name
* @param $value
* @param string $name attribute name
* @param mixed $value attribute value
*
* @return $this
*/
public function __set($name, $value)
{
$this->$name = $value;
return $this;
}
/**
* Getter
*
* @return array
*/
public function getFilesToBackup()
{
return $this->_filesToBackup;
return $this->files_to_backup;
}
/**
* Getter
*
* @return array
*/
public function getStreamsToBackup()
{
return $this->_streamsToBackup;
return $this->streams_to_backup;
}
/**
* Check if all files got the minimum given size.
*
* @param int $file_size
* @param int $file_size file size
*
* @return bool
*/
public function checkMinimumFilesize($file_size)
{
foreach ($this->_filesToBackup as $file => $name) {
foreach ($this->files_to_backup as $file => $name) {
if (filesize($file) < $file_size) {
return false;
}
}
foreach ($this->_streamsToBackup as $name => $file) {
foreach ($this->streams_to_backup as $name => $file) {
if (mb_strlen($file, 'utf-8') < $file_size) {
return false;
}
@ -75,44 +97,58 @@ abstract class BackupAbstract
return true;
}
/**
* Initialize everything
*/
/**
* Initialize everything
*
* @return $this
*/
protected function init()
{
$this->preBuild();
$this->build();
$this->postBuild();
$this->applyOptions();
return $this;
}
/**
* Function that can be used to initialize the backup
*/
/**
* Function that can be used to initialize the backup
*
* @return void
*/
abstract protected function preBuild();
/**
* Function that can be used after the backup
*/
* Function that can be used after the backup
*
* @return void
*/
abstract protected function postBuild();
/**
* Mandatory function doing the backup
*/
* Mandatory function doing the backup
*
* @return void
*/
abstract protected function build();
/**
* Check if the backup is valid
*
* @return bool
*/
* Check if the backup is valid
*
* @return bool
*/
abstract public function isValid();
/**
* Apply options
*
* @return $this
*/
protected function applyOptions()
{
// TODO isValid here ?
foreach($this->options as $name => $value)
{
foreach ($this->options as $name => $value) {
$method = sprintf('setOption%s', ucfirst($name));
if (method_exists($this, $method)) {
call_user_func([$this, $method], $value);
@ -132,18 +168,18 @@ abstract class BackupAbstract
protected function setOptionZip()
{
$zip = new \ZipArchive();
$zip_name = sprintf('%s.zip', (!empty($this->options['name']) ? $this->options['name'] : time())); // Zip name
if (touch(TEMP_DIR.$zip_name) === false) {
// Zip name
$zip_name = !empty($this->options['name']) ? $this->options['name'] : time();
$zip_name = sprintf('%s.zip', $zip_name);
if (touch(TEMP_DIR . $zip_name) === false) {
throw new \Exception('Backup::Zip::Permission denied.');
}
if ($zip->open(TEMP_DIR.$zip_name, \ZIPARCHIVE::OVERWRITE)==TRUE) {
foreach($this->_filesToBackup as $file => $name)
{
if ($zip->open(TEMP_DIR . $zip_name, \ZipArchive::OVERWRITE) == TRUE) {
foreach ($this->files_to_backup as $file => $name) {
$zip->addFile($file, $name); // Adding files into zip
}
foreach($this->_streamsToBackup as $file => $name)
{
foreach ($this->streams_to_backup as $file => $name) {
$zip->addFromString($file, $name); // Adding streams into zip
}
$zip->close();
@ -151,8 +187,8 @@ abstract class BackupAbstract
throw new \Exception('Backup::Zip::Can\'t zip the given backup.');
}
$this->_filesToBackup = [TEMP_DIR.$zip_name => $zip_name];
$this->_streamsToBackup = [];
$this->files_to_backup = [TEMP_DIR . $zip_name => $zip_name];
$this->streams_to_backup = [];
return $this;
}
@ -160,7 +196,7 @@ abstract class BackupAbstract
/**
* Add the current date with the given format into the files names
*
* @param string $format
* @param string $format date format
*
* @return $this
*/
@ -170,20 +206,20 @@ abstract class BackupAbstract
$format = 'Ymd';
}
$tmpFiles = array();
foreach ($this->_filesToBackup as $file => $name) {
foreach ($this->files_to_backup as $file => $name) {
$nameA = explode('.', $name);
$nameA[] = end($nameA);
$nameA[count($nameA) - 2] = date($format);
$name = implode('.', $nameA);
$tmpFiles[$file] = $name;
}
$this->_filesToBackup = $tmpFiles;
$this->files_to_backup = $tmpFiles;
$tmpStream = array();
foreach ($this->_streamsToBackup as $name => $stream) {
foreach ($this->streams_to_backup as $name => $stream) {
$tmpStream[$name . '-' . date($format)] = $stream;
}
$this->_streamsToBackup = $tmpStream;
$this->streams_to_backup = $tmpStream;
return $this;
}
@ -191,7 +227,7 @@ abstract class BackupAbstract
/**
* Add the current time with the given format into the files names
*
* @param string $format
* @param string $format time format
*
* @return $this
*/
@ -201,26 +237,28 @@ abstract class BackupAbstract
$format = 'his';
}
$tmpFiles = array();
foreach ($this->_filesToBackup as $file => $name) {
foreach ($this->files_to_backup as $file => $name) {
$nameA = explode('.', $name);
$nameA[] = end($nameA);
$nameA[count($nameA) - 2] = date($format);
$name = implode('.', $nameA);
$tmpFiles[$file] = $name;
}
$this->_filesToBackup = $tmpFiles;
$this->files_to_backup = $tmpFiles;
$tmpStream = array();
foreach ($this->_streamsToBackup as $name => $stream) {
foreach ($this->streams_to_backup as $name => $stream) {
$tmpStream[$name . '-' . date($format)] = $stream;
}
$this->_streamsToBackup = $tmpStream;
$this->streams_to_backup = $tmpStream;
return $this;
}
/**
* @param $name
* Set option name
*
* @param mixed $name option's name
*
* @throws \Exception
*

4
app/code/backup/Files.php
View File

@ -16,7 +16,7 @@ class Files extends BackupAbstract
$filesToBackup = $config['files'];
if(!empty($filesToBackup) && is_array($filesToBackup)){
$names = array_map("basename",$filesToBackup);
$this->_filesToBackup = array_combine($filesToBackup,$names);
$this->files_to_backup = array_combine($filesToBackup,$names);
}
parent::__construct($config);
}
@ -31,7 +31,7 @@ class Files extends BackupAbstract
public function isValid()
{
$result = true;
foreach ($this->_filesToBackup as $file => $name) {
foreach ($this->files_to_backup as $file => $name) {
if (!file_exists($file)) {
$result = false;
break;

23
app/code/backup/Folder.php
View File

@ -4,39 +4,38 @@ namespace Shikiryu\Backup\Backup;
class Folder extends BackupAbstract
{
public function __construct(array $config = array())
{
parent::__construct($config);
}
/**
* @return bool
*/
* @return bool
*/
public function isValid()
{
// TODO: Implement isValid() method.
}
/**
* Function that can be used to initialize the backup
*/
/**
* Function that can be used to initialize the backup
*/
protected function preBuild()
{
// TODO: Implement preBuild() method.
}
/**
* Function that can be used after the backup
*/
/**
* Function that can be used after the backup
*/
protected function postBuild()
{
// TODO: Implement postBuild() method.
}
/**
* Mandatory function doing the backup
*/
/**
* Mandatory function doing the backup
*/
protected function build()
{
// TODO: Implement build() method.

100
app/code/backup/Mysql.php
View File

@ -6,13 +6,13 @@ class Mysql extends BackupAbstract
{
/**
* @var $pdo \PDO
*/
* @var $pdo \PDO
*/
private $pdo;
/*
* from config
*/
* from config
*/
protected $tables;
protected $host;
protected $database;
@ -20,47 +20,49 @@ class Mysql extends BackupAbstract
protected $pwd;
/**
* @param array $config
*/
public function __construct(array $config = array()) {
* @param array $config
*/
public function __construct(array $config = array())
{
parent::__construct($config);
}
/**
* @param array $tables
* @return $this|string
*/
* @param array $tables
* @return $this|string
*/
private function fromTables($tables = array())
{
if(!empty($tables)) {
if (!empty($tables)) {
$this->tables = $tables;
}
$this->_streamsToBackup[sprintf('db-%s.sql', $this->database)] = $this->getFromTables();
$this->streams_to_backup[sprintf('db-%s.sql', $this->database)] = $this->getFromTables();
return $this;
}
/**
* set the list of table to backup to all tables
*
* @return $this
*/
private function everything() {
* set the list of table to backup to all tables
*
* @return $this
*/
private function everything()
{
$this->tables = array();
foreach($this->pdo->query('SHOW TABLES') as $table) {
foreach ($this->pdo->query('SHOW TABLES') as $table) {
$this->tables[] = $table;
}
$this->_streamsToBackup[sprintf('db-%s.sql', $this->database)] = $this->getFromTables();
$this->streams_to_backup[sprintf('db-%s.sql', $this->database)] = $this->getFromTables();
return $this;
}
/**
* @return string
*/
* @return string
*/
private function getFromTables()
{
$return = "";
foreach ($this->tables as $table) {
if(is_array($table)) {
if (is_array($table)) {
$table = $table[0];
}
$result = $this->pdo->prepare('SELECT * FROM ' . $table);
@ -71,21 +73,21 @@ class Mysql extends BackupAbstract
$result2->execute();
$row2 = $result2->fetch();
$return.= "\n\n" . $row2[1] . ";\n\n";
foreach($result as $row){
$return.= 'INSERT INTO ' . $table . ' VALUES(';
for ($j = 0; $j < $num_fields; $j++) {
$row[$j] = addslashes($row[$j]);
// $row[$j] = preg_replace("\n", "\\n", $row[$j]);
if (isset($row[$j])) {
$return.= '"' . $row[$j] . '"';
} else {
$return.= '""';
}
if ($j < ($num_fields - 1)) {
$return.= ',';
}
foreach ($result as $row) {
$return.= 'INSERT INTO ' . $table . ' VALUES(';
for ($j = 0; $j < $num_fields; $j++) {
$row[$j] = addslashes($row[$j]);
// $row[$j] = preg_replace("\n", "\\n", $row[$j]);
if (isset($row[$j])) {
$return.= '"' . $row[$j] . '"';
} else {
$return.= '""';
}
$return.= ");\n";
if ($j < ($num_fields - 1)) {
$return.= ',';
}
}
$return.= ");\n";
}
$return.="\n\n\n";
}
@ -93,36 +95,34 @@ class Mysql extends BackupAbstract
}
/**
* @return bool
*/
* @return bool
*/
public function isValid()
{
return !empty($this->_streamsToBackup);
return !empty($this->streams_to_backup);
}
/**
* Function that can be used to initialize the backup
*/
/**
* Function that can be used to initialize the backup
*/
protected function preBuild()
{
$this->pdo = new \PDO('mysql:host='.$this->host.';dbname='.$this->database, $this->login, $this->pwd);
}
/**
* Function that can be used after the backup
*/
/**
* Function that can be used after the backup
*/
protected function postBuild()
{
// TODO: Implement postBuild() method.
}
/**
* Mandatory function doing the backup
*/
/**
* Mandatory function doing the backup
*/
protected function build()
{
empty($this->tables) || $this->tables == '*' ? $this->everything() : $this->fromTables($this->tables);
}
}
?>