vendor/symfony/yaml/Parser.php line 401

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Yaml;
  14. use Symfony\Component\Yaml\Exception\ParseException;
  15. use Symfony\Component\Yaml\Tag\TaggedValue;
  17. /**
  18.  * Parser parses YAML strings to convert them to PHP arrays.
  19.  *
  20.  * @author Fabien Potencier <fabien@symfony.com>
  21.  *
  22.  * @final since version 3.4
  23.  */
  24. class Parser
  25. {
  26.     const TAG_PATTERN = '(?P<tag>![\w!.\/:-]+)';
  27.     const BLOCK_SCALAR_HEADER_PATTERN = '(?P<separator>\||>)(?P<modifiers>\+|\-|\d+|\+\d+|\-\d+|\d+\+|\d+\-)?(?P<comments> +#.*)?';
  29.     private $filename;
  30.     private $offset = 0;
  31.     private $totalNumberOfLines;
  32.     private $lines = [];
  33.     private $currentLineNb = -1;
  34.     private $currentLine = '';
  35.     private $refs = [];
  36.     private $skippedLineNumbers = [];
  37.     private $locallySkippedLineNumbers = [];
  38.     private $refsBeingParsed = [];
  40.     public function __construct()
  41.     {
  42.         if (\func_num_args() > 0) {
  43.             @trigger_error(sprintf('The constructor arguments $offset, $totalNumberOfLines, $skippedLineNumbers of %s are deprecated and will be removed in 4.0', self::class), E_USER_DEPRECATED);
  45.             $this->offset = func_get_arg(0);
  46.             if (\func_num_args() > 1) {
  47.                 $this->totalNumberOfLines = func_get_arg(1);
  48.             }
  49.             if (\func_num_args() > 2) {
  50.                 $this->skippedLineNumbers = func_get_arg(2);
  51.             }
  52.         }
  53.     }
  55.     /**
  56.      * Parses a YAML file into a PHP value.
  57.      *
  58.      * @param string $filename The path to the YAML file to be parsed
  59.      * @param int    $flags    A bit field of PARSE_* constants to customize the YAML parser behavior
  60.      *
  61.      * @return mixed The YAML converted to a PHP value
  62.      *
  63.      * @throws ParseException If the file could not be read or the YAML is not valid
  64.      */
  65.     public function parseFile($filename, $flags = 0)
  66.     {
  67.         if (!is_file($filename)) {
  68.             throw new ParseException(sprintf('File "%s" does not exist.', $filename));
  69.         }
  71.         if (!is_readable($filename)) {
  72.             throw new ParseException(sprintf('File "%s" cannot be read.', $filename));
  73.         }
  75.         $this->filename = $filename;
  77.         try {
  78.             return $this->parse(file_get_contents($filename), $flags);
  79.         } finally {
  80.             $this->filename = null;
  81.         }
  82.     }
  84.     /**
  85.      * Parses a YAML string to a PHP value.
  86.      *
  87.      * @param string $value A YAML string
  88.      * @param int    $flags A bit field of PARSE_* constants to customize the YAML parser behavior
  89.      *
  90.      * @return mixed A PHP value
  91.      *
  92.      * @throws ParseException If the YAML is not valid
  93.      */
  94.     public function parse($value, $flags = 0)
  95.     {
  96.         if (\is_bool($flags)) {
  97.             @trigger_error('Passing a boolean flag to toggle exception handling is deprecated since Symfony 3.1 and will be removed in 4.0. Use the Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE flag instead.', E_USER_DEPRECATED);
  99.             if ($flags) {
  100.                 $flags = Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE;
  101.             } else {
  102.                 $flags = 0;
  103.             }
  104.         }
  106.         if (\func_num_args() >= 3) {
  107.             @trigger_error('Passing a boolean flag to toggle object support is deprecated since Symfony 3.1 and will be removed in 4.0. Use the Yaml::PARSE_OBJECT flag instead.', E_USER_DEPRECATED);
  109.             if (func_get_arg(2)) {
  110.                 $flags |= Yaml::PARSE_OBJECT;
  111.             }
  112.         }
  114.         if (\func_num_args() >= 4) {
  115.             @trigger_error('Passing a boolean flag to toggle object for map support is deprecated since Symfony 3.1 and will be removed in 4.0. Use the Yaml::PARSE_OBJECT_FOR_MAP flag instead.', E_USER_DEPRECATED);
  117.             if (func_get_arg(3)) {
  118.                 $flags |= Yaml::PARSE_OBJECT_FOR_MAP;
  119.             }
  120.         }
  122.         if (Yaml::PARSE_KEYS_AS_STRINGS & $flags) {
  123.             @trigger_error('Using the Yaml::PARSE_KEYS_AS_STRINGS flag is deprecated since Symfony 3.4 as it will be removed in 4.0. Quote your keys when they are evaluable instead.', E_USER_DEPRECATED);
  124.         }
  126.         if (false === preg_match('//u', $value)) {
  127.             throw new ParseException('The YAML value does not appear to be valid UTF-8.', -1, null, $this->filename);
  128.         }
  130.         $this->refs = [];
  132.         $mbEncoding = null;
  133.         $e = null;
  134.         $data = null;
  136.         if (2 /* MB_OVERLOAD_STRING */ & (int) ini_get('mbstring.func_overload')) {
  137.             $mbEncoding = mb_internal_encoding();
  138.             mb_internal_encoding('UTF-8');
  139.         }
  141.         try {
  142.             $data = $this->doParse($value, $flags);
  143.         } catch (\Exception $e) {
  144.         } catch (\Throwable $e) {
  145.         }
  147.         if (null !== $mbEncoding) {
  148.             mb_internal_encoding($mbEncoding);
  149.         }
  151.         $this->lines = [];
  152.         $this->currentLine = '';
  153.         $this->refs = [];
  154.         $this->skippedLineNumbers = [];
  155.         $this->locallySkippedLineNumbers = [];
  157.         if (null !== $e) {
  158.             throw $e;
  159.         }
  161.         return $data;
  162.     }
  164.     private function doParse($value, $flags)
  165.     {
  166.         $this->currentLineNb = -1;
  167.         $this->currentLine = '';
  168.         $value = $this->cleanup($value);
  169.         $this->lines = explode("\n", $value);
  170.         $this->locallySkippedLineNumbers = [];
  172.         if (null === $this->totalNumberOfLines) {
  173.             $this->totalNumberOfLines = \count($this->lines);
  174.         }
  176.         if (!$this->moveToNextLine()) {
  177.             return null;
  178.         }
  180.         $data = [];
  181.         $context = null;
  182.         $allowOverwrite = false;
  184.         while ($this->isCurrentLineEmpty()) {
  185.             if (!$this->moveToNextLine()) {
  186.                 return null;
  187.             }
  188.         }
  190.         // Resolves the tag and returns if end of the document
  191.         if (null !== ($tag = $this->getLineTag($this->currentLine, $flags, false)) && !$this->moveToNextLine()) {
  192.             return new TaggedValue($tag, '');
  193.         }
  195.         do {
  196.             if ($this->isCurrentLineEmpty()) {
  197.                 continue;
  198.             }
  200.             // tab?
  201.             if ("\t" === $this->currentLine[0]) {
  202.                 throw new ParseException('A YAML file cannot contain tabs as indentation.', $this->getRealCurrentLineNb() + 1, $this->currentLine, $this->filename);
  203.             }
  205.             Inline::initialize($flags, $this->getRealCurrentLineNb(), $this->filename);
  207.             $isRef = $mergeNode = false;
  208.             if (self::preg_match('#^\-((?P<leadspaces>\s+)(?P<value>.+))?$#u', rtrim($this->currentLine), $values)) {
  209.                 if ($context && 'mapping' == $context) {
  210.                     throw new ParseException('You cannot define a sequence item when in a mapping', $this->getRealCurrentLineNb() + 1, $this->currentLine, $this->filename);
  211.                 }
  212.                 $context = 'sequence';
  214.                 if (isset($values['value']) && self::preg_match('#^&(?P<ref>[^ ]+) *(?P<value>.*)#u', $values['value'], $matches)) {
  215.                     $isRef = $matches['ref'];
  216.                     $this->refsBeingParsed[] = $isRef;
  217.                     $values['value'] = $matches['value'];
  218.                 }
  220.                 if (isset($values['value'][1]) && '?' === $values['value'][0] && ' ' === $values['value'][1]) {
  221.                     @trigger_error($this->getDeprecationMessage('Starting an unquoted string with a question mark followed by a space is deprecated since Symfony 3.3 and will throw \Symfony\Component\Yaml\Exception\ParseException in 4.0.'), E_USER_DEPRECATED);
  222.                 }
  224.                 // array
  225.                 if (!isset($values['value']) || '' == trim($values['value'], ' ') || 0 === strpos(ltrim($values['value'], ' '), '#')) {
  226.                     $data[] = $this->parseBlock($this->getRealCurrentLineNb() + 1, $this->getNextEmbedBlock(null, true), $flags);
  227.                 } elseif (null !== $subTag = $this->getLineTag(ltrim($values['value'], ' '), $flags)) {
  228.                     $data[] = new TaggedValue(
  229.                         $subTag,
  230.                         $this->parseBlock($this->getRealCurrentLineNb() + 1, $this->getNextEmbedBlock(null, true), $flags)
  231.                     );
  232.                 } else {
  233.                     if (isset($values['leadspaces'])
  234.                         && self::preg_match('#^(?P<key>'.Inline::REGEX_QUOTED_STRING.'|[^ \'"\{\[].*?) *\:(\s+(?P<value>.+?))?\s*$#u', $this->trimTag($values['value']), $matches)
  235.                     ) {
  236.                         // this is a compact notation element, add to next block and parse
  237.                         $block = $values['value'];
  238.                         if ($this->isNextLineIndented()) {
  239.                             $block .= "\n".$this->getNextEmbedBlock($this->getCurrentLineIndentation() + \strlen($values['leadspaces']) + 1);
  240.                         }
  242.                         $data[] = $this->parseBlock($this->getRealCurrentLineNb(), $block, $flags);
  243.                     } else {
  244.                         $data[] = $this->parseValue($values['value'], $flags, $context);
  245.                     }
  246.                 }
  247.                 if ($isRef) {
  248.                     $this->refs[$isRef] = end($data);
  249.                     array_pop($this->refsBeingParsed);
  250.                 }
  251.             } elseif (
  252.                 self::preg_match('#^(?P<key>(?:![^\s]++\s++)?(?:'.Inline::REGEX_QUOTED_STRING.'|(?:!?!php/const:)?[^ \'"\[\{!].*?)) *\:(\s++(?P<value>.+))?$#u', rtrim($this->currentLine), $values)
  253.                 && (false === strpos($values['key'], ' #') || \in_array($values['key'][0], ['"', "'"]))
  254.             ) {
  255.                 if ($context && 'sequence' == $context) {
  256.                     throw new ParseException('You cannot define a mapping item when in a sequence', $this->currentLineNb + 1, $this->currentLine, $this->filename);
  257.                 }
  258.                 $context = 'mapping';
  260.                 try {
  261.                     $i = 0;
  262.                     $evaluateKey = !(Yaml::PARSE_KEYS_AS_STRINGS & $flags);
  264.                     // constants in key will be evaluated anyway
  265.                     if (isset($values['key'][0]) && '!' === $values['key'][0] && Yaml::PARSE_CONSTANT & $flags) {
  266.                         $evaluateKey = true;
  267.                     }
  269.                     $key = Inline::parseScalar($values['key'], 0, null, $i, $evaluateKey);
  270.                 } catch (ParseException $e) {
  271.                     $e->setParsedLine($this->getRealCurrentLineNb() + 1);
  272.                     $e->setSnippet($this->currentLine);
  274.                     throw $e;
  275.                 }
  277.                 if (!\is_string($key) && !\is_int($key)) {
  278.                     $keyType = is_numeric($key) ? 'numeric key' : 'non-string key';
  279.                     @trigger_error($this->getDeprecationMessage(sprintf('Implicit casting of %s to string is deprecated since Symfony 3.3 and will throw \Symfony\Component\Yaml\Exception\ParseException in 4.0. Quote your evaluable mapping keys instead.', $keyType)), E_USER_DEPRECATED);
  280.                 }
  282.                 // Convert float keys to strings, to avoid being converted to integers by PHP
  283.                 if (\is_float($key)) {
  284.                     $key = (string) $key;
  285.                 }
  287.                 if ('<<' === $key && (!isset($values['value']) || !self::preg_match('#^&(?P<ref>[^ ]+)#u', $values['value'], $refMatches))) {
  288.                     $mergeNode = true;
  289.                     $allowOverwrite = true;
  290.                     if (isset($values['value'][0]) && '*' === $values['value'][0]) {
  291.                         $refName = substr(rtrim($values['value']), 1);
  292.                         if (!\array_key_exists($refName, $this->refs)) {
  293.                             if (false !== $pos = array_search($refName, $this->refsBeingParsed, true)) {
  294.                                 throw new ParseException(sprintf('Circular reference [%s, %s] detected for reference "%s".', implode(', ', \array_slice($this->refsBeingParsed, $pos)), $refName, $refName), $this->currentLineNb + 1, $this->currentLine, $this->filename);
  295.                             }
  297.                             throw new ParseException(sprintf('Reference "%s" does not exist.', $refName), $this->getRealCurrentLineNb() + 1, $this->currentLine, $this->filename);
  298.                         }
  300.                         $refValue = $this->refs[$refName];
  302.                         if (Yaml::PARSE_OBJECT_FOR_MAP & $flags && $refValue instanceof \stdClass) {
  303.                             $refValue = (array) $refValue;
  304.                         }
  306.                         if (!\is_array($refValue)) {
  307.                             throw new ParseException('YAML merge keys used with a scalar value instead of an array.', $this->getRealCurrentLineNb() + 1, $this->currentLine, $this->filename);
  308.                         }
  310.                         $data += $refValue; // array union
  311.                     } else {
  312.                         if (isset($values['value']) && '' !== $values['value']) {
  313.                             $value = $values['value'];
  314.                         } else {
  315.                             $value = $this->getNextEmbedBlock();
  316.                         }
  317.                         $parsed = $this->parseBlock($this->getRealCurrentLineNb() + 1, $value, $flags);
  319.                         if (Yaml::PARSE_OBJECT_FOR_MAP & $flags && $parsed instanceof \stdClass) {
  320.                             $parsed = (array) $parsed;
  321.                         }
  323.                         if (!\is_array($parsed)) {
  324.                             throw new ParseException('YAML merge keys used with a scalar value instead of an array.', $this->getRealCurrentLineNb() + 1, $this->currentLine, $this->filename);
  325.                         }
  327.                         if (isset($parsed[0])) {
  328.                             // If the value associated with the merge key is a sequence, then this sequence is expected to contain mapping nodes
  329.                             // and each of these nodes is merged in turn according to its order in the sequence. Keys in mapping nodes earlier
  330.                             // in the sequence override keys specified in later mapping nodes.
  331.                             foreach ($parsed as $parsedItem) {
  332.                                 if (Yaml::PARSE_OBJECT_FOR_MAP & $flags && $parsedItem instanceof \stdClass) {
  333.                                     $parsedItem = (array) $parsedItem;
  334.                                 }
  336.                                 if (!\is_array($parsedItem)) {
  337.                                     throw new ParseException('Merge items must be arrays.', $this->getRealCurrentLineNb() + 1, $parsedItem, $this->filename);
  338.                                 }
  340.                                 $data += $parsedItem; // array union
  341.                             }
  342.                         } else {
  343.                             // If the value associated with the key is a single mapping node, each of its key/value pairs is inserted into the
  344.                             // current mapping, unless the key already exists in it.
  345.                             $data += $parsed; // array union
  346.                         }
  347.                     }
  348.                 } elseif ('<<' !== $key && isset($values['value']) && self::preg_match('#^&(?P<ref>[^ ]++) *+(?P<value>.*)#u', $values['value'], $matches)) {
  349.                     $isRef = $matches['ref'];
  350.                     $this->refsBeingParsed[] = $isRef;
  351.                     $values['value'] = $matches['value'];
  352.                 }
  354.                 $subTag = null;
  355.                 if ($mergeNode) {
  356.                     // Merge keys
  357.                 } elseif (!isset($values['value']) || '' === $values['value'] || 0 === strpos($values['value'], '#') || (null !== $subTag = $this->getLineTag($values['value'], $flags)) || '<<' === $key) {
  358.                     // hash
  359.                     // if next line is less indented or equal, then it means that the current value is null
  360.                     if (!$this->isNextLineIndented() && !$this->isNextLineUnIndentedCollection()) {
  361.                         // Spec: Keys MUST be unique; first one wins.
  362.                         // But overwriting is allowed when a merge node is used in current block.
  363.                         if ($allowOverwrite || !isset($data[$key])) {
  364.                             if (null !== $subTag) {
  365.                                 $data[$key] = new TaggedValue($subTag, '');
  366.                             } else {
  367.                                 $data[$key] = null;
  368.                             }
  369.                         } else {
  370.                             @trigger_error($this->getDeprecationMessage(sprintf('Duplicate key "%s" detected whilst parsing YAML. Silent handling of duplicate mapping keys in YAML is deprecated since Symfony 3.2 and will throw \Symfony\Component\Yaml\Exception\ParseException in 4.0.', $key)), E_USER_DEPRECATED);
  371.                         }
  372.                     } else {
  373.                         $value = $this->parseBlock($this->getRealCurrentLineNb() + 1, $this->getNextEmbedBlock(), $flags);
  374.                         if ('<<' === $key) {
  375.                             $this->refs[$refMatches['ref']] = $value;
  377.                             if (Yaml::PARSE_OBJECT_FOR_MAP & $flags && $value instanceof \stdClass) {
  378.                                 $value = (array) $value;
  379.                             }
  381.                             $data += $value;
  382.                         } elseif ($allowOverwrite || !isset($data[$key])) {
  383.                             // Spec: Keys MUST be unique; first one wins.
  384.                             // But overwriting is allowed when a merge node is used in current block.
  385.                             if (null !== $subTag) {
  386.                                 $data[$key] = new TaggedValue($subTag, $value);
  387.                             } else {
  388.                                 $data[$key] = $value;
  389.                             }
  390.                         } else {
  391.                             @trigger_error($this->getDeprecationMessage(sprintf('Duplicate key "%s" detected whilst parsing YAML. Silent handling of duplicate mapping keys in YAML is deprecated since Symfony 3.2 and will throw \Symfony\Component\Yaml\Exception\ParseException in 4.0.', $key)), E_USER_DEPRECATED);
  392.                         }
  393.                     }
  394.                 } else {
  395.                     $value = $this->parseValue(rtrim($values['value']), $flags, $context);
  396.                     // Spec: Keys MUST be unique; first one wins.
  397.                     // But overwriting is allowed when a merge node is used in current block.
  398.                     if ($allowOverwrite || !isset($data[$key])) {
  399.                         $data[$key] = $value;
  400.                     } else {
  401.                         @trigger_error($this->getDeprecationMessage(sprintf('Duplicate key "%s" detected whilst parsing YAML. Silent handling of duplicate mapping keys in YAML is deprecated since Symfony 3.2 and will throw \Symfony\Component\Yaml\Exception\ParseException in 4.0.', $key)), E_USER_DEPRECATED);
  402.                     }
  403.                 }
  404.                 if ($isRef) {
  405.                     $this->refs[$isRef] = $data[$key];
  406.                     array_pop($this->refsBeingParsed);
  407.                 }
  408.             } else {
  409.                 // multiple documents are not supported
  410.                 if ('---' === $this->currentLine) {
  411.                     throw new ParseException('Multiple documents are not supported.', $this->currentLineNb + 1, $this->currentLine, $this->filename);
  412.                 }
  414.                 if ($deprecatedUsage = (isset($this->currentLine[1]) && '?' === $this->currentLine[0] && ' ' === $this->currentLine[1])) {
  415.                     @trigger_error($this->getDeprecationMessage('Starting an unquoted string with a question mark followed by a space is deprecated since Symfony 3.3 and will throw \Symfony\Component\Yaml\Exception\ParseException in 4.0.'), E_USER_DEPRECATED);
  416.                 }
  418.                 // 1-liner optionally followed by newline(s)
  419.                 if (\is_string($value) && $this->lines[0] === trim($value)) {
  420.                     try {
  421.                         $value = Inline::parse($this->lines[0], $flags, $this->refs);
  422.                     } catch (ParseException $e) {
  423.                         $e->setParsedLine($this->getRealCurrentLineNb() + 1);
  424.                         $e->setSnippet($this->currentLine);
  426.                         throw $e;
  427.                     }
  429.                     return $value;
  430.                 }
  432.                 // try to parse the value as a multi-line string as a last resort
  433.                 if (0 === $this->currentLineNb) {
  434.                     $previousLineWasNewline = false;
  435.                     $previousLineWasTerminatedWithBackslash = false;
  436.                     $value = '';
  438.                     foreach ($this->lines as $line) {
  439.                         if ('' !== ltrim($line) && '#' === ltrim($line)[0]) {
  440.                             continue;
  441.                         }
  442.                         // If the indentation is not consistent at offset 0, it is to be considered as a ParseError
  443.                         if (0 === $this->offset && !$deprecatedUsage && isset($line[0]) && ' ' === $line[0]) {
  444.                             throw new ParseException('Unable to parse.', $this->getRealCurrentLineNb() + 1, $this->currentLine, $this->filename);
  445.                         }
  446.                         if ('' === trim($line)) {
  447.                             $value .= "\n";
  448.                         } elseif (!$previousLineWasNewline && !$previousLineWasTerminatedWithBackslash) {
  449.                             $value .= ' ';
  450.                         }
  452.                         if ('' !== trim($line) && '\\' === substr($line, -1)) {
  453.                             $value .= ltrim(substr($line, 0, -1));
  454.                         } elseif ('' !== trim($line)) {
  455.                             $value .= trim($line);
  456.                         }
  458.                         if ('' === trim($line)) {
  459.                             $previousLineWasNewline = true;
  460.                             $previousLineWasTerminatedWithBackslash = false;
  461.                         } elseif ('\\' === substr($line, -1)) {
  462.                             $previousLineWasNewline = false;
  463.                             $previousLineWasTerminatedWithBackslash = true;
  464.                         } else {
  465.                             $previousLineWasNewline = false;
  466.                             $previousLineWasTerminatedWithBackslash = false;
  467.                         }
  468.                     }
  470.                     try {
  471.                         return Inline::parse(trim($value));
  472.                     } catch (ParseException $e) {
  473.                         // fall-through to the ParseException thrown below
  474.                     }
  475.                 }
  477.                 throw new ParseException('Unable to parse.', $this->getRealCurrentLineNb() + 1, $this->currentLine, $this->filename);
  478.             }
  479.         } while ($this->moveToNextLine());
  481.         if (null !== $tag) {
  482.             $data = new TaggedValue($tag, $data);
  483.         }
  485.         if (Yaml::PARSE_OBJECT_FOR_MAP & $flags && !\is_object($data) && 'mapping' === $context) {
  486.             $object = new \stdClass();
  488.             foreach ($data as $key => $value) {
  489.                 $object->$key = $value;
  490.             }
  492.             $data = $object;
  493.         }
  495.         return empty($data) ? null : $data;
  496.     }
  498.     private function parseBlock($offset, $yaml, $flags)
  499.     {
  500.         $skippedLineNumbers = $this->skippedLineNumbers;
  502.         foreach ($this->locallySkippedLineNumbers as $lineNumber) {
  503.             if ($lineNumber < $offset) {
  504.                 continue;
  505.             }
  507.             $skippedLineNumbers[] = $lineNumber;
  508.         }
  510.         $parser = new self();
  511.         $parser->offset = $offset;
  512.         $parser->totalNumberOfLines = $this->totalNumberOfLines;
  513.         $parser->skippedLineNumbers = $skippedLineNumbers;
  514.         $parser->refs = &$this->refs;
  515.         $parser->refsBeingParsed = $this->refsBeingParsed;
  517.         return $parser->doParse($yaml, $flags);
  518.     }
  520.     /**
  521.      * Returns the current line number (takes the offset into account).
  522.      *
  523.      * @internal
  524.      *
  525.      * @return int The current line number
  526.      */
  527.     public function getRealCurrentLineNb()
  528.     {
  529.         $realCurrentLineNumber = $this->currentLineNb + $this->offset;
  531.         foreach ($this->skippedLineNumbers as $skippedLineNumber) {
  532.             if ($skippedLineNumber > $realCurrentLineNumber) {
  533.                 break;
  534.             }
  536.             ++$realCurrentLineNumber;
  537.         }
  539.         return $realCurrentLineNumber;
  540.     }
  542.     /**
  543.      * Returns the current line indentation.
  544.      *
  545.      * @return int The current line indentation
  546.      */
  547.     private function getCurrentLineIndentation()
  548.     {
  549.         return \strlen($this->currentLine) - \strlen(ltrim($this->currentLine, ' '));
  550.     }
  552.     /**
  553.      * Returns the next embed block of YAML.
  554.      *
  555.      * @param int  $indentation The indent level at which the block is to be read, or null for default
  556.      * @param bool $inSequence  True if the enclosing data structure is a sequence
  557.      *
  558.      * @return string A YAML string
  559.      *
  560.      * @throws ParseException When indentation problem are detected
  561.      */
  562.     private function getNextEmbedBlock($indentation = null, $inSequence = false)
  563.     {
  564.         $oldLineIndentation = $this->getCurrentLineIndentation();
  566.         if (!$this->moveToNextLine()) {
  567.             return '';
  568.         }
  570.         if (null === $indentation) {
  571.             $newIndent = null;
  572.             $movements = 0;
  574.             do {
  575.                 $EOF = false;
  577.                 // empty and comment-like lines do not influence the indentation depth
  578.                 if ($this->isCurrentLineEmpty() || $this->isCurrentLineComment()) {
  579.                     $EOF = !$this->moveToNextLine();
  581.                     if (!$EOF) {
  582.                         ++$movements;
  583.                     }
  584.                 } else {
  585.                     $newIndent = $this->getCurrentLineIndentation();
  586.                 }
  587.             } while (!$EOF && null === $newIndent);
  589.             for ($i = 0; $i < $movements; ++$i) {
  590.                 $this->moveToPreviousLine();
  591.             }
  593.             $unindentedEmbedBlock = $this->isStringUnIndentedCollectionItem();
  595.             if (!$this->isCurrentLineEmpty() && 0 === $newIndent && !$unindentedEmbedBlock) {
  596.                 throw new ParseException('Indentation problem.', $this->getRealCurrentLineNb() + 1, $this->currentLine, $this->filename);
  597.             }
  598.         } else {
  599.             $newIndent = $indentation;
  600.         }
  602.         $data = [];
  603.         if ($this->getCurrentLineIndentation() >= $newIndent) {
  604.             $data[] = substr($this->currentLine, $newIndent);
  605.         } elseif ($this->isCurrentLineEmpty() || $this->isCurrentLineComment()) {
  606.             $data[] = $this->currentLine;
  607.         } else {
  608.             $this->moveToPreviousLine();
  610.             return '';
  611.         }
  613.         if ($inSequence && $oldLineIndentation === $newIndent && isset($data[0][0]) && '-' === $data[0][0]) {
  614.             // the previous line contained a dash but no item content, this line is a sequence item with the same indentation
  615.             // and therefore no nested list or mapping
  616.             $this->moveToPreviousLine();
  618.             return '';
  619.         }
  621.         $isItUnindentedCollection = $this->isStringUnIndentedCollectionItem();
  623.         while ($this->moveToNextLine()) {
  624.             $indent = $this->getCurrentLineIndentation();
  626.             if ($isItUnindentedCollection && !$this->isCurrentLineEmpty() && !$this->isStringUnIndentedCollectionItem() && $newIndent === $indent) {
  627.                 $this->moveToPreviousLine();
  628.                 break;
  629.             }
  631.             if ($this->isCurrentLineBlank()) {
  632.                 $data[] = substr($this->currentLine, $newIndent);
  633.                 continue;
  634.             }
  636.             if ($indent >= $newIndent) {
  637.                 $data[] = substr($this->currentLine, $newIndent);
  638.             } elseif ($this->isCurrentLineComment()) {
  639.                 $data[] = $this->currentLine;
  640.             } elseif (0 == $indent) {
  641.                 $this->moveToPreviousLine();
  643.                 break;
  644.             } else {
  645.                 throw new ParseException('Indentation problem.', $this->getRealCurrentLineNb() + 1, $this->currentLine, $this->filename);
  646.             }
  647.         }
  649.         return implode("\n", $data);
  650.     }
  652.     /**
  653.      * Moves the parser to the next line.
  654.      *
  655.      * @return bool
  656.      */
  657.     private function moveToNextLine()
  658.     {
  659.         if ($this->currentLineNb >= \count($this->lines) - 1) {
  660.             return false;
  661.         }
  663.         $this->currentLine = $this->lines[++$this->currentLineNb];
  665.         return true;
  666.     }
  668.     /**
  669.      * Moves the parser to the previous line.
  670.      *
  671.      * @return bool
  672.      */
  673.     private function moveToPreviousLine()
  674.     {
  675.         if ($this->currentLineNb < 1) {
  676.             return false;
  677.         }
  679.         $this->currentLine = $this->lines[--$this->currentLineNb];
  681.         return true;
  682.     }
  684.     /**
  685.      * Parses a YAML value.
  686.      *
  687.      * @param string $value   A YAML value
  688.      * @param int    $flags   A bit field of PARSE_* constants to customize the YAML parser behavior
  689.      * @param string $context The parser context (either sequence or mapping)
  690.      *
  691.      * @return mixed A PHP value
  692.      *
  693.      * @throws ParseException When reference does not exist
  694.      */
  695.     private function parseValue($value, $flags, $context)
  696.     {
  697.         if (0 === strpos($value, '*')) {
  698.             if (false !== $pos = strpos($value, '#')) {
  699.                 $value = substr($value, 1, $pos - 2);
  700.             } else {
  701.                 $value = substr($value, 1);
  702.             }
  704.             if (!\array_key_exists($value, $this->refs)) {
  705.                 if (false !== $pos = array_search($value, $this->refsBeingParsed, true)) {
  706.                     throw new ParseException(sprintf('Circular reference [%s, %s] detected for reference "%s".', implode(', ', \array_slice($this->refsBeingParsed, $pos)), $value, $value), $this->currentLineNb + 1, $this->currentLine, $this->filename);
  707.                 }
  709.                 throw new ParseException(sprintf('Reference "%s" does not exist.', $value), $this->currentLineNb + 1, $this->currentLine, $this->filename);
  710.             }
  712.             return $this->refs[$value];
  713.         }
  715.         if (self::preg_match('/^(?:'.self::TAG_PATTERN.' +)?'.self::BLOCK_SCALAR_HEADER_PATTERN.'$/', $value, $matches)) {
  716.             $modifiers = isset($matches['modifiers']) ? $matches['modifiers'] : '';
  718.             $data = $this->parseBlockScalar($matches['separator'], preg_replace('#\d+#', '', $modifiers), (int) abs((int) $modifiers));
  720.             if ('' !== $matches['tag']) {
  721.                 if ('!!binary' === $matches['tag']) {
  722.                     return Inline::evaluateBinaryScalar($data);
  723.                 } elseif ('tagged' === $matches['tag']) {
  724.                     return new TaggedValue(substr($matches['tag'], 1), $data);
  725.                 } elseif ('!' !== $matches['tag']) {
  726.                     @trigger_error($this->getDeprecationMessage(sprintf('Using the custom tag "%s" for the value "%s" is deprecated since Symfony 3.3. It will be replaced by an instance of %s in 4.0.', $matches['tag'], $data, TaggedValue::class)), E_USER_DEPRECATED);
  727.                 }
  728.             }
  730.             return $data;
  731.         }
  733.         try {
  734.             $quotation = '' !== $value && ('"' === $value[0] || "'" === $value[0]) ? $value[0] : null;
  736.             // do not take following lines into account when the current line is a quoted single line value
  737.             if (null !== $quotation && self::preg_match('/^'.$quotation.'.*'.$quotation.'(\s*#.*)?$/', $value)) {
  738.                 return Inline::parse($value, $flags, $this->refs);
  739.             }
  741.             $lines = [];
  743.             while ($this->moveToNextLine()) {
  744.                 // unquoted strings end before the first unindented line
  745.                 if (null === $quotation && 0 === $this->getCurrentLineIndentation()) {
  746.                     $this->moveToPreviousLine();
  748.                     break;
  749.                 }
  751.                 $lines[] = trim($this->currentLine);
  753.                 // quoted string values end with a line that is terminated with the quotation character
  754.                 if ('' !== $this->currentLine && substr($this->currentLine, -1) === $quotation) {
  755.                     break;
  756.                 }
  757.             }
  759.             for ($i = 0, $linesCount = \count($lines), $previousLineBlank = false; $i < $linesCount; ++$i) {
  760.                 if ('' === $lines[$i]) {
  761.                     $value .= "\n";
  762.                     $previousLineBlank = true;
  763.                 } elseif ($previousLineBlank) {
  764.                     $value .= $lines[$i];
  765.                     $previousLineBlank = false;
  766.                 } else {
  767.                     $value .= ' '.$lines[$i];
  768.                     $previousLineBlank = false;
  769.                 }
  770.             }
  772.             Inline::$parsedLineNumber = $this->getRealCurrentLineNb();
  774.             $parsedValue = Inline::parse($value, $flags, $this->refs);
  776.             if ('mapping' === $context && \is_string($parsedValue) && '"' !== $value[0] && "'" !== $value[0] && '[' !== $value[0] && '{' !== $value[0] && '!' !== $value[0] && false !== strpos($parsedValue, ': ')) {
  777.                 throw new ParseException('A colon cannot be used in an unquoted mapping value.', $this->getRealCurrentLineNb() + 1, $value, $this->filename);
  778.             }
  780.             return $parsedValue;
  781.         } catch (ParseException $e) {
  782.             $e->setParsedLine($this->getRealCurrentLineNb() + 1);
  783.             $e->setSnippet($this->currentLine);
  785.             throw $e;
  786.         }
  787.     }
  789.     /**
  790.      * Parses a block scalar.
  791.      *
  792.      * @param string $style       The style indicator that was used to begin this block scalar (| or >)
  793.      * @param string $chomping    The chomping indicator that was used to begin this block scalar (+ or -)
  794.      * @param int    $indentation The indentation indicator that was used to begin this block scalar
  795.      *
  796.      * @return string The text value
  797.      */
  798.     private function parseBlockScalar($style, $chomping = '', $indentation = 0)
  799.     {
  800.         $notEOF = $this->moveToNextLine();
  801.         if (!$notEOF) {
  802.             return '';
  803.         }
  805.         $isCurrentLineBlank = $this->isCurrentLineBlank();
  806.         $blockLines = [];
  808.         // leading blank lines are consumed before determining indentation
  809.         while ($notEOF && $isCurrentLineBlank) {
  810.             // newline only if not EOF
  811.             if ($notEOF = $this->moveToNextLine()) {
  812.                 $blockLines[] = '';
  813.                 $isCurrentLineBlank = $this->isCurrentLineBlank();
  814.             }
  815.         }
  817.         // determine indentation if not specified
  818.         if (0 === $indentation) {
  819.             if (self::preg_match('/^ +/', $this->currentLine, $matches)) {
  820.                 $indentation = \strlen($matches[0]);
  821.             }
  822.         }
  824.         if ($indentation > 0) {
  825.             $pattern = sprintf('/^ {%d}(.*)$/', $indentation);
  827.             while (
  828.                 $notEOF && (
  829.                     $isCurrentLineBlank ||
  830.                     self::preg_match($pattern, $this->currentLine, $matches)
  831.                 )
  832.             ) {
  833.                 if ($isCurrentLineBlank && \strlen($this->currentLine) > $indentation) {
  834.                     $blockLines[] = substr($this->currentLine, $indentation);
  835.                 } elseif ($isCurrentLineBlank) {
  836.                     $blockLines[] = '';
  837.                 } else {
  838.                     $blockLines[] = $matches[1];
  839.                 }
  841.                 // newline only if not EOF
  842.                 if ($notEOF = $this->moveToNextLine()) {
  843.                     $isCurrentLineBlank = $this->isCurrentLineBlank();
  844.                 }
  845.             }
  846.         } elseif ($notEOF) {
  847.             $blockLines[] = '';
  848.         }
  850.         if ($notEOF) {
  851.             $blockLines[] = '';
  852.             $this->moveToPreviousLine();
  853.         } elseif (!$notEOF && !$this->isCurrentLineLastLineInDocument()) {
  854.             $blockLines[] = '';
  855.         }
  857.         // folded style
  858.         if ('>' === $style) {
  859.             $text = '';
  860.             $previousLineIndented = false;
  861.             $previousLineBlank = false;
  863.             for ($i = 0, $blockLinesCount = \count($blockLines); $i < $blockLinesCount; ++$i) {
  864.                 if ('' === $blockLines[$i]) {
  865.                     $text .= "\n";
  866.                     $previousLineIndented = false;
  867.                     $previousLineBlank = true;
  868.                 } elseif (' ' === $blockLines[$i][0]) {
  869.                     $text .= "\n".$blockLines[$i];
  870.                     $previousLineIndented = true;
  871.                     $previousLineBlank = false;
  872.                 } elseif ($previousLineIndented) {
  873.                     $text .= "\n".$blockLines[$i];
  874.                     $previousLineIndented = false;
  875.                     $previousLineBlank = false;
  876.                 } elseif ($previousLineBlank || 0 === $i) {
  877.                     $text .= $blockLines[$i];
  878.                     $previousLineIndented = false;
  879.                     $previousLineBlank = false;
  880.                 } else {
  881.                     $text .= ' '.$blockLines[$i];
  882.                     $previousLineIndented = false;
  883.                     $previousLineBlank = false;
  884.                 }
  885.             }
  886.         } else {
  887.             $text = implode("\n", $blockLines);
  888.         }
  890.         // deal with trailing newlines
  891.         if ('' === $chomping) {
  892.             $text = preg_replace('/\n+$/', "\n", $text);
  893.         } elseif ('-' === $chomping) {
  894.             $text = preg_replace('/\n+$/', '', $text);
  895.         }
  897.         return $text;
  898.     }
  900.     /**
  901.      * Returns true if the next line is indented.
  902.      *
  903.      * @return bool Returns true if the next line is indented, false otherwise
  904.      */
  905.     private function isNextLineIndented()
  906.     {
  907.         $currentIndentation = $this->getCurrentLineIndentation();
  908.         $movements = 0;
  910.         do {
  911.             $EOF = !$this->moveToNextLine();
  913.             if (!$EOF) {
  914.                 ++$movements;
  915.             }
  916.         } while (!$EOF && ($this->isCurrentLineEmpty() || $this->isCurrentLineComment()));
  918.         if ($EOF) {
  919.             return false;
  920.         }
  922.         $ret = $this->getCurrentLineIndentation() > $currentIndentation;
  924.         for ($i = 0; $i < $movements; ++$i) {
  925.             $this->moveToPreviousLine();
  926.         }
  928.         return $ret;
  929.     }
  931.     /**
  932.      * Returns true if the current line is blank or if it is a comment line.
  933.      *
  934.      * @return bool Returns true if the current line is empty or if it is a comment line, false otherwise
  935.      */
  936.     private function isCurrentLineEmpty()
  937.     {
  938.         return $this->isCurrentLineBlank() || $this->isCurrentLineComment();
  939.     }
  941.     /**
  942.      * Returns true if the current line is blank.
  943.      *
  944.      * @return bool Returns true if the current line is blank, false otherwise
  945.      */
  946.     private function isCurrentLineBlank()
  947.     {
  948.         return '' == trim($this->currentLine, ' ');
  949.     }
  951.     /**
  952.      * Returns true if the current line is a comment line.
  953.      *
  954.      * @return bool Returns true if the current line is a comment line, false otherwise
  955.      */
  956.     private function isCurrentLineComment()
  957.     {
  958.         //checking explicitly the first char of the trim is faster than loops or strpos
  959.         $ltrimmedLine = ltrim($this->currentLine, ' ');
  961.         return '' !== $ltrimmedLine && '#' === $ltrimmedLine[0];
  962.     }
  964.     private function isCurrentLineLastLineInDocument()
  965.     {
  966.         return ($this->offset + $this->currentLineNb) >= ($this->totalNumberOfLines - 1);
  967.     }
  969.     /**
  970.      * Cleanups a YAML string to be parsed.
  971.      *
  972.      * @param string $value The input YAML string
  973.      *
  974.      * @return string A cleaned up YAML string
  975.      */
  976.     private function cleanup($value)
  977.     {
  978.         $value = str_replace(["\r\n", "\r"], "\n", $value);
  980.         // strip YAML header
  981.         $count = 0;
  982.         $value = preg_replace('#^\%YAML[: ][\d\.]+.*\n#u', '', $value, -1, $count);
  983.         $this->offset += $count;
  985.         // remove leading comments
  986.         $trimmedValue = preg_replace('#^(\#.*?\n)+#s', '', $value, -1, $count);
  987.         if (1 === $count) {
  988.             // items have been removed, update the offset
  989.             $this->offset += substr_count($value, "\n") - substr_count($trimmedValue, "\n");
  990.             $value = $trimmedValue;
  991.         }
  993.         // remove start of the document marker (---)
  994.         $trimmedValue = preg_replace('#^\-\-\-.*?\n#s', '', $value, -1, $count);
  995.         if (1 === $count) {
  996.             // items have been removed, update the offset
  997.             $this->offset += substr_count($value, "\n") - substr_count($trimmedValue, "\n");
  998.             $value = $trimmedValue;
  1000.             // remove end of the document marker (...)
  1001.             $value = preg_replace('#\.\.\.\s*$#', '', $value);
  1002.         }
  1004.         return $value;
  1005.     }
  1007.     /**
  1008.      * Returns true if the next line starts unindented collection.
  1009.      *
  1010.      * @return bool Returns true if the next line starts unindented collection, false otherwise
  1011.      */
  1012.     private function isNextLineUnIndentedCollection()
  1013.     {
  1014.         $currentIndentation = $this->getCurrentLineIndentation();
  1015.         $movements = 0;
  1017.         do {
  1018.             $EOF = !$this->moveToNextLine();
  1020.             if (!$EOF) {
  1021.                 ++$movements;
  1022.             }
  1023.         } while (!$EOF && ($this->isCurrentLineEmpty() || $this->isCurrentLineComment()));
  1025.         if ($EOF) {
  1026.             return false;
  1027.         }
  1029.         $ret = $this->getCurrentLineIndentation() === $currentIndentation && $this->isStringUnIndentedCollectionItem();
  1031.         for ($i = 0; $i < $movements; ++$i) {
  1032.             $this->moveToPreviousLine();
  1033.         }
  1035.         return $ret;
  1036.     }
  1038.     /**
  1039.      * Returns true if the string is un-indented collection item.
  1040.      *
  1041.      * @return bool Returns true if the string is un-indented collection item, false otherwise
  1042.      */
  1043.     private function isStringUnIndentedCollectionItem()
  1044.     {
  1045.         return '-' === rtrim($this->currentLine) || 0 === strpos($this->currentLine, '- ');
  1046.     }
  1048.     /**
  1049.      * A local wrapper for `preg_match` which will throw a ParseException if there
  1050.      * is an internal error in the PCRE engine.
  1051.      *
  1052.      * This avoids us needing to check for "false" every time PCRE is used
  1053.      * in the YAML engine
  1054.      *
  1055.      * @throws ParseException on a PCRE internal error
  1056.      *
  1057.      * @see preg_last_error()
  1058.      *
  1059.      * @internal
  1060.      */
  1061.     public static function preg_match($pattern, $subject, &$matches = null, $flags = 0, $offset = 0)
  1062.     {
  1063.         if (false === $ret = preg_match($pattern, $subject, $matches, $flags, $offset)) {
  1064.             switch (preg_last_error()) {
  1065.                 case PREG_INTERNAL_ERROR:
  1066.                     $error = 'Internal PCRE error.';
  1067.                     break;
  1068.                 case PREG_BACKTRACK_LIMIT_ERROR:
  1069.                     $error = 'pcre.backtrack_limit reached.';
  1070.                     break;
  1071.                 case PREG_RECURSION_LIMIT_ERROR:
  1072.                     $error = 'pcre.recursion_limit reached.';
  1073.                     break;
  1074.                 case PREG_BAD_UTF8_ERROR:
  1075.                     $error = 'Malformed UTF-8 data.';
  1076.                     break;
  1077.                 case PREG_BAD_UTF8_OFFSET_ERROR:
  1078.                     $error = 'Offset doesn\'t correspond to the begin of a valid UTF-8 code point.';
  1079.                     break;
  1080.                 default:
  1081.                     $error = 'Error.';
  1082.             }
  1084.             throw new ParseException($error);
  1085.         }
  1087.         return $ret;
  1088.     }
  1090.     /**
  1091.      * Trim the tag on top of the value.
  1092.      *
  1093.      * Prevent values such as `!foo {quz: bar}` to be considered as
  1094.      * a mapping block.
  1095.      */
  1096.     private function trimTag($value)
  1097.     {
  1098.         if ('!' === $value[0]) {
  1099.             return ltrim(substr($value, 1, strcspn($value, " \r\n", 1)), ' ');
  1100.         }
  1102.         return $value;
  1103.     }
  1105.     /**
  1106.      * @return string|null
  1107.      */
  1108.     private function getLineTag($value, $flags, $nextLineCheck = true)
  1109.     {
  1110.         if ('' === $value || '!' !== $value[0] || 1 !== self::preg_match('/^'.self::TAG_PATTERN.' *( +#.*)?$/', $value, $matches)) {
  1111.             return null;
  1112.         }
  1114.         if ($nextLineCheck && !$this->isNextLineIndented()) {
  1115.             return null;
  1116.         }
  1118.         $tag = substr($matches['tag'], 1);
  1120.         // Built-in tags
  1121.         if ($tag && '!' === $tag[0]) {
  1122.             throw new ParseException(sprintf('The built-in tag "!%s" is not implemented.', $tag), $this->getRealCurrentLineNb() + 1, $value, $this->filename);
  1123.         }
  1125.         if (Yaml::PARSE_CUSTOM_TAGS & $flags) {
  1126.             return $tag;
  1127.         }
  1129.         throw new ParseException(sprintf('Tags support is not enabled. You must use the flag `Yaml::PARSE_CUSTOM_TAGS` to use "%s".', $matches['tag']), $this->getRealCurrentLineNb() + 1, $value, $this->filename);
  1130.     }
  1132.     private function getDeprecationMessage($message)
  1133.     {
  1134.         $message = rtrim($message, '.');
  1136.         if (null !== $this->filename) {
  1137.             $message .= ' in '.$this->filename;
  1138.         }
  1140.         $message .= ' on line '.($this->getRealCurrentLineNb() + 1);
  1142.         return $message.'.';
  1143.     }
  1144. }