123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\Yaml;
- use Symfony\Component\Yaml\Exception\ParseException;
- use Symfony\Component\Yaml\Exception\DumpException;
- /**
- * Inline implements a YAML parser/dumper for the YAML inline syntax.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- */
- class Inline
- {
- const REGEX_QUOTED_STRING = '(?:"([^"\\\\]*+(?:\\\\.[^"\\\\]*+)*+)"|\'([^\']*+(?:\'\'[^\']*+)*+)\')';
- private static $exceptionOnInvalidType = false;
- private static $objectSupport = false;
- private static $objectForMap = false;
- /**
- * Converts a YAML string to a PHP value.
- *
- * @param string $value A YAML string
- * @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
- * @param bool $objectSupport true if object support is enabled, false otherwise
- * @param bool $objectForMap true if maps should return a stdClass instead of array()
- * @param array $references Mapping of variable names to values
- *
- * @return mixed A PHP value
- *
- * @throws ParseException
- */
- public static function parse($value, $exceptionOnInvalidType = false, $objectSupport = false, $objectForMap = false, $references = array())
- {
- self::$exceptionOnInvalidType = $exceptionOnInvalidType;
- self::$objectSupport = $objectSupport;
- self::$objectForMap = $objectForMap;
- $value = trim($value);
- if ('' === $value) {
- return '';
- }
- if (2 /* MB_OVERLOAD_STRING */ & (int) ini_get('mbstring.func_overload')) {
- $mbEncoding = mb_internal_encoding();
- mb_internal_encoding('ASCII');
- }
- $i = 0;
- switch ($value[0]) {
- case '[':
- $result = self::parseSequence($value, $i, $references);
- ++$i;
- break;
- case '{':
- $result = self::parseMapping($value, $i, $references);
- ++$i;
- break;
- default:
- $result = self::parseScalar($value, null, array('"', "'"), $i, true, $references);
- }
- // some comments are allowed at the end
- if (preg_replace('/\s+#.*$/A', '', substr($value, $i))) {
- throw new ParseException(sprintf('Unexpected characters near "%s".', substr($value, $i)));
- }
- if (isset($mbEncoding)) {
- mb_internal_encoding($mbEncoding);
- }
- return $result;
- }
- /**
- * Dumps a given PHP variable to a YAML string.
- *
- * @param mixed $value The PHP variable to convert
- * @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
- * @param bool $objectSupport true if object support is enabled, false otherwise
- *
- * @return string The YAML string representing the PHP value
- *
- * @throws DumpException When trying to dump PHP resource
- */
- public static function dump($value, $exceptionOnInvalidType = false, $objectSupport = false)
- {
- switch (true) {
- case is_resource($value):
- if ($exceptionOnInvalidType) {
- throw new DumpException(sprintf('Unable to dump PHP resources in a YAML file ("%s").', get_resource_type($value)));
- }
- return 'null';
- case is_object($value):
- if ($objectSupport) {
- return '!php/object:'.serialize($value);
- }
- if ($exceptionOnInvalidType) {
- throw new DumpException('Object support when dumping a YAML file has been disabled.');
- }
- return 'null';
- case is_array($value):
- return self::dumpArray($value, $exceptionOnInvalidType, $objectSupport);
- case null === $value:
- return 'null';
- case true === $value:
- return 'true';
- case false === $value:
- return 'false';
- case ctype_digit($value):
- return is_string($value) ? "'$value'" : (int) $value;
- case is_numeric($value):
- $locale = setlocale(LC_NUMERIC, 0);
- if (false !== $locale) {
- setlocale(LC_NUMERIC, 'C');
- }
- if (is_float($value)) {
- $repr = (string) $value;
- if (is_infinite($value)) {
- $repr = str_ireplace('INF', '.Inf', $repr);
- } elseif (floor($value) == $value && $repr == $value) {
- // Preserve float data type since storing a whole number will result in integer value.
- $repr = '!!float '.$repr;
- }
- } else {
- $repr = is_string($value) ? "'$value'" : (string) $value;
- }
- if (false !== $locale) {
- setlocale(LC_NUMERIC, $locale);
- }
- return $repr;
- case '' == $value:
- return "''";
- case Escaper::requiresDoubleQuoting($value):
- return Escaper::escapeWithDoubleQuotes($value);
- case Escaper::requiresSingleQuoting($value):
- case preg_match(self::getHexRegex(), $value):
- case preg_match(self::getTimestampRegex(), $value):
- return Escaper::escapeWithSingleQuotes($value);
- default:
- return $value;
- }
- }
- /**
- * Check if given array is hash or just normal indexed array.
- *
- * @internal
- *
- * @param array $value The PHP array to check
- *
- * @return bool true if value is hash array, false otherwise
- */
- public static function isHash(array $value)
- {
- $expectedKey = 0;
- foreach ($value as $key => $val) {
- if ($key !== $expectedKey++) {
- return true;
- }
- }
- return false;
- }
- /**
- * Dumps a PHP array to a YAML string.
- *
- * @param array $value The PHP array to dump
- * @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
- * @param bool $objectSupport true if object support is enabled, false otherwise
- *
- * @return string The YAML string representing the PHP array
- */
- private static function dumpArray($value, $exceptionOnInvalidType, $objectSupport)
- {
- // array
- if ($value && !self::isHash($value)) {
- $output = array();
- foreach ($value as $val) {
- $output[] = self::dump($val, $exceptionOnInvalidType, $objectSupport);
- }
- return sprintf('[%s]', implode(', ', $output));
- }
- // hash
- $output = array();
- foreach ($value as $key => $val) {
- $output[] = sprintf('%s: %s', self::dump($key, $exceptionOnInvalidType, $objectSupport), self::dump($val, $exceptionOnInvalidType, $objectSupport));
- }
- return sprintf('{ %s }', implode(', ', $output));
- }
- /**
- * Parses a YAML scalar.
- *
- * @param string $scalar
- * @param string $delimiters
- * @param array $stringDelimiters
- * @param int &$i
- * @param bool $evaluate
- * @param array $references
- *
- * @return string
- *
- * @throws ParseException When malformed inline YAML string is parsed
- *
- * @internal
- */
- public static function parseScalar($scalar, $delimiters = null, $stringDelimiters = array('"', "'"), &$i = 0, $evaluate = true, $references = array())
- {
- if (in_array($scalar[$i], $stringDelimiters)) {
- // quoted scalar
- $output = self::parseQuotedScalar($scalar, $i);
- if (null !== $delimiters) {
- $tmp = ltrim(substr($scalar, $i), ' ');
- if (!in_array($tmp[0], $delimiters)) {
- throw new ParseException(sprintf('Unexpected characters (%s).', substr($scalar, $i)));
- }
- }
- } else {
- // "normal" string
- if (!$delimiters) {
- $output = substr($scalar, $i);
- $i += strlen($output);
- // remove comments
- if (preg_match('/[ \t]+#/', $output, $match, PREG_OFFSET_CAPTURE)) {
- $output = substr($output, 0, $match[0][1]);
- }
- } elseif (preg_match('/^(.+?)('.implode('|', $delimiters).')/', substr($scalar, $i), $match)) {
- $output = $match[1];
- $i += strlen($output);
- } else {
- throw new ParseException(sprintf('Malformed inline YAML string: %s.', $scalar));
- }
- // a non-quoted string cannot start with @ or ` (reserved) nor with a scalar indicator (| or >)
- if ($output && ('@' === $output[0] || '`' === $output[0] || '|' === $output[0] || '>' === $output[0])) {
- @trigger_error(sprintf('Not quoting the scalar "%s" starting with "%s" is deprecated since Symfony 2.8 and will throw a ParseException in 3.0.', $output, $output[0]), E_USER_DEPRECATED);
- // to be thrown in 3.0
- // throw new ParseException(sprintf('The reserved indicator "%s" cannot start a plain scalar; you need to quote the scalar.', $output[0]));
- }
- if ($evaluate) {
- $output = self::evaluateScalar($output, $references);
- }
- }
- return $output;
- }
- /**
- * Parses a YAML quoted scalar.
- *
- * @param string $scalar
- * @param int &$i
- *
- * @return string
- *
- * @throws ParseException When malformed inline YAML string is parsed
- */
- private static function parseQuotedScalar($scalar, &$i)
- {
- if (!preg_match('/'.self::REGEX_QUOTED_STRING.'/Au', substr($scalar, $i), $match)) {
- throw new ParseException(sprintf('Malformed inline YAML string: %s.', substr($scalar, $i)));
- }
- $output = substr($match[0], 1, strlen($match[0]) - 2);
- $unescaper = new Unescaper();
- if ('"' == $scalar[$i]) {
- $output = $unescaper->unescapeDoubleQuotedString($output);
- } else {
- $output = $unescaper->unescapeSingleQuotedString($output);
- }
- $i += strlen($match[0]);
- return $output;
- }
- /**
- * Parses a YAML sequence.
- *
- * @param string $sequence
- * @param int &$i
- * @param array $references
- *
- * @return array
- *
- * @throws ParseException When malformed inline YAML string is parsed
- */
- private static function parseSequence($sequence, &$i = 0, $references = array())
- {
- $output = array();
- $len = strlen($sequence);
- ++$i;
- // [foo, bar, ...]
- while ($i < $len) {
- switch ($sequence[$i]) {
- case '[':
- // nested sequence
- $output[] = self::parseSequence($sequence, $i, $references);
- break;
- case '{':
- // nested mapping
- $output[] = self::parseMapping($sequence, $i, $references);
- break;
- case ']':
- return $output;
- case ',':
- case ' ':
- break;
- default:
- $isQuoted = in_array($sequence[$i], array('"', "'"));
- $value = self::parseScalar($sequence, array(',', ']'), array('"', "'"), $i, true, $references);
- // the value can be an array if a reference has been resolved to an array var
- if (!is_array($value) && !$isQuoted && false !== strpos($value, ': ')) {
- // embedded mapping?
- try {
- $pos = 0;
- $value = self::parseMapping('{'.$value.'}', $pos, $references);
- } catch (\InvalidArgumentException $e) {
- // no, it's not
- }
- }
- $output[] = $value;
- --$i;
- }
- ++$i;
- }
- throw new ParseException(sprintf('Malformed inline YAML string: %s.', $sequence));
- }
- /**
- * Parses a YAML mapping.
- *
- * @param string $mapping
- * @param int &$i
- * @param array $references
- *
- * @return array|\stdClass
- *
- * @throws ParseException When malformed inline YAML string is parsed
- */
- private static function parseMapping($mapping, &$i = 0, $references = array())
- {
- $output = array();
- $len = strlen($mapping);
- ++$i;
- // {foo: bar, bar:foo, ...}
- while ($i < $len) {
- switch ($mapping[$i]) {
- case ' ':
- case ',':
- ++$i;
- continue 2;
- case '}':
- if (self::$objectForMap) {
- return (object) $output;
- }
- return $output;
- }
- // key
- $key = self::parseScalar($mapping, array(':', ' '), array('"', "'"), $i, false);
- // value
- $done = false;
- while ($i < $len) {
- switch ($mapping[$i]) {
- case '[':
- // nested sequence
- $value = self::parseSequence($mapping, $i, $references);
- // Spec: Keys MUST be unique; first one wins.
- // Parser cannot abort this mapping earlier, since lines
- // are processed sequentially.
- if (!isset($output[$key])) {
- $output[$key] = $value;
- }
- $done = true;
- break;
- case '{':
- // nested mapping
- $value = self::parseMapping($mapping, $i, $references);
- // Spec: Keys MUST be unique; first one wins.
- // Parser cannot abort this mapping earlier, since lines
- // are processed sequentially.
- if (!isset($output[$key])) {
- $output[$key] = $value;
- }
- $done = true;
- break;
- case ':':
- case ' ':
- break;
- default:
- $value = self::parseScalar($mapping, array(',', '}'), array('"', "'"), $i, true, $references);
- // Spec: Keys MUST be unique; first one wins.
- // Parser cannot abort this mapping earlier, since lines
- // are processed sequentially.
- if (!isset($output[$key])) {
- $output[$key] = $value;
- }
- $done = true;
- --$i;
- }
- ++$i;
- if ($done) {
- continue 2;
- }
- }
- }
- throw new ParseException(sprintf('Malformed inline YAML string: %s.', $mapping));
- }
- /**
- * Evaluates scalars and replaces magic values.
- *
- * @param string $scalar
- * @param array $references
- *
- * @return string A YAML string
- *
- * @throws ParseException when object parsing support was disabled and the parser detected a PHP object or when a reference could not be resolved
- */
- private static function evaluateScalar($scalar, $references = array())
- {
- $scalar = trim($scalar);
- $scalarLower = strtolower($scalar);
- if (0 === strpos($scalar, '*')) {
- if (false !== $pos = strpos($scalar, '#')) {
- $value = substr($scalar, 1, $pos - 2);
- } else {
- $value = substr($scalar, 1);
- }
- // an unquoted *
- if (false === $value || '' === $value) {
- throw new ParseException('A reference must contain at least one character.');
- }
- if (!array_key_exists($value, $references)) {
- throw new ParseException(sprintf('Reference "%s" does not exist.', $value));
- }
- return $references[$value];
- }
- switch (true) {
- case 'null' === $scalarLower:
- case '' === $scalar:
- case '~' === $scalar:
- return;
- case 'true' === $scalarLower:
- return true;
- case 'false' === $scalarLower:
- return false;
- // Optimise for returning strings.
- case $scalar[0] === '+' || $scalar[0] === '-' || $scalar[0] === '.' || $scalar[0] === '!' || is_numeric($scalar[0]):
- switch (true) {
- case 0 === strpos($scalar, '!str'):
- return (string) substr($scalar, 5);
- case 0 === strpos($scalar, '! '):
- return (int) self::parseScalar(substr($scalar, 2));
- case 0 === strpos($scalar, '!php/object:'):
- if (self::$objectSupport) {
- return unserialize(substr($scalar, 12));
- }
- if (self::$exceptionOnInvalidType) {
- throw new ParseException('Object support when parsing a YAML file has been disabled.');
- }
- return;
- case 0 === strpos($scalar, '!!php/object:'):
- if (self::$objectSupport) {
- return unserialize(substr($scalar, 13));
- }
- if (self::$exceptionOnInvalidType) {
- throw new ParseException('Object support when parsing a YAML file has been disabled.');
- }
- return;
- case 0 === strpos($scalar, '!!float '):
- return (float) substr($scalar, 8);
- case ctype_digit($scalar):
- $raw = $scalar;
- $cast = (int) $scalar;
- return '0' == $scalar[0] ? octdec($scalar) : (((string) $raw == (string) $cast) ? $cast : $raw);
- case '-' === $scalar[0] && ctype_digit(substr($scalar, 1)):
- $raw = $scalar;
- $cast = (int) $scalar;
- return '0' == $scalar[1] ? octdec($scalar) : (((string) $raw === (string) $cast) ? $cast : $raw);
- case is_numeric($scalar):
- case preg_match(self::getHexRegex(), $scalar):
- return '0x' === $scalar[0].$scalar[1] ? hexdec($scalar) : (float) $scalar;
- case '.inf' === $scalarLower:
- case '.nan' === $scalarLower:
- return -log(0);
- case '-.inf' === $scalarLower:
- return log(0);
- case preg_match('/^(-|\+)?[0-9,]+(\.[0-9]+)?$/', $scalar):
- return (float) str_replace(',', '', $scalar);
- case preg_match(self::getTimestampRegex(), $scalar):
- $timeZone = date_default_timezone_get();
- date_default_timezone_set('UTC');
- $time = strtotime($scalar);
- date_default_timezone_set($timeZone);
- return $time;
- }
- default:
- return (string) $scalar;
- }
- }
- /**
- * Gets a regex that matches a YAML date.
- *
- * @return string The regular expression
- *
- * @see http://www.yaml.org/spec/1.2/spec.html#id2761573
- */
- private static function getTimestampRegex()
- {
- return <<<EOF
- ~^
- (?P<year>[0-9][0-9][0-9][0-9])
- -(?P<month>[0-9][0-9]?)
- -(?P<day>[0-9][0-9]?)
- (?:(?:[Tt]|[ \t]+)
- (?P<hour>[0-9][0-9]?)
- :(?P<minute>[0-9][0-9])
- :(?P<second>[0-9][0-9])
- (?:\.(?P<fraction>[0-9]*))?
- (?:[ \t]*(?P<tz>Z|(?P<tz_sign>[-+])(?P<tz_hour>[0-9][0-9]?)
- (?::(?P<tz_minute>[0-9][0-9]))?))?)?
- $~x
- EOF;
- }
- /**
- * Gets a regex that matches a YAML number in hexadecimal notation.
- *
- * @return string
- */
- private static function getHexRegex()
- {
- return '~^0x[0-9a-f]++$~i';
- }
- }
|