<?php
/**
- * Copyright (C) 2008 Aaron Schulz
+ * Implements Special:Log
+ *
+ * Copyright © 2008 Aaron Schulz
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
- */
-
-/**
+ *
* @file
* @ingroup SpecialPage
*/
/**
- * constructor
+ * A special page that lists log entries
+ *
+ * @ingroup SpecialPage
*/
-function wfSpecialLog( $par = '' ) {
- global $wgRequest, $wgOut, $wgUser, $wgLogTypes;
-
- # Get parameters
- $parms = explode( '/', ($par = ( $par !== null ) ? $par : '' ) );
- $symsForAll = array( '*', 'all' );
- if ( $parms[0] != '' && ( in_array( $par, $wgLogTypes ) || in_array( $par, $symsForAll ) ) ) {
- $type = $par;
- $user = $wgRequest->getText( 'user' );
- } else if ( count( $parms ) == 2 ) {
- $type = $parms[0];
- $user = $parms[1];
- } else {
- $type = $wgRequest->getVal( 'type' );
- $user = ( $par != '' ) ? $par : $wgRequest->getText( 'user' );
+class SpecialLog extends SpecialPage {
+
+ /**
+ * List log type for which the target is a user
+ * Thus if the given target is in NS_MAIN we can alter it to be an NS_USER
+ * Title user instead.
+ */
+ private $typeOnUser = array(
+ 'block',
+ 'newusers',
+ 'right',
+ );
+
+ public function __construct() {
+ parent::__construct( 'Log' );
+ }
+
+ public function execute( $par ) {
+ global $wgLogRestrictions;
+
+ $this->setHeaders();
+ $this->outputHeader();
+
+ $opts = new FormOptions;
+ $opts->add( 'type', '' );
+ $opts->add( 'user', '' );
+ $opts->add( 'page', '' );
+ $opts->add( 'pattern', false );
+ $opts->add( 'year', null, FormOptions::INTNULL );
+ $opts->add( 'month', null, FormOptions::INTNULL );
+ $opts->add( 'tagfilter', '' );
+ $opts->add( 'offset', '' );
+ $opts->add( 'dir', '' );
+ $opts->add( 'offender', '' );
+
+ // Set values
+ $opts->fetchValuesFromRequest( $this->getRequest() );
+ if ( $par ) {
+ $this->parseParams( $opts, (string)$par );
+ }
+
+ # Don't let the user get stuck with a certain date
+ if ( $opts->getValue( 'offset' ) || $opts->getValue( 'dir' ) == 'prev' ) {
+ $opts->setValue( 'year', '' );
+ $opts->setValue( 'month', '' );
+ }
+
+ // Reset the log type to default (nothing) if it's invalid or if the
+ // user does not possess the right to view it
+ $type = $opts->getValue( 'type' );
+ if ( !LogPage::isLogType( $type )
+ || ( isset( $wgLogRestrictions[$type] )
+ && !$this->getUser()->isAllowed( $wgLogRestrictions[$type] ) )
+ ) {
+ $opts->setValue( 'type', '' );
+ }
+
+ # Handle type-specific inputs
+ $qc = array();
+ if ( $opts->getValue( 'type' ) == 'suppress' ) {
+ $offender = User::newFromName( $opts->getValue( 'offender' ), false );
+ if ( $offender && $offender->getId() > 0 ) {
+ $qc = array( 'ls_field' => 'target_author_id', 'ls_value' => $offender->getId() );
+ } elseif ( $offender && IP::isIPAddress( $offender->getName() ) ) {
+ $qc = array( 'ls_field' => 'target_author_ip', 'ls_value' => $offender->getName() );
+ }
+ }
+
+ # Some log types are only for a 'User:' title but we might have been given
+ # only the username instead of the full title 'User:username'. This part try
+ # to lookup for a user by that name and eventually fix user input. See bug 1697.
+ if( in_array( $opts->getValue( 'type' ), $this->typeOnUser ) ) {
+ # ok we have a type of log which expect a user title.
+ $target = Title::newFromText( $opts->getValue( 'page' ) );
+ if( $target->getNamespace() === NS_MAIN ) {
+ # User forgot to add 'User:', we are adding it for him
+ $opts->setValue( 'page',
+ Title::makeTitleSafe( NS_USER, $opts->getValue( 'page' ) )
+ );
+ }
+ }
+
+ $this->show( $opts, $qc );
}
- $title = $wgRequest->getText( 'page' );
- $pattern = $wgRequest->getBool( 'pattern' );
- $y = $wgRequest->getIntOrNull( 'year' );
- $m = $wgRequest->getIntOrNull( 'month' );
- $tagFilter = $wgRequest->getVal( 'tagfilter' );
- # Don't let the user get stuck with a certain date
- $skip = $wgRequest->getText( 'offset' ) || $wgRequest->getText( 'dir' ) == 'prev';
- if( $skip ) {
- $y = '';
- $m = '';
+
+ private function parseParams( FormOptions $opts, $par ) {
+ global $wgLogTypes;
+
+ # Get parameters
+ $parms = explode( '/', ($par = ( $par !== null ) ? $par : '' ) );
+ $symsForAll = array( '*', 'all' );
+ if ( $parms[0] != '' && ( in_array( $par, $wgLogTypes ) || in_array( $par, $symsForAll ) ) ) {
+ $opts->setValue( 'type', $par );
+ } elseif ( count( $parms ) == 2 ) {
+ $opts->setValue( 'type', $parms[0] );
+ $opts->setValue( 'user', $parms[1] );
+ } elseif ( $par != '' ) {
+ $opts->setValue( 'user', $par );
+ }
}
- # Handle type-specific inputs
- $qc = array();
- if( $type == 'suppress' ) {
- $offender = User::newFromName( $wgRequest->getVal('offender'), false );
- if( $offender && $offender->getId() > 0 ) {
- $qc = array( 'ls_field' => 'target_author_id', 'ls_value' => $offender->getId() );
- } else if( $offender && IP::isIPAddress( $offender->getName() ) ) {
- $qc = array( 'ls_field' => 'target_author_ip', 'ls_value' => $offender->getName() );
+
+ private function show( FormOptions $opts, array $extraConds ) {
+ # Create a LogPager item to get the results and a LogEventsList item to format them...
+ $loglist = new LogEventsList( $this->getSkin(), $this->getOutput(), 0 );
+ $pager = new LogPager( $loglist, $opts->getValue( 'type' ), $opts->getValue( 'user' ),
+ $opts->getValue( 'page' ), $opts->getValue( 'pattern' ), $extraConds, $opts->getValue( 'year' ),
+ $opts->getValue( 'month' ), $opts->getValue( 'tagfilter' ) );
+
+ $this->addHeader( $opts->getValue( 'type' ) );
+
+ # Set relevant user
+ if ( $pager->getPerformer() ) {
+ $this->getSkin()->setRelevantUser( User::newFromName( $pager->getPerformer() ) );
+ }
+
+ # Show form options
+ $loglist->showOptions( $pager->getType(), $pager->getPerformer(), $pager->getPage(), $pager->getPattern(),
+ $pager->getYear(), $pager->getMonth(), $pager->getFilterParams(), $opts->getValue( 'tagfilter' ) );
+
+ # Insert list
+ $logBody = $pager->getBody();
+ if ( $logBody ) {
+ $this->getOutput()->addHTML(
+ $pager->getNavigationBar() .
+ $loglist->beginLogEventsList() .
+ $logBody .
+ $loglist->endLogEventsList() .
+ $pager->getNavigationBar()
+ );
+ } else {
+ $this->getOutput()->addWikiMsg( 'logempty' );
}
}
- # Create a LogPager item to get the results and a LogEventsList item to format them...
- $loglist = new LogEventsList( $wgUser->getSkin(), $wgOut, 0 );
- $pager = new LogPager( $loglist, $type, $user, $title, $pattern, $qc, $y, $m, $tagFilter );
- # Set title and add header
- $loglist->showHeader( $pager->getType() );
- # Show form options
- $loglist->showOptions( $pager->getType(), $pager->getUser(), $pager->getPage(), $pager->getPattern(),
- $pager->getYear(), $pager->getMonth(), $pager->getFilterParams(), $tagFilter );
- # Insert list
- $logBody = $pager->getBody();
- if( $logBody ) {
- $wgOut->addHTML(
- $pager->getNavigationBar() .
- $loglist->beginLogEventsList() .
- $logBody .
- $loglist->endLogEventsList() .
- $pager->getNavigationBar()
- );
- } else {
- $wgOut->addWikiMsg( 'logempty' );
+
+ /**
+ * Set page title and show header for this log type
+ * @param $type string
+ * @since 1.19
+ */
+ protected function addHeader( $type ) {
+ $page = new LogPage( $type );
+ $this->getOutput()->setPageTitle( $page->getName()->text() );
+ $this->getOutput()->addHTML( $page->getDescription()->parseAsBlock() );
}
+
}