wikimedia/mediawiki-core

<?php
/**
 * 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
 * @ingroup Change tagging
 */

use MediaWiki\MediaWikiServices;
use MediaWiki\Permissions\Authority;
use MediaWiki\Status\Status;
use Wikimedia\Rdbms\IResultWrapper;
use Wikimedia\Rdbms\SelectQueryBuilder;

/**
 * Stores a list of taggable log entries.
 * @since 1.25
 */
class ChangeTagsLogList extends ChangeTagsList {
    public function getType() {
        return 'logentry';
    }

    /**
     * @param \Wikimedia\Rdbms\IReadableDatabase $db
     * @return IResultWrapper
     */
    public function doQuery( $db ) {
        $ids = array_map( 'intval', $this->ids );
        $queryBuilder = DatabaseLogEntry::newSelectQueryBuilder( $db )
            ->where( [ 'log_id' => $ids ] )
            ->orderBy( [ 'log_timestamp', 'log_id' ], SelectQueryBuilder::SORT_DESC );

        MediaWikiServices::getInstance()->getChangeTagsStore()->modifyDisplayQueryBuilder( $queryBuilder, 'logging' );
        return $queryBuilder->caller( __METHOD__ )->fetchResultSet();
    }

    public function newItem( $row ) {
        return new ChangeTagsLogItem( $this, $row );
    }

    /**
     * Add/remove change tags from all the log entries in the list.
     *
     * @param string[] $tagsToAdd
     * @param string[] $tagsToRemove
     * @param string|null $params
     * @param string $reason
     * @param Authority $performer
     * @return Status
     */
    public function updateChangeTagsOnAll(
        array $tagsToAdd,
        array $tagsToRemove,
        ?string $params,
        string $reason,
        Authority $performer
    ) {
        $status = Status::newGood();
        for ( $this->reset(); $this->current(); $this->next() ) {
            $item = $this->current();
            $status = ChangeTags::updateTagsWithChecks( $tagsToAdd, $tagsToRemove,
                null, null, $item->getId(), $params, $reason, $performer );
            // Should only fail on second and subsequent times if the user trips
            // the rate limiter
            if ( !$status->isOK() ) {
                break;
            }
        }

        return $status;
    }
}