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
 */

use MediaWiki\Block\AbstractBlock;
use MediaWiki\Block\Block;
use MediaWiki\Block\CompositeBlock;
use MediaWiki\Block\DatabaseBlock;
use MediaWiki\Block\SystemBlock;
use MediaWiki\User\User;
use MediaWiki\Utils\MWTimestamp;

/**
 * @ingroup API
 */
trait ApiBlockInfoTrait {

    /**
     * Get basic info about a given block
     * @param Block $block
     * @param Language|null $language
     * @return array Array containing several keys:
     *  - blockid - ID of the block
     *  - blockedby - username of the blocker
     *  - blockedbyid - user ID of the blocker
     *  - blockreason - reason provided for the block
     *  - blockedtimestamp - timestamp for when the block was placed/modified
     *  - blockedtimestampformatted - blockedtimestamp, formatted for the current locale
     *  - blockexpiry - expiry time of the block
     *  - blockexpiryformatted - blockexpiry formatted for the current locale, omitted if infinite
     *  - blockexpiryrelative - relative time to blockexpiry (e.g. 'in 5 days'), omitted if infinite
     *  - blockpartial - block only applies to certain pages, namespaces and/or actions
     *  - systemblocktype - system block type, if any
     *  - blockcomponents - If the block is a composite block, this will be an array of block
     *    info arrays
     */
    private function getBlockDetails(
        Block $block,
        $language = null
    ) {
        $language ??= $this->getLanguage();

        $blocker = $block->getBlocker();

        $vals = [];
        $vals['blockid'] = $block->getId();
        $vals['blockedby'] = $blocker ? $blocker->getName() : '';
        $vals['blockedbyid'] = $blocker ? $blocker->getId() : 0;
        $vals['blockreason'] = $block->getReasonComment()
            ->message->inLanguage( $language )->plain();
        $vals['blockedtimestamp'] = wfTimestamp( TS_ISO_8601, $block->getTimestamp() );
        $expiry = ApiResult::formatExpiry( $block->getExpiry(), 'infinite' );
        $vals['blockexpiry'] = $expiry;
        $vals['blockpartial'] = !$block->isSitewide();
        $vals['blocknocreate'] = $block->isCreateAccountBlocked();
        $vals['blockanononly'] = !$block->isHardblock();
        if ( $block instanceof AbstractBlock ) {
            $vals['blockemail'] = $block->isEmailBlocked();
            $vals['blockowntalk'] = !$block->isUsertalkEditAllowed();
        }

        $user = $this->getUser();
        // Formatted timestamps
        $vals['blockedtimestampformatted'] = $language->formatExpiry(
            $block->getTimestamp(), true, 'infinity', $user
        );
        if ( $expiry !== 'infinite' ) {
            $vals['blockexpiryformatted'] = $language->formatExpiry(
                $expiry, true, 'infinity', $user
            );
            $vals['blockexpiryrelative'] = $language->getHumanTimestamp(
                new MWTimestamp( $expiry ), new MWTimestamp(), $user
            );
        }

        if ( $block instanceof SystemBlock ) {
            $vals['systemblocktype'] = $block->getSystemBlockType();
        }

        if ( $block instanceof CompositeBlock ) {
            $components = [];
            foreach ( $block->getOriginalBlocks() as $singleBlock ) {
                $components[] = $this->getBlockDetails( $singleBlock, $language );
            }
            $vals['blockcomponents'] = $components;
        }

        return $vals;
    }

    /**
     * Get the API error code, to be used in ApiMessage::create or ApiBase::dieWithError
     * @param Block $block
     * @return string
     */
    private function getBlockCode( Block $block ): string {
        if ( $block instanceof DatabaseBlock && $block->getType() === Block::TYPE_AUTO ) {
            return 'autoblocked';
        }
        return 'blocked';
    }

    // region   Methods required from ApiBase
    /** @name   Methods required from ApiBase
     * @{
     */

    /**
     * @see IContextSource::getLanguage
     * @return Language
     */
    abstract public function getLanguage();

    /**
     * @see IContextSource::getUser
     * @return User
     */
    abstract public function getUser();

    /** @} */
    // endregion -- end of methods required from ApiBase

}