Target.php
6.46 KB
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
<?php
namespace Drupal\drupalmoduleupgrader;
use Doctrine\Common\Collections\ArrayCollection;
use Drupal\Component\Utility\SafeMarkup;
use Pharborist\Node;
use Pharborist\Parser;
use Pharborist\RootNode;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Finder\Finder;
/**
* Default implementation of TargetInterface.
*/
class Target implements TargetInterface {
/**
* The target module's machine name.
*
* @var string
*/
protected $id;
/**
* @var \Drupal\Component\Plugin\PluginManagerInterface
*/
protected $indexerManager;
/**
* The target module's base path.
*
* @var string
*/
protected $basePath;
/**
* @var IndexerInterface[]
*/
protected $indexers = [];
/**
* @var \Doctrine\Common\Collections\ArrayCollection
*/
protected $services;
/**
* All open documents.
*
* @var \Pharborist\RootNode[]
*/
protected $documents = [];
/**
* Constructs a Target.
*
* @param string $path
* The base path of the target module.
* @param ContainerInterface $container
* The current container, to pull any dependencies out of.
*/
public function __construct($path, ContainerInterface $container) {
$this->indexerManager = $container->get('plugin.manager.drupalmoduleupgrader.indexer');
if (is_dir($path)) {
$this->basePath = $path;
}
else {
throw new \RuntimeException(SafeMarkup::format('Invalid base path: @path', ['@path' => $path]));
}
}
/**
* {@inheritdoc}
*/
public function id() {
if (empty($this->id)) {
$dir = $this->getBasePath();
$info = (new Finder)->in($dir)->depth('== 0')->name('*.info')->getIterator();
$info->rewind();
if ($info_file = $info->current()) {
$this->id = subStr($info_file->getFilename(), 0, -5);
}
else {
throw new \RuntimeException(SafeMarkup::format('Could not find info file in @dir', ['@dir' => $dir]));
}
}
return $this->id;
}
/**
* {@inheritdoc}
*/
public function getBasePath() {
return $this->basePath;
}
/**
* {@inheritdoc}
*/
public function getPath($file) {
if ($file{0} == '.') {
$file = $this->id() . $file;
}
return $this->getBasePath() . '/' . ltrim($file, '/');
}
/**
* {@inheritdoc}
*/
public function getFinder() {
// We do NOT want to include submodules. We can detect one by the presence
// of an info file -- if there is one, its directory is a submodule.
$directories = (new Finder)
->directories()
->in($this->getBasePath())
->filter(function(\SplFileInfo $dir) {
return (new Finder)->files()->in($dir->getPathname())->depth('== 0')->name('*.info')->count() === 0;
});
$directories = array_keys(iterator_to_array($directories));
$directories[] = $this->getBasePath();
return (new Finder)
->files()
->in($directories)
// We don't need to recurse, because we've already determined which
// directories to search.
->depth('== 0')
->name('*.module')
->name('*.install')
->name('*.inc')
->name('*.php')
->name('*.test');
}
/**
* {@inheritdoc}
*/
public function getIndexer($which) {
if (empty($this->indexers[$which])) {
/** @var IndexerInterface $indexer */
$indexer = $this->indexerManager->createInstance($which);
$indexer->bind($this);
$this->indexers[$which] = $indexer;
}
return $this->indexers[$which];
}
/**
* {@inheritdoc}
*/
public function getServices() {
if (empty($this->services)) {
$this->services = new ArrayCollection();
}
return $this->services;
}
/**
* Runs all available indexers on this target.
*/
public function buildIndex() {
$indexers = array_keys($this->indexerManager->getDefinitions());
foreach ($indexers as $id) {
$this->getIndexer($id)->build();
}
// Release syntax trees that were opened during indexing.
$this->flush();
}
/**
* Destroys all index data for this target.
*/
public function destroyIndex() {
$indexers = array_keys($this->indexerManager->getDefinitions());
foreach ($indexers as $id) {
$this->getIndexer($id)->destroy();
}
}
/**
* {@inheritdoc}
*/
public function implementsHook($hook) {
return $this->getIndexer('function')->has('hook_' . $hook);
}
/**
* {@inheritdoc}
*/
public function executeHook($hook, array $arguments = []) {
if ($this->implementsHook($hook)) {
return $this->getIndexer('function')->execute('hook_' . $hook, $arguments);
}
else {
$variables = [
'@module' => $this->id(),
'@hook' => $hook,
];
throw new \InvalidArgumentException(SafeMarkup::format('@module does not implement hook_@hook.', $variables));
}
}
/**
* {@inheritdoc}
*/
public function open($file) {
if (empty($this->documents[$file])) {
$this->documents[$file] = Parser::parseFile($file);
}
return $this->documents[$file];
}
/**
* {@inheritdoc}
*/
public function save(Node $node = NULL) {
if ($node) {
$file = $this->getFileOf($node);
if ($file) {
$doc = $node instanceof RootNode ? $node : $node->parents()->get(0);
$victory = file_put_contents($file, $doc->getText());
if ($victory === FALSE) {
throw new IOException(SafeMarkup::format('Failed to save @file.', [ '@file' => $file ]));
}
}
else {
throw new IOException('Cannot save a node that is not attached to an open document.');
}
}
else {
array_walk($this->documents, [ $this, 'save' ]);
}
}
/**
* {@inheritdoc}
*/
public function create($file, $ns = NULL) {
$this->documents[$file] = RootNode::create($ns);
return $this->documents[$file];
}
/**
* {@inheritdoc}
*/
public function flush() {
$this->documents = [];
}
/**
* Determines which currently-open file a node belongs to, if any. Nodes
* which are not part of any open syntax tree will return NULL.
*
* @return string|NULL
*/
public function getFileOf(Node $node) {
if ($node instanceof RootNode) {
$root = $node;
}
else {
$parents = $node->parents();
if ($parents->isEmpty()) {
return NULL;
}
$root = $parents->get(0);
}
foreach ($this->documents as $file => $doc) {
if ($root === $doc) {
return $file;
}
}
}
}