/
update.php
487 lines (428 loc) · 10.4 KB
/
update.php
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
<?php
/**
* @package Joomla.Platform
* @subpackage Updater
*
* @copyright Copyright (C) 2005 - 2016 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Update class. It is used by JUpdater::update() to install an update. Use JUpdater::findUpdates() to find updates for
* an extension.
*
* @since 11.1
*/
class JUpdate extends JObject
{
/**
* Update manifest `<name>` element
*
* @var string
* @since 11.1
*/
protected $name;
/**
* Update manifest `<description>` element
*
* @var string
* @since 11.1
*/
protected $description;
/**
* Update manifest `<element>` element
*
* @var string
* @since 11.1
*/
protected $element;
/**
* Update manifest `<type>` element
*
* @var string
* @since 11.1
*/
protected $type;
/**
* Update manifest `<version>` element
*
* @var string
* @since 11.1
*/
protected $version;
/**
* Update manifest `<infourl>` element
*
* @var string
* @since 11.1
*/
protected $infourl;
/**
* Update manifest `<client>` element
*
* @var string
* @since 11.1
*/
protected $client;
/**
* Update manifest `<group>` element
*
* @var string
* @since 11.1
*/
protected $group;
/**
* Update manifest `<downloads>` element
*
* @var string
* @since 11.1
*/
protected $downloads;
/**
* Update manifest `<tags>` element
*
* @var string
* @since 11.1
*/
protected $tags;
/**
* Update manifest `<maintainer>` element
*
* @var string
* @since 11.1
*/
protected $maintainer;
/**
* Update manifest `<maintainerurl>` element
*
* @var string
* @since 11.1
*/
protected $maintainerurl;
/**
* Update manifest `<category>` element
*
* @var string
* @since 11.1
*/
protected $category;
/**
* Update manifest `<relationships>` element
*
* @var string
* @since 11.1
*/
protected $relationships;
/**
* Update manifest `<targetplatform>` element
*
* @var string
* @since 11.1
*/
protected $targetplatform;
/**
* Extra query for download URLs
*
* @var string
* @since 13.1
*/
protected $extra_query;
/**
* Resource handle for the XML Parser
*
* @var resource
* @since 12.1
*/
protected $xmlParser;
/**
* Element call stack
*
* @var array
* @since 12.1
*/
protected $stack = array('base');
/**
* Unused state array
*
* @var array
* @since 12.1
*/
protected $stateStore = array();
/**
* Object containing the current update data
*
* @var stdClass
* @since 12.1
*/
protected $currentUpdate;
/**
* Object containing the latest update data
*
* @var stdClass
* @since 12.1
*/
protected $latest;
/**
* The minimum stability required for updates to be taken into account. The possible values are:
* 0 dev Development snapshots, nightly builds, pre-release versions and so on
* 1 alpha Alpha versions (work in progress, things are likely to be broken)
* 2 beta Beta versions (major functionality in place, show-stopper bugs are likely to be present)
* 3 rc Release Candidate versions (almost stable, minor bugs might be present)
* 4 stable Stable versions (production quality code)
*
* @var int
* @since 14.1
*
* @see JUpdater
*/
protected $minimum_stability = JUpdater::STABILITY_STABLE;
/**
* Gets the reference to the current direct parent
*
* @return object
*
* @since 11.1
*/
protected function _getStackLocation()
{
return implode('->', $this->stack);
}
/**
* Get the last position in stack count
*
* @return string
*
* @since 11.1
*/
protected function _getLastTag()
{
return $this->stack[count($this->stack) - 1];
}
/**
* XML Start Element callback
*
* @param object $parser Parser object
* @param string $name Name of the tag found
* @param array $attrs Attributes of the tag
*
* @return void
*
* @note This is public because it is called externally
* @since 11.1
*/
public function _startElement($parser, $name, $attrs = array())
{
array_push($this->stack, $name);
$tag = $this->_getStackLocation();
// Reset the data
if (isset($this->$tag))
{
$this->$tag->_data = "";
}
switch ($name)
{
// This is a new update; create a current update
case 'UPDATE':
$this->currentUpdate = new stdClass;
break;
// Don't do anything
case 'UPDATES':
break;
// For everything else there's...the default!
default:
$name = strtolower($name);
if (!isset($this->currentUpdate->$name))
{
$this->currentUpdate->$name = new stdClass;
}
$this->currentUpdate->$name->_data = '';
foreach ($attrs as $key => $data)
{
$key = strtolower($key);
$this->currentUpdate->$name->$key = $data;
}
break;
}
}
/**
* Callback for closing the element
*
* @param object $parser Parser object
* @param string $name Name of element that was closed
*
* @return void
*
* @note This is public because it is called externally
* @since 11.1
*/
public function _endElement($parser, $name)
{
array_pop($this->stack);
switch ($name)
{
// Closing update, find the latest version and check
case 'UPDATE':
$product = strtolower(JFilterInput::getInstance()->clean(JVersion::PRODUCT, 'cmd'));
// Support for the min_dev_level and max_dev_level attributes is deprecated, a regexp should be used instead
if (isset($this->currentUpdate->targetplatform->min_dev_level) || isset($this->currentUpdate->targetplatform->max_dev_level))
{
JLog::add(
'Support for the min_dev_level and max_dev_level attributes of an update\'s <targetplatform> tag is deprecated and'
. ' will be removed in 4.0. The full version should be specified in the version attribute and may optionally be a regexp.',
JLog::WARNING,
'deprecated'
);
}
/*
* Check that the product matches and that the version matches (optionally a regexp)
*
* Check for optional min_dev_level and max_dev_level attributes to further specify targetplatform (e.g., 3.0.1)
*/
if (isset($this->currentUpdate->targetplatform->name)
&& $product == $this->currentUpdate->targetplatform->name
&& preg_match('/^' . $this->currentUpdate->targetplatform->version . '/', JVERSION)
&& ((!isset($this->currentUpdate->targetplatform->min_dev_level)) || JVersion::DEV_LEVEL >= $this->currentUpdate->targetplatform->min_dev_level)
&& ((!isset($this->currentUpdate->targetplatform->max_dev_level)) || JVersion::DEV_LEVEL <= $this->currentUpdate->targetplatform->max_dev_level))
{
// Check if PHP version supported via <php_minimum> tag, assume true if tag isn't present
if (!isset($this->currentUpdate->php_minimum) || version_compare(PHP_VERSION, $this->currentUpdate->php_minimum->_data, '>='))
{
$phpMatch = true;
}
else
{
$phpMatch = false;
}
// Check minimum stability
$stabilityMatch = true;
if (isset($this->currentUpdate->stability) && ($this->currentUpdate->stability < $this->minimum_stability))
{
$stabilityMatch = false;
}
if ($phpMatch && $stabilityMatch)
{
if (isset($this->latest))
{
if (version_compare($this->currentUpdate->version->_data, $this->latest->version->_data, '>') == 1)
{
$this->latest = $this->currentUpdate;
}
}
else
{
$this->latest = $this->currentUpdate;
}
}
}
break;
case 'UPDATES':
// If the latest item is set then we transfer it to where we want to
if (isset($this->latest))
{
foreach (get_object_vars($this->latest) as $key => $val)
{
$this->$key = $val;
}
unset($this->latest);
unset($this->currentUpdate);
}
elseif (isset($this->currentUpdate))
{
// The update might be for an older version of j!
unset($this->currentUpdate);
}
break;
}
}
/**
* Character Parser Function
*
* @param object $parser Parser object.
* @param object $data The data.
*
* @return void
*
* @note This is public because its called externally.
* @since 11.1
*/
public function _characterData($parser, $data)
{
$tag = $this->_getLastTag();
// Throw the data for this item together
$tag = strtolower($tag);
if ($tag == 'tag')
{
$this->currentUpdate->stability = $this->stabilityTagToInteger((string) $data);
return;
}
if (isset($this->currentUpdate->$tag))
{
$this->currentUpdate->$tag->_data .= $data;
}
}
/**
* Loads an XML file from a URL.
*
* @param string $url The URL.
* @param int $minimum_stability The minimum stability required for updating the extension {@see JUpdater}
*
* @return boolean True on success
*
* @since 11.1
*/
public function loadFromXml($url, $minimum_stability = JUpdater::STABILITY_STABLE)
{
$http = JHttpFactory::getHttp();
try
{
$response = $http->get($url);
}
catch (RuntimeException $e)
{
$response = null;
}
if ($response === null || $response->code !== 200)
{
// TODO: Add a 'mark bad' setting here somehow
JLog::add(JText::sprintf('JLIB_UPDATER_ERROR_EXTENSION_OPEN_URL', $url), JLog::WARNING, 'jerror');
return false;
}
$this->minimum_stability = $minimum_stability;
$this->xmlParser = xml_parser_create('');
xml_set_object($this->xmlParser, $this);
xml_set_element_handler($this->xmlParser, '_startElement', '_endElement');
xml_set_character_data_handler($this->xmlParser, '_characterData');
if (!xml_parse($this->xmlParser, $response->body))
{
JLog::add(
sprintf(
"XML error: %s at line %d", xml_error_string(xml_get_error_code($this->xmlParser)),
xml_get_current_line_number($this->xmlParser)
),
JLog::WARNING, 'updater'
);
return false;
}
xml_parser_free($this->xmlParser);
return true;
}
/**
* Converts a tag to numeric stability representation. If the tag doesn't represent a known stability level (one of
* dev, alpha, beta, rc, stable) it is ignored.
*
* @param string $tag The tag string, e.g. dev, alpha, beta, rc, stable
*
* @return integer
*
* @since 3.4
*/
protected function stabilityTagToInteger($tag)
{
$constant = 'JUpdater::STABILITY_' . strtoupper($tag);
if (defined($constant))
{
return constant($constant);
}
return JUpdater::STABILITY_STABLE;
}
}