RecentChange.php

Go to the documentation of this file.

<?php
class RecentChange {
    // Constants for the rc_source field.  Extensions may also have
    // their own source constants.
    const SRC_EDIT = 'mw.edit';
    const SRC_NEW = 'mw.new';
    const SRC_LOG = 'mw.log';
    const SRC_EXTERNAL = 'mw.external'; // obsolete

    public $mAttribs = array();
    public $mExtra = array();

    public $mTitle = false;

    private $mPerformer = false;

    public $numberofWatchingusers = 0; # Dummy to prevent error message in SpecialRecentChangesLinked
    public $notificationtimestamp;

    public $counter = -1;

    # Factory methods

    public static function newFromRow( $row ) {
        $rc = new RecentChange;
        $rc->loadFromRow( $row );

        return $rc;
    }

    public static function newFromCurRow( $row ) {
        wfDeprecated( __METHOD__, '1.22' );
        $rc = new RecentChange;
        $rc->loadFromCurRow( $row );
        $rc->notificationtimestamp = false;
        $rc->numberofWatchingusers = false;

        return $rc;
    }

    public static function newFromId( $rcid ) {
        return self::newFromConds( array( 'rc_id' => $rcid ), __METHOD__ );
    }

    public static function newFromConds( $conds, $fname = __METHOD__, $options = array() ) {
        $dbr = wfGetDB( DB_SLAVE );
        $row = $dbr->selectRow( 'recentchanges', self::selectFields(), $conds, $fname, $options );
        if ( $row !== false ) {
            return self::newFromRow( $row );
        } else {
            return null;
        }
    }

    public static function selectFields() {
        return array(
            'rc_id',
            'rc_timestamp',
            'rc_user',
            'rc_user_text',
            'rc_namespace',
            'rc_title',
            'rc_comment',
            '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',
        );
    }

    # Accessors

    public function setAttribs( $attribs ) {
        $this->mAttribs = $attribs;
    }

    public function setExtra( $extra ) {
        $this->mExtra = $extra;
    }

    public function &getTitle() {
        if ( $this->mTitle === false ) {
            $this->mTitle = Title::makeTitle( $this->mAttribs['rc_namespace'], $this->mAttribs['rc_title'] );
        }

        return $this->mTitle;
    }

    public function getPerformer() {
        if ( $this->mPerformer === false ) {
            if ( $this->mAttribs['rc_user'] ) {
                $this->mPerformer = User::newFromID( $this->mAttribs['rc_user'] );
            } else {
                $this->mPerformer = User::newFromName( $this->mAttribs['rc_user_text'], false );
            }
        }

        return $this->mPerformer;
    }

    public function save( $noudp = false ) {
        global $wgPutIPinRC, $wgUseEnotif, $wgShowUpdatedMarker, $wgContLang;

        $dbw = wfGetDB( DB_MASTER );
        if ( !is_array( $this->mExtra ) ) {
            $this->mExtra = array();
        }

        if ( !$wgPutIPinRC ) {
            $this->mAttribs['rc_ip'] = '';
        }

        # If our database is strict about IP addresses, use NULL instead of an empty string
        if ( $dbw->strictIPs() and $this->mAttribs['rc_ip'] == '' ) {
            unset( $this->mAttribs['rc_ip'] );
        }

        # Trim spaces on user supplied text
        $this->mAttribs['rc_comment'] = trim( $this->mAttribs['rc_comment'] );

        # Make sure summary is truncated (whole multibyte characters)
        $this->mAttribs['rc_comment'] = $wgContLang->truncate( $this->mAttribs['rc_comment'], 255 );

        # Fixup database timestamps
        $this->mAttribs['rc_timestamp'] = $dbw->timestamp( $this->mAttribs['rc_timestamp'] );
        $this->mAttribs['rc_id'] = $dbw->nextSequenceValue( 'recentchanges_rc_id_seq' );

        ## If we are using foreign keys, an entry of 0 for the page_id will fail, so use NULL
        if ( $dbw->cascadingDeletes() and $this->mAttribs['rc_cur_id'] == 0 ) {
            unset( $this->mAttribs['rc_cur_id'] );
        }

        # Insert new row
        $dbw->insert( 'recentchanges', $this->mAttribs, __METHOD__ );

        # Set the ID
        $this->mAttribs['rc_id'] = $dbw->insertId();

        # Notify extensions
        wfRunHooks( 'RecentChange_save', array( &$this ) );

        # Notify external application via UDP
        if ( !$noudp ) {
            $this->notifyRCFeeds();
        }

        # E-mail notifications
        if ( $wgUseEnotif || $wgShowUpdatedMarker ) {
            $editor = $this->getPerformer();
            $title = $this->getTitle();

            if ( wfRunHooks( 'AbortEmailNotification', array( $editor, $title ) ) ) {
                # @todo FIXME: This would be better as an extension hook
                $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'] );
            }
        }
    }

    public function notifyRC2UDP() {
        wfDeprecated( __METHOD__, '1.22' );
        $this->notifyRCFeeds();
    }

    public static function sendToUDP( $line, $address = '', $prefix = '', $port = '' ) {
        global $wgRC2UDPAddress, $wgRC2UDPInterwikiPrefix, $wgRC2UDPPort, $wgRC2UDPPrefix;

        wfDeprecated( __METHOD__, '1.22' );

        # Assume default for standard RC case
        $address = $address ? $address : $wgRC2UDPAddress;
        $prefix = $prefix ? $prefix : $wgRC2UDPPrefix;
        $port = $port ? $port : $wgRC2UDPPort;

        $engine = new UDPRCFeedEngine();
        $feed = array(
            'uri' => "udp://$address:$port/$prefix",
            'formatter' => 'IRCColourfulRCFeedFormatter',
            'add_interwiki_prefix' => $wgRC2UDPInterwikiPrefix,
        );

        $engine->send( $feed, $line );
    }

    public function notifyRCFeeds() {
        global $wgRCFeeds;

        $performer = $this->getPerformer();

        foreach ( $wgRCFeeds as $feed ) {
            $feed += array(
                'omit_bots' => false,
                'omit_anon' => false,
                'omit_user' => false,
                'omit_minor' => false,
                'omit_patrolled' => false,
            );

            if (
                ( $feed['omit_bots'] && $this->mAttribs['rc_bot'] ) ||
                ( $feed['omit_anon'] && $performer->isAnon() ) ||
                ( $feed['omit_user'] && !$performer->isAnon() ) ||
                ( $feed['omit_minor'] && $this->mAttribs['rc_minor'] ) ||
                ( $feed['omit_patrolled'] && $this->mAttribs['rc_patrolled'] ) ||
                $this->mAttribs['rc_type'] == RC_EXTERNAL
            ) {
                continue;
            }

            $engine = self::getEngine( $feed['uri'] );

            if ( isset( $this->mExtra['actionCommentIRC'] ) ) {
                $actionComment = $this->mExtra['actionCommentIRC'];
            } else {
                $actionComment = null;
            }

            $formatter = new $feed['formatter']();
            $line = $formatter->getLine( $feed, $this, $actionComment );

            $engine->send( $feed, $line );
        }
    }

    public static function getEngine( $uri ) {
        global $wgRCEngines;

        $scheme = parse_url( $uri, PHP_URL_SCHEME );
        if ( !$scheme ) {
            throw new MWException( __FUNCTION__ . ": Invalid stream logger URI: '$uri'" );
        }

        if ( !isset( $wgRCEngines[$scheme] ) ) {
            throw new MWException( __FUNCTION__ . ": Unknown stream logger URI scheme: $scheme" );
        }

        return new $wgRCEngines[$scheme];
    }

    public static function cleanupForIRC( $text ) {
        wfDeprecated( __METHOD__, '1.22' );

        return IRCColourfulRCFeedFormatter::cleanupForIRC( $text );
    }

    public static function markPatrolled( $change, $auto = false ) {
        global $wgUser;

        $change = $change instanceof RecentChange
            ? $change
            : RecentChange::newFromId( $change );

        if ( !$change instanceof RecentChange ) {
            return null;
        }

        return $change->doMarkPatrolled( $wgUser, $auto );
    }

    public function doMarkPatrolled( User $user, $auto = false ) {
        global $wgUseRCPatrol, $wgUseNPPatrol;
        $errors = array();
        // If recentchanges patrol is disabled, only new pages
        // can be patrolled
        if ( !$wgUseRCPatrol && ( !$wgUseNPPatrol || $this->getAttribute( 'rc_type' ) != RC_NEW ) ) {
            $errors[] = array( 'rcpatroldisabled' );
        }
        // Automatic patrol needs "autopatrol", ordinary patrol needs "patrol"
        $right = $auto ? 'autopatrol' : 'patrol';
        $errors = array_merge( $errors, $this->getTitle()->getUserPermissionsErrors( $right, $user ) );
        if ( !wfRunHooks( 'MarkPatrolled', array( $this->getAttribute( 'rc_id' ), &$user, false ) ) ) {
            $errors[] = array( 'hookaborted' );
        }
        // Users without the 'autopatrol' right can't patrol their
        // own revisions
        if ( $user->getName() == $this->getAttribute( 'rc_user_text' )
            && !$user->isAllowed( 'autopatrol' )
        ) {
            $errors[] = array( 'markedaspatrollederror-noautopatrol' );
        }
        if ( $errors ) {
            return $errors;
        }
        // If the change was patrolled already, do nothing
        if ( $this->getAttribute( 'rc_patrolled' ) ) {
            return array();
        }
        // Actually set the 'patrolled' flag in RC
        $this->reallyMarkPatrolled();
        // Log this patrol event
        PatrolLog::record( $this, $auto, $user );
        wfRunHooks( 'MarkPatrolledComplete', array( $this->getAttribute( 'rc_id' ), &$user, false ) );

        return array();
    }

    public function reallyMarkPatrolled() {
        $dbw = wfGetDB( DB_MASTER );
        $dbw->update(
            'recentchanges',
            array(
                'rc_patrolled' => 1
            ),
            array(
                '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();
    }

    public static function notifyEdit( $timestamp, &$title, $minor, &$user, $comment, $oldId,
        $lastTimestamp, $bot, $ip = '', $oldSize = 0, $newSize = 0, $newId = 0, $patrol = 0 ) {
        $rc = new RecentChange;
        $rc->mTitle = $title;
        $rc->mPerformer = $user;
        $rc->mAttribs = array(
            '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_comment' => $comment,
            '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 = array(
            'prefixedDBkey' => $title->getPrefixedDBkey(),
            'lastTimestamp' => $lastTimestamp,
            'oldSize' => $oldSize,
            'newSize' => $newSize,
            'pageStatus' => 'changed'
        );
        $rc->save();

        return $rc;
    }

    public static function notifyNew( $timestamp, &$title, $minor, &$user, $comment, $bot,
        $ip = '', $size = 0, $newId = 0, $patrol = 0 ) {
        $rc = new RecentChange;
        $rc->mTitle = $title;
        $rc->mPerformer = $user;
        $rc->mAttribs = array(
            '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_comment' => $comment,
            '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 = array(
            'prefixedDBkey' => $title->getPrefixedDBkey(),
            'lastTimestamp' => 0,
            'oldSize' => 0,
            'newSize' => $size,
            'pageStatus' => 'created'
        );
        $rc->save();

        return $rc;
    }

    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;
    }

    public static function newLogEntry( $timestamp, &$title, &$user, $actionComment, $ip,
        $type, $action, $target, $logComment, $params, $newId = 0, $actionCommentIRC = '' ) {
        global $wgRequest;

        ## Get pageStatus for email notification
        switch ( $type . '-' . $action ) {
            case 'delete-delete':
                $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;
        }

        $rc = new RecentChange;
        $rc->mTitle = $target;
        $rc->mPerformer = $user;
        $rc->mAttribs = array(
            '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_comment' => $logComment,
            'rc_this_oldid' => 0,
            'rc_last_oldid' => 0,
            'rc_bot' => $user->isAllowed( 'bot' ) ? $wgRequest->getBool( 'bot', true ) : 0,
            'rc_ip' => self::checkIPAddress( $ip ),
            'rc_patrolled' => 1,
            '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 = array(
            'prefixedDBkey' => $title->getPrefixedDBkey(),
            'lastTimestamp' => 0,
            'actionComment' => $actionComment, // the comment appended to the action, passed from LogPage
            'pageStatus' => $pageStatus,
            'actionCommentIRC' => $actionCommentIRC
        );

        return $rc;
    }

    public function loadFromRow( $row ) {
        $this->mAttribs = get_object_vars( $row );
        $this->mAttribs['rc_timestamp'] = wfTimestamp( TS_MW, $this->mAttribs['rc_timestamp'] );
        $this->mAttribs['rc_deleted'] = $row->rc_deleted; // MUST be set
    }

    public function loadFromCurRow( $row ) {
        wfDeprecated( __METHOD__, '1.22' );
        $this->mAttribs = array(
            'rc_timestamp' => wfTimestamp( TS_MW, $row->rev_timestamp ),
            'rc_user' => $row->rev_user,
            'rc_user_text' => $row->rev_user_text,
            'rc_namespace' => $row->page_namespace,
            'rc_title' => $row->page_title,
            'rc_comment' => $row->rev_comment,
            'rc_minor' => $row->rev_minor_edit ? 1 : 0,
            'rc_type' => $row->page_is_new ? RC_NEW : RC_EDIT,
            'rc_source' => $row->page_is_new ? self::SRC_NEW : self::SRC_EDIT,
            'rc_cur_id' => $row->page_id,
            'rc_this_oldid' => $row->rev_id,
            'rc_last_oldid' => isset( $row->rc_last_oldid ) ? $row->rc_last_oldid : 0,
            'rc_bot' => 0,
            'rc_ip' => '',
            'rc_id' => $row->rc_id,
            'rc_patrolled' => $row->rc_patrolled,
            'rc_new' => $row->page_is_new, # obsolete
            'rc_old_len' => $row->rc_old_len,
            'rc_new_len' => $row->rc_new_len,
            'rc_params' => isset( $row->rc_params ) ? $row->rc_params : '',
            'rc_log_type' => isset( $row->rc_log_type ) ? $row->rc_log_type : null,
            'rc_log_action' => isset( $row->rc_log_action ) ? $row->rc_log_action : null,
            'rc_logid' => isset( $row->rc_logid ) ? $row->rc_logid : 0,
            'rc_deleted' => $row->rc_deleted // MUST be set
        );
    }

    public function getAttribute( $name ) {
        return isset( $this->mAttribs[$name] ) ? $this->mAttribs[$name] : null;
    }

    public function getAttributes() {
        return $this->mAttribs;
    }

    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;
    }

    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 );
    }

    public static function purgeExpiredChanges() {
        if ( wfReadOnly() ) {
            return;
        }

        $method = __METHOD__;
        $dbw = wfGetDB( DB_MASTER );
        $dbw->onTransactionIdle( function () use ( $dbw, $method ) {
            global $wgRCMaxAge;

            $cutoff = $dbw->timestamp( time() - $wgRCMaxAge );
            $dbw->delete(
                'recentchanges',
                array( 'rc_timestamp < ' . $dbw->addQuotes( $cutoff ) ),
                $method
            );
        } );
    }

    private static function checkIPAddress( $ip ) {
        global $wgRequest;
        if ( $ip ) {
            if ( !IP::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;
    }

    public static function isInRCLifespan( $timestamp, $tolerance = 0 ) {
        global $wgRCMaxAge;

        return wfTimestamp( TS_UNIX, $timestamp ) > time() - $tolerance - $wgRCMaxAge;
    }
}