1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
<?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\Debug\MWDebug;
/**
* MediaWiki exception
*
* @newable
* @stable to extend
*
* @ingroup Exception
* @deprecated since 1.40, use native exceptions instead (either directly, or defining subclasses when appropriate)
*/
class MWException extends Exception {
/**
* Whether to log this exception in the exception debug log.
*
* @stable to override
*
* @since 1.23
* @return bool
*/
public function isLoggable() {
return true;
}
/**
* Can the extension use the Message class/wfMessage to get i18n-ed messages?
*
* @stable to override
*
* @return bool
*/
public function useMessageCache() {
foreach ( $this->getTrace() as $frame ) {
if ( isset( $frame['class'] ) && $frame['class'] === LocalisationCache::class ) {
return false;
}
}
return true;
}
/**
* Get a message from i18n
*
* @param string $key Message name
* @param string $fallback Default message if the message cache can't be
* called by the exception
* @param mixed ...$params To pass to wfMessage()
* @return string Message with arguments replaced
*/
public function msg( $key, $fallback, ...$params ) {
// NOTE: Keep logic in sync with MWExceptionRenderer::msg.
$res = false;
if ( $this->useMessageCache() ) {
try {
$res = wfMessage( $key, ...$params )->text();
} catch ( Exception $e ) {
}
}
if ( $res === false ) {
// Fallback to static message text and generic sitename.
// Avoid live config as this must work before Setup/MediaWikiServices finish.
$res = wfMsgReplaceArgs( $fallback, $params );
$res = strtr( $res, [
'{{SITENAME}}' => 'MediaWiki',
] );
}
return $res;
}
/**
* Output a report about the exception and takes care of formatting.
* It will be either HTML or plain text based on isCommandLine().
*
* @stable to override
*/
public function report() {
// May be overridden by subclasses to replace the whole error page
MWExceptionRenderer::output( $this, MWExceptionRenderer::AS_PRETTY );
}
/**
* @internal
*/
final public function hasOverriddenHandler(): bool {
return MWDebug::detectDeprecatedOverride( $this, __CLASS__, 'report' );
}
/**
* Check whether we are in command line mode or not to report the exception
* in the correct format.
*
* @return bool
*/
public static function isCommandLine() {
return MW_ENTRY_POINT === 'cli';
}
}
|
