- md5
- c9281e2a18021dbc13d9ebe981cf8e56
- sha1
- a7a53a129662dcc4d991ff3a73c6087daab2d678
- sha256
- 932fbe5922016a39dfb7de5431ae48210a5eb6c2e156d9bc80405cf977e0feb5
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557
<?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\Filter\InputFilter;
use Joomla\CMS\Http\HttpFactory;
use Joomla\CMS\Log\Log;
use Joomla\CMS\Version;
use Joomla\Registry\Registry;
/**
* Update class. It is used by Updater::update() to install an update. Use Updater::findUpdates() to find updates for
* an extension.
*
* @since 1.7.0
*/
class Update extends \JObject
{
/**
* Update manifest `<name>` element
*
* @var string
* @since 1.7.0
*/
protected $name;
/**
* Update manifest `<description>` element
*
* @var string
* @since 1.7.0
*/
protected $description;
/**
* Update manifest `<element>` element
*
* @var string
* @since 1.7.0
*/
protected $element;
/**
* Update manifest `<type>` element
*
* @var string
* @since 1.7.0
*/
protected $type;
/**
* Update manifest `<version>` element
*
* @var string
* @since 1.7.0
*/
protected $version;
/**
* Update manifest `<infourl>` element
*
* @var string
* @since 1.7.0
*/
protected $infourl;
/**
* Update manifest `<client>` element
*
* @var string
* @since 1.7.0
*/
protected $client;
/**
* Update manifest `<group>` element
*
* @var string
* @since 1.7.0
*/
protected $group;
/**
* Update manifest `<downloads>` element
*
* @var string
* @since 1.7.0
*/
protected $downloads;
/**
* Update manifest `<downloadsource>` elements
*
* @var DownloadSource[]
* @since 3.8.3
*/
protected $downloadSources = array();
/**
* Update manifest `<tags>` element
*
* @var string
* @since 1.7.0
*/
protected $tags;
/**
* Update manifest `<maintainer>` element
*
* @var string
* @since 1.7.0
*/
protected $maintainer;
/**
* Update manifest `<maintainerurl>` element
*
* @var string
* @since 1.7.0
*/
protected $maintainerurl;
/**
* Update manifest `<category>` element
*
* @var string
* @since 1.7.0
*/
protected $category;
/**
* Update manifest `<relationships>` element
*
* @var string
* @since 1.7.0
*/
protected $relationships;
/**
* Update manifest `<targetplatform>` element
*
* @var string
* @since 1.7.0
*/
protected $targetplatform;
/**
* Extra query for download URLs
*
* @var string
* @since 3.2.0
*/
protected $extra_query;
/**
* 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');
/**
* Unused state array
*
* @var array
* @since 3.0.0
*/
protected $stateStore = array();
/**
* Object containing the current update data
*
* @var \stdClass
* @since 3.0.0
*/
protected $currentUpdate;
/**
* Object containing the latest update data
*
* @var \stdClass
* @since 3.0.0
*/
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 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);
}
/**
* Get the last position in stack count
*
* @return string
*
* @since 1.7.0
*/
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 1.7.0
*/
public function _startElement($parser, $name, $attrs = array())
{
$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;
// Handle the array of download sources
case 'DOWNLOADSOURCE':
$source = new DownloadSource;
foreach ($attrs as $key => $data)
{
$key = strtolower($key);
$source->$key = $data;
}
$this->downloadSources[] = $source;
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 1.7.0
*/
public function _endElement($parser, $name)
{
array_pop($this->stack);
switch ($name)
{
// Closing update, find the latest version and check
case 'UPDATE':
$product = strtolower(InputFilter::getInstance()->clean(Version::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))
{
Log::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.',
Log::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)
*/
$patchVersion = $this->get('jversion.dev_level', Version::PATCH_VERSION);
$patchMinimumSupported = !isset($this->currentUpdate->targetplatform->min_dev_level)
|| $patchVersion >= $this->currentUpdate->targetplatform->min_dev_level;
$patchMaximumSupported = !isset($this->currentUpdate->targetplatform->max_dev_level)
|| $patchVersion <= $this->currentUpdate->targetplatform->max_dev_level;
if (isset($this->currentUpdate->targetplatform->name)
&& $product == $this->currentUpdate->targetplatform->name
&& preg_match('/^' . $this->currentUpdate->targetplatform->version . '/', $this->get('jversion.full', JVERSION))
&& $patchMinimumSupported
&& $patchMaximumSupported)
{
$phpMatch = false;
// 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;
}
$dbMatch = false;
// Check if DB & version is supported via <supported_databases> tag, assume supported if tag isn't present
if (isset($this->currentUpdate->supported_databases))
{
$db = Factory::getDbo();
$dbType = strtolower($db->getServerType());
$dbVersion = $db->getVersion();
$supportedDbs = $this->currentUpdate->supported_databases;
// Do we have a entry for the database?
if (isset($supportedDbs->$dbType))
{
$minumumVersion = $supportedDbs->$dbType;
$dbMatch = version_compare($dbVersion, $minumumVersion, '>=');
}
}
else
{
// Set to true if the <supported_databases> tag is not set
$dbMatch = true;
}
// Check minimum stability
$stabilityMatch = true;
if (isset($this->currentUpdate->stability) && ($this->currentUpdate->stability < $this->minimum_stability))
{
$stabilityMatch = false;
}
if ($phpMatch && $stabilityMatch && $dbMatch)
{
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 1.7.0
*/
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 ($tag == 'downloadsource')
{
// Grab the last source so we can append the URL
$source = end($this->downloadSources);
$source->url = $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 Updater}
*
* @return boolean True on success
*
* @since 1.7.0
*/
public function loadFromXml($url, $minimum_stability = Updater::STABILITY_STABLE)
{
$version = new Version;
$httpOption = new Registry;
$httpOption->set('userAgent', $version->getUserAgent('Joomla', true, false));
try
{
$http = HttpFactory::getHttp($httpOption);
$response = $http->get($url);
}
catch (\RuntimeException $e)
{
$response = null;
}
if ($response === null || $response->code !== 200)
{
// TODO: Add a 'mark bad' setting here somehow
Log::add(\JText::sprintf('JLIB_UPDATER_ERROR_EXTENSION_OPEN_URL', $url), Log::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))
{
Log::add(
sprintf(
'XML error: %s at line %d', xml_error_string(xml_get_error_code($this->xmlParser)),
xml_get_current_line_number($this->xmlParser)
),
Log::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 = '\\Joomla\\CMS\\Updater\\Updater::STABILITY_' . strtoupper($tag);
if (defined($constant))
{
return constant($constant);
}
return Updater::STABILITY_STABLE;
}
}
The same content is in 2 releases, Joomla 3.9.2-rc to 3.9.2. See them all, or every version of this file.