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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
<?php
/**
* JSON Content Model
*
* @file
*
* @author Ori Livneh <ori@wikimedia.org>
* @author Kunal Mehta <legoktm@gmail.com>
*/
/**
* Represents the content of a JSON content.
* @since 1.24
*/
class JsonContent extends TextContent {
/**
* @since 1.25
* @var Status
*/
protected $jsonParse;
/**
* @param string $text JSON
*/
public function __construct( $text, $modelId = CONTENT_MODEL_JSON ) {
parent::__construct( $text, $modelId );
}
/**
* Decodes the JSON into a PHP associative array.
*
* @deprecated since 1.25 Use getData instead.
* @return array|null
*/
public function getJsonData() {
wfDeprecated( __METHOD__, '1.25' );
return FormatJson::decode( $this->getNativeData(), true );
}
/**
* Decodes the JSON string.
*
* Note that this parses it without casting objects to associative arrays.
* Objects and arrays are kept as distinguishable types in the PHP values.
*
* @return Status
*/
public function getData() {
if ( $this->jsonParse === null ) {
$this->jsonParse = FormatJson::parse( $this->getNativeData() );
}
return $this->jsonParse;
}
/**
* @return bool Whether content is valid.
*/
public function isValid() {
return $this->getData()->isGood();
}
/**
* Pretty-print JSON.
*
* If called before validation, it may return JSON "null".
*
* @return string
*/
public function beautifyJSON() {
return FormatJson::encode( $this->getData()->getValue(), true, FormatJson::UTF8_OK );
}
/**
* Beautifies JSON prior to save.
*
* @param Title $title Title
* @param User $user User
* @param ParserOptions $popts
* @return JsonContent
*/
public function preSaveTransform( Title $title, User $user, ParserOptions $popts ) {
// FIXME: WikiPage::doEditContent invokes PST before validation. As such, native data
// may be invalid (though PST result is discarded later in that case).
if ( !$this->isValid() ) {
return $this;
}
return new static( $this->beautifyJSON() );
}
/**
* Set the HTML and add the appropriate styles.
*
* @param Title $title
* @param int $revId
* @param ParserOptions $options
* @param bool $generateHtml
* @param ParserOutput $output
*/
protected function fillParserOutput( Title $title, $revId,
ParserOptions $options, $generateHtml, ParserOutput &$output
) {
// FIXME: WikiPage::doEditContent generates parser output before validation.
// As such, native data may be invalid (though output is discarded later in that case).
if ( $generateHtml && $this->isValid() ) {
$output->setText( $this->rootValueTable( $this->getData()->getValue() ) );
$output->addModuleStyles( 'mediawiki.content.json' );
} else {
$output->setText( '' );
}
}
/**
* Construct HTML table representation of any JSON value.
*
* See also valueCell, which is similar.
*
* @param mixed $val
* @return string HTML.
*/
protected function rootValueTable( $val ) {
if ( is_object( $val ) ) {
return self::objectTable( $val );
}
if ( is_array( $val ) ) {
// Wrap arrays in another array so that they're visually boxed in a container.
// Otherwise they are visually indistinguishable from a single value.
return self::arrayTable( array( $val ) );
}
return Html::rawElement( 'table', array( 'class' => 'mw-json mw-json-single-value' ),
Html::rawElement( 'tbody', array(),
Html::rawElement( 'tr', array(),
Html::element( 'td', array(), self::primitiveValue( $val ) )
)
)
);
}
/**
* Create HTML table representing a JSON object.
*
* @param stdClass $mapping
* @return string HTML
*/
protected function objectTable( $mapping ) {
$rows = array();
$empty = true;
foreach ( $mapping as $key => $val ) {
$rows[] = $this->objectRow( $key, $val );
$empty = false;
}
if ( $empty ) {
$rows[] = Html::rawElement( 'tr', array(),
Html::element( 'td', array( 'class' => 'mw-json-empty' ),
wfMessage( 'content-json-empty-object' )->text()
)
);
}
return Html::rawElement( 'table', array( 'class' => 'mw-json' ),
Html::rawElement( 'tbody', array(), join( '', $rows ) )
);
}
/**
* Create HTML table row representing one object property.
*
* @param string $key
* @param mixed $val
* @return string HTML.
*/
protected function objectRow( $key, $val ) {
$th = Html::element( 'th', array(), $key );
$td = self::valueCell( $val );
return Html::rawElement( 'tr', array(), $th . $td );
}
/**
* Create HTML table representing a JSON array.
*
* @param array $mapping
* @return string HTML
*/
protected function arrayTable( $mapping ) {
$rows = array();
$empty = true;
foreach ( $mapping as $val ) {
$rows[] = $this->arrayRow( $val );
$empty = false;
}
if ( $empty ) {
$rows[] = Html::rawElement( 'tr', array(),
Html::element( 'td', array( 'class' => 'mw-json-empty' ),
wfMessage( 'content-json-empty-array' )->text()
)
);
}
return Html::rawElement( 'table', array( 'class' => 'mw-json' ),
Html::rawElement( 'tbody', array(), join( "\n", $rows ) )
);
}
/**
* Create HTML table row representing the value in an array.
*
* @param mixed $val
* @return string HTML.
*/
protected function arrayRow( $val ) {
$td = self::valueCell( $val );
return Html::rawElement( 'tr', array(), $td );
}
/**
* Construct HTML table cell representing any JSON value.
*
* @param mixed $val
* @return string HTML.
*/
protected function valueCell( $val ) {
if ( is_object( $val ) ) {
return Html::rawElement( 'td', array(), self::objectTable( $val ) );
}
if ( is_array( $val ) ) {
return Html::rawElement( 'td', array(), self::arrayTable( $val ) );
}
return Html::element( 'td', array( 'class' => 'value' ), self::primitiveValue( $val ) );
}
/**
* Construct text representing a JSON primitive value.
*
* @param mixed $val
* @return string Text.
*/
protected function primitiveValue( $val ) {
if ( is_string( $val ) ) {
// Don't FormatJson::encode for strings since we want quotes
// and new lines to render visually instead of escaped.
return '"' . $val . '"';
}
return FormatJson::encode( $val );
}
}
|
