MediaWiki  master
HistoryAction.php
Go to the documentation of this file.
1 <?php
37  const DIR_PREV = 0;
38  const DIR_NEXT = 1;
39 
41  public $message;
42 
43  public function getName() {
44  return 'history';
45  }
46 
47  public function requiresWrite() {
48  return false;
49  }
50 
51  public function requiresUnblock() {
52  return false;
53  }
54 
55  protected function getPageTitle() {
56  return $this->msg( 'history-title', $this->getTitle()->getPrefixedText() )->text();
57  }
58 
59  protected function getDescription() {
60  // Creation of a subtitle link pointing to [[Special:Log]]
61  return Linker::linkKnown(
62  SpecialPage::getTitleFor( 'Log' ),
63  $this->msg( 'viewpagelogs' )->escaped(),
64  [],
65  [ 'page' => $this->getTitle()->getPrefixedText() ]
66  );
67  }
68 
72  public function getArticle() {
73  return $this->page;
74  }
75 
80  private function preCacheMessages() {
81  // Precache various messages
82  if ( !isset( $this->message ) ) {
83  $msgs = [ 'cur', 'last', 'pipe-separator' ];
84  foreach ( $msgs as $msg ) {
85  $this->message[$msg] = $this->msg( $msg )->escaped();
86  }
87  }
88  }
89 
93  function onView() {
94  $out = $this->getOutput();
95  $request = $this->getRequest();
96 
100  if ( $out->checkLastModified( $this->page->getTouched() ) ) {
101  return; // Client cache fresh and headers sent, nothing more to do.
102  }
103 
104  $this->preCacheMessages();
105  $config = $this->context->getConfig();
106 
107  # Fill in the file cache if not set already
108  $useFileCache = $config->get( 'UseFileCache' );
109  if ( $useFileCache && HTMLFileCache::useFileCache( $this->getContext() ) ) {
110  $cache = new HTMLFileCache( $this->getTitle(), 'history' );
111  if ( !$cache->isCacheGood( /* Assume up to date */ ) ) {
112  ob_start( [ &$cache, 'saveToFileCache' ] );
113  }
114  }
115 
116  // Setup page variables.
117  $out->setFeedAppendQuery( 'action=history' );
118  $out->addModules( 'mediawiki.action.history' );
119  $out->addModuleStyles( [
120  'mediawiki.action.history.styles',
121  'mediawiki.special.changeslist',
122  ] );
123  if ( $config->get( 'UseMediaWikiUIEverywhere' ) ) {
124  $out = $this->getOutput();
125  $out->addModuleStyles( [
126  'mediawiki.ui.input',
127  'mediawiki.ui.checkbox',
128  ] );
129  }
130 
131  // Handle atom/RSS feeds.
132  $feedType = $request->getVal( 'feed' );
133  if ( $feedType ) {
134  $this->feed( $feedType );
135 
136  return;
137  }
138 
139  $this->addHelpLink( '//meta.wikimedia.org/wiki/Special:MyLanguage/Help:Page_history', true );
140 
141  // Fail nicely if article doesn't exist.
142  if ( !$this->page->exists() ) {
143  $out->addWikiMsg( 'nohistory' );
144  # show deletion/move log if there is an entry
146  $out,
147  [ 'delete', 'move' ],
148  $this->getTitle(),
149  '',
150  [ 'lim' => 10,
151  'conds' => [ "log_action != 'revision'" ],
152  'showIfEmpty' => false,
153  'msgKey' => [ 'moveddeleted-notice' ]
154  ]
155  );
156 
157  return;
158  }
159 
163  $year = $request->getInt( 'year' );
164  $month = $request->getInt( 'month' );
165  $tagFilter = $request->getVal( 'tagfilter' );
166  $tagSelector = ChangeTags::buildTagFilterSelector( $tagFilter );
167 
171  if ( $request->getBool( 'deleted' ) ) {
172  $conds = [ 'rev_deleted != 0' ];
173  } else {
174  $conds = [];
175  }
176  if ( $this->getUser()->isAllowed( 'deletedhistory' ) ) {
177  $checkDeleted = Xml::checkLabel( $this->msg( 'history-show-deleted' )->text(),
178  'deleted', 'mw-show-deleted-only', $request->getBool( 'deleted' ) ) . "\n";
179  } else {
180  $checkDeleted = '';
181  }
182 
183  // Add the general form
184  $action = htmlspecialchars( wfScript() );
185  $out->addHTML(
186  "<form action=\"$action\" method=\"get\" id=\"mw-history-searchform\">" .
188  $this->msg( 'history-fieldset-title' )->text(),
189  false,
190  [ 'id' => 'mw-history-search' ]
191  ) .
192  Html::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) . "\n" .
193  Html::hidden( 'action', 'history' ) . "\n" .
195  ( $year == null ? MWTimestamp::getLocalInstance()->format( 'Y' ) : $year ),
196  $month
197  ) . '&#160;' .
198  ( $tagSelector ? ( implode( '&#160;', $tagSelector ) . '&#160;' ) : '' ) .
199  $checkDeleted .
201  $this->msg( 'historyaction-submit' )->text(),
202  [],
203  [ 'mw-ui-progressive' ]
204  ) . "\n" .
205  '</fieldset></form>'
206  );
207 
208  Hooks::run( 'PageHistoryBeforeList', [ &$this->page, $this->getContext() ] );
209 
210  // Create and output the list.
211  $pager = new HistoryPager( $this, $year, $month, $tagFilter, $conds );
212  $out->addHTML(
213  $pager->getNavigationBar() .
214  $pager->getBody() .
215  $pager->getNavigationBar()
216  );
217  $out->preventClickjacking( $pager->getPreventClickjacking() );
218 
219  }
220 
231  function fetchRevisions( $limit, $offset, $direction ) {
232  // Fail if article doesn't exist.
233  if ( !$this->getTitle()->exists() ) {
234  return new FakeResultWrapper( [] );
235  }
236 
237  $dbr = wfGetDB( DB_SLAVE );
238 
239  if ( $direction === self::DIR_PREV ) {
240  list( $dirs, $oper ) = [ "ASC", ">=" ];
241  } else { /* $direction === self::DIR_NEXT */
242  list( $dirs, $oper ) = [ "DESC", "<=" ];
243  }
244 
245  if ( $offset ) {
246  $offsets = [ "rev_timestamp $oper " . $dbr->addQuotes( $dbr->timestamp( $offset ) ) ];
247  } else {
248  $offsets = [];
249  }
250 
251  $page_id = $this->page->getId();
252 
253  return $dbr->select( 'revision',
255  array_merge( [ 'rev_page' => $page_id ], $offsets ),
256  __METHOD__,
257  [ 'ORDER BY' => "rev_timestamp $dirs",
258  'USE INDEX' => 'page_timestamp', 'LIMIT' => $limit ]
259  );
260  }
261 
267  function feed( $type ) {
268  if ( !FeedUtils::checkFeedOutput( $type ) ) {
269  return;
270  }
271  $request = $this->getRequest();
272 
273  $feedClasses = $this->context->getConfig()->get( 'FeedClasses' );
275  $feed = new $feedClasses[$type](
276  $this->getTitle()->getPrefixedText() . ' - ' .
277  $this->msg( 'history-feed-title' )->inContentLanguage()->text(),
278  $this->msg( 'history-feed-description' )->inContentLanguage()->text(),
279  $this->getTitle()->getFullURL( 'action=history' )
280  );
281 
282  // Get a limit on number of feed entries. Provide a sane default
283  // of 10 if none is defined (but limit to $wgFeedLimit max)
284  $limit = $request->getInt( 'limit', 10 );
285  $limit = min(
286  max( $limit, 1 ),
287  $this->context->getConfig()->get( 'FeedLimit' )
288  );
289 
290  $items = $this->fetchRevisions( $limit, 0, self::DIR_NEXT );
291 
292  // Generate feed elements enclosed between header and footer.
293  $feed->outHeader();
294  if ( $items->numRows() ) {
295  foreach ( $items as $row ) {
296  $feed->outItem( $this->feedItem( $row ) );
297  }
298  } else {
299  $feed->outItem( $this->feedEmpty() );
300  }
301  $feed->outFooter();
302  }
303 
304  function feedEmpty() {
305  return new FeedItem(
306  $this->msg( 'nohistory' )->inContentLanguage()->text(),
307  $this->msg( 'history-feed-empty' )->inContentLanguage()->parseAsBlock(),
308  $this->getTitle()->getFullURL(),
309  wfTimestamp( TS_MW ),
310  '',
311  $this->getTitle()->getTalkPage()->getFullURL()
312  );
313  }
314 
323  function feedItem( $row ) {
324  $rev = new Revision( $row );
325  $rev->setTitle( $this->getTitle() );
326  $text = FeedUtils::formatDiffRow(
327  $this->getTitle(),
328  $this->getTitle()->getPreviousRevisionID( $rev->getId() ),
329  $rev->getId(),
330  $rev->getTimestamp(),
331  $rev->getComment()
332  );
333  if ( $rev->getComment() == '' ) {
335  $title = $this->msg( 'history-feed-item-nocomment',
336  $rev->getUserText(),
337  $wgContLang->timeanddate( $rev->getTimestamp() ),
338  $wgContLang->date( $rev->getTimestamp() ),
339  $wgContLang->time( $rev->getTimestamp() ) )->inContentLanguage()->text();
340  } else {
341  $title = $rev->getUserText() .
342  $this->msg( 'colon-separator' )->inContentLanguage()->text() .
343  FeedItem::stripComment( $rev->getComment() );
344  }
345 
346  return new FeedItem(
347  $title,
348  $text,
349  $this->getTitle()->getFullURL( 'diff=' . $rev->getId() . '&oldid=prev' ),
350  $rev->getTimestamp(),
351  $rev->getUserText(),
352  $this->getTitle()->getTalkPage()->getFullURL()
353  );
354  }
355 }
356 
365  public $lastRow = false;
366 
368 
369  protected $oldIdChecked;
370 
371  protected $preventClickjacking = false;
375  protected $parentLens;
376 
378  protected $showTagEditUI;
379 
387  function __construct( $historyPage, $year = '', $month = '', $tagFilter = '', $conds = [] ) {
388  parent::__construct( $historyPage->getContext() );
389  $this->historyPage = $historyPage;
390  $this->tagFilter = $tagFilter;
391  $this->getDateCond( $year, $month );
392  $this->conds = $conds;
393  $this->showTagEditUI = ChangeTags::showTagEditingUI( $this->getUser() );
394  }
395 
396  // For hook compatibility...
397  function getArticle() {
398  return $this->historyPage->getArticle();
399  }
400 
401  function getSqlComment() {
402  if ( $this->conds ) {
403  return 'history page filtered'; // potentially slow, see CR r58153
404  } else {
405  return 'history page unfiltered';
406  }
407  }
408 
409  function getQueryInfo() {
410  $queryInfo = [
411  'tables' => [ 'revision', 'user' ],
412  'fields' => array_merge( Revision::selectFields(), Revision::selectUserFields() ),
413  'conds' => array_merge(
414  [ 'rev_page' => $this->getWikiPage()->getId() ],
415  $this->conds ),
416  'options' => [ 'USE INDEX' => [ 'revision' => 'page_timestamp' ] ],
417  'join_conds' => [ 'user' => Revision::userJoinCond() ],
418  ];
420  $queryInfo['tables'],
421  $queryInfo['fields'],
422  $queryInfo['conds'],
423  $queryInfo['join_conds'],
424  $queryInfo['options'],
425  $this->tagFilter
426  );
427  Hooks::run( 'PageHistoryPager::getQueryInfo', [ &$this, &$queryInfo ] );
428 
429  return $queryInfo;
430  }
431 
432  function getIndexField() {
433  return 'rev_timestamp';
434  }
435 
440  function formatRow( $row ) {
441  if ( $this->lastRow ) {
442  $latest = ( $this->counter == 1 && $this->mIsFirst );
443  $firstInList = $this->counter == 1;
444  $this->counter++;
445 
446  $notifTimestamp = $this->getConfig()->get( 'ShowUpdatedMarker' )
447  ? $this->getTitle()->getNotificationTimestamp( $this->getUser() )
448  : false;
449 
450  $s = $this->historyLine(
451  $this->lastRow, $row, $notifTimestamp, $latest, $firstInList );
452  } else {
453  $s = '';
454  }
455  $this->lastRow = $row;
456 
457  return $s;
458  }
459 
460  function doBatchLookups() {
461  if ( !Hooks::run( 'PageHistoryPager::doBatchLookups', [ $this, $this->mResult ] ) ) {
462  return;
463  }
464 
465  # Do a link batch query
466  $this->mResult->seek( 0 );
467  $batch = new LinkBatch();
468  $revIds = [];
469  foreach ( $this->mResult as $row ) {
470  if ( $row->rev_parent_id ) {
471  $revIds[] = $row->rev_parent_id;
472  }
473  if ( !is_null( $row->user_name ) ) {
474  $batch->add( NS_USER, $row->user_name );
475  $batch->add( NS_USER_TALK, $row->user_name );
476  } else { # for anons or usernames of imported revisions
477  $batch->add( NS_USER, $row->rev_user_text );
478  $batch->add( NS_USER_TALK, $row->rev_user_text );
479  }
480  }
481  $this->parentLens = Revision::getParentLengths( $this->mDb, $revIds );
482  $batch->execute();
483  $this->mResult->seek( 0 );
484  }
485 
491  function getStartBody() {
492  $this->lastRow = false;
493  $this->counter = 1;
494  $this->oldIdChecked = 0;
495 
496  $this->getOutput()->wrapWikiMsg( "<div class='mw-history-legend'>\n$1\n</div>", 'histlegend' );
497  $s = Html::openElement( 'form', [ 'action' => wfScript(),
498  'id' => 'mw-history-compare' ] ) . "\n";
499  $s .= Html::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) . "\n";
500  $s .= Html::hidden( 'action', 'historysubmit' ) . "\n";
501  $s .= Html::hidden( 'type', 'revision' ) . "\n";
502 
503  // Button container stored in $this->buttons for re-use in getEndBody()
504  $this->buttons = '<div>';
505  $className = 'historysubmit mw-history-compareselectedversions-button';
506  $attrs = [ 'class' => $className ]
507  + Linker::tooltipAndAccesskeyAttribs( 'compareselectedversions' );
508  $this->buttons .= $this->submitButton( $this->msg( 'compareselectedversions' )->text(),
509  $attrs
510  ) . "\n";
511 
512  $user = $this->getUser();
513  $actionButtons = '';
514  if ( $user->isAllowed( 'deleterevision' ) ) {
515  $actionButtons .= $this->getRevisionButton( 'revisiondelete', 'showhideselectedversions' );
516  }
517  if ( $this->showTagEditUI ) {
518  $actionButtons .= $this->getRevisionButton( 'editchangetags', 'history-edit-tags' );
519  }
520  if ( $actionButtons ) {
521  $this->buttons .= Xml::tags( 'div', [ 'class' =>
522  'mw-history-revisionactions' ], $actionButtons );
523  }
524 
525  if ( $user->isAllowed( 'deleterevision' ) || $this->showTagEditUI ) {
526  $this->buttons .= ( new ListToggle( $this->getOutput() ) )->getHTML();
527  }
528 
529  $this->buttons .= '</div>';
530 
531  $s .= $this->buttons;
532  $s .= '<ul id="pagehistory">' . "\n";
533 
534  return $s;
535  }
536 
537  private function getRevisionButton( $name, $msg ) {
538  $this->preventClickjacking();
539  # Note bug #20966, <button> is non-standard in IE<8
540  $element = Html::element(
541  'button',
542  [
543  'type' => 'submit',
544  'name' => $name,
545  'value' => '1',
546  'class' => "historysubmit mw-history-$name-button",
547  ],
548  $this->msg( $msg )->text()
549  ) . "\n";
550  return $element;
551  }
552 
553  function getEndBody() {
554  if ( $this->lastRow ) {
555  $latest = $this->counter == 1 && $this->mIsFirst;
556  $firstInList = $this->counter == 1;
557  if ( $this->mIsBackwards ) {
558  # Next row is unknown, but for UI reasons, probably exists if an offset has been specified
559  if ( $this->mOffset == '' ) {
560  $next = null;
561  } else {
562  $next = 'unknown';
563  }
564  } else {
565  # The next row is the past-the-end row
566  $next = $this->mPastTheEndRow;
567  }
568  $this->counter++;
569 
570  $notifTimestamp = $this->getConfig()->get( 'ShowUpdatedMarker' )
571  ? $this->getTitle()->getNotificationTimestamp( $this->getUser() )
572  : false;
573 
574  $s = $this->historyLine(
575  $this->lastRow, $next, $notifTimestamp, $latest, $firstInList );
576  } else {
577  $s = '';
578  }
579  $s .= "</ul>\n";
580  # Add second buttons only if there is more than one rev
581  if ( $this->getNumRows() > 2 ) {
582  $s .= $this->buttons;
583  }
584  $s .= '</form>';
585 
586  return $s;
587  }
588 
596  function submitButton( $message, $attributes = [] ) {
597  # Disable submit button if history has 1 revision only
598  if ( $this->getNumRows() > 1 ) {
599  return Html::submitButton( $message, $attributes );
600  } else {
601  return '';
602  }
603  }
604 
619  function historyLine( $row, $next, $notificationtimestamp = false,
620  $latest = false, $firstInList = false ) {
621  $rev = new Revision( $row );
622  $rev->setTitle( $this->getTitle() );
623 
624  if ( is_object( $next ) ) {
625  $prevRev = new Revision( $next );
626  $prevRev->setTitle( $this->getTitle() );
627  } else {
628  $prevRev = null;
629  }
630 
631  $curlink = $this->curLink( $rev, $latest );
632  $lastlink = $this->lastLink( $rev, $next );
633  $curLastlinks = $curlink . $this->historyPage->message['pipe-separator'] . $lastlink;
634  $histLinks = Html::rawElement(
635  'span',
636  [ 'class' => 'mw-history-histlinks' ],
637  $this->msg( 'parentheses' )->rawParams( $curLastlinks )->escaped()
638  );
639 
640  $diffButtons = $this->diffButtons( $rev, $firstInList );
641  $s = $histLinks . $diffButtons;
642 
643  $link = $this->revLink( $rev );
644  $classes = [];
645 
646  $del = '';
647  $user = $this->getUser();
648  $canRevDelete = $user->isAllowed( 'deleterevision' );
649  // Show checkboxes for each revision, to allow for revision deletion and
650  // change tags
651  if ( $canRevDelete || $this->showTagEditUI ) {
652  $this->preventClickjacking();
653  // If revision was hidden from sysops and we don't need the checkbox
654  // for anything else, disable it
655  if ( !$this->showTagEditUI && !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) {
656  $del = Xml::check( 'deleterevisions', false, [ 'disabled' => 'disabled' ] );
657  // Otherwise, enable the checkbox...
658  } else {
659  $del = Xml::check( 'showhiderevisions', false,
660  [ 'name' => 'ids[' . $rev->getId() . ']' ] );
661  }
662  // User can only view deleted revisions...
663  } elseif ( $rev->getVisibility() && $user->isAllowed( 'deletedhistory' ) ) {
664  // If revision was hidden from sysops, disable the link
665  if ( !$rev->userCan( Revision::DELETED_RESTRICTED, $user ) ) {
666  $del = Linker::revDeleteLinkDisabled( false );
667  // Otherwise, show the link...
668  } else {
669  $query = [ 'type' => 'revision',
670  'target' => $this->getTitle()->getPrefixedDBkey(), 'ids' => $rev->getId() ];
671  $del .= Linker::revDeleteLink( $query,
672  $rev->isDeleted( Revision::DELETED_RESTRICTED ), false );
673  }
674  }
675  if ( $del ) {
676  $s .= " $del ";
677  }
678 
679  $lang = $this->getLanguage();
680  $dirmark = $lang->getDirMark();
681 
682  $s .= " $link";
683  $s .= $dirmark;
684  $s .= " <span class='history-user'>" .
685  Linker::revUserTools( $rev, true ) . "</span>";
686  $s .= $dirmark;
687 
688  if ( $rev->isMinor() ) {
689  $s .= ' ' . ChangesList::flag( 'minor', $this->getContext() );
690  }
691 
692  # Sometimes rev_len isn't populated
693  if ( $rev->getSize() !== null ) {
694  # Size is always public data
695  $prevSize = isset( $this->parentLens[$row->rev_parent_id] )
696  ? $this->parentLens[$row->rev_parent_id]
697  : 0;
698  $sDiff = ChangesList::showCharacterDifference( $prevSize, $rev->getSize() );
699  $fSize = Linker::formatRevisionSize( $rev->getSize() );
700  $s .= ' <span class="mw-changeslist-separator">. .</span> ' . "$fSize $sDiff";
701  }
702 
703  # Text following the character difference is added just before running hooks
704  $s2 = Linker::revComment( $rev, false, true );
705 
706  if ( $notificationtimestamp && ( $row->rev_timestamp >= $notificationtimestamp ) ) {
707  $s2 .= ' <span class="updatedmarker">' . $this->msg( 'updatedmarker' )->escaped() . '</span>';
708  $classes[] = 'mw-history-line-updated';
709  }
710 
711  $tools = [];
712 
713  # Rollback and undo links
714  if ( $prevRev && $this->getTitle()->quickUserCan( 'edit', $user ) ) {
715  if ( $latest && $this->getTitle()->quickUserCan( 'rollback', $user ) ) {
716  // Get a rollback link without the brackets
717  $rollbackLink = Linker::generateRollback(
718  $rev,
719  $this->getContext(),
720  [ 'verify', 'noBrackets' ]
721  );
722  if ( $rollbackLink ) {
723  $this->preventClickjacking();
724  $tools[] = $rollbackLink;
725  }
726  }
727 
728  if ( !$rev->isDeleted( Revision::DELETED_TEXT )
729  && !$prevRev->isDeleted( Revision::DELETED_TEXT )
730  ) {
731  # Create undo tooltip for the first (=latest) line only
732  $undoTooltip = $latest
733  ? [ 'title' => $this->msg( 'tooltip-undo' )->text() ]
734  : [];
735  $undolink = Linker::linkKnown(
736  $this->getTitle(),
737  $this->msg( 'editundo' )->escaped(),
738  $undoTooltip,
739  [
740  'action' => 'edit',
741  'undoafter' => $prevRev->getId(),
742  'undo' => $rev->getId()
743  ]
744  );
745  $tools[] = "<span class=\"mw-history-undo\">{$undolink}</span>";
746  }
747  }
748  // Allow extension to add their own links here
749  Hooks::run( 'HistoryRevisionTools', [ $rev, &$tools, $prevRev, $user ] );
750 
751  if ( $tools ) {
752  $s2 .= ' ' . $this->msg( 'parentheses' )->rawParams( $lang->pipeList( $tools ) )->escaped();
753  }
754 
755  # Tags
756  list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow(
757  $row->ts_tags,
758  'history',
759  $this->getContext()
760  );
761  $classes = array_merge( $classes, $newClasses );
762  if ( $tagSummary !== '' ) {
763  $s2 .= " $tagSummary";
764  }
765 
766  # Include separator between character difference and following text
767  if ( $s2 !== '' ) {
768  $s .= ' <span class="mw-changeslist-separator">. .</span> ' . $s2;
769  }
770 
771  Hooks::run( 'PageHistoryLineEnding', [ $this, &$row, &$s, &$classes ] );
772 
773  $attribs = [];
774  if ( $classes ) {
775  $attribs['class'] = implode( ' ', $classes );
776  }
777 
778  return Xml::tags( 'li', $attribs, $s ) . "\n";
779  }
780 
787  function revLink( $rev ) {
788  $date = $this->getLanguage()->userTimeAndDate( $rev->getTimestamp(), $this->getUser() );
789  $date = htmlspecialchars( $date );
790  if ( $rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
792  $this->getTitle(),
793  $date,
794  [ 'class' => 'mw-changeslist-date' ],
795  [ 'oldid' => $rev->getId() ]
796  );
797  } else {
798  $link = $date;
799  }
800  if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
801  $link = "<span class=\"history-deleted\">$link</span>";
802  }
803 
804  return $link;
805  }
806 
814  function curLink( $rev, $latest ) {
815  $cur = $this->historyPage->message['cur'];
816  if ( $latest || !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
817  return $cur;
818  } else {
819  return Linker::linkKnown(
820  $this->getTitle(),
821  $cur,
822  [],
823  [
824  'diff' => $this->getWikiPage()->getLatest(),
825  'oldid' => $rev->getId()
826  ]
827  );
828  }
829  }
830 
840  function lastLink( $prevRev, $next ) {
841  $last = $this->historyPage->message['last'];
842 
843  if ( $next === null ) {
844  # Probably no next row
845  return $last;
846  }
847 
848  if ( $next === 'unknown' ) {
849  # Next row probably exists but is unknown, use an oldid=prev link
850  return Linker::linkKnown(
851  $this->getTitle(),
852  $last,
853  [],
854  [
855  'diff' => $prevRev->getId(),
856  'oldid' => 'prev'
857  ]
858  );
859  }
860 
861  $nextRev = new Revision( $next );
862 
863  if ( !$prevRev->userCan( Revision::DELETED_TEXT, $this->getUser() )
864  || !$nextRev->userCan( Revision::DELETED_TEXT, $this->getUser() )
865  ) {
866  return $last;
867  }
868 
869  return Linker::linkKnown(
870  $this->getTitle(),
871  $last,
872  [],
873  [
874  'diff' => $prevRev->getId(),
875  'oldid' => $next->rev_id
876  ]
877  );
878  }
879 
888  function diffButtons( $rev, $firstInList ) {
889  if ( $this->getNumRows() > 1 ) {
890  $id = $rev->getId();
891  $radio = [ 'type' => 'radio', 'value' => $id ];
893  if ( $firstInList ) {
894  $first = Xml::element( 'input',
895  array_merge( $radio, [
896  'style' => 'visibility:hidden',
897  'name' => 'oldid',
898  'id' => 'mw-oldid-null' ] )
899  );
900  $checkmark = [ 'checked' => 'checked' ];
901  } else {
902  # Check visibility of old revisions
903  if ( !$rev->userCan( Revision::DELETED_TEXT, $this->getUser() ) ) {
904  $radio['disabled'] = 'disabled';
905  $checkmark = []; // We will check the next possible one
906  } elseif ( !$this->oldIdChecked ) {
907  $checkmark = [ 'checked' => 'checked' ];
908  $this->oldIdChecked = $id;
909  } else {
910  $checkmark = [];
911  }
912  $first = Xml::element( 'input',
913  array_merge( $radio, $checkmark, [
914  'name' => 'oldid',
915  'id' => "mw-oldid-$id" ] ) );
916  $checkmark = [];
917  }
918  $second = Xml::element( 'input',
919  array_merge( $radio, $checkmark, [
920  'name' => 'diff',
921  'id' => "mw-diff-$id" ] ) );
922 
923  return $first . $second;
924  } else {
925  return '';
926  }
927  }
928 
933  function preventClickjacking( $enable = true ) {
934  $this->preventClickjacking = $enable;
935  }
936 
943  }
944 
945 }
Class for generating clickable toggle links for a list of checkboxes.
Definition: ListToggle.php:31
addHelpLink($to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: Action.php:390
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
static revComment(Revision $rev, $local=false, $isPublic=false)
Wrap and format the given revision's comment block, if the current user is allowed to view it...
Definition: Linker.php:1551
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:776
getOutput()
Get the OutputPage being used for this instance.
Definition: Action.php:207
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1435
getLanguage()
Get the Language object.
static checkFeedOutput($type)
Check whether feeds can be used and that $type is a valid feed type.
Definition: FeedUtils.php:55
getStartBody()
Creates begin of history list with a submit button.
static buildTagFilterSelector($selected= '', $fullForm=false, Title $title=null, $ooui=false)
Build a text box to select a change tag.
Definition: ChangeTags.php:662
wfScript($script= 'index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
static element($element, $attribs=null, $contents= '', $allowShortTag=true)
Format an XML element with given attributes and, optionally, text content.
Definition: Xml.php:39
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
getTitle()
Shortcut to get the Title object from the page.
Definition: Action.php:246
curLink($rev, $latest)
Create a diff-to-current link for this revision for this page.
static getTitleFor($name, $subpage=false, $fragment= '')
Get a localised Title object for a specified special page name.
Definition: SpecialPage.php:80
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:210
globals txt Globals are evil The original MediaWiki code relied on globals for processing context far too often MediaWiki development since then has been a story of slowly moving context out of global variables and into objects Storing processing context in object member variables allows those objects to be reused in a much more flexible way Consider the elegance of
database rows
Definition: globals.txt:10
if(!isset($args[0])) $lang
getUser()
Shortcut to get the User being used for this instance.
Definition: Action.php:217
static formatRevisionSize($size)
Definition: Linker.php:1574
static hidden($name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:749
IndexPager with a formatted navigation bar.
bool stdClass $lastRow
submitButton($message, $attributes=[])
Creates a submit button.
Page view caching in the file system.
historyLine($row, $next, $notificationtimestamp=false, $latest=false, $firstInList=false)
Returns a row from the history printout.
preventClickjacking($enable=true)
This is called if a write operation is possible from the generated HTML.
static exists($name)
Check if a given action is recognised, even if it's disabled.
Definition: Action.php:169
static check($name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
Definition: Xml.php:324
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
static useFileCache(IContextSource $context)
Check if pages can be cached for this request/user.
static stripComment($text)
Quickie hack...
Definition: Feed.php:180
getTitle()
Get the Title object.
static tooltipAndAccesskeyAttribs($name, array $msgParams=[])
Returns the attributes for the tooltip and access key.
Definition: Linker.php:2240
lastLink($prevRev, $next)
Create a diff-to-previous link for this revision for this page.
static showLogExtract(&$out, $types=[], $page= '', $user= '', $param=[])
Show log extract.
the value to return A Title object or null for latest to be modified or replaced by the hook handler or if authentication is not possible after cache objects are set for highlighting & $link
Definition: hooks.txt:2621
static getLocalInstance($ts=false)
Get a timestamp instance in the server local timezone ($wgLocaltimezone)
$batch
Definition: linkcache.txt:23
$mIsFirst
True if the current result set is the first one.
Definition: IndexPager.php:111
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:32
$last
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
static fieldset($legend=false, $content=false, $attribs=[])
Shortcut for creating fieldsets.
Definition: Xml.php:578
msg()
Get a Message object with context set Parameters are the same as wfMessage()
onView()
Print the history page for an article.
static openElement($element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:248
preCacheMessages()
As we use the same small set of messages in various methods and that they are called often...
static formatSummaryRow($tags, $page, IContextSource $context=null)
Creates HTML for the given tags.
Definition: ChangeTags.php:45
__construct($historyPage, $year= '', $month= '', $tagFilter= '', $conds=[])
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned after processing after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a message
Definition: hooks.txt:1972
bool $showTagEditUI
Whether to show the tag editing UI.
getConfig()
Get the Config object.
static dateMenu($year, $month)
Definition: Xml.php:167
static showCharacterDifference($old, $new, IContextSource $context=null)
Show formatted char difference.
getContext()
Get the base IContextSource object.
$cache
Definition: mcc.php:33
static revDeleteLinkDisabled($delete=true)
Creates a dead (show/hide) link for deleting revisions/log entries.
Definition: Linker.php:2222
static selectFields()
Return the list of revision fields that should be selected to create a new revision.
Definition: Revision.php:429
static showTagEditingUI(User $user)
Indicate whether change tag editing UI is relevant.
const DELETED_RESTRICTED
Definition: Revision.php:79
const DB_SLAVE
Definition: Defines.php:46
Allows to change the fields on the form that will be generated are created Can be used to omit specific feeds from being outputted You must not use this hook to add use OutputPage::addFeedLink() instead.&$feedLinks conditions will AND in the final query as a Content object as a Content object $title
Definition: hooks.txt:312
static linkKnown($target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
Definition: Linker.php:255
getContext()
Get the IContextSource in use here.
Definition: Action.php:178
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1601
A base class for basic support for outputting syndication feeds in RSS and other formats.
Definition: Feed.php:38
revLink($rev)
Create a link to view this revision of the page.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
getPreventClickjacking()
Get the "prevent clickjacking" flag.
$page
Page on which we're performing the action.
Definition: Action.php:44
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
const DELETED_TEXT
Definition: Revision.php:76
static modifyDisplayQuery(&$tables, &$fields, &$conds, &$join_conds, &$options, $filter_tag=false)
Applies all tags-related changes to a query.
Definition: ChangeTags.php:615
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
An action which just does something, without showing a form first.
feedItem($row)
Generate a FeedItem object from a given revision table row Borrows Recent Changes' feed generation fu...
This class handles printing the history page for an article.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
static tags($element, $attribs=null, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:131
static submitButton($contents, array $attrs, array $modifiers=[])
Returns an HTML link element in a string styled as a button (when $wgUseMediaWikiUIEverywhere is enab...
Definition: Html.php:186
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2458
Overloads the relevant methods of the real ResultsWrapper so it doesn't go anywhere near an actual da...
static generateRollback($rev, IContextSource $context=null, $options=[ 'verify'])
Generate a rollback link for a given revision.
Definition: Linker.php:1762
diffButtons($rev, $firstInList)
Create radio buttons for page history.
array $message
Array of message keys and strings.
fetchRevisions($limit, $offset, $direction)
Fetch an array of revisions, specified by a given limit, offset and direction.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1020
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition: design.txt:56
static flag($flag, IContextSource $context=null)
Make an "<abbr>" element for a given change flag.
static getParentLengths($db, array $revIds)
Do a batched query to get the parent revision lengths.
Definition: Revision.php:527
static checkLabel($label, $name, $id, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox with a label.
Definition: Xml.php:420
static formatDiffRow($title, $oldid, $newid, $timestamp, $comment, $actiontext= '')
Really format a diff for the newsfeed.
Definition: FeedUtils.php:106
getRevisionButton($name, $msg)
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1816
feed($type)
Output a subscription feed listing recent edits to this page.
msg()
Get a Message object with context set Parameters are the same as wfMessage()
Definition: Action.php:256
static userJoinCond()
Return the value of a select() JOIN conds array for the user table.
Definition: Revision.php:410
getRequest()
Get the WebRequest being used for this instance.
Definition: Action.php:197
const NS_USER_TALK
Definition: Defines.php:72
static revUserTools($rev, $isPublic=false)
Generate a user tool link cluster if the current user is allowed to view it.
Definition: Linker.php:1142
getWikiPage()
Get the WikiPage object.
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:230
static selectUserFields()
Return the list of user fields that should be selected from user table.
Definition: Revision.php:517
getUser()
Get the User object.
static revDeleteLink($query=[], $restricted=false, $delete=true)
Creates a (show/hide) link for deleting revisions/log entries.
Definition: Linker.php:2200
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk page
Definition: hooks.txt:2376
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2376
if the prop value should be in the metadata multi language array format
Definition: hooks.txt:1490
getNumRows()
Get the number of rows in the result set.
Definition: IndexPager.php:552
getOutput()
Get the OutputPage object.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:310