includes/specials/SpecialPagesWithProp.php

   1 <?php
   2 /**
   3  * Implements Special:PagesWithProp
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @since 1.21
  21  * @file
  22  * @ingroup SpecialPage
  23  * @author Brad Jorsch
  24  */
  25
  26 /**
  27  * Special:PagesWithProp to search the page_props table
  28  * @ingroup SpecialPage
  29  * @since 1.21
  30  */
  31 class SpecialPagesWithProp extends QueryPage {
  32         private $propName = null;
  33         private $existingPropNames = null;
  34
  35         function __construct( $name = 'PagesWithProp' ) {
  36                 parent::__construct( $name );
  37         }
  38
  39         function isCacheable() {
  40                 return false;
  41         }
  42
  43         function execute( $par ) {
  44                 $this->setHeaders();
  45                 $this->outputHeader();
  46                 $this->getOutput()->addModuleStyles( 'mediawiki.special.pagesWithProp' );
  47
  48                 $request = $this->getRequest();
  49                 $propname = $request->getVal( 'propname', $par );
  50
  51                 $propnames = $this->getExistingPropNames();
  52
  53                 $form = new HTMLForm( array(
  54                         'propname' => array(
  55                                 'type' => 'selectorother',
  56                                 'name' => 'propname',
  57                                 'options' => $propnames,
  58                                 'default' => $propname,
  59                                 'label-message' => 'pageswithprop-prop',
  60                                 'required' => true,
  61                         ),
  62                 ), $this->getContext() );
  63                 $form->setMethod( 'get' );
  64                 $form->setSubmitCallback( array( $this, 'onSubmit' ) );
  65                 $form->setWrapperLegendMsg( 'pageswithprop-legend' );
  66                 $form->addHeaderText( $this->msg( 'pageswithprop-text' )->parseAsBlock() );
  67                 $form->setSubmitTextMsg( 'pageswithprop-submit' );
  68
  69                 $form->prepareForm();
  70                 $form->displayForm( false );
  71                 if ( $propname !== '' && $propname !== null ) {
  72                         $form->trySubmit();
  73                 }
  74         }
  75
  76         public function onSubmit( $data, $form ) {
  77                 $this->propName = $data['propname'];
  78                 parent::execute( $data['propname'] );
  79         }
  80
  81         /**
  82          * Return an array of subpages beginning with $search that this special page will accept.
  83          *
  84          * @param string $search Prefix to search for
  85          * @param int $limit Maximum number of results to return
  86          * @param int $offset Number of pages to skip
  87          * @return string[] Matching subpages
  88          */
  89         public function prefixSearchSubpages( $search, $limit, $offset ) {
  90                 $subpages = array_keys( $this->queryExistingProps( $limit, $offset ) );
  91                 // We've already limited and offsetted, set to N and 0 respectively.
  92                 return self::prefixSearchArray( $search, count( $subpages ), $subpages, 0 );
  93         }
  94
  95         /**
  96          * Disable RSS/Atom feeds
  97          * @return bool
  98          */
  99         function isSyndicated() {
 100                 return false;
 101         }
 102
 103         function getQueryInfo() {
 104                 return array(
 105                         'tables' => array( 'page_props', 'page' ),
 106                         'fields' => array(
 107                                 'page_id' => 'pp_page',
 108                                 'page_namespace',
 109                                 'page_title',
 110                                 'page_len',
 111                                 'page_is_redirect',
 112                                 'page_latest',
 113                                 'pp_value',
 114                         ),
 115                         'conds' => array(
 116                                 'page_id = pp_page',
 117                                 'pp_propname' => $this->propName,
 118                         ),
 119                         'options' => array()
 120                 );
 121         }
 122
 123         function getOrderFields() {
 124                 return array( 'page_id' );
 125         }
 126
 127         /**
 128          * @param Skin $skin
 129          * @param object $result Result row
 130          * @return string
 131          */
 132         function formatResult( $skin, $result ) {
 133                 $title = Title::newFromRow( $result );
 134                 $ret = Linker::link( $title, null, array(), array(), array( 'known' ) );
 135                 if ( $result->pp_value !== '' ) {
 136                         // Do not show very long or binary values on the special page
 137                         $valueLength = strlen( $result->pp_value );
 138                         $isBinary = strpos( $result->pp_value, "\0" ) !== false;
 139                         $isTooLong = $valueLength > 1024;
 140
 141                         if ( $isBinary || $isTooLong ) {
 142                                 $message = $this
 143                                         ->msg( $isBinary ? 'pageswithprop-prophidden-binary' : 'pageswithprop-prophidden-long' )
 144                                         ->params( $this->getLanguage()->formatSize( $valueLength ) );
 145
 146                                 $propValue = Html::element( 'span', array( 'class' => 'prop-value-hidden' ), $message->text() );
 147                         } else {
 148                                 $propValue = Html::element( 'span', array( 'class' => 'prop-value' ), $result->pp_value );
 149                         }
 150
 151                         $ret .= $this->msg( 'colon-separator' )->escaped() . $propValue;
 152                 }
 153
 154                 return $ret;
 155         }
 156
 157         public function getExistingPropNames() {
 158                 if ( $this->existingPropNames === null ) {
 159                         $this->existingPropNames = $this->queryExistingProps();
 160                 }
 161                 return $this->existingPropNames;
 162         }
 163
 164         protected function queryExistingProps( $limit = null, $offset = 0 ) {
 165                 $opts = array(
 166                         'DISTINCT', 'ORDER BY' => 'pp_propname'
 167                 );
 168                 if ( $limit ) {
 169                         $opts['LIMIT'] = $limit;
 170                 }
 171                 if ( $offset ) {
 172                         $opts['OFFSET'] = $offset;
 173                 }
 174
 175                 $res = wfGetDB( DB_SLAVE )->select(
 176                         'page_props',
 177                         'pp_propname',
 178                         '',
 179                         __METHOD__,
 180                         $opts
 181                 );
 182
 183                 $propnames = array();
 184                 foreach ( $res as $row ) {
 185                         $propnames[$row->pp_propname] = $row->pp_propname;
 186                 }
 187
 188                 return $propnames;
 189         }
 190
 191         protected function getGroupName() {
 192                 return 'pages';
 193         }
 194 }