includes/specials/SpecialNewpages.php

   1 <?php
   2 /**
   3  * Implements Special:Newpages
   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  * A special page that list newly created pages
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 class SpecialNewpages extends IncludableSpecialPage {
  30         // Stored objects
  31
  32         /**
  33          * @var FormOptions
  34          */
  35         protected $opts;
  36         protected $customFilters;
  37
  38         // Some internal settings
  39         protected $showNavigation = false;
  40
  41         public function __construct() {
  42                 parent::__construct( 'Newpages' );
  43         }
  44
  45         protected function setup( $par ) {
  46                 global $wgEnableNewpagesUserFilter;
  47
  48                 // Options
  49                 $opts = new FormOptions();
  50                 $this->opts = $opts; // bind
  51                 $opts->add( 'hideliu', false );
  52                 $opts->add( 'hidepatrolled', $this->getUser()->getBoolOption( 'newpageshidepatrolled' ) );
  53                 $opts->add( 'hidebots', false );
  54                 $opts->add( 'hideredirs', true );
  55                 $opts->add( 'limit', $this->getUser()->getIntOption( 'rclimit' ) );
  56                 $opts->add( 'offset', '' );
  57                 $opts->add( 'namespace', '0' );
  58                 $opts->add( 'username', '' );
  59                 $opts->add( 'feed', '' );
  60                 $opts->add( 'tagfilter', '' );
  61                 $opts->add( 'invert', false );
  62
  63                 $this->customFilters = array();
  64                 wfRunHooks( 'SpecialNewPagesFilters', array( $this, &$this->customFilters ) );
  65                 foreach ( $this->customFilters as $key => $params ) {
  66                         $opts->add( $key, $params['default'] );
  67                 }
  68
  69                 // Set values
  70                 $opts->fetchValuesFromRequest( $this->getRequest() );
  71                 if ( $par ) {
  72                         $this->parseParams( $par );
  73                 }
  74
  75                 // Validate
  76                 $opts->validateIntBounds( 'limit', 0, 5000 );
  77                 if ( !$wgEnableNewpagesUserFilter ) {
  78                         $opts->setValue( 'username', '' );
  79                 }
  80         }
  81
  82         protected function parseParams( $par ) {
  83                 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
  84                 foreach ( $bits as $bit ) {
  85                         if ( 'shownav' == $bit ) {
  86                                 $this->showNavigation = true;
  87                         }
  88                         if ( 'hideliu' === $bit ) {
  89                                 $this->opts->setValue( 'hideliu', true );
  90                         }
  91                         if ( 'hidepatrolled' == $bit ) {
  92                                 $this->opts->setValue( 'hidepatrolled', true );
  93                         }
  94                         if ( 'hidebots' == $bit ) {
  95                                 $this->opts->setValue( 'hidebots', true );
  96                         }
  97                         if ( 'showredirs' == $bit ) {
  98                                 $this->opts->setValue( 'hideredirs', false );
  99                         }
 100                         if ( is_numeric( $bit ) ) {
 101                                 $this->opts->setValue( 'limit', intval( $bit ) );
 102                         }
 103
 104                         $m = array();
 105                         if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
 106                                 $this->opts->setValue( 'limit', intval( $m[1] ) );
 107                         }
 108                         // PG offsets not just digits!
 109                         if ( preg_match( '/^offset=([^=]+)$/', $bit, $m ) ) {
 110                                 $this->opts->setValue( 'offset', intval( $m[1] ) );
 111                         }
 112                         if ( preg_match( '/^username=(.*)$/', $bit, $m ) ) {
 113                                 $this->opts->setValue( 'username', $m[1] );
 114                         }
 115                         if ( preg_match( '/^namespace=(.*)$/', $bit, $m ) ) {
 116                                 $ns = $this->getLanguage()->getNsIndex( $m[1] );
 117                                 if ( $ns !== false ) {
 118                                         $this->opts->setValue( 'namespace', $ns );
 119                                 }
 120                         }
 121                 }
 122         }
 123
 124         /**
 125          * Show a form for filtering namespace and username
 126          *
 127          * @param $par String
 128          * @return String
 129          */
 130         public function execute( $par ) {
 131                 $out = $this->getOutput();
 132
 133                 $this->setHeaders();
 134                 $this->outputHeader();
 135
 136                 $this->showNavigation = !$this->including(); // Maybe changed in setup
 137                 $this->setup( $par );
 138
 139                 if ( !$this->including() ) {
 140                         // Settings
 141                         $this->form();
 142
 143                         $feedType = $this->opts->getValue( 'feed' );
 144                         if ( $feedType ) {
 145                                 $this->feed( $feedType );
 146
 147                                 return;
 148                         }
 149
 150                         $allValues = $this->opts->getAllValues();
 151                         unset( $allValues['feed'] );
 152                         $out->setFeedAppendQuery( wfArrayToCgi( $allValues ) );
 153                 }
 154
 155                 $pager = new NewPagesPager( $this, $this->opts );
 156                 $pager->mLimit = $this->opts->getValue( 'limit' );
 157                 $pager->mOffset = $this->opts->getValue( 'offset' );
 158
 159                 if ( $pager->getNumRows() ) {
 160                         $navigation = '';
 161                         if ( $this->showNavigation ) {
 162                                 $navigation = $pager->getNavigationBar();
 163                         }
 164                         $out->addHTML( $navigation . $pager->getBody() . $navigation );
 165                 } else {
 166                         $out->addWikiMsg( 'specialpage-empty' );
 167                 }
 168         }
 169
 170         protected function filterLinks() {
 171                 // show/hide links
 172                 $showhide = array( $this->msg( 'show' )->escaped(), $this->msg( 'hide' )->escaped() );
 173
 174                 // Option value -> message mapping
 175                 $filters = array(
 176                         'hideliu' => 'rcshowhideliu',
 177                         'hidepatrolled' => 'rcshowhidepatr',
 178                         'hidebots' => 'rcshowhidebots',
 179                         'hideredirs' => 'whatlinkshere-hideredirs'
 180                 );
 181                 foreach ( $this->customFilters as $key => $params ) {
 182                         $filters[$key] = $params['msg'];
 183                 }
 184
 185                 // Disable some if needed
 186                 if ( !User::groupHasPermission( '*', 'createpage' ) ) {
 187                         unset( $filters['hideliu'] );
 188                 }
 189                 if ( !$this->getUser()->useNPPatrol() ) {
 190                         unset( $filters['hidepatrolled'] );
 191                 }
 192
 193                 $links = array();
 194                 $changed = $this->opts->getChangedValues();
 195                 unset( $changed['offset'] ); // Reset offset if query type changes
 196
 197                 $self = $this->getTitle();
 198                 foreach ( $filters as $key => $msg ) {
 199                         $onoff = 1 - $this->opts->getValue( $key );
 200                         $link = Linker::link( $self, $showhide[$onoff], array(),
 201                                 array( $key => $onoff ) + $changed
 202                         );
 203                         $links[$key] = $this->msg( $msg )->rawParams( $link )->escaped();
 204                 }
 205
 206                 return $this->getLanguage()->pipeList( $links );
 207         }
 208
 209         protected function form() {
 210                 global $wgEnableNewpagesUserFilter, $wgScript;
 211
 212                 // Consume values
 213                 $this->opts->consumeValue( 'offset' ); // don't carry offset, DWIW
 214                 $namespace = $this->opts->consumeValue( 'namespace' );
 215                 $username = $this->opts->consumeValue( 'username' );
 216                 $tagFilterVal = $this->opts->consumeValue( 'tagfilter' );
 217                 $nsinvert = $this->opts->consumeValue( 'invert' );
 218
 219                 // Check username input validity
 220                 $ut = Title::makeTitleSafe( NS_USER, $username );
 221                 $userText = $ut ? $ut->getText() : '';
 222
 223                 // Store query values in hidden fields so that form submission doesn't lose them
 224                 $hidden = array();
 225                 foreach ( $this->opts->getUnconsumedValues() as $key => $value ) {
 226                         $hidden[] = Html::hidden( $key, $value );
 227                 }
 228                 $hidden = implode( "\n", $hidden );
 229
 230                 $tagFilter = ChangeTags::buildTagFilterSelector( $tagFilterVal );
 231                 if ( $tagFilter ) {
 232                         list( $tagFilterLabel, $tagFilterSelector ) = $tagFilter;
 233                 }
 234
 235                 $form = Xml::openElement( 'form', array( 'action' => $wgScript ) ) .
 236                         Html::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) .
 237                         Xml::fieldset( $this->msg( 'newpages' )->text() ) .
 238                         Xml::openElement( 'table', array( 'id' => 'mw-newpages-table' ) ) .
 239                         '<tr>
 240                                 <td class="mw-label">' .
 241                         Xml::label( $this->msg( 'namespace' )->text(), 'namespace' ) .
 242                         '</td>
 243                         <td class="mw-input">' .
 244                         Html::namespaceSelector(
 245                                 array(
 246                                         'selected' => $namespace,
 247                                         'all' => 'all',
 248                                 ), array(
 249                                         'name' => 'namespace',
 250                                         'id' => 'namespace',
 251                                         'class' => 'namespaceselector',
 252                                 )
 253                         ) . '&#160;' .
 254                         Xml::checkLabel(
 255                                 $this->msg( 'invert' )->text(),
 256                                 'invert',
 257                                 'nsinvert',
 258                                 $nsinvert,
 259                                 array( 'title' => $this->msg( 'tooltip-invert' )->text() )
 260                         ) .
 261                         '</td>
 262                         </tr>' . ( $tagFilter ? (
 263                         '<tr>
 264                                 <td class="mw-label">' .
 265                                 $tagFilterLabel .
 266                                 '</td>
 267                                 <td class="mw-input">' .
 268                                 $tagFilterSelector .
 269                                 '</td>
 270                         </tr>' ) : '' ) .
 271                         ( $wgEnableNewpagesUserFilter ?
 272                                 '<tr>
 273                                 <td class="mw-label">' .
 274                                         Xml::label( $this->msg( 'newpages-username' )->text(), 'mw-np-username' ) .
 275                                         '</td>
 276                                 <td class="mw-input">' .
 277                                         Xml::input( 'username', 30, $userText, array( 'id' => 'mw-np-username' ) ) .
 278                                         '</td>
 279                         </tr>' : '' ) .
 280                         '<tr> <td></td>
 281                                 <td class="mw-submit">' .
 282                         Xml::submitButton( $this->msg( 'allpagessubmit' )->text() ) .
 283                         '</td>
 284                 </tr>' .
 285                         '<tr>
 286                                 <td></td>
 287                                 <td class="mw-input">' .
 288                         $this->filterLinks() .
 289                         '</td>
 290                         </tr>' .
 291                         Xml::closeElement( 'table' ) .
 292                         Xml::closeElement( 'fieldset' ) .
 293                         $hidden .
 294                         Xml::closeElement( 'form' );
 295
 296                 $this->getOutput()->addHTML( $form );
 297         }
 298
 299         /**
 300          * Format a row, providing the timestamp, links to the page/history,
 301          * size, user links, and a comment
 302          *
 303          * @param object $result Result row
 304          * @return String
 305          */
 306         public function formatRow( $result ) {
 307                 $title = Title::newFromRow( $result );
 308
 309                 # Revision deletion works on revisions, so we should cast one
 310                 $row = array(
 311                         'comment' => $result->rc_comment,
 312                         'deleted' => $result->rc_deleted,
 313                         'user_text' => $result->rc_user_text,
 314                         'user' => $result->rc_user,
 315                 );
 316                 $rev = new Revision( $row );
 317                 $rev->setTitle( $title );
 318
 319                 $classes = array();
 320
 321                 $lang = $this->getLanguage();
 322                 $dm = $lang->getDirMark();
 323
 324                 $spanTime = Html::element( 'span', array( 'class' => 'mw-newpages-time' ),
 325                         $lang->userTimeAndDate( $result->rc_timestamp, $this->getUser() )
 326                 );
 327                 $time = Linker::linkKnown(
 328                         $title,
 329                         $spanTime,
 330                         array(),
 331                         array( 'oldid' => $result->rc_this_oldid ),
 332                         array()
 333                 );
 334
 335                 $query = array( 'redirect' => 'no' );
 336
 337                 // Linker::linkKnown() uses 'known' and 'noclasses' options.
 338                 // This breaks the colouration for stubs.
 339                 $plink = Linker::link(
 340                         $title,
 341                         null,
 342                         array( 'class' => 'mw-newpages-pagename' ),
 343                         $query,
 344                         array( 'known' )
 345                 );
 346                 $histLink = Linker::linkKnown(
 347                         $title,
 348                         $this->msg( 'hist' )->escaped(),
 349                         array(),
 350                         array( 'action' => 'history' )
 351                 );
 352                 $hist = Html::rawElement( 'span', array( 'class' => 'mw-newpages-history' ),
 353                         $this->msg( 'parentheses' )->rawParams( $histLink )->escaped() );
 354
 355                 $length = Html::element(
 356                         'span',
 357                         array( 'class' => 'mw-newpages-length' ),
 358                         $this->msg( 'brackets' )->params( $this->msg( 'nbytes' )
 359                                 ->numParams( $result->length )->text()
 360                         )
 361                 );
 362
 363                 $ulink = Linker::revUserTools( $rev );
 364                 $comment = Linker::revComment( $rev );
 365
 366                 if ( $this->patrollable( $result ) ) {
 367                         $classes[] = 'not-patrolled';
 368                 }
 369
 370                 # Add a class for zero byte pages
 371                 if ( $result->length == 0 ) {
 372                         $classes[] = 'mw-newpages-zero-byte-page';
 373                 }
 374
 375                 # Tags, if any.
 376                 if ( isset( $result->ts_tags ) ) {
 377                         list( $tagDisplay, $newClasses ) = ChangeTags::formatSummaryRow(
 378                                 $result->ts_tags,
 379                                 'newpages'
 380                         );
 381                         $classes = array_merge( $classes, $newClasses );
 382                 } else {
 383                         $tagDisplay = '';
 384                 }
 385
 386                 $css = count( $classes ) ? ' class="' . implode( ' ', $classes ) . '"' : '';
 387
 388                 # Display the old title if the namespace/title has been changed
 389                 $oldTitleText = '';
 390                 $oldTitle = Title::makeTitle( $result->rc_namespace, $result->rc_title );
 391
 392                 if ( !$title->equals( $oldTitle ) ) {
 393                         $oldTitleText = $oldTitle->getPrefixedText();
 394                         $oldTitleText = $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped();
 395                 }
 396
 397                 return "<li{$css}>{$time} {$dm}{$plink} {$hist} {$dm}{$length} {$dm}{$ulink} {$comment} {$tagDisplay} {$oldTitleText}</li>\n";
 398         }
 399
 400         /**
 401          * Should a specific result row provide "patrollable" links?
 402          *
 403          * @param object $result Result row
 404          * @return Boolean
 405          */
 406         protected function patrollable( $result ) {
 407                 return ( $this->getUser()->useNPPatrol() && !$result->rc_patrolled );
 408         }
 409
 410         /**
 411          * Output a subscription feed listing recent edits to this page.
 412          *
 413          * @param $type String
 414          */
 415         protected function feed( $type ) {
 416                 global $wgFeed, $wgFeedClasses, $wgFeedLimit;
 417
 418                 if ( !$wgFeed ) {
 419                         $this->getOutput()->addWikiMsg( 'feed-unavailable' );
 420
 421                         return;
 422                 }
 423
 424                 if ( !isset( $wgFeedClasses[$type] ) ) {
 425                         $this->getOutput()->addWikiMsg( 'feed-invalid' );
 426
 427                         return;
 428                 }
 429
 430                 $feed = new $wgFeedClasses[$type](
 431                         $this->feedTitle(),
 432                         $this->msg( 'tagline' )->text(),
 433                         $this->getTitle()->getFullURL()
 434                 );
 435
 436                 $pager = new NewPagesPager( $this, $this->opts );
 437                 $limit = $this->opts->getValue( 'limit' );
 438                 $pager->mLimit = min( $limit, $wgFeedLimit );
 439
 440                 $feed->outHeader();
 441                 if ( $pager->getNumRows() > 0 ) {
 442                         foreach ( $pager->mResult as $row ) {
 443                                 $feed->outItem( $this->feedItem( $row ) );
 444                         }
 445                 }
 446                 $feed->outFooter();
 447         }
 448
 449         protected function feedTitle() {
 450                 global $wgLanguageCode, $wgSitename;
 451                 $desc = $this->getDescription();
 452
 453                 return "$wgSitename - $desc [$wgLanguageCode]";
 454         }
 455
 456         protected function feedItem( $row ) {
 457                 $title = Title::makeTitle( intval( $row->rc_namespace ), $row->rc_title );
 458                 if ( $title ) {
 459                         $date = $row->rc_timestamp;
 460                         $comments = $title->getTalkPage()->getFullURL();
 461
 462                         return new FeedItem(
 463                                 $title->getPrefixedText(),
 464                                 $this->feedItemDesc( $row ),
 465                                 $title->getFullURL(),
 466                                 $date,
 467                                 $this->feedItemAuthor( $row ),
 468                                 $comments
 469                         );
 470                 } else {
 471                         return null;
 472                 }
 473         }
 474
 475         protected function feedItemAuthor( $row ) {
 476                 return isset( $row->rc_user_text ) ? $row->rc_user_text : '';
 477         }
 478
 479         protected function feedItemDesc( $row ) {
 480                 $revision = Revision::newFromId( $row->rev_id );
 481                 if ( $revision ) {
 482                         //XXX: include content model/type in feed item?
 483                         return '<p>' . htmlspecialchars( $revision->getUserText() ) .
 484                                 $this->msg( 'colon-separator' )->inContentLanguage()->escaped() .
 485                                 htmlspecialchars( FeedItem::stripComment( $revision->getComment() ) ) .
 486                                 "</p>\n<hr />\n<div>" .
 487                                 nl2br( htmlspecialchars( $revision->getContent()->serialize() ) ) . "</div>";
 488                 }
 489
 490                 return '';
 491         }
 492
 493         protected function getGroupName() {
 494                 return 'changes';
 495         }
 496 }
 497
 498 /**
 499  * @ingroup SpecialPage Pager
 500  */
 501 class NewPagesPager extends ReverseChronologicalPager {
 502         // Stored opts
 503         protected $opts;
 504
 505         /**
 506          * @var HtmlForm
 507          */
 508         protected $mForm;
 509
 510         function __construct( $form, FormOptions $opts ) {
 511                 parent::__construct( $form->getContext() );
 512                 $this->mForm = $form;
 513                 $this->opts = $opts;
 514         }
 515
 516         function getQueryInfo() {
 517                 global $wgEnableNewpagesUserFilter;
 518                 $conds = array();
 519                 $conds['rc_new'] = 1;
 520
 521                 $namespace = $this->opts->getValue( 'namespace' );
 522                 $namespace = ( $namespace === 'all' ) ? false : intval( $namespace );
 523
 524                 $username = $this->opts->getValue( 'username' );
 525                 $user = Title::makeTitleSafe( NS_USER, $username );
 526
 527                 if ( $namespace !== false ) {
 528                         if ( $this->opts->getValue( 'invert' ) ) {
 529                                 $conds[] = 'rc_namespace != ' . $this->mDb->addQuotes( $namespace );
 530                         } else {
 531                                 $conds['rc_namespace'] = $namespace;
 532                         }
 533                         $rcIndexes = array( 'new_name_timestamp' );
 534                 } else {
 535                         $rcIndexes = array( 'rc_timestamp' );
 536                 }
 537
 538                 # $wgEnableNewpagesUserFilter - temp WMF hack
 539                 if ( $wgEnableNewpagesUserFilter && $user ) {
 540                         $conds['rc_user_text'] = $user->getText();
 541                         $rcIndexes = 'rc_user_text';
 542                 } elseif ( User::groupHasPermission( '*', 'createpage' ) &&
 543                         $this->opts->getValue( 'hideliu' )
 544                 ) {
 545                         # If anons cannot make new pages, don't "exclude logged in users"!
 546                         $conds['rc_user'] = 0;
 547                 }
 548
 549                 # If this user cannot see patrolled edits or they are off, don't do dumb queries!
 550                 if ( $this->opts->getValue( 'hidepatrolled' ) && $this->getUser()->useNPPatrol() ) {
 551                         $conds['rc_patrolled'] = 0;
 552                 }
 553
 554                 if ( $this->opts->getValue( 'hidebots' ) ) {
 555                         $conds['rc_bot'] = 0;
 556                 }
 557
 558                 if ( $this->opts->getValue( 'hideredirs' ) ) {
 559                         $conds['page_is_redirect'] = 0;
 560                 }
 561
 562                 // Allow changes to the New Pages query
 563                 $tables = array( 'recentchanges', 'page' );
 564                 $fields = array(
 565                         'rc_namespace', 'rc_title', 'rc_cur_id', 'rc_user', 'rc_user_text',
 566                         'rc_comment', 'rc_timestamp', 'rc_patrolled', 'rc_id', 'rc_deleted',
 567                         'length' => 'page_len', 'rev_id' => 'page_latest', 'rc_this_oldid',
 568                         'page_namespace', 'page_title'
 569                 );
 570                 $join_conds = array( 'page' => array( 'INNER JOIN', 'page_id=rc_cur_id' ) );
 571
 572                 wfRunHooks( 'SpecialNewpagesConditions',
 573                         array( &$this, $this->opts, &$conds, &$tables, &$fields, &$join_conds ) );
 574
 575                 $info = array(
 576                         'tables' => $tables,
 577                         'fields' => $fields,
 578                         'conds' => $conds,
 579                         'options' => array( 'USE INDEX' => array( 'recentchanges' => $rcIndexes ) ),
 580                         'join_conds' => $join_conds
 581                 );
 582
 583                 // Modify query for tags
 584                 ChangeTags::modifyDisplayQuery(
 585                         $info['tables'],
 586                         $info['fields'],
 587                         $info['conds'],
 588                         $info['join_conds'],
 589                         $info['options'],
 590                         $this->opts['tagfilter']
 591                 );
 592
 593                 return $info;
 594         }
 595
 596         function getIndexField() {
 597                 return 'rc_timestamp';
 598         }
 599
 600         function formatRow( $row ) {
 601                 return $this->mForm->formatRow( $row );
 602         }
 603
 604         function getStartBody() {
 605                 # Do a batch existence check on pages
 606                 $linkBatch = new LinkBatch();
 607                 foreach ( $this->mResult as $row ) {
 608                         $linkBatch->add( NS_USER, $row->rc_user_text );
 609                         $linkBatch->add( NS_USER_TALK, $row->rc_user_text );
 610                         $linkBatch->add( $row->rc_namespace, $row->rc_title );
 611                 }
 612                 $linkBatch->execute();
 613
 614                 return '<ul>';
 615         }
 616
 617         function getEndBody() {
 618                 return '</ul>';
 619         }
 620 }