459f8651ab
A distinct log action is provided for automatic patrols. The old 'auto' param is preserved so that old log entries can still be correctly identified in logs and API queries. With I6a61175f9a111c03d15b4d41751c818e3a411ff6, this enables us to filter new manual patrol entries in logs. Old automatic entries will be in the wrong list, but still marked as automatic. Bug: T27799 Change-Id: I05d962fa3ec45039122bb7e370b7e3fb8bbaa3c8
90 lines
2.6 KiB
PHP
90 lines
2.6 KiB
PHP
<?php
|
|
/**
|
|
* Specific methods for the patrol log.
|
|
*
|
|
* 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
|
|
* @author Rob Church <robchur@gmail.com>
|
|
* @author Niklas Laxström
|
|
*/
|
|
|
|
/**
|
|
* Class containing static functions for working with
|
|
* logs of patrol events
|
|
*/
|
|
class PatrolLog {
|
|
/**
|
|
* Record a log event for a change being patrolled
|
|
*
|
|
* @param int|RecentChange $rc Change identifier or RecentChange object
|
|
* @param bool $auto Was this patrol event automatic?
|
|
* @param User $user User performing the action or null to use $wgUser
|
|
* @param string|string[] $tags Change tags to add to the patrol log entry
|
|
* ($user should be able to add the specified tags before this is called)
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function record( $rc, $auto = false, User $user = null, $tags = null ) {
|
|
global $wgLogAutopatrol;
|
|
|
|
// do not log autopatrolled edits if setting disables it
|
|
if ( $auto && !$wgLogAutopatrol ) {
|
|
return false;
|
|
}
|
|
|
|
if ( !$rc instanceof RecentChange ) {
|
|
$rc = RecentChange::newFromId( $rc );
|
|
if ( !is_object( $rc ) ) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if ( !$user ) {
|
|
global $wgUser;
|
|
$user = $wgUser;
|
|
}
|
|
|
|
$action = $auto ? 'autopatrol' : 'patrol';
|
|
|
|
$entry = new ManualLogEntry( 'patrol', $action );
|
|
$entry->setTarget( $rc->getTitle() );
|
|
$entry->setParameters( self::buildParams( $rc, $auto ) );
|
|
$entry->setPerformer( $user );
|
|
$entry->setTags( $tags );
|
|
$logid = $entry->insert();
|
|
if ( !$auto ) {
|
|
$entry->publish( $logid, 'udp' );
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Prepare log parameters for a patrolled change
|
|
*
|
|
* @param RecentChange $change RecentChange to represent
|
|
* @param bool $auto Whether the patrol event was automatic
|
|
* @return array
|
|
*/
|
|
private static function buildParams( $change, $auto ) {
|
|
return [
|
|
'4::curid' => $change->getAttribute( 'rc_this_oldid' ),
|
|
'5::previd' => $change->getAttribute( 'rc_last_oldid' ),
|
|
'6::auto' => (int)$auto
|
|
];
|
|
}
|
|
}
|