remove a deprecated function
[lhc/web/wiklou.git] / includes / LogPage.php
index 5260356..a94f965 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-#$Id$
 #
 # Copyright (C) 2002, 2004 Brion Vibber <brion@pobox.com>
 # http://www.mediawiki.org/
 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 # http://www.gnu.org/copyleft/gpl.html
 
-# 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.
+/**
+ * Contain log classes
+ *
+ * @package MediaWiki
+ */
 
+/**
+ * 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.
+ *
+ * @package MediaWiki
+ */
 class LogPage {
-       /* private */ var $type, $action, $comment;
+       /* private */ var $type, $action, $comment, $params, $target;
        var $updateRecentChanges = true;
 
        function LogPage( $type ) {
-               # Type is one of 'block', 'protect', 'rights', 'delete', 'upload'
+               # Type is one of 'block', 'protect', 'rights', 'delete', 'upload', 'move'
                $this->type = $type;
        }
 
@@ -42,7 +50,7 @@ class LogPage {
                $uid = $wgUser->getID();
 
                $this->timestamp = $now = wfTimestampNow();
-               $dbw->insertArray( 'logging',
+               $dbw->insert( 'logging',
                        array(
                                'log_type' => $this->type,
                                'log_action' => $this->action,
@@ -50,26 +58,94 @@ class LogPage {
                                'log_user' => $uid,
                                'log_namespace' => $this->target->getNamespace(),
                                'log_title' => $this->target->getDBkey(),
-                               'log_comment' => $this->comment
+                               'log_comment' => $this->comment,
+                               'log_params' => $this->params
                        ), $fname
                );
                
                # And update recentchanges
                if ( $this->updateRecentChanges ) {
+                       $titleObj = Title::makeTitle( NS_SPECIAL, 'Log/' . $this->type );
                        $rcComment = $this->actionText;
                        if( '' != $this->comment ) {
                                $rcComment .= ': ' . $this->comment;
                        }
-                       $titleObj = Title::makeTitle( NS_SPECIAL, 'Log/' . $this->type );
+                       
                        RecentChange::notifyLog( $now, $titleObj, $wgUser, $rcComment );
                }
                return true;
        }
 
-       /* static */ function actionText( $type, $action, $titleLink ) {
+       /**
+        * @static
+        */
+       function validTypes() {
+               static $types = array( '', 'block', 'protect', 'rights', 'delete', 'upload', 'move' );
+               return $types;
+       }
+       
+       /**
+        * @static
+        */
+       function validActions( $type ) {
+               static $actions = array(
+                       '' => NULL,
+                       'block' => array( 'block', 'unblock' ),
+                       'protect' => array( 'protect', 'unprotect' ),
+                       'rights' => array( 'rights' ),
+                       'delete' => array( 'delete', 'restore' ),
+                       'upload' => array( 'upload' ),
+                       'move' => array( 'move' )
+               );
+               return $actions[$type];
+       }
+       
+       /**
+        * @static
+        */
+       function isLogType( $type ) {
+               return in_array( $type, LogPage::validTypes() );
+       }
+       
+       /**
+        * @static
+        */
+       function logName( $type ) {
+               static $typeText = array(
+                       ''        => 'log',
+                       'block'   => 'blocklogpage',
+                       'protect' => 'protectlogpage',
+                       'rights'  => 'bureaucratlog',
+                       'delete'  => 'dellogpage',
+                       'upload'  => 'uploadlogpage',
+                       'move'    => 'movelogpage'
+               );
+               return str_replace( '_', ' ', wfMsg( $typeText[$type] ) );
+       }
+       
+       /**
+        * @static
+        */
+       function logHeader( $type ) {
+               static $headerText = array(
+                       ''        => 'alllogstext',
+                       'block'   => 'blocklogtext',
+                       'protect' => 'protectlogtext',
+                       'rights'  => 'rightslogtext',
+                       'delete'  => 'dellogpagetext',
+                       'upload'  => 'uploadlogpagetext',
+                       'move'    => 'movelogpagetext'
+               );
+               return wfMsg( $headerText[$type] );
+       }
+       
+       /**
+        * @static
+        */
+       function actionText( $type, $action, $title = NULL, $skin = NULL, $params = array(), $filterWikilinks=false ) {
                static $actions = array(
                        'block/block' => 'blocklogentry',
-                       'block/unblock' => 'blocklogentry',
+                       'block/unblock' => 'unblocklogentry',
                        'protect/protect' => 'protectedarticle',
                        'protect/unprotect' => 'unprotectedarticle',
                        'rights/rights' => 'bureaucratlogentry',
@@ -77,27 +153,91 @@ class LogPage {
                        'delete/restore' => 'undeletedarticle',
                        'upload/upload' => 'uploadedimage',
                        'upload/revert' => 'uploadedimage',
+                       'move/move' => '1movedto2',
+                       'move/move_redir' => '1movedto2_redir'
                );
                $key = "$type/$action";
                if( isset( $actions[$key] ) ) {
-                       return wfMsg( $actions[$key], $titleLink );
+                       if( is_null( $title ) ) {
+                               $rv=wfMsgForContent( $actions[$key] );
+                       } 
+                       else {
+                               if ( $skin ) {
+                                       if ( $type == 'move' ) {
+                                               $titleLink = $skin->makeLinkObj( $title, $title->getPrefixedText(), 'redirect=no' );
+                                               // Change $param[0] into a link to the title specified in $param[0]
+                                               $movedTo = Title::newFromText( $params[0] );
+                                               $params[0] = $skin->makeLinkObj( $movedTo, $params[0] );
+                                       } else {
+                                               $titleLink = $skin->makeLinkObj( $title );
+                                       }
+                               } else {
+                                       $titleLink = $title->getPrefixedText();
+                               }
+                               if ( count( $params ) == 0 ) {
+                                       $rv=wfMsgForContent( $actions[$key], $titleLink );
+                               } else {
+                                       array_unshift( $params, $titleLink );
+                                       $rv=wfMsgReal( $actions[$key], $params, true, true );
+                               }
+                       }
                } else {
                        wfDebug( "LogPage::actionText - unknown action $key\n" );
-                       return "$action $titleLink";
+                       $rv="$action $titleLink";
                }
+               if($filterWikilinks) {
+                       $rv=str_replace("[[","",$rv);
+                       $rv=str_replace("]]","",$rv);
+               }
+               return $rv;
        }
-       
-       function addEntry( $action, &$target, $comment ) {
+
+       /**
+        * 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() ) {
                global $wgLang, $wgUser;
                
+               if ( !is_array( $params ) ) {
+                       $params = array( $params );
+               }
+               
                $this->action = $action;
                $this->target =& $target;
                $this->comment = $comment;
-               $this->actionText = LogPage::actionText( $this->type, $action,
-                       $target->getPrefixedText() );
-                               
+               $this->params = LogPage::makeParamBlob( $params );
+               
+               $this->actionText = LogPage::actionText( $this->type, $action, 
+                 $target, NULL, $params );
+
                return $this->saveContent();
        }
+
+       /** 
+        * 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 );
+               }
+       }
 }
 
 ?>