|
| 1 | +<?php |
| 2 | +/** |
| 3 | + * Copyright © Magento, Inc. All rights reserved. |
| 4 | + * See COPYING.txt for license details. |
| 5 | + */ |
| 6 | +namespace Magento\Amqp\Setup; |
| 7 | + |
| 8 | +use Magento\Framework\Config\Data\ConfigData; |
| 9 | +use Magento\Framework\Config\File\ConfigFilePool; |
| 10 | +use Magento\Framework\Setup\ConfigOptionsListInterface; |
| 11 | +use Magento\Framework\Setup\Option\TextConfigOption; |
| 12 | +use Magento\Framework\App\DeploymentConfig; |
| 13 | + |
| 14 | +/** |
| 15 | + * Deployment configuration options needed for Setup application |
| 16 | + */ |
| 17 | +class ConfigOptionsList implements ConfigOptionsListInterface |
| 18 | +{ |
| 19 | + /** |
| 20 | + * Input key for the options |
| 21 | + */ |
| 22 | + const INPUT_KEY_QUEUE_AMQP_HOST = 'amqp-host'; |
| 23 | + const INPUT_KEY_QUEUE_AMQP_PORT = 'amqp-port'; |
| 24 | + const INPUT_KEY_QUEUE_AMQP_USER = 'amqp-user'; |
| 25 | + const INPUT_KEY_QUEUE_AMQP_PASSWORD = 'amqp-password'; |
| 26 | + const INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST = 'amqp-virtualhost'; |
| 27 | + const INPUT_KEY_QUEUE_AMQP_SSL = 'amqp-ssl'; |
| 28 | + |
| 29 | + /** |
| 30 | + * Path to the values in the deployment config |
| 31 | + */ |
| 32 | + const CONFIG_PATH_QUEUE_AMQP_HOST = 'queue/amqp/host'; |
| 33 | + const CONFIG_PATH_QUEUE_AMQP_PORT = 'queue/amqp/port'; |
| 34 | + const CONFIG_PATH_QUEUE_AMQP_USER = 'queue/amqp/user'; |
| 35 | + const CONFIG_PATH_QUEUE_AMQP_PASSWORD = 'queue/amqp/password'; |
| 36 | + const CONFIG_PATH_QUEUE_AMQP_VIRTUAL_HOST = 'queue/amqp/virtualhost'; |
| 37 | + const CONFIG_PATH_QUEUE_AMQP_SSL = 'queue/amqp/ssl'; |
| 38 | + |
| 39 | + /** |
| 40 | + * Default values |
| 41 | + */ |
| 42 | + const DEFAULT_AMQP_HOST = ''; |
| 43 | + const DEFAULT_AMQP_PORT = '5672'; |
| 44 | + const DEFAULT_AMQP_USER = ''; |
| 45 | + const DEFAULT_AMQP_PASSWORD = ''; |
| 46 | + const DEFAULT_AMQP_VIRTUAL_HOST = '/'; |
| 47 | + const DEFAULT_AMQP_SSL = ''; |
| 48 | + |
| 49 | + /** |
| 50 | + * @var ConnectionValidator |
| 51 | + */ |
| 52 | + private $connectionValidator; |
| 53 | + |
| 54 | + /** |
| 55 | + * Constructor |
| 56 | + * |
| 57 | + * @param ConnectionValidator $connectionValidator |
| 58 | + */ |
| 59 | + public function __construct(ConnectionValidator $connectionValidator) |
| 60 | + { |
| 61 | + $this->connectionValidator = $connectionValidator; |
| 62 | + } |
| 63 | + |
| 64 | + /** |
| 65 | + * {@inheritdoc} |
| 66 | + */ |
| 67 | + public function getOptions() |
| 68 | + { |
| 69 | + return [ |
| 70 | + new TextConfigOption( |
| 71 | + self::INPUT_KEY_QUEUE_AMQP_HOST, |
| 72 | + TextConfigOption::FRONTEND_WIZARD_TEXT, |
| 73 | + self::CONFIG_PATH_QUEUE_AMQP_HOST, |
| 74 | + 'Amqp server host', |
| 75 | + self::DEFAULT_AMQP_HOST |
| 76 | + ), |
| 77 | + new TextConfigOption( |
| 78 | + self::INPUT_KEY_QUEUE_AMQP_PORT, |
| 79 | + TextConfigOption::FRONTEND_WIZARD_TEXT, |
| 80 | + self::CONFIG_PATH_QUEUE_AMQP_PORT, |
| 81 | + 'Amqp server port', |
| 82 | + self::DEFAULT_AMQP_PORT |
| 83 | + ), |
| 84 | + new TextConfigOption( |
| 85 | + self::INPUT_KEY_QUEUE_AMQP_USER, |
| 86 | + TextConfigOption::FRONTEND_WIZARD_TEXT, |
| 87 | + self::CONFIG_PATH_QUEUE_AMQP_USER, |
| 88 | + 'Amqp server username', |
| 89 | + self::DEFAULT_AMQP_USER |
| 90 | + ), |
| 91 | + new TextConfigOption( |
| 92 | + self::INPUT_KEY_QUEUE_AMQP_PASSWORD, |
| 93 | + TextConfigOption::FRONTEND_WIZARD_TEXT, |
| 94 | + self::CONFIG_PATH_QUEUE_AMQP_PASSWORD, |
| 95 | + 'Amqp server password', |
| 96 | + self::DEFAULT_AMQP_PASSWORD |
| 97 | + ), |
| 98 | + new TextConfigOption( |
| 99 | + self::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST, |
| 100 | + TextConfigOption::FRONTEND_WIZARD_TEXT, |
| 101 | + self::CONFIG_PATH_QUEUE_AMQP_VIRTUAL_HOST, |
| 102 | + 'Amqp virtualhost', |
| 103 | + self::DEFAULT_AMQP_VIRTUAL_HOST |
| 104 | + ), |
| 105 | + new TextConfigOption( |
| 106 | + self::INPUT_KEY_QUEUE_AMQP_SSL, |
| 107 | + TextConfigOption::FRONTEND_WIZARD_TEXT, |
| 108 | + self::CONFIG_PATH_QUEUE_AMQP_SSL, |
| 109 | + 'Amqp SSL', |
| 110 | + self::DEFAULT_AMQP_SSL |
| 111 | + ), |
| 112 | + ]; |
| 113 | + } |
| 114 | + |
| 115 | + /** |
| 116 | + * {@inheritdoc} |
| 117 | + * @SuppressWarnings(PHPMD.UnusedFormalParameter) |
| 118 | + */ |
| 119 | + public function createConfig(array $data, DeploymentConfig $deploymentConfig) |
| 120 | + { |
| 121 | + $configData = new ConfigData(ConfigFilePool::APP_ENV); |
| 122 | + |
| 123 | + if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_HOST)) { |
| 124 | + $configData->set(self::CONFIG_PATH_QUEUE_AMQP_HOST, $data[self::INPUT_KEY_QUEUE_AMQP_HOST]); |
| 125 | + if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_PORT)) { |
| 126 | + $configData->set(self::CONFIG_PATH_QUEUE_AMQP_PORT, $data[self::INPUT_KEY_QUEUE_AMQP_PORT]); |
| 127 | + } |
| 128 | + if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_USER)) { |
| 129 | + $configData->set(self::CONFIG_PATH_QUEUE_AMQP_USER, $data[self::INPUT_KEY_QUEUE_AMQP_USER]); |
| 130 | + } |
| 131 | + if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_PASSWORD)) { |
| 132 | + $configData->set(self::CONFIG_PATH_QUEUE_AMQP_PASSWORD, $data[self::INPUT_KEY_QUEUE_AMQP_PASSWORD]); |
| 133 | + } |
| 134 | + if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST)) { |
| 135 | + $configData->set( |
| 136 | + self::CONFIG_PATH_QUEUE_AMQP_VIRTUAL_HOST, |
| 137 | + $data[self::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST] |
| 138 | + ); |
| 139 | + } |
| 140 | + if (!$this->isDataEmpty($data, self::INPUT_KEY_QUEUE_AMQP_SSL)) { |
| 141 | + $configData->set(self::CONFIG_PATH_QUEUE_AMQP_SSL, $data[self::INPUT_KEY_QUEUE_AMQP_SSL]); |
| 142 | + } |
| 143 | + } |
| 144 | + |
| 145 | + return [$configData]; |
| 146 | + } |
| 147 | + |
| 148 | + /** |
| 149 | + * {@inheritdoc} |
| 150 | + */ |
| 151 | + public function validate(array $options, DeploymentConfig $deploymentConfig) |
| 152 | + { |
| 153 | + $errors = []; |
| 154 | + |
| 155 | + if (isset($options[self::INPUT_KEY_QUEUE_AMQP_HOST]) |
| 156 | + && $options[self::INPUT_KEY_QUEUE_AMQP_HOST] !== '') { |
| 157 | + $result = $this->connectionValidator->isConnectionValid( |
| 158 | + $options[self::INPUT_KEY_QUEUE_AMQP_HOST], |
| 159 | + $options[self::INPUT_KEY_QUEUE_AMQP_PORT], |
| 160 | + $options[self::INPUT_KEY_QUEUE_AMQP_USER], |
| 161 | + $options[self::INPUT_KEY_QUEUE_AMQP_PASSWORD], |
| 162 | + $options[self::INPUT_KEY_QUEUE_AMQP_VIRTUAL_HOST] |
| 163 | + ); |
| 164 | + |
| 165 | + if (!$result) { |
| 166 | + $errors[] = "Could not connect to the Amqp Server."; |
| 167 | + } |
| 168 | + } |
| 169 | + |
| 170 | + return $errors; |
| 171 | + } |
| 172 | + |
| 173 | + /** |
| 174 | + * Check if data ($data) with key ($key) is empty |
| 175 | + * |
| 176 | + * @param array $data |
| 177 | + * @param string $key |
| 178 | + * @return bool |
| 179 | + */ |
| 180 | + private function isDataEmpty(array $data, $key) |
| 181 | + { |
| 182 | + if (isset($data[$key]) && $data[$key] !== '') { |
| 183 | + return false; |
| 184 | + } |
| 185 | + |
| 186 | + return true; |
| 187 | + } |
| 188 | +} |
0 commit comments