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