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         /**
  31          * @var FormOptions
  32          */
  33         protected $opts;
  34         protected $customFilters;
  35
  36         protected $showNavigation = false;
  37
  38         public function __construct() {
  39                 parent::__construct( 'Newpages' );
  40         }
  41
  42         protected function setup( $par ) {
  43                 // Options
  44                 $opts = new FormOptions();
  45                 $this->opts = $opts; // bind
  46                 $opts->add( 'hideliu', false );
  47                 $opts->add( 'hidepatrolled', $this->getUser()->getBoolOption( 'newpageshidepatrolled' ) );
  48                 $opts->add( 'hidebots', false );
  49                 $opts->add( 'hideredirs', true );
  50                 $opts->add( 'limit', $this->getUser()->getIntOption( 'rclimit' ) );
  51                 $opts->add( 'offset', '' );
  52                 $opts->add( 'namespace', '0' );
  53                 $opts->add( 'username', '' );
  54                 $opts->add( 'feed', '' );
  55                 $opts->add( 'tagfilter', '' );
  56                 $opts->add( 'invert', false );
  57                 $opts->add( 'size-mode', 'max' );
  58                 $opts->add( 'size', 0 );
  59
  60                 $this->customFilters = [];
  61                 Hooks::run( 'SpecialNewPagesFilters', [ $this, &$this->customFilters ] );
  62                 foreach ( $this->customFilters as $key => $params ) {
  63                         $opts->add( $key, $params['default'] );
  64                 }
  65
  66                 // Set values
  67                 $opts->fetchValuesFromRequest( $this->getRequest() );
  68                 if ( $par ) {
  69                         $this->parseParams( $par );
  70                 }
  71
  72                 // Validate
  73                 $opts->validateIntBounds( 'limit', 0, 5000 );
  74         }
  75
  76         protected function parseParams( $par ) {
  77                 $bits = preg_split( '/\s*,\s*/', trim( $par ) );
  78                 foreach ( $bits as $bit ) {
  79                         if ( 'shownav' == $bit ) {
  80                                 $this->showNavigation = true;
  81                         }
  82                         if ( 'hideliu' === $bit ) {
  83                                 $this->opts->setValue( 'hideliu', true );
  84                         }
  85                         if ( 'hidepatrolled' == $bit ) {
  86                                 $this->opts->setValue( 'hidepatrolled', true );
  87                         }
  88                         if ( 'hidebots' == $bit ) {
  89                                 $this->opts->setValue( 'hidebots', true );
  90                         }
  91                         if ( 'showredirs' == $bit ) {
  92                                 $this->opts->setValue( 'hideredirs', false );
  93                         }
  94                         if ( is_numeric( $bit ) ) {
  95                                 $this->opts->setValue( 'limit', intval( $bit ) );
  96                         }
  97
  98                         $m = [];
  99                         if ( preg_match( '/^limit=(\d+)$/', $bit, $m ) ) {
 100                                 $this->opts->setValue( 'limit', intval( $m[1] ) );
 101                         }
 102                         // PG offsets not just digits!
 103                         if ( preg_match( '/^offset=([^=]+)$/', $bit, $m ) ) {
 104                                 $this->opts->setValue( 'offset', intval( $m[1] ) );
 105                         }
 106                         if ( preg_match( '/^username=(.*)$/', $bit, $m ) ) {
 107                                 $this->opts->setValue( 'username', $m[1] );
 108                         }
 109                         if ( preg_match( '/^namespace=(.*)$/', $bit, $m ) ) {
 110                                 $ns = $this->getLanguage()->getNsIndex( $m[1] );
 111                                 if ( $ns !== false ) {
 112                                         $this->opts->setValue( 'namespace', $ns );
 113                                 }
 114                         }
 115                 }
 116         }
 117
 118         /**
 119          * Show a form for filtering namespace and username
 120          *
 121          * @param string $par
 122          */
 123         public function execute( $par ) {
 124                 $out = $this->getOutput();
 125
 126                 $this->setHeaders();
 127                 $this->outputHeader();
 128
 129                 $this->showNavigation = !$this->including(); // Maybe changed in setup
 130                 $this->setup( $par );
 131
 132                 $this->addHelpLink( 'Help:New pages' );
 133
 134                 if ( !$this->including() ) {
 135                         // Settings
 136                         $this->form();
 137
 138                         $feedType = $this->opts->getValue( 'feed' );
 139                         if ( $feedType ) {
 140                                 $this->feed( $feedType );
 141
 142                                 return;
 143                         }
 144
 145                         $allValues = $this->opts->getAllValues();
 146                         unset( $allValues['feed'] );
 147                         $out->setFeedAppendQuery( wfArrayToCgi( $allValues ) );
 148                 }
 149
 150                 $pager = new NewPagesPager( $this, $this->opts );
 151                 $pager->mLimit = $this->opts->getValue( 'limit' );
 152                 $pager->mOffset = $this->opts->getValue( 'offset' );
 153
 154                 if ( $pager->getNumRows() ) {
 155                         $navigation = '';
 156                         if ( $this->showNavigation ) {
 157                                 $navigation = $pager->getNavigationBar();
 158                         }
 159                         $out->addHTML( $navigation . $pager->getBody() . $navigation );
 160                 } else {
 161                         $out->addWikiMsg( 'specialpage-empty' );
 162                 }
 163         }
 164
 165         protected function filterLinks() {
 166                 // show/hide links
 167                 $showhide = [ $this->msg( 'show' )->escaped(), $this->msg( 'hide' )->escaped() ];
 168
 169                 // Option value -> message mapping
 170                 $filters = [
 171                         'hideliu' => 'rcshowhideliu',
 172                         'hidepatrolled' => 'rcshowhidepatr',
 173                         'hidebots' => 'rcshowhidebots',
 174                         'hideredirs' => 'whatlinkshere-hideredirs'
 175                 ];
 176                 foreach ( $this->customFilters as $key => $params ) {
 177                         $filters[$key] = $params['msg'];
 178                 }
 179
 180                 // Disable some if needed
 181                 if ( !User::groupHasPermission( '*', 'createpage' ) ) {
 182                         unset( $filters['hideliu'] );
 183                 }
 184                 if ( !$this->getUser()->useNPPatrol() ) {
 185                         unset( $filters['hidepatrolled'] );
 186                 }
 187
 188                 $links = [];
 189                 $changed = $this->opts->getChangedValues();
 190                 unset( $changed['offset'] ); // Reset offset if query type changes
 191
 192                 $self = $this->getPageTitle();
 193                 $linkRenderer = $this->getLinkRenderer();
 194                 foreach ( $filters as $key => $msg ) {
 195                         $onoff = 1 - $this->opts->getValue( $key );
 196                         $link = $linkRenderer->makeLink(
 197                                 $self,
 198                                 new HtmlArmor( $showhide[$onoff] ),
 199                                 [],
 200                                 [ $key => $onoff ] + $changed
 201                         );
 202                         $links[$key] = $this->msg( $msg )->rawParams( $link )->escaped();
 203                 }
 204
 205                 return $this->getLanguage()->pipeList( $links );
 206         }
 207
 208         protected function form() {
 209                 $out = $this->getOutput();
 210                 $out->addModules( 'mediawiki.userSuggest' );
 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                 $size = $this->opts->consumeValue( 'size' );
 220                 $max = $this->opts->consumeValue( 'size-mode' ) === 'max';
 221
 222                 // Check username input validity
 223                 $ut = Title::makeTitleSafe( NS_USER, $username );
 224                 $userText = $ut ? $ut->getText() : '';
 225
 226                 // Store query values in hidden fields so that form submission doesn't lose them
 227                 $hidden = [];
 228                 foreach ( $this->opts->getUnconsumedValues() as $key => $value ) {
 229                         $hidden[] = Html::hidden( $key, $value );
 230                 }
 231                 $hidden = implode( "\n", $hidden );
 232
 233                 $form = [
 234                         'namespace' => [
 235                                 'type' => 'namespaceselect',
 236                                 'name' => 'namespace',
 237                                 'label-message' => 'namespace',
 238                                 'default' => $namespace,
 239                         ],
 240                         'nsinvert' => [
 241                                 'type' => 'check',
 242                                 'name' => 'invert',
 243                                 'label-message' => 'invert',
 244                                 'default' => $nsinvert,
 245                                 'tooltip' => 'invert',
 246                         ],
 247                         'tagFilter' => [
 248                                 'type' => 'tagfilter',
 249                                 'name' => 'tagfilter',
 250                                 'label-raw' => $this->msg( 'tag-filter' )->parse(),
 251                                 'default' => $tagFilterVal,
 252                         ],
 253                         'username' => [
 254                                 'type' => 'text',
 255                                 'name' => 'username',
 256                                 'label-message' => 'newpages-username',
 257                                 'default' => $userText,
 258                                 'id' => 'mw-np-username',
 259                                 'size' => 30,
 260                                 'cssclass' => 'mw-autocomplete-user', // used by mediawiki.userSuggest
 261                         ],
 262                         'size' => [
 263                                 'type' => 'sizefilter',
 264                                 'name' => 'size',
 265                                 'default' => -$max * $size,
 266                         ],
 267                 ];
 268
 269                 $htmlForm = new HTMLForm( $form, $this->getContext() );
 270
 271                 $htmlForm->setSubmitText( $this->msg( 'newpages-submit' )->text() );
 272                 $htmlForm->setSubmitProgressive();
 273                 // The form should be visible on each request (inclusive requests with submitted forms), so
 274                 // return always false here.
 275                 $htmlForm->setSubmitCallback(
 276                         function () {
 277                                 return false;
 278                         }
 279                 );
 280                 $htmlForm->setMethod( 'get' );
 281
 282                 $out->addHTML( Xml::fieldset( $this->msg( 'newpages' )->text() ) );
 283
 284                 $htmlForm->show();
 285
 286                 $out->addHTML(
 287                         Html::rawElement(
 288                                 'div',
 289                                 null,
 290                                 $this->filterLinks()
 291                         ) .
 292                         Xml::closeElement( 'fieldset' )
 293                 );
 294         }
 295
 296         /**
 297          * Format a row, providing the timestamp, links to the page/history,
 298          * size, user links, and a comment
 299          *
 300          * @param object $result Result row
 301          * @return string
 302          */
 303         public function formatRow( $result ) {
 304                 $title = Title::newFromRow( $result );
 305
 306                 # Revision deletion works on revisions, so we should cast one
 307                 $row = [
 308                         'comment' => $result->rc_comment,
 309                         'deleted' => $result->rc_deleted,
 310                         'user_text' => $result->rc_user_text,
 311                         'user' => $result->rc_user,
 312                 ];
 313                 $rev = new Revision( $row );
 314                 $rev->setTitle( $title );
 315
 316                 $classes = [];
 317
 318                 $lang = $this->getLanguage();
 319                 $dm = $lang->getDirMark();
 320
 321                 $spanTime = Html::element( 'span', [ 'class' => 'mw-newpages-time' ],
 322                         $lang->userTimeAndDate( $result->rc_timestamp, $this->getUser() )
 323                 );
 324                 $linkRenderer = $this->getLinkRenderer();
 325                 $time = $linkRenderer->makeKnownLink(
 326                         $title,
 327                         new HtmlArmor( $spanTime ),
 328                         [],
 329                         [ 'oldid' => $result->rc_this_oldid ]
 330                 );
 331
 332                 $query = $title->isRedirect() ? [ 'redirect' => 'no' ] : [];
 333
 334                 $plink = $linkRenderer->makeKnownLink(
 335                         $title,
 336                         null,
 337                         [ 'class' => 'mw-newpages-pagename' ],
 338                         $query
 339                 );
 340                 $histLink = $linkRenderer->makeKnownLink(
 341                         $title,
 342                         $this->msg( 'hist' )->text(),
 343                         [],
 344                         [ 'action' => 'history' ]
 345                 );
 346                 $hist = Html::rawElement( 'span', [ 'class' => 'mw-newpages-history' ],
 347                         $this->msg( 'parentheses' )->rawParams( $histLink )->escaped() );
 348
 349                 $length = Html::rawElement(
 350                         'span',
 351                         [ 'class' => 'mw-newpages-length' ],
 352                         $this->msg( 'brackets' )->rawParams(
 353                                 $this->msg( 'nbytes' )->numParams( $result->length )->escaped()
 354                         )->escaped()
 355                 );
 356
 357                 $ulink = Linker::revUserTools( $rev );
 358                 $comment = Linker::revComment( $rev );
 359
 360                 if ( $this->patrollable( $result ) ) {
 361                         $classes[] = 'not-patrolled';
 362                 }
 363
 364                 # Add a class for zero byte pages
 365                 if ( $result->length == 0 ) {
 366                         $classes[] = 'mw-newpages-zero-byte-page';
 367                 }
 368
 369                 # Tags, if any.
 370                 if ( isset( $result->ts_tags ) ) {
 371                         list( $tagDisplay, $newClasses ) = ChangeTags::formatSummaryRow(
 372                                 $result->ts_tags,
 373                                 'newpages',
 374                                 $this->getContext()
 375                         );
 376                         $classes = array_merge( $classes, $newClasses );
 377                 } else {
 378                         $tagDisplay = '';
 379                 }
 380
 381                 $css = count( $classes ) ? ' class="' . implode( ' ', $classes ) . '"' : '';
 382
 383                 # Display the old title if the namespace/title has been changed
 384                 $oldTitleText = '';
 385                 $oldTitle = Title::makeTitle( $result->rc_namespace, $result->rc_title );
 386
 387                 if ( !$title->equals( $oldTitle ) ) {
 388                         $oldTitleText = $oldTitle->getPrefixedText();
 389                         $oldTitleText = Html::rawElement(
 390                                 'span',
 391                                 [ 'class' => 'mw-newpages-oldtitle' ],
 392                                 $this->msg( 'rc-old-title' )->params( $oldTitleText )->escaped()
 393                         );
 394                 }
 395
 396                 return "<li{$css}>{$time} {$dm}{$plink} {$hist} {$dm}{$length} "
 397                         . "{$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 bool
 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 string $type
 414          */
 415         protected function feed( $type ) {
 416                 if ( !$this->getConfig()->get( 'Feed' ) ) {
 417                         $this->getOutput()->addWikiMsg( 'feed-unavailable' );
 418
 419                         return;
 420                 }
 421
 422                 $feedClasses = $this->getConfig()->get( 'FeedClasses' );
 423                 if ( !isset( $feedClasses[$type] ) ) {
 424                         $this->getOutput()->addWikiMsg( 'feed-invalid' );
 425
 426                         return;
 427                 }
 428
 429                 $feed = new $feedClasses[$type](
 430                         $this->feedTitle(),
 431                         $this->msg( 'tagline' )->text(),
 432                         $this->getPageTitle()->getFullURL()
 433                 );
 434
 435                 $pager = new NewPagesPager( $this, $this->opts );
 436                 $limit = $this->opts->getValue( 'limit' );
 437                 $pager->mLimit = min( $limit, $this->getConfig()->get( 'FeedLimit' ) );
 438
 439                 $feed->outHeader();
 440                 if ( $pager->getNumRows() > 0 ) {
 441                         foreach ( $pager->mResult as $row ) {
 442                                 $feed->outItem( $this->feedItem( $row ) );
 443                         }
 444                 }
 445                 $feed->outFooter();
 446         }
 447
 448         protected function feedTitle() {
 449                 $desc = $this->getDescription();
 450                 $code = $this->getConfig()->get( 'LanguageCode' );
 451                 $sitename = $this->getConfig()->get( 'Sitename' );
 452
 453                 return "$sitename - $desc [$code]";
 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         protected function getCacheTTL() {
 498                 return 60 * 5;
 499         }
 500 }