includes/specials/SpecialLog.php

   1 <?php
   2 /**
   3  * Implements Special:Log
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 use MediaWiki\MediaWikiServices;
  25 use Wikimedia\Timestamp\TimestampException;
  26
  27 /**
  28  * A special page that lists log entries
  29  *
  30  * @ingroup SpecialPage
  31  */
  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()
  98                                 ->getPermissionManager()
  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' => $offender->getActorId() ];
 111                         }
 112                 } else {
 113                         // Allow extensions to add relations to their search types
 114                         Hooks::run(
 115                                 'SpecialLogAddLogSearchRelations',
 116                                 [ $opts->getValue( 'type' ), $this->getRequest(), &$qc ]
 117                         );
 118                 }
 119
 120                 # Some log types are only for a 'User:' title but we might have been given
 121                 # only the username instead of the full title 'User:username'. This part try
 122                 # to lookup for a user by that name and eventually fix user input. See T3697.
 123                 if ( in_array( $opts->getValue( 'type' ), self::getLogTypesOnUser() ) ) {
 124                         # ok we have a type of log which expect a user title.
 125                         $target = Title::newFromText( $opts->getValue( 'page' ) );
 126                         if ( $target && $target->getNamespace() === NS_MAIN ) {
 127                                 # User forgot to add 'User:', we are adding it for him
 128                                 $opts->setValue( 'page',
 129                                         Title::makeTitleSafe( NS_USER, $opts->getValue( 'page' ) )
 130                                 );
 131                         }
 132                 }
 133
 134                 $this->show( $opts, $qc );
 135         }
 136
 137         /**
 138          * List log type for which the target is a user
 139          * Thus if the given target is in NS_MAIN we can alter it to be an NS_USER
 140          * Title user instead.
 141          *
 142          * @since 1.25
 143          * @return array
 144          */
 145         public static function getLogTypesOnUser() {
 146                 static $types = null;
 147                 if ( $types !== null ) {
 148                         return $types;
 149                 }
 150                 $types = [
 151                         'block',
 152                         'newusers',
 153                         'rights',
 154                 ];
 155
 156                 Hooks::run( 'GetLogTypesOnUser', [ &$types ] );
 157                 return $types;
 158         }
 159
 160         /**
 161          * Return an array of subpages that this special page will accept.
 162          *
 163          * @return string[] subpages
 164          */
 165         public function getSubpagesForPrefixSearch() {
 166                 $subpages = LogPage::validTypes();
 167                 $subpages[] = 'all';
 168                 sort( $subpages );
 169                 return $subpages;
 170         }
 171
 172         /**
 173          * Set options based on the subpage title parts:
 174          * - One part that is a valid log type: Special:Log/logtype
 175          * - Two parts: Special:Log/logtype/username
 176          * - Otherwise, assume the whole subpage is a username.
 177          *
 178          * @param FormOptions $opts
 179          * @param string $par
 180          */
 181         private function parseParams( FormOptions $opts, $par ) {
 182                 # Get parameters
 183                 $par = $par ?? '';
 184                 $parms = explode( '/', $par );
 185                 $symsForAll = [ '*', 'all' ];
 186                 if ( $parms[0] != '' &&
 187                         ( in_array( $par, LogPage::validTypes() ) || in_array( $par, $symsForAll ) )
 188                 ) {
 189                         $opts->setValue( 'type', $par );
 190                 } elseif ( count( $parms ) == 2 ) {
 191                         $opts->setValue( 'type', $parms[0] );
 192                         $opts->setValue( 'user', $parms[1] );
 193                 } elseif ( $par != '' ) {
 194                         $opts->setValue( 'user', $par );
 195                 }
 196         }
 197
 198         private function show( FormOptions $opts, array $extraConds ) {
 199                 # Create a LogPager item to get the results and a LogEventsList item to format them...
 200                 $loglist = new LogEventsList(
 201                         $this->getContext(),
 202                         $this->getLinkRenderer(),
 203                         LogEventsList::USE_CHECKBOXES
 204                 );
 205
 206                 $pager = new LogPager(
 207                         $loglist,
 208                         $opts->getValue( 'type' ),
 209                         $opts->getValue( 'user' ),
 210                         $opts->getValue( 'page' ),
 211                         $opts->getValue( 'pattern' ),
 212                         $extraConds,
 213                         $opts->getValue( 'year' ),
 214                         $opts->getValue( 'month' ),
 215                         $opts->getValue( 'day' ),
 216                         $opts->getValue( 'tagfilter' ),
 217                         $opts->getValue( 'subtype' ),
 218                         $opts->getValue( 'logid' )
 219                 );
 220
 221                 $this->addHeader( $opts->getValue( 'type' ) );
 222
 223                 # Set relevant user
 224                 if ( $pager->getPerformer() ) {
 225                         $performerUser = User::newFromName( $pager->getPerformer(), false );
 226                         $this->getSkin()->setRelevantUser( $performerUser );
 227                 }
 228
 229                 # Show form options
 230                 $loglist->showOptions(
 231                         $pager->getType(),
 232                         $pager->getPerformer(),
 233                         $pager->getPage(),
 234                         $pager->getPattern(),
 235                         $pager->getYear(),
 236                         $pager->getMonth(),
 237                         $pager->getDay(),
 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 = MediaWikiServices::getInstance()
 263                         ->getPermissionManager()
 264                         ->userHasAllRights( $user, 'deletedhistory', 'deletelogentry' );
 265                 $showTagEditUI = ChangeTags::showTagEditingUI( $user );
 266                 # If the user doesn't have the ability to delete log entries nor edit tags,
 267                 # don't bother showing them the button(s).
 268                 if ( !$canRevDelete && !$showTagEditUI ) {
 269                         return $formcontents;
 270                 }
 271
 272                 # Show button to hide log entries and/or edit change tags
 273                 $s = Html::openElement(
 274                         'form',
 275                         [ 'action' => wfScript(), 'id' => 'mw-log-deleterevision-submit' ]
 276                 ) . "\n";
 277                 $s .= Html::hidden( 'action', 'historysubmit' ) . "\n";
 278                 $s .= Html::hidden( 'type', 'logging' ) . "\n";
 279
 280                 $buttons = '';
 281                 if ( $canRevDelete ) {
 282                         $buttons .= Html::element(
 283                                 'button',
 284                                 [
 285                                         'type' => 'submit',
 286                                         'name' => 'revisiondelete',
 287                                         'value' => '1',
 288                                         'class' => "deleterevision-log-submit mw-log-deleterevision-button"
 289                                 ],
 290                                 $this->msg( 'showhideselectedlogentries' )->text()
 291                         ) . "\n";
 292                 }
 293                 if ( $showTagEditUI ) {
 294                         $buttons .= Html::element(
 295                                 'button',
 296                                 [
 297                                         'type' => 'submit',
 298                                         'name' => 'editchangetags',
 299                                         'value' => '1',
 300                                         'class' => "editchangetags-log-submit mw-log-editchangetags-button"
 301                                 ],
 302                                 $this->msg( 'log-edit-tags' )->text()
 303                         ) . "\n";
 304                 }
 305
 306                 $buttons .= ( new ListToggle( $this->getOutput() ) )->getHTML();
 307
 308                 $s .= $buttons . $formcontents . $buttons;
 309                 $s .= Html::closeElement( 'form' );
 310
 311                 return $s;
 312         }
 313
 314         /**
 315          * Set page title and show header for this log type
 316          * @param string $type
 317          * @since 1.19
 318          */
 319         protected function addHeader( $type ) {
 320                 $page = new LogPage( $type );
 321                 $this->getOutput()->setPageTitle( $page->getName() );
 322                 $this->getOutput()->addHTML( $page->getDescription()
 323                         ->setContext( $this->getContext() )->parseAsBlock() );
 324         }
 325
 326         protected function getGroupName() {
 327                 return 'changes';
 328         }
 329 }