From c1f9b1f7b1b77776192048005dcc66dcf3df2bfb Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Sat, 27 Dec 2014 15:41:37 +0100 Subject: Update to MediaWiki 1.24.1 --- .../Gadgets/api/ApiQueryGadgetCategories.php | 122 +++++++++++ extensions/Gadgets/api/ApiQueryGadgets.php | 228 +++++++++++++++++++++ 2 files changed, 350 insertions(+) create mode 100644 extensions/Gadgets/api/ApiQueryGadgetCategories.php create mode 100644 extensions/Gadgets/api/ApiQueryGadgets.php (limited to 'extensions/Gadgets/api') diff --git a/extensions/Gadgets/api/ApiQueryGadgetCategories.php b/extensions/Gadgets/api/ApiQueryGadgetCategories.php new file mode 100644 index 00000000..73628085 --- /dev/null +++ b/extensions/Gadgets/api/ApiQueryGadgetCategories.php @@ -0,0 +1,122 @@ +extractRequestParams(); + $this->props = array_flip( $params['prop'] ); + $this->neededNames = isset( $params['names'] ) + ? array_flip( $params['names'] ) + : false; + + $this->getMain()->setCacheMode( 'public' ); + + $this->getList(); + } + + private function getList() { + $data = array(); + $result = $this->getResult(); + $gadgets = Gadget::loadStructuredList(); + + if ( $gadgets ) { + foreach ( $gadgets as $category => $list ) { + if ( !$this->neededNames || isset( $this->neededNames[$category] ) ) { + $row = array(); + if ( isset( $this->props['name'] ) ) { + $row['name'] = $category; + } + + if ( $category !== "" ) { + if ( isset( $this->props['title'] ) ) { + $row['desc'] = $this->msg( "gadget-section-$category" )->parse(); + } + } + + if ( isset( $this->props['members'] ) ) { + $row['members'] = count( $list ); + } + + $data[] = $row; + } + } + } + $result->setIndexedTagName( $data, 'category' ); + $result->addValue( 'query', $this->getModuleName(), $data ); + } + + public function getAllowedParams() { + return array( + 'prop' => array( + ApiBase::PARAM_DFLT => 'name', + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => array( + 'name', + 'title', + 'members', + ), + ), + 'names' => array( + ApiBase::PARAM_TYPE => 'string', + ApiBase::PARAM_ISMULTI => true, + ), + ); + } + + public function getDescription() { + return 'Returns a list of gadget categories'; + } + + public function getParamDescription() { + return array( + 'prop' => array( + 'What gadget category information to get:', + ' name - Internal category name', + ' title - Category title', + ' members - Number of gadgets in category', + ), + 'names' => 'Name(s) of categories to retrieve', + ); + } + + public function getExamples() { + $params = $this->getAllowedParams(); + $allProps = implode( '|', $params['prop'][ApiBase::PARAM_TYPE] ); + + return array( + 'Get a list of existing gadget categories:', + ' api.php?action=query&list=gadgetcategories', + 'Get all information about categories named "foo" and "bar":', + " api.php?action=query&list=gadgetcategories&gcnames=foo|bar&gcprop=$allProps", + ); + } + + public function getVersion() { + return __CLASS__ . ': $Id$'; + } +} diff --git a/extensions/Gadgets/api/ApiQueryGadgets.php b/extensions/Gadgets/api/ApiQueryGadgets.php new file mode 100644 index 00000000..b6b00515 --- /dev/null +++ b/extensions/Gadgets/api/ApiQueryGadgets.php @@ -0,0 +1,228 @@ +extractRequestParams(); + $this->props = array_flip( $params['prop'] ); + $this->categories = isset( $params['categories'] ) + ? array_flip( $params['categories'] ) + : false; + $this->neededIds = isset( $params['ids'] ) + ? array_flip( $params['ids'] ) + : false; + $this->listAllowed = isset( $params['allowedonly'] ) && $params['allowedonly']; + $this->listEnabled = isset( $params['enabledonly'] ) && $params['enabledonly']; + + $this->getMain()->setCacheMode( $this->listAllowed || $this->listEnabled + ? 'anon-public-user-private' : 'public' ); + + $this->applyList( $this->getList() ); + } + + /** + * @return array + */ + private function getList() { + $gadgets = Gadget::loadStructuredList(); + + if ( $gadgets === false ) { + return array(); + } + + $result = array(); + foreach ( $gadgets as $category => $list ) { + if ( $this->categories && !isset( $this->categories[$category] ) ) { + continue; + } + + foreach ( $list as $g ) { + if ( $this->isNeeded( $g ) ) { + $result[] = $g; + } + } + } + return $result; + } + + /** + * @param $gadgets array + */ + private function applyList( $gadgets ) { + $data = array(); + $result = $this->getResult(); + + /** + * @var $g Gadget + */ + foreach ( $gadgets as $g ) { + $row = array(); + if ( isset( $this->props['id'] ) ) { + $row['id'] = $g->getName(); + } + + if ( isset( $this->props['metadata'] ) ) { + $row['metadata'] = $this->fakeMetadata( $g ); + $this->setIndexedTagNameForMetadata( $row['metadata'] ); + } + + if ( isset( $this->props['desc'] ) ) { + $row['desc'] = $g->getDescription(); + } + + $data[] = $row; + } + + $result->setIndexedTagName( $data, 'gadget' ); + $result->addValue( 'query', $this->getModuleName(), $data ); + } + + /** + * @param $gadget Gadget + * + * @return bool + */ + private function isNeeded( Gadget $gadget ) { + $user = $this->getUser(); + + return ( $this->neededIds === false || isset( $this->neededIds[$gadget->getName()] ) ) + && ( !$this->listAllowed || $gadget->isAllowed( $user ) ) + && ( !$this->listEnabled || $gadget->isEnabled( $user ) ); + } + + /** + * @param $g Gadget + * @return array + */ + private function fakeMetadata( Gadget $g ) { + return array( + 'settings' => array( + 'rights' => $g->getRequiredRights(), + 'skins' => $g->getRequiredSkins(), + 'default' => $g->isOnByDefault(), + 'hidden' => false, // Only exists in RL2 branch + 'shared' => false, // Only exists in RL2 branch + 'category' => $g->getCategory(), + ), + 'module' => array( + 'scripts' => $g->getScripts(), + 'styles' => $g->getStyles(), + 'dependencies' => $g->getDependencies(), + 'messages' => array(), // Only exists in RL2 branch + ) + ); + } + + private function setIndexedTagNameForMetadata( &$metadata ) { + static $tagNames = array( + 'rights' => 'right', + 'skins' => 'skin', + 'scripts' => 'script', + 'styles' => 'style', + 'dependencies' => 'dependency', + 'messages' => 'message', + ); + + $result = $this->getResult(); + foreach ( $metadata as &$data ) { + foreach ( $data as $key => &$value ) { + if ( is_array( $value ) ) { + $tag = isset( $tagNames[$key] ) ? $tagNames[$key] : $key; + $result->setIndexedTagName( $value, $tag ); + } + } + } + } + + public function getAllowedParams() { + return array( + 'prop' => array( + ApiBase::PARAM_DFLT => 'id|metadata', + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => array( + 'id', + 'metadata', + 'desc', + ), + ), + 'categories' => array( + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => 'string', + ), + 'ids' => array( + ApiBase::PARAM_TYPE => 'string', + ApiBase::PARAM_ISMULTI => true, + ), + 'allowedonly' => false, + 'enabledonly' => false, + ); + } + + public function getDescription() { + return 'Returns a list of gadgets used on this wiki'; + } + + public function getParamDescription() { + return array( + 'prop' => array( + 'What gadget information to get:', + ' id - Internal gadget ID', + ' metadata - The gadget metadata', + ' desc - Gadget description transformed into HTML (can be slow, use only if really needed)', + ), + 'categories' => 'Gadgets from what categories to retrieve', + 'ids' => 'ID(s) of gadgets to retrieve', + 'allowedonly' => 'List only gadgets allowed to current user', + 'enabledonly' => 'List only gadgets enabled by current user', + ); + } + + public function getExamples() { + $params = $this->getAllowedParams(); + $allProps = implode( '|', $params['prop'][ApiBase::PARAM_TYPE] ); + return array( + 'Get a list of gadgets along with their descriptions:', + ' api.php?action=query&list=gadgets&gaprop=id|desc', + 'Get a list of gadgets with all possible properties:', + " api.php?action=query&list=gadgets&gaprop=$allProps", + 'Get a list of gadgets belonging to category "foo":', + ' api.php?action=query&list=gadgets&gacategories=foo', + 'Get information about gadgets "foo" and "bar":', + ' api.php?action=query&list=gadgets&gaids=foo|bar&gaprop=id|desc|metadata', + 'Get a list of gadgets enabled by current user:', + ' api.php?action=query&list=gadgets&gaenabledonly', + ); + } + + public function getVersion() { + return __CLASS__ . ': $Id$'; + } +} -- cgit v1.2.3-54-g00ecf