ApiQueryLogEvents.php

Go to the documentation of this file.

<?php
class ApiQueryLogEvents extends ApiQueryBase {

    public function __construct( ApiQuery $query, $moduleName ) {
        parent::__construct( $query, $moduleName, 'le' );
    }

    private $fld_ids = false, $fld_title = false, $fld_type = false,
        $fld_user = false, $fld_userid = false,
        $fld_timestamp = false, $fld_comment = false, $fld_parsedcomment = false,
        $fld_details = false, $fld_tags = false;

    public function execute() {
        $params = $this->extractRequestParams();
        $db = $this->getDB();
        $this->requireMaxOneParameter( $params, 'title', 'prefix', 'namespace' );

        $prop = array_flip( $params['prop'] );

        $this->fld_ids = isset( $prop['ids'] );
        $this->fld_title = isset( $prop['title'] );
        $this->fld_type = isset( $prop['type'] );
        $this->fld_user = isset( $prop['user'] );
        $this->fld_userid = isset( $prop['userid'] );
        $this->fld_timestamp = isset( $prop['timestamp'] );
        $this->fld_comment = isset( $prop['comment'] );
        $this->fld_parsedcomment = isset( $prop['parsedcomment'] );
        $this->fld_details = isset( $prop['details'] );
        $this->fld_tags = isset( $prop['tags'] );

        $hideLogs = LogEventsList::getExcludeClause( $db, 'user', $this->getUser() );
        if ( $hideLogs !== false ) {
            $this->addWhere( $hideLogs );
        }

        // Order is significant here
        $this->addTables( [ 'logging', 'user', 'page' ] );
        $this->addJoinConds( [
            'user' => [ 'LEFT JOIN',
                'user_id=log_user' ],
            'page' => [ 'LEFT JOIN',
                [ 'log_namespace=page_namespace',
                    'log_title=page_title' ] ] ] );

        $this->addFields( [
            'log_id',
            'log_type',
            'log_action',
            'log_timestamp',
            'log_deleted',
        ] );

        $this->addFieldsIf( 'page_id', $this->fld_ids );
        // log_page is the page_id saved at log time, whereas page_id is from a
        // join at query time.  This leads to different results in various
        // scenarios, e.g. deletion, recreation.
        $this->addFieldsIf( 'log_page', $this->fld_ids );
        $this->addFieldsIf( [ 'log_user', 'log_user_text', 'user_name' ], $this->fld_user );
        $this->addFieldsIf( 'log_user', $this->fld_userid );
        $this->addFieldsIf(
            [ 'log_namespace', 'log_title' ],
            $this->fld_title || $this->fld_parsedcomment
        );
        $this->addFieldsIf( 'log_comment', $this->fld_comment || $this->fld_parsedcomment );
        $this->addFieldsIf( 'log_params', $this->fld_details );

        if ( $this->fld_tags ) {
            $this->addTables( 'tag_summary' );
            $this->addJoinConds( [ 'tag_summary' => [ 'LEFT JOIN', 'log_id=ts_log_id' ] ] );
            $this->addFields( 'ts_tags' );
        }

        if ( !is_null( $params['tag'] ) ) {
            $this->addTables( 'change_tag' );
            $this->addJoinConds( [ 'change_tag' => [ 'INNER JOIN',
                [ 'log_id=ct_log_id' ] ] ] );
            $this->addWhereFld( 'ct_tag', $params['tag'] );
        }

        if ( !is_null( $params['action'] ) ) {
            // Do validation of action param, list of allowed actions can contains wildcards
            // Allow the param, when the actions is in the list or a wildcard version is listed.
            $logAction = $params['action'];
            if ( strpos( $logAction, '/' ) === false ) {
                // all items in the list have a slash
                $valid = false;
            } else {
                $logActions = array_flip( $this->getAllowedLogActions() );
                list( $type, $action ) = explode( '/', $logAction, 2 );
                $valid = isset( $logActions[$logAction] ) || isset( $logActions[$type . '/*'] );
            }

            if ( !$valid ) {
                $valueName = $this->encodeParamName( 'action' );
                $this->dieUsage(
                    "Unrecognized value for parameter '$valueName': {$logAction}",
                    "unknown_$valueName"
                );
            }

            $this->addWhereFld( 'log_type', $type );
            $this->addWhereFld( 'log_action', $action );
        } elseif ( !is_null( $params['type'] ) ) {
            $this->addWhereFld( 'log_type', $params['type'] );
        }

        $this->addTimestampWhereRange(
            'log_timestamp',
            $params['dir'],
            $params['start'],
            $params['end']
        );
        // Include in ORDER BY for uniqueness
        $this->addWhereRange( 'log_id', $params['dir'], null, null );

        if ( !is_null( $params['continue'] ) ) {
            $cont = explode( '|', $params['continue'] );
            $this->dieContinueUsageIf( count( $cont ) != 2 );
            $op = ( $params['dir'] === 'newer' ? '>' : '<' );
            $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
            $continueId = (int)$cont[1];
            $this->dieContinueUsageIf( $continueId != $cont[1] );
            $this->addWhere( "log_timestamp $op $continueTimestamp OR " .
                "(log_timestamp = $continueTimestamp AND " .
                "log_id $op= $continueId)"
            );
        }

        $limit = $params['limit'];
        $this->addOption( 'LIMIT', $limit + 1 );

        $user = $params['user'];
        if ( !is_null( $user ) ) {
            $userid = User::idFromName( $user );
            if ( $userid ) {
                $this->addWhereFld( 'log_user', $userid );
            } else {
                $this->addWhereFld( 'log_user_text', $user );
            }
        }

        $title = $params['title'];
        if ( !is_null( $title ) ) {
            $titleObj = Title::newFromText( $title );
            if ( is_null( $titleObj ) ) {
                $this->dieUsage( "Bad title value '$title'", 'param_title' );
            }
            $this->addWhereFld( 'log_namespace', $titleObj->getNamespace() );
            $this->addWhereFld( 'log_title', $titleObj->getDBkey() );
        }

        if ( $params['namespace'] !== null ) {
            $this->addWhereFld( 'log_namespace', $params['namespace'] );
        }

        $prefix = $params['prefix'];

        if ( !is_null( $prefix ) ) {
            if ( $this->getConfig()->get( 'MiserMode' ) ) {
                $this->dieUsage( 'Prefix search disabled in Miser Mode', 'prefixsearchdisabled' );
            }

            $title = Title::newFromText( $prefix );
            if ( is_null( $title ) ) {
                $this->dieUsage( "Bad title value '$prefix'", 'param_prefix' );
            }
            $this->addWhereFld( 'log_namespace', $title->getNamespace() );
            $this->addWhere( 'log_title ' . $db->buildLike( $title->getDBkey(), $db->anyString() ) );
        }

        // Paranoia: avoid brute force searches (bug 17342)
        if ( $params['namespace'] !== null || !is_null( $title ) || !is_null( $user ) ) {
            if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
                $titleBits = LogPage::DELETED_ACTION;
                $userBits = LogPage::DELETED_USER;
            } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
                $titleBits = LogPage::DELETED_ACTION | LogPage::DELETED_RESTRICTED;
                $userBits = LogPage::DELETED_USER | LogPage::DELETED_RESTRICTED;
            } else {
                $titleBits = 0;
                $userBits = 0;
            }
            if ( ( $params['namespace'] !== null || !is_null( $title ) ) && $titleBits ) {
                $this->addWhere( $db->bitAnd( 'log_deleted', $titleBits ) . " != $titleBits" );
            }
            if ( !is_null( $user ) && $userBits ) {
                $this->addWhere( $db->bitAnd( 'log_deleted', $userBits ) . " != $userBits" );
            }
        }

        $count = 0;
        $res = $this->select( __METHOD__ );
        $result = $this->getResult();
        foreach ( $res as $row ) {
            if ( ++$count > $limit ) {
                // We've reached the one extra which shows that there are
                // additional pages to be had. Stop here...
                $this->setContinueEnumParameter( 'continue', "$row->log_timestamp|$row->log_id" );
                break;
            }

            $vals = $this->extractRowInfo( $row );
            $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
            if ( !$fit ) {
                $this->setContinueEnumParameter( 'continue', "$row->log_timestamp|$row->log_id" );
                break;
            }
        }
        $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'item' );
    }

    public static function addLogParams( $result, &$vals, $params, $type,
        $action, $ts, $legacy = false
    ) {
        wfDeprecated( __METHOD__, '1.25' );

        $entry = new ManualLogEntry( $type, $action );
        $entry->setParameters( $params );
        $entry->setTimestamp( $ts );
        $entry->setLegacy( $legacy );
        $formatter = LogFormatter::newFromEntry( $entry );
        $vals['params'] = $formatter->formatParametersForApi();

        return $vals;
    }

    private function extractRowInfo( $row ) {
        $logEntry = DatabaseLogEntry::newFromRow( $row );
        $vals = [
            ApiResult::META_TYPE => 'assoc',
        ];
        $anyHidden = false;
        $user = $this->getUser();

        if ( $this->fld_ids ) {
            $vals['logid'] = intval( $row->log_id );
        }

        if ( $this->fld_title || $this->fld_parsedcomment ) {
            $title = Title::makeTitle( $row->log_namespace, $row->log_title );
        }

        if ( $this->fld_title || $this->fld_ids || $this->fld_details && $row->log_params !== '' ) {
            if ( LogEventsList::isDeleted( $row, LogPage::DELETED_ACTION ) ) {
                $vals['actionhidden'] = true;
                $anyHidden = true;
            }
            if ( LogEventsList::userCan( $row, LogPage::DELETED_ACTION, $user ) ) {
                if ( $this->fld_title ) {
                    ApiQueryBase::addTitleInfo( $vals, $title );
                }
                if ( $this->fld_ids ) {
                    $vals['pageid'] = intval( $row->page_id );
                    $vals['logpage'] = intval( $row->log_page );
                }
                if ( $this->fld_details ) {
                    $vals['params'] = LogFormatter::newFromEntry( $logEntry )->formatParametersForApi();
                }
            }
        }

        if ( $this->fld_type ) {
            $vals['type'] = $row->log_type;
            $vals['action'] = $row->log_action;
        }

        if ( $this->fld_user || $this->fld_userid ) {
            if ( LogEventsList::isDeleted( $row, LogPage::DELETED_USER ) ) {
                $vals['userhidden'] = true;
                $anyHidden = true;
            }
            if ( LogEventsList::userCan( $row, LogPage::DELETED_USER, $user ) ) {
                if ( $this->fld_user ) {
                    $vals['user'] = $row->user_name === null ? $row->log_user_text : $row->user_name;
                }
                if ( $this->fld_userid ) {
                    $vals['userid'] = intval( $row->log_user );
                }

                if ( !$row->log_user ) {
                    $vals['anon'] = true;
                }
            }
        }
        if ( $this->fld_timestamp ) {
            $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->log_timestamp );
        }

        if ( ( $this->fld_comment || $this->fld_parsedcomment ) && isset( $row->log_comment ) ) {
            if ( LogEventsList::isDeleted( $row, LogPage::DELETED_COMMENT ) ) {
                $vals['commenthidden'] = true;
                $anyHidden = true;
            }
            if ( LogEventsList::userCan( $row, LogPage::DELETED_COMMENT, $user ) ) {
                if ( $this->fld_comment ) {
                    $vals['comment'] = $row->log_comment;
                }

                if ( $this->fld_parsedcomment ) {
                    $vals['parsedcomment'] = Linker::formatComment( $row->log_comment, $title );
                }
            }
        }

        if ( $this->fld_tags ) {
            if ( $row->ts_tags ) {
                $tags = explode( ',', $row->ts_tags );
                ApiResult::setIndexedTagName( $tags, 'tag' );
                $vals['tags'] = $tags;
            } else {
                $vals['tags'] = [];
            }
        }

        if ( $anyHidden && LogEventsList::isDeleted( $row, LogPage::DELETED_RESTRICTED ) ) {
            $vals['suppressed'] = true;
        }

        return $vals;
    }

    private function getAllowedLogActions() {
        $config = $this->getConfig();
        return array_keys( array_merge(
            $config->get( 'LogActions' ),
            $config->get( 'LogActionsHandlers' )
        ) );
    }

    public function getCacheMode( $params ) {
        if ( $this->userCanSeeRevDel() ) {
            return 'private';
        }
        if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
            // formatComment() calls wfMessage() among other things
            return 'anon-public-user-private';
        } elseif ( LogEventsList::getExcludeClause( $this->getDB(), 'user', $this->getUser() )
            === LogEventsList::getExcludeClause( $this->getDB(), 'public' )
        ) { // Output can only contain public data.
            return 'public';
        } else {
            return 'anon-public-user-private';
        }
    }

    public function getAllowedParams( $flags = 0 ) {
        $config = $this->getConfig();
        $ret = [
            'prop' => [
                ApiBase::PARAM_ISMULTI => true,
                ApiBase::PARAM_DFLT => 'ids|title|type|user|timestamp|comment|details',
                ApiBase::PARAM_TYPE => [
                    'ids',
                    'title',
                    'type',
                    'user',
                    'userid',
                    'timestamp',
                    'comment',
                    'parsedcomment',
                    'details',
                    'tags'
                ],
                ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
            ],
            'type' => [
                ApiBase::PARAM_TYPE => $config->get( 'LogTypes' )
            ],
            'action' => [
                // validation on request is done in execute()
                ApiBase::PARAM_TYPE => ( $flags & ApiBase::GET_VALUES_FOR_HELP )
                    ? $this->getAllowedLogActions()
                    : null
            ],
            'start' => [
                ApiBase::PARAM_TYPE => 'timestamp'
            ],
            'end' => [
                ApiBase::PARAM_TYPE => 'timestamp'
            ],
            'dir' => [
                ApiBase::PARAM_DFLT => 'older',
                ApiBase::PARAM_TYPE => [
                    'newer',
                    'older'
                ],
                ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
            ],
            'user' => [
                ApiBase::PARAM_TYPE => 'user',
            ],
            'title' => null,
            'namespace' => [
                ApiBase::PARAM_TYPE => 'namespace'
            ],
            'prefix' => [],
            'tag' => null,
            'limit' => [
                ApiBase::PARAM_DFLT => 10,
                ApiBase::PARAM_TYPE => 'limit',
                ApiBase::PARAM_MIN => 1,
                ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
                ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
            ],
            'continue' => [
                ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
            ],
        ];

        if ( $config->get( 'MiserMode' ) ) {
            $ret['prefix'][ApiBase::PARAM_HELP_MSG] = 'api-help-param-disabled-in-miser-mode';
        }

        return $ret;
    }

    protected function getExamplesMessages() {
        return [
            'action=query&list=logevents'
                => 'apihelp-query+logevents-example-simple',
        ];
    }

    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/API:Logevents';
    }
}