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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Amqp;
use Magento\Framework\Amqp\Connection\FactoryOptions;
use Magento\Framework\App\DeploymentConfig;
use Magento\Framework\App\ObjectManager;
use PhpAmqpLib\Connection\AbstractConnection;
use PhpAmqpLib\Channel\AMQPChannel;
use Magento\Framework\Amqp\Connection\Factory as ConnectionFactory;
/**
* Reads the Amqp config in the deployed environment configuration
*
* @api
* @since 102.0.1
*/
class Config
{
/**
* Queue config key
*/
const QUEUE_CONFIG = 'queue';
/**
* Amqp config key
*/
const AMQP_CONFIG = 'amqp';
const HOST = 'host';
const PORT = 'port';
const USERNAME = 'user';
const PASSWORD = 'password';
const VIRTUALHOST = 'virtualhost';
const SSL = 'ssl';
const SSL_OPTIONS = 'ssl_options';
/**
* Deployment configuration
*
* @var DeploymentConfig
*/
private $deploymentConfig;
/**
* @var AbstractConnection
*/
private $connection;
/**
* @var AMQPChannel
*/
private $channel;
/**
* Associative array of Amqp configuration
*
* @var array
*/
private $data;
/**
* AMQP connection name.
*
* @var string
*/
private $connectionName;
/**
* @var ConnectionFactory
*/
private $connectionFactory;
/**
* Initialize dependencies.
*
* Example environment config:
* <code>
* 'queue' =>
* [
* 'amqp' => [
* 'host' => 'localhost',
* 'port' => 5672,
* 'username' => 'guest',
* 'password' => 'guest',
* 'virtual_host' => '/',
* 'ssl' => false,
* 'ssl_options' => [],
* ],
* ],
* </code>
*
* @param DeploymentConfig $config
* @param string $connectionName
* @param ConnectionFactory|null $connectionFactory
*/
public function __construct(
DeploymentConfig $config,
$connectionName = 'amqp',
ConnectionFactory $connectionFactory = null
) {
$this->deploymentConfig = $config;
$this->connectionName = $connectionName;
$this->connectionFactory = $connectionFactory
?: ObjectManager::getInstance()->get(ConnectionFactory::class);
}
/**
* Destructor
*
* @return void
* @since 102.0.1
*/
public function __destruct()
{
$this->closeConnection();
}
/**
* Returns the configuration set for the key.
*
* @param string $key
* @return string
* @throws \LogicException
* @since 102.0.1
*/
public function getValue($key)
{
$this->load();
return $this->data[$key] ?? null;
}
/**
* Create amqp connection
*
* @return AbstractConnection
*/
private function createConnection(): AbstractConnection
{
$sslEnabled = trim($this->getValue(self::SSL)) === 'true';
$options = new FactoryOptions();
$options->setHost($this->getValue(self::HOST));
$options->setPort($this->getValue(self::PORT));
$options->setUsername($this->getValue(self::USERNAME));
$options->setPassword($this->getValue(self::PASSWORD));
$options->setVirtualHost($this->getValue(self::VIRTUALHOST));
$options->setSslEnabled($sslEnabled);
/** @var array $sslOptions */
if ($sslOptions = $this->getValue(self::SSL_OPTIONS)) {
$options->setSslOptions($sslOptions);
}
return $this->connectionFactory->create($options);
}
/**
* Return Amqp channel
*
* @return AMQPChannel
* @throws \LogicException
* @since 102.0.1
*/
public function getChannel()
{
if (!isset($this->connection) || !isset($this->channel)) {
$this->connection = $this->createConnection();
$this->channel = $this->connection->channel();
}
return $this->channel;
}
/**
* Load the configuration for Amqp
*
* @return void
* @throws \LogicException
*/
private function load()
{
if (null === $this->data) {
$queueConfig = $this->deploymentConfig->getConfigData(self::QUEUE_CONFIG);
if ($this->connectionName == self::AMQP_CONFIG) {
$this->data = isset($queueConfig[self::AMQP_CONFIG]) ? $queueConfig[self::AMQP_CONFIG] : [];
} else {
$this->data = isset($queueConfig['connections'][$this->connectionName])
? $queueConfig['connections'][$this->connectionName]
: [];
}
if (empty($this->data)) {
throw new \LogicException('Unknown connection name ' . $this->connectionName);
}
}
}
/**
* Close Amqp connection and Channel
*
* @return void
*/
private function closeConnection()
{
if (isset($this->channel)) {
$this->channel->close();
unset($this->channel);
}
if (isset($this->connection)) {
$this->connection->close();
unset($this->connection);
}
}
}