php-ast
php-cs-fixer
PHP-CS-Fixer 是一个开源工具,它可以强制执行和检测违反 PHP 编码风格的行为。 使用预定义的规则,它可以使您拥有严格的编码风格,该风格由工具强制执行,因此您可以将时间花在更重要的事情上。
安装过程
在github上其实给出了很多种安装方式,我直接下载了php-cs-fixer.phar文件并将其存储在计算机上的某个位置。
还有其他版本的方式:全局(手动)
php-cs-fixer
您可以运行这些命令以从系统上的任何位置轻松访问最新版本:
wget https://cs.symfony.com/download/php-cs-fixer-v3.phar -O php-cs-fixer
或指定版本:
wget https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/releases/download/v3.13.0/php-cs-fixer.phar -O php-cs-fixer
或curl:
curl -L https://cs.symfony.com/download/php-cs-fixer-v3.phar -o php-cs-fixer
然后给用户添加使用权限:sudo chmod a+x php-cs-fixer
移动当可以直接运行命令的地方sudo mv php-cs-fixer /usr/local/bin/php-cs-fixer
现在就用到了composer这个命令,composer是PHP的包管理、包依赖关系管理工具,有了它,我们就很轻松一个命令就可以把他人优秀的代码用到我们的项目中来,而且很容易管理依赖关系,更新删除等操作也很轻易的实现。具体的使用用法参见这里
composer global require friendsofphp/php-cs-fixer
记得添加环境变量啊,使他能全局使用export PATH="$PATH:$HOME/.composer/vendor/bin"
php-ast
PHP7 的内核中有一个重要的变化是加入了 AST。在 PHP5中,从 php 脚本到 opcodes 的执行的过程是:
- Lexing:词法扫描分析,将源文件转换成 token 流;
- Parsing:语法分析,在此阶段生成 op arrays。
PHP7 中在语法分析阶段不再直接生成 op arrays,而是先生成 AST,所以过程多了一步:
- Lexing:词法扫描分析,将源文件转换成 token 流;
- Parsing:语法分析,从 token 流生成抽象语法树;
- Compilation:从抽象语法树生成 op arrays。
从这里下载源码进行安装编译
phpize
./configure
make
sudo make install
另外添加extension=ast.so
到您的php.ini
文件中。
可以使用ast\parse_code()
接受代码字符串的 或 ast\parse_file()
接受文件路径的 来解析代码。此外,这两个函数都需要一个$version
参数来确保向前兼容。当前版本为90。但在之后的运行当中我们会发现这个数字在源码里是30,而我使用的php7.4版本是70,写到phpjoern再细说。
$ast = ast\parse_code('<?php ...', $version=70);
// or
$ast = ast\parse_file('file.php', $version=70);
这些函数返回的抽象语法树由ast\Node
对象组合而成。 ast\Node
声明如下:
namespace ast;
class Node {
public $kind;
public $flags;
public $lineno;
public $children;
}
该kind
属性指定节点的类型。它是一个整体值,对应于其中一个ast\AST_*
常量,例如ast\AST_STMT_LIST
。有相关可用节点类型的概述,请参阅 AST节点类型。
该flags
属性包含节点特定的标志。 它始终被定义,但对于大多数节点而言,它始终为零。 有关不同节点类型支持的标志列表,请参阅标志部分。
该lineno
属性指定节点的起始行号。
该children
属性包含一个子节点数组。 这些孩子可以是其他 ast\Node 对象或普通值。 有两种一般的节点类别:普通 AST 节点,它有一组固定的命名子节点,以及列表节点,它有可变数量的子节点。 AST 节点种类部分包含不同节点种类的子名称列表。
phpjoern
它使用php-ast
扩展从 PHP 项目生成 AST,并将这些导出到适合由 Joern 解析的 CSV 文件。目前这个文件已经不更新了,所有很多地方都不兼容,需要自己手动修改。
解析器在 PHP 中实现并使用扩展php-ast
。存储库根目录中名为的简单 Bash 包装器脚本 php2ast
用作入口点。它以 PHP 文件或目录的路径作为参数。如果提供的参数是一个目录,解析器将递归地搜索该目录中的所有 PHP 文件并为每个文件生成一个 AST。
在执行脚本之前,$PHP7
应将环境变量设置为php
PHP 7 可执行文件的位置。如果未设置此类变量,/usr/bin/php
则默认使用该位置。
用法示例:
./php2ast somefile.php
./php2ast somedirectory/
这些调用中的任何一个都将生成两个 CSV 文件nodes.csv
并rels.csv
分别表示生成的 AST 的节点及其关系。此外,还会创建目录和文件节点并将其连接到各个 AST 根节点,以反映扫描目录的结构并获得单个大树。
PHP Fatal error: Uncaught LogicException: Unknown version 30. Current version is 90. All versions (including experimental): {50, 60, 70, 80, 85, 90} in /home/parallels/php-fuzz/phpjoern/src/Parser.php:185
这个问题就是由于版本不统一造成的,我们根据他出错位置找到对应代码,改成70
重新运行命令发现又出错了
PHP Fatal error: Uncaught Error: Undefined constant 'ast\flags\ASSIGN_BITWISE_OR' in /home/parallels/php-fuzz/phpjoern/src/util.php:135
这个问题原因也一样,代码里的功能比较老旧,导致很多代码其实也不兼容php7.4了,查过资料之后知道直接注释掉这段就好其实他自己都说了这是old version了。
最后运行结果就会生成两个csv