MediaWiki REL1_32
FormatJson.php
Go to the documentation of this file.
1<?php
34 const UTF8_OK = 1;
35
46 const XMLMETA_OK = 2;
47
55 const ALL_OK = self::UTF8_OK | self::XMLMETA_OK;
56
63 const FORCE_ASSOC = 0x100;
64
70 const TRY_FIXING = 0x200;
71
77 const STRIP_COMMENTS = 0x400;
78
85 private static $badChars = [
86 "\u{2028}", // U+2028 LINE SEPARATOR
87 "\u{2029}", // U+2029 PARAGRAPH SEPARATOR
88 ];
89
93 private static $badCharsEscaped = [
94 '\u2028', // U+2028 LINE SEPARATOR
95 '\u2029', // U+2029 PARAGRAPH SEPARATOR
96 ];
97
115 public static function encode( $value, $pretty = false, $escaping = 0 ) {
116 if ( !is_string( $pretty ) ) {
117 $pretty = $pretty ? ' ' : false;
118 }
119
120 // PHP escapes '/' to prevent breaking out of inline script blocks using '</script>',
121 // which is hardly useful when '<' and '>' are escaped (and inadequate), and such
122 // escaping negatively impacts the human readability of URLs and similar strings.
123 $options = JSON_UNESCAPED_SLASHES;
124 $options |= $pretty !== false ? JSON_PRETTY_PRINT : 0;
125 $options |= ( $escaping & self::UTF8_OK ) ? JSON_UNESCAPED_UNICODE : 0;
126 $options |= ( $escaping & self::XMLMETA_OK ) ? 0 : ( JSON_HEX_TAG | JSON_HEX_AMP );
127 $json = json_encode( $value, $options );
128 if ( $json === false ) {
129 return false;
130 }
131
132 if ( $pretty !== false && $pretty !== ' ' ) {
133 // Change the four-space indent to a tab indent
134 $json = str_replace( "\n ", "\n\t", $json );
135 while ( strpos( $json, "\t " ) !== false ) {
136 $json = str_replace( "\t ", "\t\t", $json );
137 }
138
139 if ( $pretty !== "\t" ) {
140 // Change the tab indent to the provided indent
141 $json = str_replace( "\t", $pretty, $json );
142 }
143 }
144 if ( $escaping & self::UTF8_OK ) {
145 $json = str_replace( self::$badChars, self::$badCharsEscaped, $json );
146 }
147
148 return $json;
149 }
150
164 public static function decode( $value, $assoc = false ) {
165 return json_decode( $value, $assoc );
166 }
167
178 public static function parse( $value, $options = 0 ) {
179 if ( $options & self::STRIP_COMMENTS ) {
180 $value = self::stripComments( $value );
181 }
182 $assoc = ( $options & self::FORCE_ASSOC ) !== 0;
183 $result = json_decode( $value, $assoc );
184 $code = json_last_error();
185
186 if ( $code === JSON_ERROR_SYNTAX && ( $options & self::TRY_FIXING ) !== 0 ) {
187 // The most common error is the trailing comma in a list or an object.
188 // We cannot simply replace /,\s*[}\]]/ because it could be inside a string value.
189 // But we could use the fact that JSON does not allow multi-line string values,
190 // And remove trailing commas if they are et the end of a line.
191 // JSON only allows 4 control characters: [ \t\r\n]. So we must not use '\s' for matching.
192 // Regex match ,]<any non-quote chars>\n or ,\n] with optional spaces/tabs.
193 $count = 0;
194 $value =
195 preg_replace( '/,([ \t]*[}\]][^"\r\n]*([\r\n]|$)|[ \t]*[\r\n][ \t\r\n]*[}\]])/', '$1',
196 $value, -1, $count );
197 if ( $count > 0 ) {
198 $result = json_decode( $value, $assoc );
199 if ( JSON_ERROR_NONE === json_last_error() ) {
200 // Report warning
201 $st = Status::newGood( $result );
202 $st->warning( wfMessage( 'json-warn-trailing-comma' )->numParams( $count ) );
203 return $st;
204 }
205 }
206 }
207
208 switch ( $code ) {
209 case JSON_ERROR_NONE:
210 return Status::newGood( $result );
211 default:
212 return Status::newFatal( wfMessage( 'json-error-unknown' )->numParams( $code ) );
213 case JSON_ERROR_DEPTH:
214 $msg = 'json-error-depth';
215 break;
216 case JSON_ERROR_STATE_MISMATCH:
217 $msg = 'json-error-state-mismatch';
218 break;
219 case JSON_ERROR_CTRL_CHAR:
220 $msg = 'json-error-ctrl-char';
221 break;
222 case JSON_ERROR_SYNTAX:
223 $msg = 'json-error-syntax';
224 break;
225 case JSON_ERROR_UTF8:
226 $msg = 'json-error-utf8';
227 break;
228 case JSON_ERROR_RECURSION:
229 $msg = 'json-error-recursion';
230 break;
231 case JSON_ERROR_INF_OR_NAN:
232 $msg = 'json-error-inf-or-nan';
233 break;
234 case JSON_ERROR_UNSUPPORTED_TYPE:
235 $msg = 'json-error-unsupported-type';
236 break;
237 }
238 return Status::newFatal( $msg );
239 }
240
249 public static function stripComments( $json ) {
250 // Ensure we have a string
251 $str = (string)$json;
252 $buffer = '';
253 $maxLen = strlen( $str );
254 $mark = 0;
255
256 $inString = false;
257 $inComment = false;
258 $multiline = false;
259
260 for ( $idx = 0; $idx < $maxLen; $idx++ ) {
261 switch ( $str[$idx] ) {
262 case '"':
263 $lookBehind = ( $idx - 1 >= 0 ) ? $str[$idx - 1] : '';
264 if ( !$inComment && $lookBehind !== '\\' ) {
265 // Either started or ended a string
266 $inString = !$inString;
267 }
268 break;
269
270 case '/':
271 $lookAhead = ( $idx + 1 < $maxLen ) ? $str[$idx + 1] : '';
272 $lookBehind = ( $idx - 1 >= 0 ) ? $str[$idx - 1] : '';
273 if ( $inString ) {
274 break;
275
276 } elseif ( !$inComment &&
277 ( $lookAhead === '/' || $lookAhead === '*' )
278 ) {
279 // Transition into a comment
280 // Add characters seen to buffer
281 $buffer .= substr( $str, $mark, $idx - $mark );
282 // Consume the look ahead character
283 $idx++;
284 // Track state
285 $inComment = true;
286 $multiline = $lookAhead === '*';
287
288 } elseif ( $multiline && $lookBehind === '*' ) {
289 // Found the end of the current comment
290 $mark = $idx + 1;
291 $inComment = false;
292 $multiline = false;
293 }
294 break;
295
296 case "\n":
297 if ( $inComment && !$multiline ) {
298 // Found the end of the current comment
299 $mark = $idx + 1;
300 $inComment = false;
301 }
302 break;
303 }
304 }
305 if ( $inComment ) {
306 // Comment ends with input
307 // Technically we should check to ensure that we aren't in
308 // a multiline comment that hasn't been properly ended, but this
309 // is a strip filter, not a validating parser.
310 $mark = $maxLen;
311 }
312 // Add final chunk to buffer before returning
313 return $buffer . substr( $str, $mark, $maxLen - $mark );
314 }
315}
JSON formatter wrapper class.
const UTF8_OK
Skip escaping most characters above U+007F for readability and compactness.
static parse( $value, $options=0)
Decodes a JSON string.
const FORCE_ASSOC
If set, treat JSON objects '{...}' as associative arrays.
const TRY_FIXING
If set, attempt to fix invalid JSON.
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
const STRIP_COMMENTS
If set, strip comments from input before parsing as JSON.
static decode( $value, $assoc=false)
Decodes a JSON string.
static $badChars
Characters problematic in JavaScript.
const ALL_OK
Skip escaping as many characters as reasonably possible.
static $badCharsEscaped
Escape sequences for characters listed in FormatJson::$badChars.
const XMLMETA_OK
Skip escaping the characters '<', '>', and '&', which have special meanings in HTML and XML.
static stripComments( $json)
Remove multiline and single line comments from an otherwise valid JSON input string.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:2042
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition hooks.txt:181
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition hooks.txt:2050
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition hooks.txt:895
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
$buffer