MediaWiki  1.28.1
ContribsPager.php
Go to the documentation of this file.
1 <?php
27 
29  public $messages;
30  public $target;
31  public $namespace = '';
32  public $mDb;
33  public $preventClickjacking = false;
34 
36  public $mDbSecondary;
37 
41  protected $mParentLens;
42 
44  parent::__construct( $context );
45 
46  $msgs = [
47  'diff',
48  'hist',
49  'pipe-separator',
50  'uctop'
51  ];
52 
53  foreach ( $msgs as $msg ) {
54  $this->messages[$msg] = $this->msg( $msg )->escaped();
55  }
56 
57  $this->target = isset( $options['target'] ) ? $options['target'] : '';
58  $this->contribs = isset( $options['contribs'] ) ? $options['contribs'] : 'users';
59  $this->namespace = isset( $options['namespace'] ) ? $options['namespace'] : '';
60  $this->tagFilter = isset( $options['tagfilter'] ) ? $options['tagfilter'] : false;
61  $this->nsInvert = isset( $options['nsInvert'] ) ? $options['nsInvert'] : false;
62  $this->associated = isset( $options['associated'] ) ? $options['associated'] : false;
63 
64  $this->deletedOnly = !empty( $options['deletedOnly'] );
65  $this->topOnly = !empty( $options['topOnly'] );
66  $this->newOnly = !empty( $options['newOnly'] );
67  $this->hideMinor = !empty( $options['hideMinor'] );
68 
69  $year = isset( $options['year'] ) ? $options['year'] : false;
70  $month = isset( $options['month'] ) ? $options['month'] : false;
71  $this->getDateCond( $year, $month );
72 
73  // Most of this code will use the 'contributions' group DB, which can map to replica DBs
74  // with extra user based indexes or partioning by user. The additional metadata
75  // queries should use a regular replica DB since the lookup pattern is not all by user.
76  $this->mDbSecondary = wfGetDB( DB_REPLICA ); // any random replica DB
77  $this->mDb = wfGetDB( DB_REPLICA, 'contributions' );
78  }
79 
81  $query = parent::getDefaultQuery();
82  $query['target'] = $this->target;
83 
84  return $query;
85  }
86 
96  function reallyDoQuery( $offset, $limit, $descending ) {
97  list( $tables, $fields, $conds, $fname, $options, $join_conds ) = $this->buildQueryInfo(
98  $offset,
99  $limit,
100  $descending
101  );
102 
103  /*
104  * This hook will allow extensions to add in additional queries, so they can get their data
105  * in My Contributions as well. Extensions should append their results to the $data array.
106  *
107  * Extension queries have to implement the navbar requirement as well. They should
108  * - have a column aliased as $pager->getIndexField()
109  * - have LIMIT set
110  * - have a WHERE-clause that compares the $pager->getIndexField()-equivalent column to the offset
111  * - have the ORDER BY specified based upon the details provided by the navbar
112  *
113  * See includes/Pager.php buildQueryInfo() method on how to build LIMIT, WHERE & ORDER BY
114  *
115  * &$data: an array of results of all contribs queries
116  * $pager: the ContribsPager object hooked into
117  * $offset: see phpdoc above
118  * $limit: see phpdoc above
119  * $descending: see phpdoc above
120  */
121  $data = [ $this->mDb->select(
122  $tables, $fields, $conds, $fname, $options, $join_conds
123  ) ];
124  Hooks::run(
125  'ContribsPager::reallyDoQuery',
126  [ &$data, $this, $offset, $limit, $descending ]
127  );
128 
129  $result = [];
130 
131  // loop all results and collect them in an array
132  foreach ( $data as $query ) {
133  foreach ( $query as $i => $row ) {
134  // use index column as key, allowing us to easily sort in PHP
135  $result[$row->{$this->getIndexField()} . "-$i"] = $row;
136  }
137  }
138 
139  // sort results
140  if ( $descending ) {
141  ksort( $result );
142  } else {
143  krsort( $result );
144  }
145 
146  // enforce limit
147  $result = array_slice( $result, 0, $limit );
148 
149  // get rid of array keys
150  $result = array_values( $result );
151 
152  return new FakeResultWrapper( $result );
153  }
154 
155  function getQueryInfo() {
156  list( $tables, $index, $userCond, $join_cond ) = $this->getUserCond();
157 
158  $user = $this->getUser();
159  $conds = array_merge( $userCond, $this->getNamespaceCond() );
160 
161  // Paranoia: avoid brute force searches (bug 17342)
162  if ( !$user->isAllowed( 'deletedhistory' ) ) {
163  $conds[] = $this->mDb->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0';
164  } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
165  $conds[] = $this->mDb->bitAnd( 'rev_deleted', Revision::SUPPRESSED_USER ) .
166  ' != ' . Revision::SUPPRESSED_USER;
167  }
168 
169  # Don't include orphaned revisions
170  $join_cond['page'] = Revision::pageJoinCond();
171  # Get the current user name for accounts
172  $join_cond['user'] = Revision::userJoinCond();
173 
174  $options = [];
175  if ( $index ) {
176  $options['USE INDEX'] = [ 'revision' => $index ];
177  }
178 
179  $queryInfo = [
180  'tables' => $tables,
181  'fields' => array_merge(
184  [ 'page_namespace', 'page_title', 'page_is_new',
185  'page_latest', 'page_is_redirect', 'page_len' ]
186  ),
187  'conds' => $conds,
188  'options' => $options,
189  'join_conds' => $join_cond
190  ];
191 
193  $queryInfo['tables'],
194  $queryInfo['fields'],
195  $queryInfo['conds'],
196  $queryInfo['join_conds'],
197  $queryInfo['options'],
198  $this->tagFilter
199  );
200 
201  Hooks::run( 'ContribsPager::getQueryInfo', [ &$this, &$queryInfo ] );
202 
203  return $queryInfo;
204  }
205 
206  function getUserCond() {
207  $condition = [];
208  $join_conds = [];
209  $tables = [ 'revision', 'page', 'user' ];
210  $index = false;
211  if ( $this->contribs == 'newbie' ) {
212  $max = $this->mDb->selectField( 'user', 'max(user_id)', false, __METHOD__ );
213  $condition[] = 'rev_user >' . (int)( $max - $max / 100 );
214  # ignore local groups with the bot right
215  # @todo FIXME: Global groups may have 'bot' rights
216  $groupsWithBotPermission = User::getGroupsWithPermission( 'bot' );
217  if ( count( $groupsWithBotPermission ) ) {
218  $tables[] = 'user_groups';
219  $condition[] = 'ug_group IS NULL';
220  $join_conds['user_groups'] = [
221  'LEFT JOIN', [
222  'ug_user = rev_user',
223  'ug_group' => $groupsWithBotPermission
224  ]
225  ];
226  }
227  // (T140537) Disallow looking too far in the past for 'newbies' queries. If the user requested
228  // a timestamp offset far in the past such that there are no edits by users with user_ids in
229  // the range, we would end up scanning all revisions from that offset until start of time.
230  $condition[] = 'rev_timestamp > ' .
231  $this->mDb->addQuotes( $this->mDb->timestamp( wfTimestamp() - 30 * 24 * 60 * 60 ) );
232  } else {
233  $uid = User::idFromName( $this->target );
234  if ( $uid ) {
235  $condition['rev_user'] = $uid;
236  $index = 'user_timestamp';
237  } else {
238  $condition['rev_user_text'] = $this->target;
239  $index = 'usertext_timestamp';
240  }
241  }
242 
243  if ( $this->deletedOnly ) {
244  $condition[] = 'rev_deleted != 0';
245  }
246 
247  if ( $this->topOnly ) {
248  $condition[] = 'rev_id = page_latest';
249  }
250 
251  if ( $this->newOnly ) {
252  $condition[] = 'rev_parent_id = 0';
253  }
254 
255  if ( $this->hideMinor ) {
256  $condition[] = 'rev_minor_edit = 0';
257  }
258 
259  return [ $tables, $index, $condition, $join_conds ];
260  }
261 
262  function getNamespaceCond() {
263  if ( $this->namespace !== '' ) {
264  $selectedNS = $this->mDb->addQuotes( $this->namespace );
265  $eq_op = $this->nsInvert ? '!=' : '=';
266  $bool_op = $this->nsInvert ? 'AND' : 'OR';
267 
268  if ( !$this->associated ) {
269  return [ "page_namespace $eq_op $selectedNS" ];
270  }
271 
272  $associatedNS = $this->mDb->addQuotes(
273  MWNamespace::getAssociated( $this->namespace )
274  );
275 
276  return [
277  "page_namespace $eq_op $selectedNS " .
278  $bool_op .
279  " page_namespace $eq_op $associatedNS"
280  ];
281  }
282 
283  return [];
284  }
285 
286  function getIndexField() {
287  return 'rev_timestamp';
288  }
289 
290  function doBatchLookups() {
291  # Do a link batch query
292  $this->mResult->seek( 0 );
293  $parentRevIds = [];
294  $this->mParentLens = [];
295  $batch = new LinkBatch();
296  # Give some pointers to make (last) links
297  foreach ( $this->mResult as $row ) {
298  if ( isset( $row->rev_parent_id ) && $row->rev_parent_id ) {
299  $parentRevIds[] = $row->rev_parent_id;
300  }
301  if ( isset( $row->rev_id ) ) {
302  $this->mParentLens[$row->rev_id] = $row->rev_len;
303  if ( $this->contribs === 'newbie' ) { // multiple users
304  $batch->add( NS_USER, $row->user_name );
305  $batch->add( NS_USER_TALK, $row->user_name );
306  }
307  $batch->add( $row->page_namespace, $row->page_title );
308  }
309  }
310  # Fetch rev_len for revisions not already scanned above
311  $this->mParentLens += Revision::getParentLengths(
312  $this->mDbSecondary,
313  array_diff( $parentRevIds, array_keys( $this->mParentLens ) )
314  );
315  $batch->execute();
316  $this->mResult->seek( 0 );
317  }
318 
322  function getStartBody() {
323  return "<ul class=\"mw-contributions-list\">\n";
324  }
325 
329  function getEndBody() {
330  return "</ul>\n";
331  }
332 
345  function formatRow( $row ) {
346 
347  $ret = '';
348  $classes = [];
349 
350  /*
351  * There may be more than just revision rows. To make sure that we'll only be processing
352  * revisions here, let's _try_ to build a revision out of our row (without displaying
353  * notices though) and then trying to grab data from the built object. If we succeed,
354  * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
355  * to extensions to subscribe to the hook to parse the row.
356  */
357  MediaWiki\suppressWarnings();
358  try {
359  $rev = new Revision( $row );
360  $validRevision = (bool)$rev->getId();
361  } catch ( Exception $e ) {
362  $validRevision = false;
363  }
364  MediaWiki\restoreWarnings();
365 
366  if ( $validRevision ) {
367  $classes = [];
368 
369  $page = Title::newFromRow( $row );
371  $page,
372  htmlspecialchars( $page->getPrefixedText() ),
373  [ 'class' => 'mw-contributions-title' ],
374  $page->isRedirect() ? [ 'redirect' => 'no' ] : []
375  );
376  # Mark current revisions
377  $topmarktext = '';
378  $user = $this->getUser();
379  if ( $row->rev_id === $row->page_latest ) {
380  $topmarktext .= '<span class="mw-uctop">' . $this->messages['uctop'] . '</span>';
381  $classes[] = 'mw-contributions-current';
382  # Add rollback link
383  if ( !$row->page_is_new && $page->quickUserCan( 'rollback', $user )
384  && $page->quickUserCan( 'edit', $user )
385  ) {
386  $this->preventClickjacking();
387  $topmarktext .= ' ' . Linker::generateRollback( $rev, $this->getContext() );
388  }
389  }
390  # Is there a visible previous revision?
391  if ( $rev->userCan( Revision::DELETED_TEXT, $user ) && $rev->getParentId() !== 0 ) {
392  $difftext = Linker::linkKnown(
393  $page,
394  $this->messages['diff'],
395  [],
396  [
397  'diff' => 'prev',
398  'oldid' => $row->rev_id
399  ]
400  );
401  } else {
402  $difftext = $this->messages['diff'];
403  }
404  $histlink = Linker::linkKnown(
405  $page,
406  $this->messages['hist'],
407  [],
408  [ 'action' => 'history' ]
409  );
410 
411  if ( $row->rev_parent_id === null ) {
412  // For some reason rev_parent_id isn't populated for this row.
413  // Its rumoured this is true on wikipedia for some revisions (bug 34922).
414  // Next best thing is to have the total number of bytes.
415  $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
416  $chardiff .= Linker::formatRevisionSize( $row->rev_len );
417  $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
418  } else {
419  $parentLen = 0;
420  if ( isset( $this->mParentLens[$row->rev_parent_id] ) ) {
421  $parentLen = $this->mParentLens[$row->rev_parent_id];
422  }
423 
424  $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
426  $parentLen,
427  $row->rev_len,
428  $this->getContext()
429  );
430  $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
431  }
432 
433  $lang = $this->getLanguage();
434  $comment = $lang->getDirMark() . Linker::revComment( $rev, false, true );
435  $date = $lang->userTimeAndDate( $row->rev_timestamp, $user );
436  if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) {
437  $d = Linker::linkKnown(
438  $page,
439  htmlspecialchars( $date ),
440  [ 'class' => 'mw-changeslist-date' ],
441  [ 'oldid' => intval( $row->rev_id ) ]
442  );
443  } else {
444  $d = htmlspecialchars( $date );
445  }
446  if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
447  $d = '<span class="history-deleted">' . $d . '</span>';
448  }
449 
450  # Show user names for /newbies as there may be different users.
451  # Note that we already excluded rows with hidden user names.
452  if ( $this->contribs == 'newbie' ) {
453  $userlink = ' . . ' . $lang->getDirMark()
454  . Linker::userLink( $rev->getUser(), $rev->getUserText() );
455  $userlink .= ' ' . $this->msg( 'parentheses' )->rawParams(
456  Linker::userTalkLink( $rev->getUser(), $rev->getUserText() ) )->escaped() . ' ';
457  } else {
458  $userlink = '';
459  }
460 
461  $flags = [];
462  if ( $rev->getParentId() === 0 ) {
463  $flags[] = ChangesList::flag( 'newpage' );
464  }
465 
466  if ( $rev->isMinor() ) {
467  $flags[] = ChangesList::flag( 'minor' );
468  }
469 
471  if ( $del !== '' ) {
472  $del .= ' ';
473  }
474 
475  $diffHistLinks = $this->msg( 'parentheses' )
476  ->rawParams( $difftext . $this->messages['pipe-separator'] . $histlink )
477  ->escaped();
478 
479  # Tags, if any.
480  list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow(
481  $row->ts_tags,
482  'contributions',
483  $this->getContext()
484  );
485  $classes = array_merge( $classes, $newClasses );
486 
487  Hooks::run( 'SpecialContributions::formatRow::flags', [ $this->getContext(), $row, &$flags ] );
488 
489  $templateParams = [
490  'del' => $del,
491  'timestamp' => $d,
492  'diffHistLinks' => $diffHistLinks,
493  'charDifference' => $chardiff,
494  'flags' => $flags,
495  'articleLink' => $link,
496  'userlink' => $userlink,
497  'logText' => $comment,
498  'topmarktext' => $topmarktext,
499  'tagSummary' => $tagSummary,
500  ];
501 
502  # Denote if username is redacted for this edit
503  if ( $rev->isDeleted( Revision::DELETED_USER ) ) {
504  $templateParams['rev-deleted-user-contribs'] =
505  $this->msg( 'rev-deleted-user-contribs' )->escaped();
506  }
507 
509  $ret = $templateParser->processTemplate(
510  'SpecialContributionsLine',
511  $templateParams
512  );
513  }
514 
515  // Let extensions add data
516  Hooks::run( 'ContributionsLineEnding', [ $this, &$ret, $row, &$classes ] );
517 
518  // TODO: Handle exceptions in the catch block above. Do any extensions rely on
519  // receiving empty rows?
520 
521  if ( $classes === [] && $ret === '' ) {
522  wfDebug( "Dropping Special:Contribution row that could not be formatted\n" );
523  return "<!-- Could not format Special:Contribution row. -->\n";
524  }
525 
526  // FIXME: The signature of the ContributionsLineEnding hook makes it
527  // very awkward to move this LI wrapper into the template.
528  return Html::rawElement( 'li', [ 'class' => $classes ], $ret ) . "\n";
529  }
530 
535  function getSqlComment() {
536  if ( $this->namespace || $this->deletedOnly ) {
537  // potentially slow, see CR r58153
538  return 'contributions page filtered for namespace or RevisionDeleted edits';
539  } else {
540  return 'contributions page unfiltered';
541  }
542  }
543 
544  protected function preventClickjacking() {
545  $this->preventClickjacking = true;
546  }
547 
551  public function getPreventClickjacking() {
553  }
554 }
const DIR_DESCENDING
Definition: IndexPager.php:73
static newFromRow($row)
Make a Title object from a DB row.
Definition: Title.php:450
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
Interface for objects which can provide a MediaWiki context on request.
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:1550
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
the array() calling protocol came about after MediaWiki 1.4rc1.
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:1555
getLanguage()
Get the Language object.
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:2101
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
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:1936
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2102
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:209
if(!isset($args[0])) $lang
static formatRevisionSize($size)
Definition: Linker.php:1573
IndexPager with a formatted navigation bar.
$comment
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2703
IContextSource $context
when a variable name is used in a function
Definition: design.txt:93
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist & $tables
Definition: hooks.txt:1007
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
__construct(IContextSource $context, array $options)
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. '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 '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:Associative array mapping language codes to prefixed links of the form"language:title".&$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:1934
$batch
Definition: linkcache.txt:23
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2889
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:1230
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:32
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
msg()
Get a Message object with context set Parameters are the same as wfMessage()
formatRow($row)
Generates each row in the contributions list.
static formatSummaryRow($tags, $page, IContextSource $context=null)
Creates HTML for the given tags.
Definition: ChangeTags.php:50
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 $options
Definition: hooks.txt:1046
static showCharacterDifference($old, $new, IContextSource $context=null)
Show formatted char difference.
getContext()
Get the base IContextSource object.
static selectFields()
Return the list of revision fields that should be selected to create a new revision.
Definition: Revision.php:442
static linkKnown($target, $html=null, $customAttribs=[], $query=[], $options=[ 'known'])
Identical to link(), except $options defaults to 'known'.
Definition: Linker.php:255
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
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:1721
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
getSqlComment()
Overwrite Pager function and return a helpful comment.
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
static link($target, $html=null, $customAttribs=[], $query=[], $options=[])
This function returns an HTML link to the given target.
Definition: Linker.php:203
const DELETED_TEXT
Definition: Revision.php:85
static modifyDisplayQuery(&$tables, &$fields, &$conds, &$join_conds, &$options, $filter_tag=false)
Applies all tags-related changes to a query.
Definition: ChangeTags.php:629
const SUPPRESSED_USER
Definition: Revision.php:89
static userLink($userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:984
static pageJoinCond()
Return the value of a select() page conds array for the page table.
Definition: Revision.php:433
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
const DELETED_USER
Definition: Revision.php:87
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined...
Definition: Setup.php:36
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:1761
static userTalkLink($userId, $userText)
Definition: Linker.php:1083
static idFromName($name, $flags=self::READ_NORMAL)
Get database id given a user name.
Definition: User.php:728
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:1046
static flag($flag, IContextSource $context=null)
Make an "" element for a given change flag.
reallyDoQuery($offset, $limit, $descending)
This method basically executes the exact same code as the parent class, though with a hook added...
static getParentLengths($db, array $revIds)
Do a batched query to get the parent revision lengths.
Definition: Revision.php:540
$templateParser
Pager for Special:Contributions.
static userJoinCond()
Return the value of a select() JOIN conds array for the user table.
Definition: Revision.php:423
const NS_USER_TALK
Definition: Defines.php:59
buildQueryInfo($offset, $limit, $descending)
Build variables to use by the database wrapper.
Definition: IndexPager.php:376
static getAssociated($index)
Get the associated namespace.
static selectUserFields()
Return the list of user fields that should be selected from user table.
Definition: Revision.php:530
getUser()
Get the User object.
static getGroupsWithPermission($role)
Get all the groups who have a given permission.
Definition: User.php:4602
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 $page
Definition: hooks.txt:2491
IDatabase $mDbSecondary
getDateCond($year, $month, $day=-1)
Set and return the mOffset timestamp such that we can get all revisions with a timestamp up to the sp...