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                                         array_unshift( $params, $titleLink );
 289
 290                                         $rv = wfMessage( $wgLogActions[$key] )->rawParams( $params )
 291                                                         ->inLanguage( $langObj )->escaped();
 292                                 }
 293                         }
 294                 } else {
 295                         global $wgLogActionsHandlers;
 296
 297                         if ( isset( $wgLogActionsHandlers[$key] ) ) {
 298                                 $args = func_get_args();
 299                                 $rv = call_user_func_array( $wgLogActionsHandlers[$key], $args );
 300                         } else {
 301                                 wfDebug( "LogPage::actionText - unknown action $key\n" );
 302                                 $rv = "$action";
 303                         }
 304                 }
 305
 306                 // For the perplexed, this feature was added in r7855 by Erik.
 307                 // The feature was added because we liked adding [[$1]] in our log entries
 308                 // but the log entries are parsed as Wikitext on RecentChanges but as HTML
 309                 // on Special:Log. The hack is essentially that [[$1]] represented a link
 310                 // to the title in question. The first parameter to the HTML version (Special:Log)
 311                 // is that link in HTML form, and so this just gets rid of the ugly [[]].
 312                 // However, this is a horrible hack and it doesn't work like you expect if, say,
 313                 // you want to link to something OTHER than the title of the log entry.
 314                 // The real problem, which Erik was trying to fix (and it sort-of works now) is
 315                 // that the same messages are being treated as both wikitext *and* HTML.
 316                 if ( $filterWikilinks ) {
 317                         $rv = str_replace( '[[', '', $rv );
 318                         $rv = str_replace( ']]', '', $rv );
 319                 }
 320
 321                 return $rv;
 322         }
 323
 324         /**
 325          * @todo Document
 326          * @param string $type
 327          * @param Language|null $lang
 328          * @param Title $title
 329          * @param array $params
 330          * @return string
 331          */
 332         protected static function getTitleLink( $type, $lang, $title, &$params ) {
 333                 if ( !$lang ) {
 334                         return $title->getPrefixedText();
 335                 }
 336
 337                 if ( $title->isSpecialPage() ) {
 338                         list( $name, $par ) = SpecialPageFactory::resolveAlias( $title->getDBkey() );
 339
 340                         # Use the language name for log titles, rather than Log/X
 341                         if ( $name == 'Log' ) {
 342                                 $logPage = new LogPage( $par );
 343                                 $titleLink = Linker::link( $title, $logPage->getName()->escaped() );
 344                                 $titleLink = wfMessage( 'parentheses' )
 345                                         ->inLanguage( $lang )
 346                                         ->rawParams( $titleLink )
 347                                         ->escaped();
 348                         } else {
 349                                 $titleLink = Linker::link( $title );
 350                         }
 351                 } else {
 352                         $titleLink = Linker::link( $title );
 353                 }
 354
 355                 return $titleLink;
 356         }
 357
 358         /**
 359          * Add a log entry
 360          *
 361          * @param string $action One of '', 'block', 'protect', 'rights', 'delete',
 362          *   'upload', 'move', 'move_redir'
 363          * @param Title $target Title object
 364          * @param string $comment Description associated
 365          * @param array $params Parameters passed later to wfMessage function
 366          * @param null|int|User $doer The user doing the action. null for $wgUser
 367          *
 368          * @return int The log_id of the inserted log entry
 369          */
 370         public function addEntry( $action, $target, $comment, $params = array(), $doer = null ) {
 371                 global $wgContLang;
 372
 373                 if ( !is_array( $params ) ) {
 374                         $params = array( $params );
 375                 }
 376
 377                 if ( $comment === null ) {
 378                         $comment = '';
 379                 }
 380
 381                 # Trim spaces on user supplied text
 382                 $comment = trim( $comment );
 383
 384                 # Truncate for whole multibyte characters.
 385                 $comment = $wgContLang->truncate( $comment, 255 );
 386
 387                 $this->action = $action;
 388                 $this->target = $target;
 389                 $this->comment = $comment;
 390                 $this->params = LogPage::makeParamBlob( $params );
 391
 392                 if ( $doer === null ) {
 393                         global $wgUser;
 394                         $doer = $wgUser;
 395                 } elseif ( !is_object( $doer ) ) {
 396                         $doer = User::newFromId( $doer );
 397                 }
 398
 399                 $this->doer = $doer;
 400
 401                 $logEntry = new ManualLogEntry( $this->type, $action );
 402                 $logEntry->setTarget( $target );
 403                 $logEntry->setPerformer( $doer );
 404                 $logEntry->setParameters( $params );
 405                 // All log entries using the LogPage to insert into the logging table
 406                 // are using the old logging system and therefore the legacy flag is
 407                 // needed to say the LogFormatter the parameters have numeric keys
 408                 $logEntry->setLegacy( true );
 409
 410                 $formatter = LogFormatter::newFromEntry( $logEntry );
 411                 $context = RequestContext::newExtraneousContext( $target );
 412                 $formatter->setContext( $context );
 413
 414                 $this->actionText = $formatter->getPlainActionText();
 415                 $this->ircActionText = $formatter->getIRCActionText();
 416
 417                 return $this->saveContent();
 418         }
 419
 420         /**
 421          * Add relations to log_search table
 422          *
 423          * @param string $field
 424          * @param array $values
 425          * @param int $logid
 426          * @return bool
 427          */
 428         public function addRelations( $field, $values, $logid ) {
 429                 if ( !strlen( $field ) || empty( $values ) ) {
 430                         return false; // nothing
 431                 }
 432
 433                 $data = array();
 434
 435                 foreach ( $values as $value ) {
 436                         $data[] = array(
 437                                 'ls_field' => $field,
 438                                 'ls_value' => $value,
 439                                 'ls_log_id' => $logid
 440                         );
 441                 }
 442
 443                 $dbw = wfGetDB( DB_MASTER );
 444                 $dbw->insert( 'log_search', $data, __METHOD__, 'IGNORE' );
 445
 446                 return true;
 447         }
 448
 449         /**
 450          * Create a blob from a parameter array
 451          *
 452          * @param array $params
 453          * @return string
 454          */
 455         public static function makeParamBlob( $params ) {
 456                 return implode( "\n", $params );
 457         }
 458
 459         /**
 460          * Extract a parameter array from a blob
 461          *
 462          * @param string $blob
 463          * @return array
 464          */
 465         public static function extractParams( $blob ) {
 466                 if ( $blob === '' ) {
 467                         return array();
 468                 } else {
 469                         return explode( "\n", $blob );
 470                 }
 471         }
 472
 473         /**
 474          * Name of the log.
 475          * @return Message
 476          * @since 1.19
 477          */
 478         public function getName() {
 479                 global $wgLogNames;
 480
 481                 // BC
 482                 if ( isset( $wgLogNames[$this->type] ) ) {
 483                         $key = $wgLogNames[$this->type];
 484                 } else {
 485                         $key = 'log-name-' . $this->type;
 486                 }
 487
 488                 return wfMessage( $key );
 489         }
 490
 491         /**
 492          * Description of this log type.
 493          * @return Message
 494          * @since 1.19
 495          */
 496         public function getDescription() {
 497                 global $wgLogHeaders;
 498                 // BC
 499                 if ( isset( $wgLogHeaders[$this->type] ) ) {
 500                         $key = $wgLogHeaders[$this->type];
 501                 } else {
 502                         $key = 'log-description-' . $this->type;
 503                 }
 504
 505                 return wfMessage( $key );
 506         }
 507
 508         /**
 509          * Returns the right needed to read this log type.
 510          * @return string
 511          * @since 1.19
 512          */
 513         public function getRestriction() {
 514                 global $wgLogRestrictions;
 515                 if ( isset( $wgLogRestrictions[$this->type] ) ) {
 516                         $restriction = $wgLogRestrictions[$this->type];
 517                 } else {
 518                         // '' always returns true with $user->isAllowed()
 519                         $restriction = '';
 520                 }
 521
 522                 return $restriction;
 523         }
 524
 525         /**
 526          * Tells if this log is not viewable by all.
 527          * @return bool
 528          * @since 1.19
 529          */
 530         public function isRestricted() {
 531                 $restriction = $this->getRestriction();
 532
 533                 return $restriction !== '' && $restriction !== '*';
 534         }
 535 }