@appthreat/atom 1.7.5 → 1.8.1

package/plugins/nikic/php-parser/lib/PhpParser/NodeAbstract.php

@@ -0,0 +1,178 @@
+<?php declare(strict_types=1);
+
+namespace PhpParser;
+
+abstract class NodeAbstract implements Node, \JsonSerializable {
+    /** @var array<string, mixed> Attributes */
+    protected array $attributes;
+
+    /**
+     * Creates a Node.
+     *
+     * @param array<string, mixed> $attributes Array of attributes
+     */
+    public function __construct(array $attributes = []) {
+        $this->attributes = $attributes;
+    }
+
+    /**
+     * Gets line the node started in (alias of getStartLine).
+     *
+     * @return int Start line (or -1 if not available)
+     */
+    public function getLine(): int {
+        return $this->attributes['startLine'] ?? -1;
+    }
+
+    /**
+     * Gets line the node started in.
+     *
+     * Requires the 'startLine' attribute to be enabled in the lexer (enabled by default).
+     *
+     * @return int Start line (or -1 if not available)
+     */
+    public function getStartLine(): int {
+        return $this->attributes['startLine'] ?? -1;
+    }
+
+    /**
+     * Gets the line the node ended in.
+     *
+     * Requires the 'endLine' attribute to be enabled in the lexer (enabled by default).
+     *
+     * @return int End line (or -1 if not available)
+     */
+    public function getEndLine(): int {
+        return $this->attributes['endLine'] ?? -1;
+    }
+
+    /**
+     * Gets the token offset of the first token that is part of this node.
+     *
+     * The offset is an index into the array returned by Lexer::getTokens().
+     *
+     * Requires the 'startTokenPos' attribute to be enabled in the lexer (DISABLED by default).
+     *
+     * @return int Token start position (or -1 if not available)
+     */
+    public function getStartTokenPos(): int {
+        return $this->attributes['startTokenPos'] ?? -1;
+    }
+
+    /**
+     * Gets the token offset of the last token that is part of this node.
+     *
+     * The offset is an index into the array returned by Lexer::getTokens().
+     *
+     * Requires the 'endTokenPos' attribute to be enabled in the lexer (DISABLED by default).
+     *
+     * @return int Token end position (or -1 if not available)
+     */
+    public function getEndTokenPos(): int {
+        return $this->attributes['endTokenPos'] ?? -1;
+    }
+
+    /**
+     * Gets the file offset of the first character that is part of this node.
+     *
+     * Requires the 'startFilePos' attribute to be enabled in the lexer (DISABLED by default).
+     *
+     * @return int File start position (or -1 if not available)
+     */
+    public function getStartFilePos(): int {
+        return $this->attributes['startFilePos'] ?? -1;
+    }
+
+    /**
+     * Gets the file offset of the last character that is part of this node.
+     *
+     * Requires the 'endFilePos' attribute to be enabled in the lexer (DISABLED by default).
+     *
+     * @return int File end position (or -1 if not available)
+     */
+    public function getEndFilePos(): int {
+        return $this->attributes['endFilePos'] ?? -1;
+    }
+
+    /**
+     * Gets all comments directly preceding this node.
+     *
+     * The comments are also available through the "comments" attribute.
+     *
+     * @return Comment[]
+     */
+    public function getComments(): array {
+        return $this->attributes['comments'] ?? [];
+    }
+
+    /**
+     * Gets the doc comment of the node.
+     *
+     * @return null|Comment\Doc Doc comment object or null
+     */
+    public function getDocComment(): ?Comment\Doc {
+        $comments = $this->getComments();
+        for ($i = count($comments) - 1; $i >= 0; $i--) {
+            $comment = $comments[$i];
+            if ($comment instanceof Comment\Doc) {
+                return $comment;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Sets the doc comment of the node.
+     *
+     * This will either replace an existing doc comment or add it to the comments array.
+     *
+     * @param Comment\Doc $docComment Doc comment to set
+     */
+    public function setDocComment(Comment\Doc $docComment): void {
+        $comments = $this->getComments();
+        for ($i = count($comments) - 1; $i >= 0; $i--) {
+            if ($comments[$i] instanceof Comment\Doc) {
+                // Replace existing doc comment.
+                $comments[$i] = $docComment;
+                $this->setAttribute('comments', $comments);
+                return;
+            }
+        }
+
+        // Append new doc comment.
+        $comments[] = $docComment;
+        $this->setAttribute('comments', $comments);
+    }
+
+    public function setAttribute(string $key, $value): void {
+        $this->attributes[$key] = $value;
+    }
+
+    public function hasAttribute(string $key): bool {
+        return array_key_exists($key, $this->attributes);
+    }
+
+    public function getAttribute(string $key, $default = null) {
+        if (array_key_exists($key, $this->attributes)) {
+            return $this->attributes[$key];
+        }
+
+        return $default;
+    }
+
+    public function getAttributes(): array {
+        return $this->attributes;
+    }
+
+    public function setAttributes(array $attributes): void {
+        $this->attributes = $attributes;
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function jsonSerialize(): array {
+        return ['nodeType' => $this->getType()] + get_object_vars($this);
+    }
+}

package/plugins/nikic/php-parser/lib/PhpParser/NodeDumper.php

@@ -0,0 +1,290 @@
+<?php declare(strict_types=1);
+
+namespace PhpParser;
+
+use PhpParser\Node\Expr\Array_;
+use PhpParser\Node\Expr\Include_;
+use PhpParser\Node\Expr\List_;
+use PhpParser\Node\Scalar\Int_;
+use PhpParser\Node\Scalar\InterpolatedString;
+use PhpParser\Node\Scalar\String_;
+use PhpParser\Node\Stmt\GroupUse;
+use PhpParser\Node\Stmt\Use_;
+use PhpParser\Node\UseItem;
+
+class NodeDumper {
+    private bool $dumpComments;
+    private bool $dumpPositions;
+    private bool $dumpOtherAttributes;
+    private ?string $code;
+    private string $res;
+    private string $nl;
+
+    private const IGNORE_ATTRIBUTES = [
+        'comments' => true,
+        'startLine' => true,
+        'endLine' => true,
+        'startFilePos' => true,
+        'endFilePos' => true,
+        'startTokenPos' => true,
+        'endTokenPos' => true,
+    ];
+
+    /**
+     * Constructs a NodeDumper.
+     *
+     * Supported options:
+     *  * bool dumpComments: Whether comments should be dumped.
+     *  * bool dumpPositions: Whether line/offset information should be dumped. To dump offset
+     *                        information, the code needs to be passed to dump().
+     *  * bool dumpOtherAttributes: Whether non-comment, non-position attributes should be dumped.
+     *
+     * @param array $options Options (see description)
+     */
+    public function __construct(array $options = []) {
+        $this->dumpComments = !empty($options['dumpComments']);
+        $this->dumpPositions = !empty($options['dumpPositions']);
+        $this->dumpOtherAttributes = !empty($options['dumpOtherAttributes']);
+    }
+
+    /**
+     * Dumps a node or array.
+     *
+     * @param array|Node $node Node or array to dump
+     * @param string|null $code Code corresponding to dumped AST. This only needs to be passed if
+     *                          the dumpPositions option is enabled and the dumping of node offsets
+     *                          is desired.
+     *
+     * @return string Dumped value
+     */
+    public function dump($node, ?string $code = null): string {
+        $this->code = $code;
+        $this->res = '';
+        $this->nl = "\n";
+        $this->dumpRecursive($node, false);
+        return $this->res;
+    }
+
+    /** @param mixed $node */
+    protected function dumpRecursive($node, bool $indent = true): void {
+        if ($indent) {
+            $this->nl .= "    ";
+        }
+        if ($node instanceof Node) {
+            $this->res .= $node->getType();
+            if ($this->dumpPositions && null !== $p = $this->dumpPosition($node)) {
+                $this->res .= $p;
+            }
+            $this->res .= '(';
+
+            foreach ($node->getSubNodeNames() as $key) {
+                $this->res .= "$this->nl    " . $key . ': ';
+
+                $value = $node->$key;
+                if (\is_int($value)) {
+                    if ('flags' === $key || 'newModifier' === $key) {
+                        $this->res .= $this->dumpFlags($value);
+                        continue;
+                    }
+                    if ('type' === $key && $node instanceof Include_) {
+                        $this->res .= $this->dumpIncludeType($value);
+                        continue;
+                    }
+                    if ('type' === $key
+                            && ($node instanceof Use_ || $node instanceof UseItem || $node instanceof GroupUse)) {
+                        $this->res .= $this->dumpUseType($value);
+                        continue;
+                    }
+                }
+                $this->dumpRecursive($value);
+            }
+
+            if ($this->dumpComments && $comments = $node->getComments()) {
+                $this->res .= "$this->nl    comments: ";
+                $this->dumpRecursive($comments);
+            }
+
+            if ($this->dumpOtherAttributes) {
+                foreach ($node->getAttributes() as $key => $value) {
+                    if (isset(self::IGNORE_ATTRIBUTES[$key])) {
+                        continue;
+                    }
+
+                    $this->res .= "$this->nl    $key: ";
+                    if (\is_int($value)) {
+                        if ('kind' === $key) {
+                            if ($node instanceof Int_) {
+                                $this->res .= $this->dumpIntKind($value);
+                                continue;
+                            }
+                            if ($node instanceof String_ || $node instanceof InterpolatedString) {
+                                $this->res .= $this->dumpStringKind($value);
+                                continue;
+                            }
+                            if ($node instanceof Array_) {
+                                $this->res .= $this->dumpArrayKind($value);
+                                continue;
+                            }
+                            if ($node instanceof List_) {
+                                $this->res .= $this->dumpListKind($value);
+                                continue;
+                            }
+                        }
+                    }
+                    $this->dumpRecursive($value);
+                }
+            }
+            $this->res .= "$this->nl)";
+        } elseif (\is_array($node)) {
+            $this->res .= 'array(';
+            foreach ($node as $key => $value) {
+                $this->res .= "$this->nl    " . $key . ': ';
+                $this->dumpRecursive($value);
+            }
+            $this->res .= "$this->nl)";
+        } elseif ($node instanceof Comment) {
+            $this->res .= \str_replace("\n", $this->nl, $node->getReformattedText());
+        } elseif (\is_string($node)) {
+            $this->res .= \str_replace("\n", $this->nl, (string)$node);
+        } elseif (\is_int($node) || \is_float($node)) {
+            $this->res .= $node;
+        } elseif (null === $node) {
+            $this->res .= 'null';
+        } elseif (false === $node) {
+            $this->res .= 'false';
+        } elseif (true === $node) {
+            $this->res .= 'true';
+        } else {
+            throw new \InvalidArgumentException('Can only dump nodes and arrays.');
+        }
+        if ($indent) {
+            $this->nl = \substr($this->nl, 0, -4);
+        }
+    }
+
+    protected function dumpFlags(int $flags): string {
+        $strs = [];
+        if ($flags & Modifiers::PUBLIC) {
+            $strs[] = 'PUBLIC';
+        }
+        if ($flags & Modifiers::PROTECTED) {
+            $strs[] = 'PROTECTED';
+        }
+        if ($flags & Modifiers::PRIVATE) {
+            $strs[] = 'PRIVATE';
+        }
+        if ($flags & Modifiers::ABSTRACT) {
+            $strs[] = 'ABSTRACT';
+        }
+        if ($flags & Modifiers::STATIC) {
+            $strs[] = 'STATIC';
+        }
+        if ($flags & Modifiers::FINAL) {
+            $strs[] = 'FINAL';
+        }
+        if ($flags & Modifiers::READONLY) {
+            $strs[] = 'READONLY';
+        }
+
+        if ($strs) {
+            return implode(' | ', $strs) . ' (' . $flags . ')';
+        } else {
+            return (string) $flags;
+        }
+    }
+
+    /** @param array<int, string> $map */
+    private function dumpEnum(int $value, array $map): string {
+        if (!isset($map[$value])) {
+            return (string) $value;
+        }
+        return $map[$value] . ' (' . $value . ')';
+    }
+
+    private function dumpIncludeType(int $type): string {
+        return $this->dumpEnum($type, [
+            Include_::TYPE_INCLUDE      => 'TYPE_INCLUDE',
+            Include_::TYPE_INCLUDE_ONCE => 'TYPE_INCLUDE_ONCE',
+            Include_::TYPE_REQUIRE      => 'TYPE_REQUIRE',
+            Include_::TYPE_REQUIRE_ONCE => 'TYPE_REQUIRE_ONCE',
+        ]);
+    }
+
+    private function dumpUseType(int $type): string {
+        return $this->dumpEnum($type, [
+            Use_::TYPE_UNKNOWN  => 'TYPE_UNKNOWN',
+            Use_::TYPE_NORMAL   => 'TYPE_NORMAL',
+            Use_::TYPE_FUNCTION => 'TYPE_FUNCTION',
+            Use_::TYPE_CONSTANT => 'TYPE_CONSTANT',
+        ]);
+    }
+
+    private function dumpIntKind(int $kind): string {
+        return $this->dumpEnum($kind, [
+            Int_::KIND_BIN => 'KIND_BIN',
+            Int_::KIND_OCT => 'KIND_OCT',
+            Int_::KIND_DEC => 'KIND_DEC',
+            Int_::KIND_HEX => 'KIND_HEX',
+        ]);
+    }
+
+    private function dumpStringKind(int $kind): string {
+        return $this->dumpEnum($kind, [
+            String_::KIND_SINGLE_QUOTED => 'KIND_SINGLE_QUOTED',
+            String_::KIND_DOUBLE_QUOTED => 'KIND_DOUBLE_QUOTED',
+            String_::KIND_HEREDOC => 'KIND_HEREDOC',
+            String_::KIND_NOWDOC => 'KIND_NOWDOC',
+        ]);
+    }
+
+    private function dumpArrayKind(int $kind): string {
+        return $this->dumpEnum($kind, [
+            Array_::KIND_LONG => 'KIND_LONG',
+            Array_::KIND_SHORT => 'KIND_SHORT',
+        ]);
+    }
+
+    private function dumpListKind(int $kind): string {
+        return $this->dumpEnum($kind, [
+            List_::KIND_LIST => 'KIND_LIST',
+            List_::KIND_ARRAY => 'KIND_ARRAY',
+        ]);
+    }
+
+    /**
+     * Dump node position, if possible.
+     *
+     * @param Node $node Node for which to dump position
+     *
+     * @return string|null Dump of position, or null if position information not available
+     */
+    protected function dumpPosition(Node $node): ?string {
+        if (!$node->hasAttribute('startLine') || !$node->hasAttribute('endLine')) {
+            return null;
+        }
+
+        $start = $node->getStartLine();
+        $end = $node->getEndLine();
+        if ($node->hasAttribute('startFilePos') && $node->hasAttribute('endFilePos')
+            && null !== $this->code
+        ) {
+            $start .= ':' . $this->toColumn($this->code, $node->getStartFilePos());
+            $end .= ':' . $this->toColumn($this->code, $node->getEndFilePos());
+        }
+        return "[$start - $end]";
+    }
+
+    // Copied from Error class
+    private function toColumn(string $code, int $pos): int {
+        if ($pos > strlen($code)) {
+            throw new \RuntimeException('Invalid position information');
+        }
+
+        $lineStartPos = strrpos($code, "\n", $pos - strlen($code));
+        if (false === $lineStartPos) {
+            $lineStartPos = -1;
+        }
+
+        return $pos - $lineStartPos;
+    }
+}

package/plugins/nikic/php-parser/lib/PhpParser/NodeFinder.php

@@ -0,0 +1,90 @@
+<?php declare(strict_types=1);
+
+namespace PhpParser;
+
+use PhpParser\NodeVisitor\FindingVisitor;
+use PhpParser\NodeVisitor\FirstFindingVisitor;
+
+class NodeFinder {
+    /**
+     * Find all nodes satisfying a filter callback.
+     *
+     * @param Node|Node[] $nodes Single node or array of nodes to search in
+     * @param callable $filter Filter callback: function(Node $node) : bool
+     *
+     * @return Node[] Found nodes satisfying the filter callback
+     */
+    public function find($nodes, callable $filter): array {
+        if ($nodes === []) {
+            return [];
+        }
+
+        if (!is_array($nodes)) {
+            $nodes = [$nodes];
+        }
+
+        $visitor = new FindingVisitor($filter);
+
+        $traverser = new NodeTraverser($visitor);
+        $traverser->traverse($nodes);
+
+        return $visitor->getFoundNodes();
+    }
+
+    /**
+     * Find all nodes that are instances of a certain class.
+
+     * @template TNode as Node
+     *
+     * @param Node|Node[] $nodes Single node or array of nodes to search in
+     * @param class-string<TNode> $class Class name
+     *
+     * @return TNode[] Found nodes (all instances of $class)
+     */
+    public function findInstanceOf($nodes, string $class): array {
+        return $this->find($nodes, function ($node) use ($class) {
+            return $node instanceof $class;
+        });
+    }
+
+    /**
+     * Find first node satisfying a filter callback.
+     *
+     * @param Node|Node[] $nodes Single node or array of nodes to search in
+     * @param callable $filter Filter callback: function(Node $node) : bool
+     *
+     * @return null|Node Found node (or null if none found)
+     */
+    public function findFirst($nodes, callable $filter): ?Node {
+        if ($nodes === []) {
+            return null;
+        }
+
+        if (!is_array($nodes)) {
+            $nodes = [$nodes];
+        }
+
+        $visitor = new FirstFindingVisitor($filter);
+
+        $traverser = new NodeTraverser($visitor);
+        $traverser->traverse($nodes);
+
+        return $visitor->getFoundNode();
+    }
+
+    /**
+     * Find first node that is an instance of a certain class.
+     *
+     * @template TNode as Node
+     *
+     * @param Node|Node[] $nodes Single node or array of nodes to search in
+     * @param class-string<TNode> $class Class name
+     *
+     * @return null|TNode Found node, which is an instance of $class (or null if none found)
+     */
+    public function findFirstInstanceOf($nodes, string $class): ?Node {
+        return $this->findFirst($nodes, function ($node) use ($class) {
+            return $node instanceof $class;
+        });
+    }
+}