If 'tables' is a string that starts with a space, treat it as user-enforced FROM...
[lhc/web/wiklou.git] / includes / LogPage.php
index bd8c928..65dbbe4 100644 (file)
-<?
-# Class to simplify the use of log pages
+<?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
+ *
+ */
+
+/**
+ * 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 {
-       /* private */ var $mTitle, $mContent, $mContentLoaded, $mId, $mComment;
-       var $mUpdateRecentChanges ;
-
-       function LogPage( $title, $defaulttext = "<ul>\n</ul>"  )
-       {
-               # For now, assume title is correct dbkey
-               # and log pages always go in Wikipedia namespace
-               $this->mTitle = str_replace( " ", "_", $title );
-               $this->mId = 0;
-               $this->mUpdateRecentChanges = true ;
-               $this->mContentLoaded = false;
-               $this->getContent( $defaulttext );
-       }
+       /* @access private */
+       var $type, $action, $comment, $params, $target;
+       /* @acess public */
+       var $updateRecentChanges;
 
-       function getContent( $defaulttext = "<ul>\n</ul>" )
-       {
-               $sql = "SELECT cur_id,cur_text,cur_timestamp FROM cur " .
-                       "WHERE cur_namespace=" . Namespace::getWikipedia() . " AND " .
-                       "cur_title='" . wfStrencode($this->mTitle ) . "'";
-               $res = wfQuery( $sql, "LogPage::getContent" );
-
-               if( wfNumRows( $res ) > 0 ) {
-                       $s = wfFetchObject( $res );
-                       $this->mId = $s->cur_id;
-                       $this->mContent = $s->cur_text;
-                       $this->mTimestamp = $s->cur_timestamp;
-               } else {
-                       $this->mId = 0;
-                       $this->mContent = $defaulttext;
-                       $this->mTimestamp = wfTimestampNow();
-               }
-               $this->mContentLoaded = true; # Well, sort of
-               
-               return $this->mContent;
-       }
-       
-       function getTimestamp()
-       {
-               if( !$this->mContentLoaded ) {
-                       $this->getContent();
-               }
-               return $this->mTimestamp;
+       /**
+         * 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
+         */
+       function __construct( $type, $rc = true ) {
+               $this->type = $type;
+               $this->updateRecentChanges = $rc;
        }
 
-       function saveContent()
-       {
-               if( wfReadOnly() ) return;
+       function saveContent() {
+               if( wfReadOnly() ) return false;
 
                global $wgUser;
-               $fname = "LogPage::saveContent";
+               $fname = 'LogPage::saveContent';
+
+               $dbw = wfGetDB( DB_MASTER );
                $uid = $wgUser->getID();
-               $ut = wfStrencode( $wgUser->getName() );
-
-               if( !$this->mContentLoaded ) return false;
-               $this->mTimestamp = $now = wfTimestampNow();
-               $won = wfInvertTimestamp( $now );
-               if($this->mId == 0) {
-                       $sql = "INSERT INTO cur (cur_timestamp,cur_user,cur_user_text,
-                               cur_namespace,cur_title,cur_text,cur_comment,cur_restrictions,inverse_timestamp)
-                               VALUES ('{$now}', {$uid}, '{$ut}', " .
-                               Namespace::getWikipedia() . ", '" .
-                               wfStrencode( $this->mTitle ) . "', '" .
-                               wfStrencode( $this->mContent ) . "', '" .
-                               wfStrencode( $this->mComment ) . "', 'sysop', '{$won}')";
-                       wfQuery( $sql, $fname );
-                       $this->mId = wfInsertId();
-               } else {
-                       $sql = "UPDATE cur SET cur_timestamp='{$now}', " .
-                         "cur_user={$uid}, cur_user_text='{$ut}', " .
-                         "cur_text='" . wfStrencode( $this->mContent ) . "', " .
-                         "cur_comment='" . wfStrencode( $this->mComment ) . "', " .
-                         "cur_restrictions='sysop', inverse_timestamp='{$won}' " .
-                         "WHERE cur_id={$this->mId}";
-                       wfQuery( $sql, $fname );
-               }
-               
+
+               $this->timestamp = $now = wfTimestampNow();
+               $dbw->insert( 'logging',
+                       array(
+                               'log_type' => $this->type,
+                               'log_action' => $this->action,
+                               'log_timestamp' => $dbw->timestamp( $now ),
+                               'log_user' => $uid,
+                               'log_namespace' => $this->target->getNamespace(),
+                               'log_title' => $this->target->getDBkey(),
+                               'log_comment' => $this->comment,
+                               'log_params' => $this->params
+                       ), $fname
+               );
+
                # And update recentchanges
-               if ( $this->mUpdateRecentChanges ) {
-                       $sql = "INSERT INTO recentchanges (rc_timestamp,rc_cur_time,
-                       rc_user,rc_user_text,rc_namespace,rc_title,rc_comment,
-                       rc_cur_id) VALUES ('{$now}','{$now}',{$uid},'{$ut}',4,'" .
-                               wfStrencode( $this->mTitle ) . "','" .
-                               wfStrencode( $this->mComment ) . "',{$this->mId})";
-                       wfQuery( $sql, $fname );
+               if ( $this->updateRecentChanges ) {
+                       $titleObj = SpecialPage::getTitleFor( 'Log', $this->type );
+                       $rcComment = $this->actionText;
+                       if( '' != $this->comment ) {
+                               if ($rcComment == '')
+                                       $rcComment = $this->comment;
+                               else
+                                       $rcComment .= ': ' . $this->comment;
                        }
+
+                       RecentChange::notifyLog( $now, $titleObj, $wgUser, $rcComment, '',
+                               $this->type, $this->action, $this->target, $this->comment, $this->params );
+               }
                return true;
        }
 
-       function addEntry( $action, $comment, $textaction = "" )
-       {
-               global $wgLang, $wgUser;
-               $this->getContent();
+       /**
+        * @static
+        */
+       function validTypes() {
+               global $wgLogTypes;
+               return $wgLogTypes;
+       }
 
-               $ut = $wgUser->getName();
-               $uid = $wgUser->getID();
-               if( $uid ) {
-                       $ul = "[[" .
-                         $wgLang->getNsText( Namespace::getUser() ) .
-                         ":{$ut}|{$ut}]]";
+       /**
+        * @static
+        */
+       function isLogType( $type ) {
+               return in_array( $type, LogPage::validTypes() );
+       }
+
+       /**
+        * @static
+        */
+       public static function logName( $type ) {
+               global $wgLogNames;
+
+               if( isset( $wgLogNames[$type] ) ) {
+                       return str_replace( '_', ' ', wfMsg( $wgLogNames[$type] ) );
                } else {
-                       $ul = $ut;
+                       // Bogus log types? Perhaps an extension was removed.
+                       return $type;
                }
-               $d = $wgLang->timeanddate( wfTimestampNow(), false );
+       }
+
+       /**
+        * @fixme: handle missing log types
+        * @static
+        */
+       function logHeader( $type ) {
+               global $wgLogHeaders;
+               return wfMsg( $wgLogHeaders[$type] );
+       }
 
-               preg_match( "/^(.*?)<ul>(.*)$/sD", $this->mContent, $m );
+       /**
+        * @static
+        */
+       function actionText( $type, $action, $title = NULL, $skin = NULL, $params = array(), $filterWikilinks=false, $translate=false ) {
+               global $wgLang, $wgContLang, $wgLogActions;
 
-               if($textaction)
-                       $this->mComment = $textaction;
-               else
-                       $this->mComment = $action;
+               $key = "$type/$action";
+               
+               if( $key == 'patrol/patrol' )
+                       return PatrolLog::makeActionText( $title, $params, $skin );
                
-               if ( "" == $comment ) {
-                       $inline = "";
+               if( isset( $wgLogActions[$key] ) ) {
+                       if( is_null( $title ) ) {
+                               $rv=wfMsg( $wgLogActions[$key] );
+                       } else {
+                               if( $skin ) {
+
+                                       switch( $type ) {
+                                               case 'move':
+                                                       $titleLink = $skin->makeLinkObj( $title, $title->getPrefixedText(), 'redirect=no' );
+                                                       $params[0] = $skin->makeLinkObj( Title::newFromText( $params[0] ), $params[0] );
+                                                       break;
+                                               case 'block':
+                                                       if( substr( $title->getText(), 0, 1 ) == '#' ) {
+                                                               $titleLink = $title->getText();
+                                                       } else {
+                                                               $titleLink = $skin->makeLinkObj( $title, $title->getText() );
+                                                               $titleLink .= ' (' . $skin->makeKnownLinkObj( SpecialPage::getTitleFor( 'Contributions', $title->getDBkey() ), wfMsg( 'contribslink' ) ) . ')';
+                                                       }
+                                                       break;
+                                               case 'rights':
+                                                       $text = $wgContLang->ucfirst( $title->getText() );
+                                                       $titleLink = $skin->makeLinkObj( Title::makeTitle( NS_USER, $text ) );
+                                                       break;
+                                               default:
+                                                       $titleLink = $skin->makeLinkObj( $title );
+                                       }
+
+                               } else {
+                                       $titleLink = $title->getPrefixedText();
+                               }
+                               if( $key == 'rights/rights' ) {
+                                       if ($skin) {
+                                               $rightsnone = wfMsg( 'rightsnone' );
+                                       } 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 {
+                                       array_unshift( $params, $titleLink );
+                                       if ( $translate && $key == 'block/block' ) {
+                                               $params[1] = $wgLang->translateBlockExpiry( $params[1] );
+                                               $params[2] = isset( $params[2] )
+                                                                               ? self::formatBlockFlags( $params[2] )
+                                                                               : '';
+                                       }
+                                       $rv = wfMsgReal( $wgLogActions[$key], $params, true, !$skin );
+                               }
+                       }
                } else {
-                       $inline = " <em>({$comment})</em>";
-                       $this->mComment .= ": {$comment}";
+                       wfDebug( "LogPage::actionText - unknown action $key\n" );
+                       $rv = "$action";
                }
-               $this->mContent = "{$m[1]}<ul><li>{$d} {$ul} {$action}{$inline}</li>\n{$m[2]}";
-               
-               # TODO: automatic log rotation...
-               
-               return $this->saveContent();
+               if( $filterWikilinks ) {
+                       $rv = str_replace( "[[", "", $rv );
+                       $rv = str_replace( "]]", "", $rv );
+               }
+               return $rv;
        }
-       
-       function replaceContent( $text, $comment = "" )
-       {
-               $this->mContent = $text;
-               $this->mComment = $comment;
-               $this->mTimestamp = wfTimestampNow();
+
+       /**
+        * 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
+        */
+       function addEntry( $action, $target, $comment, $params = array() ) {
+               if ( !is_array( $params ) ) {
+                       $params = array( $params );
+               }
+
+               $this->action = $action;
+               $this->target = $target;
+               $this->comment = $comment;
+               $this->params = LogPage::makeParamBlob( $params );
+
+               $this->actionText = LogPage::actionText( $this->type, $action, $target, NULL, $params );
+
                return $this->saveContent();
        }
 
-       function showAsDisabledPage( $rawhtml = true )
-       {
-               global $wgLang, $wgOut;
-               $wgOut->checkLastModified( $this->getTimestamp() );
-               $func = ( $rawhtml ? "addHTML" : "addWikiText" );
-               $wgOut->$func(
-                       "<p>" . wfMsg( "perfdisabled" ) . "</p>\n\n" .
-                       "<p>" . wfMsg( "perfdisabledsub", $wgLang->timeanddate( $this->getTimestamp() ) ) . "</p>\n\n" .
-                       "<hr />\n\n" .
-                       $this->getContent()
-                       );
-               return;
-               
+       /**
+        * Create a blob from a parameter array
+        * @static
+        */
+       function makeParamBlob( $params ) {
+               return implode( "\n", $params );
        }
+
+       /**
+        * Extract a parameter array from a blob
+        * @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
+        * @return string
+        */
+       public static function formatBlockFlags( $flags ) {
+               $flags = explode( ',', trim( $flags ) );
+               if( count( $flags ) > 0 ) {
+                       for( $i = 0; $i < count( $flags ); $i++ )
+                               $flags[$i] = self::formatBlockFlag( $flags[$i] );
+                       return '(' . implode( ', ', $flags ) . ')';
+               } else {
+                       return '';
+               }
+       }
+       
+       /**
+        * Translate a block log flag if possible
+        *
+        * @param $flag Flag to translate
+        * @return string
+        */
+       public static function formatBlockFlag( $flag ) {
+               static $messages = array();
+               if( !isset( $messages[$flag] ) ) {
+                       $k = 'block-log-flags-' . $flag;
+                       $msg = wfMsg( $k );
+                       $messages[$flag] = htmlspecialchars( wfEmptyMsg( $k, $msg ) ? $flag : $msg );
+               }
+               return $messages[$flag];
+       }
+       
 }
 
 ?>