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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Amqp\Setup;
use Magento\Framework\Config\Data\ConfigData;
use Magento\Framework\Config\File\ConfigFilePool;
use Magento\Framework\Setup\ConfigOptionsListInterface;
use Magento\Framework\Setup\Option\TextConfigOption;
use Magento\Framework\App\DeploymentConfig;
/**
* Deployment configuration options needed for Setup application
*/
class ConfigOptionsList implements ConfigOptionsListInterface
{
/**
* Input key for the options
*/
const INPUT_KEY_QUEUE_AMQP_HOST = 'amqp-host';
const INPUT_KEY_QUEUE_AMQP_PORT = 'amqp-port';
const INPUT_KEY_QUEUE_AMQP_USER = 'amqp-user';
const INPUT_KEY_QUEUE_AMQP_PASSWORD = 'amqp-password';
const INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST = 'amqp-virtualhost';
const INPUT_KEY_QUEUE_AMQP_SSL = 'amqp-ssl';
const INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS = 'amqp-ssl-options';
/**
* Path to the values in the deployment config
*/
const CONFIG_PATH_QUEUE_AMQP_HOST = 'queue/amqp/host';
const CONFIG_PATH_QUEUE_AMQP_PORT = 'queue/amqp/port';
const CONFIG_PATH_QUEUE_AMQP_USER = 'queue/amqp/user';
const CONFIG_PATH_QUEUE_AMQP_PASSWORD = 'queue/amqp/password';
const CONFIG_PATH_QUEUE_AMQP_VIRTUAL_HOST = 'queue/amqp/virtualhost';
const CONFIG_PATH_QUEUE_AMQP_SSL = 'queue/amqp/ssl';
const CONFIG_PATH_QUEUE_AMQP_SSL_OPTIONS = 'queue/amqp/ssl_options';
/**
* Default values
*/
const DEFAULT_AMQP_HOST = '';
const DEFAULT_AMQP_PORT = '5672';
const DEFAULT_AMQP_USER = '';
const DEFAULT_AMQP_PASSWORD = '';
const DEFAULT_AMQP_VIRTUAL_HOST = '/';
const DEFAULT_AMQP_SSL = '';
/**
* @var ConnectionValidator
*/
private $connectionValidator;
/**
* Constructor
*
* @param ConnectionValidator $connectionValidator
*/
public function __construct(ConnectionValidator $connectionValidator)
{
$this->connectionValidator = $connectionValidator;
}
/**
* {@inheritdoc}
*/
public function getOptions()
{
return [
new TextConfigOption(
self::INPUT_KEY_QUEUE_AMQP_HOST,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_QUEUE_AMQP_HOST,
'Amqp server host',
self::DEFAULT_AMQP_HOST
),
new TextConfigOption(
self::INPUT_KEY_QUEUE_AMQP_PORT,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_QUEUE_AMQP_PORT,
'Amqp server port',
self::DEFAULT_AMQP_PORT
),
new TextConfigOption(
self::INPUT_KEY_QUEUE_AMQP_USER,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_QUEUE_AMQP_USER,
'Amqp server username',
self::DEFAULT_AMQP_USER
),
new TextConfigOption(
self::INPUT_KEY_QUEUE_AMQP_PASSWORD,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_QUEUE_AMQP_PASSWORD,
'Amqp server password',
self::DEFAULT_AMQP_PASSWORD
),
new TextConfigOption(
self::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_QUEUE_AMQP_VIRTUAL_HOST,
'Amqp virtualhost',
self::DEFAULT_AMQP_VIRTUAL_HOST
),
new TextConfigOption(
self::INPUT_KEY_QUEUE_AMQP_SSL,
TextConfigOption::FRONTEND_WIZARD_TEXT,
self::CONFIG_PATH_QUEUE_AMQP_SSL,
'Amqp SSL',
self::DEFAULT_AMQP_SSL
),
new TextConfigOption(
self::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS,
TextConfigOption::FRONTEND_WIZARD_TEXTAREA,
self::CONFIG_PATH_QUEUE_AMQP_SSL_OPTIONS,
'Amqp SSL Options (JSON)',
self::DEFAULT_AMQP_SSL
),
];
}
/**
* {@inheritdoc}
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function createConfig(array $data, DeploymentConfig $deploymentConfig)
{
$configData = new ConfigData(ConfigFilePool::APP_ENV);
if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_HOST)) {
$configData->set(self::CONFIG_PATH_QUEUE_AMQP_HOST, $data[self::INPUT_KEY_QUEUE_AMQP_HOST]);
if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_PORT)) {
$configData->set(self::CONFIG_PATH_QUEUE_AMQP_PORT, $data[self::INPUT_KEY_QUEUE_AMQP_PORT]);
}
if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_USER)) {
$configData->set(self::CONFIG_PATH_QUEUE_AMQP_USER, $data[self::INPUT_KEY_QUEUE_AMQP_USER]);
}
if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_PASSWORD)) {
$configData->set(self::CONFIG_PATH_QUEUE_AMQP_PASSWORD, $data[self::INPUT_KEY_QUEUE_AMQP_PASSWORD]);
}
if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST)) {
$configData->set(
self::CONFIG_PATH_QUEUE_AMQP_VIRTUAL_HOST,
$data[self::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST]
);
}
if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_SSL)) {
$configData->set(self::CONFIG_PATH_QUEUE_AMQP_SSL, $data[self::INPUT_KEY_QUEUE_AMQP_SSL]);
}
if (!$this->isDataEmpty(
$data,
self::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS
)) {
$options = json_decode(
$data[self::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS],
true
);
if ($options !== null) {
$configData->set(
self::CONFIG_PATH_QUEUE_AMQP_SSL_OPTIONS,
$options
);
}
}
}
return [$configData];
}
/**
* {@inheritdoc}
*/
public function validate(array $options, DeploymentConfig $deploymentConfig)
{
$errors = [];
if (isset($options[self::INPUT_KEY_QUEUE_AMQP_HOST])
&& $options[self::INPUT_KEY_QUEUE_AMQP_HOST] !== '') {
if (!$this->isDataEmpty(
$options,
self::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS
)) {
$sslOptions = json_decode(
$options[self::INPUT_KEY_QUEUE_AMQP_SSL_OPTIONS],
true
);
} else {
$sslOptions = null;
}
$isSslEnabled = !empty($options[self::INPUT_KEY_QUEUE_AMQP_SSL])
&& $options[self::INPUT_KEY_QUEUE_AMQP_SSL] !== 'false';
$result = $this->connectionValidator->isConnectionValid(
$options[self::INPUT_KEY_QUEUE_AMQP_HOST],
$options[self::INPUT_KEY_QUEUE_AMQP_PORT],
$options[self::INPUT_KEY_QUEUE_AMQP_USER],
$options[self::INPUT_KEY_QUEUE_AMQP_PASSWORD],
$options[self::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST],
$isSslEnabled,
$sslOptions
);
if (!$result) {
$errors[] = "Could not connect to the Amqp Server.";
}
}
return $errors;
}
/**
* Check if data ($data) with key ($key) is empty
*
* @param array $data
* @param string $key
* @return bool
*/
private function isDataEmpty(array $data, $key)
{
if (isset($data[$key]) && $data[$key] !== '') {
return false;
}
return true;
}
}