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