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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
<?php
/**
* Generic operation result class
* Has warning/error list, boolean status and arbitrary value
*
* "Good" means the operation was completed with no warnings or errors.
*
* "OK" means the operation was partially or wholly completed.
*
* An operation which is not OK should have errors so that the user can be
* informed as to what went wrong. Calling the fatal() function sets an error
* message and simultaneously switches off the OK flag.
*/
class Status {
var $ok = true;
var $value;
/** Counters for batch operations */
var $successCount = 0, $failCount = 0;
/*semi-private*/ var $errors = array();
/*semi-private*/ var $cleanCallback = false;
/**
* Factory function for fatal errors
*/
static function newFatal( $message /*, parameters...*/ ) {
$params = func_get_args();
$result = new self;
call_user_func_array( array( &$result, 'error' ), $params );
$result->ok = false;
return $result;
}
static function newGood( $value = null ) {
$result = new self;
$result->value = $value;
return $result;
}
function setResult( $ok, $value = null ) {
$this->ok = $ok;
$this->value = $value;
}
function isGood() {
return $this->ok && !$this->errors;
}
function isOK() {
return $this->ok;
}
function warning( $message /*, parameters... */ ) {
$params = array_slice( func_get_args(), 1 );
$this->errors[] = array(
'type' => 'warning',
'message' => $message,
'params' => $params );
}
/**
* Add an error, do not set fatal flag
* This can be used for non-fatal errors
*/
function error( $message /*, parameters... */ ) {
$params = array_slice( func_get_args(), 1 );
$this->errors[] = array(
'type' => 'error',
'message' => $message,
'params' => $params );
}
/**
* Add an error and set OK to false, indicating that the operation as a whole was fatal
*/
function fatal( $message /*, parameters... */ ) {
$params = array_slice( func_get_args(), 1 );
$this->errors[] = array(
'type' => 'error',
'message' => $message,
'params' => $params );
$this->ok = false;
}
protected function cleanParams( $params ) {
if ( !$this->cleanCallback ) {
return $params;
}
$cleanParams = array();
foreach ( $params as $i => $param ) {
$cleanParams[$i] = call_user_func( $this->cleanCallback, $param );
}
return $cleanParams;
}
protected function getItemXML( $item ) {
$params = $this->cleanParams( $item['params'] );
$xml = "<{$item['type']}>\n" .
Xml::element( 'message', null, $item['message'] ) . "\n" .
Xml::element( 'text', null, wfMsgReal( $item['message'], $params ) ) ."\n";
foreach ( $params as $param ) {
$xml .= Xml::element( 'param', null, $param );
}
$xml .= "</{$this->type}>\n";
return $xml;
}
/**
* Get the error list as XML
*/
function getXML() {
$xml = "<errors>\n";
foreach ( $this->errors as $error ) {
$xml .= $this->getItemXML( $error );
}
$xml .= "</errors>\n";
return $xml;
}
/**
* Get the error list as a wikitext formatted list
* @param string $shortContext A short enclosing context message name, to be used
* when there is a single error
* @param string $longContext A long enclosing context message name, for a list
*/
function getWikiText( $shortContext = false, $longContext = false ) {
if ( count( $this->errors ) == 0 ) {
if ( $this->ok ) {
$this->fatal( 'internalerror_info',
__METHOD__." called for a good result, this is incorrect\n" );
} else {
$this->fatal( 'internalerror_info',
__METHOD__.": Invalid result object: no error text but not OK\n" );
}
}
if ( count( $this->errors ) == 1 ) {
$params = array_map( 'wfEscapeWikiText', $this->cleanParams( $this->errors[0]['params'] ) );
$s = wfMsgReal( $this->errors[0]['message'], $params, true, false, false );
if ( $shortContext ) {
$s = wfMsgNoTrans( $shortContext, $s );
} elseif ( $longContext ) {
$s = wfMsgNoTrans( $longContext, "* $s\n" );
}
} else {
$s = '';
foreach ( $this->errors as $error ) {
$params = array_map( 'wfEscapeWikiText', $this->cleanParams( $error['params'] ) );
$s .= '* ' . wfMsgReal( $error['message'], $params, true, false, false ) . "\n";
}
if ( $longContext ) {
$s = wfMsgNoTrans( $longContext, $s );
} elseif ( $shortContext ) {
$s = wfMsgNoTrans( $shortContext, "\n* $s\n" );
}
}
return $s;
}
/**
* Merge another status object into this one
*/
function merge( $other, $overwriteValue = false ) {
$this->errors = array_merge( $this->errors, $other->errors );
$this->ok = $this->ok && $other->ok;
if ( $overwriteValue ) {
$this->value = $other->value;
}
$this->successCount += $other->successCount;
$this->failCount += $other->failCount;
}
function getErrorsArray() {
$result = array();
foreach ( $this->errors as $error ) {
if ( $error['type'] == 'error' )
$result[] = $error['message'];
}
return $result;
}
/**
* Returns true if the specified message is present as a warning or error
*/
function hasMessage( $msg ) {
foreach ( $this->errors as $error ) {
if ( $error['message'] === $msg ) {
return true;
}
}
return false;
}
}
|
