includes/specialpage/ChangesListSpecialPage.php

   1 <?php
   2 /**
   3  * Special page which uses a ChangesList to show query results.
   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  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * Special page which uses a ChangesList to show query results.
  26  * @todo Way too many public functions, most of them should be protected
  27  *
  28  * @ingroup SpecialPage
  29  */
  30 abstract class ChangesListSpecialPage extends SpecialPage {
  31         /** @var string */
  32         protected $rcSubpage;
  33
  34         /** @var FormOptions */
  35         protected $rcOptions;
  36
  37         /** @var array */
  38         protected $customFilters;
  39
  40         /**
  41          * Main execution point
  42          *
  43          * @param string $subpage
  44          */
  45         public function execute( $subpage ) {
  46                 $this->rcSubpage = $subpage;
  47
  48                 $this->setHeaders();
  49                 $this->outputHeader();
  50                 $this->addModules();
  51
  52                 $rows = $this->getRows();
  53                 $opts = $this->getOptions();
  54                 if ( $rows === false ) {
  55                         if ( !$this->including() ) {
  56                                 $this->doHeader( $opts );
  57                         }
  58
  59                         return;
  60                 }
  61
  62                 $batch = new LinkBatch;
  63                 foreach ( $rows as $row ) {
  64                         $batch->add( NS_USER, $row->rc_user_text );
  65                         $batch->add( NS_USER_TALK, $row->rc_user_text );
  66                         $batch->add( $row->rc_namespace, $row->rc_title );
  67                 }
  68                 $batch->execute();
  69
  70                 $this->webOutput( $rows, $opts );
  71
  72                 $rows->free();
  73         }
  74
  75         /**
  76          * Get the database result for this special page instance. Used by ApiFeedRecentChanges.
  77          *
  78          * @return bool|ResultWrapper Result or false
  79          */
  80         public function getRows() {
  81                 $opts = $this->getOptions();
  82                 $conds = $this->buildMainQueryConds( $opts );
  83
  84                 return $this->doMainQuery( $conds, $opts );
  85         }
  86
  87         /**
  88          * Get the current FormOptions for this request
  89          *
  90          * @return FormOptions
  91          */
  92         public function getOptions() {
  93                 if ( $this->rcOptions === null ) {
  94                         $this->rcOptions = $this->setup( $this->rcSubpage );
  95                 }
  96
  97                 return $this->rcOptions;
  98         }
  99
 100         /**
 101          * Create a FormOptions object with options as specified by the user
 102          *
 103          * @param array $parameters
 104          *
 105          * @return FormOptions
 106          */
 107         public function setup( $parameters ) {
 108                 $opts = $this->getDefaultOptions();
 109                 foreach ( $this->getCustomFilters() as $key => $params ) {
 110                         $opts->add( $key, $params['default'] );
 111                 }
 112
 113                 $opts = $this->fetchOptionsFromRequest( $opts );
 114
 115                 // Give precedence to subpage syntax
 116                 if ( $parameters !== null ) {
 117                         $this->parseParameters( $parameters, $opts );
 118                 }
 119
 120                 $this->validateOptions( $opts );
 121
 122                 return $opts;
 123         }
 124
 125         /**
 126          * Get a FormOptions object containing the default options. By default returns some basic options,
 127          * you might want to not call parent method and discard them, or to override default values.
 128          *
 129          * @return FormOptions
 130          */
 131         public function getDefaultOptions() {
 132                 $opts = new FormOptions();
 133
 134                 $opts->add( 'hideminor', false );
 135                 $opts->add( 'hidebots', false );
 136                 $opts->add( 'hideanons', false );
 137                 $opts->add( 'hideliu', false );
 138                 $opts->add( 'hidepatrolled', false );
 139                 $opts->add( 'hidemyself', false );
 140
 141                 $opts->add( 'namespace', '', FormOptions::INTNULL );
 142                 $opts->add( 'invert', false );
 143                 $opts->add( 'associated', false );
 144
 145                 return $opts;
 146         }
 147
 148         /**
 149          * Get custom show/hide filters
 150          *
 151          * @return array Map of filter URL param names to properties (msg/default)
 152          */
 153         protected function getCustomFilters() {
 154                 if ( $this->customFilters === null ) {
 155                         $this->customFilters = array();
 156                         wfRunHooks( 'ChangesListSpecialPageFilters', array( $this, &$this->customFilters ) );
 157                 }
 158
 159                 return $this->customFilters;
 160         }
 161
 162         /**
 163          * Fetch values for a FormOptions object from the WebRequest associated with this instance.
 164          *
 165          * Intended for subclassing, e.g. to add a backwards-compatibility layer.
 166          *
 167          * @param FormOptions $opts
 168          * @return FormOptions
 169          */
 170         protected function fetchOptionsFromRequest( $opts ) {
 171                 $opts->fetchValuesFromRequest( $this->getRequest() );
 172
 173                 return $opts;
 174         }
 175
 176         /**
 177          * Process $par and put options found in $opts. Used when including the page.
 178          *
 179          * @param string $par
 180          * @param FormOptions $opts
 181          */
 182         public function parseParameters( $par, FormOptions $opts ) {
 183                 // nothing by default
 184         }
 185
 186         /**
 187          * Validate a FormOptions object generated by getDefaultOptions() with values already populated.
 188          *
 189          * @param FormOptions $opts
 190          */
 191         public function validateOptions( FormOptions $opts ) {
 192                 // nothing by default
 193         }
 194
 195         /**
 196          * Return an array of conditions depending of options set in $opts
 197          *
 198          * @param FormOptions $opts
 199          * @return array
 200          */
 201         public function buildMainQueryConds( FormOptions $opts ) {
 202                 $dbr = $this->getDB();
 203                 $user = $this->getUser();
 204                 $conds = array();
 205
 206                 // It makes no sense to hide both anons and logged-in users. When this occurs, try a guess on
 207                 // what the user meant and either show only bots or force anons to be shown.
 208                 $botsonly = false;
 209                 $hideanons = $opts['hideanons'];
 210                 if ( $opts['hideanons'] && $opts['hideliu'] ) {
 211                         if ( $opts['hidebots'] ) {
 212                                 $hideanons = false;
 213                         } else {
 214                                 $botsonly = true;
 215                         }
 216                 }
 217
 218                 // Toggles
 219                 if ( $opts['hideminor'] ) {
 220                         $conds['rc_minor'] = 0;
 221                 }
 222                 if ( $opts['hidebots'] ) {
 223                         $conds['rc_bot'] = 0;
 224                 }
 225                 if ( $user->useRCPatrol() && $opts['hidepatrolled'] ) {
 226                         $conds['rc_patrolled'] = 0;
 227                 }
 228                 if ( $botsonly ) {
 229                         $conds['rc_bot'] = 1;
 230                 } else {
 231                         if ( $opts['hideliu'] ) {
 232                                 $conds[] = 'rc_user = 0';
 233                         }
 234                         if ( $hideanons ) {
 235                                 $conds[] = 'rc_user != 0';
 236                         }
 237                 }
 238                 if ( $opts['hidemyself'] ) {
 239                         if ( $user->getId() ) {
 240                                 $conds[] = 'rc_user != ' . $dbr->addQuotes( $user->getId() );
 241                         } else {
 242                                 $conds[] = 'rc_user_text != ' . $dbr->addQuotes( $user->getName() );
 243                         }
 244                 }
 245
 246                 // Namespace filtering
 247                 if ( $opts['namespace'] !== '' ) {
 248                         $selectedNS = $dbr->addQuotes( $opts['namespace'] );
 249                         $operator = $opts['invert'] ? '!=' : '=';
 250                         $boolean = $opts['invert'] ? 'AND' : 'OR';
 251
 252                         // Namespace association (bug 2429)
 253                         if ( !$opts['associated'] ) {
 254                                 $condition = "rc_namespace $operator $selectedNS";
 255                         } else {
 256                                 // Also add the associated namespace
 257                                 $associatedNS = $dbr->addQuotes(
 258                                         MWNamespace::getAssociated( $opts['namespace'] )
 259                                 );
 260                                 $condition = "(rc_namespace $operator $selectedNS "
 261                                         . $boolean
 262                                         . " rc_namespace $operator $associatedNS)";
 263                         }
 264
 265                         $conds[] = $condition;
 266                 }
 267
 268                 return $conds;
 269         }
 270
 271         /**
 272          * Process the query
 273          *
 274          * @param array $conds
 275          * @param FormOptions $opts
 276          * @return bool|ResultWrapper Result or false
 277          */
 278         public function doMainQuery( $conds, $opts ) {
 279                 $tables = array( 'recentchanges' );
 280                 $fields = RecentChange::selectFields();
 281                 $query_options = array();
 282                 $join_conds = array();
 283
 284                 ChangeTags::modifyDisplayQuery(
 285                         $tables,
 286                         $fields,
 287                         $conds,
 288                         $join_conds,
 289                         $query_options,
 290                         ''
 291                 );
 292
 293                 if ( !wfRunHooks( 'ChangesListSpecialPageQuery',
 294                         array( $this->getName(), &$tables, &$fields, &$conds, &$query_options, &$join_conds, $opts ) )
 295                 ) {
 296                         return false;
 297                 }
 298
 299                 $dbr = $this->getDB();
 300
 301                 return $dbr->select(
 302                         $tables,
 303                         $fields,
 304                         $conds,
 305                         __METHOD__,
 306                         $query_options,
 307                         $join_conds
 308                 );
 309         }
 310
 311         /**
 312          * Return a DatabaseBase object for reading
 313          *
 314          * @return DatabaseBase
 315          */
 316         protected function getDB() {
 317                 return wfGetDB( DB_SLAVE );
 318         }
 319
 320         /**
 321          * Send output to the OutputPage object, only called if not used feeds
 322          *
 323          * @param ResultWrapper $rows Database rows
 324          * @param FormOptions $opts
 325          */
 326         public function webOutput( $rows, $opts ) {
 327                 if ( !$this->including() ) {
 328                         $this->outputFeedLinks();
 329                         $this->doHeader( $opts );
 330                 }
 331
 332                 $this->outputChangesList( $rows, $opts );
 333         }
 334
 335         /**
 336          * Output feed links.
 337          */
 338         public function outputFeedLinks() {
 339                 // nothing by default
 340         }
 341
 342         /**
 343          * Build and output the actual changes list.
 344          *
 345          * @param array $rows Database rows
 346          * @param FormOptions $opts
 347          */
 348         abstract public function outputChangesList( $rows, $opts );
 349
 350         /**
 351          * Return the text to be displayed above the changes
 352          *
 353          * @param FormOptions $opts
 354          * @return string XHTML
 355          */
 356         public function doHeader( $opts ) {
 357                 $this->setTopText( $opts );
 358
 359                 // @todo Lots of stuff should be done here.
 360
 361                 $this->setBottomText( $opts );
 362         }
 363
 364         /**
 365          * Send the text to be displayed before the options. Should use $this->getOutput()->addWikiText()
 366          * or similar methods to print the text.
 367          *
 368          * @param FormOptions $opts
 369          */
 370         function setTopText( FormOptions $opts ) {
 371                 // nothing by default
 372         }
 373
 374         /**
 375          * Send the text to be displayed after the options. Should use $this->getOutput()->addWikiText()
 376          * or similar methods to print the text.
 377          *
 378          * @param FormOptions $opts
 379          */
 380         function setBottomText( FormOptions $opts ) {
 381                 // nothing by default
 382         }
 383
 384         /**
 385          * Get options to be displayed in a form
 386          * @todo This should handle options returned by getDefaultOptions().
 387          * @todo Not called by anything, should be called by something… doHeader() maybe?
 388          *
 389          * @param FormOptions $opts
 390          * @return array
 391          */
 392         function getExtraOptions( $opts ) {
 393                 return array();
 394         }
 395
 396         /**
 397          * Return the legend displayed within the fieldset
 398          * @todo This should not be static, then we can drop the parameter
 399          * @todo Not called by anything, should be called by doHeader()
 400          *
 401          * @param IContextSource $context The object available as $this in non-static functions
 402          * @return string
 403          */
 404         public static function makeLegend( IContextSource $context ) {
 405                 global $wgRecentChangesFlags;
 406                 $user = $context->getUser();
 407                 # The legend showing what the letters and stuff mean
 408                 $legend = Html::openElement( 'dl' ) . "\n";
 409                 # Iterates through them and gets the messages for both letter and tooltip
 410                 $legendItems = $wgRecentChangesFlags;
 411                 if ( !( $user->useRCPatrol() || $user->useNPPatrol() ) ) {
 412                         unset( $legendItems['unpatrolled'] );
 413                 }
 414                 foreach ( $legendItems as $key => $item ) { # generate items of the legend
 415                         $label = isset( $item['legend'] ) ? $item['legend'] : $item['title'];
 416                         $letter = $item['letter'];
 417                         $cssClass = isset( $item['class'] ) ? $item['class'] : $key;
 418
 419                         $legend .= Html::element( 'dt',
 420                                 array( 'class' => $cssClass ), $context->msg( $letter )->text()
 421                         ) . "\n" .
 422                         Html::rawElement( 'dd', array(),
 423                                 $context->msg( $label )->parse()
 424                         ) . "\n";
 425                 }
 426                 # (+-123)
 427                 $legend .= Html::rawElement( 'dt',
 428                         array( 'class' => 'mw-plusminus-pos' ),
 429                         $context->msg( 'recentchanges-legend-plusminus' )->parse()
 430                 ) . "\n";
 431                 $legend .= Html::element(
 432                         'dd',
 433                         array( 'class' => 'mw-changeslist-legend-plusminus' ),
 434                         $context->msg( 'recentchanges-label-plusminus' )->text()
 435                 ) . "\n";
 436                 $legend .= Html::closeElement( 'dl' ) . "\n";
 437
 438                 # Collapsibility
 439                 $legend =
 440                         '<div class="mw-changeslist-legend">' .
 441                                 $context->msg( 'recentchanges-legend-heading' )->parse() .
 442                                 '<div class="mw-collapsible-content">' . $legend . '</div>' .
 443                         '</div>';
 444
 445                 return $legend;
 446         }
 447
 448         /**
 449          * Add page-specific modules.
 450          */
 451         protected function addModules() {
 452                 $out = $this->getOutput();
 453                 // Styles and behavior for the legend box (see makeLegend())
 454                 $out->addModuleStyles( 'mediawiki.special.changeslist.legend' );
 455                 $out->addModules( 'mediawiki.special.changeslist.legend.js' );
 456         }
 457
 458         protected function getGroupName() {
 459                 return 'changes';
 460         }
 461 }