mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Gadgets
synced 2024-11-28 01:00:02 +00:00
72cbb64069
Adds a contentModels option to gadget definitions to restrict gadgets to run in pages of the given content models only. Use-cases include gadgets for tabular data[1] (for Tabular .JsonConfig model), for editing map data[2] (for Map.JsonConfig model), and for showing links in code pages[3] (restricted to javascript, css, json, and scribunto models), as well as common gadgets like ProveIt[4] which can be restricted to wikitext model. [1]: https://commons.wikimedia.org/wiki/MediaWiki:Gadget-TabularImportExport.js [2]: https://fr.wikipedia.org/wiki/MediaWiki:Gadget-KartoEditor.js [3]: https://en.wiktionary.org/wiki/MediaWiki:Gadget-CodeLinks.js [4]: https://commons.wikimedia.org/wiki/Help:Gadget-ProveIt Bug: T204201 Bug: T63007 Change-Id: I7dcfc21d674ead8d710e7f77d13bf18bcad15079
74 lines
2.2 KiB
PHP
74 lines
2.2 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Extension\Gadgets;
|
|
|
|
/**
|
|
* 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
|
|
*
|
|
* @author Siddharth VP
|
|
* @file
|
|
*/
|
|
|
|
use OutputPage;
|
|
use Skin;
|
|
use User;
|
|
|
|
class GadgetLoadConditions {
|
|
/** @var User */
|
|
private $user;
|
|
/** @var Skin */
|
|
private $skin;
|
|
/** @var string */
|
|
private $action;
|
|
/** @var int */
|
|
private $namespace;
|
|
/** @var string */
|
|
private $contentModel;
|
|
/** @var bool */
|
|
private $isMobileView;
|
|
/** @var string|null */
|
|
private $withGadgetParam;
|
|
|
|
/**
|
|
* @param OutputPage $out
|
|
*/
|
|
public function __construct( OutputPage $out, bool $isMobileView = false ) {
|
|
$this->user = $out->getUser();
|
|
$this->skin = $out->getSkin();
|
|
$this->action = $out->getContext()->getActionName();
|
|
$this->namespace = $out->getTitle()->getNamespace();
|
|
$this->contentModel = $out->getTitle()->getContentModel();
|
|
$this->withGadgetParam = $out->getRequest()->getRawVal( 'withgadget' );
|
|
$this->isMobileView = $isMobileView;
|
|
}
|
|
|
|
/**
|
|
* @param Gadget $gadget
|
|
* @return bool
|
|
*/
|
|
public function check( Gadget $gadget ) {
|
|
$urlLoad = $this->withGadgetParam === $gadget->getName() && $gadget->supportsUrlLoad();
|
|
|
|
return ( $gadget->isEnabled( $this->user ) || $urlLoad )
|
|
&& $gadget->isAllowed( $this->user )
|
|
&& $gadget->isActionSupported( $this->action )
|
|
&& $gadget->isSkinSupported( $this->skin )
|
|
&& $gadget->isNamespaceSupported( $this->namespace )
|
|
&& $gadget->isContentModelSupported( $this->contentModel )
|
|
&& $gadget->isTargetSupported( $this->isMobileView );
|
|
}
|
|
}
|