Inline.php 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Yaml;
  11. use Symfony\Component\Yaml\Exception\ParseException;
  12. use Symfony\Component\Yaml\Exception\DumpException;
  13. /**
  14. * Inline implements a YAML parser/dumper for the YAML inline syntax.
  15. *
  16. * @author Fabien Potencier <fabien@symfony.com>
  17. */
  18. class Inline
  19. {
  20. const REGEX_QUOTED_STRING = '(?:"([^"\\\\]*+(?:\\\\.[^"\\\\]*+)*+)"|\'([^\']*+(?:\'\'[^\']*+)*+)\')';
  21. private static $exceptionOnInvalidType = false;
  22. private static $objectSupport = false;
  23. private static $objectForMap = false;
  24. /**
  25. * Converts a YAML string to a PHP value.
  26. *
  27. * @param string $value A YAML string
  28. * @param bool $exceptionOnInvalidType True if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
  29. * @param bool $objectSupport True if object support is enabled, false otherwise
  30. * @param bool $objectForMap True if maps should return a stdClass instead of array()
  31. * @param array $references Mapping of variable names to values
  32. *
  33. * @return mixed A PHP value
  34. *
  35. * @throws ParseException
  36. */
  37. public static function parse($value, $exceptionOnInvalidType = false, $objectSupport = false, $objectForMap = false, $references = array())
  38. {
  39. self::$exceptionOnInvalidType = $exceptionOnInvalidType;
  40. self::$objectSupport = $objectSupport;
  41. self::$objectForMap = $objectForMap;
  42. $value = trim($value);
  43. if ('' === $value) {
  44. return '';
  45. }
  46. if (2 /* MB_OVERLOAD_STRING */ & (int) ini_get('mbstring.func_overload')) {
  47. $mbEncoding = mb_internal_encoding();
  48. mb_internal_encoding('ASCII');
  49. }
  50. $i = 0;
  51. switch ($value[0]) {
  52. case '[':
  53. $result = self::parseSequence($value, $i, $references);
  54. ++$i;
  55. break;
  56. case '{':
  57. $result = self::parseMapping($value, $i, $references);
  58. ++$i;
  59. break;
  60. default:
  61. $result = self::parseScalar($value, null, array('"', "'"), $i, true, $references);
  62. }
  63. // some comments are allowed at the end
  64. if (preg_replace('/\s+#.*$/A', '', substr($value, $i))) {
  65. throw new ParseException(sprintf('Unexpected characters near "%s".', substr($value, $i)));
  66. }
  67. if (isset($mbEncoding)) {
  68. mb_internal_encoding($mbEncoding);
  69. }
  70. return $result;
  71. }
  72. /**
  73. * Dumps a given PHP variable to a YAML string.
  74. *
  75. * @param mixed $value The PHP variable to convert
  76. * @param bool $exceptionOnInvalidType True if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
  77. * @param bool $objectSupport True if object support is enabled, false otherwise
  78. *
  79. * @return string The YAML string representing the PHP value
  80. *
  81. * @throws DumpException When trying to dump PHP resource
  82. */
  83. public static function dump($value, $exceptionOnInvalidType = false, $objectSupport = false)
  84. {
  85. switch (true) {
  86. case is_resource($value):
  87. if ($exceptionOnInvalidType) {
  88. throw new DumpException(sprintf('Unable to dump PHP resources in a YAML file ("%s").', get_resource_type($value)));
  89. }
  90. return 'null';
  91. case is_object($value):
  92. if ($objectSupport) {
  93. return '!php/object:'.serialize($value);
  94. }
  95. if ($exceptionOnInvalidType) {
  96. throw new DumpException('Object support when dumping a YAML file has been disabled.');
  97. }
  98. return 'null';
  99. case is_array($value):
  100. return self::dumpArray($value, $exceptionOnInvalidType, $objectSupport);
  101. case null === $value:
  102. return 'null';
  103. case true === $value:
  104. return 'true';
  105. case false === $value:
  106. return 'false';
  107. case ctype_digit($value):
  108. return is_string($value) ? "'$value'" : (int) $value;
  109. case is_numeric($value):
  110. $locale = setlocale(LC_NUMERIC, 0);
  111. if (false !== $locale) {
  112. setlocale(LC_NUMERIC, 'C');
  113. }
  114. if (is_float($value)) {
  115. $repr = (string) $value;
  116. if (is_infinite($value)) {
  117. $repr = str_ireplace('INF', '.Inf', $repr);
  118. } elseif (floor($value) == $value && $repr == $value) {
  119. // Preserve float data type since storing a whole number will result in integer value.
  120. $repr = '!!float '.$repr;
  121. }
  122. } else {
  123. $repr = is_string($value) ? "'$value'" : (string) $value;
  124. }
  125. if (false !== $locale) {
  126. setlocale(LC_NUMERIC, $locale);
  127. }
  128. return $repr;
  129. case '' == $value:
  130. return "''";
  131. case Escaper::requiresDoubleQuoting($value):
  132. return Escaper::escapeWithDoubleQuotes($value);
  133. case Escaper::requiresSingleQuoting($value):
  134. case Parser::preg_match(self::getHexRegex(), $value):
  135. case Parser::preg_match(self::getTimestampRegex(), $value):
  136. return Escaper::escapeWithSingleQuotes($value);
  137. default:
  138. return $value;
  139. }
  140. }
  141. /**
  142. * Check if given array is hash or just normal indexed array.
  143. *
  144. * @internal
  145. *
  146. * @param array $value The PHP array to check
  147. *
  148. * @return bool true if value is hash array, false otherwise
  149. */
  150. public static function isHash(array $value)
  151. {
  152. $expectedKey = 0;
  153. foreach ($value as $key => $val) {
  154. if ($key !== $expectedKey++) {
  155. return true;
  156. }
  157. }
  158. return false;
  159. }
  160. /**
  161. * Dumps a PHP array to a YAML string.
  162. *
  163. * @param array $value The PHP array to dump
  164. * @param bool $exceptionOnInvalidType True if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
  165. * @param bool $objectSupport True if object support is enabled, false otherwise
  166. *
  167. * @return string The YAML string representing the PHP array
  168. */
  169. private static function dumpArray($value, $exceptionOnInvalidType, $objectSupport)
  170. {
  171. // array
  172. if ($value && !self::isHash($value)) {
  173. $output = array();
  174. foreach ($value as $val) {
  175. $output[] = self::dump($val, $exceptionOnInvalidType, $objectSupport);
  176. }
  177. return sprintf('[%s]', implode(', ', $output));
  178. }
  179. // hash
  180. $output = array();
  181. foreach ($value as $key => $val) {
  182. $output[] = sprintf('%s: %s', self::dump($key, $exceptionOnInvalidType, $objectSupport), self::dump($val, $exceptionOnInvalidType, $objectSupport));
  183. }
  184. return sprintf('{ %s }', implode(', ', $output));
  185. }
  186. /**
  187. * Parses a YAML scalar.
  188. *
  189. * @param string $scalar
  190. * @param string[] $delimiters
  191. * @param string[] $stringDelimiters
  192. * @param int &$i
  193. * @param bool $evaluate
  194. * @param array $references
  195. *
  196. * @return string
  197. *
  198. * @throws ParseException When malformed inline YAML string is parsed
  199. *
  200. * @internal
  201. */
  202. public static function parseScalar($scalar, $delimiters = null, $stringDelimiters = array('"', "'"), &$i = 0, $evaluate = true, $references = array())
  203. {
  204. if (in_array($scalar[$i], $stringDelimiters)) {
  205. // quoted scalar
  206. $output = self::parseQuotedScalar($scalar, $i);
  207. if (null !== $delimiters) {
  208. $tmp = ltrim(substr($scalar, $i), ' ');
  209. if (!in_array($tmp[0], $delimiters)) {
  210. throw new ParseException(sprintf('Unexpected characters (%s).', substr($scalar, $i)));
  211. }
  212. }
  213. } else {
  214. // "normal" string
  215. if (!$delimiters) {
  216. $output = substr($scalar, $i);
  217. $i += strlen($output);
  218. // remove comments
  219. if (Parser::preg_match('/[ \t]+#/', $output, $match, PREG_OFFSET_CAPTURE)) {
  220. $output = substr($output, 0, $match[0][1]);
  221. }
  222. } elseif (Parser::preg_match('/^(.+?)('.implode('|', $delimiters).')/', substr($scalar, $i), $match)) {
  223. $output = $match[1];
  224. $i += strlen($output);
  225. } else {
  226. throw new ParseException(sprintf('Malformed inline YAML string: %s.', $scalar));
  227. }
  228. // a non-quoted string cannot start with @ or ` (reserved) nor with a scalar indicator (| or >)
  229. if ($output && ('@' === $output[0] || '`' === $output[0] || '|' === $output[0] || '>' === $output[0])) {
  230. @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);
  231. // to be thrown in 3.0
  232. // throw new ParseException(sprintf('The reserved indicator "%s" cannot start a plain scalar; you need to quote the scalar.', $output[0]));
  233. }
  234. if ($evaluate) {
  235. $output = self::evaluateScalar($output, $references);
  236. }
  237. }
  238. return $output;
  239. }
  240. /**
  241. * Parses a YAML quoted scalar.
  242. *
  243. * @param string $scalar
  244. * @param int &$i
  245. *
  246. * @return string
  247. *
  248. * @throws ParseException When malformed inline YAML string is parsed
  249. */
  250. private static function parseQuotedScalar($scalar, &$i)
  251. {
  252. if (!Parser::preg_match('/'.self::REGEX_QUOTED_STRING.'/Au', substr($scalar, $i), $match)) {
  253. throw new ParseException(sprintf('Malformed inline YAML string: %s.', substr($scalar, $i)));
  254. }
  255. $output = substr($match[0], 1, strlen($match[0]) - 2);
  256. $unescaper = new Unescaper();
  257. if ('"' == $scalar[$i]) {
  258. $output = $unescaper->unescapeDoubleQuotedString($output);
  259. } else {
  260. $output = $unescaper->unescapeSingleQuotedString($output);
  261. }
  262. $i += strlen($match[0]);
  263. return $output;
  264. }
  265. /**
  266. * Parses a YAML sequence.
  267. *
  268. * @param string $sequence
  269. * @param int &$i
  270. * @param array $references
  271. *
  272. * @return array
  273. *
  274. * @throws ParseException When malformed inline YAML string is parsed
  275. */
  276. private static function parseSequence($sequence, &$i = 0, $references = array())
  277. {
  278. $output = array();
  279. $len = strlen($sequence);
  280. ++$i;
  281. // [foo, bar, ...]
  282. while ($i < $len) {
  283. switch ($sequence[$i]) {
  284. case '[':
  285. // nested sequence
  286. $output[] = self::parseSequence($sequence, $i, $references);
  287. break;
  288. case '{':
  289. // nested mapping
  290. $output[] = self::parseMapping($sequence, $i, $references);
  291. break;
  292. case ']':
  293. return $output;
  294. case ',':
  295. case ' ':
  296. break;
  297. default:
  298. $isQuoted = in_array($sequence[$i], array('"', "'"));
  299. $value = self::parseScalar($sequence, array(',', ']'), array('"', "'"), $i, true, $references);
  300. // the value can be an array if a reference has been resolved to an array var
  301. if (!is_array($value) && !$isQuoted && false !== strpos($value, ': ')) {
  302. // embedded mapping?
  303. try {
  304. $pos = 0;
  305. $value = self::parseMapping('{'.$value.'}', $pos, $references);
  306. } catch (\InvalidArgumentException $e) {
  307. // no, it's not
  308. }
  309. }
  310. $output[] = $value;
  311. --$i;
  312. }
  313. ++$i;
  314. }
  315. throw new ParseException(sprintf('Malformed inline YAML string: %s.', $sequence));
  316. }
  317. /**
  318. * Parses a YAML mapping.
  319. *
  320. * @param string $mapping
  321. * @param int &$i
  322. * @param array $references
  323. *
  324. * @return array|\stdClass
  325. *
  326. * @throws ParseException When malformed inline YAML string is parsed
  327. */
  328. private static function parseMapping($mapping, &$i = 0, $references = array())
  329. {
  330. $output = array();
  331. $len = strlen($mapping);
  332. ++$i;
  333. $allowOverwrite = false;
  334. // {foo: bar, bar:foo, ...}
  335. while ($i < $len) {
  336. switch ($mapping[$i]) {
  337. case ' ':
  338. case ',':
  339. ++$i;
  340. continue 2;
  341. case '}':
  342. if (self::$objectForMap) {
  343. return (object) $output;
  344. }
  345. return $output;
  346. }
  347. // key
  348. $key = self::parseScalar($mapping, array(':', ' '), array('"', "'"), $i, false);
  349. if ('<<' === $key) {
  350. $allowOverwrite = true;
  351. }
  352. // value
  353. $done = false;
  354. while ($i < $len) {
  355. switch ($mapping[$i]) {
  356. case '[':
  357. // nested sequence
  358. $value = self::parseSequence($mapping, $i, $references);
  359. // Spec: Keys MUST be unique; first one wins.
  360. // Parser cannot abort this mapping earlier, since lines
  361. // are processed sequentially.
  362. // But overwriting is allowed when a merge node is used in current block.
  363. if ('<<' === $key) {
  364. foreach ($value as $parsedValue) {
  365. $output += $parsedValue;
  366. }
  367. } elseif ($allowOverwrite || !isset($output[$key])) {
  368. $output[$key] = $value;
  369. }
  370. $done = true;
  371. break;
  372. case '{':
  373. // nested mapping
  374. $value = self::parseMapping($mapping, $i, $references);
  375. // Spec: Keys MUST be unique; first one wins.
  376. // Parser cannot abort this mapping earlier, since lines
  377. // are processed sequentially.
  378. // But overwriting is allowed when a merge node is used in current block.
  379. if ('<<' === $key) {
  380. $output += $value;
  381. } elseif ($allowOverwrite || !isset($output[$key])) {
  382. $output[$key] = $value;
  383. }
  384. $done = true;
  385. break;
  386. case ':':
  387. case ' ':
  388. break;
  389. default:
  390. $value = self::parseScalar($mapping, array(',', '}'), array('"', "'"), $i, true, $references);
  391. // Spec: Keys MUST be unique; first one wins.
  392. // Parser cannot abort this mapping earlier, since lines
  393. // are processed sequentially.
  394. // But overwriting is allowed when a merge node is used in current block.
  395. if ('<<' === $key) {
  396. $output += $value;
  397. } elseif ($allowOverwrite || !isset($output[$key])) {
  398. $output[$key] = $value;
  399. }
  400. $done = true;
  401. --$i;
  402. }
  403. ++$i;
  404. if ($done) {
  405. continue 2;
  406. }
  407. }
  408. }
  409. throw new ParseException(sprintf('Malformed inline YAML string: %s.', $mapping));
  410. }
  411. /**
  412. * Evaluates scalars and replaces magic values.
  413. *
  414. * @param string $scalar
  415. * @param array $references
  416. *
  417. * @return mixed The evaluated YAML string
  418. *
  419. * @throws ParseException when object parsing support was disabled and the parser detected a PHP object or when a reference could not be resolved
  420. */
  421. private static function evaluateScalar($scalar, $references = array())
  422. {
  423. $scalar = trim($scalar);
  424. $scalarLower = strtolower($scalar);
  425. if (0 === strpos($scalar, '*')) {
  426. if (false !== $pos = strpos($scalar, '#')) {
  427. $value = substr($scalar, 1, $pos - 2);
  428. } else {
  429. $value = substr($scalar, 1);
  430. }
  431. // an unquoted *
  432. if (false === $value || '' === $value) {
  433. throw new ParseException('A reference must contain at least one character.');
  434. }
  435. if (!array_key_exists($value, $references)) {
  436. throw new ParseException(sprintf('Reference "%s" does not exist.', $value));
  437. }
  438. return $references[$value];
  439. }
  440. switch (true) {
  441. case 'null' === $scalarLower:
  442. case '' === $scalar:
  443. case '~' === $scalar:
  444. return;
  445. case 'true' === $scalarLower:
  446. return true;
  447. case 'false' === $scalarLower:
  448. return false;
  449. // Optimise for returning strings.
  450. case '+' === $scalar[0] || '-' === $scalar[0] || '.' === $scalar[0] || '!' === $scalar[0] || is_numeric($scalar[0]):
  451. switch (true) {
  452. case 0 === strpos($scalar, '!str'):
  453. return (string) substr($scalar, 5);
  454. case 0 === strpos($scalar, '! '):
  455. return (int) self::parseScalar(substr($scalar, 2));
  456. case 0 === strpos($scalar, '!php/object:'):
  457. if (self::$objectSupport) {
  458. return unserialize(substr($scalar, 12));
  459. }
  460. if (self::$exceptionOnInvalidType) {
  461. throw new ParseException('Object support when parsing a YAML file has been disabled.');
  462. }
  463. return;
  464. case 0 === strpos($scalar, '!!php/object:'):
  465. if (self::$objectSupport) {
  466. return unserialize(substr($scalar, 13));
  467. }
  468. if (self::$exceptionOnInvalidType) {
  469. throw new ParseException('Object support when parsing a YAML file has been disabled.');
  470. }
  471. return;
  472. case 0 === strpos($scalar, '!!float '):
  473. return (float) substr($scalar, 8);
  474. case ctype_digit($scalar):
  475. $raw = $scalar;
  476. $cast = (int) $scalar;
  477. return '0' == $scalar[0] ? octdec($scalar) : (((string) $raw == (string) $cast) ? $cast : $raw);
  478. case '-' === $scalar[0] && ctype_digit(substr($scalar, 1)):
  479. $raw = $scalar;
  480. $cast = (int) $scalar;
  481. return '0' == $scalar[1] ? octdec($scalar) : (((string) $raw === (string) $cast) ? $cast : $raw);
  482. case is_numeric($scalar):
  483. case Parser::preg_match(self::getHexRegex(), $scalar):
  484. return '0x' === $scalar[0].$scalar[1] ? hexdec($scalar) : (float) $scalar;
  485. case '.inf' === $scalarLower:
  486. case '.nan' === $scalarLower:
  487. return -log(0);
  488. case '-.inf' === $scalarLower:
  489. return log(0);
  490. case Parser::preg_match('/^(-|\+)?[0-9,]+(\.[0-9]+)?$/', $scalar):
  491. return (float) str_replace(',', '', $scalar);
  492. case Parser::preg_match(self::getTimestampRegex(), $scalar):
  493. $timeZone = date_default_timezone_get();
  494. date_default_timezone_set('UTC');
  495. $time = strtotime($scalar);
  496. date_default_timezone_set($timeZone);
  497. return $time;
  498. }
  499. // no break
  500. default:
  501. return (string) $scalar;
  502. }
  503. }
  504. /**
  505. * Gets a regex that matches a YAML date.
  506. *
  507. * @return string The regular expression
  508. *
  509. * @see http://www.yaml.org/spec/1.2/spec.html#id2761573
  510. */
  511. private static function getTimestampRegex()
  512. {
  513. return <<<EOF
  514. ~^
  515. (?P<year>[0-9][0-9][0-9][0-9])
  516. -(?P<month>[0-9][0-9]?)
  517. -(?P<day>[0-9][0-9]?)
  518. (?:(?:[Tt]|[ \t]+)
  519. (?P<hour>[0-9][0-9]?)
  520. :(?P<minute>[0-9][0-9])
  521. :(?P<second>[0-9][0-9])
  522. (?:\.(?P<fraction>[0-9]*))?
  523. (?:[ \t]*(?P<tz>Z|(?P<tz_sign>[-+])(?P<tz_hour>[0-9][0-9]?)
  524. (?::(?P<tz_minute>[0-9][0-9]))?))?)?
  525. $~x
  526. EOF;
  527. }
  528. /**
  529. * Gets a regex that matches a YAML number in hexadecimal notation.
  530. *
  531. * @return string
  532. */
  533. private static function getHexRegex()
  534. {
  535. return '~^0x[0-9a-f]++$~i';
  536. }
  537. }