1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
use Composer\Package\Version\VersionParser; |
4
|
|
|
use Guzzle\Http\Exception\ClientErrorResponseException; |
5
|
|
|
use Packagist\Api\Result\Package; |
6
|
|
|
use Packagist\Api\Result\Package\Version; |
7
|
|
|
use SilverStripe\Elastica\ElasticaService; |
8
|
|
|
|
9
|
|
|
/** |
10
|
|
|
* Updates all add-ons from Packagist. |
11
|
|
|
*/ |
12
|
|
|
class AddonUpdater |
13
|
|
|
{ |
14
|
|
|
|
15
|
|
|
/** |
16
|
|
|
* @var PackagistService |
17
|
|
|
*/ |
18
|
|
|
private $packagist; |
19
|
|
|
|
20
|
|
|
/** |
21
|
|
|
* @var SilverStripe\Elastica\ElasticaService |
22
|
|
|
*/ |
23
|
|
|
private $elastica; |
24
|
|
|
|
25
|
|
|
/** |
26
|
|
|
* @var SilverStripeVersion[] |
27
|
|
|
*/ |
28
|
|
|
private $silverstripes; |
29
|
|
|
|
30
|
|
|
public function __construct( |
31
|
|
|
PackagistService $packagist, |
32
|
|
|
ElasticaService $elastica |
33
|
|
|
) { |
34
|
|
|
$this->packagist = $packagist; |
35
|
|
|
$this->elastica = $elastica; |
36
|
|
|
|
37
|
|
|
$this->setSilverStripeVersions(SilverStripeVersion::get()); |
38
|
|
|
} |
39
|
|
|
|
40
|
|
|
/** |
41
|
|
|
* Updates all add-ons. |
42
|
|
|
* |
43
|
|
|
* @param boolean Clear existing addons before updating them. |
44
|
|
|
* Will also clear their search index, and cascade the delete for associated data. |
45
|
|
|
* @param array Limit to specific addons, using their name incl. vendor prefix. |
46
|
|
|
*/ |
47
|
|
|
public function update($clear = false, $limitAddons = null) |
48
|
|
|
{ |
49
|
|
|
if ($clear && !$limitAddons) { |
50
|
|
|
Addon::get()->removeAll(); |
51
|
|
|
AddonAuthor::get()->removeAll(); |
52
|
|
|
AddonKeyword::get()->removeAll(); |
53
|
|
|
AddonLink::get()->removeAll(); |
54
|
|
|
AddonVendor::get()->removeAll(); |
55
|
|
|
AddonVersion::get()->removeAll(); |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
// This call to packagist can be expensive. Requests are served from a cache if usePackagistCache() returns true |
59
|
|
|
$cache = SS_Cache::factory('addons'); |
60
|
|
|
|
61
|
|
|
if ($this->usePackagistCache() && $packages = $cache->load('packagist')) { |
62
|
|
|
$packages = unserialize($packages); |
63
|
|
|
} else { |
64
|
|
|
$packages = $this->packagist->getPackages(); |
65
|
|
|
$cache->save(serialize($packages), 'packagist'); |
66
|
|
|
} |
67
|
|
|
|
68
|
|
|
// TODO: AWS elasticsearch doesn't have this setting enabled |
69
|
|
|
// https://www.elastic.co/guide/en/elasticsearch/reference/5.2/url-access-control.html |
70
|
|
|
// and bulk index operations by elastica currently require it |
71
|
|
|
// Switching to https://github.com/heyday/silverstripe-elastica and SS4 might help |
72
|
|
|
|
73
|
|
|
// $this->elastica->startBulkIndex(); |
74
|
|
|
|
75
|
|
|
foreach ($packages as $package) { |
76
|
|
|
/** @var Packagist\Api\Result\Package $package */ |
77
|
|
|
|
78
|
|
|
$isAbandoned = (method_exists($package, 'isAbandoned') && $package->isAbandoned()); |
|
|
|
|
79
|
|
|
$name = $package->getName(); |
80
|
|
|
$versions = $package->getVersions(); |
81
|
|
|
|
82
|
|
|
if ($limitAddons && !in_array($name, $limitAddons)) { |
83
|
|
|
continue; |
84
|
|
|
} |
85
|
|
|
|
86
|
|
|
$addon = Addon::get()->filter('Name', $name)->first(); |
87
|
|
|
|
88
|
|
|
if (!$addon) { |
89
|
|
|
$addon = new Addon(); |
90
|
|
|
$addon->Name = $name; |
|
|
|
|
91
|
|
|
$addon->write(); |
92
|
|
|
} |
93
|
|
|
|
94
|
|
|
usort($versions, function ($a, $b) { |
95
|
|
|
return version_compare($a->getVersionNormalized(), $b->getVersionNormalized()); |
96
|
|
|
}); |
97
|
|
|
|
98
|
|
|
$this->updateAddon($addon, $package, $versions); |
|
|
|
|
99
|
|
|
} |
100
|
|
|
|
101
|
|
|
// $this->elastica->endBulkIndex(); |
102
|
|
|
} |
103
|
|
|
|
104
|
|
|
|
105
|
|
|
|
106
|
|
|
/** |
107
|
|
|
* Check whether or not we should contact packagist or use a cached version. This allows to speed up the task |
108
|
|
|
* during development. |
109
|
|
|
* |
110
|
|
|
* @return bool |
111
|
|
|
*/ |
112
|
|
|
protected function usePackagistCache() |
113
|
|
|
{ |
114
|
|
|
return Director::isDev(); |
115
|
|
|
} |
116
|
|
|
|
117
|
|
|
private function updateAddon(Addon $addon, Package $package, array $versions) |
118
|
|
|
{ |
119
|
|
|
echo "Updating addon {$addon->Name}:\n"; |
|
|
|
|
120
|
|
|
|
121
|
|
|
if (!$addon->VendorID) { |
|
|
|
|
122
|
|
|
$vendor = AddonVendor::get()->filter('Name', $addon->VendorName())->first(); |
123
|
|
|
|
124
|
|
|
if (!$vendor) { |
125
|
|
|
$vendor = new AddonVendor(); |
126
|
|
|
$vendor->Name = $addon->VendorName(); |
|
|
|
|
127
|
|
|
$vendor->write(); |
128
|
|
|
} |
129
|
|
|
|
130
|
|
|
echo " - Set vendor name to {$vendor->Name}\n"; |
131
|
|
|
|
132
|
|
|
$addon->VendorID = $vendor->ID; |
|
|
|
|
133
|
|
|
} |
134
|
|
|
|
135
|
|
|
$addon->Type = preg_replace('/^silverstripe-(vendor)?/', '', $package->getType()); |
|
|
|
|
136
|
|
|
$addon->Abandoned = $package->isAbandoned(); |
|
|
|
|
137
|
|
|
$addon->Description = $package->getDescription(); |
|
|
|
|
138
|
|
|
$addon->Released = strtotime($package->getTime()); |
|
|
|
|
139
|
|
|
$addon->Repository = $package->getRepository(); |
|
|
|
|
140
|
|
|
$addon->Downloads = $package->getDownloads()->getTotal(); |
|
|
|
|
141
|
|
|
$addon->DownloadsMonthly = $package->getDownloads()->getMonthly(); |
|
|
|
|
142
|
|
|
$addon->Favers = $package->getFavers(); |
|
|
|
|
143
|
|
|
|
144
|
|
|
foreach ($versions as $version) { |
145
|
|
|
$this->updateVersion($addon, $version); |
146
|
|
|
} |
147
|
|
|
|
148
|
|
|
// If there is no build, then queue one up if the add-on requires |
149
|
|
|
// one. |
150
|
|
|
if (!$addon->BuildQueued) { |
|
|
|
|
151
|
|
|
echo " - Will queue a rebuild\n"; |
152
|
|
|
if (!$addon->BuiltAt) { |
|
|
|
|
153
|
|
|
$buildJob = new BuildAddonJob(['package' => $addon->ID]); |
154
|
|
|
singleton('QueuedJobService')->queueJob($buildJob); |
155
|
|
|
echo " - Queued {$addon->Name} for build\n"; |
|
|
|
|
156
|
|
|
$addon->BuildQueued = true; |
|
|
|
|
157
|
|
|
} else { |
158
|
|
|
$built = (int) $addon->obj('BuiltAt')->format('U'); |
159
|
|
|
|
160
|
|
|
foreach ($versions as $version) { |
161
|
|
|
if (strtotime($version->getTime()) > $built) { |
162
|
|
|
$buildJob = new BuildAddonJob(['package' => $addon->ID]); |
163
|
|
|
singleton('QueuedJobService')->queueJob($buildJob); |
164
|
|
|
echo " - Queued {$addon->Name} version {$version->Name} for build\n"; |
|
|
|
|
165
|
|
|
$addon->BuildQueued = true; |
|
|
|
|
166
|
|
|
|
167
|
|
|
break; |
168
|
|
|
} |
169
|
|
|
} |
170
|
|
|
} |
171
|
|
|
} else { |
172
|
|
|
echo " - Will not queue a rebuild\n"; |
173
|
|
|
} |
174
|
|
|
|
175
|
|
|
$addon->LastUpdated = time(); |
|
|
|
|
176
|
|
|
$addon->write(); |
177
|
|
|
} |
178
|
|
|
|
179
|
|
|
private function updateVersion(Addon $addon, Version $package) |
180
|
|
|
{ |
181
|
|
|
$version = null; |
182
|
|
|
|
183
|
|
|
if ($addon->isInDB()) { |
184
|
|
|
$version = $addon->Versions()->filter('Version', $package->getVersionNormalized())->first(); |
|
|
|
|
185
|
|
|
} |
186
|
|
|
|
187
|
|
|
if (!$version) { |
188
|
|
|
$version = new AddonVersion(); |
189
|
|
|
} |
190
|
|
|
|
191
|
|
|
$version->Name = $package->getName(); |
192
|
|
|
$version->Type = preg_replace('/^silverstripe-(vendor)?/', '', $package->getType()); |
193
|
|
|
$version->Description = $package->getDescription(); |
194
|
|
|
$version->Released = strtotime($package->getTime()); |
195
|
|
|
$keywords = $package->getKeywords(); |
196
|
|
|
|
197
|
|
|
if ($keywords) { |
198
|
|
|
foreach ($keywords as $keyword) { |
|
|
|
|
199
|
|
|
$keyword = AddonKeyword::get_by_name($keyword); |
200
|
|
|
|
201
|
|
|
$addon->Keywords()->add($keyword); |
|
|
|
|
202
|
|
|
$version->Keywords()->add($keyword); |
203
|
|
|
} |
204
|
|
|
} |
205
|
|
|
|
206
|
|
|
$version->Version = $package->getVersionNormalized(); |
207
|
|
|
$version->PrettyVersion = $package->getVersion(); |
208
|
|
|
|
209
|
|
|
$stability = VersionParser::parseStability($package->getVersion()); |
210
|
|
|
$isDev = $stability === 'dev'; |
211
|
|
|
$version->Development = $isDev; |
212
|
|
|
|
213
|
|
|
$version->SourceType = $package->getSource()->getType(); |
214
|
|
|
$version->SourceUrl = $package->getSource()->getUrl(); |
215
|
|
|
$version->SourceReference = $package->getSource()->getReference(); |
216
|
|
|
|
217
|
|
|
if ($package->getDist()) { |
218
|
|
|
$version->DistType = $package->getDist()->getType(); |
219
|
|
|
$version->DistUrl = $package->getDist()->getUrl(); |
220
|
|
|
$version->DistReference = $package->getDist()->getReference(); |
221
|
|
|
$version->DistChecksum = $package->getDist()->getShasum(); |
222
|
|
|
} |
223
|
|
|
|
224
|
|
|
$version->Extra = $package->getExtra(); |
225
|
|
|
$version->Homepage = $package->getHomepage(); |
226
|
|
|
$version->License = $package->getLicense(); |
227
|
|
|
// $version->Support = $package->getSupport(); |
228
|
|
|
|
229
|
|
|
echo " - Processed version {$version->Version}\n"; |
230
|
|
|
|
231
|
|
|
$addon->Versions()->add($version); |
|
|
|
|
232
|
|
|
|
233
|
|
|
$this->updateLinks($version, $package); |
234
|
|
|
$this->updateCompatibility($addon, $version, $package); |
235
|
|
|
$this->updateAuthors($version, $package); |
236
|
|
|
} |
237
|
|
|
|
238
|
|
|
private function updateLinks(AddonVersion $version, Version $package) |
239
|
|
|
{ |
240
|
|
|
$getLink = function ($name, $type) use ($version) { |
241
|
|
|
$link = null; |
242
|
|
|
|
243
|
|
|
if ($version->isInDB()) { |
244
|
|
|
$link = $version->Links()->filter('Name', $name)->filter('Type', $type)->first(); |
|
|
|
|
245
|
|
|
} |
246
|
|
|
|
247
|
|
|
if (!$link) { |
248
|
|
|
$link = new AddonLink(); |
249
|
|
|
$link->Name = $name; |
|
|
|
|
250
|
|
|
$link->Type = $type; |
|
|
|
|
251
|
|
|
} |
252
|
|
|
|
253
|
|
|
return $link; |
254
|
|
|
}; |
255
|
|
|
|
256
|
|
|
$types = array( |
257
|
|
|
'require' => 'getRequire', |
258
|
|
|
'require-dev' => 'getRequireDev', |
259
|
|
|
'provide' => 'getProvide', |
260
|
|
|
'conflict' => 'getConflict', |
261
|
|
|
'replace' => 'getReplace' |
262
|
|
|
); |
263
|
|
|
|
264
|
|
|
foreach ($types as $type => $method) { |
265
|
|
|
if ($linked = $package->$method()) { |
266
|
|
|
foreach ($linked as $link => $constraint) { |
267
|
|
|
$name = $link; |
268
|
|
|
$addon = Addon::get()->filter('Name', $name)->first(); |
269
|
|
|
|
270
|
|
|
$local = $getLink($name, $type); |
271
|
|
|
$local->Constraint = $constraint; |
272
|
|
|
|
273
|
|
|
if ($addon) { |
274
|
|
|
$local->TargetID = $addon->ID; |
275
|
|
|
} |
276
|
|
|
|
277
|
|
|
$version->Links()->add($local); |
|
|
|
|
278
|
|
|
} |
279
|
|
|
} |
280
|
|
|
} |
281
|
|
|
|
282
|
|
|
//to-do api have no method to get this. |
283
|
|
|
/*$suggested = $package->getSuggests(); |
284
|
|
|
|
285
|
|
|
if ($suggested) foreach ($suggested as $package => $description) { |
286
|
|
|
$link = $getLink($package, 'suggest'); |
287
|
|
|
$link->Description = $description; |
288
|
|
|
|
289
|
|
|
$version->Links()->add($link); |
290
|
|
|
}*/ |
291
|
|
|
} |
292
|
|
|
|
293
|
|
|
private function updateCompatibility(Addon $addon, AddonVersion $version, Version $package) |
294
|
|
|
{ |
295
|
|
|
$require = null; |
296
|
|
|
|
297
|
|
|
if ($package->getRequire()) { |
298
|
|
|
foreach ($package->getRequire() as $name => $link) { |
299
|
|
|
if ((string)$link == 'self.version') { |
300
|
|
|
continue; |
301
|
|
|
} |
302
|
|
|
|
303
|
|
|
if ($name == 'silverstripe/framework') { |
304
|
|
|
$require = $link; |
305
|
|
|
break; |
306
|
|
|
} |
307
|
|
|
|
308
|
|
|
if ($name == 'silverstripe/cms') { |
309
|
|
|
$require = $link; |
310
|
|
|
} |
311
|
|
|
} |
312
|
|
|
} |
313
|
|
|
|
314
|
|
|
if (!$require) { |
315
|
|
|
return; |
316
|
|
|
} |
317
|
|
|
|
318
|
|
|
// >= interpreted as ^, see https://github.com/silverstripe/addons.silverstripe.org/issues/160 |
319
|
|
|
$require = preg_replace('/^>=/', '^', $require); |
320
|
|
|
|
321
|
|
|
$addon->CompatibleVersions()->removeAll(); |
|
|
|
|
322
|
|
|
$version->CompatibleVersions()->removeAll(); |
|
|
|
|
323
|
|
|
|
324
|
|
|
foreach ($this->getSilverStripeVersions() as $silverStripeVersion) { |
325
|
|
|
/** @var SilverStripeVersion $silverStripeVersion */ |
326
|
|
|
try { |
327
|
|
|
if ($silverStripeVersion->getConstraintValidity($require)) { |
328
|
|
|
$addon->CompatibleVersions()->add($silverStripeVersion); |
|
|
|
|
329
|
|
|
$version->CompatibleVersions()->add($silverStripeVersion); |
|
|
|
|
330
|
|
|
} |
331
|
|
|
} catch (Exception $e) { |
332
|
|
|
// An exception here shouldn't prevent further updates. |
333
|
|
|
Debug::log($addon->Name . "\t" . $addon->ID . "\t" . $e->getMessage()); |
|
|
|
|
334
|
|
|
} |
335
|
|
|
} |
336
|
|
|
} |
337
|
|
|
|
338
|
|
|
private function updateAuthors(AddonVersion $version, Version $package) |
339
|
|
|
{ |
340
|
|
|
if ($package->getAuthors()) { |
341
|
|
|
foreach ($package->getAuthors() as $details) { |
342
|
|
|
$author = null; |
343
|
|
|
|
344
|
|
|
if (!$details->getName() && !$details->getEmail()) { |
345
|
|
|
continue; |
346
|
|
|
} |
347
|
|
|
|
348
|
|
|
if ($details->getEmail()) { |
349
|
|
|
$author = AddonAuthor::get()->filter('Email', $details->getEmail())->first(); |
350
|
|
|
} |
351
|
|
|
|
352
|
|
|
if (!$author && $details->getHomepage()) { |
353
|
|
|
$author = AddonAuthor::get() |
354
|
|
|
->filter('Name', $details->getName()) |
355
|
|
|
->filter('Homepage', $details->getHomepage()) |
356
|
|
|
->first(); |
357
|
|
|
} |
358
|
|
|
|
359
|
|
|
if (!$author && $details->getName()) { |
360
|
|
|
$author = AddonAuthor::get() |
361
|
|
|
->filter('Name', $details->getName()) |
362
|
|
|
->filter('Versions.Addon.Name', $package->getName()) |
363
|
|
|
->first(); |
364
|
|
|
} |
365
|
|
|
|
366
|
|
|
if (!$author) { |
367
|
|
|
$author = new AddonAuthor(); |
368
|
|
|
} |
369
|
|
|
|
370
|
|
|
if ($details->getName()) { |
371
|
|
|
$author->Name = $details->getName(); |
372
|
|
|
} |
373
|
|
|
if ($details->getEmail()) { |
374
|
|
|
$author->Email = $details->getEmail(); |
375
|
|
|
} |
376
|
|
|
if ($details->getHomepage()) { |
377
|
|
|
$author->Homepage = $details->getHomepage(); |
378
|
|
|
} |
379
|
|
|
|
380
|
|
|
//to-do not supported by API |
381
|
|
|
//if(isset($details['role'])) $author->Role = $details['role']; |
382
|
|
|
|
383
|
|
|
$version->Authors()->add($author->write()); |
|
|
|
|
384
|
|
|
} |
385
|
|
|
} |
386
|
|
|
} |
387
|
|
|
|
388
|
|
|
/** |
389
|
|
|
* Get the list of SilverStripe versions |
390
|
|
|
* |
391
|
|
|
* @return DataList |
392
|
|
|
*/ |
393
|
|
|
public function getSilverStripeVersions() |
394
|
|
|
{ |
395
|
|
|
return $this->silverstripes; |
396
|
|
|
} |
397
|
|
|
|
398
|
|
|
/** |
399
|
|
|
* Set the list of SilverStripeVersions |
400
|
|
|
* |
401
|
|
|
* @param DataList $versions |
402
|
|
|
* @return $this |
403
|
|
|
*/ |
404
|
|
|
public function setSilverStripeVersions(DataList $versions) |
405
|
|
|
{ |
406
|
|
|
$this->silverstripes = $versions; |
|
|
|
|
407
|
|
|
return $this; |
408
|
|
|
} |
409
|
|
|
} |
410
|
|
|
|
This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.
Both the
$myVar
assignment in line 1 and the$higher
assignment in line 2 are dead. The first because$myVar
is never used and the second because$higher
is always overwritten for every possible time line.