includes/RevisionList.php

   1 <?php
   2 /**
   3  * Holders of revision list for a single page
   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  */
  22
  23 use MediaWiki\MediaWikiServices;
  24 use Wikimedia\Rdbms\ResultWrapper;
  25 use Wikimedia\Rdbms\IDatabase;
  26
  27 /**
  28  * List for revision table items for a single page
  29  */
  30 abstract class RevisionListBase extends ContextSource implements Iterator {
  31         /** @var Title */
  32         public $title;
  33
  34         /** @var array */
  35         protected $ids;
  36
  37         /** @var ResultWrapper|bool */
  38         protected $res;
  39
  40         /** @var bool|Revision */
  41         protected $current;
  42
  43         /**
  44          * Construct a revision list for a given title
  45          * @param IContextSource $context
  46          * @param Title $title
  47          */
  48         function __construct( IContextSource $context, Title $title ) {
  49                 $this->setContext( $context );
  50                 $this->title = $title;
  51         }
  52
  53         /**
  54          * Select items only where the ID is any of the specified values
  55          * @param array $ids
  56          */
  57         function filterByIds( array $ids ) {
  58                 $this->ids = $ids;
  59         }
  60
  61         /**
  62          * Get the internal type name of this list. Equal to the table name.
  63          * Override this function.
  64          * @return null
  65          */
  66         public function getType() {
  67                 return null;
  68         }
  69
  70         /**
  71          * Initialise the current iteration pointer
  72          */
  73         protected function initCurrent() {
  74                 $row = $this->res->current();
  75                 if ( $row ) {
  76                         $this->current = $this->newItem( $row );
  77                 } else {
  78                         $this->current = false;
  79                 }
  80         }
  81
  82         /**
  83          * Start iteration. This must be called before current() or next().
  84          * @return Revision First list item
  85          */
  86         public function reset() {
  87                 if ( !$this->res ) {
  88                         $this->res = $this->doQuery( wfGetDB( DB_REPLICA ) );
  89                 } else {
  90                         $this->res->rewind();
  91                 }
  92                 $this->initCurrent();
  93                 return $this->current;
  94         }
  95
  96         public function rewind() {
  97                 $this->reset();
  98         }
  99
 100         /**
 101          * Get the current list item, or false if we are at the end
 102          * @return Revision
 103          */
 104         public function current() {
 105                 return $this->current;
 106         }
 107
 108         /**
 109          * Move the iteration pointer to the next list item, and return it.
 110          * @return Revision
 111          */
 112         public function next() {
 113                 $this->res->next();
 114                 $this->initCurrent();
 115                 return $this->current;
 116         }
 117
 118         public function key() {
 119                 return $this->res ? $this->res->key() : 0;
 120         }
 121
 122         public function valid() {
 123                 return $this->res ? $this->res->valid() : false;
 124         }
 125
 126         /**
 127          * Get the number of items in the list.
 128          * @return int
 129          */
 130         public function length() {
 131                 if ( !$this->res ) {
 132                         return 0;
 133                 } else {
 134                         return $this->res->numRows();
 135                 }
 136         }
 137
 138         /**
 139          * Do the DB query to iterate through the objects.
 140          * @param IDatabase $db DB object to use for the query
 141          */
 142         abstract public function doQuery( $db );
 143
 144         /**
 145          * Create an item object from a DB result row
 146          * @param object $row
 147          */
 148         abstract public function newItem( $row );
 149 }
 150
 151 /**
 152  * Abstract base class for revision items
 153  */
 154 abstract class RevisionItemBase {
 155         /** @var RevisionListBase The parent */
 156         protected $list;
 157
 158         /** The database result row */
 159         protected $row;
 160
 161         /**
 162          * @param RevisionListBase $list
 163          * @param object $row DB result row
 164          */
 165         public function __construct( $list, $row ) {
 166                 $this->list = $list;
 167                 $this->row = $row;
 168         }
 169
 170         /**
 171          * Get the DB field name associated with the ID list.
 172          * Override this function.
 173          * @return null
 174          */
 175         public function getIdField() {
 176                 return null;
 177         }
 178
 179         /**
 180          * Get the DB field name storing timestamps.
 181          * Override this function.
 182          * @return bool
 183          */
 184         public function getTimestampField() {
 185                 return false;
 186         }
 187
 188         /**
 189          * Get the DB field name storing user ids.
 190          * Override this function.
 191          * @return bool
 192          */
 193         public function getAuthorIdField() {
 194                 return false;
 195         }
 196
 197         /**
 198          * Get the DB field name storing user names.
 199          * Override this function.
 200          * @return bool
 201          */
 202         public function getAuthorNameField() {
 203                 return false;
 204         }
 205
 206         /**
 207          * Get the ID, as it would appear in the ids URL parameter
 208          * @return int
 209          */
 210         public function getId() {
 211                 $field = $this->getIdField();
 212                 return $this->row->$field;
 213         }
 214
 215         /**
 216          * Get the date, formatted in user's language
 217          * @return string
 218          */
 219         public function formatDate() {
 220                 return $this->list->getLanguage()->userDate( $this->getTimestamp(),
 221                         $this->list->getUser() );
 222         }
 223
 224         /**
 225          * Get the time, formatted in user's language
 226          * @return string
 227          */
 228         public function formatTime() {
 229                 return $this->list->getLanguage()->userTime( $this->getTimestamp(),
 230                         $this->list->getUser() );
 231         }
 232
 233         /**
 234          * Get the timestamp in MW 14-char form
 235          * @return mixed
 236          */
 237         public function getTimestamp() {
 238                 $field = $this->getTimestampField();
 239                 return wfTimestamp( TS_MW, $this->row->$field );
 240         }
 241
 242         /**
 243          * Get the author user ID
 244          * @return int
 245          */
 246         public function getAuthorId() {
 247                 $field = $this->getAuthorIdField();
 248                 return intval( $this->row->$field );
 249         }
 250
 251         /**
 252          * Get the author user name
 253          * @return string
 254          */
 255         public function getAuthorName() {
 256                 $field = $this->getAuthorNameField();
 257                 return strval( $this->row->$field );
 258         }
 259
 260         /**
 261          * Returns true if the current user can view the item
 262          */
 263         abstract public function canView();
 264
 265         /**
 266          * Returns true if the current user can view the item text/file
 267          */
 268         abstract public function canViewContent();
 269
 270         /**
 271          * Get the HTML of the list item. Should be include "<li></li>" tags.
 272          * This is used to show the list in HTML form, by the special page.
 273          */
 274         abstract public function getHTML();
 275
 276         /**
 277          * Returns an instance of LinkRenderer
 278          * @return \MediaWiki\Linker\LinkRenderer
 279          */
 280         protected function getLinkRenderer() {
 281                 return MediaWikiServices::getInstance()->getLinkRenderer();
 282         }
 283 }
 284
 285 class RevisionList extends RevisionListBase {
 286         public function getType() {
 287                 return 'revision';
 288         }
 289
 290         /**
 291          * @param IDatabase $db
 292          * @return mixed
 293          */
 294         public function doQuery( $db ) {
 295                 $conds = [ 'rev_page' => $this->title->getArticleID() ];
 296                 if ( $this->ids !== null ) {
 297                         $conds['rev_id'] = array_map( 'intval', $this->ids );
 298                 }
 299                 $revQuery = Revision::getQueryInfo( [ 'page', 'user' ] );
 300                 return $db->select(
 301                         $revQuery['tables'],
 302                         $revQuery['fields'],
 303                         $conds,
 304                         __METHOD__,
 305                         [ 'ORDER BY' => 'rev_id DESC' ],
 306                         $revQuery['joins']
 307                 );
 308         }
 309
 310         public function newItem( $row ) {
 311                 return new RevisionItem( $this, $row );
 312         }
 313 }
 314
 315 /**
 316  * Item class for a live revision table row
 317  */
 318 class RevisionItem extends RevisionItemBase {
 319         /** @var Revision */
 320         protected $revision;
 321
 322         /** @var RequestContext */
 323         protected $context;
 324
 325         public function __construct( $list, $row ) {
 326                 parent::__construct( $list, $row );
 327                 $this->revision = new Revision( $row );
 328                 $this->context = $list->getContext();
 329         }
 330
 331         public function getIdField() {
 332                 return 'rev_id';
 333         }
 334
 335         public function getTimestampField() {
 336                 return 'rev_timestamp';
 337         }
 338
 339         public function getAuthorIdField() {
 340                 return 'rev_user';
 341         }
 342
 343         public function getAuthorNameField() {
 344                 return 'rev_user_text';
 345         }
 346
 347         public function canView() {
 348                 return $this->revision->userCan( Revision::DELETED_RESTRICTED, $this->context->getUser() );
 349         }
 350
 351         public function canViewContent() {
 352                 return $this->revision->userCan( Revision::DELETED_TEXT, $this->context->getUser() );
 353         }
 354
 355         public function isDeleted() {
 356                 return $this->revision->isDeleted( Revision::DELETED_TEXT );
 357         }
 358
 359         /**
 360          * Get the HTML link to the revision text.
 361          * @todo Essentially a copy of RevDelRevisionItem::getRevisionLink. That class
 362          * should inherit from this one, and implement an appropriate interface instead
 363          * of extending RevDelItem
 364          * @return string
 365          */
 366         protected function getRevisionLink() {
 367                 $date = $this->list->getLanguage()->userTimeAndDate(
 368                         $this->revision->getTimestamp(), $this->list->getUser() );
 369
 370                 if ( $this->isDeleted() && !$this->canViewContent() ) {
 371                         return htmlspecialchars( $date );
 372                 }
 373                 $linkRenderer = $this->getLinkRenderer();
 374                 return $linkRenderer->makeKnownLink(
 375                         $this->list->title,
 376                         $date,
 377                         [],
 378                         [
 379                                 'oldid' => $this->revision->getId(),
 380                                 'unhide' => 1
 381                         ]
 382                 );
 383         }
 384
 385         /**
 386          * Get the HTML link to the diff.
 387          * @todo Essentially a copy of RevDelRevisionItem::getDiffLink. That class
 388          * should inherit from this one, and implement an appropriate interface instead
 389          * of extending RevDelItem
 390          * @return string
 391          */
 392         protected function getDiffLink() {
 393                 if ( $this->isDeleted() && !$this->canViewContent() ) {
 394                         return $this->context->msg( 'diff' )->escaped();
 395                 } else {
 396                         $linkRenderer = $this->getLinkRenderer();
 397                         return $linkRenderer->makeKnownLink(
 398                                         $this->list->title,
 399                                         $this->list->msg( 'diff' )->text(),
 400                                         [],
 401                                         [
 402                                                 'diff' => $this->revision->getId(),
 403                                                 'oldid' => 'prev',
 404                                                 'unhide' => 1
 405                                         ]
 406                                 );
 407                 }
 408         }
 409
 410         /**
 411          * @todo Essentially a copy of RevDelRevisionItem::getHTML. That class
 412          * should inherit from this one, and implement an appropriate interface instead
 413          * of extending RevDelItem
 414          * @return string
 415          */
 416         public function getHTML() {
 417                 $difflink = $this->context->msg( 'parentheses' )
 418                         ->rawParams( $this->getDiffLink() )->escaped();
 419                 $revlink = $this->getRevisionLink();
 420                 $userlink = Linker::revUserLink( $this->revision );
 421                 $comment = Linker::revComment( $this->revision );
 422                 if ( $this->isDeleted() ) {
 423                         $revlink = "<span class=\"history-deleted\">$revlink</span>";
 424                 }
 425                 return "<li>$difflink $revlink $userlink $comment</li>";
 426         }
 427 }