MediaWiki  1.28.0
SpecialLog.php
Go to the documentation of this file.
1 <?php
31 class SpecialLog extends SpecialPage {
32  public function __construct() {
33  parent::__construct( 'Log' );
34  }
35 
36  public function execute( $par ) {
37  $this->setHeaders();
38  $this->outputHeader();
39  $this->getOutput()->addModules( 'mediawiki.userSuggest' );
40  $this->addHelpLink( 'Help:Log' );
41 
42  $opts = new FormOptions;
43  $opts->add( 'type', '' );
44  $opts->add( 'user', '' );
45  $opts->add( 'page', '' );
46  $opts->add( 'pattern', false );
47  $opts->add( 'year', null, FormOptions::INTNULL );
48  $opts->add( 'month', null, FormOptions::INTNULL );
49  $opts->add( 'tagfilter', '' );
50  $opts->add( 'offset', '' );
51  $opts->add( 'dir', '' );
52  $opts->add( 'offender', '' );
53  $opts->add( 'subtype', '' );
54 
55  // Set values
56  $opts->fetchValuesFromRequest( $this->getRequest() );
57  if ( $par !== null ) {
58  $this->parseParams( $opts, (string)$par );
59  }
60 
61  # Don't let the user get stuck with a certain date
62  if ( $opts->getValue( 'offset' ) || $opts->getValue( 'dir' ) == 'prev' ) {
63  $opts->setValue( 'year', '' );
64  $opts->setValue( 'month', '' );
65  }
66 
67  // If the user doesn't have the right permission to view the specific
68  // log type, throw a PermissionsError
69  // If the log type is invalid, just show all public logs
70  $logRestrictions = $this->getConfig()->get( 'LogRestrictions' );
71  $type = $opts->getValue( 'type' );
72  if ( !LogPage::isLogType( $type ) ) {
73  $opts->setValue( 'type', '' );
74  } elseif ( isset( $logRestrictions[$type] )
75  && !$this->getUser()->isAllowed( $logRestrictions[$type] )
76  ) {
77  throw new PermissionsError( $logRestrictions[$type] );
78  }
79 
80  # Handle type-specific inputs
81  $qc = [];
82  if ( $opts->getValue( 'type' ) == 'suppress' ) {
83  $offender = User::newFromName( $opts->getValue( 'offender' ), false );
84  if ( $offender && $offender->getId() > 0 ) {
85  $qc = [ 'ls_field' => 'target_author_id', 'ls_value' => $offender->getId() ];
86  } elseif ( $offender && IP::isIPAddress( $offender->getName() ) ) {
87  $qc = [ 'ls_field' => 'target_author_ip', 'ls_value' => $offender->getName() ];
88  }
89  } else {
90  // Allow extensions to add relations to their search types
91  Hooks::run(
92  'SpecialLogAddLogSearchRelations',
93  [ $opts->getValue( 'type' ), $this->getRequest(), &$qc ]
94  );
95  }
96 
97  # Some log types are only for a 'User:' title but we might have been given
98  # only the username instead of the full title 'User:username'. This part try
99  # to lookup for a user by that name and eventually fix user input. See bug 1697.
100  if ( in_array( $opts->getValue( 'type' ), self::getLogTypesOnUser() ) ) {
101  # ok we have a type of log which expect a user title.
102  $target = Title::newFromText( $opts->getValue( 'page' ) );
103  if ( $target && $target->getNamespace() === NS_MAIN ) {
104  # User forgot to add 'User:', we are adding it for him
105  $opts->setValue( 'page',
106  Title::makeTitleSafe( NS_USER, $opts->getValue( 'page' ) )
107  );
108  }
109  }
110 
111  $this->show( $opts, $qc );
112  }
113 
122  public static function getLogTypesOnUser() {
123  static $types = null;
124  if ( $types !== null ) {
125  return $types;
126  }
127  $types = [
128  'block',
129  'newusers',
130  'rights',
131  ];
132 
133  Hooks::run( 'GetLogTypesOnUser', [ &$types ] );
134  return $types;
135  }
136 
142  public function getSubpagesForPrefixSearch() {
143  $subpages = $this->getConfig()->get( 'LogTypes' );
144  $subpages[] = 'all';
145  sort( $subpages );
146  return $subpages;
147  }
148 
149  private function parseParams( FormOptions $opts, $par ) {
150  # Get parameters
151  $par = $par !== null ? $par : '';
152  $parms = explode( '/', $par );
153  $symsForAll = [ '*', 'all' ];
154  if ( $parms[0] != '' &&
155  ( in_array( $par, $this->getConfig()->get( 'LogTypes' ) ) || in_array( $par, $symsForAll ) )
156  ) {
157  $opts->setValue( 'type', $par );
158  } elseif ( count( $parms ) == 2 ) {
159  $opts->setValue( 'type', $parms[0] );
160  $opts->setValue( 'user', $parms[1] );
161  } elseif ( $par != '' ) {
162  $opts->setValue( 'user', $par );
163  }
164  }
165 
166  private function show( FormOptions $opts, array $extraConds ) {
167  # Create a LogPager item to get the results and a LogEventsList item to format them...
168  $loglist = new LogEventsList(
169  $this->getContext(),
170  null,
172  );
173 
174  $pager = new LogPager(
175  $loglist,
176  $opts->getValue( 'type' ),
177  $opts->getValue( 'user' ),
178  $opts->getValue( 'page' ),
179  $opts->getValue( 'pattern' ),
180  $extraConds,
181  $opts->getValue( 'year' ),
182  $opts->getValue( 'month' ),
183  $opts->getValue( 'tagfilter' ),
184  $opts->getValue( 'subtype' )
185  );
186 
187  $this->addHeader( $opts->getValue( 'type' ) );
188 
189  # Set relevant user
190  if ( $pager->getPerformer() ) {
191  $performerUser = User::newFromName( $pager->getPerformer(), false );
192  $this->getSkin()->setRelevantUser( $performerUser );
193  }
194 
195  # Show form options
196  $loglist->showOptions(
197  $pager->getType(),
198  $pager->getPerformer(),
199  $pager->getPage(),
200  $pager->getPattern(),
201  $pager->getYear(),
202  $pager->getMonth(),
203  $pager->getFilterParams(),
204  $pager->getTagFilter(),
205  $pager->getAction()
206  );
207 
208  # Insert list
209  $logBody = $pager->getBody();
210  if ( $logBody ) {
211  $this->getOutput()->addHTML(
212  $pager->getNavigationBar() .
213  $this->getActionButtons(
214  $loglist->beginLogEventsList() .
215  $logBody .
216  $loglist->endLogEventsList()
217  ) .
218  $pager->getNavigationBar()
219  );
220  } else {
221  $this->getOutput()->addWikiMsg( 'logempty' );
222  }
223  }
224 
225  private function getActionButtons( $formcontents ) {
226  $user = $this->getUser();
227  $canRevDelete = $user->isAllowedAll( 'deletedhistory', 'deletelogentry' );
228  $showTagEditUI = ChangeTags::showTagEditingUI( $user );
229  # If the user doesn't have the ability to delete log entries nor edit tags,
230  # don't bother showing them the button(s).
231  if ( !$canRevDelete && !$showTagEditUI ) {
232  return $formcontents;
233  }
234 
235  # Show button to hide log entries and/or edit change tags
237  'form',
238  [ 'action' => wfScript(), 'id' => 'mw-log-deleterevision-submit' ]
239  ) . "\n";
240  $s .= Html::hidden( 'action', 'historysubmit' ) . "\n";
241  $s .= Html::hidden( 'type', 'logging' ) . "\n";
242 
243  $buttons = '';
244  if ( $canRevDelete ) {
245  $buttons .= Html::element(
246  'button',
247  [
248  'type' => 'submit',
249  'name' => 'revisiondelete',
250  'value' => '1',
251  'class' => "deleterevision-log-submit mw-log-deleterevision-button"
252  ],
253  $this->msg( 'showhideselectedlogentries' )->text()
254  ) . "\n";
255  }
256  if ( $showTagEditUI ) {
257  $buttons .= Html::element(
258  'button',
259  [
260  'type' => 'submit',
261  'name' => 'editchangetags',
262  'value' => '1',
263  'class' => "editchangetags-log-submit mw-log-editchangetags-button"
264  ],
265  $this->msg( 'log-edit-tags' )->text()
266  ) . "\n";
267  }
268 
269  $buttons .= ( new ListToggle( $this->getOutput() ) )->getHTML();
270 
271  $s .= $buttons . $formcontents . $buttons;
272  $s .= Html::closeElement( 'form' );
273 
274  return $s;
275  }
276 
282  protected function addHeader( $type ) {
283  $page = new LogPage( $type );
284  $this->getOutput()->setPageTitle( $page->getName() );
285  $this->getOutput()->addHTML( $page->getDescription()
286  ->setContext( $this->getContext() )->parseAsBlock() );
287  }
288 
289  protected function getGroupName() {
290  return 'changes';
291  }
292 }
Class for generating clickable toggle links for a list of checkboxes.
Definition: ListToggle.php:31
static newFromName($name, $validate= 'valid')
Static factory method for creation from username.
Definition: User.php:525
static closeElement($element)
Returns "".
Definition: Html.php:305
Helper class to keep track of options when mixing links and form elements.
Definition: FormOptions.php:35
const USE_CHECKBOXES
the array() calling protocol came about after MediaWiki 1.4rc1.
getContext()
Gets the context this SpecialPage is executed in.
wfScript($script= 'index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
getActionButtons($formcontents)
Definition: SpecialLog.php:225
parseParams(FormOptions $opts, $par)
Definition: SpecialLog.php:149
const NS_MAIN
Definition: Defines.php:56
setValue($name, $value, $force=false)
Use to set the value of an option.
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
const INTNULL
Integer type or null, maps to WebRequest::getIntOrNull() This is useful for the namespace selector...
Definition: FormOptions.php:54
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept.
Definition: SpecialLog.php:142
addHeader($type)
Set page title and show header for this log type.
Definition: SpecialLog.php:282
static hidden($name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:758
msg()
Wrapper around wfMessage that sets the current context.
getOutput()
Get the OutputPage being used for this instance.
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:262
static isIPAddress($ip)
Determine if a string is as valid IP address or network (CIDR prefix).
Definition: IP.php:79
addHelpLink($to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
outputHeader($summaryMessageKey= '')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Class to simplify the use of log pages.
Definition: LogPage.php:32
Parent class for all special pages.
Definition: SpecialPage.php:36
static openElement($element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:247
getValue($name)
Get the value for the given option name.
getSkin()
Shortcut to get the skin being used for this instance.
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! ...
static makeTitleSafe($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:535
A special page that lists log entries.
Definition: SpecialLog.php:31
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
static isLogType($type)
Is $type a valid log type.
Definition: LogPage.php:210
add($name, $default, $type=self::AUTO)
Add an option to be handled by this FormOptions instance.
Definition: FormOptions.php:78
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
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
show(FormOptions $opts, array $extraConds)
Definition: SpecialLog.php:166
getUser()
Shortcut to get the User executing this instance.
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:122
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...
getRequest()
Get the WebRequest being used for this instance.
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:229
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 one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
execute($par)
Definition: SpecialLog.php:36
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