includes/logging/PatrolLog.php

   1 <?php
   2 /**
   3  * Specific methods for the patrol log.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @author Rob Church <robchur@gmail.com>
  22  * @author Niklas Laxström
  23  */
  24
  25 /**
  26  * Class containing static functions for working with
  27  * logs of patrol events
  28  */
  29 class PatrolLog {
  30
  31         /**
  32          * Record a log event for a change being patrolled
  33          *
  34          * @param int|RecentChange $rc Change identifier or RecentChange object
  35          * @param bool $auto Was this patrol event automatic?
  36          * @param User|null $user User performing the action or null to use $wgUser
  37          * @param string|string[]|null $tags Change tags to add to the patrol log entry
  38          *   ($user should be able to add the specified tags before this is called)
  39          *
  40          * @return bool
  41          */
  42         public static function record( $rc, $auto = false, User $user = null, $tags = null ) {
  43                 // Do not log autopatrol actions: T184485
  44                 if ( $auto ) {
  45                         return false;
  46                 }
  47
  48                 if ( !$rc instanceof RecentChange ) {
  49                         $rc = RecentChange::newFromId( $rc );
  50                         if ( !is_object( $rc ) ) {
  51                                 return false;
  52                         }
  53                 }
  54
  55                 if ( !$user ) {
  56                         global $wgUser;
  57                         $user = $wgUser;
  58                 }
  59
  60                 $action = $auto ? 'autopatrol' : 'patrol';
  61
  62                 $entry = new ManualLogEntry( 'patrol', $action );
  63                 $entry->setTarget( $rc->getTitle() );
  64                 $entry->setParameters( self::buildParams( $rc, $auto ) );
  65                 $entry->setPerformer( $user );
  66                 $entry->addTags( $tags );
  67                 $logid = $entry->insert();
  68                 if ( !$auto ) {
  69                         $entry->publish( $logid, 'udp' );
  70                 }
  71
  72                 return true;
  73         }
  74
  75         /**
  76          * Prepare log parameters for a patrolled change
  77          *
  78          * @param RecentChange $change RecentChange to represent
  79          * @param bool $auto Whether the patrol event was automatic
  80          * @return array
  81          */
  82         private static function buildParams( $change, $auto ) {
  83                 return [
  84                         '4::curid' => $change->getAttribute( 'rc_this_oldid' ),
  85                         '5::previd' => $change->getAttribute( 'rc_last_oldid' ),
  86                         '6::auto' => (int)$auto
  87                 ];
  88         }
  89 }