Updater.php
11.7 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
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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
<?php
/**
* Joomla! Content Management System
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Updater;
defined('JPATH_PLATFORM') or die;
use Joomla\CMS\Factory;
use Joomla\CMS\Table\Table;
\JLoader::import('joomla.filesystem.file');
\JLoader::import('joomla.filesystem.folder');
\JLoader::import('joomla.filesystem.path');
\JLoader::import('joomla.base.adapter');
/**
* Updater Class
*
* @since 1.7.0
*/
class Updater extends \JAdapter
{
/**
* Development snapshots, nightly builds, pre-release versions and so on
*
* @var integer
* @since 3.4
*/
const STABILITY_DEV = 0;
/**
* Alpha versions (work in progress, things are likely to be broken)
*
* @var integer
* @since 3.4
*/
const STABILITY_ALPHA = 1;
/**
* Beta versions (major functionality in place, show-stopper bugs are likely to be present)
*
* @var integer
* @since 3.4
*/
const STABILITY_BETA = 2;
/**
* Release Candidate versions (almost stable, minor bugs might be present)
*
* @var integer
* @since 3.4
*/
const STABILITY_RC = 3;
/**
* Stable versions (production quality code)
*
* @var integer
* @since 3.4
*/
const STABILITY_STABLE = 4;
/**
* Updater instance container.
*
* @var Updater
* @since 1.7.3
*/
protected static $instance;
/**
* Constructor
*
* @param string $basepath Base Path of the adapters
* @param string $classprefix Class prefix of adapters
* @param string $adapterfolder Name of folder to append to base path
*
* @since 3.1
*/
public function __construct($basepath = __DIR__, $classprefix = '\\Joomla\\CMS\\Updater\\Adapter', $adapterfolder = 'Adapter')
{
parent::__construct($basepath, $classprefix, $adapterfolder);
}
/**
* Returns a reference to the global Installer object, only creating it
* if it doesn't already exist.
*
* @return Updater An installer object
*
* @since 1.7.0
*/
public static function getInstance()
{
if (!isset(self::$instance))
{
self::$instance = new Updater;
}
return self::$instance;
}
/**
* Finds the update for an extension. Any discovered updates are stored in the #__updates table.
*
* @param int|array $eid Extension Identifier or list of Extension Identifiers; if zero use all
* sites
* @param integer $cacheTimeout How many seconds to cache update information; if zero, force reload the
* update information
* @param integer $minimum_stability Minimum stability for the updates; 0=dev, 1=alpha, 2=beta, 3=rc,
* 4=stable
* @param boolean $includeCurrent Should I include the current version in the results?
*
* @return boolean True if there are updates
*
* @since 1.7.0
*/
public function findUpdates($eid = 0, $cacheTimeout = 0, $minimum_stability = self::STABILITY_STABLE, $includeCurrent = false)
{
$retval = false;
$results = $this->getUpdateSites($eid);
if (empty($results))
{
return $retval;
}
$now = time();
$earliestTime = $now - $cacheTimeout;
$sitesWithUpdates = array();
if ($cacheTimeout > 0)
{
$sitesWithUpdates = $this->getSitesWithUpdates($earliestTime);
}
foreach ($results as $result)
{
/**
* If we have already checked for updates within the cache timeout period we will report updates available
* only if there are update records matching this update site. Then we skip processing of the update site
* since it's already processed within the cache timeout period.
*/
if (($cacheTimeout > 0)
&& isset($result['last_check_timestamp'])
&& ($result['last_check_timestamp'] >= $earliestTime))
{
$retval = $retval || in_array($result['update_site_id'], $sitesWithUpdates);
continue;
}
// Make sure there is no update left over in the database.
$db = $this->getDbo();
$query = $db->getQuery(true)
->delete($db->quoteName('#__updates'))
->where($db->quoteName('update_site_id') . ' = ' . $db->quote($result['update_site_id']));
$db->setQuery($query);
$db->execute();
$updateObjects = $this->getUpdateObjectsForSite($result, $minimum_stability, $includeCurrent);
if (!empty($updateObjects))
{
$retval = true;
/** @var \JTableUpdate $update */
foreach ($updateObjects as $update)
{
$update->check();
$update->store();
}
}
// Finally, update the last update check timestamp
$this->updateLastCheckTimestamp($result['update_site_id']);
}
return $retval;
}
/**
* Finds an update for an extension
*
* @param integer $id Id of the extension
*
* @return mixed
*
* @since 3.6.0
*
* @deprecated 4.0 No replacement.
*/
public function update($id)
{
$updaterow = Table::getInstance('update');
$updaterow->load($id);
$update = new Update;
if ($update->loadFromXml($updaterow->detailsurl))
{
return $update->install();
}
return false;
}
/**
* Returns the update site records for an extension with ID $eid. If $eid is zero all enabled update sites records
* will be returned.
*
* @param int $eid The extension ID to fetch.
*
* @return array
*
* @since 3.6.0
*/
private function getUpdateSites($eid = 0)
{
$db = $this->getDbo();
$query = $db->getQuery(true);
$query->select('DISTINCT a.update_site_id, a.type, a.location, a.last_check_timestamp, a.extra_query')
->from($db->quoteName('#__update_sites', 'a'))
->where('a.enabled = 1');
if ($eid)
{
$query->join('INNER', '#__update_sites_extensions AS b ON a.update_site_id = b.update_site_id');
if (is_array($eid))
{
$query->where('b.extension_id IN (' . implode(',', $eid) . ')');
}
elseif ((int) $eid)
{
$query->where('b.extension_id = ' . $eid);
}
}
$db->setQuery($query);
$result = $db->loadAssocList();
if (!is_array($result))
{
return array();
}
return $result;
}
/**
* Loads the contents of an update site record $updateSite and returns the update objects
*
* @param array $updateSite The update site record to process
* @param int $minimum_stability Minimum stability for the returned update records
* @param bool $includeCurrent Should I also include the current version?
*
* @return array The update records. Empty array if no updates are found.
*
* @since 3.6.0
*/
private function getUpdateObjectsForSite($updateSite, $minimum_stability = self::STABILITY_STABLE, $includeCurrent = false)
{
$retVal = array();
$this->setAdapter($updateSite['type']);
if (!isset($this->_adapters[$updateSite['type']]))
{
// Ignore update sites requiring adapters we don't have installed
return $retVal;
}
$updateSite['minimum_stability'] = $minimum_stability;
// Get the update information from the remote update XML document
/** @var UpdateAdapter $adapter */
$adapter = $this->_adapters[ $updateSite['type']];
$update_result = $adapter->findUpdate($updateSite);
// Version comparison operator.
$operator = $includeCurrent ? 'ge' : 'gt';
if (is_array($update_result))
{
// If we have additional update sites in the remote (collection) update XML document, parse them
if (array_key_exists('update_sites', $update_result) && count($update_result['update_sites']))
{
$thisUrl = trim($updateSite['location']);
$thisId = (int) $updateSite['update_site_id'];
foreach ($update_result['update_sites'] as $extraUpdateSite)
{
$extraUrl = trim($extraUpdateSite['location']);
$extraId = (int) $extraUpdateSite['update_site_id'];
// Do not try to fetch the same update site twice
if (($thisId == $extraId) || ($thisUrl == $extraUrl))
{
continue;
}
$extraUpdates = $this->getUpdateObjectsForSite($extraUpdateSite, $minimum_stability);
if (count($extraUpdates))
{
$retVal = array_merge($retVal, $extraUpdates);
}
}
}
if (array_key_exists('updates', $update_result) && count($update_result['updates']))
{
/** @var \JTableUpdate $current_update */
foreach ($update_result['updates'] as $current_update)
{
$current_update->extra_query = $updateSite['extra_query'];
/** @var \JTableUpdate $update */
$update = Table::getInstance('update');
/** @var \JTableExtension $extension */
$extension = Table::getInstance('extension');
$uid = $update
->find(
array(
'element' => $current_update->get('element'),
'type' => $current_update->get('type'),
'client_id' => $current_update->get('client_id'),
'folder' => $current_update->get('folder'),
)
);
$eid = $extension
->find(
array(
'element' => $current_update->get('element'),
'type' => $current_update->get('type'),
'client_id' => $current_update->get('client_id'),
'folder' => $current_update->get('folder'),
)
);
if (!$uid)
{
// Set the extension id
if ($eid)
{
// We have an installed extension, check the update is actually newer
$extension->load($eid);
$data = json_decode($extension->manifest_cache, true);
if (version_compare($current_update->version, $data['version'], $operator) == 1)
{
$current_update->extension_id = $eid;
$retVal[] = $current_update;
}
}
else
{
// A potentially new extension to be installed
$retVal[] = $current_update;
}
}
else
{
$update->load($uid);
// We already have an update in the database lets check whether it has an extension_id
if ((int) $update->extension_id === 0 && $eid)
{
// The current update does not have an extension_id but we found one let's use them
$current_update->extension_id = $eid;
}
// If there is an update, check that the version is newer then replaces
if (version_compare($current_update->version, $update->version, $operator) == 1)
{
$retVal[] = $current_update;
}
}
}
}
}
return $retVal;
}
/**
* Returns the IDs of the update sites with cached updates
*
* @param int $timestamp Optional. If set, only update sites checked before $timestamp will be taken into
* account.
*
* @return array The IDs of the update sites with cached updates
*
* @since 3.6.0
*/
private function getSitesWithUpdates($timestamp = 0)
{
$db = Factory::getDbo();
$query = $db->getQuery(true)
->select('DISTINCT update_site_id')
->from('#__updates');
if ($timestamp)
{
$subQuery = $db->getQuery(true)
->select('update_site_id')
->from('#__update_sites')
->where($db->qn('last_check_timestamp') . ' IS NULL', 'OR')
->where($db->qn('last_check_timestamp') . ' <= ' . $db->q($timestamp), 'OR');
$query->where($db->qn('update_site_id') . ' IN (' . $subQuery . ')');
}
$retVal = $db->setQuery($query)->loadColumn(0);
if (empty($retVal))
{
return array();
}
return $retVal;
}
/**
* Update the last check timestamp of an update site
*
* @param int $updateSiteId The update site ID to mark as just checked
*
* @return void
*
* @since 3.6.0
*/
private function updateLastCheckTimestamp($updateSiteId)
{
$timestamp = time();
$db = Factory::getDbo();
$query = $db->getQuery(true)
->update($db->quoteName('#__update_sites'))
->set($db->quoteName('last_check_timestamp') . ' = ' . $db->quote($timestamp))
->where($db->quoteName('update_site_id') . ' = ' . $db->quote($updateSiteId));
$db->setQuery($query);
$db->execute();
}
}