includes/exception/LocalizedException.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 use MediaWiki\Message\Message;
  22 use MediaWiki\Parser\Sanitizer;
  23 use Wikimedia\Message\MessageSpecifier;
  24
  25 /**
  26  * Basic localized exception.
  27  *
  28  * @newable
  29  * @stable to extend
  30  * @since 1.29
  31  * @ingroup Exception
  32  * @note Don't use this in a situation where MessageCache is not functional.
  33  */
  34 class LocalizedException extends Exception implements ILocalizedException {
  35         /** @var string|array|MessageSpecifier */
  36         protected $messageSpec;
  37
  38         /**
  39          * @stable to call
  40          * @param string|array|MessageSpecifier $messageSpec See Message::newFromSpecifier
  41          * @param int $code
  42          * @param Throwable|null $previous The previous exception used for the exception
  43          *  chaining.
  44          */
  45         public function __construct( $messageSpec, $code = 0, ?Throwable $previous = null ) {
  46                 $this->messageSpec = $messageSpec;
  47
  48                 // Exception->getMessage() should be in plain English, not localized.
  49                 // So fetch the English version of the message, without local
  50                 // customizations, and make a basic attempt to turn markup into text.
  51                 $msg = $this->getMessageObject()->inLanguage( 'en' )->useDatabase( false )->text();
  52                 $msg = preg_replace( '!</?(var|kbd|samp|code)>!', '"', $msg );
  53                 $msg = Sanitizer::stripAllTags( $msg );
  54                 parent::__construct( $msg, $code, $previous );
  55         }
  56
  57         public function getMessageObject() {
  58                 return Message::newFromSpecifier( $this->messageSpec );
  59         }
  60 }