LogPage.php

Go to the documentation of this file.

<?php
class LogPage {
        const DELETED_ACTION = 1;
        const DELETED_COMMENT = 2;
        const DELETED_USER = 4;
        const DELETED_RESTRICTED = 8;
        // Convenience fields
        const SUPPRESSED_USER = 12;
        const SUPPRESSED_ACTION = 9;
        /* @access private */
        var $type, $action, $comment, $params;

        var $doer;

        var $target;

        /* @acess public */
        var $updateRecentChanges, $sendToUDP;

        public function __construct( $type, $rc = true, $udp = 'skipUDP' ) {
                $this->type = $type;
                $this->updateRecentChanges = $rc;
                $this->sendToUDP = ( $udp == 'UDP' );
        }

        protected function saveContent() {
                global $wgLogRestrictions;

                $dbw = wfGetDB( DB_MASTER );
                $log_id = $dbw->nextSequenceValue( 'logging_log_id_seq' );

                $this->timestamp = $now = wfTimestampNow();
                $data = array(
                        'log_id' => $log_id,
                        'log_type' => $this->type,
                        'log_action' => $this->action,
                        'log_timestamp' => $dbw->timestamp( $now ),
                        'log_user' => $this->doer->getId(),
                        'log_user_text' => $this->doer->getName(),
                        'log_namespace' => $this->target->getNamespace(),
                        'log_title' => $this->target->getDBkey(),
                        'log_page' => $this->target->getArticleId(),
                        'log_comment' => $this->comment,
                        'log_params' => $this->params
                );
                $dbw->insert( 'logging', $data, __METHOD__ );
                $newId = !is_null( $log_id ) ? $log_id : $dbw->insertId();

                # And update recentchanges
                if( $this->updateRecentChanges ) {
                        $titleObj = SpecialPage::getTitleFor( 'Log', $this->type );

                        RecentChange::notifyLog(
                                $now, $titleObj, $this->doer, $this->getRcComment(), '',
                                $this->type, $this->action, $this->target, $this->comment,
                                $this->params, $newId
                        );
                } elseif( $this->sendToUDP ) {
                        # Don't send private logs to UDP
                        if( isset( $wgLogRestrictions[$this->type] ) && $wgLogRestrictions[$this->type] != '*' ) {
                                return true;
                        }

                        # Notify external application via UDP.
                        # We send this to IRC but do not want to add it the RC table.
                        $titleObj = SpecialPage::getTitleFor( 'Log', $this->type );
                        $rc = RecentChange::newLogEntry(
                                $now, $titleObj, $this->doer, $this->getRcComment(), '',
                                $this->type, $this->action, $this->target, $this->comment,
                                $this->params, $newId
                        );
                        $rc->notifyRC2UDP();
                }
                return $newId;
        }

        public function getRcComment() {
                $rcComment = $this->actionText;

                if( $this->comment != '' ) {
                        if ( $rcComment == '' ) {
                                $rcComment = $this->comment;
                        } else {
                                $rcComment .= wfMsgForContent( 'colon-separator' ) . $this->comment;
                        }
                }

                return $rcComment;
        }

        public function getComment() {
                return $this->comment;
        }

        public static function validTypes() {
                global $wgLogTypes;
                return $wgLogTypes;
        }

        public static function isLogType( $type ) {
                return in_array( $type, LogPage::validTypes() );
        }

        public static function logName( $type ) {
                wfDeprecated( __METHOD__, '1.19' );
                global $wgLogNames;

                if( isset( $wgLogNames[$type] ) ) {
                        return str_replace( '_', ' ', wfMsg( $wgLogNames[$type] ) );
                } else {
                        // Bogus log types? Perhaps an extension was removed.
                        return $type;
                }
        }

        public static function logHeader( $type ) {
                wfDeprecated( __METHOD__, '1.19' );
                global $wgLogHeaders;
                return wfMsgExt( $wgLogHeaders[$type], array( 'parseinline' ) );
        }

        public static function actionText( $type, $action, $title = null, $skin = null,
                $params = array(), $filterWikilinks = false )
        {
                global $wgLang, $wgContLang, $wgLogActions;

                if ( is_null( $skin ) ) {
                        $langObj = $wgContLang;
                        $langObjOrNull = null;
                } else {
                        $langObj = $wgLang;
                        $langObjOrNull = $wgLang;
                }

                $key = "$type/$action";

                if( isset( $wgLogActions[$key] ) ) {
                        if( is_null( $title ) ) {
                                $rv = wfMsgExt( $wgLogActions[$key], array( 'parsemag', 'escape', 'language' => $langObj ) );
                        } else {
                                $titleLink = self::getTitleLink( $type, $langObjOrNull, $title, $params );

                                if( preg_match( '/^rights\/(rights|autopromote)/', $key ) ) {
                                        $rightsnone = wfMsgExt( 'rightsnone', array( 'parsemag', 'language' => $langObj ) );

                                        if( $skin ) {
                                                foreach ( $params as &$param ) {
                                                        $groupArray = array_map( 'trim', explode( ',', $param ) );
                                                        $groupArray = array_map( array( 'User', 'getGroupMember' ), $groupArray );
                                                        $param = $wgLang->listToText( $groupArray );
                                                }
                                        }

                                        if( !isset( $params[0] ) || trim( $params[0] ) == '' ) {
                                                $params[0] = $rightsnone;
                                        }

                                        if( !isset( $params[1] ) || trim( $params[1] ) == '' ) {
                                                $params[1] = $rightsnone;
                                        }
                                }

                                if( count( $params ) == 0 ) {
                                        $rv = wfMsgExt( $wgLogActions[$key], array( 'parsemag', 'escape', 'replaceafter', 'language' => $langObj ), $titleLink );
                                } else {
                                        $details = '';
                                        array_unshift( $params, $titleLink );

                                        // User suppression
                                        if ( preg_match( '/^(block|suppress)\/(block|reblock)$/', $key ) ) {
                                                if ( $skin ) {
                                                        $params[1] = '<span class="blockExpiry" dir="ltr" title="' . htmlspecialchars( $params[1] ). '">' .
                                                                $wgLang->translateBlockExpiry( $params[1] ) . '</span>';
                                                } else {
                                                        $params[1] = $wgContLang->translateBlockExpiry( $params[1] );
                                                }

                                                $params[2] = isset( $params[2] ) ?
                                                        self::formatBlockFlags( $params[2], $langObj ) : '';
                                        // Page protections
                                        } elseif ( $type == 'protect' && count($params) == 3 ) {
                                                // Restrictions and expiries
                                                if( $skin ) {
                                                        $details .= $wgLang->getDirMark() . htmlspecialchars( " {$params[1]}" );
                                                } else {
                                                        $details .= " {$params[1]}";
                                                }

                                                // Cascading flag...
                                                if( $params[2] ) {
                                                        $details .= ' [' . wfMsgExt( 'protect-summary-cascade', array( 'parsemag', 'language' => $langObj ) ) . ']';
                                                }
                                        }

                                        $rv = wfMsgExt( $wgLogActions[$key], array( 'parsemag', 'escape', 'replaceafter', 'language' => $langObj ), $params ) . $details;
                                }
                        }
                } else {
                        global $wgLogActionsHandlers;

                        if( isset( $wgLogActionsHandlers[$key] ) ) {
                                $args = func_get_args();
                                $rv = call_user_func_array( $wgLogActionsHandlers[$key], $args );
                        } else {
                                wfDebug( "LogPage::actionText - unknown action $key\n" );
                                $rv = "$action";
                        }
                }

                // For the perplexed, this feature was added in r7855 by Erik.
                // The feature was added because we liked adding [[$1]] in our log entries
                // but the log entries are parsed as Wikitext on RecentChanges but as HTML
                // on Special:Log. The hack is essentially that [[$1]] represented a link
                // to the title in question. The first parameter to the HTML version (Special:Log)
                // is that link in HTML form, and so this just gets rid of the ugly [[]].
                // However, this is a horrible hack and it doesn't work like you expect if, say,
                // you want to link to something OTHER than the title of the log entry.
                // The real problem, which Erik was trying to fix (and it sort-of works now) is
                // that the same messages are being treated as both wikitext *and* HTML.
                if( $filterWikilinks ) {
                        $rv = str_replace( '[[', '', $rv );
                        $rv = str_replace( ']]', '', $rv );
                }

                return $rv;
        }

        protected static function getTitleLink( $type, $lang, $title, &$params ) {
                global $wgContLang, $wgUserrightsInterwikiDelimiter;

                if( !$lang ) {
                        return $title->getPrefixedText();
                }

                switch( $type ) {
                        case 'move':
                                $titleLink = Linker::link(
                                        $title,
                                        htmlspecialchars( $title->getPrefixedText() ),
                                        array(),
                                        array( 'redirect' => 'no' )
                                );

                                $targetTitle = Title::newFromText( $params[0] );

                                if ( !$targetTitle ) {
                                        # Workaround for broken database
                                        $params[0] = htmlspecialchars( $params[0] );
                                } else {
                                        $params[0] = Linker::link(
                                                $targetTitle,
                                                htmlspecialchars( $params[0] )
                                        );
                                }
                                break;
                        case 'block':
                                if( substr( $title->getText(), 0, 1 ) == '#' ) {
                                        $titleLink = $title->getText();
                                } else {
                                        // @todo Store the user identifier in the parameters
                                        // to make this faster for future log entries
                                        $id = User::idFromName( $title->getText() );
                                        $titleLink = Linker::userLink( $id, $title->getText() )
                                                . Linker::userToolLinks( $id, $title->getText(), false, Linker::TOOL_LINKS_NOBLOCK );
                                }
                                break;
                        case 'rights':
                                $text = $wgContLang->ucfirst( $title->getText() );
                                $parts = explode( $wgUserrightsInterwikiDelimiter, $text, 2 );

                                if ( count( $parts ) == 2 ) {
                                        $titleLink = WikiMap::foreignUserLink( $parts[1], $parts[0],
                                                htmlspecialchars( $title->getPrefixedText() ) );

                                        if ( $titleLink !== false ) {
                                                break;
                                        }
                                }
                                $titleLink = Linker::link( Title::makeTitle( NS_USER, $text ) );
                                break;
                        case 'merge':
                                $titleLink = Linker::link(
                                        $title,
                                        $title->getPrefixedText(),
                                        array(),
                                        array( 'redirect' => 'no' )
                                );
                                $params[0] = Linker::link(
                                        Title::newFromText( $params[0] ),
                                        htmlspecialchars( $params[0] )
                                );
                                $params[1] = $lang->timeanddate( $params[1] );
                                break;
                        default:
                                if( $title->isSpecialPage() ) {
                                        list( $name, $par ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );

                                        # Use the language name for log titles, rather than Log/X
                                        if( $name == 'Log' ) {
                                                $titleLink = '(' . Linker::link( $title, LogPage::logName( $par ) ) . ')';
                                        } else {
                                                $titleLink = Linker::link( $title );
                                        }
                                } else {
                                        $titleLink = Linker::link( $title );
                                }
                }

                return $titleLink;
        }

        public function addEntry( $action, $target, $comment, $params = array(), $doer = null ) {
                global $wgContLang;

                if ( !is_array( $params ) ) {
                        $params = array( $params );
                }

                if ( $comment === null ) {
                        $comment = '';
                }

                # Truncate for whole multibyte characters.
                $comment = $wgContLang->truncate( $comment, 255 );

                $this->action = $action;
                $this->target = $target;
                $this->comment = $comment;
                $this->params = LogPage::makeParamBlob( $params );

                if ( $doer === null ) {
                        global $wgUser;
                        $doer = $wgUser;
                } elseif ( !is_object( $doer ) ) {
                        $doer = User::newFromId( $doer );
                }

                $this->doer = $doer;

                $logEntry = new ManualLogEntry( $this->type, $action );
                $logEntry->setTarget( $target );
                $logEntry->setPerformer( $doer );
                $logEntry->setParameters( $params );

                $formatter = LogFormatter::newFromEntry( $logEntry );
                $context = RequestContext::newExtraneousContext( $target );
                $formatter->setContext( $context );

                $this->actionText = $formatter->getPlainActionText();

                return $this->saveContent();
        }

        public function addRelations( $field, $values, $logid ) {
                if( !strlen( $field ) || empty( $values ) ) {
                        return false; // nothing
                }

                $data = array();

                foreach( $values as $value ) {
                        $data[] = array(
                                'ls_field' => $field,
                                'ls_value' => $value,
                                'ls_log_id' => $logid
                        );
                }

                $dbw = wfGetDB( DB_MASTER );
                $dbw->insert( 'log_search', $data, __METHOD__, 'IGNORE' );

                return true;
        }

        public static function makeParamBlob( $params ) {
                return implode( "\n", $params );
        }

        public static function extractParams( $blob ) {
                if ( $blob === '' ) {
                        return array();
                } else {
                        return explode( "\n", $blob );
                }
        }

        public static function formatBlockFlags( $flags, $lang ) {
                $flags = explode( ',', trim( $flags ) );

                if( count( $flags ) > 0 ) {
                        for( $i = 0; $i < count( $flags ); $i++ ) {
                                $flags[$i] = self::formatBlockFlag( $flags[$i], $lang );
                        }
                        return '(' . $lang->commaList( $flags ) . ')';
                } else {
                        return '';
                }
        }

        public static function formatBlockFlag( $flag, $lang ) {
                static $messages = array();

                if( !isset( $messages[$flag] ) ) {
                        $messages[$flag] = htmlspecialchars( $flag ); // Fallback

                        // For grepping. The following core messages can be used here:
                        // * block-log-flags-angry-autoblock
                        // * block-log-flags-anononly
                        // * block-log-flags-hiddenname
                        // * block-log-flags-noautoblock
                        // * block-log-flags-nocreate
                        // * block-log-flags-noemail
                        // * block-log-flags-nousertalk
                        $msg = wfMessage( 'block-log-flags-' . $flag )->inLanguage( $lang );

                        if ( $msg->exists() ) {
                                $messages[$flag] = $msg->escaped();
                        }
                }

                return $messages[$flag];
        }


        public function getName() {
                global $wgLogNames;

                // BC
                if ( isset( $wgLogNames[$this->type] ) ) {
                        $key = $wgLogNames[$this->type];
                } else {
                        $key = 'log-name-' . $this->type;
                }

                return wfMessage( $key );
        }

        public function getDescription() {
                global $wgLogHeaders;
                // BC
                if ( isset( $wgLogHeaders[$this->type] ) ) {
                        $key = $wgLogHeaders[$this->type];
                } else {
                        $key = 'log-description-' . $this->type;
                }
                return wfMessage( $key );
        }

        public function getRestriction() {
                global $wgLogRestrictions;
                if ( isset( $wgLogRestrictions[$this->type] ) ) {
                        $restriction = $wgLogRestrictions[$this->type];
                } else {
                        // '' always returns true with $user->isAllowed()
                        $restriction = '';
                }
                return $restriction;
        }

        public function isRestricted() {
                $restriction = $this->getRestriction();
                return $restriction !== '' && $restriction !== '*';
        }

}