Skip to content

Commit 99ddaa2

Browse files
zakdmazakdma
committed
MAGETWO-94174: Disable backups by default
1 parent 52498f2 commit 99ddaa2

File tree

22 files changed

+352
-384
lines changed

22 files changed

+352
-384
lines changed

‎app/code/Magento/Backend/Block/System/Store/Delete/Form.php

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,39 @@
55
*/
66
namespace Magento\Backend\Block\System\Store\Delete;
77

8+
use Magento\Backup\Helper\Data as BackupHelper;
9+
use Magento\Framework\App\ObjectManager;
10+
811
/**
912
* Adminhtml cms block edit form
1013
*
1114
* @author Magento Core Team <core@magentocommerce.com>
1215
*/
1316
class Form extends \Magento\Backend\Block\Widget\Form\Generic
1417
{
18+
/**
19+
* @var BackupHelper
20+
*/
21+
private $backup;
22+
23+
/**
24+
* @param \Magento\Backend\Block\Template\Context $context
25+
* @param \Magento\Framework\Registry $registry
26+
* @param \Magento\Framework\Data\FormFactory $formFactory
27+
* @param array $data
28+
* @param BackupHelper|null $backup
29+
*/
30+
public function __construct(
31+
\Magento\Backend\Block\Template\Context $context,
32+
\Magento\Framework\Registry $registry,
33+
\Magento\Framework\Data\FormFactory $formFactory,
34+
array $data = [],
35+
BackupHelper $backup = null
36+
) {
37+
parent::__construct($context, $registry, $formFactory, $data);
38+
$this->backup = $backup ?? ObjectManager::getInstance()->get(BackupHelper::class);
39+
}
40+
1541
/**
1642
* Init form
1743
*
@@ -25,7 +51,7 @@ protected function _construct()
2551
}
2652

2753
/**
28-
* {@inheritdoc}
54+
* @inheritDoc
2955
*/
3056
protected function _prepareForm()
3157
{
@@ -45,15 +71,21 @@ protected function _prepareForm()
4571

4672
$fieldset->addField('item_id', 'hidden', ['name' => 'item_id', 'value' => $dataObject->getId()]);
4773

74+
$backupOptions = ['0' => __('No')];
75+
$backupSelected = '0';
76+
if ($this->backup->isEnabled()) {
77+
$backupOptions['1'] = __('Yes');
78+
$backupSelected = '1';
79+
}
4880
$fieldset->addField(
4981
'create_backup',
5082
'select',
5183
[
5284
'label' => __('Create DB Backup'),
5385
'title' => __('Create DB Backup'),
5486
'name' => 'create_backup',
55-
'options' => ['1' => __('Yes'), '0' => __('No')],
56-
'value' => '1'
87+
'options' => $backupOptions,
88+
'value' => $backupSelected
5789
]
5890
);
5991

‎app/code/Magento/Backend/Controller/Adminhtml/System/Store.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
* Store controller
1515
*
1616
* @author Magento Core Team <core@magentocommerce.com>
17+
* @SuppressWarnings(PHPMD.AllPurposeAction)
1718
*/
1819
abstract class Store extends Action
1920
{
@@ -86,6 +87,8 @@ protected function createPage()
8687
* Backup database
8788
*
8889
* @return bool
90+
*
91+
* @deprecated Backup module is to be removed.
8992
*/
9093
protected function _backupDatabase()
9194
{

‎app/code/Magento/Backup/Controller/Adminhtml/Index.php

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,16 @@
55
*/
66
namespace Magento\Backup\Controller\Adminhtml;
77

8+
use Magento\Backup\Helper\Data as Helper;
9+
use Magento\Framework\App\ObjectManager;
10+
811
/**
912
* Backup admin controller
1013
*
1114
* @author Magento Core Team <core@magentocommerce.com>
1215
* @api
1316
* @since 100.0.2
17+
* @SuppressWarnings(PHPMD.AllPurposeAction)
1418
*/
1519
abstract class Index extends \Magento\Backend\App\Action
1620
{
@@ -48,27 +52,47 @@ abstract class Index extends \Magento\Backend\App\Action
4852
*/
4953
protected $maintenanceMode;
5054

55+
/**
56+
* @var Helper
57+
*/
58+
private $helper;
59+
5160
/**
5261
* @param \Magento\Backend\App\Action\Context $context
5362
* @param \Magento\Framework\Registry $coreRegistry
5463
* @param \Magento\Framework\Backup\Factory $backupFactory
5564
* @param \Magento\Framework\App\Response\Http\FileFactory $fileFactory
5665
* @param \Magento\Backup\Model\BackupFactory $backupModelFactory
5766
* @param \Magento\Framework\App\MaintenanceMode $maintenanceMode
67+
* @param Helper|null $helper
5868
*/
5969
public function __construct(
6070
\Magento\Backend\App\Action\Context $context,
6171
\Magento\Framework\Registry $coreRegistry,
6272
\Magento\Framework\Backup\Factory $backupFactory,
6373
\Magento\Framework\App\Response\Http\FileFactory $fileFactory,
6474
\Magento\Backup\Model\BackupFactory $backupModelFactory,
65-
\Magento\Framework\App\MaintenanceMode $maintenanceMode
75+
\Magento\Framework\App\MaintenanceMode $maintenanceMode,
76+
Helper $helper = null
6677
) {
6778
$this->_coreRegistry = $coreRegistry;
6879
$this->_backupFactory = $backupFactory;
6980
$this->_fileFactory = $fileFactory;
7081
$this->_backupModelFactory = $backupModelFactory;
7182
$this->maintenanceMode = $maintenanceMode;
83+
$this->helper = $helper ?? ObjectManager::getInstance()->get(Helper::class);
7284
parent::__construct($context);
7385
}
86+
87+
/**
88+
* @inheritDoc
89+
*/
90+
public function dispatch(\Magento\Framework\App\RequestInterface $request)
91+
{
92+
if (!$this->helper->isEnabled()) {
93+
return $this->_redirect('*/*/disabled');
94+
}
95+
96+
return parent::dispatch($request);
97+
}
7498
}

‎app/code/Magento/Backup/Controller/Adminhtml/Index/Disabled.php

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
7+
declare(strict_types=1);
8+
9+
namespace Magento\Backup\Controller\Adminhtml\Index;
10+
11+
use Magento\Backend\App\Action;
12+
use Magento\Backend\App\Action\Context;
13+
use Magento\Framework\View\Result\PageFactory;
14+
15+
/**
16+
* Inform that backup is disabled.
17+
*/
18+
class Disabled extends Action
19+
{
20+
/**
21+
* @see _isAllowed()
22+
*/
23+
const ADMIN_RESOURCE = 'Magento_Backend::backup';
24+
25+
/**
26+
* @var PageFactory
27+
*/
28+
private $pageFactory;
29+
30+
/**
31+
* @param Context $context
32+
* @param PageFactory $pageFactory
33+
*/
34+
public function __construct(Context $context, PageFactory $pageFactory)
35+
{
36+
parent::__construct($context);
37+
$this->pageFactory = $pageFactory;
38+
}
39+
40+
/**
41+
* @inheritDoc
42+
*/
43+
public function execute()
44+
{
45+
return $this->pageFactory->create();
46+
}
47+
}

‎app/code/Magento/Backup/Cron/SystemBackup.php

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
use Magento\Framework\App\Filesystem\DirectoryList;
99
use Magento\Store\Model\ScopeInterface;
1010

11+
/**
12+
* Performs scheduled backup.
13+
*/
1114
class SystemBackup
1215
{
1316
const XML_PATH_BACKUP_ENABLED = 'system/backup/enabled';
@@ -101,6 +104,10 @@ public function __construct(
101104
*/
102105
public function execute()
103106
{
107+
if (!$this->_backupData->isEnabled()) {
108+
return $this;
109+
}
110+
104111
if (!$this->_scopeConfig->isSetFlag(self::XML_PATH_BACKUP_ENABLED, ScopeInterface::SCOPE_STORE)) {
105112
return $this;
106113
}

‎app/code/Magento/Backup/Helper/Data.php

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* Copyright © Magento, Inc. All rights reserved.
44
* See COPYING.txt for license details.
55
*/
6+
7+
declare(strict_types=1);
8+
69
namespace Magento\Backup\Helper;
710

811
use Magento\Framework\App\Filesystem\DirectoryList;
@@ -285,4 +288,14 @@ public function extractDataFromFilename($filename)
285288

286289
return $result;
287290
}
291+
292+
/**
293+
* Is backup functionality enabled.
294+
*
295+
* @return bool
296+
*/
297+
public function isEnabled(): bool
298+
{
299+
return $this->scopeConfig->isSetFlag('system/backup/functionality_enabled');
300+
}
288301
}

‎app/code/Magento/Backup/Model/Db.php

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,16 @@
55
*/
66
namespace Magento\Backup\Model;
77

8+
use Magento\Backup\Helper\Data as Helper;
9+
use Magento\Framework\App\ObjectManager;
10+
use Magento\Framework\Exception\RuntimeException;
11+
812
/**
913
* Database backup model
1014
*
1115
* @api
1216
* @since 100.0.2
17+
* @deprecated Backup module is to be removed.
1318
*/
1419
class Db implements \Magento\Framework\Backup\Db\BackupDbInterface
1520
{
@@ -33,16 +38,24 @@ class Db implements \Magento\Framework\Backup\Db\BackupDbInterface
3338
*/
3439
protected $_resource = null;
3540

41+
/**
42+
* @var Helper
43+
*/
44+
private $helper;
45+
3646
/**
3747
* @param \Magento\Backup\Model\ResourceModel\Db $resourceDb
3848
* @param \Magento\Framework\App\ResourceConnection $resource
49+
* @param Helper|null $helper
3950
*/
4051
public function __construct(
4152
\Magento\Backup\Model\ResourceModel\Db $resourceDb,
42-
\Magento\Framework\App\ResourceConnection $resource
53+
\Magento\Framework\App\ResourceConnection $resource,
54+
Helper $helper = null
4355
) {
4456
$this->_resourceDb = $resourceDb;
4557
$this->_resource = $resource;
58+
$this->helper = $helper ?? ObjectManager::getInstance()->get(Helper::class);
4659
}
4760

4861
/**
@@ -63,6 +76,8 @@ public function getResource()
6376
}
6477

6578
/**
79+
* Tables list.
80+
*
6681
* @return array
6782
*/
6883
public function getTables()
@@ -71,6 +86,8 @@ public function getTables()
7186
}
7287

7388
/**
89+
* Command to recreate given table.
90+
*
7491
* @param string $tableName
7592
* @param bool $addDropIfExists
7693
* @return string
@@ -81,6 +98,8 @@ public function getTableCreateScript($tableName, $addDropIfExists = false)
8198
}
8299

83100
/**
101+
* Generate table's data dump.
102+
*
84103
* @param string $tableName
85104
* @return string
86105
*/
@@ -90,6 +109,8 @@ public function getTableDataDump($tableName)
90109
}
91110

92111
/**
112+
* Header for dumps.
113+
*
93114
* @return string
94115
*/
95116
public function getHeader()
@@ -98,6 +119,8 @@ public function getHeader()
98119
}
99120

100121
/**
122+
* Footer for dumps.
123+
*
101124
* @return string
102125
*/
103126
public function getFooter()
@@ -106,6 +129,8 @@ public function getFooter()
106129
}
107130

108131
/**
132+
* Get backup SQL.
133+
*
109134
* @return string
110135
*/
111136
public function renderSql()
@@ -124,13 +149,15 @@ public function renderSql()
124149
}
125150

126151
/**
127-
* Create backup and stream write to adapter
128-
*
129-
* @param \Magento\Framework\Backup\Db\BackupInterface $backup
130-
* @return $this
152+
* @inheritDoc
153+
* @throws RuntimeException
131154
*/
132155
public function createBackup(\Magento\Framework\Backup\Db\BackupInterface $backup)
133156
{
157+
if (!$this->helper->isEnabled()) {
158+
throw new RuntimeException(__('Backup functionality is disabled'));
159+
}
160+
134161
$backup->open(true);
135162

136163
$this->getResource()->beginTransaction();
@@ -179,8 +206,6 @@ public function createBackup(\Magento\Framework\Backup\Db\BackupInterface $backu
179206
$this->getResource()->commitTransaction();
180207

181208
$backup->close();
182-
183-
return $this;
184209
}
185210

186211
/**

0 commit comments

Comments
 (0)