1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
|
<?php
/**
* Utility class for creating and accessing recent change entries.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\ChangeTags\Taggable;
use MediaWiki\MediaWikiServices;
use Wikimedia\IPUtils;
/**
* Utility class for creating new RC entries
*
* mAttribs:
* rc_id id of the row in the recentchanges table
* rc_timestamp time the entry was made
* rc_namespace namespace #
* rc_title non-prefixed db key
* rc_type is new entry, used to determine whether updating is necessary
* rc_source string representation of change source
* rc_minor is minor
* rc_cur_id page_id of associated page entry
* rc_user user id who made the entry
* rc_user_text user name who made the entry
* rc_actor actor id who made the entry
* rc_comment edit summary
* rc_this_oldid rev_id associated with this entry (or zero)
* rc_last_oldid rev_id associated with the entry before this one (or zero)
* rc_bot is bot, hidden
* rc_ip IP address of the user in dotted quad notation
* rc_new obsolete, use rc_type==RC_NEW
* rc_patrolled boolean whether or not someone has marked this edit as patrolled
* rc_old_len integer byte length of the text before the edit
* rc_new_len the same after the edit
* rc_deleted partial deletion
* rc_logid the log_id value for this log entry (or zero)
* rc_log_type the log type (or null)
* rc_log_action the log action (or null)
* rc_params log params
*
* mExtra:
* prefixedDBkey prefixed db key, used by external app via msg queue
* lastTimestamp timestamp of previous entry, used in WHERE clause during update
* oldSize text size before the change
* newSize text size after the change
* pageStatus status of the page: created, deleted, moved, restored, changed
*
* temporary: not stored in the database
* notificationtimestamp
* numberofWatchingusers
* watchlistExpiry for temporary watchlist items
*
* @todo Deprecate access to mAttribs (direct or via getAttributes). Right now
* we're having to include both rc_comment and rc_comment_text/rc_comment_data
* so random crap works right.
*/
class RecentChange implements Taggable {
// Constants for the rc_source field. Extensions may also have
// their own source constants.
public const SRC_EDIT = 'mw.edit';
public const SRC_NEW = 'mw.new';
public const SRC_LOG = 'mw.log';
public const SRC_EXTERNAL = 'mw.external'; // obsolete
public const SRC_CATEGORIZE = 'mw.categorize';
public const PRC_UNPATROLLED = 0;
public const PRC_PATROLLED = 1;
public const PRC_AUTOPATROLLED = 2;
/**
* @var bool For save() - save to the database only, without any events.
*/
public const SEND_NONE = true;
/**
* @var bool For save() - do emit the change to RCFeeds (usually public).
*/
public const SEND_FEED = false;
/** @var array */
public $mAttribs = [];
public $mExtra = [];
/**
* @var Title|false
*/
public $mTitle = false;
/**
* @var User|false
*/
private $mPerformer = false;
public $numberofWatchingusers = 0; # Dummy to prevent error message in SpecialRecentChangesLinked
public $notificationtimestamp;
/**
* @var string|null The expiry time, if this is a temporary watchlist item.
*/
public $watchlistExpiry;
/**
* @var int Line number of recent change. Default -1.
*/
public $counter = -1;
/**
* @var array List of tags to apply
*/
private $tags = [];
/**
* @var array Array of change types
*/
private const CHANGE_TYPES = [
'edit' => RC_EDIT,
'new' => RC_NEW,
'log' => RC_LOG,
'external' => RC_EXTERNAL,
'categorize' => RC_CATEGORIZE,
];
# Factory methods
/**
* @param mixed $row
* @return RecentChange
*/
public static function newFromRow( $row ) {
$rc = new RecentChange;
$rc->loadFromRow( $row );
return $rc;
}
/**
* Parsing text to RC_* constants
* @since 1.24
* @param string|array $type
* @throws MWException
* @return int|array RC_TYPE
*/
public static function parseToRCType( $type ) {
if ( is_array( $type ) ) {
$retval = [];
foreach ( $type as $t ) {
$retval[] = self::parseToRCType( $t );
}
return $retval;
}
if ( !array_key_exists( $type, self::CHANGE_TYPES ) ) {
throw new MWException( "Unknown type '$type'" );
}
return self::CHANGE_TYPES[$type];
}
/**
* Parsing RC_* constants to human-readable test
* @since 1.24
* @param int $rcType
* @return string $type
*/
public static function parseFromRCType( $rcType ) {
return array_search( $rcType, self::CHANGE_TYPES, true ) ?: "$rcType";
}
/**
* Get an array of all change types
*
* @since 1.26
*
* @return array
*/
public static function getChangeTypes() {
return array_keys( self::CHANGE_TYPES );
}
/**
* Obtain the recent change with a given rc_id value
*
* @param int $rcid The rc_id value to retrieve
* @return RecentChange|null
*/
public static function newFromId( $rcid ) {
return self::newFromConds( [ 'rc_id' => $rcid ], __METHOD__ );
}
/**
* Find the first recent change matching some specific conditions
*
* @param array $conds Array of conditions
* @param mixed $fname Override the method name in profiling/logs
* @param int $dbType DB_* constant
*
* @return RecentChange|null
*/
public static function newFromConds(
$conds,
$fname = __METHOD__,
$dbType = DB_REPLICA
) {
$db = wfGetDB( $dbType );
$rcQuery = self::getQueryInfo();
$row = $db->selectRow(
$rcQuery['tables'], $rcQuery['fields'], $conds, $fname, [], $rcQuery['joins']
);
if ( $row !== false ) {
return self::newFromRow( $row );
} else {
return null;
}
}
/**
* Return the tables, fields, and join conditions to be selected to create
* a new recentchanges object.
* @since 1.31
* @return array With three keys:
* - tables: (string[]) to include in the `$table` to `IDatabase->select()`
* - fields: (string[]) to include in the `$vars` to `IDatabase->select()`
* - joins: (array) to include in the `$join_conds` to `IDatabase->select()`
*/
public static function getQueryInfo() {
$commentQuery = CommentStore::getStore()->getJoin( 'rc_comment' );
$actorQuery = ActorMigration::newMigration()->getJoin( 'rc_user' );
return [
'tables' => [ 'recentchanges' ] + $commentQuery['tables'] + $actorQuery['tables'],
'fields' => [
'rc_id',
'rc_timestamp',
'rc_namespace',
'rc_title',
'rc_minor',
'rc_bot',
'rc_new',
'rc_cur_id',
'rc_this_oldid',
'rc_last_oldid',
'rc_type',
'rc_source',
'rc_patrolled',
'rc_ip',
'rc_old_len',
'rc_new_len',
'rc_deleted',
'rc_logid',
'rc_log_type',
'rc_log_action',
'rc_params',
] + $commentQuery['fields'] + $actorQuery['fields'],
'joins' => $commentQuery['joins'] + $actorQuery['joins'],
];
}
# Accessors
/**
* @param array $attribs
*/
public function setAttribs( $attribs ) {
$this->mAttribs = $attribs;
}
/**
* @param array $extra
*/
public function setExtra( $extra ) {
$this->mExtra = $extra;
}
/**
* @return Title
*/
public function &getTitle() {
if ( $this->mTitle === false ) {
$this->mTitle = Title::makeTitle( $this->mAttribs['rc_namespace'], $this->mAttribs['rc_title'] );
}
return $this->mTitle;
}
/**
* Get the User object of the person who performed this change.
*
* @return User
*/
public function getPerformer() {
if ( $this->mPerformer === false ) {
if ( !empty( $this->mAttribs['rc_actor'] ) ) {
$this->mPerformer = User::newFromActorId( $this->mAttribs['rc_actor'] );
} elseif ( !empty( $this->mAttribs['rc_user'] ) ) {
$this->mPerformer = User::newFromId( $this->mAttribs['rc_user'] );
} elseif ( !empty( $this->mAttribs['rc_user_text'] ) ) {
$this->mPerformer = User::newFromName( $this->mAttribs['rc_user_text'], false );
} else {
throw new MWException( 'RecentChange object lacks rc_actor, rc_user, and rc_user_text' );
}
}
return $this->mPerformer;
}
/**
* Writes the data in this object to the database
*
* For compatibility reasons, the SEND_ constants internally reference a value
* that may seem negated from their purpose (none=true, feed=false). This is
* because the parameter used to be called "$noudp", defaulting to false.
*
* @param bool $send self::SEND_FEED or self::SEND_NONE
*/
public function save( $send = self::SEND_FEED ) {
global $wgPutIPinRC, $wgUseEnotif, $wgShowUpdatedMarker;
$dbw = wfGetDB( DB_MASTER );
if ( !is_array( $this->mExtra ) ) {
$this->mExtra = [];
}
if ( !$wgPutIPinRC ) {
$this->mAttribs['rc_ip'] = '';
}
# Strict mode fixups (not-NULL fields)
foreach ( [ 'minor', 'bot', 'new', 'patrolled', 'deleted' ] as $field ) {
$this->mAttribs["rc_$field"] = (int)$this->mAttribs["rc_$field"];
}
# ...more fixups (NULL fields)
foreach ( [ 'old_len', 'new_len' ] as $field ) {
$this->mAttribs["rc_$field"] = isset( $this->mAttribs["rc_$field"] )
? (int)$this->mAttribs["rc_$field"]
: null;
}
# If our database is strict about IP addresses, use NULL instead of an empty string
$strictIPs = $dbw->getType() === 'postgres'; // legacy
if ( $strictIPs && $this->mAttribs['rc_ip'] == '' ) {
unset( $this->mAttribs['rc_ip'] );
}
# Trim spaces on user supplied text
$this->mAttribs['rc_comment'] = trim( $this->mAttribs['rc_comment'] );
# Fixup database timestamps
$this->mAttribs['rc_timestamp'] = $dbw->timestamp( $this->mAttribs['rc_timestamp'] );
# # If we are using foreign keys, an entry of 0 for the page_id will fail, so use NULL
if ( $this->mAttribs['rc_cur_id'] == 0 ) {
unset( $this->mAttribs['rc_cur_id'] );
}
$row = $this->mAttribs;
# Convert mAttribs['rc_comment'] for CommentStore
$comment = $row['rc_comment'];
unset( $row['rc_comment'], $row['rc_comment_text'], $row['rc_comment_data'] );
$row += CommentStore::getStore()->insert( $dbw, 'rc_comment', $comment );
# Convert mAttribs['rc_user'] etc for ActorMigration
$user = User::newFromAnyId(
$row['rc_user'] ?? null,
$row['rc_user_text'] ?? null,
$row['rc_actor'] ?? null
);
unset( $row['rc_user'], $row['rc_user_text'], $row['rc_actor'] );
$row += ActorMigration::newMigration()->getInsertValues( $dbw, 'rc_user', $user );
# Don't reuse an existing rc_id for the new row, if one happens to be
# set for some reason.
unset( $row['rc_id'] );
# Insert new row
$dbw->insert( 'recentchanges', $row, __METHOD__ );
# Set the ID
$this->mAttribs['rc_id'] = $dbw->insertId();
# Notify extensions
Hooks::runner()->onRecentChange_save( $this );
if ( count( $this->tags ) ) {
ChangeTags::addTags( $this->tags, $this->mAttribs['rc_id'],
$this->mAttribs['rc_this_oldid'], $this->mAttribs['rc_logid'], null, $this );
}
if ( $send === self::SEND_FEED ) {
// Emit the change to external applications via RCFeeds.
$this->notifyRCFeeds();
}
# E-mail notifications
if ( $wgUseEnotif || $wgShowUpdatedMarker ) {
$editor = $this->getPerformer();
$title = $this->getTitle();
// Never send an RC notification email about categorization changes
if (
Hooks::runner()->onAbortEmailNotification( $editor, $title, $this ) &&
$this->mAttribs['rc_type'] != RC_CATEGORIZE
) {
// @FIXME: This would be better as an extension hook
// Send emails or email jobs once this row is safely committed
$dbw->onTransactionCommitOrIdle(
function () use ( $editor, $title ) {
$enotif = new EmailNotification();
$enotif->notifyOnPageChange(
$editor,
$title,
$this->mAttribs['rc_timestamp'],
$this->mAttribs['rc_comment'],
$this->mAttribs['rc_minor'],
$this->mAttribs['rc_last_oldid'],
$this->mExtra['pageStatus']
);
},
__METHOD__
);
}
}
// Update the cached list of active users
if ( $this->mAttribs['rc_user'] > 0 ) {
JobQueueGroup::singleton()->lazyPush( RecentChangesUpdateJob::newCacheUpdateJob() );
}
}
/**
* Notify all the feeds about the change.
* @param array|null $feeds Optional feeds to send to, defaults to $wgRCFeeds
*/
public function notifyRCFeeds( array $feeds = null ) {
global $wgRCFeeds;
if ( $feeds === null ) {
$feeds = $wgRCFeeds;
}
$performer = $this->getPerformer();
foreach ( $feeds as $params ) {
$params += [
'omit_bots' => false,
'omit_anon' => false,
'omit_user' => false,
'omit_minor' => false,
'omit_patrolled' => false,
];
if (
( $params['omit_bots'] && $this->mAttribs['rc_bot'] ) ||
( $params['omit_anon'] && $performer->isAnon() ) ||
( $params['omit_user'] && !$performer->isAnon() ) ||
( $params['omit_minor'] && $this->mAttribs['rc_minor'] ) ||
( $params['omit_patrolled'] && $this->mAttribs['rc_patrolled'] ) ||
$this->mAttribs['rc_type'] == RC_EXTERNAL
) {
continue;
}
$actionComment = $this->mExtra['actionCommentIRC'] ?? null;
$feed = RCFeed::factory( $params );
$feed->notify( $this, $actionComment );
}
}
/**
* @since 1.22
* @deprecated since 1.29 Use RCFeed::factory() instead
* @param string $uri URI to get the engine object for
* @param array $params
* @return RCFeedEngine The engine object
* @throws MWException
*/
public static function getEngine( $uri, $params = [] ) {
// TODO: Merge into RCFeed::factory().
global $wgRCEngines;
$scheme = parse_url( $uri, PHP_URL_SCHEME );
if ( !$scheme ) {
throw new MWException( "Invalid RCFeed uri: '$uri'" );
}
if ( !isset( $wgRCEngines[$scheme] ) ) {
throw new MWException( "Unknown RCFeedEngine scheme: '$scheme'" );
}
if ( defined( 'MW_PHPUNIT_TEST' ) && is_object( $wgRCEngines[$scheme] ) ) {
return $wgRCEngines[$scheme];
}
return new $wgRCEngines[$scheme]( $params );
}
/**
* Mark a given change as patrolled
*
* @deprecated since 1.35, use doMarkPatrolled directly
*
* @param RecentChange|int $change RecentChange or corresponding rc_id
* @param bool $auto For automatic patrol
* @param string|string[]|null $tags Change tags to add to the patrol log entry
* ($user should be able to add the specified tags before this is called)
* @return array[]|null See doMarkPatrolled(), or null if $change is not an existing rc_id
*/
public static function markPatrolled( $change, $auto = false, $tags = null ) {
wfDeprecated( __METHOD__, '1.35' );
global $wgUser;
$change = $change instanceof RecentChange
? $change
: self::newFromId( $change );
if ( !$change instanceof RecentChange ) {
return null;
}
return $change->doMarkPatrolled( $wgUser, $auto, $tags );
}
/**
* Mark this RecentChange as patrolled
*
* NOTE: Can also return 'rcpatroldisabled', 'hookaborted' and
* 'markedaspatrollederror-noautopatrol' as errors
* @param User $user User object doing the action
* @param bool $auto For automatic patrol
* @param string|string[]|null $tags Change tags to add to the patrol log entry
* ($user should be able to add the specified tags before this is called)
* @return array[] Array of permissions errors, see PermissionManager::getPermissionErrors()
*/
public function doMarkPatrolled( User $user, $auto = false, $tags = null ) {
global $wgUseRCPatrol, $wgUseNPPatrol, $wgUseFilePatrol;
$permManager = MediaWikiServices::getInstance()->getPermissionManager();
// Fix up $tags so that the MarkPatrolled hook below always gets an array
if ( $tags === null ) {
$tags = [];
} elseif ( is_string( $tags ) ) {
$tags = [ $tags ];
}
$errors = [];
// If recentchanges patrol is disabled, only new pages or new file versions
// can be patrolled, provided the appropriate config variable is set
if ( !$wgUseRCPatrol && ( !$wgUseNPPatrol || $this->getAttribute( 'rc_type' ) != RC_NEW ) &&
( !$wgUseFilePatrol || !( $this->getAttribute( 'rc_type' ) == RC_LOG &&
$this->getAttribute( 'rc_log_type' ) == 'upload' ) ) ) {
$errors[] = [ 'rcpatroldisabled' ];
}
// Automatic patrol needs "autopatrol", ordinary patrol needs "patrol"
$right = $auto ? 'autopatrol' : 'patrol';
$errors = array_merge(
$errors,
$permManager->getPermissionErrors( $right, $user, $this->getTitle() )
);
if ( !Hooks::runner()->onMarkPatrolled(
$this->getAttribute( 'rc_id' ), $user, false, $auto, $tags )
) {
$errors[] = [ 'hookaborted' ];
}
// Users without the 'autopatrol' right can't patrol their
// own revisions
if ( $user->getName() === $this->getAttribute( 'rc_user_text' ) &&
!$permManager->userHasRight( $user, 'autopatrol' )
) {
$errors[] = [ 'markedaspatrollederror-noautopatrol' ];
}
if ( $errors ) {
return $errors;
}
// If the change was patrolled already, do nothing
if ( $this->getAttribute( 'rc_patrolled' ) ) {
return [];
}
// Actually set the 'patrolled' flag in RC
$this->reallyMarkPatrolled();
// Log this patrol event
PatrolLog::record( $this, $auto, $user, $tags );
Hooks::runner()->onMarkPatrolledComplete(
$this->getAttribute( 'rc_id' ), $user, false, $auto );
return [];
}
/**
* Mark this RecentChange patrolled, without error checking
* @return int Number of affected rows
*/
public function reallyMarkPatrolled() {
$dbw = wfGetDB( DB_MASTER );
$dbw->update(
'recentchanges',
[
'rc_patrolled' => self::PRC_PATROLLED
],
[
'rc_id' => $this->getAttribute( 'rc_id' )
],
__METHOD__
);
// Invalidate the page cache after the page has been patrolled
// to make sure that the Patrol link isn't visible any longer!
$this->getTitle()->invalidateCache();
return $dbw->affectedRows();
}
/**
* Makes an entry in the database corresponding to an edit
*
* @param string $timestamp
* @param Title $title
* @param bool $minor
* @param User $user
* @param string $comment
* @param int $oldId
* @param string $lastTimestamp
* @param bool $bot
* @param string $ip
* @param int $oldSize
* @param int $newSize
* @param int $newId
* @param int $patrol
* @param array $tags
* @return RecentChange
*/
public static function notifyEdit(
$timestamp, $title, $minor, $user, $comment, $oldId, $lastTimestamp,
$bot, $ip = '', $oldSize = 0, $newSize = 0, $newId = 0, $patrol = 0,
$tags = []
) {
$rc = new RecentChange;
$rc->mTitle = $title;
$rc->mPerformer = $user;
$rc->mAttribs = [
'rc_timestamp' => $timestamp,
'rc_namespace' => $title->getNamespace(),
'rc_title' => $title->getDBkey(),
'rc_type' => RC_EDIT,
'rc_source' => self::SRC_EDIT,
'rc_minor' => $minor ? 1 : 0,
'rc_cur_id' => $title->getArticleID(),
'rc_user' => $user->getId(),
'rc_user_text' => $user->getName(),
'rc_actor' => $user->getActorId(),
'rc_comment' => &$comment,
'rc_comment_text' => &$comment,
'rc_comment_data' => null,
'rc_this_oldid' => $newId,
'rc_last_oldid' => $oldId,
'rc_bot' => $bot ? 1 : 0,
'rc_ip' => self::checkIPAddress( $ip ),
'rc_patrolled' => intval( $patrol ),
'rc_new' => 0, # obsolete
'rc_old_len' => $oldSize,
'rc_new_len' => $newSize,
'rc_deleted' => 0,
'rc_logid' => 0,
'rc_log_type' => null,
'rc_log_action' => '',
'rc_params' => ''
];
$rc->mExtra = [
'prefixedDBkey' => $title->getPrefixedDBkey(),
'lastTimestamp' => $lastTimestamp,
'oldSize' => $oldSize,
'newSize' => $newSize,
'pageStatus' => 'changed'
];
DeferredUpdates::addCallableUpdate(
function () use ( $rc, $tags ) {
$rc->addTags( $tags );
$rc->save();
},
DeferredUpdates::POSTSEND,
wfGetDB( DB_MASTER )
);
return $rc;
}
/**
* Makes an entry in the database corresponding to page creation
* Note: the title object must be loaded with the new id using resetArticleID()
*
* @param string $timestamp
* @param Title $title
* @param bool $minor
* @param User $user
* @param string $comment
* @param bool $bot
* @param string $ip
* @param int $size
* @param int $newId
* @param int $patrol
* @param array $tags
* @return RecentChange
*/
public static function notifyNew(
$timestamp, $title, $minor, $user, $comment, $bot,
$ip = '', $size = 0, $newId = 0, $patrol = 0, $tags = []
) {
$rc = new RecentChange;
$rc->mTitle = $title;
$rc->mPerformer = $user;
$rc->mAttribs = [
'rc_timestamp' => $timestamp,
'rc_namespace' => $title->getNamespace(),
'rc_title' => $title->getDBkey(),
'rc_type' => RC_NEW,
'rc_source' => self::SRC_NEW,
'rc_minor' => $minor ? 1 : 0,
'rc_cur_id' => $title->getArticleID(),
'rc_user' => $user->getId(),
'rc_user_text' => $user->getName(),
'rc_actor' => $user->getActorId(),
'rc_comment' => &$comment,
'rc_comment_text' => &$comment,
'rc_comment_data' => null,
'rc_this_oldid' => $newId,
'rc_last_oldid' => 0,
'rc_bot' => $bot ? 1 : 0,
'rc_ip' => self::checkIPAddress( $ip ),
'rc_patrolled' => intval( $patrol ),
'rc_new' => 1, # obsolete
'rc_old_len' => 0,
'rc_new_len' => $size,
'rc_deleted' => 0,
'rc_logid' => 0,
'rc_log_type' => null,
'rc_log_action' => '',
'rc_params' => ''
];
$rc->mExtra = [
'prefixedDBkey' => $title->getPrefixedDBkey(),
'lastTimestamp' => 0,
'oldSize' => 0,
'newSize' => $size,
'pageStatus' => 'created'
];
DeferredUpdates::addCallableUpdate(
function () use ( $rc, $tags ) {
$rc->addTags( $tags );
$rc->save();
},
DeferredUpdates::POSTSEND,
wfGetDB( DB_MASTER )
);
return $rc;
}
/**
* @param string $timestamp
* @param Title $title
* @param User $user
* @param string $actionComment
* @param string $ip
* @param string $type
* @param string $action
* @param Title $target
* @param string $logComment
* @param string $params
* @param int $newId
* @param string $actionCommentIRC
* @return bool
*/
public static function notifyLog( $timestamp, $title, $user, $actionComment, $ip, $type,
$action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = ''
) {
global $wgLogRestrictions;
# Don't add private logs to RC!
if ( isset( $wgLogRestrictions[$type] ) && $wgLogRestrictions[$type] != '*' ) {
return false;
}
$rc = self::newLogEntry( $timestamp, $title, $user, $actionComment, $ip, $type, $action,
$target, $logComment, $params, $newId, $actionCommentIRC );
$rc->save();
return true;
}
/**
* @param string $timestamp
* @param Title $title
* @param User $user
* @param string $actionComment
* @param string $ip
* @param string $type
* @param string $action
* @param Title $target
* @param string $logComment
* @param string $params
* @param int $newId
* @param string $actionCommentIRC
* @param int $revId Id of associated revision, if any
* @param bool $isPatrollable Whether this log entry is patrollable
* @return RecentChange
*/
public static function newLogEntry( $timestamp, $title, $user, $actionComment, $ip,
$type, $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = '',
$revId = 0, $isPatrollable = false ) {
global $wgRequest;
$permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
# # Get pageStatus for email notification
switch ( $type . '-' . $action ) {
case 'delete-delete':
case 'delete-delete_redir':
$pageStatus = 'deleted';
break;
case 'move-move':
case 'move-move_redir':
$pageStatus = 'moved';
break;
case 'delete-restore':
$pageStatus = 'restored';
break;
case 'upload-upload':
$pageStatus = 'created';
break;
case 'upload-overwrite':
default:
$pageStatus = 'changed';
break;
}
// Allow unpatrolled status for patrollable log entries
$canAutopatrol = $permissionManager->userHasRight( $user, 'autopatrol' );
$markPatrolled = $isPatrollable ? $canAutopatrol : true;
$rc = new RecentChange;
$rc->mTitle = $target;
$rc->mPerformer = $user;
$rc->mAttribs = [
'rc_timestamp' => $timestamp,
'rc_namespace' => $target->getNamespace(),
'rc_title' => $target->getDBkey(),
'rc_type' => RC_LOG,
'rc_source' => self::SRC_LOG,
'rc_minor' => 0,
'rc_cur_id' => $target->getArticleID(),
'rc_user' => $user->getId(),
'rc_user_text' => $user->getName(),
'rc_actor' => $user->getActorId(),
'rc_comment' => &$logComment,
'rc_comment_text' => &$logComment,
'rc_comment_data' => null,
'rc_this_oldid' => $revId,
'rc_last_oldid' => 0,
'rc_bot' => $permissionManager->userHasRight( $user, 'bot' ) ?
(int)$wgRequest->getBool( 'bot', true ) : 0,
'rc_ip' => self::checkIPAddress( $ip ),
'rc_patrolled' => $markPatrolled ? self::PRC_AUTOPATROLLED : self::PRC_UNPATROLLED,
'rc_new' => 0, # obsolete
'rc_old_len' => null,
'rc_new_len' => null,
'rc_deleted' => 0,
'rc_logid' => $newId,
'rc_log_type' => $type,
'rc_log_action' => $action,
'rc_params' => $params
];
$rc->mExtra = [
'prefixedDBkey' => $title->getPrefixedDBkey(),
'lastTimestamp' => 0,
'actionComment' => $actionComment, // the comment appended to the action, passed from LogPage
'pageStatus' => $pageStatus,
'actionCommentIRC' => $actionCommentIRC
];
return $rc;
}
/**
* Constructs a RecentChange object for the given categorization
* This does not call save() on the object and thus does not write to the db
*
* @since 1.27
*
* @param string $timestamp Timestamp of the recent change to occur
* @param Title $categoryTitle Title of the category a page is being added to or removed from
* @param User|null $user User object of the user that made the change
* @param string $comment Change summary
* @param Title $pageTitle Title of the page that is being added or removed
* @param int $oldRevId Parent revision ID of this change
* @param int $newRevId Revision ID of this change
* @param string $lastTimestamp Parent revision timestamp of this change
* @param bool $bot true, if the change was made by a bot
* @param string $ip IP address of the user, if the change was made anonymously
* @param int $deleted Indicates whether the change has been deleted
* @param bool|null $added true, if the category was added, false for removed
*
* @return RecentChange
*/
public static function newForCategorization(
$timestamp,
Title $categoryTitle,
?User $user,
$comment,
Title $pageTitle,
$oldRevId,
$newRevId,
$lastTimestamp,
$bot,
$ip = '',
$deleted = 0,
$added = null
) {
// Done in a backwards compatible way.
$params = [
'hidden-cat' => WikiCategoryPage::factory( $categoryTitle )->isHidden()
];
if ( $added !== null ) {
$params['added'] = $added;
}
$rc = new RecentChange;
$rc->mTitle = $categoryTitle;
$rc->mPerformer = $user;
$rc->mAttribs = [
'rc_timestamp' => $timestamp,
'rc_namespace' => $categoryTitle->getNamespace(),
'rc_title' => $categoryTitle->getDBkey(),
'rc_type' => RC_CATEGORIZE,
'rc_source' => self::SRC_CATEGORIZE,
'rc_minor' => 0,
'rc_cur_id' => $pageTitle->getArticleID(),
'rc_user' => $user ? $user->getId() : 0,
'rc_user_text' => $user ? $user->getName() : '',
'rc_actor' => $user ? $user->getActorId() : null,
'rc_comment' => &$comment,
'rc_comment_text' => &$comment,
'rc_comment_data' => null,
'rc_this_oldid' => $newRevId,
'rc_last_oldid' => $oldRevId,
'rc_bot' => $bot ? 1 : 0,
'rc_ip' => self::checkIPAddress( $ip ),
'rc_patrolled' => self::PRC_AUTOPATROLLED, // Always patrolled, just like log entries
'rc_new' => 0, # obsolete
'rc_old_len' => null,
'rc_new_len' => null,
'rc_deleted' => $deleted,
'rc_logid' => 0,
'rc_log_type' => null,
'rc_log_action' => '',
'rc_params' => serialize( $params )
];
$rc->mExtra = [
'prefixedDBkey' => $categoryTitle->getPrefixedDBkey(),
'lastTimestamp' => $lastTimestamp,
'oldSize' => 0,
'newSize' => 0,
'pageStatus' => 'changed'
];
return $rc;
}
/**
* Get a parameter value
*
* @since 1.27
*
* @param string $name parameter name
* @return mixed
*/
public function getParam( $name ) {
$params = $this->parseParams();
return $params[$name] ?? null;
}
/**
* Initialises the members of this object from a mysql row object
*
* @param mixed $row
*/
public function loadFromRow( $row ) {
$this->mAttribs = get_object_vars( $row );
$this->mAttribs['rc_timestamp'] = wfTimestamp( TS_MW, $this->mAttribs['rc_timestamp'] );
// rc_deleted MUST be set
$this->mAttribs['rc_deleted'] = $row->rc_deleted;
if ( isset( $this->mAttribs['rc_ip'] ) ) {
// Clean up CIDRs for Postgres per T164898. ("127.0.0.1" casts to "127.0.0.1/32")
$n = strpos( $this->mAttribs['rc_ip'], '/' );
if ( $n !== false ) {
$this->mAttribs['rc_ip'] = substr( $this->mAttribs['rc_ip'], 0, $n );
}
}
$comment = CommentStore::getStore()
// Legacy because $row may have come from self::selectFields()
->getCommentLegacy( wfGetDB( DB_REPLICA ), 'rc_comment', $row, true )
->text;
$this->mAttribs['rc_comment'] = &$comment;
$this->mAttribs['rc_comment_text'] = &$comment;
$this->mAttribs['rc_comment_data'] = null;
$user = User::newFromAnyId(
$this->mAttribs['rc_user'] ?? null,
$this->mAttribs['rc_user_text'] ?? null,
$this->mAttribs['rc_actor'] ?? null
);
$this->mAttribs['rc_user'] = $user->getId();
$this->mAttribs['rc_user_text'] = $user->getName();
$this->mAttribs['rc_actor'] = $user->getActorId();
// Watchlist expiry.
if ( isset( $row->we_expiry ) && $row->we_expiry ) {
$this->watchlistExpiry = wfTimestamp( TS_MW, $row->we_expiry );
}
}
/**
* Get an attribute value
*
* @param string $name Attribute name
* @return mixed
*/
public function getAttribute( $name ) {
if ( $name === 'rc_comment' ) {
return CommentStore::getStore()
->getComment( 'rc_comment', $this->mAttribs, true )->text;
}
if ( $name === 'rc_user' || $name === 'rc_user_text' || $name === 'rc_actor' ) {
$user = User::newFromAnyId(
$this->mAttribs['rc_user'] ?? null,
$this->mAttribs['rc_user_text'] ?? null,
$this->mAttribs['rc_actor'] ?? null
);
if ( $name === 'rc_user' ) {
return $user->getId();
}
if ( $name === 'rc_user_text' ) {
return $user->getName();
}
if ( $name === 'rc_actor' ) {
return $user->getActorId();
}
}
return $this->mAttribs[$name] ?? null;
}
/**
* @return array
*/
public function getAttributes() {
return $this->mAttribs;
}
/**
* Gets the end part of the diff URL associated with this object
* Blank if no diff link should be displayed
* @param bool $forceCur
* @return string
*/
public function diffLinkTrail( $forceCur ) {
if ( $this->mAttribs['rc_type'] == RC_EDIT ) {
$trail = "curid=" . (int)( $this->mAttribs['rc_cur_id'] ) .
"&oldid=" . (int)( $this->mAttribs['rc_last_oldid'] );
if ( $forceCur ) {
$trail .= '&diff=0';
} else {
$trail .= '&diff=' . (int)( $this->mAttribs['rc_this_oldid'] );
}
} else {
$trail = '';
}
return $trail;
}
/**
* Returns the change size (HTML).
* The lengths can be given optionally.
* @param int $old
* @param int $new
* @return string
*/
public function getCharacterDifference( $old = 0, $new = 0 ) {
if ( $old === 0 ) {
$old = $this->mAttribs['rc_old_len'];
}
if ( $new === 0 ) {
$new = $this->mAttribs['rc_new_len'];
}
if ( $old === null || $new === null ) {
return '';
}
return ChangesList::showCharacterDifference( $old, $new );
}
private static function checkIPAddress( $ip ) {
global $wgRequest;
if ( $ip ) {
if ( !IPUtils::isIPAddress( $ip ) ) {
throw new MWException( "Attempt to write \"" . $ip .
"\" as an IP address into recent changes" );
}
} else {
$ip = $wgRequest->getIP();
if ( !$ip ) {
$ip = '';
}
}
return $ip;
}
/**
* Check whether the given timestamp is new enough to have a RC row with a given tolerance
* as the recentchanges table might not be cleared out regularly (so older entries might exist)
* or rows which will be deleted soon shouldn't be included.
*
* @param mixed $timestamp MWTimestamp compatible timestamp
* @param int $tolerance Tolerance in seconds
* @return bool
*/
public static function isInRCLifespan( $timestamp, $tolerance = 0 ) {
global $wgRCMaxAge;
return wfTimestamp( TS_UNIX, $timestamp ) > time() - $tolerance - $wgRCMaxAge;
}
/**
* Parses and returns the rc_params attribute
*
* @since 1.26
*
* @return mixed|bool false on failed unserialization
*/
public function parseParams() {
$rcParams = $this->getAttribute( 'rc_params' );
Wikimedia\suppressWarnings();
$unserializedParams = unserialize( $rcParams );
Wikimedia\restoreWarnings();
return $unserializedParams;
}
/**
* Tags to append to the recent change,
* and associated revision/log
*
* @since 1.28
*
* @param string|string[] $tags
*/
public function addTags( $tags ) {
if ( is_string( $tags ) ) {
$this->tags[] = $tags;
} else {
$this->tags = array_merge( $tags, $this->tags );
}
}
}
|