1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Setup\Controller;
use Magento\Framework\App\Filesystem\DirectoryList;
use Magento\Framework\Filesystem;
use Magento\Setup\Model\Cron\ReadinessCheck;
use Zend\Mvc\Controller\AbstractActionController;
/**
* Class Environment
*
* Provides information and checks about the environment.
*/
class Environment extends AbstractActionController
{
/**
* Path to updater application
*/
const UPDATER_DIR = 'update';
/**
* File system
*
* @var \Magento\Framework\Filesystem
*/
protected $filesystem;
/**
* Cron Script Readiness Check
*
* @var \Magento\Setup\Model\CronScriptReadinessCheck
*/
protected $cronScriptReadinessCheck;
/**
* PHP Readiness Check
*
* @var \Magento\Setup\Model\PhpReadinessCheck
*/
protected $phpReadinessCheck;
/**
* Constructor
*
* @param \Magento\Framework\Setup\FilePermissions $permissions
* @param \Magento\Framework\Filesystem $filesystem
* @param \Magento\Setup\Model\CronScriptReadinessCheck $cronScriptReadinessCheck
* @param \Magento\Setup\Model\PhpReadinessCheck $phpReadinessCheck
*/
public function __construct(
\Magento\Framework\Setup\FilePermissions $permissions,
\Magento\Framework\Filesystem $filesystem,
\Magento\Setup\Model\CronScriptReadinessCheck $cronScriptReadinessCheck,
\Magento\Setup\Model\PhpReadinessCheck $phpReadinessCheck
) {
$this->permissions = $permissions;
$this->filesystem = $filesystem;
$this->cronScriptReadinessCheck = $cronScriptReadinessCheck;
$this->phpReadinessCheck = $phpReadinessCheck;
}
/**
* No index action, return 404 error page
*
* @return \Zend\View\Model\JsonModel
*/
public function indexAction()
{
$view = new \Zend\View\Model\JsonModel([]);
$view->setTemplate('/error/404.phtml');
$this->getResponse()->setStatusCode(\Zend\Http\Response::STATUS_CODE_404);
return $view;
}
/**
* Verifies php version
*
* @return \Zend\View\Model\JsonModel
*/
public function phpVersionAction()
{
$type = $this->getRequest()->getQuery('type');
$data = [];
if ($type == ReadinessCheckInstaller::INSTALLER) {
$data = $this->phpReadinessCheck->checkPhpVersion();
} elseif ($type == ReadinessCheckUpdater::UPDATER) {
$data = $this->getPhpChecksInfo(ReadinessCheck::KEY_PHP_VERSION_VERIFIED);
}
return new \Zend\View\Model\JsonModel($data);
}
/**
* Checks PHP settings
*
* @return \Zend\View\Model\JsonModel
*/
public function phpSettingsAction()
{
$type = $this->getRequest()->getQuery('type');
$data = [];
if ($type == ReadinessCheckInstaller::INSTALLER) {
$data = $this->phpReadinessCheck->checkPhpSettings();
} elseif ($type == ReadinessCheckUpdater::UPDATER) {
$data = $this->getPhpChecksInfo(ReadinessCheck::KEY_PHP_SETTINGS_VERIFIED);
}
return new \Zend\View\Model\JsonModel($data);
}
/**
* Verifies php verifications
*
* @return \Zend\View\Model\JsonModel
*/
public function phpExtensionsAction()
{
$type = $this->getRequest()->getQuery('type');
$data = [];
if ($type == ReadinessCheckInstaller::INSTALLER) {
$data = $this->phpReadinessCheck->checkPhpExtensions();
} elseif ($type == ReadinessCheckUpdater::UPDATER) {
$data = $this->getPhpChecksInfo(ReadinessCheck::KEY_PHP_EXTENSIONS_VERIFIED);
}
return new \Zend\View\Model\JsonModel($data);
}
/**
* Gets the PHP check info from Cron status file
*
* @param string $type
* @return array
*/
private function getPhpChecksInfo($type)
{
$read = $this->filesystem->getDirectoryRead(DirectoryList::VAR_DIR);
try {
$jsonData = json_decode($read->readFile(ReadinessCheck::SETUP_CRON_JOB_STATUS_FILE), true);
if (isset($jsonData[ReadinessCheck::KEY_PHP_CHECKS])
&& isset($jsonData[ReadinessCheck::KEY_PHP_CHECKS][$type])
) {
return $jsonData[ReadinessCheck::KEY_PHP_CHECKS][$type];
}
return ['responseType' => ResponseTypeInterface::RESPONSE_TYPE_ERROR];
} catch (\Exception $e) {
return ['responseType' => ResponseTypeInterface::RESPONSE_TYPE_ERROR];
}
}
/**
* Verifies file permissions
*
* @return \Zend\View\Model\JsonModel
*/
public function filePermissionsAction()
{
$responseType = ResponseTypeInterface::RESPONSE_TYPE_SUCCESS;
$missingWritePermissionPaths = $this->permissions->getMissingWritablePathsForInstallation(true);
$currentPaths = [];
$requiredPaths = [];
if ($missingWritePermissionPaths) {
foreach ($missingWritePermissionPaths as $key => $value) {
if (is_array($value)) {
$requiredPaths[] = ['path' => $key, 'missing' => $value];
$responseType = ResponseTypeInterface::RESPONSE_TYPE_ERROR;
} else {
$requiredPaths[] = ['path' => $key];
$currentPaths[] = $key;
}
}
}
$data = [
'responseType' => $responseType,
'data' => [
'required' => $requiredPaths,
'current' => $currentPaths,
],
];
return new \Zend\View\Model\JsonModel($data);
}
/**
* Verifies updater application exists
*
* @return \Zend\View\Model\JsonModel
*/
public function updaterApplicationAction()
{
$responseType = ResponseTypeInterface::RESPONSE_TYPE_SUCCESS;
if (!$this->filesystem->getDirectoryRead(DirectoryList::ROOT)->isExist(self::UPDATER_DIR)) {
$responseType = ResponseTypeInterface::RESPONSE_TYPE_ERROR;
}
$data = [
'responseType' => $responseType
];
return new \Zend\View\Model\JsonModel($data);
}
/**
* Verifies Setup and Updater Cron status
*
* @return \Zend\View\Model\JsonModel
*/
public function cronScriptAction()
{
$responseType = ResponseTypeInterface::RESPONSE_TYPE_SUCCESS;
$setupCheck = $this->cronScriptReadinessCheck->checkSetup();
$updaterCheck = $this->cronScriptReadinessCheck->checkUpdater();
$data = [];
if (!$setupCheck['success']) {
$responseType = ResponseTypeInterface::RESPONSE_TYPE_ERROR;
$data['setupErrorMessage'] = 'Error from Setup Application Cron Script:<br/>' . $setupCheck['error'];
}
if (!$updaterCheck['success']) {
$responseType = ResponseTypeInterface::RESPONSE_TYPE_ERROR;
$data['updaterErrorMessage'] = 'Error from Updater Application Cron Script:<br/>' . $updaterCheck['error'];
}
if (isset($setupCheck['notice'])) {
$data['setupNoticeMessage'] = 'Notice from Setup Application Cron Script:<br/>' . $setupCheck['notice'];
}
if (isset($updaterCheck['notice'])) {
$data['updaterNoticeMessage'] = 'Notice from Updater Application Cron Script:<br/>' .
$updaterCheck['notice'];
}
$data['responseType'] = $responseType;
return new \Zend\View\Model\JsonModel($data);
}
}