3 * Implements Special:Log
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
24 use Wikimedia\Timestamp\TimestampException
;
27 * A special page that lists log entries
29 * @ingroup SpecialPage
31 class SpecialLog
extends SpecialPage
{
32 public function __construct() {
33 parent
::__construct( 'Log' );
36 public function execute( $par ) {
37 global $wgActorTableSchemaMigrationStage;
40 $this->outputHeader();
41 $this->getOutput()->addModules( 'mediawiki.userSuggest' );
42 $this->addHelpLink( 'Help:Log' );
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', '' );
60 $opts->fetchValuesFromRequest( $this->getRequest() );
61 if ( $par !== null ) {
62 $this->parseParams( $opts, (string)$par );
66 $dateString = $this->getRequest()->getVal( 'wpdate' );
67 if ( !empty( $dateString ) ) {
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)
76 $opts->setValue( 'year', (int)$dateStamp->format( 'Y' ) );
77 $opts->setValue( 'month', (int)$dateStamp->format( 'm' ) );
78 $opts->setValue( 'day', (int)$dateStamp->format( 'd' ) );
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', '' );
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] )
98 throw new PermissionsError( $logRestrictions[$type] );
101 # Handle type-specific inputs
103 if ( $opts->getValue( 'type' ) == 'suppress' ) {
104 $offenderName = $opts->getValue( 'offender' );
105 $offender = empty( $offenderName ) ?
null : User
::newFromName( $offenderName, false );
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() ];
112 $qc = [ 'ls_field' => 'target_author_ip', 'ls_value' => $offender->getName() ];
116 // Allow extensions to add relations to their search types
118 'SpecialLogAddLogSearchRelations',
119 [ $opts->getValue( 'type' ), $this->getRequest(), &$qc ]
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' ) )
137 $this->show( $opts, $qc );
141 * List log type for which the target is a user
142 * Thus if the given target is in NS_MAIN we can alter it to be an NS_USER
143 * Title user instead.
148 public static function getLogTypesOnUser() {
149 static $types = null;
150 if ( $types !== null ) {
159 Hooks
::run( 'GetLogTypesOnUser', [ &$types ] );
164 * Return an array of subpages that this special page will accept.
166 * @return string[] subpages
168 public function getSubpagesForPrefixSearch() {
169 $subpages = LogPage
::validTypes();
176 * Set options based on the subpage title parts:
177 * - One part that is a valid log type: Special:Log/logtype
178 * - Two parts: Special:Log/logtype/username
179 * - Otherwise, assume the whole subpage is a username.
181 * @param FormOptions $opts
183 * @throws ConfigException
185 private function parseParams( FormOptions
$opts, $par ) {
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 ) )
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 );
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(
206 $this->getLinkRenderer(),
207 LogEventsList
::USE_CHECKBOXES
210 $pager = new LogPager(
212 $opts->getValue( 'type' ),
213 $opts->getValue( 'user' ),
214 $opts->getValue( 'page' ),
215 $opts->getValue( 'pattern' ),
217 $opts->getValue( 'year' ),
218 $opts->getValue( 'month' ),
219 $opts->getValue( 'day' ),
220 $opts->getValue( 'tagfilter' ),
221 $opts->getValue( 'subtype' ),
222 $opts->getValue( 'logid' )
225 $this->addHeader( $opts->getValue( 'type' ) );
228 if ( $pager->getPerformer() ) {
229 $performerUser = User
::newFromName( $pager->getPerformer(), false );
230 $this->getSkin()->setRelevantUser( $performerUser );
234 $loglist->showOptions(
236 $pager->getPerformer(),
238 $pager->getPattern(),
242 $pager->getFilterParams(),
243 $pager->getTagFilter(),
248 $logBody = $pager->getBody();
250 $this->getOutput()->addHTML(
251 $pager->getNavigationBar() .
252 $this->getActionButtons(
253 $loglist->beginLogEventsList() .
255 $loglist->endLogEventsList()
257 $pager->getNavigationBar()
260 $this->getOutput()->addWikiMsg( 'logempty' );
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;
274 # Show button to hide log entries and/or edit change tags
275 $s = Html
::openElement(
277 [ 'action' => wfScript(), 'id' => 'mw-log-deleterevision-submit' ]
279 $s .= Html
::hidden( 'action', 'historysubmit' ) . "\n";
280 $s .= Html
::hidden( 'type', 'logging' ) . "\n";
283 if ( $canRevDelete ) {
284 $buttons .= Html
::element(
288 'name' => 'revisiondelete',
290 'class' => "deleterevision-log-submit mw-log-deleterevision-button"
292 $this->msg( 'showhideselectedlogentries' )->text()
295 if ( $showTagEditUI ) {
296 $buttons .= Html
::element(
300 'name' => 'editchangetags',
302 'class' => "editchangetags-log-submit mw-log-editchangetags-button"
304 $this->msg( 'log-edit-tags' )->text()
308 $buttons .= ( new ListToggle( $this->getOutput() ) )->getHTML();
310 $s .= $buttons . $formcontents . $buttons;
311 $s .= Html
::closeElement( 'form' );
317 * Set page title and show header for this log type
318 * @param string $type
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() );
328 protected function getGroupName() {