MediaWiki  master
LogEventsList.php
Go to the documentation of this file.
1 <?php
29 
31  const NO_ACTION_LINK = 1;
33  const USE_CHECKBOXES = 4;
34 
35  public $flags;
36 
40  protected $mDefaultQuery;
41 
45  protected $showTagEditUI;
46 
50  protected $allowedActions = null;
51 
55  private $linkRenderer;
56 
67  public function __construct( $context, $linkRenderer = null, $flags = 0 ) {
68  if ( $context instanceof IContextSource ) {
69  $this->setContext( $context );
70  } else {
71  // Old parameters, $context should be a Skin object
72  $this->setContext( $context->getContext() );
73  }
74 
75  $this->flags = $flags;
76  $this->showTagEditUI = ChangeTags::showTagEditingUI( $this->getUser() );
77  if ( $linkRenderer instanceof LinkRenderer ) {
78  $this->linkRenderer = $linkRenderer;
79  }
80  }
81 
86  protected function getLinkRenderer() {
87  if ( $this->linkRenderer !== null ) {
88  return $this->linkRenderer;
89  } else {
90  return MediaWikiServices::getInstance()->getLinkRenderer();
91  }
92  }
93 
110  public function showOptions( $types = [], $user = '', $page = '', $pattern = false, $year = 0,
111  $month = 0, $day = 0, $filter = null, $tagFilter = '', $action = null
112  ) {
113  // For B/C, we take strings, but make sure they are converted...
114  $types = ( $types === '' ) ? [] : (array)$types;
115 
116  $formDescriptor = [];
117 
118  // Basic selectors
119  $formDescriptor['type'] = $this->getTypeMenuDesc( $types );
120  $formDescriptor['user'] = $this->getUserInputDesc( $user );
121  $formDescriptor['page'] = $this->getTitleInputDesc( $page );
122 
123  // Add extra inputs if any
124  // This could either be a form descriptor array or a string with raw HTML.
125  // We need it to work in both cases and show a deprecation warning if it
126  // is a string. See T199495.
127  $extraInputsDescriptor = $this->getExtraInputsDesc( $types );
128  if (
129  is_array( $extraInputsDescriptor ) &&
130  !empty( $extraInputsDescriptor )
131  ) {
132  $formDescriptor[ 'extra' ] = $extraInputsDescriptor;
133  } elseif (
134  is_string( $extraInputsDescriptor ) &&
135  $extraInputsDescriptor !== ''
136  ) {
137  // We'll add this to the footer of the form later
138  $extraInputsString = $extraInputsDescriptor;
139  wfDeprecated( '$input in LogEventsListGetExtraInputs hook', '1.32' );
140  }
141 
142  // Title pattern, if allowed
143  if ( !$this->getConfig()->get( 'MiserMode' ) ) {
144  $formDescriptor['pattern'] = $this->getTitlePatternDesc( $pattern );
145  }
146 
147  // Date menu
148  $formDescriptor['date'] = [
149  'type' => 'date',
150  'label-message' => 'date',
151  'default' => sprintf( "%04d-%02d-%02d", $year, $month, $day ),
152  ];
153 
154  // Tag filter
155  $formDescriptor['tagfilter'] = [
156  'type' => 'tagfilter',
157  'name' => 'tagfilter',
158  'label-raw' => $this->msg( 'tag-filter' )->parse(),
159  ];
160 
161  // Filter links
162  if ( $filter ) {
163  $formDescriptor['filters'] = $this->getFiltersDesc( $filter );
164  }
165 
166  // Action filter
167  if (
168  $action !== null &&
169  $this->allowedActions !== null &&
170  count( $this->allowedActions ) > 0
171  ) {
172  $formDescriptor['subtype'] = $this->getActionSelectorDesc( $types, $action );
173  }
174 
175  $context = new DerivativeContext( $this->getContext() );
176  $context->setTitle( SpecialPage::getTitleFor( 'Log' ) ); // Remove subpage
177  $htmlForm = new HTMLForm( $formDescriptor, $context );
178  $htmlForm
179  ->setSubmitText( $this->msg( 'logeventslist-submit' )->text() )
180  ->setMethod( 'get' )
181  ->setWrapperLegendMsg( 'log' );
182 
183  // TODO This will should be removed at some point. See T199495.
184  if ( isset( $extraInputsString ) ) {
185  $htmlForm->addFooterText( Html::rawElement(
186  'div',
187  null,
188  $extraInputsString
189  ) );
190  }
191 
192  $htmlForm->prepareForm()->displayForm( false );
193  }
194 
199  private function getFiltersDesc( $filter ) {
200  $options = [];
201  $default = [];
202  foreach ( $filter as $type => $val ) {
203  $message = $this->msg( "logeventslist-{$type}-log" );
204  // FIXME: Remove this check once T199657 is fully resolved.
205  if ( !$message->exists() ) {
206  $message = $this->msg( "log-show-hide-{$type}" )->params( $this->msg( 'show' )->text() );
207  }
208  $options[ $message->text() ] = $type;
209 
210  if ( $val === false ) {
211  $default[] = $type;
212  }
213  }
214  return [
215  'class' => 'HTMLMultiSelectField',
216  'label-message' => 'logeventslist-more-filters',
217  'flatlist' => true,
218  'options' => $options,
219  'default' => $default,
220  ];
221  }
222 
223  private function getDefaultQuery() {
224  if ( !isset( $this->mDefaultQuery ) ) {
225  $this->mDefaultQuery = $this->getRequest()->getQueryValues();
226  unset( $this->mDefaultQuery['title'] );
227  unset( $this->mDefaultQuery['dir'] );
228  unset( $this->mDefaultQuery['offset'] );
229  unset( $this->mDefaultQuery['limit'] );
230  unset( $this->mDefaultQuery['order'] );
231  unset( $this->mDefaultQuery['month'] );
232  unset( $this->mDefaultQuery['year'] );
233  }
234 
235  return $this->mDefaultQuery;
236  }
237 
242  private function getTypeMenuDesc( $queryTypes ) {
243  $queryType = count( $queryTypes ) == 1 ? $queryTypes[0] : '';
244 
245  $typesByName = []; // Temporary array
246  // First pass to load the log names
247  foreach ( LogPage::validTypes() as $type ) {
248  $page = new LogPage( $type );
249  $restriction = $page->getRestriction();
250  if ( $this->getUser()->isAllowed( $restriction ) ) {
251  $typesByName[$type] = $page->getName()->text();
252  }
253  }
254 
255  // Second pass to sort by name
256  asort( $typesByName );
257 
258  // Always put "All public logs" on top
259  $public = $typesByName[''];
260  unset( $typesByName[''] );
261  $typesByName = [ '' => $public ] + $typesByName;
262 
263  return [
264  'class' => 'HTMLSelectField',
265  'name' => 'type',
266  'options' => array_flip( $typesByName ),
267  'default' => $queryType,
268  ];
269  }
270 
275  private function getUserInputDesc( $user ) {
276  return [
277  'class' => 'HTMLUserTextField',
278  'label-message' => 'specialloguserlabel',
279  'name' => 'user',
280  'default' => $user,
281  ];
282  }
283 
288  private function getTitleInputDesc( $title ) {
289  return [
290  'class' => 'HTMLTitleTextField',
291  'label-message' => 'speciallogtitlelabel',
292  'name' => 'page',
293  'required' => false
294  ];
295  }
296 
301  private function getTitlePatternDesc( $pattern ) {
302  return [
303  'type' => 'check',
304  'label-message' => 'log-title-wildcard',
305  'name' => 'pattern',
306  ];
307  }
308 
313  private function getExtraInputsDesc( $types ) {
314  if ( count( $types ) == 1 ) {
315  if ( $types[0] == 'suppress' ) {
316  return [
317  'type' => 'text',
318  'label-message' => 'revdelete-offender',
319  'name' => 'offender',
320  ];
321  } else {
322  // Allow extensions to add their own extra inputs
323  // This could be an array or string. See T199495.
324  $input = ''; // Deprecated
325  $formDescriptor = [];
326  Hooks::run( 'LogEventsListGetExtraInputs', [ $types[0], $this, &$input, &$formDescriptor ] );
327 
328  return empty( $formDescriptor ) ? $input : $formDescriptor;
329  }
330  }
331 
332  return [];
333  }
334 
341  private function getActionSelectorDesc( $types, $action ) {
342  $actionOptions = [];
343  $actionOptions[ 'log-action-filter-all' ] = '';
344 
345  foreach ( $this->allowedActions as $value ) {
346  $msgKey = 'log-action-filter-' . $types[0] . '-' . $value;
347  $actionOptions[ $msgKey ] = $value;
348  }
349 
350  return [
351  'class' => 'HTMLSelectField',
352  'name' => 'subtype',
353  'options-messages' => $actionOptions,
354  'default' => $action,
355  'label' => $this->msg( 'log-action-filter-' . $types[0] )->text(),
356  ];
357  }
358 
365  public function setAllowedActions( $actions ) {
366  $this->allowedActions = $actions;
367  }
368 
372  public function beginLogEventsList() {
373  return "<ul>\n";
374  }
375 
379  public function endLogEventsList() {
380  return "</ul>\n";
381  }
382 
387  public function logLine( $row ) {
388  $entry = DatabaseLogEntry::newFromRow( $row );
389  $formatter = LogFormatter::newFromEntry( $entry );
390  $formatter->setContext( $this->getContext() );
391  $formatter->setLinkRenderer( $this->getLinkRenderer() );
392  $formatter->setShowUserToolLinks( !( $this->flags & self::NO_EXTRA_USER_LINKS ) );
393 
394  $time = htmlspecialchars( $this->getLanguage()->userTimeAndDate(
395  $entry->getTimestamp(), $this->getUser() ) );
396 
397  $action = $formatter->getActionText();
398 
399  if ( $this->flags & self::NO_ACTION_LINK ) {
400  $revert = '';
401  } else {
402  $revert = $formatter->getActionLinks();
403  if ( $revert != '' ) {
404  $revert = '<span class="mw-logevent-actionlink">' . $revert . '</span>';
405  }
406  }
407 
408  $comment = $formatter->getComment();
409 
410  // Some user can hide log items and have review links
411  $del = $this->getShowHideLinks( $row );
412 
413  // Any tags...
414  list( $tagDisplay, $newClasses ) = ChangeTags::formatSummaryRow(
415  $row->ts_tags,
416  'logevent',
417  $this->getContext()
418  );
419  $classes = array_merge(
420  [ 'mw-logline-' . $entry->getType() ],
421  $newClasses
422  );
423  $attribs = [
424  'data-mw-logid' => $entry->getId(),
425  'data-mw-logaction' => $entry->getFullType(),
426  ];
427  $ret = "$del $time $action $comment $revert $tagDisplay";
428 
429  // Let extensions add data
430  Hooks::run( 'LogEventsListLineEnding', [ $this, &$ret, $entry, &$classes, &$attribs ] );
431  $attribs = array_filter( $attribs,
432  [ Sanitizer::class, 'isReservedDataAttribute' ],
433  ARRAY_FILTER_USE_KEY
434  );
435  $attribs['class'] = implode( ' ', $classes );
436 
437  return Html::rawElement( 'li', $attribs, $ret ) . "\n";
438  }
439 
444  private function getShowHideLinks( $row ) {
445  // We don't want to see the links and
446  if ( $this->flags == self::NO_ACTION_LINK ) {
447  return '';
448  }
449 
450  $user = $this->getUser();
451 
452  // If change tag editing is available to this user, return the checkbox
453  if ( $this->flags & self::USE_CHECKBOXES && $this->showTagEditUI ) {
454  return Xml::check(
455  'showhiderevisions',
456  false,
457  [ 'name' => 'ids[' . $row->log_id . ']' ]
458  );
459  }
460 
461  // no one can hide items from the suppress log.
462  if ( $row->log_type == 'suppress' ) {
463  return '';
464  }
465 
466  $del = '';
467  // Don't show useless checkbox to people who cannot hide log entries
468  if ( $user->isAllowed( 'deletedhistory' ) ) {
469  $canHide = $user->isAllowed( 'deletelogentry' );
470  $canViewSuppressedOnly = $user->isAllowed( 'viewsuppressed' ) &&
471  !$user->isAllowed( 'suppressrevision' );
472  $entryIsSuppressed = self::isDeleted( $row, LogPage::DELETED_RESTRICTED );
473  $canViewThisSuppressedEntry = $canViewSuppressedOnly && $entryIsSuppressed;
474  if ( $row->log_deleted || $canHide ) {
475  // Show checkboxes instead of links.
476  if ( $canHide && $this->flags & self::USE_CHECKBOXES && !$canViewThisSuppressedEntry ) {
477  // If event was hidden from sysops
478  if ( !self::userCan( $row, LogPage::DELETED_RESTRICTED, $user ) ) {
479  $del = Xml::check( 'deleterevisions', false, [ 'disabled' => 'disabled' ] );
480  } else {
481  $del = Xml::check(
482  'showhiderevisions',
483  false,
484  [ 'name' => 'ids[' . $row->log_id . ']' ]
485  );
486  }
487  } else {
488  // If event was hidden from sysops
489  if ( !self::userCan( $row, LogPage::DELETED_RESTRICTED, $user ) ) {
490  $del = Linker::revDeleteLinkDisabled( $canHide );
491  } else {
492  $query = [
493  'target' => SpecialPage::getTitleFor( 'Log', $row->log_type )->getPrefixedDBkey(),
494  'type' => 'logging',
495  'ids' => $row->log_id,
496  ];
497  $del = Linker::revDeleteLink(
498  $query,
499  $entryIsSuppressed,
500  $canHide && !$canViewThisSuppressedEntry
501  );
502  }
503  }
504  }
505  }
506 
507  return $del;
508  }
509 
517  public static function typeAction( $row, $type, $action, $right = '' ) {
518  $match = is_array( $type ) ?
519  in_array( $row->log_type, $type ) : $row->log_type == $type;
520  if ( $match ) {
521  $match = is_array( $action ) ?
522  in_array( $row->log_action, $action ) : $row->log_action == $action;
523  if ( $match && $right ) {
524  global $wgUser;
525  $match = $wgUser->isAllowed( $right );
526  }
527  }
528 
529  return $match;
530  }
531 
541  public static function userCan( $row, $field, User $user = null ) {
542  return self::userCanBitfield( $row->log_deleted, $field, $user );
543  }
544 
554  public static function userCanBitfield( $bitfield, $field, User $user = null ) {
555  if ( $bitfield & $field ) {
556  if ( $user === null ) {
557  global $wgUser;
558  $user = $wgUser;
559  }
560  if ( $bitfield & LogPage::DELETED_RESTRICTED ) {
561  $permissions = [ 'suppressrevision', 'viewsuppressed' ];
562  } else {
563  $permissions = [ 'deletedhistory' ];
564  }
565  $permissionlist = implode( ', ', $permissions );
566  wfDebug( "Checking for $permissionlist due to $field match on $bitfield\n" );
567  return $user->isAllowedAny( ...$permissions );
568  }
569  return true;
570  }
571 
577  public static function isDeleted( $row, $field ) {
578  return ( $row->log_deleted & $field ) == $field;
579  }
580 
606  public static function showLogExtract(
607  &$out, $types = [], $page = '', $user = '', $param = []
608  ) {
609  $defaultParameters = [
610  'lim' => 25,
611  'conds' => [],
612  'showIfEmpty' => true,
613  'msgKey' => [ '' ],
614  'wrap' => "$1",
615  'flags' => 0,
616  'useRequestParams' => false,
617  'useMaster' => false,
618  'extraUrlParams' => false,
619  ];
620  # The + operator appends elements of remaining keys from the right
621  # handed array to the left handed, whereas duplicated keys are NOT overwritten.
622  $param += $defaultParameters;
623  # Convert $param array to individual variables
624  $lim = $param['lim'];
625  $conds = $param['conds'];
626  $showIfEmpty = $param['showIfEmpty'];
627  $msgKey = $param['msgKey'];
628  $wrap = $param['wrap'];
629  $flags = $param['flags'];
630  $extraUrlParams = $param['extraUrlParams'];
631 
632  $useRequestParams = $param['useRequestParams'];
633  if ( !is_array( $msgKey ) ) {
634  $msgKey = [ $msgKey ];
635  }
636 
637  if ( $out instanceof OutputPage ) {
638  $context = $out->getContext();
639  } else {
641  }
642 
643  // FIXME: Figure out how to inject this
644  $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
645 
646  # Insert list of top 50 (or top $lim) items
647  $loglist = new LogEventsList( $context, $linkRenderer, $flags );
648  $pager = new LogPager( $loglist, $types, $user, $page, '', $conds );
649  if ( !$useRequestParams ) {
650  # Reset vars that may have been taken from the request
651  $pager->mLimit = 50;
652  $pager->mDefaultLimit = 50;
653  $pager->mOffset = "";
654  $pager->mIsBackwards = false;
655  }
656 
657  if ( $param['useMaster'] ) {
658  $pager->mDb = wfGetDB( DB_MASTER );
659  }
660  if ( isset( $param['offset'] ) ) { # Tell pager to ignore WebRequest offset
661  $pager->setOffset( $param['offset'] );
662  }
663 
664  if ( $lim > 0 ) {
665  $pager->mLimit = $lim;
666  }
667  // Fetch the log rows and build the HTML if needed
668  $logBody = $pager->getBody();
669  $numRows = $pager->getNumRows();
670 
671  $s = '';
672 
673  if ( $logBody ) {
674  if ( $msgKey[0] ) {
675  $dir = $context->getLanguage()->getDir();
676  $lang = $context->getLanguage()->getHtmlCode();
677 
678  $s = Xml::openElement( 'div', [
679  'class' => "mw-warning-with-logexcerpt mw-content-$dir",
680  'dir' => $dir,
681  'lang' => $lang,
682  ] );
683 
684  if ( count( $msgKey ) == 1 ) {
685  $s .= $context->msg( $msgKey[0] )->parseAsBlock();
686  } else { // Process additional arguments
687  $args = $msgKey;
688  array_shift( $args );
689  $s .= $context->msg( $msgKey[0], $args )->parseAsBlock();
690  }
691  }
692  $s .= $loglist->beginLogEventsList() .
693  $logBody .
694  $loglist->endLogEventsList();
695  } elseif ( $showIfEmpty ) {
696  $s = Html::rawElement( 'div', [ 'class' => 'mw-warning-logempty' ],
697  $context->msg( 'logempty' )->parse() );
698  }
699 
700  if ( $numRows > $pager->mLimit ) { # Show "Full log" link
701  $urlParam = [];
702  if ( $page instanceof Title ) {
703  $urlParam['page'] = $page->getPrefixedDBkey();
704  } elseif ( $page != '' ) {
705  $urlParam['page'] = $page;
706  }
707 
708  if ( $user != '' ) {
709  $urlParam['user'] = $user;
710  }
711 
712  if ( !is_array( $types ) ) { # Make it an array, if it isn't
713  $types = [ $types ];
714  }
715 
716  # If there is exactly one log type, we can link to Special:Log?type=foo
717  if ( count( $types ) == 1 ) {
718  $urlParam['type'] = $types[0];
719  }
720 
721  if ( $extraUrlParams !== false ) {
722  $urlParam = array_merge( $urlParam, $extraUrlParams );
723  }
724 
725  $s .= $linkRenderer->makeKnownLink(
726  SpecialPage::getTitleFor( 'Log' ),
727  $context->msg( 'log-fulllog' )->text(),
728  [],
729  $urlParam
730  );
731  }
732 
733  if ( $logBody && $msgKey[0] ) {
734  $s .= '</div>';
735  }
736 
737  if ( $wrap != '' ) { // Wrap message in html
738  $s = str_replace( '$1', $s, $wrap );
739  }
740 
741  /* hook can return false, if we don't want the message to be emitted (Wikia BugId:7093) */
742  if ( Hooks::run( 'LogEventsListShowLogExtract', [ &$s, $types, $page, $user, $param ] ) ) {
743  // $out can be either an OutputPage object or a String-by-reference
744  if ( $out instanceof OutputPage ) {
745  $out->addHTML( $s );
746  } else {
747  $out = $s;
748  }
749  }
750 
751  return $numRows;
752  }
753 
762  public static function getExcludeClause( $db, $audience = 'public', User $user = null ) {
763  global $wgLogRestrictions;
764 
765  if ( $audience != 'public' && $user === null ) {
766  global $wgUser;
767  $user = $wgUser;
768  }
769 
770  // Reset the array, clears extra "where" clauses when $par is used
771  $hiddenLogs = [];
772 
773  // Don't show private logs to unprivileged users
774  foreach ( $wgLogRestrictions as $logType => $right ) {
775  if ( $audience == 'public' || !$user->isAllowed( $right ) ) {
776  $hiddenLogs[] = $logType;
777  }
778  }
779  if ( count( $hiddenLogs ) == 1 ) {
780  return 'log_type != ' . $db->addQuotes( $hiddenLogs[0] );
781  } elseif ( $hiddenLogs ) {
782  return 'log_type NOT IN (' . $db->makeList( $hiddenLogs ) . ')';
783  }
784 
785  return false;
786  }
787 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
setContext(IContextSource $context)
const USE_CHECKBOXES
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
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:813
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:1628
if(is_array( $mode)) switch( $mode) $input
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
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:2037
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getTitleInputDesc( $title)
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead & $formDescriptor
Definition: hooks.txt:2116
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
static newFromRow( $row)
Constructs new LogEntry from database result row.
Definition: LogEntry.php:208
if(!isset( $args[0])) $lang
const NO_EXTRA_USER_LINKS
static newFromEntry(LogEntry $entry)
Constructs a new formatter suitable for given entry.
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:210
An IContextSource implementation which will inherit context from another source but allow individual ...
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
getFiltersDesc( $filter)
static typeAction( $row, $type, $action, $right='')
getShowHideLinks( $row)
$value
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:23
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters create2 Corresponds to logging log_action database field and which is displayed in the UI & $revert
Definition: hooks.txt:2214
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
$wgLogRestrictions
This restricts log access to those who have a certain right Users without this will not see it in the...
IContextSource $context
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
const DB_MASTER
Definition: defines.php:26
if( $line===false) $args
Definition: cdb.php:64
Class to simplify the use of log pages.
Definition: LogPage.php:33
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:47
getUserInputDesc( $user)
Class that generates HTML links for pages.
static getMain()
Get the RequestContext object associated with the main request.
static openElement( $element, $attribs=null)
This opens an XML element.
Definition: Xml.php:110
__construct( $context, $linkRenderer=null, $flags=0)
The first two parameters used to be $skin and $out, but now only a context is needed, that&#39;s why there&#39;s a second unused parameter.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static userCanBitfield( $bitfield, $field, User $user=null)
Determine if the current user is allowed to view a particular field of this log row, if it&#39;s marked as deleted.
getContext()
Get the base IContextSource object.
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:2037
static showTagEditingUI(User $user)
Indicate whether change tag editing UI is relevant.
static isDeleted( $row, $field)
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:2037
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
getTypeMenuDesc( $queryTypes)
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:82
const NO_ACTION_LINK
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
const DELETED_RESTRICTED
Definition: LogPage.php:37
setAllowedActions( $actions)
Sets the action types allowed for log filtering To one action type may correspond several log_actions...
msg( $key)
This is the method for getting translated interface messages.
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
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN type
Definition: postgres.txt:22
getActionSelectorDesc( $types, $action)
Drop down menu for selection of actions that can be used to filter the log.
static userCan( $row, $field, User $user=null)
Determine if the current user is allowed to view a particular field of this log row, if it&#39;s marked as deleted.
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:52
static getExcludeClause( $db, $audience='public', User $user=null)
SQL clause to skip forbidden log types for this user.
static revDeleteLink( $query=[], $restricted=false, $delete=true)
Creates a (show/hide) link for deleting revisions/log entries.
Definition: Linker.php:2092
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead 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:2206
showOptions( $types=[], $user='', $page='', $pattern=false, $year=0, $month=0, $day=0, $filter=null, $tagFilter='', $action=null)
Show options for the log list.
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template to be included in the link
Definition: hooks.txt:3091
static formatSummaryRow( $tags, $page, IContextSource $context=null)
Creates HTML for the given tags.
Definition: ChangeTags.php:93
getExtraInputsDesc( $types)
=Architecture==Two class hierarchies are used to provide the functionality associated with the different content models:*Content interface(and AbstractContent base class) define functionality that acts on the concrete content of a page, and *ContentHandler base class provides functionality specific to a content model, but not acting on concrete content. The most important function of ContentHandler is to act as a factory for the appropriate implementation of Content. These Content objects are to be used by MediaWiki everywhere, instead of passing page content around as text. All manipulation and analysis of page content must be done via the appropriate methods of the Content object. For each content model, a subclass of ContentHandler has to be registered with $wgContentHandlers. The ContentHandler object for a given content model can be obtained using ContentHandler::getForModelID($id). Also Title, WikiPage and Revision now have getContentHandler() methods for convenience. ContentHandler objects are singletons that provide functionality specific to the content type, but not directly acting on the content of some page. ContentHandler::makeEmptyContent() and ContentHandler::unserializeContent() can be used to create a Content object of the appropriate type. However, it is recommended to instead use WikiPage::getContent() resp. Revision::getContent() to get a page 's content as a Content object. These two methods should be the ONLY way in which page content is accessed. Another important function of ContentHandler objects is to define custom action handlers for a content model, see ContentHandler::getActionOverrides(). This is similar to what WikiPage::getActionOverrides() was already doing.==Serialization==With the ContentHandler facility, page content no longer has to be text based. Objects implementing the Content interface are used to represent and handle the content internally. For storage and data exchange, each content model supports at least one serialization format via ContentHandler::serializeContent($content). The list of supported formats for a given content model can be accessed using ContentHandler::getSupportedFormats(). Content serialization formats are identified using MIME type like strings. The following formats are built in:*text/x-wiki - wikitext *text/javascript - for js pages *text/css - for css pages *text/plain - for future use, e.g. with plain text messages. *text/html - for future use, e.g. with plain html messages. *application/vnd.php.serialized - for future use with the api and for extensions *application/json - for future use with the api, and for use by extensions *application/xml - for future use with the api, and for use by extensions In PHP, use the corresponding CONTENT_FORMAT_XXX constant. Note that when using the API to access page content, especially action=edit, action=parse and action=query &prop=revisions, the model and format of the content should always be handled explicitly. Without that information, interpretation of the provided content is not reliable. The same applies to XML dumps generated via maintenance/dumpBackup.php or Special:Export. Also note that the API will provide encapsulated, serialized content - so if the API was called with format=json, and contentformat is also json(or rather, application/json), the page content is represented as a string containing an escaped json structure. Extensions that use JSON to serialize some types of page content may provide specialized API modules that allow access to that content in a more natural form.==Compatibility==The ContentHandler facility is introduced in a way that should allow all existing code to keep functioning at least for pages that contain wikitext or other text based content. However, a number of functions and hooks have been deprecated in favor of new versions that are aware of the page 's content model, and will now generate warnings when used. Most importantly, the following functions have been deprecated:*Revisions::getText() is deprecated in favor Revisions::getContent() *WikiPage::getText() is deprecated in favor WikiPage::getContent() Also, the old Article::getContent()(which returns text) is superceded by Article::getContentObject(). However, both methods should be avoided since they do not provide clean access to the page 's actual content. For instance, they may return a system message for non-existing pages. Use WikiPage::getContent() instead. Code that relies on a textual representation of the page content should eventually be rewritten. However, ContentHandler::getContentText() provides a stop-gap that can be used to get text for a page. Its behavior is controlled by $wgContentHandlerTextFallback it
getTitlePatternDesc( $pattern)
static validTypes()
Get the list of valid log types.
Definition: LogPage.php:194
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
Definition: Xml.php:325
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1842
LinkRenderer null $linkRenderer
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:244
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
array $mDefaultQuery
static revDeleteLinkDisabled( $delete=true)
Creates a dead (show/hide) link for deleting revisions/log entries.
Definition: Linker.php:2114
static showLogExtract(&$out, $types=[], $page='', $user='', $param=[])
Show log extract.