-
Notifications
You must be signed in to change notification settings - Fork 15
/
AliasRecord.php
243 lines (217 loc) · 5.04 KB
/
AliasRecord.php
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
238
239
240
241
242
243
<?php
namespace Consolidation\SiteAlias;
use Consolidation\Config\Config;
use Consolidation\Config\ConfigInterface;
use Consolidation\Config\Util\ArrayUtil;
use Drush\Utils\FsUtils;
/**
* An alias record is a configuration record containing well-known items.
*
* @see AliasRecordInterface for documentation
*/
class AliasRecord extends Config implements AliasRecordInterface
{
/**
* @var string
*/
protected $name;
/**
* @inheritdoc
*/
public function __construct(array $data = null, $name = '', $env = '')
{
parent::__construct($data);
if (!empty($env)) {
$name .= ".$env";
}
$this->name = $name;
}
/**
* @inheritdoc
*/
public function getConfig(ConfigInterface $config, $key, $default = null)
{
if ($this->has($key)) {
return $this->get($key, $default);
}
return $config->get($key, $default);
}
/**
* @inheritdoc
*/
public function name()
{
return $this->name;
}
/**
* @inheritdoc
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @inheritdoc
*/
public function hasRoot()
{
return $this->has('root');
}
/**
* @inheritdoc
*/
public function root()
{
$root = $this->get('root');
if ($this->isLocal()) {
return FsUtils::realpath($root);
}
return $root;
}
/**
* @inheritdoc
*/
public function uri()
{
return $this->get('uri');
}
/**
* @inheritdoc
*/
public function setUri($uri)
{
return $this->set('uri', $uri);
}
/**
* @inheritdoc
*/
public function remoteHostWithUser()
{
$result = $this->remoteHost();
if (!empty($result) && $this->hasRemoteUser()) {
$result = $this->remoteUser() . '@' . $result;
}
return $result;
}
/**
* @inheritdoc
*/
public function remoteUser()
{
return $this->get('user');
}
/**
* @inheritdoc
*/
public function hasRemoteUser()
{
return $this->has('user');
}
/**
* @inheritdoc
*/
public function remoteHost()
{
return $this->get('host');
}
/**
* @inheritdoc
*/
public function isRemote()
{
return !$this->isLocal();
}
/**
* @inheritdoc
*/
public function isLocal()
{
if ($host = $this->remoteHost()) {
return $host == 'localhost' || $host == '127.0.0.1';
}
return true;
}
/**
* @inheritdoc
*/
public function isNone()
{
return empty($this->root()) && $this->isLocal();
}
/**
* @inheritdoc
*/
public function localRoot()
{
if (!$this->isRemote()) {
return $this->root();
}
return false;
}
/**
* @inheritdoc
*/
public function exportConfig()
{
return $this->remap($this->export());
}
/**
* Reconfigure data exported from the form it is expected to be in
* inside an alias record to the form it is expected to be in when
* inside a configuration file.
*/
protected function remap($data)
{
foreach ($this->remapOptionTable() as $from => $to) {
if (isset($data[$from])) {
unset($data[$from]);
}
$value = $this->get($from, null);
if (isset($value)) {
$data['options'][$to] = $value;
}
}
return new Config($data);
}
/**
* Fetch the parameter-specific options from the 'alias-parameters' section of the alias.
* @param string $parameterName
* @return array
*/
protected function getParameterSpecificOptions($aliasData, $parameterName)
{
if (!empty($parameterName) && $this->has("alias-parameters.{$parameterName}")) {
return $this->get("alias-parameters.{$parameterName}");
}
return [];
}
/**
* Convert the data in this record to the layout that was used
* in the legacy code, for backwards compatiblity.
*/
public function legacyRecord()
{
$result = $this->exportConfig()->get('options', []);
// Backend invoke needs a couple of critical items in specific locations.
if ($this->has('paths.drush-script')) {
$result['path-aliases']['%drush-script'] = $this->get('paths.drush-script');
}
if ($this->has('ssh.options')) {
$result['ssh-options'] = $this->get('ssh.options');
}
return $result;
}
/**
* Conversion table from old to new option names. These all implicitly
* go in `options`, although they can come from different locations.
*/
protected function remapOptionTable()
{
return [
'user' => 'remote-user',
'host' => 'remote-host',
'root' => 'root',
'uri' => 'uri',
];
}
}