UpdateAdapter.php
7.3 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
<?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\Http\HttpFactory;
use Joomla\CMS\Log\Log;
use Joomla\CMS\Version;
use Joomla\Registry\Registry;
\JLoader::import('joomla.base.adapterinstance');
/**
* UpdateAdapter class.
*
* @since 1.7.0
*/
abstract class UpdateAdapter extends \JAdapterInstance
{
/**
* Resource handle for the XML Parser
*
* @var resource
* @since 3.0.0
*/
protected $xmlParser;
/**
* Element call stack
*
* @var array
* @since 3.0.0
*/
protected $stack = array('base');
/**
* ID of update site
*
* @var string
* @since 3.0.0
*/
protected $updateSiteId = 0;
/**
* Columns in the extensions table to be updated
*
* @var array
* @since 3.0.0
*/
protected $updatecols = array('NAME', 'ELEMENT', 'TYPE', 'FOLDER', 'CLIENT', 'VERSION', 'DESCRIPTION', 'INFOURL', 'EXTRA_QUERY');
/**
* Should we try appending a .xml extension to the update site's URL?
*
* @var bool
*/
protected $appendExtension = false;
/**
* The name of the update site (used in logging)
*
* @var string
*/
protected $updateSiteName = '';
/**
* The update site URL from which we will get the update information
*
* @var string
*/
protected $_url = '';
/**
* 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 Updater
*/
protected $minimum_stability = Updater::STABILITY_STABLE;
/**
* Gets the reference to the current direct parent
*
* @return object
*
* @since 1.7.0
*/
protected function _getStackLocation()
{
return implode('->', $this->stack);
}
/**
* Gets the reference to the last tag
*
* @return object
*
* @since 1.7.0
*/
protected function _getLastTag()
{
return $this->stack[count($this->stack) - 1];
}
/**
* Finds an update
*
* @param array $options Options to use: update_site_id: the unique ID of the update site to look at
*
* @return array Update_sites and updates discovered
*
* @since 1.7.0
*/
abstract public function findUpdate($options);
/**
* Toggles the enabled status of an update site. Update sites are disabled before getting the update information
* from their URL and enabled afterwards. If the URL fetch fails with a PHP fatal error (e.g. timeout) the faulty
* update site will remain disabled the next time we attempt to load the update information.
*
* @param int $update_site_id The numeric ID of the update site to enable/disable
* @param bool $enabled Enable the site when true, disable it when false
*
* @return void
*/
protected function toggleUpdateSite($update_site_id, $enabled = true)
{
$update_site_id = (int) $update_site_id;
$enabled = (bool) $enabled;
if (empty($update_site_id))
{
return;
}
$db = $this->parent->getDbo();
$query = $db->getQuery(true)
->update($db->qn('#__update_sites'))
->set($db->qn('enabled') . ' = ' . $db->q($enabled ? 1 : 0))
->where($db->qn('update_site_id') . ' = ' . $db->q($update_site_id));
$db->setQuery($query);
try
{
$db->execute();
}
catch (\RuntimeException $e)
{
// Do nothing
}
}
/**
* Get the name of an update site. This is used in logging.
*
* @param int $updateSiteId The numeric ID of the update site
*
* @return string The name of the update site or an empty string if it's not found
*/
protected function getUpdateSiteName($updateSiteId)
{
$updateSiteId = (int) $updateSiteId;
if (empty($updateSiteId))
{
return '';
}
$db = $this->parent->getDbo();
$query = $db->getQuery(true)
->select($db->qn('name'))
->from($db->qn('#__update_sites'))
->where($db->qn('update_site_id') . ' = ' . $db->q($updateSiteId));
$db->setQuery($query);
$name = '';
try
{
$name = $db->loadResult();
}
catch (\RuntimeException $e)
{
// Do nothing
}
return $name;
}
/**
* Try to get the raw HTTP response from the update site, hopefully containing the update XML.
*
* @param array $options The update options, see findUpdate() in children classes
*
* @return boolean|\JHttpResponse False if we can't connect to the site, JHttpResponse otherwise
*
* @throws \Exception
*/
protected function getUpdateSiteResponse($options = array())
{
$url = trim($options['location']);
$this->_url = &$url;
$this->updateSiteId = $options['update_site_id'];
if (!isset($options['update_site_name']))
{
$options['update_site_name'] = $this->getUpdateSiteName($this->updateSiteId);
}
$this->updateSiteName = $options['update_site_name'];
$this->appendExtension = false;
if (array_key_exists('append_extension', $options))
{
$this->appendExtension = $options['append_extension'];
}
if ($this->appendExtension && (substr($url, -4) != '.xml'))
{
if (substr($url, -1) != '/')
{
$url .= '/';
}
$url .= 'extension.xml';
}
// Disable the update site. If the get() below fails with a fatal error (e.g. timeout) the faulty update
// site will remain disabled
$this->toggleUpdateSite($this->updateSiteId, false);
$startTime = microtime(true);
$version = new Version;
$httpOption = new Registry;
$httpOption->set('userAgent', $version->getUserAgent('Joomla', true, false));
// JHttp transport throws an exception when there's no response.
try
{
$http = HttpFactory::getHttp($httpOption);
$response = $http->get($url, array(), 20);
}
catch (\RuntimeException $e)
{
$response = null;
}
// Enable the update site. Since the get() returned the update site should remain enabled
$this->toggleUpdateSite($this->updateSiteId, true);
// Log the time it took to load this update site's information
$endTime = microtime(true);
$timeToLoad = sprintf('%0.2f', $endTime - $startTime);
Log::add(
"Loading information from update site #{$this->updateSiteId} with name " .
"\"$this->updateSiteName\" and URL $url took $timeToLoad seconds", Log::INFO, 'updater'
);
if ($response === null || $response->code !== 200)
{
// If the URL is missing the .xml extension, try appending it and retry loading the update
if (!$this->appendExtension && (substr($url, -4) != '.xml'))
{
$options['append_extension'] = true;
return $this->getUpdateSiteResponse($options);
}
// Log the exact update site name and URL which could not be loaded
Log::add('Error opening url: ' . $url . ' for update site: ' . $this->updateSiteName, Log::WARNING, 'updater');
$app = Factory::getApplication();
$app->enqueueMessage(\JText::sprintf('JLIB_UPDATER_ERROR_OPEN_UPDATE_SITE', $this->updateSiteId, $this->updateSiteName, $url), 'warning');
return false;
}
return $response;
}
}