Add PagesWithProp special page and API module
authorBrad Jorsch <bjorsch@wikimedia.org>
Mon, 31 Dec 2012 21:30:24 +0000 (16:30 -0500)
committerReedy <reedy@wikimedia.org>
Tue, 26 Feb 2013 00:24:31 +0000 (00:24 +0000)
It would be useful to be able to list pages using a particular page
property, particularly in light of the new Disambiguator extension.

This adds a special page Special:PagesWithProp and an API query module
list=pageswithprop to do just this. It also adds an API query module
list=pagepropnames to list the prop names currently in use on the wiki.

Change-Id: Ib0d4e17f22b8d0cb9894eac6095962315480e809

12 files changed:
RELEASE-NOTES-1.21
includes/AutoLoader.php
includes/DefaultSettings.php
includes/SpecialPageFactory.php
includes/api/ApiQuery.php
includes/api/ApiQueryPagePropNames.php [new file with mode: 0644]
includes/api/ApiQueryPagesWithProp.php [new file with mode: 0644]
includes/specials/SpecialPagesWithProp.php [new file with mode: 0644]
languages/messages/MessagesEn.php
languages/messages/MessagesQqq.php
maintenance/language/messageTypes.inc
maintenance/language/messages.inc

index 80266c6..2db9153 100644 (file)
@@ -102,6 +102,7 @@ production.
 * maintenance/sql.php learned the --cluster option. Let you run the script
   on some external cluster instead of the primary cluster for a given wiki.
 * (bug 20281) test the parsing of inline URLs.
+* Added Special:PagesWithProp, which lists pages using a particular page property.
 
 === Bug fixes in 1.21 ===
 * (bug 40353) SpecialDoubleRedirect should support interwiki redirects.
@@ -226,6 +227,10 @@ production.
   in any one query. If there are too many, iicontinue will be returned.
 * action=query&meta=siteinfo&siprop=general will now return the regexes used for
   link trails and link prefices. Added for Parsoid support.
+* Added an API query module list=pageswithprop, which lists pages using a
+  particular page property.
+* Added an API query module list=pagepropnames, which lists all page prop names
+  currently in use on the wiki.
 
 === API internal changes in 1.21 ===
 * For debugging only, a new global $wgDebugAPI removes many API restrictions when true.
index e0b7c8f..5b64e65 100644 (file)
@@ -408,6 +408,8 @@ $wgAutoloadLocalClasses = array(
        'ApiQueryLogEvents' => 'includes/api/ApiQueryLogEvents.php',
        'ApiQueryORM' => 'includes/api/ApiQueryORM.php',
        'ApiQueryPageProps' => 'includes/api/ApiQueryPageProps.php',
+       'ApiQueryPagesWithProp' => 'includes/api/ApiQueryPagesWithProp.php',
+       'ApiQueryPagePropNames' => 'includes/api/ApiQueryPagePropNames.php',
        'ApiQueryProtectedTitles' => 'includes/api/ApiQueryProtectedTitles.php',
        'ApiQueryQueryPage' => 'includes/api/ApiQueryQueryPage.php',
        'ApiQueryRandom' => 'includes/api/ApiQueryRandom.php',
@@ -967,6 +969,7 @@ $wgAutoloadLocalClasses = array(
        'SpecialNewFiles' => 'includes/specials/SpecialNewimages.php',
        'SpecialNewpages' => 'includes/specials/SpecialNewpages.php',
        'SpecialPasswordReset' => 'includes/specials/SpecialPasswordReset.php',
+       'SpecialPagesWithProp' => 'includes/specials/SpecialPagesWithProp.php',
        'SpecialPermanentLink' => 'includes/SpecialPage.php',
        'SpecialPreferences' => 'includes/specials/SpecialPreferences.php',
        'SpecialPrefixindex' => 'includes/specials/SpecialPrefixindex.php',
index a6eed69..731c1a1 100644 (file)
@@ -5879,6 +5879,7 @@ $wgSpecialPageGroups = array(
        'Listredirects' => 'pages',
        'Categories' => 'pages',
        'Disambiguations' => 'pages',
+       'PagesWithProp' => 'pages',
 
        'Randompage' => 'redirects',
        'Randomredirect' => 'redirects',
index add7efc..c94c358 100644 (file)
@@ -80,6 +80,7 @@ class SpecialPageFactory {
                'Categories'                => 'SpecialCategories',
                'Disambiguations'           => 'DisambiguationsPage',
                'Listredirects'             => 'ListredirectsPage',
+               'PagesWithProp'             => 'SpecialPagesWithProp',
 
                // Login/create account
                'Userlogin'                 => 'LoginForm',
index a25e78c..118355c 100644 (file)
@@ -80,6 +80,8 @@ class ApiQuery extends ApiBase {
                'iwbacklinks' => 'ApiQueryIWBacklinks',
                'langbacklinks' => 'ApiQueryLangBacklinks',
                'logevents' => 'ApiQueryLogEvents',
+               'pageswithprop' => 'ApiQueryPagesWithProp',
+               'pagepropnames' => 'ApiQueryPagePropNames',
                'protectedtitles' => 'ApiQueryProtectedTitles',
                'querypage' => 'ApiQueryQueryPage',
                'random' => 'ApiQueryRandom',
diff --git a/includes/api/ApiQueryPagePropNames.php b/includes/api/ApiQueryPagePropNames.php
new file mode 100644 (file)
index 0000000..08c883d
--- /dev/null
@@ -0,0 +1,116 @@
+<?php
+/**
+ * Created on January 21, 2013
+ *
+ * Copyright © 2013 Brad Jorsch <bjorsch@wikimedia.org>
+ *
+ * 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.21
+ * @author Brad Jorsch
+ */
+
+/**
+ * A query module to list used page props
+ *
+ * @ingroup API
+ * @since 1.21
+ */
+class ApiQueryPagePropNames extends ApiQueryBase {
+
+       public function __construct( $query, $moduleName ) {
+               parent::__construct( $query, $moduleName, 'ppn' );
+       }
+
+       public function getCacheMode( $params ) {
+               return 'public';
+       }
+
+       public function execute() {
+               $params = $this->extractRequestParams();
+
+               $this->addTables( 'page_props' );
+               $this->addFields( 'pp_propname' );
+               $this->addOption( 'DISTINCT' );
+               $this->addOption( 'ORDER BY', 'pp_propname' );
+
+               if ( $params['continue'] ) {
+                       $cont = explode( '|', $params['continue'] );
+                       $this->dieContinueUsageIf( count( $cont ) != 1 );
+
+                       // Add a WHERE clause
+                       $this->addWhereRange( 'pp_propname', 'newer', $cont[0], null );
+               }
+
+               $limit = $params['limit'];
+               $this->addOption( 'LIMIT', $limit + 1 );
+
+               $result = $this->getResult();
+               $count = 0;
+               foreach ( $this->select( __METHOD__ ) as $row ) {
+                       if ( ++$count > $limit ) {
+                               // We've reached the one extra which shows that there are additional pages to be had. Stop here...
+                               $this->setContinueEnumParameter( 'continue', $row->pp_propname );
+                               break;
+                       }
+
+                       $vals = array();
+                       $vals['propname'] = $row->pp_propname;
+                       $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
+                       if ( !$fit ) {
+                               $this->setContinueEnumParameter( 'continue', $row->pp_propname );
+                               break;
+                       }
+               }
+
+               $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'p' );
+       }
+
+       public function getAllowedParams() {
+               return array(
+                       'continue' => null,
+                       'limit' => array(
+                               ApiBase::PARAM_TYPE => 'limit',
+                               ApiBase::PARAM_DFLT => 10,
+                               ApiBase::PARAM_MIN => 1,
+                               ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+                               ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
+                       ),
+               );
+       }
+
+       public function getParamDescription() {
+               return array(
+                       'continue' => 'When more results are available, use this to continue',
+                       'limit' => 'The maximum number of pages to return',
+               );
+       }
+
+       public function getDescription() {
+               return 'List all page prop names in use on the wiki';
+       }
+
+       public function getExamples() {
+               return array(
+                       'api.php?action=query&list=pagepropnames' => 'Get first 10 prop names',
+               );
+       }
+
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Pagepropnames';
+       }
+}
diff --git a/includes/api/ApiQueryPagesWithProp.php b/includes/api/ApiQueryPagesWithProp.php
new file mode 100644 (file)
index 0000000..0132fc3
--- /dev/null
@@ -0,0 +1,189 @@
+<?php
+/**
+ * Created on December 31, 2012
+ *
+ * Copyright © 2012 Brad Jorsch <bjorsch@wikimedia.org>
+ *
+ * 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.21
+ * @author Brad Jorsch
+ */
+
+/**
+ * A query module to enumerate pages that use a particular prop
+ *
+ * @ingroup API
+ * @since 1.21
+ */
+class ApiQueryPagesWithProp extends ApiQueryGeneratorBase {
+
+       public function __construct( $query, $moduleName ) {
+               parent::__construct( $query, $moduleName, 'pwp' );
+       }
+
+       public function execute() {
+               $this->run();
+       }
+
+       public function getCacheMode( $params ) {
+               return 'public';
+       }
+
+       public function executeGenerator( $resultPageSet ) {
+               $this->run( $resultPageSet );
+       }
+
+       /**
+        * @param $resultPageSet ApiPageSet
+        * @return void
+        */
+       private function run( $resultPageSet = null ) {
+               $params = $this->extractRequestParams();
+
+               $prop = array_flip( $params['prop'] );
+               $fld_ids = isset( $prop['ids'] );
+               $fld_title = isset( $prop['title'] );
+               $fld_value = isset( $prop['value'] );
+
+               if ( $resultPageSet === null ) {
+                       $this->addFields( array( 'page_id' ) );
+                       $this->addFieldsIf( array( 'page_title', 'page_namespace' ), $fld_title );
+                       $this->addFieldsIf( 'pp_value', $fld_value );
+               } else {
+                       $this->addFields( $resultPageSet->getPageTableFields() );
+               }
+               $this->addTables( array( 'page_props', 'page' ) );
+               $this->addWhere( 'pp_page=page_id' );
+               $this->addWhereFld( 'pp_propname', $params['propname'] );
+
+               $dir = ( $params['dir'] == 'ascending' ) ? 'newer' : 'older';
+
+               if ( $params['continue'] ) {
+                       $cont = explode( '|', $params['continue'] );
+                       $this->dieContinueUsageIf( count( $cont ) != 1 );
+
+                       // Add a WHERE clause
+                       $from = (int)$cont[0];
+                       $this->addWhereRange( 'pp_page', $dir, $from, null );
+               }
+
+               $sort = ( $params['dir'] === 'descending' ? ' DESC' : '' );
+               $this->addOption( 'ORDER BY', 'pp_page' . $sort );
+
+               $limit = $params['limit'];
+               $this->addOption( 'LIMIT', $limit + 1 );
+
+               $result = $this->getResult();
+               $count = 0;
+               foreach ( $this->select( __METHOD__ ) as $row ) {
+                       if ( ++$count > $limit ) {
+                               // We've reached the one extra which shows that there are additional pages to be had. Stop here...
+                               $this->setContinueEnumParameter( 'continue', $row->page_id );
+                               break;
+                       }
+
+                       if ( $resultPageSet === null ) {
+                               $vals = array();
+                               if ( $fld_ids ) {
+                                       $vals['pageid'] = (int)$row->page_id;
+                               }
+                               if ( $fld_title ) {
+                                       $title = Title::makeTitle( $row->page_namespace, $row->page_title );
+                                       ApiQueryBase::addTitleInfo( $vals, $title );
+                               }
+                               if ( $fld_value ) {
+                                       $vals['value'] = $row->pp_value;
+                               }
+                               $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
+                               if ( !$fit ) {
+                                       $this->setContinueEnumParameter( 'continue', $row->page_id );
+                                       break;
+                               }
+                       } else {
+                               $resultPageSet->processDbRow( $row );
+                       }
+               }
+
+               if ( $resultPageSet === null ) {
+                       $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'page' );
+               }
+       }
+
+       public function getAllowedParams() {
+               return array(
+                       'propname' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true,
+                       ),
+                       'prop' => array(
+                               ApiBase::PARAM_DFLT => 'ids|title',
+                               ApiBase::PARAM_ISMULTI => true,
+                               ApiBase::PARAM_TYPE => array (
+                                       'ids',
+                                       'title',
+                                       'value',
+                               )
+                       ),
+                       'continue' => null,
+                       'limit' => array(
+                               ApiBase::PARAM_TYPE => 'limit',
+                               ApiBase::PARAM_DFLT => 10,
+                               ApiBase::PARAM_MIN => 1,
+                               ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+                               ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
+                       ),
+                       'dir' => array(
+                               ApiBase::PARAM_DFLT => 'ascending',
+                               ApiBase::PARAM_TYPE => array(
+                                       'ascending',
+                                       'descending',
+                               )
+                       ),
+               );
+       }
+
+       public function getParamDescription() {
+               return array(
+                       'propname' => 'Page prop for which to enumerate pages',
+                       'prop' => array(
+                               'What pieces of information to include',
+                               ' ids   - Adds the page ID',
+                               ' title - Adds the title and namespace ID of the page',
+                               ' value - Adds the value of the page prop',
+                       ),
+                       'dir' => 'In which direction to sort',
+                       'continue' => 'When more results are available, use this to continue',
+                       'limit' => 'The maximum number of pages to return',
+               );
+       }
+
+       public function getDescription() {
+               return 'List all pages using a given page prop';
+       }
+
+       public function getExamples() {
+               return array(
+                       'api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value' => 'Get first 10 pages using {{DISPLAYTITLE:}}',
+                       'api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info' => 'Get page info about first 10 pages using __NOTOC__',
+               );
+       }
+
+       public function getHelpUrls() {
+               return 'https://www.mediawiki.org/wiki/API:Pageswithprop';
+       }
+}
diff --git a/includes/specials/SpecialPagesWithProp.php b/includes/specials/SpecialPagesWithProp.php
new file mode 100644 (file)
index 0000000..189798d
--- /dev/null
@@ -0,0 +1,134 @@
+<?php
+/**
+ * Implements Special:PagesWithProp
+ *
+ * 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
+ *
+ * @since 1.21
+ * @file
+ * @ingroup SpecialPage
+ * @author Brad Jorsch
+ */
+
+
+/**
+ * Special:PagesWithProp to search the page_props table
+ * @ingroup SpecialPage
+ * @since 1.21
+ */
+class SpecialPagesWithProp extends QueryPage {
+       private $propName = null;
+
+       function __construct( $name = 'PagesWithProp' ) {
+               parent::__construct( $name );
+       }
+
+       function isCacheable() {
+               return false;
+       }
+
+       function execute( $par ) {
+               $this->setHeaders();
+               $this->outputHeader();
+
+               $request = $this->getRequest();
+               $propname = $request->getVal( 'propname', $par );
+
+               $dbr = wfGetDB( DB_SLAVE );
+               $res = $dbr->select(
+                       'page_props',
+                       'pp_propname',
+                       '',
+                       __METHOD__,
+                       array( 'DISTINCT', 'ORDER BY' => 'pp_propname' )
+               );
+               foreach ( $res as $row ) {
+                       $propnames[$row->pp_propname] = $row->pp_propname;
+               }
+
+               $form = new HTMLForm( array(
+                       'propname' => array(
+                               'type' => 'selectorother',
+                               'name' => 'propname',
+                               'options' => $propnames,
+                               'default' => $propname,
+                               'label-message' => 'pageswithprop-prop',
+                               'required' => true,
+                       ),
+               ), $this->getContext() );
+               $form->setMethod( 'get' );
+               $form->setAction( $this->getTitle()->getFullUrl() );
+               $form->setSubmitCallback( array( $this, 'onSubmit' ) );
+               $form->setWrapperLegend( $this->msg( 'pageswithprop-legend' ) );
+               $form->addHeaderText( $this->msg( 'pageswithprop-text' )->parseAsBlock() );
+               $form->setSubmitTextMsg( 'pageswithprop-submit' );
+
+               $form->prepareForm();
+               $form->displayForm( false );
+               if ( $propname !== '' && $propname !== null ) {
+                       $form->trySubmit();
+               }
+       }
+
+       public function onSubmit( $data, $form ) {
+               $this->propName = $data['propname'];
+               parent::execute( $data['propname'] );
+       }
+
+       /**
+        * Disable RSS/Atom feeds
+        * @return bool
+        */
+       function isSyndicated() {
+               return false;
+       }
+
+       function getQueryInfo() {
+               return array(
+                       'tables' => array( 'page_props', 'page' ),
+                       'fields' => array(
+                               'page_id' => 'pp_page',
+                               'page_namespace',
+                               'page_title',
+                               'page_len',
+                               'page_is_redirect',
+                               'page_latest',
+                               'pp_value',
+                       ),
+                       'conds' => array(
+                               'page_id = pp_page',
+                               'pp_propname' => $this->propName,
+                       ),
+                       'options' => array()
+               );
+       }
+
+       function getOrderFields() {
+               return array( 'page_id' );
+       }
+
+       function formatResult( $skin, $result ) {
+               $title = Title::newFromRow( $result );
+               $ret = Linker::link( $title, null, array(), array(), array( 'known' ) );
+               if ( $result->pp_value !== '' ) {
+                       $value = $this->msg( 'parentheses' )
+                               ->rawParams( Xml::span( $result->pp_value, 'prop-value' ) )
+                               ->escaped();
+                       $ret .= " $value";
+               }
+               return $ret;
+       }
+}
index d3f1327..a9fdf35 100644 (file)
@@ -429,6 +429,7 @@ $specialPageAliases = array(
        'Myuploads'                 => array( 'MyUploads' ),
        'Newimages'                 => array( 'NewFiles', 'NewImages' ),
        'Newpages'                  => array( 'NewPages' ),
+       'PagesWithProp'             => array( 'PagesWithProp', 'Pageswithprop', 'PagesByProp', 'Pagesbyprop' ),
        'PasswordReset'             => array( 'PasswordReset' ),
        'PermanentLink'             => array( 'PermanentLink', 'PermaLink' ),
        'Popularpages'              => array( 'PopularPages' ),
@@ -2565,6 +2566,13 @@ Remember to check for other links to the templates before deleting them.',
 They may have to link to a more appropriate page instead.<br />
 A page is treated as a disambiguation page if it uses a template that is linked from [[MediaWiki:Disambiguationspage]].",
 
+'pageswithprop'         => 'Pages with a page property',
+'pageswithprop-summary' => '', # do not translate or duplicate this message to other languages
+'pageswithprop-legend'  => 'Pages with a page property',
+'pageswithprop-text'    => 'This page lists pages that use a particular page property.',
+'pageswithprop-prop'    => 'Property name:',
+'pageswithprop-submit'  => 'Go',
+
 'doubleredirects'                   => 'Double redirects',
 'doubleredirects-summary'           => '', # do not translate or duplicate this message to other languages
 'doubleredirectstext'               => 'This page lists pages that redirect to other redirect pages.
index 287ccda..9c968ac 100644 (file)
@@ -3851,6 +3851,12 @@ This block of text is shown on [[:Special:Disambiguations]].
 
 \'\'\'Background information:\'\'\' Beyond telling about links going to disambiguation pages, that they are generally bad, it should explain which pages in the article namespace are seen as disambiguations: [[MediaWiki:Disambiguationspage]] usually holds a list of disambiguation templates of the local wiki. Pages linking to one of them (by transclusion) will count as disambiguation pages. Pages linking to these disambiguation pages, instead to the disambiguated article itself, are listed on [[:Special:Disambiguations]].',
 
+'pageswithprop'         => 'Title for [[Special:PagesWithProp]]',
+'pageswithprop-legend'  => 'Legend for the input form on [[Special:PagesWithProp]]',
+'pageswithprop-text'    => 'Introductory text for the input form on [[Special:PagesWithProp]]',
+'pageswithprop-prop'    => 'Label for the property name input field on [[Special:PagesWithProp]]',
+'pageswithprop-submit'  => 'Label for the submit button on [[Special:PagesWithProp]]',
+
 'doubleredirects' => 'Name of [[Special:DoubleRedirects]] displayed in [[Special:SpecialPages]]',
 'doubleredirectstext' => 'Shown on top of [[Special:Doubleredirects]]',
 'double-redirect-fixed-move' => 'This is the message in the log when the software (under the username {{msg|double-redirect-fixer}}) updates the redirects after a page move. See also {{msg|fix-double-redirects}}.',
index 3b2292f..66cc1dc 100644 (file)
@@ -181,6 +181,7 @@ $wgIgnoredMessages = array(
        'deadendpages-summary',
        'protectedpages-summary',
        'disambiguations-summary',
+       'pageswithprop-summary',
        'doubleredirects-summary',
        'lonelypages-summary',
        'unusedtemplates-summary',
index e2997c4..0d6de10 100644 (file)
@@ -1637,6 +1637,13 @@ $wgMessageStructure = array(
                'disambiguationspage',
                'disambiguations-text',
        ),
+       'pageswithprop' => array(
+               'pageswithprop',
+               'pageswithprop-summary',
+               'pageswithprop-text',
+               'pageswithprop-prop',
+               'pageswithprop-ok',
+       ),
        'doubleredirects' => array(
                'doubleredirects',
                'doubleredirects-summary',
@@ -3928,6 +3935,7 @@ XHTML id names.",
        'randomredirect'      => 'Random redirect',
        'statistics'          => 'Statistics',
        'disambiguations'     => '',
+       'pageswithprop'       => '',
        'doubleredirects'     => '',
        'brokenredirects'     => '',
        'withoutinterwiki'    => '',