mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git
synced 2024-11-28 01:20:07 +00:00
cee5ee0003
Changes:
- Add the LatestSkinVersionRequirement requirement class, which lazily
evaluates the application state to get the version of the skin for the
request.
This majority of this class is taken from Stephen Niedzielski's
Vector\SkinVersionLookup class, which was introduced in d1072d0fdf.
- Register an instance of LatestSkinVersionRequirement and register the
'LatestSkin' feature that requires that requirement
- Re-introduce SkinVector::isLegacy and make it defer to the Feature
Manager
Bug: T244481
Change-Id: If6b82a514aa5afce73e571abdd8de60b16a62fa8
122 lines
3.6 KiB
PHP
122 lines
3.6 KiB
PHP
<?php
|
|
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @since 1.35
|
|
*/
|
|
|
|
namespace Vector\FeatureManagement\Requirements;
|
|
|
|
use Config;
|
|
use User;
|
|
use Vector\Constants;
|
|
use Vector\FeatureManagement\Requirement;
|
|
use WebRequest;
|
|
|
|
/**
|
|
* Retrieve the skin version for the request and compare it with `Constants::SKIN_VERSION_LATEST`.
|
|
* This requirement is met if the two are equal.
|
|
*
|
|
* Skin version is evaluated in the following order:
|
|
*
|
|
* - `useskinversion` URL query parameter override. See `README.md`.
|
|
*
|
|
* - User preference. The `User` object for new and existing accounts are updated by hook according
|
|
* to the `VectorDefaultSkinVersionForNewAccounts` and
|
|
* `VectorDefaultSkinVersionForExistingAccounts` config values. See the `Vector\Hooks` class and
|
|
* `skin.json`.
|
|
*
|
|
* If the skin version is evaluated prior to `User` preference hook invocations, an incorrect
|
|
* version may be returned as only query parameter and site configuration will be known.
|
|
*
|
|
* - Site configuration default. The default is controlled by the `VectorDefaultSkinVersion` config
|
|
* value. This is used for anonymous users and as a fallback configuration. See `skin.json`.
|
|
*
|
|
* This majority of this class is taken from Stephen Niedzielski's `Vector\SkinVersionLookup` class,
|
|
* which was introduced in `d1072d0fdfb1`.
|
|
*
|
|
* @unstable
|
|
*
|
|
* @package Vector\FeatureManagement\Requirements
|
|
* @internal
|
|
*/
|
|
final class LatestSkinVersionRequirement implements Requirement {
|
|
|
|
/**
|
|
* @var WebRequest
|
|
*/
|
|
private $request;
|
|
/**
|
|
* @var User
|
|
*/
|
|
private $user;
|
|
/**
|
|
* @var Config
|
|
*/
|
|
private $config;
|
|
|
|
/**
|
|
* This constructor accepts all dependencies needed to obtain the skin version.
|
|
*
|
|
* @param WebRequest $request
|
|
* @param User $user
|
|
* @param Config $config
|
|
*/
|
|
public function __construct( WebRequest $request, User $user, Config $config ) {
|
|
$this->request = $request;
|
|
$this->user = $user;
|
|
$this->config = $config;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function getName() : string {
|
|
return Constants::REQUIREMENT_LATEST_SKIN_VERSION;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
* @throws \ConfigException
|
|
*/
|
|
public function isMet() : bool {
|
|
return $this->getVersion() === Constants::SKIN_VERSION_LATEST;
|
|
}
|
|
|
|
/**
|
|
* The skin version as a string. E.g., `Constants::SKIN_VERSION_LATEST`,
|
|
* `Constants::SKIN_VERSION_LATEST`, or maybe 'beta'. Note: it's likely someone will put
|
|
* arbitrary strings in the query parameter which means this function returns those strings as
|
|
* is.
|
|
*
|
|
* @return string
|
|
* @throws \ConfigException
|
|
*/
|
|
private function getVersion() : string {
|
|
// Obtain the skin version from the `useskinversion` URL query parameter override, the user
|
|
// preference, or the configured default.
|
|
return (string)$this->request->getVal(
|
|
Constants::QUERY_PARAM_SKIN_VERSION,
|
|
$this->user->getOption(
|
|
Constants::PREF_KEY_SKIN_VERSION,
|
|
$this->config->get( Constants::CONFIG_KEY_DEFAULT_SKIN_VERSION )
|
|
)
|
|
);
|
|
}
|
|
}
|