Skip to content

Commit

Permalink
Move recursive transcoder from json_encode() into src/Extension/Defau…
Browse files Browse the repository at this point in the history 
…ltExtension/RecursiveTranscoder.php
  • Loading branch information
@cmanley
cmanley committed Jun 1, 2024
1 parent ef2fa74 commit cbbb244
Show file tree
Hide file tree
Showing 4 changed files with 153 additions and 65 deletions.
69 changes: 6 additions & 63 deletions src/Extension/DefaultExtension.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -628,71 +628,14 @@ public function smarty_modifier_json_encode($value, $flags = 0, string $input_en
if (is_string($value)) { # shortcut for the most common case
$value = mb_convert_encoding($value, 'UTF-8', $input_encoding);
}
elseif (is_array($value) || is_object($value)) {
static $transcoder; # this closure will be assigned once, and then persist in memory
if (is_null($transcoder)) {
/**
* Similar to mb_convert_encoding(), but operates on keys and values of arrays, and on objects too.
* Objects implementing \JsonSerializable and unsupported types are returned unchanged.
*
* @param string $from_encoding
* @param string $to_encoding
* @param mixed $data
* @return mixed
*/
$transcoder = function($data, string $to_encoding, string $from_encoding) use(&$transcoder) {
if (empty($data)) {
return $data;
}
elseif (is_string($data)) {
return mb_convert_encoding($data, $to_encoding, $from_encoding);
}
elseif (is_scalar($data)) {
return $data;
}

# convert object to array if necessary
if (is_object($data)) {
if (is_a($data, \JsonSerializable::class)) { # this is the only reason why this function is not generic
return $data;
}
$data = get_object_vars($data); # public properties as key => value pairs
}

if (is_array($data)) {
$result = [];
foreach ($data as $k => $v) {
if (is_string($k)) {
$k = mb_convert_encoding($k, $to_encoding, $from_encoding);
if ($k === false) {
return false;
}
}
if (empty($v) || (is_scalar($v) && !is_string($v))) {
$result[$k] = $v; # $v can be false and that's not an error
}
else {
# recurse
$v = $transcoder($v, $to_encoding, $from_encoding);
if ($v === false) {
return false;
}
$result[$k] = $v;
}
}
return $result;
}

return $data; # anything except string, object, or array
}; # / $transcoder function
} # / if is_null($transcoder)

$value = $transcoder($value, 'UTF-8', $input_encoding);
elseif (DefaultExtension\RecursiveTranscoder::is_transcoding_candidate($value)) {
$value = DefaultExtension\RecursiveTranscoder::transcode($value, 'UTF-8', $input_encoding, ['ignore_JsonSerializable_objects' => true]);
if ($value === false) {
return $value; # failure; this must not be passed to json_encode!; this is part of what the !empty() check is for at the top of this block
# If transcode() throws an exception on failure, then the interpreter will never arrive here
return false; # failure
}
} # / elseif (is_array($value) || is_object($value))
} # / if input encoding != UTF-8
}
}

return \json_encode($value, $flags); # string|false
}
Expand Down
138 changes: 138 additions & 0 deletions src/Extension/DefaultExtension/RecursiveTranscoder.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
<?php declare(strict_types=1);

namespace Smarty\Extension\DefaultExtension;

use Smarty\Exception;

class RecursiveTranscoder {

/**
* Determines if the given value is a possible candidate for transcoding.
*
* @param mixed $value
* @return bool
*/
public static function is_transcoding_candidate($value): bool {
if (empty($value)) {
return false;
}
return is_string($value) || is_array($value) || is_object($value);
}


/**
* Similar to mb_convert_encoding(), but operates recursively on keys and values of arrays, and on objects too.
* Objects implementing \JsonSerializable and unsupported types are returned unchanged.
* The following boolean options/hints are supported (all default to false):
* - ignore_keys: do not transcode array keys
* - ignore_objects: leave objects alone, i.e. do not convert them into associative arrays and transcode them
* - ignore_JsonSerializable_objects: if transcoded result is meant as input for json_encode(), then set this to true.
*
* @param mixed $data
* @param string $to_encoding
* @param string $from_encoding of $data; defaults to \Smarty\Smarty::$_CHARSET
* @param array $options
* @return mixed
*/
public static function transcode($data, string $to_encoding, string $from_encoding = null, array $options = null) {
$debug = !empty($options['debug']);
#$debug = true;
$debug && error_log(__METHOD__ . ' entered with $data type ' . gettype($data));
if (!static::is_transcoding_candidate($data)) {
$debug && error_log(__METHOD__ . ' return $data unchanged since it is not a transcoding candidate');
return $data;
}
if (!$from_encoding) {
$from_encoding = \Smarty\Smarty::$_CHARSET;
}
if (strcasecmp($to_encoding, $from_encoding) == 0) {
$debug && error_log(__METHOD__ . ' return $data unchanged since to_encoding = from_encoding');
return $data;
}

# most cases:
if (is_string($data)) {
$debug && error_log(__METHOD__ . ' return mb_convert_encoding string $data');
return mb_convert_encoding($data, $to_encoding, $from_encoding); # string|false
}

# convert object to array to be transcoded as array
if (is_object($data)) {
if (!empty($options['ignore_objects'])) {
$debug && error_log(__METHOD__ . ' return object unchanged since ignore_objects is true');
return $data;
}
if (is_a($data, \JsonSerializable::class)) {
if (!empty($options['ignore_JsonSerializable_objects'])) {
$debug && error_log(__METHOD__ . ' return JsonSerializable object unchanged since ignore_JsonSerializable_objects is true');
return $data; # \JsonSerializable objects should be trusted to serialize themselves into data that can be consumed by json_encode() no matter what the application's default encoding is.
}
#$debug && error_log(__METHOD__ . ' call jsonSerialize() on JsonSerializable object');
#$data = $data->jsonSerialize(); # mixed
#if (!is_array($data)) {
# $debug && error_log(__METHOD__ . ' return non-array jsonSerialize() on JsonSerializable object');
# return $data;
#}
}
$debug && error_log(__METHOD__ . ' convert object to array');
$data = get_object_vars($data); # public properties as key => value pairs
}

if (!(is_array($data) && $data)) {
$debug && error_log(__METHOD__ . ' return non-array or empty empty');
return $data; # any empty array or non-array type as a possible result of object conversion above
}

# $data is a filled array
$must_transcode_keys = empty($options['ignore_keys']);
$debug && error_log(__METHOD__ . " process filled array (must_transcode_keys == $must_transcode_keys)");
$result = []; # replacement for $data if keys are transcoded too (i.e. $must_transcode_keys)
$this_func = __FUNCTION__; # for recursion
foreach ($data as $k => &$v) {
if ($must_transcode_keys && is_string($k)) {
$converted_k = mb_convert_encoding($k, $to_encoding, $from_encoding); # string|false
$debug && error_log(__METHOD__ . "\tconverted key \"$k\" to \"$converted_k\"");
if ($converted_k === false) { # this means mb_convert_encoding() failed which should've triggered a warning
# One of three things can be done here:
# 1. throw an Exception
# 2. return false, indicating to caller that mb_convert_encoding() failed
# 3. do nothing and use the original key
#return false;
throw Exception("Failed to encode array key \"$k\" from $from_encoding to $to_encoding");
}
else {
$k = $converted_k;
}
}
if (static::is_transcoding_candidate($v)) {
$debug && error_log(__METHOD__ . "\trecurse for " . gettype($value) . ' value that is a transcoding candidate');
# recurse
$converted_v = static::$this_func($v, $to_encoding, $from_encoding, $options);
if ($converted_v === false) { # this means that $v is a string and that mb_convert_encoding() failed, which should've triggered a warning
# One of four things can be done here:
# 1. throw an Exception
# 2. return false, indicating to caller that mb_convert_encoding() failed
# 3. do nothing and use the original value
# 4. replace the original value with false
#return false;
throw Exception('Failed to encode array value' . (is_string($v) ? " \"$k\"" : '') . 'of type ' . gettype($v) . " from $from_encoding to $to_encoding");
}
else {
$v = $converted_v;
if ($must_transcode_keys) {
$result[$k] = $v;
}
}
}
else {
# $v may be false here, and in this case it is not an error (since no transcoding occurred since it's not a transcoding candidate)
if ($must_transcode_keys) {
$result[$k] = $v;
}
}
unset($v);
}
return $must_transcode_keys ? $result : $data;
}

}
9 changes: 8 additions & 1 deletion ...s/UnitTests/TemplateSource/TagTests/PluginModifier/PluginModifierJsonEncodeCp1252Test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,18 @@ public function testDefaultAsFunction($value, $expected)
}

public function dataForDefault() {
$json_serializable_object = new class() implements \JsonSerializable {
public function jsonSerialize(): mixed {
return ["Schl\xC3\xBCssel" => "Stra\xC3\x9Fe"]; # UTF-8 ready for json_encode(); to prove that transcoding doesn't attempt to transcode this again
#return ['Schlüssel' => 'Straße']; # alternatively, this can be used, but then this file must always be saved in UTF-8 encoding or else the test will fail.
}
};
return [
["abc", '"abc"'],
[["abc"], '["abc"]'],
[["abc",["a"=>2]], '["abc",{"a":2}]'],
[["\x80uro",["Schl\xFCssel"=>"Stra\xDFe"]], '["\u20acuro",{"Schl\u00fcssel":"Stra\u00dfe"}]'], # x80 = � = euro, xFC = � = uuml, xDF = � = szlig
[["\x80uro",["Schl\xFCssel"=>"Stra\xDFe"]], '["\u20acuro",{"Schl\u00fcssel":"Stra\u00dfe"}]'], # x80 = € = euro, xFC = ü = uuml, xDF = ß = szlig
[$json_serializable_object, '{"Schl\u00fcssel":"Stra\u00dfe"}'],
];
}

Expand Down
2 changes: 1 addition & 1 deletion tests/UnitTests/TemplateSource/TagTests/PluginModifier/PluginModifierJsonEncodeTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public function dataForDefault() {
["abc", '"abc"'],
[["abc"], '["abc"]'],
[["abc",["a"=>2]], '["abc",{"a":2}]'],
[["€uro",["Schlüssel"=>"Straße"]], '["\u20acuro",{"Schl\u00fcssel":"Stra\u00dfe"}]'], # \u{20ac} = € = euro, \u{00fc} = ü = uuml, xDF = \u{00df} = szlig
[["€uro",["Schlüssel"=>"Straße"]], '["\u20acuro",{"Schl\u00fcssel":"Stra\u00dfe"}]'], # \u{20ac} = € = euro, \u{00fc} = ü = uuml, \u{00df} = ß = szlig
];
}

Expand Down

0 comments on commit cbbb244

Please sign in to comment.