3 * Utility class for creating and accessing recent change entries.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Utility class for creating new RC entries
27 * rc_id id of the row in the recentchanges table
28 * rc_timestamp time the entry was made
29 * rc_namespace namespace #
30 * rc_title non-prefixed db key
31 * rc_type is new entry, used to determine whether updating is necessary
32 * rc_source string representation of change source
34 * rc_cur_id page_id of associated page entry
35 * rc_user user id who made the entry
36 * rc_user_text user name who made the entry
37 * rc_comment edit summary
38 * rc_this_oldid rev_id associated with this entry (or zero)
39 * rc_last_oldid rev_id associated with the entry before this one (or zero)
40 * rc_bot is bot, hidden
41 * rc_ip IP address of the user in dotted quad notation
42 * rc_new obsolete, use rc_type==RC_NEW
43 * rc_patrolled boolean whether or not someone has marked this edit as patrolled
44 * rc_old_len integer byte length of the text before the edit
45 * rc_new_len the same after the edit
46 * rc_deleted partial deletion
47 * rc_logid the log_id value for this log entry (or zero)
48 * rc_log_type the log type (or null)
49 * rc_log_action the log action (or null)
50 * rc_params log params
53 * prefixedDBkey prefixed db key, used by external app via msg queue
54 * lastTimestamp timestamp of previous entry, used in WHERE clause during update
55 * oldSize text size before the change
56 * newSize text size after the change
57 * pageStatus status of the page: created, deleted, moved, restored, changed
59 * temporary: not stored in the database
60 * notificationtimestamp
61 * numberofWatchingusers
63 * @todo Deprecate access to mAttribs (direct or via getAttributes). Right now
64 * we're having to include both rc_comment and rc_comment_text/rc_comment_data
65 * so random crap works right.
68 // Constants for the rc_source field. Extensions may also have
69 // their own source constants.
70 const SRC_EDIT
= 'mw.edit';
71 const SRC_NEW
= 'mw.new';
72 const SRC_LOG
= 'mw.log';
73 const SRC_EXTERNAL
= 'mw.external'; // obsolete
74 const SRC_CATEGORIZE
= 'mw.categorize';
76 public $mAttribs = [];
82 public $mTitle = false;
87 private $mPerformer = false;
89 public $numberofWatchingusers = 0; # Dummy to prevent error message in SpecialRecentChangesLinked
90 public $notificationtimestamp;
93 * @var int Line number of recent change. Default -1.
98 * @var array List of tags to apply
103 * @var array Array of change types
105 private static $changeTypes = [
109 'external' => RC_EXTERNAL
,
110 'categorize' => RC_CATEGORIZE
,
117 * @return RecentChange
119 public static function newFromRow( $row ) {
120 $rc = new RecentChange
;
121 $rc->loadFromRow( $row );
127 * Parsing text to RC_* constants
129 * @param string|array $type
130 * @throws MWException
131 * @return int|array RC_TYPE
133 public static function parseToRCType( $type ) {
134 if ( is_array( $type ) ) {
136 foreach ( $type as $t ) {
137 $retval[] = self
::parseToRCType( $t );
143 if ( !array_key_exists( $type, self
::$changeTypes ) ) {
144 throw new MWException( "Unknown type '$type'" );
146 return self
::$changeTypes[$type];
150 * Parsing RC_* constants to human-readable test
153 * @return string $type
155 public static function parseFromRCType( $rcType ) {
156 return array_search( $rcType, self
::$changeTypes, true ) ?
: "$rcType";
160 * Get an array of all change types
166 public static function getChangeTypes() {
167 return array_keys( self
::$changeTypes );
171 * Obtain the recent change with a given rc_id value
173 * @param int $rcid The rc_id value to retrieve
174 * @return RecentChange|null
176 public static function newFromId( $rcid ) {
177 return self
::newFromConds( [ 'rc_id' => $rcid ], __METHOD__
);
181 * Find the first recent change matching some specific conditions
183 * @param array $conds Array of conditions
184 * @param mixed $fname Override the method name in profiling/logs
185 * @param int $dbType DB_* constant
187 * @return RecentChange|null
189 public static function newFromConds(
194 $db = wfGetDB( $dbType );
195 $row = $db->selectRow( 'recentchanges', self
::selectFields(), $conds, $fname );
196 if ( $row !== false ) {
197 return self
::newFromRow( $row );
204 * Return the list of recentchanges fields that should be selected to create
205 * a new recentchanges object.
206 * @todo Deprecate this in favor of a method that returns tables and joins
207 * as well, and use CommentStore::getJoin().
210 public static function selectFields() {
235 ] + CommentStore
::newKey( 'rc_comment' )->getFields();
241 * @param array $attribs
243 public function setAttribs( $attribs ) {
244 $this->mAttribs
= $attribs;
248 * @param array $extra
250 public function setExtra( $extra ) {
251 $this->mExtra
= $extra;
257 public function &getTitle() {
258 if ( $this->mTitle
=== false ) {
259 $this->mTitle
= Title
::makeTitle( $this->mAttribs
['rc_namespace'], $this->mAttribs
['rc_title'] );
262 return $this->mTitle
;
266 * Get the User object of the person who performed this change.
270 public function getPerformer() {
271 if ( $this->mPerformer
=== false ) {
272 if ( $this->mAttribs
['rc_user'] ) {
273 $this->mPerformer
= User
::newFromId( $this->mAttribs
['rc_user'] );
275 $this->mPerformer
= User
::newFromName( $this->mAttribs
['rc_user_text'], false );
279 return $this->mPerformer
;
283 * Writes the data in this object to the database
286 public function save( $noudp = false ) {
287 global $wgPutIPinRC, $wgUseEnotif, $wgShowUpdatedMarker, $wgContLang;
289 $dbw = wfGetDB( DB_MASTER
);
290 if ( !is_array( $this->mExtra
) ) {
294 if ( !$wgPutIPinRC ) {
295 $this->mAttribs
['rc_ip'] = '';
298 # Strict mode fixups (not-NULL fields)
299 foreach ( [ 'minor', 'bot', 'new', 'patrolled', 'deleted' ] as $field ) {
300 $this->mAttribs
["rc_$field"] = (int)$this->mAttribs
["rc_$field"];
302 # ...more fixups (NULL fields)
303 foreach ( [ 'old_len', 'new_len' ] as $field ) {
304 $this->mAttribs
["rc_$field"] = isset( $this->mAttribs
["rc_$field"] )
305 ?
(int)$this->mAttribs
["rc_$field"]
309 # If our database is strict about IP addresses, use NULL instead of an empty string
310 $strictIPs = in_array( $dbw->getType(), [ 'oracle', 'postgres' ] ); // legacy
311 if ( $strictIPs && $this->mAttribs
['rc_ip'] == '' ) {
312 unset( $this->mAttribs
['rc_ip'] );
315 # Trim spaces on user supplied text
316 $this->mAttribs
['rc_comment'] = trim( $this->mAttribs
['rc_comment'] );
318 # Make sure summary is truncated (whole multibyte characters)
319 $this->mAttribs
['rc_comment'] = $wgContLang->truncate( $this->mAttribs
['rc_comment'], 255 );
321 # Fixup database timestamps
322 $this->mAttribs
['rc_timestamp'] = $dbw->timestamp( $this->mAttribs
['rc_timestamp'] );
323 $this->mAttribs
['rc_id'] = $dbw->nextSequenceValue( 'recentchanges_rc_id_seq' );
325 # # If we are using foreign keys, an entry of 0 for the page_id will fail, so use NULL
326 if ( $this->mAttribs
['rc_cur_id'] == 0 ) {
327 unset( $this->mAttribs
['rc_cur_id'] );
330 # Convert mAttribs['rc_comment'] for CommentStore
331 $row = $this->mAttribs
;
332 $comment = $row['rc_comment'];
333 unset( $row['rc_comment'], $row['rc_comment_text'], $row['rc_comment_data'] );
334 $row +
= CommentStore
::newKey( 'rc_comment' )->insert( $dbw, $comment );
337 $dbw->insert( 'recentchanges', $row, __METHOD__
);
340 $this->mAttribs
['rc_id'] = $dbw->insertId();
343 // Avoid PHP 7.1 warning from passing $this by reference
345 Hooks
::run( 'RecentChange_save', [ &$rc ] );
347 if ( count( $this->tags
) ) {
348 ChangeTags
::addTags( $this->tags
, $this->mAttribs
['rc_id'],
349 $this->mAttribs
['rc_this_oldid'], $this->mAttribs
['rc_logid'], null, $this );
352 # Notify external application via UDP
354 $this->notifyRCFeeds();
357 # E-mail notifications
358 if ( $wgUseEnotif ||
$wgShowUpdatedMarker ) {
359 $editor = $this->getPerformer();
360 $title = $this->getTitle();
362 // Never send an RC notification email about categorization changes
364 $this->mAttribs
['rc_type'] != RC_CATEGORIZE
&&
365 Hooks
::run( 'AbortEmailNotification', [ $editor, $title, $this ] )
367 // @FIXME: This would be better as an extension hook
368 // Send emails or email jobs once this row is safely committed
369 $dbw->onTransactionIdle(
370 function () use ( $editor, $title ) {
371 $enotif = new EmailNotification();
372 $enotif->notifyOnPageChange(
375 $this->mAttribs
['rc_timestamp'],
376 $this->mAttribs
['rc_comment'],
377 $this->mAttribs
['rc_minor'],
378 $this->mAttribs
['rc_last_oldid'],
379 $this->mExtra
['pageStatus']
387 // Update the cached list of active users
388 if ( $this->mAttribs
['rc_user'] > 0 ) {
389 JobQueueGroup
::singleton()->lazyPush( RecentChangesUpdateJob
::newCacheUpdateJob() );
394 * Notify all the feeds about the change.
395 * @param array $feeds Optional feeds to send to, defaults to $wgRCFeeds
397 public function notifyRCFeeds( array $feeds = null ) {
399 if ( $feeds === null ) {
403 $performer = $this->getPerformer();
405 foreach ( $feeds as $params ) {
407 'omit_bots' => false,
408 'omit_anon' => false,
409 'omit_user' => false,
410 'omit_minor' => false,
411 'omit_patrolled' => false,
415 ( $params['omit_bots'] && $this->mAttribs
['rc_bot'] ) ||
416 ( $params['omit_anon'] && $performer->isAnon() ) ||
417 ( $params['omit_user'] && !$performer->isAnon() ) ||
418 ( $params['omit_minor'] && $this->mAttribs
['rc_minor'] ) ||
419 ( $params['omit_patrolled'] && $this->mAttribs
['rc_patrolled'] ) ||
420 $this->mAttribs
['rc_type'] == RC_EXTERNAL
425 if ( isset( $this->mExtra
['actionCommentIRC'] ) ) {
426 $actionComment = $this->mExtra
['actionCommentIRC'];
428 $actionComment = null;
431 $feed = RCFeed
::factory( $params );
432 $feed->notify( $this, $actionComment );
438 * @deprecated since 1.29 Use RCFeed::factory() instead
439 * @param string $uri URI to get the engine object for
440 * @param array $params
441 * @return RCFeedEngine The engine object
442 * @throws MWException
444 public static function getEngine( $uri, $params = [] ) {
445 // TODO: Merge into RCFeed::factory().
447 $scheme = parse_url( $uri, PHP_URL_SCHEME
);
449 throw new MWException( "Invalid RCFeed uri: '$uri'" );
451 if ( !isset( $wgRCEngines[$scheme] ) ) {
452 throw new MWException( "Unknown RCFeedEngine scheme: '$scheme'" );
454 if ( defined( 'MW_PHPUNIT_TEST' ) && is_object( $wgRCEngines[$scheme] ) ) {
455 return $wgRCEngines[$scheme];
457 return new $wgRCEngines[$scheme]( $params );
461 * Mark a given change as patrolled
463 * @param RecentChange|int $change RecentChange or corresponding rc_id
464 * @param bool $auto For automatic patrol
465 * @param string|string[] $tags Change tags to add to the patrol log entry
466 * ($user should be able to add the specified tags before this is called)
467 * @return array See doMarkPatrolled(), or null if $change is not an existing rc_id
469 public static function markPatrolled( $change, $auto = false, $tags = null ) {
472 $change = $change instanceof RecentChange
474 : self
::newFromId( $change );
476 if ( !$change instanceof RecentChange
) {
480 return $change->doMarkPatrolled( $wgUser, $auto, $tags );
484 * Mark this RecentChange as patrolled
486 * NOTE: Can also return 'rcpatroldisabled', 'hookaborted' and
487 * 'markedaspatrollederror-noautopatrol' as errors
488 * @param User $user User object doing the action
489 * @param bool $auto For automatic patrol
490 * @param string|string[] $tags Change tags to add to the patrol log entry
491 * ($user should be able to add the specified tags before this is called)
492 * @return array Array of permissions errors, see Title::getUserPermissionsErrors()
494 public function doMarkPatrolled( User
$user, $auto = false, $tags = null ) {
495 global $wgUseRCPatrol, $wgUseNPPatrol, $wgUseFilePatrol;
498 // If recentchanges patrol is disabled, only new pages or new file versions
499 // can be patrolled, provided the appropriate config variable is set
500 if ( !$wgUseRCPatrol && ( !$wgUseNPPatrol ||
$this->getAttribute( 'rc_type' ) != RC_NEW
) &&
501 ( !$wgUseFilePatrol ||
!( $this->getAttribute( 'rc_type' ) == RC_LOG
&&
502 $this->getAttribute( 'rc_log_type' ) == 'upload' ) ) ) {
503 $errors[] = [ 'rcpatroldisabled' ];
505 // Automatic patrol needs "autopatrol", ordinary patrol needs "patrol"
506 $right = $auto ?
'autopatrol' : 'patrol';
507 $errors = array_merge( $errors, $this->getTitle()->getUserPermissionsErrors( $right, $user ) );
508 if ( !Hooks
::run( 'MarkPatrolled',
509 [ $this->getAttribute( 'rc_id' ), &$user, false, $auto ] )
511 $errors[] = [ 'hookaborted' ];
513 // Users without the 'autopatrol' right can't patrol their
515 if ( $user->getName() === $this->getAttribute( 'rc_user_text' )
516 && !$user->isAllowed( 'autopatrol' )
518 $errors[] = [ 'markedaspatrollederror-noautopatrol' ];
523 // If the change was patrolled already, do nothing
524 if ( $this->getAttribute( 'rc_patrolled' ) ) {
527 // Actually set the 'patrolled' flag in RC
528 $this->reallyMarkPatrolled();
529 // Log this patrol event
530 PatrolLog
::record( $this, $auto, $user, $tags );
533 'MarkPatrolledComplete',
534 [ $this->getAttribute( 'rc_id' ), &$user, false, $auto ]
541 * Mark this RecentChange patrolled, without error checking
542 * @return int Number of affected rows
544 public function reallyMarkPatrolled() {
545 $dbw = wfGetDB( DB_MASTER
);
552 'rc_id' => $this->getAttribute( 'rc_id' )
556 // Invalidate the page cache after the page has been patrolled
557 // to make sure that the Patrol link isn't visible any longer!
558 $this->getTitle()->invalidateCache();
560 return $dbw->affectedRows();
564 * Makes an entry in the database corresponding to an edit
566 * @param string $timestamp
567 * @param Title &$title
570 * @param string $comment
572 * @param string $lastTimestamp
575 * @param int $oldSize
576 * @param int $newSize
580 * @return RecentChange
582 public static function notifyEdit(
583 $timestamp, &$title, $minor, &$user, $comment, $oldId, $lastTimestamp,
584 $bot, $ip = '', $oldSize = 0, $newSize = 0, $newId = 0, $patrol = 0,
587 $rc = new RecentChange
;
588 $rc->mTitle
= $title;
589 $rc->mPerformer
= $user;
591 'rc_timestamp' => $timestamp,
592 'rc_namespace' => $title->getNamespace(),
593 'rc_title' => $title->getDBkey(),
594 'rc_type' => RC_EDIT
,
595 'rc_source' => self
::SRC_EDIT
,
596 'rc_minor' => $minor ?
1 : 0,
597 'rc_cur_id' => $title->getArticleID(),
598 'rc_user' => $user->getId(),
599 'rc_user_text' => $user->getName(),
600 'rc_comment' => &$comment,
601 'rc_comment_text' => &$comment,
602 'rc_comment_data' => null,
603 'rc_this_oldid' => $newId,
604 'rc_last_oldid' => $oldId,
605 'rc_bot' => $bot ?
1 : 0,
606 'rc_ip' => self
::checkIPAddress( $ip ),
607 'rc_patrolled' => intval( $patrol ),
608 'rc_new' => 0, # obsolete
609 'rc_old_len' => $oldSize,
610 'rc_new_len' => $newSize,
613 'rc_log_type' => null,
614 'rc_log_action' => '',
619 'prefixedDBkey' => $title->getPrefixedDBkey(),
620 'lastTimestamp' => $lastTimestamp,
621 'oldSize' => $oldSize,
622 'newSize' => $newSize,
623 'pageStatus' => 'changed'
626 DeferredUpdates
::addCallableUpdate(
627 function () use ( $rc, $tags ) {
628 $rc->addTags( $tags );
630 if ( $rc->mAttribs
['rc_patrolled'] ) {
631 PatrolLog
::record( $rc, true, $rc->getPerformer() );
634 DeferredUpdates
::POSTSEND
,
642 * Makes an entry in the database corresponding to page creation
643 * Note: the title object must be loaded with the new id using resetArticleID()
645 * @param string $timestamp
646 * @param Title &$title
649 * @param string $comment
656 * @return RecentChange
658 public static function notifyNew(
659 $timestamp, &$title, $minor, &$user, $comment, $bot,
660 $ip = '', $size = 0, $newId = 0, $patrol = 0, $tags = []
662 $rc = new RecentChange
;
663 $rc->mTitle
= $title;
664 $rc->mPerformer
= $user;
666 'rc_timestamp' => $timestamp,
667 'rc_namespace' => $title->getNamespace(),
668 'rc_title' => $title->getDBkey(),
670 'rc_source' => self
::SRC_NEW
,
671 'rc_minor' => $minor ?
1 : 0,
672 'rc_cur_id' => $title->getArticleID(),
673 'rc_user' => $user->getId(),
674 'rc_user_text' => $user->getName(),
675 'rc_comment' => &$comment,
676 'rc_comment_text' => &$comment,
677 'rc_comment_data' => null,
678 'rc_this_oldid' => $newId,
679 'rc_last_oldid' => 0,
680 'rc_bot' => $bot ?
1 : 0,
681 'rc_ip' => self
::checkIPAddress( $ip ),
682 'rc_patrolled' => intval( $patrol ),
683 'rc_new' => 1, # obsolete
685 'rc_new_len' => $size,
688 'rc_log_type' => null,
689 'rc_log_action' => '',
694 'prefixedDBkey' => $title->getPrefixedDBkey(),
695 'lastTimestamp' => 0,
698 'pageStatus' => 'created'
701 DeferredUpdates
::addCallableUpdate(
702 function () use ( $rc, $tags ) {
703 $rc->addTags( $tags );
705 if ( $rc->mAttribs
['rc_patrolled'] ) {
706 PatrolLog
::record( $rc, true, $rc->getPerformer() );
709 DeferredUpdates
::POSTSEND
,
717 * @param string $timestamp
718 * @param Title &$title
720 * @param string $actionComment
722 * @param string $type
723 * @param string $action
724 * @param Title $target
725 * @param string $logComment
726 * @param string $params
728 * @param string $actionCommentIRC
731 public static function notifyLog( $timestamp, &$title, &$user, $actionComment, $ip, $type,
732 $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = ''
734 global $wgLogRestrictions;
736 # Don't add private logs to RC!
737 if ( isset( $wgLogRestrictions[$type] ) && $wgLogRestrictions[$type] != '*' ) {
740 $rc = self
::newLogEntry( $timestamp, $title, $user, $actionComment, $ip, $type, $action,
741 $target, $logComment, $params, $newId, $actionCommentIRC );
748 * @param string $timestamp
749 * @param Title &$title
751 * @param string $actionComment
753 * @param string $type
754 * @param string $action
755 * @param Title $target
756 * @param string $logComment
757 * @param string $params
759 * @param string $actionCommentIRC
760 * @param int $revId Id of associated revision, if any
761 * @param bool $isPatrollable Whether this log entry is patrollable
762 * @return RecentChange
764 public static function newLogEntry( $timestamp, &$title, &$user, $actionComment, $ip,
765 $type, $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = '',
766 $revId = 0, $isPatrollable = false ) {
769 # # Get pageStatus for email notification
770 switch ( $type . '-' . $action ) {
771 case 'delete-delete':
772 case 'delete-delete_redir':
773 $pageStatus = 'deleted';
776 case 'move-move_redir':
777 $pageStatus = 'moved';
779 case 'delete-restore':
780 $pageStatus = 'restored';
782 case 'upload-upload':
783 $pageStatus = 'created';
785 case 'upload-overwrite':
787 $pageStatus = 'changed';
791 // Allow unpatrolled status for patrollable log entries
792 $markPatrolled = $isPatrollable ?
$user->isAllowed( 'autopatrol' ) : true;
794 $rc = new RecentChange
;
795 $rc->mTitle
= $target;
796 $rc->mPerformer
= $user;
798 'rc_timestamp' => $timestamp,
799 'rc_namespace' => $target->getNamespace(),
800 'rc_title' => $target->getDBkey(),
802 'rc_source' => self
::SRC_LOG
,
804 'rc_cur_id' => $target->getArticleID(),
805 'rc_user' => $user->getId(),
806 'rc_user_text' => $user->getName(),
807 'rc_comment' => &$logComment,
808 'rc_comment_text' => &$logComment,
809 'rc_comment_data' => null,
810 'rc_this_oldid' => $revId,
811 'rc_last_oldid' => 0,
812 'rc_bot' => $user->isAllowed( 'bot' ) ?
(int)$wgRequest->getBool( 'bot', true ) : 0,
813 'rc_ip' => self
::checkIPAddress( $ip ),
814 'rc_patrolled' => $markPatrolled ?
1 : 0,
815 'rc_new' => 0, # obsolete
816 'rc_old_len' => null,
817 'rc_new_len' => null,
819 'rc_logid' => $newId,
820 'rc_log_type' => $type,
821 'rc_log_action' => $action,
822 'rc_params' => $params
826 'prefixedDBkey' => $title->getPrefixedDBkey(),
827 'lastTimestamp' => 0,
828 'actionComment' => $actionComment, // the comment appended to the action, passed from LogPage
829 'pageStatus' => $pageStatus,
830 'actionCommentIRC' => $actionCommentIRC
837 * Constructs a RecentChange object for the given categorization
838 * This does not call save() on the object and thus does not write to the db
842 * @param string $timestamp Timestamp of the recent change to occur
843 * @param Title $categoryTitle Title of the category a page is being added to or removed from
844 * @param User $user User object of the user that made the change
845 * @param string $comment Change summary
846 * @param Title $pageTitle Title of the page that is being added or removed
847 * @param int $oldRevId Parent revision ID of this change
848 * @param int $newRevId Revision ID of this change
849 * @param string $lastTimestamp Parent revision timestamp of this change
850 * @param bool $bot true, if the change was made by a bot
851 * @param string $ip IP address of the user, if the change was made anonymously
852 * @param int $deleted Indicates whether the change has been deleted
854 * @return RecentChange
856 public static function newForCategorization(
858 Title
$categoryTitle,
869 $rc = new RecentChange
;
870 $rc->mTitle
= $categoryTitle;
871 $rc->mPerformer
= $user;
873 'rc_timestamp' => $timestamp,
874 'rc_namespace' => $categoryTitle->getNamespace(),
875 'rc_title' => $categoryTitle->getDBkey(),
876 'rc_type' => RC_CATEGORIZE
,
877 'rc_source' => self
::SRC_CATEGORIZE
,
879 'rc_cur_id' => $pageTitle->getArticleID(),
880 'rc_user' => $user ?
$user->getId() : 0,
881 'rc_user_text' => $user ?
$user->getName() : '',
882 'rc_comment' => &$comment,
883 'rc_comment_text' => &$comment,
884 'rc_comment_data' => null,
885 'rc_this_oldid' => $newRevId,
886 'rc_last_oldid' => $oldRevId,
887 'rc_bot' => $bot ?
1 : 0,
888 'rc_ip' => self
::checkIPAddress( $ip ),
889 'rc_patrolled' => 1, // Always patrolled, just like log entries
890 'rc_new' => 0, # obsolete
891 'rc_old_len' => null,
892 'rc_new_len' => null,
893 'rc_deleted' => $deleted,
895 'rc_log_type' => null,
896 'rc_log_action' => '',
897 'rc_params' => serialize( [
898 'hidden-cat' => WikiCategoryPage
::factory( $categoryTitle )->isHidden()
903 'prefixedDBkey' => $categoryTitle->getPrefixedDBkey(),
904 'lastTimestamp' => $lastTimestamp,
907 'pageStatus' => 'changed'
914 * Get a parameter value
918 * @param string $name parameter name
921 public function getParam( $name ) {
922 $params = $this->parseParams();
923 return isset( $params[$name] ) ?
$params[$name] : null;
927 * Initialises the members of this object from a mysql row object
931 public function loadFromRow( $row ) {
932 $this->mAttribs
= get_object_vars( $row );
933 $this->mAttribs
['rc_timestamp'] = wfTimestamp( TS_MW
, $this->mAttribs
['rc_timestamp'] );
934 // rc_deleted MUST be set
935 $this->mAttribs
['rc_deleted'] = $row->rc_deleted
;
937 if ( isset( $this->mAttribs
['rc_ip'] ) ) {
938 // Clean up CIDRs for Postgres per T164898. ("127.0.0.1" casts to "127.0.0.1/32")
939 $n = strpos( $this->mAttribs
['rc_ip'], '/' );
940 if ( $n !== false ) {
941 $this->mAttribs
['rc_ip'] = substr( $this->mAttribs
['rc_ip'], 0, $n );
945 $comment = CommentStore
::newKey( 'rc_comment' )
946 // Legacy because $row probably came from self::selectFields()
947 ->getCommentLegacy( wfGetDB( DB_REPLICA
), $row, true )->text
;
948 $this->mAttribs
['rc_comment'] = &$comment;
949 $this->mAttribs
['rc_comment_text'] = &$comment;
950 $this->mAttribs
['rc_comment_data'] = null;
954 * Get an attribute value
956 * @param string $name Attribute name
959 public function getAttribute( $name ) {
960 if ( $name === 'rc_comment' ) {
961 return CommentStore
::newKey( 'rc_comment' )->getComment( $this->mAttribs
, true )->text
;
963 return isset( $this->mAttribs
[$name] ) ?
$this->mAttribs
[$name] : null;
969 public function getAttributes() {
970 return $this->mAttribs
;
974 * Gets the end part of the diff URL associated with this object
975 * Blank if no diff link should be displayed
976 * @param bool $forceCur
979 public function diffLinkTrail( $forceCur ) {
980 if ( $this->mAttribs
['rc_type'] == RC_EDIT
) {
981 $trail = "curid=" . (int)( $this->mAttribs
['rc_cur_id'] ) .
982 "&oldid=" . (int)( $this->mAttribs
['rc_last_oldid'] );
986 $trail .= '&diff=' . (int)( $this->mAttribs
['rc_this_oldid'] );
996 * Returns the change size (HTML).
997 * The lengths can be given optionally.
1002 public function getCharacterDifference( $old = 0, $new = 0 ) {
1004 $old = $this->mAttribs
['rc_old_len'];
1007 $new = $this->mAttribs
['rc_new_len'];
1009 if ( $old === null ||
$new === null ) {
1013 return ChangesList
::showCharacterDifference( $old, $new );
1016 private static function checkIPAddress( $ip ) {
1019 if ( !IP
::isIPAddress( $ip ) ) {
1020 throw new MWException( "Attempt to write \"" . $ip .
1021 "\" as an IP address into recent changes" );
1024 $ip = $wgRequest->getIP();
1034 * Check whether the given timestamp is new enough to have a RC row with a given tolerance
1035 * as the recentchanges table might not be cleared out regularly (so older entries might exist)
1036 * or rows which will be deleted soon shouldn't be included.
1038 * @param mixed $timestamp MWTimestamp compatible timestamp
1039 * @param int $tolerance Tolerance in seconds
1042 public static function isInRCLifespan( $timestamp, $tolerance = 0 ) {
1045 return wfTimestamp( TS_UNIX
, $timestamp ) > time() - $tolerance - $wgRCMaxAge;
1049 * Parses and returns the rc_params attribute
1053 * @return mixed|bool false on failed unserialization
1055 public function parseParams() {
1056 $rcParams = $this->getAttribute( 'rc_params' );
1058 MediaWiki\
suppressWarnings();
1059 $unserializedParams = unserialize( $rcParams );
1060 MediaWiki\restoreWarnings
();
1062 return $unserializedParams;
1066 * Tags to append to the recent change,
1067 * and associated revision/log
1071 * @param string|array $tags
1073 public function addTags( $tags ) {
1074 if ( is_string( $tags ) ) {
1075 $this->tags
[] = $tags;
1077 $this->tags
= array_merge( $tags, $this->tags
);