fuhrystudio/system-shell

一个用于尽可能安全地从PHP中执行程序的库。

dev-master 2017-09-09 17:42 UTC

This package is auto-updated.

Last update: 2024-09-22 04:37:56 UTC


README

PHP命令执行的对象接口。鼓励更安全的参数处理。这是一个干净室、无版权限制的重新实现,我在雇主的项目中实现了这些功能。

功能

execf()/vexecf():printf样式的格式化命令

我编写这个类的初衷是为了鼓励自己和工程师们对任何类型的命令行参数进行严格转义 - 即使是来自应用程序其他部分的半信任数据。

为了实现这个目标,execf() 方法接受三个参数

  • $command:要执行的基命令,即要运行的可执行文件。示例:ls
  • $argTemplate:参数的printf样式模板字符串。您可以在其中包含开关,但不应包含任何用户数据。用户数据的占位符不应加引号。示例:-la %s
  • ...$args:传递给sprintf()的参数。这里的用户数据不应加引号;所有参数都将转换为字符串并适当地引号化,以便用于命令行。

PATH解析

Shell类使用一个IResolver(默认为PathEnvironmentResolver)来计算在运行之前可执行文件的全路径。如果系统的PATH为空,则使用合理的默认值。

日志记录

Shell类实现了PSR-3 LoggerAwareInterface,因此您可以提供任何日志记录器来记录命令执行和结果。

分离的stdout/stderr捕获

从所有命令返回的ExecuteResult实例有三个方法

  • getExitStatus:返回进程的整数退出状态
  • getStandardOutput:返回进程的标准输出字符串
  • getStandardError:返回进程的标准错误字符串

自动异常

您可以指示Shell在命令失败时自动抛出异常

$shell->throwsExceptionOnErrorExit(true)->execf('false'); // throws ShellException

待办事项

  • 添加对装饰器的支持(sudo、超时等?)
  • 添加控制日志记录行为的能力 - 启用/禁用分析、参数日志记录等。
  • 添加对提供标准输入的支持

许可证

THE MIT LICENSE

Copyright (c) 2017 Dan Fuhry

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.