includes/logging/LogPage.php

   1 <?php
   2 /**
   3  * Contain log classes
   4  *
   5  * Copyright © 2002, 2004 Brion Vibber <brion@pobox.com>
   6  * https://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
  38         // Convenience fields
  39         const SUPPRESSED_USER = 12;
  40         const SUPPRESSED_ACTION = 9;
  41
  42         /** @var bool */
  43         public $updateRecentChanges;
  44
  45         /** @var bool */
  46         public $sendToUDP;
  47
  48         /** @var string Plaintext version of the message for IRC */
  49         private $ircActionText;
  50
  51         /** @var string Plaintext version of the message */
  52         private $actionText;
  53
  54         /** @var string One of '', 'block', 'protect', 'rights', 'delete',
  55          *    'upload', 'move'
  56          */
  57         private $type;
  58
  59         /** @var string One of '', 'block', 'protect', 'rights', 'delete',
  60          *   'upload', 'move', 'move_redir' */
  61         private $action;
  62
  63         /** @var string Comment associated with action */
  64         private $comment;
  65
  66         /** @var string Blob made of a parameters array */
  67         private $params;
  68
  69         /** @var User The user doing the action */
  70         private $doer;
  71
  72         /** @var Title */
  73         private $target;
  74
  75         /**
  76          * Constructor
  77          *
  78          * @param string $type One of '', 'block', 'protect', 'rights', 'delete',
  79          *   'upload', 'move'
  80          * @param bool $rc Whether to update recent changes as well as the logging table
  81          * @param string $udp Pass 'UDP' to send to the UDP feed if NOT sent to RC
  82          */
  83         public function __construct( $type, $rc = true, $udp = 'skipUDP' ) {
  84                 $this->type = $type;
  85                 $this->updateRecentChanges = $rc;
  86                 $this->sendToUDP = ( $udp == 'UDP' );
  87         }
  88
  89         /**
  90          * @return int The log_id of the inserted log entry
  91          */
  92         protected function saveContent() {
  93                 global $wgLogRestrictions;
  94
  95                 $dbw = wfGetDB( DB_MASTER );
  96                 $log_id = $dbw->nextSequenceValue( 'logging_log_id_seq' );
  97
  98                 // @todo FIXME private/protected/public property?
  99                 $this->timestamp = $now = wfTimestampNow();
 100                 $data = array(
 101                         'log_id' => $log_id,
 102                         'log_type' => $this->type,
 103                         'log_action' => $this->action,
 104                         'log_timestamp' => $dbw->timestamp( $now ),
 105                         'log_user' => $this->doer->getId(),
 106                         'log_user_text' => $this->doer->getName(),
 107                         'log_namespace' => $this->target->getNamespace(),
 108                         'log_title' => $this->target->getDBkey(),
 109                         'log_page' => $this->target->getArticleID(),
 110                         'log_comment' => $this->comment,
 111                         'log_params' => $this->params
 112                 );
 113                 $dbw->insert( 'logging', $data, __METHOD__ );
 114                 $newId = !is_null( $log_id ) ? $log_id : $dbw->insertId();
 115
 116                 # And update recentchanges
 117                 if ( $this->updateRecentChanges ) {
 118                         $titleObj = SpecialPage::getTitleFor( 'Log', $this->type );
 119
 120                         RecentChange::notifyLog(
 121                                 $now, $titleObj, $this->doer, $this->getRcComment(), '',
 122                                 $this->type, $this->action, $this->target, $this->comment,
 123                                 $this->params, $newId, $this->getRcCommentIRC()
 124                         );
 125                 } elseif ( $this->sendToUDP ) {
 126                         # Don't send private logs to UDP
 127                         if ( isset( $wgLogRestrictions[$this->type] ) && $wgLogRestrictions[$this->type] != '*' ) {
 128                                 return $newId;
 129                         }
 130
 131                         # Notify external application via UDP.
 132                         # We send this to IRC but do not want to add it the RC table.
 133                         $titleObj = SpecialPage::getTitleFor( 'Log', $this->type );
 134                         $rc = RecentChange::newLogEntry(
 135                                 $now, $titleObj, $this->doer, $this->getRcComment(), '',
 136                                 $this->type, $this->action, $this->target, $this->comment,
 137                                 $this->params, $newId, $this->getRcCommentIRC()
 138                         );
 139                         $rc->notifyRCFeeds();
 140                 }
 141
 142                 return $newId;
 143         }
 144
 145         /**
 146          * Get the RC comment from the last addEntry() call
 147          *
 148          * @return string
 149          */
 150         public function getRcComment() {
 151                 $rcComment = $this->actionText;
 152
 153                 if ( $this->comment != '' ) {
 154                         if ( $rcComment == '' ) {
 155                                 $rcComment = $this->comment;
 156                         } else {
 157                                 $rcComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() .
 158                                         $this->comment;
 159                         }
 160                 }
 161
 162                 return $rcComment;
 163         }
 164
 165         /**
 166          * Get the RC comment from the last addEntry() call for IRC
 167          *
 168          * @return string
 169          */
 170         public function getRcCommentIRC() {
 171                 $rcComment = $this->ircActionText;
 172
 173                 if ( $this->comment != '' ) {
 174                         if ( $rcComment == '' ) {
 175                                 $rcComment = $this->comment;
 176                         } else {
 177                                 $rcComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() .
 178                                         $this->comment;
 179                         }
 180                 }
 181
 182                 return $rcComment;
 183         }
 184
 185         /**
 186          * Get the comment from the last addEntry() call
 187          * @return string
 188          */
 189         public function getComment() {
 190                 return $this->comment;
 191         }
 192
 193         /**
 194          * Get the list of valid log types
 195          *
 196          * @return array Array of strings
 197          */
 198         public static function validTypes() {
 199                 global $wgLogTypes;
 200
 201                 return $wgLogTypes;
 202         }
 203
 204         /**
 205          * Is $type a valid log type
 206          *
 207          * @param string $type Log type to check
 208          * @return bool
 209          */
 210         public static function isLogType( $type ) {
 211                 return in_array( $type, LogPage::validTypes() );
 212         }
 213
 214         /**
 215          * Get the name for the given log type
 216          *
 217          * @param string $type Log type
 218          * @return string Log name
 219          * @deprecated since 1.19, warnings in 1.21. Use getName()
 220          */
 221         public static function logName( $type ) {
 222                 global $wgLogNames;
 223
 224                 wfDeprecated( __METHOD__, '1.21' );
 225
 226                 if ( isset( $wgLogNames[$type] ) ) {
 227                         return str_replace( '_', ' ', wfMessage( $wgLogNames[$type] )->text() );
 228                 } else {
 229                         // Bogus log types? Perhaps an extension was removed.
 230                         return $type;
 231                 }
 232         }
 233
 234         /**
 235          * Get the log header for the given log type
 236          *
 237          * @todo handle missing log types
 238          * @param string $type Logtype
 239          * @return string Header text of this logtype
 240          * @deprecated since 1.19, warnings in 1.21. Use getDescription()
 241          */
 242         public static function logHeader( $type ) {
 243                 global $wgLogHeaders;
 244
 245                 wfDeprecated( __METHOD__, '1.21' );
 246
 247                 return wfMessage( $wgLogHeaders[$type] )->parse();
 248         }
 249
 250         /**
 251          * Generate text for a log entry.
 252          * Only LogFormatter should call this function.
 253          *
 254          * @param string $type Log type
 255          * @param string $action Log action
 256          * @param Title|null $title Title object or null
 257          * @param Skin|null $skin Skin object or null. If null, we want to use the wiki
 258          *   content language, since that will go to the IRC feed.
 259          * @param array $params Parameters
 260          * @param bool $filterWikilinks Whether to filter wiki links
 261          * @return string HTML
 262          */
 263         public static function actionText( $type, $action, $title = null, $skin = null,
 264                 $params = array(), $filterWikilinks = false
 265         ) {
 266                 global $wgLang, $wgContLang, $wgLogActions;
 267
 268                 if ( is_null( $skin ) ) {
 269                         $langObj = $wgContLang;
 270                         $langObjOrNull = null;
 271                 } else {
 272                         $langObj = $wgLang;
 273                         $langObjOrNull = $wgLang;
 274                 }
 275
 276                 $key = "$type/$action";
 277
 278                 if ( isset( $wgLogActions[$key] ) ) {
 279                         if ( is_null( $title ) ) {
 280                                 $rv = wfMessage( $wgLogActions[$key] )->inLanguage( $langObj )->escaped();
 281                         } else {
 282                                 $titleLink = self::getTitleLink( $type, $langObjOrNull, $title, $params );
 283
 284                                 if ( count( $params ) == 0 ) {
 285                                         $rv = wfMessage( $wgLogActions[$key] )->rawParams( $titleLink )
 286                                                 ->inLanguage( $langObj )->escaped();
 287                                 } else {
 288                                         $details = '';
 289                                         array_unshift( $params, $titleLink );
 290
 291                                         // Page protections
 292                                         if ( $type == 'protect' && count( $params ) == 3 ) {
 293                                                 // Restrictions and expiries
 294                                                 if ( $skin ) {
 295                                                         $details .= $wgLang->getDirMark() . htmlspecialchars( " {$params[1]}" );
 296                                                 } else {
 297                                                         $details .= " {$params[1]}";
 298                                                 }
 299
 300                                                 // Cascading flag...
 301                                                 if ( $params[2] ) {
 302                                                         $text = wfMessage( 'protect-summary-cascade' )
 303                                                                 ->inLanguage( $langObj )->text();
 304                                                         $details .= ' ';
 305                                                         $details .= wfMessage( 'brackets', $text )->inLanguage( $langObj )->text();
 306
 307                                                 }
 308                                         }
 309
 310                                         $rv = wfMessage( $wgLogActions[$key] )->rawParams( $params )
 311                                                         ->inLanguage( $langObj )->escaped() . $details;
 312                                 }
 313                         }
 314                 } else {
 315                         global $wgLogActionsHandlers;
 316
 317                         if ( isset( $wgLogActionsHandlers[$key] ) ) {
 318                                 $args = func_get_args();
 319                                 $rv = call_user_func_array( $wgLogActionsHandlers[$key], $args );
 320                         } else {
 321                                 wfDebug( "LogPage::actionText - unknown action $key\n" );
 322                                 $rv = "$action";
 323                         }
 324                 }
 325
 326                 // For the perplexed, this feature was added in r7855 by Erik.
 327                 // The feature was added because we liked adding [[$1]] in our log entries
 328                 // but the log entries are parsed as Wikitext on RecentChanges but as HTML
 329                 // on Special:Log. The hack is essentially that [[$1]] represented a link
 330                 // to the title in question. The first parameter to the HTML version (Special:Log)
 331                 // is that link in HTML form, and so this just gets rid of the ugly [[]].
 332                 // However, this is a horrible hack and it doesn't work like you expect if, say,
 333                 // you want to link to something OTHER than the title of the log entry.
 334                 // The real problem, which Erik was trying to fix (and it sort-of works now) is
 335                 // that the same messages are being treated as both wikitext *and* HTML.
 336                 if ( $filterWikilinks ) {
 337                         $rv = str_replace( '[[', '', $rv );
 338                         $rv = str_replace( ']]', '', $rv );
 339                 }
 340
 341                 return $rv;
 342         }
 343
 344         /**
 345          * @todo Document
 346          * @param string $type
 347          * @param Language|null $lang
 348          * @param Title $title
 349          * @param array $params
 350          * @return string
 351          */
 352         protected static function getTitleLink( $type, $lang, $title, &$params ) {
 353                 if ( !$lang ) {
 354                         return $title->getPrefixedText();
 355                 }
 356
 357                 if ( $title->isSpecialPage() ) {
 358                         list( $name, $par ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
 359
 360                         # Use the language name for log titles, rather than Log/X
 361                         if ( $name == 'Log' ) {
 362                                 $logPage = new LogPage( $par );
 363                                 $titleLink = Linker::link( $title, $logPage->getName()->escaped() );
 364                                 $titleLink = wfMessage( 'parentheses' )
 365                                         ->inLanguage( $lang )
 366                                         ->rawParams( $titleLink )
 367                                         ->escaped();
 368                         } else {
 369                                 $titleLink = Linker::link( $title );
 370                         }
 371                 } else {
 372                         $titleLink = Linker::link( $title );
 373                 }
 374
 375                 return $titleLink;
 376         }
 377
 378         /**
 379          * Add a log entry
 380          *
 381          * @param string $action One of '', 'block', 'protect', 'rights', 'delete',
 382          *   'upload', 'move', 'move_redir'
 383          * @param Title $target Title object
 384          * @param string $comment Description associated
 385          * @param array $params Parameters passed later to wfMessage function
 386          * @param null|int|User $doer The user doing the action. null for $wgUser
 387          *
 388          * @return int The log_id of the inserted log entry
 389          */
 390         public function addEntry( $action, $target, $comment, $params = array(), $doer = null ) {
 391                 global $wgContLang;
 392
 393                 if ( !is_array( $params ) ) {
 394                         $params = array( $params );
 395                 }
 396
 397                 if ( $comment === null ) {
 398                         $comment = '';
 399                 }
 400
 401                 # Trim spaces on user supplied text
 402                 $comment = trim( $comment );
 403
 404                 # Truncate for whole multibyte characters.
 405                 $comment = $wgContLang->truncate( $comment, 255 );
 406
 407                 $this->action = $action;
 408                 $this->target = $target;
 409                 $this->comment = $comment;
 410                 $this->params = LogPage::makeParamBlob( $params );
 411
 412                 if ( $doer === null ) {
 413                         global $wgUser;
 414                         $doer = $wgUser;
 415                 } elseif ( !is_object( $doer ) ) {
 416                         $doer = User::newFromId( $doer );
 417                 }
 418
 419                 $this->doer = $doer;
 420
 421                 $logEntry = new ManualLogEntry( $this->type, $action );
 422                 $logEntry->setTarget( $target );
 423                 $logEntry->setPerformer( $doer );
 424                 $logEntry->setParameters( $params );
 425                 // All log entries using the LogPage to insert into the logging table
 426                 // are using the old logging system and therefore the legacy flag is
 427                 // needed to say the LogFormatter the parameters have numeric keys
 428                 $logEntry->setLegacy( true );
 429
 430                 $formatter = LogFormatter::newFromEntry( $logEntry );
 431                 $context = RequestContext::newExtraneousContext( $target );
 432                 $formatter->setContext( $context );
 433
 434                 $this->actionText = $formatter->getPlainActionText();
 435                 $this->ircActionText = $formatter->getIRCActionText();
 436
 437                 return $this->saveContent();
 438         }
 439
 440         /**
 441          * Add relations to log_search table
 442          *
 443          * @param string $field
 444          * @param array $values
 445          * @param int $logid
 446          * @return bool
 447          */
 448         public function addRelations( $field, $values, $logid ) {
 449                 if ( !strlen( $field ) || empty( $values ) ) {
 450                         return false; // nothing
 451                 }
 452
 453                 $data = array();
 454
 455                 foreach ( $values as $value ) {
 456                         $data[] = array(
 457                                 'ls_field' => $field,
 458                                 'ls_value' => $value,
 459                                 'ls_log_id' => $logid
 460                         );
 461                 }
 462
 463                 $dbw = wfGetDB( DB_MASTER );
 464                 $dbw->insert( 'log_search', $data, __METHOD__, 'IGNORE' );
 465
 466                 return true;
 467         }
 468
 469         /**
 470          * Create a blob from a parameter array
 471          *
 472          * @param array $params
 473          * @return string
 474          */
 475         public static function makeParamBlob( $params ) {
 476                 return implode( "\n", $params );
 477         }
 478
 479         /**
 480          * Extract a parameter array from a blob
 481          *
 482          * @param string $blob
 483          * @return array
 484          */
 485         public static function extractParams( $blob ) {
 486                 if ( $blob === '' ) {
 487                         return array();
 488                 } else {
 489                         return explode( "\n", $blob );
 490                 }
 491         }
 492
 493         /**
 494          * Name of the log.
 495          * @return Message
 496          * @since 1.19
 497          */
 498         public function getName() {
 499                 global $wgLogNames;
 500
 501                 // BC
 502                 if ( isset( $wgLogNames[$this->type] ) ) {
 503                         $key = $wgLogNames[$this->type];
 504                 } else {
 505                         $key = 'log-name-' . $this->type;
 506                 }
 507
 508                 return wfMessage( $key );
 509         }
 510
 511         /**
 512          * Description of this log type.
 513          * @return Message
 514          * @since 1.19
 515          */
 516         public function getDescription() {
 517                 global $wgLogHeaders;
 518                 // BC
 519                 if ( isset( $wgLogHeaders[$this->type] ) ) {
 520                         $key = $wgLogHeaders[$this->type];
 521                 } else {
 522                         $key = 'log-description-' . $this->type;
 523                 }
 524
 525                 return wfMessage( $key );
 526         }
 527
 528         /**
 529          * Returns the right needed to read this log type.
 530          * @return string
 531          * @since 1.19
 532          */
 533         public function getRestriction() {
 534                 global $wgLogRestrictions;
 535                 if ( isset( $wgLogRestrictions[$this->type] ) ) {
 536                         $restriction = $wgLogRestrictions[$this->type];
 537                 } else {
 538                         // '' always returns true with $user->isAllowed()
 539                         $restriction = '';
 540                 }
 541
 542                 return $restriction;
 543         }
 544
 545         /**
 546          * Tells if this log is not viewable by all.
 547          * @return bool
 548          * @since 1.19
 549          */
 550         public function isRestricted() {
 551                 $restriction = $this->getRestriction();
 552
 553                 return $restriction !== '' && $restriction !== '*';
 554         }
 555 }