MediaWiki  master
SpecialLog.php
Go to the documentation of this file.
1 <?php
25 
31 class SpecialLog extends SpecialPage {
32  public function __construct() {
33  parent::__construct( 'Log' );
34  }
35 
36  public function execute( $par ) {
38 
39  $this->setHeaders();
40  $this->outputHeader();
41  $this->getOutput()->addModules( 'mediawiki.userSuggest' );
42  $this->addHelpLink( 'Help:Log' );
43 
44  $opts = new FormOptions;
45  $opts->add( 'type', '' );
46  $opts->add( 'user', '' );
47  $opts->add( 'page', '' );
48  $opts->add( 'pattern', false );
49  $opts->add( 'year', null, FormOptions::INTNULL );
50  $opts->add( 'month', null, FormOptions::INTNULL );
51  $opts->add( 'day', null, FormOptions::INTNULL );
52  $opts->add( 'tagfilter', '' );
53  $opts->add( 'offset', '' );
54  $opts->add( 'dir', '' );
55  $opts->add( 'offender', '' );
56  $opts->add( 'subtype', '' );
57  $opts->add( 'logid', '' );
58 
59  // Set values
60  $opts->fetchValuesFromRequest( $this->getRequest() );
61  if ( $par !== null ) {
62  $this->parseParams( $opts, (string)$par );
63  }
64 
65  // Set date values
66  $dateString = $this->getRequest()->getVal( 'wpdate' );
67  if ( !empty( $dateString ) ) {
68  try {
69  $dateStamp = MWTimestamp::getInstance( $dateString . ' 00:00:00' );
70  } catch ( TimestampException $e ) {
71  // If users provide an invalid date, silently ignore it
72  // instead of letting an exception bubble up (T201411)
73  $dateStamp = false;
74  }
75  if ( $dateStamp ) {
76  $opts->setValue( 'year', (int)$dateStamp->format( 'Y' ) );
77  $opts->setValue( 'month', (int)$dateStamp->format( 'm' ) );
78  $opts->setValue( 'day', (int)$dateStamp->format( 'd' ) );
79  }
80  }
81 
82  # Don't let the user get stuck with a certain date
83  if ( $opts->getValue( 'offset' ) || $opts->getValue( 'dir' ) == 'prev' ) {
84  $opts->setValue( 'year', '' );
85  $opts->setValue( 'month', '' );
86  }
87 
88  // If the user doesn't have the right permission to view the specific
89  // log type, throw a PermissionsError
90  // If the log type is invalid, just show all public logs
91  $logRestrictions = $this->getConfig()->get( 'LogRestrictions' );
92  $type = $opts->getValue( 'type' );
93  if ( !LogPage::isLogType( $type ) ) {
94  $opts->setValue( 'type', '' );
95  } elseif ( isset( $logRestrictions[$type] )
96  && !$this->getUser()->isAllowed( $logRestrictions[$type] )
97  ) {
98  throw new PermissionsError( $logRestrictions[$type] );
99  }
100 
101  # Handle type-specific inputs
102  $qc = [];
103  if ( $opts->getValue( 'type' ) == 'suppress' ) {
104  $offenderName = $opts->getValue( 'offender' );
105  $offender = empty( $offenderName ) ? null : User::newFromName( $offenderName, false );
106  if ( $offender ) {
107  if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW ) {
108  $qc = [ 'ls_field' => 'target_author_actor', 'ls_value' => $offender->getActorId() ];
109  } elseif ( $offender->getId() > 0 ) {
110  $qc = [ 'ls_field' => 'target_author_id', 'ls_value' => $offender->getId() ];
111  } else {
112  $qc = [ 'ls_field' => 'target_author_ip', 'ls_value' => $offender->getName() ];
113  }
114  }
115  } else {
116  // Allow extensions to add relations to their search types
117  Hooks::run(
118  'SpecialLogAddLogSearchRelations',
119  [ $opts->getValue( 'type' ), $this->getRequest(), &$qc ]
120  );
121  }
122 
123  # Some log types are only for a 'User:' title but we might have been given
124  # only the username instead of the full title 'User:username'. This part try
125  # to lookup for a user by that name and eventually fix user input. See T3697.
126  if ( in_array( $opts->getValue( 'type' ), self::getLogTypesOnUser() ) ) {
127  # ok we have a type of log which expect a user title.
128  $target = Title::newFromText( $opts->getValue( 'page' ) );
129  if ( $target && $target->getNamespace() === NS_MAIN ) {
130  # User forgot to add 'User:', we are adding it for him
131  $opts->setValue( 'page',
132  Title::makeTitleSafe( NS_USER, $opts->getValue( 'page' ) )
133  );
134  }
135  }
136 
137  $this->show( $opts, $qc );
138  }
139 
148  public static function getLogTypesOnUser() {
149  static $types = null;
150  if ( $types !== null ) {
151  return $types;
152  }
153  $types = [
154  'block',
155  'newusers',
156  'rights',
157  ];
158 
159  Hooks::run( 'GetLogTypesOnUser', [ &$types ] );
160  return $types;
161  }
162 
168  public function getSubpagesForPrefixSearch() {
169  $subpages = LogPage::validTypes();
170  $subpages[] = 'all';
171  sort( $subpages );
172  return $subpages;
173  }
174 
185  private function parseParams( FormOptions $opts, $par ) {
186  # Get parameters
187  $par = $par !== null ? $par : '';
188  $parms = explode( '/', $par );
189  $symsForAll = [ '*', 'all' ];
190  if ( $parms[0] != '' &&
191  ( in_array( $par, LogPage::validTypes() ) || in_array( $par, $symsForAll ) )
192  ) {
193  $opts->setValue( 'type', $par );
194  } elseif ( count( $parms ) == 2 ) {
195  $opts->setValue( 'type', $parms[0] );
196  $opts->setValue( 'user', $parms[1] );
197  } elseif ( $par != '' ) {
198  $opts->setValue( 'user', $par );
199  }
200  }
201 
202  private function show( FormOptions $opts, array $extraConds ) {
203  # Create a LogPager item to get the results and a LogEventsList item to format them...
204  $loglist = new LogEventsList(
205  $this->getContext(),
206  $this->getLinkRenderer(),
208  );
209 
210  $pager = new LogPager(
211  $loglist,
212  $opts->getValue( 'type' ),
213  $opts->getValue( 'user' ),
214  $opts->getValue( 'page' ),
215  $opts->getValue( 'pattern' ),
216  $extraConds,
217  $opts->getValue( 'year' ),
218  $opts->getValue( 'month' ),
219  $opts->getValue( 'day' ),
220  $opts->getValue( 'tagfilter' ),
221  $opts->getValue( 'subtype' ),
222  $opts->getValue( 'logid' )
223  );
224 
225  $this->addHeader( $opts->getValue( 'type' ) );
226 
227  # Set relevant user
228  if ( $pager->getPerformer() ) {
229  $performerUser = User::newFromName( $pager->getPerformer(), false );
230  $this->getSkin()->setRelevantUser( $performerUser );
231  }
232 
233  # Show form options
234  $loglist->showOptions(
235  $pager->getType(),
236  $pager->getPerformer(),
237  $pager->getPage(),
238  $pager->getPattern(),
239  $pager->getYear(),
240  $pager->getMonth(),
241  $pager->getDay(),
242  $pager->getFilterParams(),
243  $pager->getTagFilter(),
244  $pager->getAction()
245  );
246 
247  # Insert list
248  $logBody = $pager->getBody();
249  if ( $logBody ) {
250  $this->getOutput()->addHTML(
251  $pager->getNavigationBar() .
252  $this->getActionButtons(
253  $loglist->beginLogEventsList() .
254  $logBody .
255  $loglist->endLogEventsList()
256  ) .
257  $pager->getNavigationBar()
258  );
259  } else {
260  $this->getOutput()->addWikiMsg( 'logempty' );
261  }
262  }
263 
264  private function getActionButtons( $formcontents ) {
265  $user = $this->getUser();
266  $canRevDelete = $user->isAllowedAll( 'deletedhistory', 'deletelogentry' );
267  $showTagEditUI = ChangeTags::showTagEditingUI( $user );
268  # If the user doesn't have the ability to delete log entries nor edit tags,
269  # don't bother showing them the button(s).
270  if ( !$canRevDelete && !$showTagEditUI ) {
271  return $formcontents;
272  }
273 
274  # Show button to hide log entries and/or edit change tags
276  'form',
277  [ 'action' => wfScript(), 'id' => 'mw-log-deleterevision-submit' ]
278  ) . "\n";
279  $s .= Html::hidden( 'action', 'historysubmit' ) . "\n";
280  $s .= Html::hidden( 'type', 'logging' ) . "\n";
281 
282  $buttons = '';
283  if ( $canRevDelete ) {
284  $buttons .= Html::element(
285  'button',
286  [
287  'type' => 'submit',
288  'name' => 'revisiondelete',
289  'value' => '1',
290  'class' => "deleterevision-log-submit mw-log-deleterevision-button"
291  ],
292  $this->msg( 'showhideselectedlogentries' )->text()
293  ) . "\n";
294  }
295  if ( $showTagEditUI ) {
296  $buttons .= Html::element(
297  'button',
298  [
299  'type' => 'submit',
300  'name' => 'editchangetags',
301  'value' => '1',
302  'class' => "editchangetags-log-submit mw-log-editchangetags-button"
303  ],
304  $this->msg( 'log-edit-tags' )->text()
305  ) . "\n";
306  }
307 
308  $buttons .= ( new ListToggle( $this->getOutput() ) )->getHTML();
309 
310  $s .= $buttons . $formcontents . $buttons;
311  $s .= Html::closeElement( 'form' );
312 
313  return $s;
314  }
315 
321  protected function addHeader( $type ) {
322  $page = new LogPage( $type );
323  $this->getOutput()->setPageTitle( $page->getName() );
324  $this->getOutput()->addHTML( $page->getDescription()
325  ->setContext( $this->getContext() )->parseAsBlock() );
326  }
327 
328  protected function getGroupName() {
329  return 'changes';
330  }
331 }
Class for generating clickable toggle links for a list of checkboxes.
Definition: ListToggle.php:31
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))
Helper class to keep track of options when mixing links and form elements.
Definition: FormOptions.php:35
const USE_CHECKBOXES
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:232
getContext()
Gets the context this SpecialPage is executed in.
parseParams(FormOptions $opts, $par)
Set options based on the subpage title parts:
Definition: SpecialLog.php:185
const NS_MAIN
Definition: Defines.php:64
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
const INTNULL
Integer type or null, maps to WebRequest::getIntOrNull() This is useful for the namespace selector...
Definition: FormOptions.php:54
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2223
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept.
Definition: SpecialLog.php:168
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing &#39;/&#39;...
Definition: Html.php:252
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
const SCHEMA_COMPAT_READ_NEW
Definition: Defines.php:287
getActionButtons( $formcontents)
Definition: SpecialLog.php:264
getOutput()
Get the OutputPage being used for this instance.
execute( $par)
Definition: SpecialLog.php:36
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
add( $name, $default, $type=self::AUTO)
Add an option to be handled by this FormOptions instance.
Definition: FormOptions.php:81
Class to simplify the use of log pages.
Definition: LogPage.php:33
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
static getInstance( $ts=false)
Get a timestamp instance in GMT.
Definition: MWTimestamp.php:39
getSkin()
Shortcut to get the skin being used for this instance.
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:310
static showTagEditingUI(User $user)
Indicate whether change tag editing UI is relevant.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
A special page that lists log entries.
Definition: SpecialLog.php:31
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:573
static isLogType( $type)
Is $type a valid log type.
Definition: LogPage.php:206
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
setValue( $name, $value, $force=false)
Use to set the value of an option.
show(FormOptions $opts, array $extraConds)
Definition: SpecialLog.php:202
getUser()
Shortcut to get the User executing this instance.
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:795
static getLogTypesOnUser()
List log type for which the target is a user Thus if the given target is in NS_MAIN we can alter it t...
Definition: SpecialLog.php:148
getConfig()
Shortcut to get main config object.
Show an error when a user tries to do something they do not have the necessary permissions for...
msg( $key)
Wrapper around wfMessage that sets the current context.
addHeader( $type)
Set page title and show header for this log type.
Definition: SpecialLog.php:321
getRequest()
Get the WebRequest being used for this instance.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:592
static validTypes()
Get the list of valid log types.
Definition: LogPage.php:194
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
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
getValue( $name)
Get the value for the given option name.
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:280