SpecialLog.php

Go to the documentation of this file.

<?php
class SpecialLog extends SpecialPage {

        private $typeOnUser = array(
                'block',
                'newusers',
                'rights',
        );

        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 && $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 );
        }

        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 );
                }
        }

        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(), $opts->getValue( 'user' ), $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' );
                }
        }

        protected function addHeader( $type ) {
                $page = new LogPage( $type );
                $this->getOutput()->setPageTitle( $page->getName()->text() );
                $this->getOutput()->addHTML( $page->getDescription()->parseAsBlock() );
        }

}