FormatJson.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Json;
 
use MediaWiki\Message\Message;
use MediaWiki\Status\Status;
 
class FormatJson {
    public const UTF8_OK = 1;
 
    public const XMLMETA_OK = 2;
 
    public const ALL_OK = self::UTF8_OK | self::XMLMETA_OK;
 
    public const FORCE_ASSOC = 0x100;
 
    public const TRY_FIXING = 0x200;
 
    public const STRIP_COMMENTS = 0x400;
 
    public static function encode( $value, $pretty = false, $escaping = 0 ) {
        // PHP escapes '/' to prevent breaking out of inline script blocks using '</script>',
        // which is hardly useful when '<' and '>' are escaped (and inadequate), and such
        // escaping negatively impacts the human readability of URLs and similar strings.
        $options = JSON_UNESCAPED_SLASHES;
        if ( $pretty || is_string( $pretty ) ) {
            $options |= JSON_PRETTY_PRINT;
        }
        if ( $escaping & self::UTF8_OK ) {
            $options |= JSON_UNESCAPED_UNICODE;
        }
        if ( !( $escaping & self::XMLMETA_OK ) ) {
            $options |= JSON_HEX_TAG | JSON_HEX_AMP;
        }
        $json = json_encode( $value, $options );
 
        if ( is_string( $pretty ) && $pretty !== '    ' && $json !== false ) {
            // Change the four-space indent to the provided indent.
            // The regex matches four spaces either at the start of a line or immediately
            // after the previous match. $pretty should contain only whitespace characters,
            // so there should be no need to call StringUtils::escapeRegexReplacement().
            $json = preg_replace( '/ {4}|.*+\n\K {4}/A', $pretty, $json );
        }
 
        return $json;
    }
 
    public static function decode( $value, $assoc = false ) {
        return json_decode( $value, $assoc );
    }
 
    public static function parse( $value, $options = 0 ) {
        if ( $options & self::STRIP_COMMENTS ) {
            $value = self::stripComments( $value );
        }
        $assoc = ( $options & self::FORCE_ASSOC ) !== 0;
        $result = json_decode( $value, $assoc );
        $code = json_last_error();
 
        if ( $code === JSON_ERROR_SYNTAX && ( $options & self::TRY_FIXING ) !== 0 ) {
            // The most common error is the trailing comma in a list or an object.
            // We cannot simply replace /,\s*[}\]]/ because it could be inside a string value.
            // But we could use the fact that JSON does not allow multi-line string values,
            // And remove trailing commas if they are et the end of a line.
            // JSON only allows 4 control characters: [ \t\r\n].  So we must not use '\s' for matching.
            // Regex match   ,]<any non-quote chars>\n   or   ,\n]   with optional spaces/tabs.
            $count = 0;
            $value =
                preg_replace( '/,([ \t]*[}\]][^"\r\n]*([\r\n]|$)|[ \t]*[\r\n][ \t\r\n]*[}\]])/', '$1',
                    $value, -1, $count );
            if ( $count > 0 ) {
                $result = json_decode( $value, $assoc );
                if ( json_last_error() === JSON_ERROR_NONE ) {
                    // Report warning
                    return Status::newGood( $result )->warning(
                        'json-warn-trailing-comma',
                        Message::numParam( $count )
                    );
                }
            }
        }
 
        // JSON_ERROR_RECURSION, JSON_ERROR_INF_OR_NAN, JSON_ERROR_UNSUPPORTED_TYPE,
        // are all encode errors that we don't need to care about here.
        switch ( $code ) {
            case JSON_ERROR_NONE:
                return Status::newGood( $result );
            default:
                return Status::newFatal( 'json-error-unknown', Message::numParam( $code ) );
            case JSON_ERROR_DEPTH:
                $msg = 'json-error-depth';
                break;
            case JSON_ERROR_STATE_MISMATCH:
                $msg = 'json-error-state-mismatch';
                break;
            case JSON_ERROR_CTRL_CHAR:
                $msg = 'json-error-ctrl-char';
                break;
            case JSON_ERROR_SYNTAX:
                $msg = 'json-error-syntax';
                break;
            case JSON_ERROR_UTF8:
                $msg = 'json-error-utf8';
                break;
            case JSON_ERROR_INVALID_PROPERTY_NAME:
                $msg = 'json-error-invalid-property-name';
                break;
            case JSON_ERROR_UTF16:
                $msg = 'json-error-utf16';
                break;
        }
        return Status::newFatal( $msg );
    }
 
    public static function stripComments( $json ) {
        // Ensure we have a string
        $str = (string)$json;
        $buffer = '';
        $maxLen = strlen( $str );
        $mark = 0;
 
        $inString = false;
        $inComment = false;
        $multiline = false;
 
        for ( $idx = 0; $idx < $maxLen; $idx++ ) {
            switch ( $str[$idx] ) {
                case '"':
                    $lookBehind = ( $idx - 1 >= 0 ) ? $str[$idx - 1] : '';
                    if ( !$inComment && $lookBehind !== '\\' ) {
                        // Either started or ended a string
                        $inString = !$inString;
                    }
                    break;
 
                case '/':
                    $lookAhead = ( $idx + 1 < $maxLen ) ? $str[$idx + 1] : '';
                    $lookBehind = ( $idx - 1 >= 0 ) ? $str[$idx - 1] : '';
                    if ( $inString ) {
                        break;
 
                    } elseif ( !$inComment &&
                        ( $lookAhead === '/' || $lookAhead === '*' )
                    ) {
                        // Transition into a comment
                        // Add characters seen to buffer
                        $buffer .= substr( $str, $mark, $idx - $mark );
                        // Consume the look ahead character
                        $idx++;
                        // Track state
                        $inComment = true;
                        $multiline = $lookAhead === '*';
 
                    } elseif ( $multiline && $lookBehind === '*' ) {
                        // Found the end of the current comment
                        $mark = $idx + 1;
                        $inComment = false;
                        $multiline = false;
                    }
                    break;
 
                case "\n":
                    if ( $inComment && !$multiline ) {
                        // Found the end of the current comment
                        $mark = $idx + 1;
                        $inComment = false;
                    }
                    break;
            }
        }
        if ( $inComment ) {
            // Comment ends with input
            // Technically we should check to ensure that we aren't in
            // a multiline comment that hasn't been properly ended, but this
            // is a strip filter, not a validating parser.
            $mark = $maxLen;
        }
        // Add final chunk to buffer before returning
        return $buffer . substr( $str, $mark, $maxLen - $mark );
    }
}
class_alias( FormatJson::class, 'FormatJson' );