MediaWiki  REL1_31
ContribsPager.php
Go to the documentation of this file.
1 <?php
30 
32 
34  public $messages;
35  public $target;
36  public $namespace = '';
37  public $mDb;
38  public $preventClickjacking = false;
39 
41  public $mDbSecondary;
42 
46  protected $mParentLens;
47 
51  protected $templateParser;
52 
54  parent::__construct( $context );
55 
56  $msgs = [
57  'diff',
58  'hist',
59  'pipe-separator',
60  'uctop'
61  ];
62 
63  foreach ( $msgs as $msg ) {
64  $this->messages[$msg] = $this->msg( $msg )->escaped();
65  }
66 
67  $this->target = isset( $options['target'] ) ? $options['target'] : '';
68  $this->contribs = isset( $options['contribs'] ) ? $options['contribs'] : 'users';
69  $this->namespace = isset( $options['namespace'] ) ? $options['namespace'] : '';
70  $this->tagFilter = isset( $options['tagfilter'] ) ? $options['tagfilter'] : false;
71  $this->nsInvert = isset( $options['nsInvert'] ) ? $options['nsInvert'] : false;
72  $this->associated = isset( $options['associated'] ) ? $options['associated'] : false;
73 
74  $this->deletedOnly = !empty( $options['deletedOnly'] );
75  $this->topOnly = !empty( $options['topOnly'] );
76  $this->newOnly = !empty( $options['newOnly'] );
77  $this->hideMinor = !empty( $options['hideMinor'] );
78 
79  // Date filtering: use timestamp if available
80  $startTimestamp = '';
81  $endTimestamp = '';
82  if ( $options['start'] ) {
83  $startTimestamp = $options['start'] . ' 00:00:00';
84  }
85  if ( $options['end'] ) {
86  $endTimestamp = $options['end'] . ' 23:59:59';
87  }
88  $this->getDateRangeCond( $startTimestamp, $endTimestamp );
89 
90  // This property on IndexPager is set by $this->getIndexField() in parent::__construct().
91  // We need to reassign it here so that it is used when the actual query is ran.
92  $this->mIndexField = $this->getIndexField();
93 
94  // Most of this code will use the 'contributions' group DB, which can map to replica DBs
95  // with extra user based indexes or partioning by user. The additional metadata
96  // queries should use a regular replica DB since the lookup pattern is not all by user.
97  $this->mDbSecondary = wfGetDB( DB_REPLICA ); // any random replica DB
98  $this->mDb = wfGetDB( DB_REPLICA, 'contributions' );
99  $this->templateParser = new TemplateParser();
100  }
101 
102  function getDefaultQuery() {
103  $query = parent::getDefaultQuery();
104  $query['target'] = $this->target;
105 
106  return $query;
107  }
108 
118  function reallyDoQuery( $offset, $limit, $descending ) {
119  list( $tables, $fields, $conds, $fname, $options, $join_conds ) = $this->buildQueryInfo(
120  $offset,
121  $limit,
122  $descending
123  );
124 
125  /*
126  * This hook will allow extensions to add in additional queries, so they can get their data
127  * in My Contributions as well. Extensions should append their results to the $data array.
128  *
129  * Extension queries have to implement the navbar requirement as well. They should
130  * - have a column aliased as $pager->getIndexField()
131  * - have LIMIT set
132  * - have a WHERE-clause that compares the $pager->getIndexField()-equivalent column to the offset
133  * - have the ORDER BY specified based upon the details provided by the navbar
134  *
135  * See includes/Pager.php buildQueryInfo() method on how to build LIMIT, WHERE & ORDER BY
136  *
137  * &$data: an array of results of all contribs queries
138  * $pager: the ContribsPager object hooked into
139  * $offset: see phpdoc above
140  * $limit: see phpdoc above
141  * $descending: see phpdoc above
142  */
143  $data = [ $this->mDb->select(
144  $tables, $fields, $conds, $fname, $options, $join_conds
145  ) ];
146  Hooks::run(
147  'ContribsPager::reallyDoQuery',
148  [ &$data, $this, $offset, $limit, $descending ]
149  );
150 
151  $result = [];
152 
153  // loop all results and collect them in an array
154  foreach ( $data as $query ) {
155  foreach ( $query as $i => $row ) {
156  // use index column as key, allowing us to easily sort in PHP
157  $result[$row->{$this->getIndexField()} . "-$i"] = $row;
158  }
159  }
160 
161  // sort results
162  if ( $descending ) {
163  ksort( $result );
164  } else {
165  krsort( $result );
166  }
167 
168  // enforce limit
169  $result = array_slice( $result, 0, $limit );
170 
171  // get rid of array keys
172  $result = array_values( $result );
173 
174  return new FakeResultWrapper( $result );
175  }
176 
177  function getQueryInfo() {
178  $revQuery = Revision::getQueryInfo( [ 'page', 'user' ] );
179  $queryInfo = [
180  'tables' => $revQuery['tables'],
181  'fields' => array_merge( $revQuery['fields'], [ 'page_is_new' ] ),
182  'conds' => [],
183  'options' => [],
184  'join_conds' => $revQuery['joins'],
185  ];
186 
187  if ( $this->contribs == 'newbie' ) {
188  $max = $this->mDb->selectField( 'user', 'max(user_id)', '', __METHOD__ );
189  $queryInfo['conds'][] = $revQuery['fields']['rev_user'] . ' >' . (int)( $max - $max / 100 );
190  # ignore local groups with the bot right
191  # @todo FIXME: Global groups may have 'bot' rights
192  $groupsWithBotPermission = User::getGroupsWithPermission( 'bot' );
193  if ( count( $groupsWithBotPermission ) ) {
194  $queryInfo['tables'][] = 'user_groups';
195  $queryInfo['conds'][] = 'ug_group IS NULL';
196  $queryInfo['join_conds']['user_groups'] = [
197  'LEFT JOIN', [
198  'ug_user = ' . $revQuery['fields']['rev_user'],
199  'ug_group' => $groupsWithBotPermission,
200  'ug_expiry IS NULL OR ug_expiry >= ' .
201  $this->mDb->addQuotes( $this->mDb->timestamp() )
202  ]
203  ];
204  }
205  // (T140537) Disallow looking too far in the past for 'newbies' queries. If the user requested
206  // a timestamp offset far in the past such that there are no edits by users with user_ids in
207  // the range, we would end up scanning all revisions from that offset until start of time.
208  $queryInfo['conds'][] = 'rev_timestamp > ' .
209  $this->mDb->addQuotes( $this->mDb->timestamp( wfTimestamp() - 30 * 24 * 60 * 60 ) );
210  } else {
211  $user = User::newFromName( $this->target, false );
212  $ipRangeConds = $user->isAnon() ? $this->getIpRangeConds( $this->mDb, $this->target ) : null;
213  if ( $ipRangeConds ) {
214  $queryInfo['tables'][] = 'ip_changes';
215  $queryInfo['join_conds']['ip_changes'] = [
216  'LEFT JOIN', [ 'ipc_rev_id = rev_id' ]
217  ];
218  $queryInfo['conds'][] = $ipRangeConds;
219  } else {
220  // tables and joins are already handled by Revision::getQueryInfo()
221  $conds = ActorMigration::newMigration()->getWhere( $this->mDb, 'rev_user', $user );
222  $queryInfo['conds'][] = $conds['conds'];
223  // Force the appropriate index to avoid bad query plans (T189026)
224  if ( count( $conds['orconds'] ) === 1 ) {
225  if ( isset( $conds['orconds']['actor'] ) ) {
226  // @todo: This will need changing when revision_comment_temp goes away
227  $queryInfo['options']['USE INDEX']['temp_rev_user'] = 'actor_timestamp';
228  } else {
229  $queryInfo['options']['USE INDEX']['revision'] =
230  isset( $conds['orconds']['userid'] ) ? 'user_timestamp' : 'usertext_timestamp';
231  }
232  }
233  }
234  }
235 
236  if ( $this->deletedOnly ) {
237  $queryInfo['conds'][] = 'rev_deleted != 0';
238  }
239 
240  if ( $this->topOnly ) {
241  $queryInfo['conds'][] = 'rev_id = page_latest';
242  }
243 
244  if ( $this->newOnly ) {
245  $queryInfo['conds'][] = 'rev_parent_id = 0';
246  }
247 
248  if ( $this->hideMinor ) {
249  $queryInfo['conds'][] = 'rev_minor_edit = 0';
250  }
251 
252  $user = $this->getUser();
253  $queryInfo['conds'] = array_merge( $queryInfo['conds'], $this->getNamespaceCond() );
254 
255  // Paranoia: avoid brute force searches (T19342)
256  if ( !$user->isAllowed( 'deletedhistory' ) ) {
257  $queryInfo['conds'][] = $this->mDb->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0';
258  } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
259  $queryInfo['conds'][] = $this->mDb->bitAnd( 'rev_deleted', Revision::SUPPRESSED_USER ) .
260  ' != ' . Revision::SUPPRESSED_USER;
261  }
262 
263  // For IPv6, we use ipc_rev_timestamp on ip_changes as the index field,
264  // which will be referenced when parsing the results of a query.
265  if ( self::isQueryableRange( $this->target ) ) {
266  $queryInfo['fields'][] = 'ipc_rev_timestamp';
267  }
268 
270  $queryInfo['tables'],
271  $queryInfo['fields'],
272  $queryInfo['conds'],
273  $queryInfo['join_conds'],
274  $queryInfo['options'],
275  $this->tagFilter
276  );
277 
278  // Avoid PHP 7.1 warning from passing $this by reference
279  $pager = $this;
280  Hooks::run( 'ContribsPager::getQueryInfo', [ &$pager, &$queryInfo ] );
281 
282  return $queryInfo;
283  }
284 
285  function getNamespaceCond() {
286  if ( $this->namespace !== '' ) {
287  $selectedNS = $this->mDb->addQuotes( $this->namespace );
288  $eq_op = $this->nsInvert ? '!=' : '=';
289  $bool_op = $this->nsInvert ? 'AND' : 'OR';
290 
291  if ( !$this->associated ) {
292  return [ "page_namespace $eq_op $selectedNS" ];
293  }
294 
295  $associatedNS = $this->mDb->addQuotes(
296  MWNamespace::getAssociated( $this->namespace )
297  );
298 
299  return [
300  "page_namespace $eq_op $selectedNS " .
301  $bool_op .
302  " page_namespace $eq_op $associatedNS"
303  ];
304  }
305 
306  return [];
307  }
308 
315  private function getIpRangeConds( $db, $ip ) {
316  // First make sure it is a valid range and they are not outside the CIDR limit
317  if ( !$this->isQueryableRange( $ip ) ) {
318  return false;
319  }
320 
321  list( $start, $end ) = IP::parseRange( $ip );
322 
323  return 'ipc_hex BETWEEN ' . $db->addQuotes( $start ) . ' AND ' . $db->addQuotes( $end );
324  }
325 
333  public function isQueryableRange( $ipRange ) {
334  $limits = $this->getConfig()->get( 'RangeContributionsCIDRLimit' );
335 
336  $bits = IP::parseCIDR( $ipRange )[1];
337  if (
338  ( $bits === false ) ||
339  ( IP::isIPv4( $ipRange ) && $bits < $limits['IPv4'] ) ||
340  ( IP::isIPv6( $ipRange ) && $bits < $limits['IPv6'] )
341  ) {
342  return false;
343  }
344 
345  return true;
346  }
347 
354  public function getIndexField() {
355  if ( $this->isQueryableRange( $this->target ) ) {
356  return 'ipc_rev_timestamp';
357  } else {
358  return 'rev_timestamp';
359  }
360  }
361 
362  function doBatchLookups() {
363  # Do a link batch query
364  $this->mResult->seek( 0 );
365  $parentRevIds = [];
366  $this->mParentLens = [];
367  $batch = new LinkBatch();
368  $isIpRange = $this->isQueryableRange( $this->target );
369  # Give some pointers to make (last) links
370  foreach ( $this->mResult as $row ) {
371  if ( isset( $row->rev_parent_id ) && $row->rev_parent_id ) {
372  $parentRevIds[] = $row->rev_parent_id;
373  }
374  if ( isset( $row->rev_id ) ) {
375  $this->mParentLens[$row->rev_id] = $row->rev_len;
376  if ( $this->contribs === 'newbie' ) { // multiple users
377  $batch->add( NS_USER, $row->user_name );
378  $batch->add( NS_USER_TALK, $row->user_name );
379  } elseif ( $isIpRange ) {
380  // If this is an IP range, batch the IP's talk page
381  $batch->add( NS_USER_TALK, $row->rev_user_text );
382  }
383  $batch->add( $row->page_namespace, $row->page_title );
384  }
385  }
386  # Fetch rev_len for revisions not already scanned above
387  $this->mParentLens += Revision::getParentLengths(
388  $this->mDbSecondary,
389  array_diff( $parentRevIds, array_keys( $this->mParentLens ) )
390  );
391  $batch->execute();
392  $this->mResult->seek( 0 );
393  }
394 
398  function getStartBody() {
399  return "<ul class=\"mw-contributions-list\">\n";
400  }
401 
405  function getEndBody() {
406  return "</ul>\n";
407  }
408 
421  function formatRow( $row ) {
422  $ret = '';
423  $classes = [];
424  $attribs = [];
425 
426  $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
427 
428  /*
429  * There may be more than just revision rows. To make sure that we'll only be processing
430  * revisions here, let's _try_ to build a revision out of our row (without displaying
431  * notices though) and then trying to grab data from the built object. If we succeed,
432  * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
433  * to extensions to subscribe to the hook to parse the row.
434  */
435  Wikimedia\suppressWarnings();
436  try {
437  $rev = new Revision( $row );
438  $validRevision = (bool)$rev->getId();
439  } catch ( Exception $e ) {
440  $validRevision = false;
441  }
442  Wikimedia\restoreWarnings();
443 
444  if ( $validRevision ) {
445  $attribs['data-mw-revid'] = $rev->getId();
446 
447  $page = Title::newFromRow( $row );
448  $link = $linkRenderer->makeLink(
449  $page,
450  $page->getPrefixedText(),
451  [ 'class' => 'mw-contributions-title' ],
452  $page->isRedirect() ? [ 'redirect' => 'no' ] : []
453  );
454  # Mark current revisions
455  $topmarktext = '';
456  $user = $this->getUser();
457 
458  if ( $row->rev_id === $row->page_latest ) {
459  $topmarktext .= '<span class="mw-uctop">' . $this->messages['uctop'] . '</span>';
460  $classes[] = 'mw-contributions-current';
461  # Add rollback link
462  if ( !$row->page_is_new && $page->quickUserCan( 'rollback', $user )
463  && $page->quickUserCan( 'edit', $user )
464  ) {
465  $this->preventClickjacking();
466  $topmarktext .= ' ' . Linker::generateRollback( $rev, $this->getContext() );
467  }
468  }
469  # Is there a visible previous revision?
470  if ( $rev->userCan( Revision::DELETED_TEXT, $user ) && $rev->getParentId() !== 0 ) {
471  $difftext = $linkRenderer->makeKnownLink(
472  $page,
473  new HtmlArmor( $this->messages['diff'] ),
474  [ 'class' => 'mw-changeslist-diff' ],
475  [
476  'diff' => 'prev',
477  'oldid' => $row->rev_id
478  ]
479  );
480  } else {
481  $difftext = $this->messages['diff'];
482  }
483  $histlink = $linkRenderer->makeKnownLink(
484  $page,
485  new HtmlArmor( $this->messages['hist'] ),
486  [ 'class' => 'mw-changeslist-history' ],
487  [ 'action' => 'history' ]
488  );
489 
490  if ( $row->rev_parent_id === null ) {
491  // For some reason rev_parent_id isn't populated for this row.
492  // Its rumoured this is true on wikipedia for some revisions (T36922).
493  // Next best thing is to have the total number of bytes.
494  $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
495  $chardiff .= Linker::formatRevisionSize( $row->rev_len );
496  $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
497  } else {
498  $parentLen = 0;
499  if ( isset( $this->mParentLens[$row->rev_parent_id] ) ) {
500  $parentLen = $this->mParentLens[$row->rev_parent_id];
501  }
502 
503  $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
505  $parentLen,
506  $row->rev_len,
507  $this->getContext()
508  );
509  $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
510  }
511 
512  $lang = $this->getLanguage();
513  $comment = $lang->getDirMark() . Linker::revComment( $rev, false, true );
514  $date = $lang->userTimeAndDate( $row->rev_timestamp, $user );
515  if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) {
516  $d = $linkRenderer->makeKnownLink(
517  $page,
518  $date,
519  [ 'class' => 'mw-changeslist-date' ],
520  [ 'oldid' => intval( $row->rev_id ) ]
521  );
522  } else {
523  $d = htmlspecialchars( $date );
524  }
525  if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
526  $d = '<span class="history-deleted">' . $d . '</span>';
527  }
528 
529  # Show user names for /newbies as there may be different users.
530  # Note that only unprivileged users have rows with hidden user names excluded.
531  # When querying for an IP range, we want to always show user and user talk links.
532  $userlink = '';
533  if ( ( $this->contribs == 'newbie' && !$rev->isDeleted( Revision::DELETED_USER ) )
534  || $this->isQueryableRange( $this->target ) ) {
535  $userlink = ' . . ' . $lang->getDirMark()
536  . Linker::userLink( $rev->getUser(), $rev->getUserText() );
537  $userlink .= ' ' . $this->msg( 'parentheses' )->rawParams(
538  Linker::userTalkLink( $rev->getUser(), $rev->getUserText() ) )->escaped() . ' ';
539  }
540 
541  $flags = [];
542  if ( $rev->getParentId() === 0 ) {
543  $flags[] = ChangesList::flag( 'newpage' );
544  }
545 
546  if ( $rev->isMinor() ) {
547  $flags[] = ChangesList::flag( 'minor' );
548  }
549 
550  $del = Linker::getRevDeleteLink( $user, $rev, $page );
551  if ( $del !== '' ) {
552  $del .= ' ';
553  }
554 
555  $diffHistLinks = $this->msg( 'parentheses' )
556  ->rawParams( $difftext . $this->messages['pipe-separator'] . $histlink )
557  ->escaped();
558 
559  # Tags, if any.
560  list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow(
561  $row->ts_tags,
562  'contributions',
563  $this->getContext()
564  );
565  $classes = array_merge( $classes, $newClasses );
566 
567  Hooks::run( 'SpecialContributions::formatRow::flags', [ $this->getContext(), $row, &$flags ] );
568 
569  $templateParams = [
570  'del' => $del,
571  'timestamp' => $d,
572  'diffHistLinks' => $diffHistLinks,
573  'charDifference' => $chardiff,
574  'flags' => $flags,
575  'articleLink' => $link,
576  'userlink' => $userlink,
577  'logText' => $comment,
578  'topmarktext' => $topmarktext,
579  'tagSummary' => $tagSummary,
580  ];
581 
582  # Denote if username is redacted for this edit
583  if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
584  $templateParams['rev-deleted-user-contribs'] =
585  $this->msg( 'rev-deleted-user-contribs' )->escaped();
586  }
587 
588  $ret = $this->templateParser->processTemplate(
589  'SpecialContributionsLine',
590  $templateParams
591  );
592  }
593 
594  // Let extensions add data
595  Hooks::run( 'ContributionsLineEnding', [ $this, &$ret, $row, &$classes, &$attribs ] );
596  $attribs = wfArrayFilterByKey( $attribs, [ Sanitizer::class, 'isReservedDataAttribute' ] );
597 
598  // TODO: Handle exceptions in the catch block above. Do any extensions rely on
599  // receiving empty rows?
600 
601  if ( $classes === [] && $attribs === [] && $ret === '' ) {
602  wfDebug( "Dropping Special:Contribution row that could not be formatted\n" );
603  return "<!-- Could not format Special:Contribution row. -->\n";
604  }
605  $attribs['class'] = $classes;
606 
607  // FIXME: The signature of the ContributionsLineEnding hook makes it
608  // very awkward to move this LI wrapper into the template.
609  return Html::rawElement( 'li', $attribs, $ret ) . "\n";
610  }
611 
616  function getSqlComment() {
617  if ( $this->namespace || $this->deletedOnly ) {
618  // potentially slow, see CR r58153
619  return 'contributions page filtered for namespace or RevisionDeleted edits';
620  } else {
621  return 'contributions page unfiltered';
622  }
623  }
624 
625  protected function preventClickjacking() {
626  $this->preventClickjacking = true;
627  }
628 
632  public function getPreventClickjacking() {
633  return $this->preventClickjacking;
634  }
635 
642  public static function processDateFilter( array $opts ) {
643  $start = isset( $opts['start'] ) ? $opts['start'] : '';
644  $end = isset( $opts['end'] ) ? $opts['end'] : '';
645  $year = isset( $opts['year'] ) ? $opts['year'] : '';
646  $month = isset( $opts['month'] ) ? $opts['month'] : '';
647 
648  if ( $start !== '' && $end !== '' && $start > $end ) {
649  $temp = $start;
650  $start = $end;
651  $end = $temp;
652  }
653 
654  // If year/month legacy filtering options are set, convert them to display the new stamp
655  if ( $year !== '' || $month !== '' ) {
656  // Reuse getDateCond logic, but subtract a day because
657  // the endpoints of our date range appear inclusive
658  // but the internal end offsets are always exclusive
659  $legacyTimestamp = ReverseChronologicalPager::getOffsetDate( $year, $month );
660  $legacyDateTime = new DateTime( $legacyTimestamp->getTimestamp( TS_ISO_8601 ) );
661  $legacyDateTime = $legacyDateTime->modify( '-1 day' );
662 
663  // Clear the new timestamp range options if used and
664  // replace with the converted legacy timestamp
665  $start = '';
666  $end = $legacyDateTime->format( 'Y-m-d' );
667  }
668 
669  $opts['start'] = $start;
670  $opts['end'] = $end;
671 
672  return $opts;
673  }
674 }
ReverseChronologicalPager\getOffsetDate
static getOffsetDate( $year, $month, $day=-1)
Core logic of determining the mOffset timestamp such that we can get all items with a timestamp up to...
Definition: ReverseChronologicalPager.php:116
$user
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 account $user
Definition: hooks.txt:247
Revision\DELETED_USER
const DELETED_USER
Definition: Revision.php:49
ContextSource\$context
IContextSource $context
Definition: ContextSource.php:33
HtmlArmor
Marks HTML that shouldn't be escaped.
Definition: HtmlArmor.php:28
Linker\userTalkLink
static userTalkLink( $userId, $userText)
Definition: Linker.php:1003
ContribsPager\$namespace
$namespace
Definition: ContribsPager.php:36
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
ContribsPager\$messages
$messages
Definition: ContribsPager.php:34
Linker\userLink
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:893
array
the array() calling protocol came about after MediaWiki 1.4rc1.
$lang
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
ContribsPager\reallyDoQuery
reallyDoQuery( $offset, $limit, $descending)
This method basically executes the exact same code as the parent class, though with a hook added,...
Definition: ContribsPager.php:118
ContextSource\msg
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:168
ContribsPager\__construct
__construct(IContextSource $context, array $options)
Definition: ContribsPager.php:53
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
$ret
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 & $ret
Definition: hooks.txt:2005
ContribsPager\getDefaultQuery
getDefaultQuery()
Get an array of query parameters that should be put into self-links.
Definition: ContribsPager.php:102
ContribsPager\getSqlComment
getSqlComment()
Overwrite Pager function and return a helpful comment.
Definition: ContribsPager.php:616
ContribsPager\formatRow
formatRow( $row)
Generates each row in the contributions list.
Definition: ContribsPager.php:421
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
IP\isIPv6
static isIPv6( $ip)
Given a string, determine if it as valid IP in IPv6 only.
Definition: IP.php:88
ContribsPager\$mDbSecondary
IDatabase $mDbSecondary
Definition: ContribsPager.php:41
wfArrayFilterByKey
wfArrayFilterByKey(array $arr, callable $callback)
Like array_filter with ARRAY_FILTER_USE_KEY, but works pre-5.6.
Definition: GlobalFunctions.php:168
$linkRenderer
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 after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition: hooks.txt:2056
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
Wikimedia\Rdbms\FakeResultWrapper
Overloads the relevant methods of the real ResultsWrapper so it doesn't go anywhere near an actual da...
Definition: FakeResultWrapper.php:11
getContext
getContext()
ContribsPager\doBatchLookups
doBatchLookups()
Called from getBody(), before getStartBody() is called and after doQuery() was called.
Definition: ContribsPager.php:362
$revQuery
$revQuery
Definition: testCompression.php:51
ActorMigration\newMigration
static newMigration()
Static constructor.
Definition: ActorMigration.php:89
php
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:37
ContribsPager\processDateFilter
static processDateFilter(array $opts)
Set up date filter options, given request data.
Definition: ContribsPager.php:642
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
Revision
Definition: Revision.php:41
ContribsPager\getPreventClickjacking
getPreventClickjacking()
Definition: ContribsPager.php:632
ChangeTags\modifyDisplayQuery
static modifyDisplayQuery(&$tables, &$fields, &$conds, &$join_conds, &$options, $filter_tag='')
Applies all tags-related changes to a query.
Definition: ChangeTags.php:723
Revision\SUPPRESSED_USER
const SUPPRESSED_USER
Definition: Revision.php:51
ContribsPager\getNamespaceCond
getNamespaceCond()
Definition: ContribsPager.php:285
Revision\getQueryInfo
static getQueryInfo( $options=[])
Return the tables, fields, and join conditions to be selected to create a new revision object.
Definition: Revision.php:492
messages
passed in as a query string parameter to the various URLs constructed here(i.e. $prevlink) $ldel you ll need to handle error messages
Definition: hooks.txt:1275
Linker\generateRollback
static generateRollback( $rev, IContextSource $context=null, $options=[ 'verify'])
Generate a rollback link for a given revision.
Definition: Linker.php:1706
if
if(file_exists("$IP/StartProfiler.php"))
Definition: Setup.php:42
Wikimedia\Rdbms\IResultWrapper
Result wrapper for grabbing data queried from an IDatabase object.
Definition: IResultWrapper.php:24
ContribsPager\getStartBody
getStartBody()
Definition: ContribsPager.php:398
Title\newFromRow
static newFromRow( $row)
Make a Title object from a DB row.
Definition: Title.php:464
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
RangeChronologicalPager\getDateRangeCond
getDateRangeCond( $startStamp, $endStamp)
Set and return a date range condition using timestamps provided by the user.
Definition: RangeChronologicalPager.php:42
ContribsPager\$mDefaultDirection
$mDefaultDirection
Definition: ContribsPager.php:33
ContribsPager\$target
$target
Definition: ContribsPager.php:35
ChangesList\flag
static flag( $flag, IContextSource $context=null)
Make an "<abbr>" element for a given change flag.
Definition: ChangesList.php:228
$link
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:3021
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
list
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
RangeChronologicalPager
Pager for filtering by a range of dates.
Definition: RangeChronologicalPager.php:27
$fname
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
Definition: Setup.php:112
$options
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 & $options
Definition: hooks.txt:2001
ContribsPager
Definition: ContribsPager.php:31
$attribs
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:2014
Linker\revComment
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:1480
ContribsPager\isQueryableRange
isQueryableRange( $ipRange)
Is the given IP a range and within the CIDR limit?
Definition: ContribsPager.php:333
NS_USER_TALK
const NS_USER_TALK
Definition: Defines.php:77
ContribsPager\$preventClickjacking
$preventClickjacking
Definition: ContribsPager.php:38
Revision\getParentLengths
static getParentLengths( $db, array $revIds)
Do a batched query to get the parent revision lengths.
Definition: Revision.php:519
IP\parseRange
static parseRange( $range)
Given a string range in a number of formats, return the start and end of the range in hexadecimal.
Definition: IP.php:513
Linker\getRevDeleteLink
static getRevDeleteLink(User $user, Revision $rev, Title $title)
Get a revision-deletion link, or disabled link, or nothing, depending on user permissions & the setti...
Definition: Linker.php:2053
ContribsPager\$templateParser
TemplateParser $templateParser
Definition: ContribsPager.php:51
Linker\formatRevisionSize
static formatRevisionSize( $size)
Definition: Linker.php:1503
ChangesList\showCharacterDifference
static showCharacterDifference( $old, $new, IContextSource $context=null)
Show formatted char difference.
Definition: ChangesList.php:289
IP\isIPv4
static isIPv4( $ip)
Given a string, determine if it as valid IP in IPv4 only.
Definition: IP.php:99
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
IP\parseCIDR
static parseCIDR( $range)
Convert a network specification in CIDR notation to an integer network and a number of bits.
Definition: IP.php:470
IndexPager\DIR_DESCENDING
const DIR_DESCENDING
Definition: IndexPager.php:76
$rev
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:1777
$tables
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist & $tables
Definition: hooks.txt:1015
as
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:22
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
NS_USER
const NS_USER
Definition: Defines.php:76
$batch
$batch
Definition: linkcache.txt:23
ContribsPager\getIpRangeConds
getIpRangeConds( $db, $ip)
Get SQL conditions for an IP range, if applicable.
Definition: ContribsPager.php:315
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
ContribsPager\$mDb
$mDb
Definition: ContribsPager.php:37
ContribsPager\getEndBody
getEndBody()
Definition: ContribsPager.php:405
ContribsPager\getQueryInfo
getQueryInfo()
This function should be overridden to provide all parameters needed for the main paged query.
Definition: ContribsPager.php:177
MediaWikiServices
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 MediaWikiServices
Definition: injection.txt:25
$query
null for the 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:1620
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
ContribsPager\preventClickjacking
preventClickjacking()
Definition: ContribsPager.php:625
MWNamespace\getAssociated
static getAssociated( $index)
Get the associated namespace.
Definition: MWNamespace.php:162
ContribsPager\getIndexField
getIndexField()
Override of getIndexField() in IndexPager.
Definition: ContribsPager.php:354
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
ChangeTags\formatSummaryRow
static formatSummaryRow( $tags, $page, IContextSource $context=null)
Creates HTML for the given tags.
Definition: ChangeTags.php:88
Revision\DELETED_TEXT
const DELETED_TEXT
Definition: Revision.php:47
ContribsPager\$mParentLens
array $mParentLens
Definition: ContribsPager.php:46
User\getGroupsWithPermission
static getGroupsWithPermission( $role)
Get all the groups who have a given permission.
Definition: User.php:4982
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171
RangeChronologicalPager\buildQueryInfo
buildQueryInfo( $offset, $limit, $descending)
Build variables to use by the database wrapper.
Definition: RangeChronologicalPager.php:101