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

namespace MediaWiki\Exception;

use MediaWiki\Block\Block;
use MediaWiki\Context\RequestContext;
use MediaWiki\Language\RawMessage;
use MediaWiki\MediaWikiServices;
use MediaWiki\User\UserIdentity;

/**
 * Show an error when the user tries to do something whilst blocked.
 *
 * @newable
 * @since 1.18
 * @ingroup Exception
 */
class UserBlockedError extends ErrorPageError {
	/**
	 * @stable to call
	 * @param Block $block
	 * @param UserIdentity|null $user
	 * @param mixed $language Unused since 1.42
	 * @param string|null $ip
	 */
	public function __construct(
		Block $block,
		?UserIdentity $user = null,
		$language = null,
		$ip = null
	) {
		$context = RequestContext::getMain();
		if ( $user === null || $ip === null ) {
			// If any of these are not passed in, use the global context
			$user = $context->getUser();
			$ip = $context->getRequest()->getIP();
		}

		// @todo This should be passed in via the constructor
		$messages = MediaWikiServices::getInstance()->getFormatterFactory()
			->getBlockErrorFormatter( $context )
			->getMessages( $block, $user, $ip );

		if ( count( $messages ) === 1 ) {
			$message = $messages[0];
		} else {
			$message = new RawMessage( '* $' . implode( "\n* \$", range( 1, count( $messages ) ) ) );
			$message->params( $messages )->parse();
		}

		parent::__construct( 'blockedtitle', $message );
	}
}

/** @deprecated class alias since 1.44 */
class_alias( UserBlockedError::class, 'UserBlockedError' );