includes/logging/LogPage.php

   1 <?php
   2 /**
   3  * Contain log classes
   4  *
   5  * Copyright © 2002, 2004 Brion Vibber <brion@pobox.com>
   6  * http://www.mediawiki.org/
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  */
  25
  26 /**
  27  * Class to simplify the use of log pages.
  28  * The logs are now kept in a table which is easier to manage and trim
  29  * than ever-growing wiki pages.
  30  *
  31  */
  32 class LogPage {
  33         const DELETED_ACTION = 1;
  34         const DELETED_COMMENT = 2;
  35         const DELETED_USER = 4;
  36         const DELETED_RESTRICTED = 8;
  37         // Convenience fields
  38         const SUPPRESSED_USER = 12;
  39         const SUPPRESSED_ACTION = 9;
  40         /* @access private */
  41         var $type, $action, $comment, $params;
  42
  43         /**
  44          * @var User
  45          */
  46         var $doer;
  47
  48         /**
  49          * @var Title
  50          */
  51         var $target;
  52
  53         /* @acess public */
  54         var $updateRecentChanges, $sendToUDP;
  55
  56         /**
  57          * Constructor
  58          *
  59          * @param $type String: one of '', 'block', 'protect', 'rights', 'delete',
  60          *               'upload', 'move'
  61          * @param $rc Boolean: whether to update recent changes as well as the logging table
  62          * @param $udp String: pass 'UDP' to send to the UDP feed if NOT sent to RC
  63          */
  64         public function __construct( $type, $rc = true, $udp = 'skipUDP' ) {
  65                 $this->type = $type;
  66                 $this->updateRecentChanges = $rc;
  67                 $this->sendToUDP = ( $udp == 'UDP' );
  68         }
  69
  70         /**
  71          * @return int log_id of the inserted log entry
  72          */
  73         protected function saveContent() {
  74                 global $wgLogRestrictions;
  75
  76                 $dbw = wfGetDB( DB_MASTER );
  77                 $log_id = $dbw->nextSequenceValue( 'logging_log_id_seq' );
  78
  79                 $this->timestamp = $now = wfTimestampNow();
  80                 $data = array(
  81                         'log_id' => $log_id,
  82                         'log_type' => $this->type,
  83                         'log_action' => $this->action,
  84                         'log_timestamp' => $dbw->timestamp( $now ),
  85                         'log_user' => $this->doer->getId(),
  86                         'log_user_text' => $this->doer->getName(),
  87                         'log_namespace' => $this->target->getNamespace(),
  88                         'log_title' => $this->target->getDBkey(),
  89                         'log_page' => $this->target->getArticleID(),
  90                         'log_comment' => $this->comment,
  91                         'log_params' => $this->params
  92                 );
  93                 $dbw->insert( 'logging', $data, __METHOD__ );
  94                 $newId = !is_null( $log_id ) ? $log_id : $dbw->insertId();
  95
  96                 # And update recentchanges
  97                 if( $this->updateRecentChanges ) {
  98                         $titleObj = SpecialPage::getTitleFor( 'Log', $this->type );
  99
 100                         RecentChange::notifyLog(
 101                                 $now, $titleObj, $this->doer, $this->getRcComment(), '',
 102                                 $this->type, $this->action, $this->target, $this->comment,
 103                                 $this->params, $newId, $this->getRcCommentIRC()
 104                         );
 105                 } elseif( $this->sendToUDP ) {
 106                         # Don't send private logs to UDP
 107                         if( isset( $wgLogRestrictions[$this->type] ) && $wgLogRestrictions[$this->type] != '*' ) {
 108                                 return $newId;
 109                         }
 110
 111                         # Notify external application via UDP.
 112                         # We send this to IRC but do not want to add it the RC table.
 113                         $titleObj = SpecialPage::getTitleFor( 'Log', $this->type );
 114                         $rc = RecentChange::newLogEntry(
 115                                 $now, $titleObj, $this->doer, $this->getRcComment(), '',
 116                                 $this->type, $this->action, $this->target, $this->comment,
 117                                 $this->params, $newId, $this->getRcCommentIRC()
 118                         );
 119                         $rc->notifyRC2UDP();
 120                 }
 121                 return $newId;
 122         }
 123
 124         /**
 125          * Get the RC comment from the last addEntry() call
 126          *
 127          * @return string
 128          */
 129         public function getRcComment() {
 130                 $rcComment = $this->actionText;
 131
 132                 if( $this->comment != '' ) {
 133                         if ( $rcComment == '' ) {
 134                                 $rcComment = $this->comment;
 135                         } else {
 136                                 $rcComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() .
 137                                         $this->comment;
 138                         }
 139                 }
 140
 141                 return $rcComment;
 142         }
 143
 144         /**
 145          * Get the RC comment from the last addEntry() call for IRC
 146          *
 147          * @return string
 148          */
 149         public function getRcCommentIRC() {
 150                 $rcComment = $this->ircActionText;
 151
 152                 if( $this->comment != '' ) {
 153                         if ( $rcComment == '' ) {
 154                                 $rcComment = $this->comment;
 155                         } else {
 156                                 $rcComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() .
 157                                         $this->comment;
 158                         }
 159                 }
 160
 161                 return $rcComment;
 162         }
 163
 164         /**
 165          * Get the comment from the last addEntry() call
 166          */
 167         public function getComment() {
 168                 return $this->comment;
 169         }
 170
 171         /**
 172          * Get the list of valid log types
 173          *
 174          * @return Array of strings
 175          */
 176         public static function validTypes() {
 177                 global $wgLogTypes;
 178                 return $wgLogTypes;
 179         }
 180
 181         /**
 182          * Is $type a valid log type
 183          *
 184          * @param $type String: log type to check
 185          * @return Boolean
 186          */
 187         public static function isLogType( $type ) {
 188                 return in_array( $type, LogPage::validTypes() );
 189         }
 190
 191         /**
 192          * Get the name for the given log type
 193          *
 194          * @param $type String: logtype
 195          * @return String: log name
 196          * @deprecated in 1.19, warnings in 1.21. Use getName()
 197          */
 198         public static function logName( $type ) {
 199                 global $wgLogNames;
 200
 201                 if( isset( $wgLogNames[$type] ) ) {
 202                         return str_replace( '_', ' ', wfMessage( $wgLogNames[$type] )->text() );
 203                 } else {
 204                         // Bogus log types? Perhaps an extension was removed.
 205                         return $type;
 206                 }
 207         }
 208
 209         /**
 210          * Get the log header for the given log type
 211          *
 212          * @todo handle missing log types
 213          * @param $type String: logtype
 214          * @return String: headertext of this logtype
 215          * @deprecated in 1.19, warnings in 1.21. Use getDescription()
 216          */
 217         public static function logHeader( $type ) {
 218                 global $wgLogHeaders;
 219                 return wfMessage( $wgLogHeaders[$type] )->parse();
 220         }
 221
 222         /**
 223          * Generate text for a log entry.
 224          * Only LogFormatter should call this function.
 225          *
 226          * @param $type String: log type
 227          * @param $action String: log action
 228          * @param $title Mixed: Title object or null
 229          * @param $skin Mixed: Skin object or null. If null, we want to use the wiki
 230          *              content language, since that will go to the IRC feed.
 231          * @param $params Array: parameters
 232          * @param $filterWikilinks Boolean: whether to filter wiki links
 233          * @return HTML string
 234          */
 235         public static function actionText( $type, $action, $title = null, $skin = null,
 236                 $params = array(), $filterWikilinks = false )
 237         {
 238                 global $wgLang, $wgContLang, $wgLogActions;
 239
 240                 if ( is_null( $skin ) ) {
 241                         $langObj = $wgContLang;
 242                         $langObjOrNull = null;
 243                 } else {
 244                         $langObj = $wgLang;
 245                         $langObjOrNull = $wgLang;
 246                 }
 247
 248                 $key = "$type/$action";
 249
 250                 if( isset( $wgLogActions[$key] ) ) {
 251                         if( is_null( $title ) ) {
 252                                 $rv = wfMessage( $wgLogActions[$key] )->inLanguage( $langObj )->escaped();
 253                         } else {
 254                                 $titleLink = self::getTitleLink( $type, $langObjOrNull, $title, $params );
 255
 256                                 if( count( $params ) == 0 ) {
 257                                         $rv = wfMessage( $wgLogActions[$key] )->rawParams( $titleLink )->inLanguage( $langObj )->escaped();
 258                                 } else {
 259                                         $details = '';
 260                                         array_unshift( $params, $titleLink );
 261
 262                                         // User suppression
 263                                         if ( preg_match( '/^(block|suppress)\/(block|reblock)$/', $key ) ) {
 264                                                 if ( $skin ) {
 265                                                         $params[1] = '<span class="blockExpiry" dir="ltr" title="' . htmlspecialchars( $params[1] ). '">' .
 266                                                                 $wgLang->translateBlockExpiry( $params[1] ) . '</span>';
 267                                                 } else {
 268                                                         $params[1] = $wgContLang->translateBlockExpiry( $params[1] );
 269                                                 }
 270
 271                                                 $params[2] = isset( $params[2] ) ?
 272                                                         self::formatBlockFlags( $params[2], $langObj ) : '';
 273                                         // Page protections
 274                                         } elseif ( $type == 'protect' && count($params) == 3 ) {
 275                                                 // Restrictions and expiries
 276                                                 if( $skin ) {
 277                                                         $details .= $wgLang->getDirMark() . htmlspecialchars( " {$params[1]}" );
 278                                                 } else {
 279                                                         $details .= " {$params[1]}";
 280                                                 }
 281
 282                                                 // Cascading flag...
 283                                                 if( $params[2] ) {
 284                                                         $details .= ' [' . wfMessage( 'protect-summary-cascade' )->inLanguage( $langObj )->text() . ']';
 285                                                 }
 286                                         }
 287
 288                                         $rv = wfMessage( $wgLogActions[$key] )->rawParams( $params )->inLanguage( $langObj )->escaped() . $details;
 289                                 }
 290                         }
 291                 } else {
 292                         global $wgLogActionsHandlers;
 293
 294                         if( isset( $wgLogActionsHandlers[$key] ) ) {
 295                                 $args = func_get_args();
 296                                 $rv = call_user_func_array( $wgLogActionsHandlers[$key], $args );
 297                         } else {
 298                                 wfDebug( "LogPage::actionText - unknown action $key\n" );
 299                                 $rv = "$action";
 300                         }
 301                 }
 302
 303                 // For the perplexed, this feature was added in r7855 by Erik.
 304                 // The feature was added because we liked adding [[$1]] in our log entries
 305                 // but the log entries are parsed as Wikitext on RecentChanges but as HTML
 306                 // on Special:Log. The hack is essentially that [[$1]] represented a link
 307                 // to the title in question. The first parameter to the HTML version (Special:Log)
 308                 // is that link in HTML form, and so this just gets rid of the ugly [[]].
 309                 // However, this is a horrible hack and it doesn't work like you expect if, say,
 310                 // you want to link to something OTHER than the title of the log entry.
 311                 // The real problem, which Erik was trying to fix (and it sort-of works now) is
 312                 // that the same messages are being treated as both wikitext *and* HTML.
 313                 if( $filterWikilinks ) {
 314                         $rv = str_replace( '[[', '', $rv );
 315                         $rv = str_replace( ']]', '', $rv );
 316                 }
 317
 318                 return $rv;
 319         }
 320
 321         /**
 322          * TODO document
 323          * @param  $type String
 324          * @param  $lang Language or null
 325          * @param  $title Title
 326          * @param  $params Array
 327          * @return String
 328          */
 329         protected static function getTitleLink( $type, $lang, $title, &$params ) {
 330                 if( !$lang ) {
 331                         return $title->getPrefixedText();
 332                 }
 333
 334                 switch( $type ) {
 335                         case 'move':
 336                                 $titleLink = Linker::link(
 337                                         $title,
 338                                         htmlspecialchars( $title->getPrefixedText() ),
 339                                         array(),
 340                                         array( 'redirect' => 'no' )
 341                                 );
 342
 343                                 $targetTitle = Title::newFromText( $params[0] );
 344
 345                                 if ( !$targetTitle ) {
 346                                         # Workaround for broken database
 347                                         $params[0] = htmlspecialchars( $params[0] );
 348                                 } else {
 349                                         $params[0] = Linker::link(
 350                                                 $targetTitle,
 351                                                 htmlspecialchars( $params[0] )
 352                                         );
 353                                 }
 354                                 break;
 355                         case 'block':
 356                                 if( substr( $title->getText(), 0, 1 ) == '#' ) {
 357                                         $titleLink = $title->getText();
 358                                 } else {
 359                                         // @todo Store the user identifier in the parameters
 360                                         // to make this faster for future log entries
 361                                         $id = User::idFromName( $title->getText() );
 362                                         $titleLink = Linker::userLink( $id, $title->getText() )
 363                                                 . Linker::userToolLinks( $id, $title->getText(), false, Linker::TOOL_LINKS_NOBLOCK );
 364                                 }
 365                                 break;
 366                         case 'merge':
 367                                 $titleLink = Linker::link(
 368                                         $title,
 369                                         $title->getPrefixedText(),
 370                                         array(),
 371                                         array( 'redirect' => 'no' )
 372                                 );
 373                                 $params[0] = Linker::link(
 374                                         Title::newFromText( $params[0] ),
 375                                         htmlspecialchars( $params[0] )
 376                                 );
 377                                 $params[1] = $lang->timeanddate( $params[1] );
 378                                 break;
 379                         default:
 380                                 if( $title->isSpecialPage() ) {
 381                                         list( $name, $par ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
 382
 383                                         # Use the language name for log titles, rather than Log/X
 384                                         if( $name == 'Log' ) {
 385                                                 $logPage = new LogPage( $par );
 386                                                 $titleLink = Linker::link( $title, $logPage->getName()->escaped() );
 387                                                 $titleLink = wfMessage( 'parentheses' )
 388                                                         ->inLanguage( $lang )
 389                                                         ->rawParams( $titleLink )
 390                                                         ->escaped();
 391                                         } else {
 392                                                 $titleLink = Linker::link( $title );
 393                                         }
 394                                 } else {
 395                                         $titleLink = Linker::link( $title );
 396                                 }
 397                 }
 398
 399                 return $titleLink;
 400         }
 401
 402         /**
 403          * Add a log entry
 404          *
 405          * @param $action String: one of '', 'block', 'protect', 'rights', 'delete', 'upload', 'move', 'move_redir'
 406          * @param $target Title object
 407          * @param $comment String: description associated
 408          * @param $params Array: parameters passed later to wfMessage function
 409          * @param $doer User object: the user doing the action
 410          *
 411          * @return int log_id of the inserted log entry
 412          */
 413         public function addEntry( $action, $target, $comment, $params = array(), $doer = null ) {
 414                 global $wgContLang;
 415
 416                 if ( !is_array( $params ) ) {
 417                         $params = array( $params );
 418                 }
 419
 420                 if ( $comment === null ) {
 421                         $comment = '';
 422                 }
 423
 424                 # Truncate for whole multibyte characters.
 425                 $comment = $wgContLang->truncate( $comment, 255 );
 426
 427                 $this->action = $action;
 428                 $this->target = $target;
 429                 $this->comment = $comment;
 430                 $this->params = LogPage::makeParamBlob( $params );
 431
 432                 if ( $doer === null ) {
 433                         global $wgUser;
 434                         $doer = $wgUser;
 435                 } elseif ( !is_object( $doer ) ) {
 436                         $doer = User::newFromId( $doer );
 437                 }
 438
 439                 $this->doer = $doer;
 440
 441                 $logEntry = new ManualLogEntry( $this->type, $action );
 442                 $logEntry->setTarget( $target );
 443                 $logEntry->setPerformer( $doer );
 444                 $logEntry->setParameters( $params );
 445
 446                 $formatter = LogFormatter::newFromEntry( $logEntry );
 447                 $context = RequestContext::newExtraneousContext( $target );
 448                 $formatter->setContext( $context );
 449
 450                 $this->actionText = $formatter->getPlainActionText();
 451                 $this->ircActionText = $formatter->getIRCActionText();
 452
 453                 return $this->saveContent();
 454         }
 455
 456         /**
 457          * Add relations to log_search table
 458          *
 459          * @param $field String
 460          * @param $values Array
 461          * @param $logid Integer
 462          * @return Boolean
 463          */
 464         public function addRelations( $field, $values, $logid ) {
 465                 if( !strlen( $field ) || empty( $values ) ) {
 466                         return false; // nothing
 467                 }
 468
 469                 $data = array();
 470
 471                 foreach( $values as $value ) {
 472                         $data[] = array(
 473                                 'ls_field' => $field,
 474                                 'ls_value' => $value,
 475                                 'ls_log_id' => $logid
 476                         );
 477                 }
 478
 479                 $dbw = wfGetDB( DB_MASTER );
 480                 $dbw->insert( 'log_search', $data, __METHOD__, 'IGNORE' );
 481
 482                 return true;
 483         }
 484
 485         /**
 486          * Create a blob from a parameter array
 487          *
 488          * @param $params Array
 489          * @return String
 490          */
 491         public static function makeParamBlob( $params ) {
 492                 return implode( "\n", $params );
 493         }
 494
 495         /**
 496          * Extract a parameter array from a blob
 497          *
 498          * @param $blob String
 499          * @return Array
 500          */
 501         public static function extractParams( $blob ) {
 502                 if ( $blob === '' ) {
 503                         return array();
 504                 } else {
 505                         return explode( "\n", $blob );
 506                 }
 507         }
 508
 509         /**
 510          * Convert a comma-delimited list of block log flags
 511          * into a more readable (and translated) form
 512          *
 513          * @param $flags string Flags to format
 514          * @param $lang Language object to use
 515          * @return String
 516          */
 517         public static function formatBlockFlags( $flags, $lang ) {
 518                 $flags = explode( ',', trim( $flags ) );
 519
 520                 if( count( $flags ) > 0 ) {
 521                         for( $i = 0; $i < count( $flags ); $i++ ) {
 522                                 $flags[$i] = self::formatBlockFlag( $flags[$i], $lang );
 523                         }
 524                         return wfMessage( 'parentheses' )->inLanguage( $lang )
 525                                 ->rawParams( $lang->commaList( $flags ) )->escaped();
 526                 } else {
 527                         return '';
 528                 }
 529         }
 530
 531         /**
 532          * Translate a block log flag if possible
 533          *
 534          * @param $flag int Flag to translate
 535          * @param $lang Language object to use
 536          * @return String
 537          */
 538         public static function formatBlockFlag( $flag, $lang ) {
 539                 static $messages = array();
 540
 541                 if( !isset( $messages[$flag] ) ) {
 542                         $messages[$flag] = htmlspecialchars( $flag ); // Fallback
 543
 544                         // For grepping. The following core messages can be used here:
 545                         // * block-log-flags-angry-autoblock
 546                         // * block-log-flags-anononly
 547                         // * block-log-flags-hiddenname
 548                         // * block-log-flags-noautoblock
 549                         // * block-log-flags-nocreate
 550                         // * block-log-flags-noemail
 551                         // * block-log-flags-nousertalk
 552                         $msg = wfMessage( 'block-log-flags-' . $flag )->inLanguage( $lang );
 553
 554                         if ( $msg->exists() ) {
 555                                 $messages[$flag] = $msg->escaped();
 556                         }
 557                 }
 558
 559                 return $messages[$flag];
 560         }
 561
 562
 563         /**
 564          * Name of the log.
 565          * @return Message
 566          * @since 1.19
 567          */
 568         public function getName() {
 569                 global $wgLogNames;
 570
 571                 // BC
 572                 if ( isset( $wgLogNames[$this->type] ) ) {
 573                         $key = $wgLogNames[$this->type];
 574                 } else {
 575                         $key = 'log-name-' . $this->type;
 576                 }
 577
 578                 return wfMessage( $key );
 579         }
 580
 581         /**
 582          * Description of this log type.
 583          * @return Message
 584          * @since 1.19
 585          */
 586         public function getDescription() {
 587                 global $wgLogHeaders;
 588                 // BC
 589                 if ( isset( $wgLogHeaders[$this->type] ) ) {
 590                         $key = $wgLogHeaders[$this->type];
 591                 } else {
 592                         $key = 'log-description-' . $this->type;
 593                 }
 594                 return wfMessage( $key );
 595         }
 596
 597         /**
 598          * Returns the right needed to read this log type.
 599          * @return string
 600          * @since 1.19
 601          */
 602         public function getRestriction() {
 603                 global $wgLogRestrictions;
 604                 if ( isset( $wgLogRestrictions[$this->type] ) ) {
 605                         $restriction = $wgLogRestrictions[$this->type];
 606                 } else {
 607                         // '' always returns true with $user->isAllowed()
 608                         $restriction = '';
 609                 }
 610                 return $restriction;
 611         }
 612
 613         /**
 614          * Tells if this log is not viewable by all.
 615          * @return bool
 616          * @since 1.19
 617          */
 618         public function isRestricted() {
 619                 $restriction = $this->getRestriction();
 620                 return $restriction !== '' && $restriction !== '*';
 621         }
 622
 623 }