Added notifyRC2UDP() convenience function

[mediawiki.git] / includes / LogPage.php

<?php
#
# Copyright (C) 2002, 2004 Brion Vibber <brion@pobox.com>
# http://www.mediawiki.org/
#
# 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
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# 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.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
# http://www.gnu.org/copyleft/gpl.html

/**
 * Contain log classes
 * @file
 */

/**
 * Class to simplify the use of log pages.
 * The logs are now kept in a table which is easier to manage and trim
 * than ever-growing wiki pages.
 *
 */
class LogPage {
        const DELETED_ACTION = 1;
        const DELETED_COMMENT = 2;
        const DELETED_USER = 4;
    const DELETED_RESTRICTED = 8;
        /* @access private */
        var $type, $action, $comment, $params, $target, $doer;
        /* @acess public */
        var $updateRecentChanges, $sendToUDP;

        /**
          * Constructor
          *
          * @param string $type One of '', 'block', 'protect', 'rights', 'delete',
          *               'upload', 'move'
          * @param bool $rc Whether to update recent changes as well as the logging table
          * @param bool $udp Whether to send to the UDP feed
          */
        public function __construct( $type, $rc = true, $udp = true ) {
                $this->type = $type;
                $this->updateRecentChanges = $rc;
                $this->sendToUDP = $udp;
        }

        protected function saveContent() {
                global $wgLogRestrictions;

                $dbw = wfGetDB( DB_MASTER );
                $log_id = $dbw->nextSequenceValue( 'log_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_namespace' => $this->target->getNamespace(),
                        'log_title' => $this->target->getDBkey(),
                        '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 );
                } else if( $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.
                        global $wgRC2UDPAddress, $wgRC2UDPOmitBots;
                        $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 );
                        if( $wgRC2UDPAddress && ( !$rc->getAttribute('rc_bot') || !$wgRC2UDPOmitBots ) ) {
                                RecentChange::sendToUDP( $rc->getIRCLine() );
                        }
                }
                return true;
        }

        /**
         * Get the RC comment from the last addEntry() call
         */
        public function getRcComment() {
                $rcComment = $this->actionText;
                if( '' != $this->comment ) {
                        if ($rcComment == '')
                                $rcComment = $this->comment;
                        else
                                $rcComment .= wfMsgForContent( 'colon-separator' ) . $this->comment;
                }
                return $rcComment;
        }

        /**
         * Get the comment from the last addEntry() call
         */
        public function getComment() {
                return $this->comment;
        }

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

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

        /**
         * @static
         */
        public static function logName( $type ) {
                global $wgLogNames, $wgMessageCache;

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

        /**
         * @todo handle missing log types
         * @param string $type logtype
         * @return string Headertext of this logtype
         */
        public static function logHeader( $type ) {
                global $wgLogHeaders, $wgMessageCache;
                $wgMessageCache->loadAllMessages();
                return wfMsgExt($wgLogHeaders[$type],array('parseinline'));
        }

        /**
         * @static
         * @return HTML string
         */
        public static function actionText( $type, $action, $title = NULL, $skin = NULL, 
                $params = array(), $filterWikilinks = false ) 
        {
                global $wgLang, $wgContLang, $wgLogActions, $wgMessageCache;

                $wgMessageCache->loadAllMessages();
                $key = "$type/$action";
                # Defer patrol log to PatrolLog class
                if( $key == 'patrol/patrol' ) {
                        return PatrolLog::makeActionText( $title, $params, $skin );
                }
                if( isset( $wgLogActions[$key] ) ) {
                        if( is_null( $title ) ) {
                                $rv = wfMsg( $wgLogActions[$key] );
                        } else {
                                $titleLink = self::getTitleLink( $type, $skin, $title, $params );
                                if( $key == 'rights/rights' ) {
                                        if( $skin ) {
                                                $rightsnone = wfMsg( 'rightsnone' );
                                                foreach ( $params as &$param ) {
                                                        $groupArray = array_map( 'trim', explode( ',', $param ) );
                                                        $groupArray = array_map( array( 'User', 'getGroupName' ), $groupArray );
                                                        $param = $wgLang->listToText( $groupArray );
                                                }
                                        } else {
                                                $rightsnone = wfMsgForContent( 'rightsnone' );
                                        }
                                        if( !isset( $params[0] ) || trim( $params[0] ) == '' )
                                                $params[0] = $rightsnone;
                                        if( !isset( $params[1] ) || trim( $params[1] ) == '' )
                                                $params[1] = $rightsnone;
                                }
                                if( count( $params ) == 0 ) {
                                        if ( $skin ) {
                                                $rv = wfMsg( $wgLogActions[$key], $titleLink );
                                        } else {
                                                $rv = wfMsgForContent( $wgLogActions[$key], $titleLink );
                                        }
                                } else {
                                        $details = '';
                                        array_unshift( $params, $titleLink );
                                        if ( $key == 'block/block' || $key == 'suppress/block' || $key == 'block/reblock' ) {
                                                if ( $skin ) {
                                                        $params[1] = '<span 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], is_null( $skin ) ) : '';
                                        } else if ( $type == 'protect' && count($params) == 3 ) {
                                                $details .= " {$params[1]}"; // restrictions and expiries
                                                if( $params[2] ) {
                                                        $details .= ' ['.wfMsg('protect-summary-cascade').']';
                                                }
                                        } else if ( $type == 'move' && count( $params ) == 3 ) {
                                                if( $params[2] ) {
                                                        $details .= ' [' . wfMsg( 'move-redirect-suppressed' ) . ']';
                                                }
                                        }
                                        $rv = wfMsgReal( $wgLogActions[$key], $params, true, !$skin ) . $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";
                        }
                }
                if( $filterWikilinks ) {
                        $rv = str_replace( "[[", "", $rv );
                        $rv = str_replace( "]]", "", $rv );
                }
                return $rv;
        }
        
        protected static function getTitleLink( $type, $skin, $title, &$params ) {
                global $wgLang, $wgContLang;
                if( !$skin ) {
                        return $title->getPrefixedText();
                }
                switch( $type ) {
                        case 'move':
                                $titleLink = $skin->makeLinkObj( $title, 
                                        htmlspecialchars( $title->getPrefixedText() ), 'redirect=no' );
                                $targetTitle = Title::newFromText( $params[0] );
                                if ( !$targetTitle ) {
                                        # Workaround for broken database
                                        $params[0] = htmlspecialchars( $params[0] );
                                } else {
                                        $params[0] = $skin->makeLinkObj( $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 = $skin->userLink( $id, $title->getText() )
                                                . $skin->userToolLinks( $id, $title->getText(), false, Linker::TOOL_LINKS_NOBLOCK );
                                }
                                break;
                        case 'rights':
                                $text = $wgContLang->ucfirst( $title->getText() );
                                $titleLink = $skin->makeLinkObj( Title::makeTitle( NS_USER, $text ) );
                                break;
                        case 'merge':
                                $titleLink = $skin->makeLinkObj( $title, $title->getPrefixedText(), 'redirect=no' );
                                $params[0] = $skin->makeLinkObj( Title::newFromText( $params[0] ), htmlspecialchars( $params[0] ) );
                                $params[1] = $wgLang->timeanddate( $params[1] );
                                break;
                        default:
                                if( $title->getNamespace() == NS_SPECIAL ) {
                                        list( $name, $par ) = SpecialPage::resolveAliasWithSubpage( $title->getDBKey() );
                                        # Use the language name for log titles, rather than Log/X
                                        if( $name == 'Log' ) {
                                                $titleLink = '('.$skin->makeLinkObj( $title, LogPage::logName( $par ) ).')';
                                        } else {
                                                $titleLink = $skin->makeLinkObj( $title );
                                        }
                                } else {
                                        $titleLink = $skin->makeLinkObj( $title );
                                }
                }
                return $titleLink;
        }

        /**
         * Add a log entry
         * @param string $action one of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'
         * @param object &$target A title object.
         * @param string $comment Description associated
         * @param array $params Parameters passed later to wfMsg.* functions
         * @param User $doer The user doing the action
         */
        public function addEntry( $action, $target, $comment, $params = array(), $doer = null ) {
                if ( !is_array( $params ) ) {
                        $params = array( $params );
                }

                $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;

                $this->actionText = LogPage::actionText( $this->type, $action, $target, NULL, $params );

                return $this->saveContent();
        }

        /**
         * Create a blob from a parameter array
         * @static
         */
        public static function makeParamBlob( $params ) {
                return implode( "\n", $params );
        }

        /**
         * Extract a parameter array from a blob
         * @static
         */
        public static function extractParams( $blob ) {
                if ( $blob === '' ) {
                        return array();
                } else {
                        return explode( "\n", $blob );
                }
        }

        /**
         * Convert a comma-delimited list of block log flags
         * into a more readable (and translated) form
         *
         * @param $flags Flags to format
         * @param $forContent Whether to localize the message depending of the user
         *                    language
         * @return string
         */
        public static function formatBlockFlags( $flags, $forContent = false ) {
                $flags = explode( ',', trim( $flags ) );
                if( count( $flags ) > 0 ) {
                        for( $i = 0; $i < count( $flags ); $i++ )
                                $flags[$i] = self::formatBlockFlag( $flags[$i], $forContent );
                        return '(' . implode( ', ', $flags ) . ')';
                } else {
                        return '';
                }
        }

        /**
         * Translate a block log flag if possible
         *
         * @param $flag Flag to translate
         * @param $forContent Whether to localize the message depending of the user
         *                    language
         * @return string
         */
        public static function formatBlockFlag( $flag, $forContent = false ) {
                static $messages = array();
                if( !isset( $messages[$flag] ) ) {
                        $k = 'block-log-flags-' . $flag;
                        if( $forContent )
                                $msg = wfMsgForContent( $k );
                        else
                                $msg = wfMsg( $k );
                        $messages[$flag] = htmlspecialchars( wfEmptyMsg( $k, $msg ) ? $flag : $msg );
                }
                return $messages[$flag];
        }
}

/**
 * Aliases for backwards compatibility with 1.6
 */
define( 'MW_LOG_DELETED_ACTION', LogPage::DELETED_ACTION );
define( 'MW_LOG_DELETED_USER', LogPage::DELETED_USER );
define( 'MW_LOG_DELETED_COMMENT', LogPage::DELETED_COMMENT );
define( 'MW_LOG_DELETED_RESTRICTED', LogPage::DELETED_RESTRICTED );