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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Setup\Model;
/**
* Validates payloads for updater tasks
*/
class PayloadValidator
{
/**
* @var \Magento\Framework\Module\FullModuleList
*/
private $moduleList;
/**
* @param \Magento\Framework\Module\FullModuleList $moduleList
*/
public function __construct(\Magento\Framework\Module\FullModuleList $moduleList)
{
$this->moduleList = $moduleList;
}
/**
* Validate POST request payload
*
* @param array $postPayload
* @return string
*/
public function validatePayload(array $postPayload)
{
$jobType = $postPayload[UpdaterTaskCreator::KEY_POST_JOB_TYPE];
$errorMessage = '';
switch ($jobType) {
case 'uninstall':
$errorMessage = $this->validateUninstallPayload($postPayload);
break;
case 'update':
$errorMessage = $this->validateUpdatePayload($postPayload);
break;
case 'enable':
case 'disable':
$errorMessage = $this->validateEnableDisablePayload($postPayload);
break;
}
return $errorMessage;
}
/**
* Validate 'uninstall' job type payload
*
* @param array $postPayload
* @return string
*/
private function validateUninstallPayload(array $postPayload)
{
$errorMessage = '';
if (!isset($postPayload[UpdaterTaskCreator::KEY_POST_DATA_OPTION])) {
$errorMessage = 'Missing dataOption' . PHP_EOL;
}
return $errorMessage;
}
/**
* Validate 'update' job type payload
*
* @param array $postPayload
* @return string
*/
private function validateUpdatePayload(array $postPayload)
{
$errorMessage = '';
if (!isset($postPayload[UpdaterTaskCreator::KEY_POST_PACKAGES])) {
$errorMessage = 'Missing packages' . PHP_EOL;
} else {
$packages = $postPayload[UpdaterTaskCreator::KEY_POST_PACKAGES];
foreach ($packages as $package) {
if ((!isset($package[UpdaterTaskCreator::KEY_POST_PACKAGE_NAME]))
|| (!isset($package[UpdaterTaskCreator::KEY_POST_PACKAGE_VERSION]))
) {
$errorMessage .= 'Missing package information' . PHP_EOL;
break;
}
}
}
return $errorMessage;
}
/**
* Validate 'enable/disable' job type payload
*
* @param array $postPayload
* @return string
*/
private function validateEnableDisablePayload(array $postPayload)
{
$errorMessage = '';
if (!isset($postPayload[UpdaterTaskCreator::KEY_POST_PACKAGES])) {
$errorMessage = 'Missing packages' . PHP_EOL;
} else {
$packages = $postPayload[UpdaterTaskCreator::KEY_POST_PACKAGES];
foreach ($packages as $package) {
if (!$this->moduleList->has($package[UpdaterTaskCreator::KEY_POST_PACKAGE_NAME])) {
$errorMessage .= 'Invalid Magento module name: '
. $package[UpdaterTaskCreator::KEY_POST_PACKAGE_NAME] . PHP_EOL;
break;
}
}
}
return $errorMessage;
}
}