MediaWiki  REL1_31
SpecialLog.php
Go to the documentation of this file.
1 <?php
29 class SpecialLog extends SpecialPage {
30  public function __construct() {
31  parent::__construct( 'Log' );
32  }
33 
34  public function execute( $par ) {
36 
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  $opts->add( 'logid', '' );
55 
56  // Set values
57  $opts->fetchValuesFromRequest( $this->getRequest() );
58  if ( $par !== null ) {
59  $this->parseParams( $opts, (string)$par );
60  }
61 
62  # Don't let the user get stuck with a certain date
63  if ( $opts->getValue( 'offset' ) || $opts->getValue( 'dir' ) == 'prev' ) {
64  $opts->setValue( 'year', '' );
65  $opts->setValue( 'month', '' );
66  }
67 
68  // If the user doesn't have the right permission to view the specific
69  // log type, throw a PermissionsError
70  // If the log type is invalid, just show all public logs
71  $logRestrictions = $this->getConfig()->get( 'LogRestrictions' );
72  $type = $opts->getValue( 'type' );
73  if ( !LogPage::isLogType( $type ) ) {
74  $opts->setValue( 'type', '' );
75  } elseif ( isset( $logRestrictions[$type] )
76  && !$this->getUser()->isAllowed( $logRestrictions[$type] )
77  ) {
78  throw new PermissionsError( $logRestrictions[$type] );
79  }
80 
81  # Handle type-specific inputs
82  $qc = [];
83  if ( $opts->getValue( 'type' ) == 'suppress' ) {
84  $offenderName = $opts->getValue( 'offender' );
85  $offender = empty( $offenderName ) ? null : User::newFromName( $offenderName, false );
86  if ( $offender ) {
88  $qc = [ 'ls_field' => 'target_author_actor', 'ls_value' => $offender->getActorId() ];
89  } else {
90  if ( $offender->getId() > 0 ) {
91  $field = 'target_author_id';
92  $value = $offender->getId();
93  } else {
94  $field = 'target_author_ip';
95  $value = $offender->getName();
96  }
97  if ( !$offender->getActorId() ) {
98  $qc = [ 'ls_field' => $field, 'ls_value' => $value ];
99  } else {
100  $db = wfGetDB( DB_REPLICA );
101  $qc = [
102  'ls_field' => [ 'target_author_actor', $field ], // So LogPager::getQueryInfo() works right
103  $db->makeList( [
104  $db->makeList(
105  [ 'ls_field' => 'target_author_actor', 'ls_value' => $offender->getActorId() ], LIST_AND
106  ),
107  $db->makeList( [ 'ls_field' => $field, 'ls_value' => $value ], LIST_AND ),
108  ], LIST_OR ),
109  ];
110  }
111  }
112  }
113  } else {
114  // Allow extensions to add relations to their search types
115  Hooks::run(
116  'SpecialLogAddLogSearchRelations',
117  [ $opts->getValue( 'type' ), $this->getRequest(), &$qc ]
118  );
119  }
120 
121  # Some log types are only for a 'User:' title but we might have been given
122  # only the username instead of the full title 'User:username'. This part try
123  # to lookup for a user by that name and eventually fix user input. See T3697.
124  if ( in_array( $opts->getValue( 'type' ), self::getLogTypesOnUser() ) ) {
125  # ok we have a type of log which expect a user title.
126  $target = Title::newFromText( $opts->getValue( 'page' ) );
127  if ( $target && $target->getNamespace() === NS_MAIN ) {
128  # User forgot to add 'User:', we are adding it for him
129  $opts->setValue( 'page',
130  Title::makeTitleSafe( NS_USER, $opts->getValue( 'page' ) )
131  );
132  }
133  }
134 
135  $this->show( $opts, $qc );
136  }
137 
146  public static function getLogTypesOnUser() {
147  static $types = null;
148  if ( $types !== null ) {
149  return $types;
150  }
151  $types = [
152  'block',
153  'newusers',
154  'rights',
155  ];
156 
157  Hooks::run( 'GetLogTypesOnUser', [ &$types ] );
158  return $types;
159  }
160 
166  public function getSubpagesForPrefixSearch() {
167  $subpages = $this->getConfig()->get( 'LogTypes' );
168  $subpages[] = 'all';
169  sort( $subpages );
170  return $subpages;
171  }
172 
183  private function parseParams( FormOptions $opts, $par ) {
184  # Get parameters
185  $par = $par !== null ? $par : '';
186  $parms = explode( '/', $par );
187  $symsForAll = [ '*', 'all' ];
188  if ( $parms[0] != '' &&
189  ( in_array( $par, $this->getConfig()->get( 'LogTypes' ) ) || in_array( $par, $symsForAll ) )
190  ) {
191  $opts->setValue( 'type', $par );
192  } elseif ( count( $parms ) == 2 ) {
193  $opts->setValue( 'type', $parms[0] );
194  $opts->setValue( 'user', $parms[1] );
195  } elseif ( $par != '' ) {
196  $opts->setValue( 'user', $par );
197  }
198  }
199 
200  private function show( FormOptions $opts, array $extraConds ) {
201  # Create a LogPager item to get the results and a LogEventsList item to format them...
202  $loglist = new LogEventsList(
203  $this->getContext(),
204  $this->getLinkRenderer(),
206  );
207 
208  $pager = new LogPager(
209  $loglist,
210  $opts->getValue( 'type' ),
211  $opts->getValue( 'user' ),
212  $opts->getValue( 'page' ),
213  $opts->getValue( 'pattern' ),
214  $extraConds,
215  $opts->getValue( 'year' ),
216  $opts->getValue( 'month' ),
217  $opts->getValue( 'tagfilter' ),
218  $opts->getValue( 'subtype' ),
219  $opts->getValue( 'logid' )
220  );
221 
222  $this->addHeader( $opts->getValue( 'type' ) );
223 
224  # Set relevant user
225  if ( $pager->getPerformer() ) {
226  $performerUser = User::newFromName( $pager->getPerformer(), false );
227  $this->getSkin()->setRelevantUser( $performerUser );
228  }
229 
230  # Show form options
231  $loglist->showOptions(
232  $pager->getType(),
233  $pager->getPerformer(),
234  $pager->getPage(),
235  $pager->getPattern(),
236  $pager->getYear(),
237  $pager->getMonth(),
238  $pager->getFilterParams(),
239  $pager->getTagFilter(),
240  $pager->getAction()
241  );
242 
243  # Insert list
244  $logBody = $pager->getBody();
245  if ( $logBody ) {
246  $this->getOutput()->addHTML(
247  $pager->getNavigationBar() .
248  $this->getActionButtons(
249  $loglist->beginLogEventsList() .
250  $logBody .
251  $loglist->endLogEventsList()
252  ) .
253  $pager->getNavigationBar()
254  );
255  } else {
256  $this->getOutput()->addWikiMsg( 'logempty' );
257  }
258  }
259 
260  private function getActionButtons( $formcontents ) {
261  $user = $this->getUser();
262  $canRevDelete = $user->isAllowedAll( 'deletedhistory', 'deletelogentry' );
263  $showTagEditUI = ChangeTags::showTagEditingUI( $user );
264  # If the user doesn't have the ability to delete log entries nor edit tags,
265  # don't bother showing them the button(s).
266  if ( !$canRevDelete && !$showTagEditUI ) {
267  return $formcontents;
268  }
269 
270  # Show button to hide log entries and/or edit change tags
272  'form',
273  [ 'action' => wfScript(), 'id' => 'mw-log-deleterevision-submit' ]
274  ) . "\n";
275  $s .= Html::hidden( 'action', 'historysubmit' ) . "\n";
276  $s .= Html::hidden( 'type', 'logging' ) . "\n";
277 
278  $buttons = '';
279  if ( $canRevDelete ) {
280  $buttons .= Html::element(
281  'button',
282  [
283  'type' => 'submit',
284  'name' => 'revisiondelete',
285  'value' => '1',
286  'class' => "deleterevision-log-submit mw-log-deleterevision-button"
287  ],
288  $this->msg( 'showhideselectedlogentries' )->text()
289  ) . "\n";
290  }
291  if ( $showTagEditUI ) {
292  $buttons .= Html::element(
293  'button',
294  [
295  'type' => 'submit',
296  'name' => 'editchangetags',
297  'value' => '1',
298  'class' => "editchangetags-log-submit mw-log-editchangetags-button"
299  ],
300  $this->msg( 'log-edit-tags' )->text()
301  ) . "\n";
302  }
303 
304  $buttons .= ( new ListToggle( $this->getOutput() ) )->getHTML();
305 
306  $s .= $buttons . $formcontents . $buttons;
307  $s .= Html::closeElement( 'form' );
308 
309  return $s;
310  }
311 
317  protected function addHeader( $type ) {
318  $page = new LogPage( $type );
319  $this->getOutput()->setPageTitle( $page->getName() );
320  $this->getOutput()->addHTML( $page->getDescription()
321  ->setContext( $this->getContext() )->parseAsBlock() );
322  }
323 
324  protected function getGroupName() {
325  return 'changes';
326  }
327 }
$user
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 account $user
Definition: hooks.txt:247
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:273
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
SpecialLog\parseParams
parseParams(FormOptions $opts, $par)
Set options based on the subpage title parts:
Definition: SpecialLog.php:183
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:722
array
the array() calling protocol came about after MediaWiki 1.4rc1.
FormOptions\getValue
getValue( $name)
Get the value for the given option name.
Definition: FormOptions.php:180
text
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:18
FormOptions\INTNULL
const INTNULL
Integer type or null, maps to WebRequest::getIntOrNull() This is useful for the namespace selector.
Definition: FormOptions.php:54
MIGRATION_NEW
const MIGRATION_NEW
Definition: Defines.php:305
SpecialLog\getActionButtons
getActionButtons( $formcontents)
Definition: SpecialLog.php:260
LogPager
Definition: LogPager.php:29
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
$s
$s
Definition: mergeMessageFileList.php:187
SpecialPage\getSkin
getSkin()
Shortcut to get the skin being used for this instance.
Definition: SpecialPage.php:742
ChangeTags\showTagEditingUI
static showTagEditingUI(User $user)
Indicate whether change tag editing UI is relevant.
Definition: ChangeTags.php:1460
PermissionsError
Show an error when a user tries to do something they do not have the necessary permissions for.
Definition: PermissionsError.php:28
LogEventsList\USE_CHECKBOXES
const USE_CHECKBOXES
Definition: LogEventsList.php:33
php
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:37
LIST_AND
const LIST_AND
Definition: Defines.php:53
NS_MAIN
const NS_MAIN
Definition: Defines.php:74
FormOptions\add
add( $name, $default, $type=self::AUTO)
Add an option to be handled by this FormOptions instance.
Definition: FormOptions.php:81
Html\closeElement
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:309
SpecialPage\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: SpecialPage.php:832
LIST_OR
const LIST_OR
Definition: Defines.php:56
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:761
wfScript
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:2890
ListToggle
Class for generating clickable toggle links for a list of checkboxes.
Definition: ListToggle.php:31
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
LogPage\isLogType
static isLogType( $type)
Is $type a valid log type.
Definition: LogPage.php:204
LogPage
Class to simplify the use of log pages.
Definition: LogPage.php:31
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:146
SpecialLog\__construct
__construct()
Definition: SpecialLog.php:30
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:527
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:732
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
LogEventsList
Definition: LogEventsList.php:30
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:695
FormOptions\setValue
setValue( $name, $value, $force=false)
Use to set the value of an option.
Definition: FormOptions.php:163
Html\hidden
static hidden( $name, $value, array $attribs=[])
Convenience function to produce an input element with type=hidden.
Definition: Html.php:774
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:562
$value
$value
Definition: styleTest.css.php:45
SpecialPage
Parent class for all special pages.
Definition: SpecialPage.php:36
SpecialLog\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialLog.php:324
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:712
SpecialLog\show
show(FormOptions $opts, array $extraConds)
Definition: SpecialLog.php:200
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:907
SpecialLog
A special page that lists log entries.
Definition: SpecialLog.php:29
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:76
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
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
SpecialLog\execute
execute( $par)
Default execute method Checks user permissions.
Definition: SpecialLog.php:34
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:629
SpecialLog\getSubpagesForPrefixSearch
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept.
Definition: SpecialLog.php:166
SpecialLog\addHeader
addHeader( $type)
Set page title and show header for this log type.
Definition: SpecialLog.php:317
$type
$type
Definition: testCompression.php:48
$wgActorTableSchemaMigrationStage
int $wgActorTableSchemaMigrationStage
Actor table schema migration stage.
Definition: DefaultSettings.php:8878