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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
<?php
/**
* @see https://github.com/zendframework/zend-component-installer for the canonical source repository
* @copyright Copyright (c) 2016-2017 Zend Technologies USA Inc. (http://www.zend.com)
* @license https://github.com/zendframework/zend-component-installer/blob/master/LICENSE.md New BSD License
*/
namespace Zend\ComponentInstaller\Injector;
use Zend\ComponentInstaller\Exception;
abstract class AbstractInjector implements InjectorInterface
{
/**
* Types this injector is allowed to register.
*
* Implementations MAY overwrite this value.
*
* @param int[]
*/
protected $allowedTypes = [
self::TYPE_COMPONENT,
self::TYPE_MODULE,
self::TYPE_DEPENDENCY,
self::TYPE_BEFORE_APPLICATION,
];
/**
* Replacements to make after removing code from the configuration for clean-up purposes.
*
* Implementations MAY overwrite this value.
*
* Structure MUST be:
*
* ```
* [
* 'pattern' => 'regular expression',
* 'replacement' => 'preg_replace replacement',
* ],
* ```
*
* @var string[]
*/
protected $cleanUpPatterns = [
'pattern' => "/(array\(|\[|,)(\r?\n){2}/s",
'replacement' => "\$1\n",
];
/**
* Configuration file to update.
*
* Implementations MUST overwrite this value.
*
* @var string
*/
protected $configFile;
/**
* Patterns and replacements to use when registering a code item.
*
* Implementations MUST overwrite this value.
*
* Structure MUST be:
*
* ```
* [
* TYPE_CONSTANT => [
* 'pattern' => 'regular expression',
* 'replacement' => 'preg_replace replacement, with %s placeholder for package',
* ],
* ]
* ```
*
* @var string[]
*/
protected $injectionPatterns = [];
/**
* Pattern to use to determine if the code item is registered.
*
* Implementations MUST overwrite this value.
*
* @var string
*/
protected $isRegisteredPattern;
/**
* Patterns and replacements to use when removing a code item.
*
* Implementations MUST overwrite this value.
*
* Structure MUST be:
*
* ```
* [
* 'pattern' => 'regular expression, with %s placeholder for component namespace/configuration class',
* 'replacement' => 'preg_replace replacement, usually an empty string',
* ],
* ```
*
* @var string[]
*/
protected $removalPatterns = [];
/**
* Modules of the application.
*
* @var array
*/
protected $applicationModules = [];
/**
* Dependencies of the module.
*
* @var array
*/
protected $moduleDependencies = [];
/**
* Constructor
*
* Optionally accept the project root directory; if non-empty, it is used
* to prefix the $configFile.
*
* @param string $projectRoot
*/
public function __construct($projectRoot = '')
{
if (is_string($projectRoot) && ! empty($projectRoot)) {
$this->configFile = sprintf('%s/%s', $projectRoot, $this->configFile);
}
}
/**
* {@inheritDoc}
*/
public function registersType($type)
{
return in_array($type, $this->allowedTypes, true);
}
/**
* {@inheritDoc}
*/
public function getTypesAllowed()
{
return $this->allowedTypes;
}
/**
* {@inheritDoc}
*/
public function isRegistered($package)
{
$config = file_get_contents($this->configFile);
return $this->isRegisteredInConfig($package, $config);
}
/**
* {@inheritDoc}
*/
public function inject($package, $type)
{
$config = file_get_contents($this->configFile);
if ($this->isRegisteredInConfig($package, $config)) {
return false;
}
if ($type === self::TYPE_COMPONENT
&& $this->moduleDependencies
) {
return $this->injectAfterDependencies($package, $config);
}
if ($type === self::TYPE_MODULE
&& ($firstApplicationModule = $this->findFirstEnabledApplicationModule($this->applicationModules, $config))
) {
return $this->injectBeforeApplicationModules($package, $config, $firstApplicationModule);
}
$pattern = $this->injectionPatterns[$type]['pattern'];
$replacement = sprintf(
$this->injectionPatterns[$type]['replacement'],
$package
);
$config = preg_replace($pattern, $replacement, $config);
file_put_contents($this->configFile, $config);
return true;
}
/**
* Injects component $package into $config after all other dependencies.
*
* If any dependencies are not registered, the method throws
* Exception\RuntimeException.
*
* @param string $package
* @param string $config
* @return true
* @throws Exception\RuntimeException
*/
private function injectAfterDependencies($package, $config)
{
foreach ($this->moduleDependencies as $dependency) {
if (! $this->isRegisteredInConfig($dependency, $config)) {
throw new Exception\RuntimeException(sprintf(
'Dependency %s is not registered in the configuration',
$dependency
));
}
}
$lastDependency = $this->findLastDependency($this->moduleDependencies, $config);
$pattern = sprintf(
$this->injectionPatterns[self::TYPE_DEPENDENCY]['pattern'],
preg_quote($lastDependency, '/')
);
$replacement = sprintf(
$this->injectionPatterns[self::TYPE_DEPENDENCY]['replacement'],
$package
);
$config = preg_replace($pattern, $replacement, $config);
file_put_contents($this->configFile, $config);
return true;
}
/**
* Find which of dependency packages is the last one on the module list.
*
* @param array $dependencies
* @param string $config
* @return string
*/
private function findLastDependency(array $dependencies, $config)
{
if (count($dependencies) === 1) {
return reset($dependencies);
}
$longLength = 0;
$last = null;
foreach ($dependencies as $dependency) {
preg_match(sprintf($this->isRegisteredPattern, preg_quote($dependency, '/')), $config, $matches);
$length = strlen($matches[0]);
if ($length > $longLength) {
$longLength = $length;
$last = $dependency;
}
}
return $last;
}
/**
* Inject module $package into $config before the first found application module
* and return true.
* If there is no any enabled application module, this method will return false.
*
* @param string $package
* @param string $config
* @param string $firstApplicationModule
* @return bool
*/
private function injectBeforeApplicationModules($package, $config, $firstApplicationModule)
{
$pattern = sprintf(
$this->injectionPatterns[self::TYPE_BEFORE_APPLICATION]['pattern'],
preg_quote($firstApplicationModule, '/')
);
$replacement = sprintf(
$this->injectionPatterns[self::TYPE_BEFORE_APPLICATION]['replacement'],
$package
);
$config = preg_replace($pattern, $replacement, $config);
file_put_contents($this->configFile, $config);
return true;
}
/**
* Find the first enabled application module from list $modules in the $config.
* If any module is not found method will return null.
*
* @param array $modules
* @param string $config
* @return string|null
*/
private function findFirstEnabledApplicationModule(array $modules, $config)
{
$shortest = strlen($config);
$first = null;
foreach ($modules as $module) {
if (! $this->isRegistered($module)) {
continue;
}
preg_match(sprintf($this->isRegisteredPattern, preg_quote($module, '/')), $config, $matches);
$length = strlen($matches[0]);
if ($length < $shortest) {
$shortest = $length;
$first = $module;
}
}
return $first;
}
/**
* {@inheritDoc}
*/
public function setApplicationModules(array $modules)
{
$this->applicationModules = $modules;
return $this;
}
/**
* {@inheritDoc}
*/
public function setModuleDependencies(array $modules)
{
$this->moduleDependencies = $modules;
return $this;
}
/**
* Removes a package from the configuration.
* Returns true if successfully removed,
* false when package is not registered.
*
* @param string $package Package name.
* @return bool
*/
public function remove($package)
{
$config = file_get_contents($this->configFile);
if (! $this->isRegisteredInConfig($package, $config)) {
return false;
}
$config = preg_replace(
sprintf($this->removalPatterns['pattern'], preg_quote($package)),
$this->removalPatterns['replacement'],
$config
);
$config = preg_replace(
$this->cleanUpPatterns['pattern'],
$this->cleanUpPatterns['replacement'],
$config
);
file_put_contents($this->configFile, $config);
return true;
}
/**
* Returns config file name of the injector.
*
* @return string
*/
public function getConfigFile()
{
return $this->configFile;
}
/**
* Is the code item registered in the configuration already?
*
* @var string $package Package name
* @var string $config
* @return bool
*/
protected function isRegisteredInConfig($package, $config)
{
return preg_match(sprintf($this->isRegisteredPattern, preg_quote($package, '/')), $config)
|| preg_match(sprintf($this->isRegisteredPattern, preg_quote(addslashes($package), '/')), $config);
}
}