buting / cliapp-updater
Framework-independent PHP updater for the apps.cli.cc release and licensing service
Package info
github.com/BuTingBa/cliapp-updater
Type:composer-plugin
pkg:composer/buting/cliapp-updater
Requires (Dev)
None
Suggests
- ext-sodium: Required only for offline Ed25519 license verification
Provides
None
Conflicts
None
Replaces
None
README
框架无关的 PHP 应用更新库,配合 apps.cli 发布与授权服务使用。提供更新检查、日志查询、完整包/文件级增量下载与安装、文件清单校验、备份回滚及离线授权验签。支持在 ThinkPHP/FPM、Webman、队列和 CLI 中调用,应用运行时不依赖第三方 PHP 包。Composer 插件负责首次安装时生成项目配置;更新操作由应用显式调用。
环境要求与安装
- Composer 2;Composer 2.2 及以上须在项目中允许本插件执行。
- 64 位 PHP 7.2 及以上,Composer 约束为
>=7.2。 - 必需扩展:
curl、hash、json、zip。 - 可选扩展:
sodium用于 Ed25519 离线验签;intl用于国际化域名转换。 - PHP 运行账户能够读写应用文件和工作目录,并有足够空间保存下载包、解压文件和旧文件备份。
composer config allow-plugins.buting/cliapp-updater true
composer require buting/cliapp-updater:^2.1.2
安装后自动在使用本包的项目根目录创建 .updater/ 和 updater.php,配置已关联这两个路径。填写 updater.php 中的中心地址、产品 Code、产品密钥和当前版本序号后即可使用。安装过程不联网检查业务更新、不安装应用版本、不生成授权。
已有项目更新依赖:
composer require buting/cliapp-updater:^2.0
插件类型为 composer-plugin,composer-plugin-api:^2.0 是 Composer 提供的虚拟接口,不会安装额外运行库。自动初始化发生在 post-autoload-dump,因此安装、更新和重新生成自动加载文件时都会检查;已有配置和状态不覆盖,卸载包时也不删除。
使用 --no-plugins 或禁止本插件时不会自动创建,可手动执行:
php vendor/bin/cli-app-updater init
不要用依赖包的 scripts 代替插件:Composer 只执行根项目脚本。详见 Composer 插件 与 allow-plugins。
从 1.x 升级: 2.x 的 check() 可能直接安装强制版本,调用点必须具备升级权限、维护准备和足够执行时间;原来仅用于展示的检查入口应改为受控后台操作。已有外置 work_dir 可继续使用;新生成的模板不会迁移旧状态,应在切换入口前填入原目录或完整迁移原目录内容。
命名空间为 BuTing\CliAppUpdater,命令入口为 vendor/bin/cli-app-updater。应用应提交 composer.lock 固定依赖版本。
快速开始
<?php require __DIR__ . '/vendor/autoload.php'; use BuTing\CliAppUpdater\Updater; // updater.php 是可信本地配置文件,默认使用它所在的目录作为应用根目录。 $updater = Updater::fromFile(__DIR__ . '/updater.php'); // 在有升级权限、已准备维护与写入暂停的操作入口调用。 // 普通更新只返回信息;强制更新在本次调用中安装完成。 $release = $updater->check(); $display = Updater::summary($release); if ($release['installed']) { // 已完成强制更新,不再弹出升级确认;按应用流程重载进程或结束维护。 } elseif ($release['update']) { // 普通版本:展示说明,用户确认后调用 update()。 } // 展示安装实例标识,不需要网络请求。 $clientKey = $updater->getClientKey();
在应用已完成权限校验、进入维护并暂停相关写入后,安装只需调用:
$result = $updater->update(); // null:没有可获取的新版本。 // array:安装完成,返回版本摘要、备份目录、实际包类型及保留文件列表。
update() 自行检查并下载,不需要预先调用 check()、status() 或 download()。check() 的完整结果含授权信息和下载票据;展示版本信息时使用 Updater::summary()。
配置
new Updater(array $config)
配置在构造时传入。Updater 没有公开属性或常量;修改配置需创建新实例。
| 参数 | 类型 | 默认值 | 含义与限制 |
|---|---|---|---|
base_url |
string | 必填 | 可信中心地址,如 https://updates.example.com;可带部署子路径,不含用户名、密码、查询串或片段 |
product_code |
string | 必填 | 中心产品 Code,不是数据库 ID;由库编码为 URL 路径 |
product_key |
string | 必填 | 产品通信密钥,发送到 Product-Key 请求头 |
project_dir |
string | 必填 | 被更新的应用根目录,必须已存在;建议绝对路径 |
work_dir |
string | project_dir/.updater |
私有持久工作目录,可自动创建;允许位于项目内,不能等于或包含项目根目录 |
version_code |
int | 0 |
首次初始化时的已安装版本序号,范围 0~9007199254740991;已有状态后以状态为准 |
client_key |
string | '' |
安装实例 ID;空串自动生成。显式值为 8~64 位字母、数字、下划线或短横线,须与已有状态一致 |
machine_id |
string|null | null |
null 自动探测系统 ID;非空串提供最多 512 字节的稳定实例 ID;'' 禁用探测并使用持久随机 ID |
upgrade_token |
string | '' |
可选客户在线凭证,发送到 Upgrade-Token;空串时中心按安装实例查找授权 |
domain |
string | '' |
可信配置中的域名;无协议、端口、路径,不接受 IP。无需域名绑定时可为空 |
client_name |
string | '' |
上报给中心的安装实例名称 |
channel |
string | 'stable' |
发布渠道:stable 或 beta |
prefer_delta |
bool | true |
条件满足时优先使用更小的增量包;false 强制完整包 |
exclude |
string|string[] | [] |
按顺序匹配的排除规则,支持多行文本或字符串数组,见下文 |
hooks |
array<string, callable> | [] |
check() 强制安装、update() 和 rollback() 共用的默认回调;同名调用参数覆盖配置回调 |
preserve |
string[] | [] |
追加保护路径,相对项目根目录;目录包含子路径,不支持通配符 |
max_package_bytes |
int | 2147483648 |
单个 ZIP 的最大下载字节数,正整数,默认 2 GiB |
http |
array | [] |
HTTP 选项,见下表 |
archive_limits |
array | [] |
解压与清单限制,见下表 |
version_code 是单调递增的整数,不是显示版本字符串。示例:版本 1.2.0 可对应序号 10200;显示版本由中心返回,客户端按序号判断新旧。
本地改动、中心迁移与跨版本升级(v2.1.1+)
更新不要求本地代码与上一版完全一致,也不要求逐个版本安装。例如已安装序号 10,中心提供序号 50,可以直接升级。对版本的比较使用整数 version_code;显示版本字符串不参与大小判断。
| 情况 | 自动处理 |
|---|---|
| 本地文件被修改或删除,无法使用增量基准 | 改用完整包,将新包包含的非保护文件更新到目标版本 |
| 增量下载期间本地基准发生变化 | 放弃本次增量,下载同一目标版本的完整包;不要求用户再次发起更新 |
| 增量声明的基础包哈希与本地记录不一致 | 改用完整包 |
修改 base_url 的域名、端口、协议或部署子路径 |
复用本地实例 key、版本与备份;新地址首次安装使用完整包,成功后可继续使用增量 |
| 中心版本跨过多个中间版本 | 直接安装中心提供的更高序号版本;应用迁移代码需支持这个版本跨度 |
完整包更新会覆盖新包包含的本地改动。要长期保留的文件应加入 exclude / preserve;内置保护规则继续生效。回滚恢复的是更新前实际存在的文件,包括当时的本地修改。未被新包包含的自建文件和本地修改过的废弃文件仍按文件保护规则保留。
迁移中心地址: 先将更新器升级至 v2.1.1 或以上,再在根 updater.php 修改 base_url,使用新中心对应的 product_key 和授权配置,保持原 product_code、project_dir、work_dir。直接调用 update() 或原有后台升级入口即可,无需删除 .updater、重新生成 client_key 或手动修改状态文件。base_url 是中心根地址,可包含部署子路径,不是 /api/{product_code}?action=... 的完整接口 URL。
旧版状态首次读取时自动兼容,保留原 key、机器摘要、版本、文件清单和恢复记录。旧格式只保存包含地址的不可逆摘要,无法取回旧地址;因此将当前配置对应的本地旧状态接纳为当前安装,无法确认包来源时使用完整包。后续包 ID 按中心地址区分,旧中心的 ID 不会直接用于新中心的增量匹配。末尾 / 的增减不视为地址变化。
version_code 配置仍用于首次初始化,已有状态以 status()['version_code'] 为准。修改中心地址不会重置已安装版本;中心目标序号必须大于该值。发生版本比较错误时,异常会列出目标和本地已安装序号,便于核对,不能只比较页面上显示的版本名称。
增量基准回退最多发生一次,只有完整包进入应用回调;覆盖开始后的失败走原有恢复机制,不重复安装或重复运行回调。完整包仍须通过授权、下载哈希、路径及内容校验;基准不匹配不再阻止完整更新,损坏的包和未完成的恢复事务仍会报错。
updater.php 与排除规则
根目录 updater.php 返回上述配置数组,不接受 HTTP 参数、不直接执行升级。可以使用环境变量提供密钥,也可填写本地值;包含密钥的配置不要提交 Git。初始化模板见 resources/updater.php。
'exclude' => [ '# 每行一条规则,也可传入多行字符串', '/config/local.php', '/customer-data/', '*.log', 'assets/**/local-*.json', '!/assets/default/local-example.json', ],
| 语法 | 含义 |
|---|---|
空行、以 # 开头 |
忽略;每条规则先去掉首尾空白 |
*.log、cache/ |
无路径分隔的名称匹配任意层级;尾部 / 仅匹配该目录内的文件 |
/config.php |
开头 / 将规则锚定到项目根目录 |
config/local.php |
包含中间 / 的规则也从根目录匹配 |
*、? |
匹配一个路径段内的任意字符、一个字符,不跨 / |
**、**/ |
跨目录匹配;**/ 可匹配零层或多层目录 |
!规则 |
取消先前的自定义排除,最后一条匹配规则生效 |
规则不区分大小写,使用 / 分隔;不支持反斜杠转义和字符范围语法,[、] 按普通字符匹配。这里只匹配每个文件的路径,不复刻 Git 的目录遍历规则,因此允许 cache/ 后用 !cache/keep.txt 重新包含文件。
排除同时用于完整包、增量包、本地基准核验和废弃文件清理。内置保护与 preserve 优先于所有排除规则,不能通过 ! 取消;.updater/、根 updater.php 和实际工作目录始终受保护。回滚按事务中记录的备份恢复,不会因之后修改排除配置而改变原事务。
HTTP 选项
以下字段放在 http 数组内:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
allow_http |
bool | false |
允许明文 HTTP;用于本地开发 |
connect_timeout |
int | 10 |
单次连接超时,正整数秒 |
timeout |
int | 30 |
单次 API 或清单请求总超时,正整数秒 |
download_timeout |
int | 1800 |
单次 ZIP 下载总超时,正整数秒 |
ca_file |
string | '' |
自定义可信 CA 文件;空串使用运行环境默认 CA |
HTTPS 校验证书与主机名,不跟随重定向。API 响应上限为 2 MiB,清单响应上限为 16 MiB;传输连续 60 秒低于 1 字节/秒会中止。HTTP 超时仅控制出站请求,不延长 FPM 或代理的入站请求时限。
解压限制
以下字段放在 archive_limits 数组内:
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
max_files |
int | 50000 |
完整 ZIP 条目及安装清单文件数上限;增量 ZIP 另允许一个元数据条目,删除清单也受此数量限制 |
max_expanded_bytes |
int | 10737418240 |
ZIP 解压总量及安装清单总大小上限,默认 10 GiB |
两个值均为正整数。ZIP 条目计数包含目录;增量 ZIP 解压总量包含 update.json。
$config['http'] = [ 'connect_timeout' => 10, 'timeout' => 30, 'download_timeout' => 600, ]; $config['archive_limits'] = [ 'max_files' => 20000, 'max_expanded_bytes' => 2147483648, ];
目录布局与持久状态
/srv/shop/app/ project_dir:应用根目录
├── app/
├── public/ Web 入口目录
├── vendor/
├── .env
├── updater.php 本地配置、排除规则与回调
└── .updater/ work_dir:私有持久目录,禁止运行缓存清理删除
├── state.json 实例 ID、已安装版本与文件基准
├── update.lock 跨进程排他锁
├── transaction.json 最近文件事务
├── downloads/
└── backups/
ZIP 根目录直接映射到 project_dir,不能额外套一层项目文件夹。工作目录可以位于项目内,会自动加入保护路径,不参与文件覆盖和废弃清理;也可继续使用原有项目外目录。不能放进 vendor、Web 公开目录或会自动清理的临时目录。同一安装的 HTTP、队列和 CLI 必须共用它。
自动创建的 .updater 包含 .gitignore、Apache .htaccess 拒绝规则与 IIS web.config 拒绝规则;是否生效取决于服务器配置。Nginx 不读取这两个文件,若项目根可经 HTTP 访问,需要自行添加 location ^~ /.updater/ { deny all; }。
新工作目录使用 0700,新配置文件使用 0600(Windows 按系统 ACL 管理)。Composer 部署账户与 PHP 运行账户不同时,部署时须设置适当属主或 ACL,使 PHP 能读取配置并读写工作目录。
宝塔的 open_basedir 应允许整个应用根目录,网站入口仍设为 public,无需开放父目录。FTP 只需访问应用目录。若项目没有 public 分层、整个项目都可由 HTTP 访问,须先在 Nginx/Apache 禁止访问工作目录,不能依赖目录名字隐藏;FTP 权限不能替代 PHP 运行用户的写权限。
已有安装修改 work_dir 时,先停止更新任务,完整移动原目录内容,再修改配置;不要只新建空目录,否则会丢失已安装版本、文件基准和回滚记录。工作目录不属于可随意清理的运行缓存。
Updater API
以下为应用接入的全部公开方法。实例方法共用 work_dir 的非阻塞排他锁:其他操作持锁时立即抛异常,不排队。status() 和 getClientKey() 也取锁。静态方法 summary() 和配置加载方法 fromFile() 不取锁。
Updater::fromFile(string $path): Updater
加载可信的本地 PHP 配置文件并构造实例。path 为文件路径;文件必须存在并返回数组,未提供 project_dir 时采用配置文件所在目录。相对路径按当前工作目录解析,推荐传绝对路径。加载会执行该 PHP 文件,因此路径不能来自用户输入。构造时创建工作目录,不发业务请求;首次调用身份相关方法时才生成状态。
Setup::initialize(string $projectDir): array
手动初始化入口,也由 Composer 插件和 CLI init 调用。projectDir 必须是已存在的项目目录。返回 config_file、work_dir 两个绝对路径,创建缺失的目录、访问保护文件和配置模板,保留已有文件。它不校验已有配置内容,不生成 client_key,不自动修改项目 .gitignore。既有 work_dir 配置仍由应用加载时生效。
getClientKey(): string
读取或首次生成安装实例标识,无参数、无网络请求。可单独调用,无需先初始化其他方法。
生成与复用规则:
- 已有状态时复用原
client_key,显式配置必须与其一致。 - 新状态优先使用显式配置的
client_key。 - 否则按系统 ID、产品 Code、项目真实路径派生 32 位十六进制 ID,中心地址不参与新 ID 的派生。
- 无法取得系统 ID 时生成随机 ID,并写入
work_dir/state.json。
Linux 读取 /etc/machine-id,备选 /var/lib/dbus/machine-id;Windows 查询 MachineGuid。Windows 探测可选使用 proc_open 调用系统 reg.exe,不可用时回退随机 ID。原始系统 ID 不写入状态、不上传中心。
同一机器的不同项目路径会产生不同实例 ID。克隆镜像或容器时应提供独立且持久的 machine_id,复制出的新站点使用新的工作目录。已有状态检测到不同机器标识时拒绝使用。ID 可重新派生不意味着版本记录和备份可重建,不应删除状态来重置版本。
v2.1.0 及以前生成的 key 保持原值,原机器派生种子也保留用于校验;升级后不会切换成新算法生成的 key。删除旧状态后按新算法重新派生,不能保证得到旧 key,因此更换中心地址应保留整个工作目录。
status(): array
读取本地已提交状态,无参数、无网络请求;首次调用可能创建状态。v2.1.2 起,状态文件缺失但事务记录仍在时,按下述规则恢复。
| 字段 | 类型 | 说明 |
|---|---|---|
client_key |
string | 安装实例 ID |
client_key_source |
string | configured、machine、random 或 legacy |
version_code |
int | 当前已提交版本序号 |
version |
string,可缺省 | 成功安装后记录的显示版本 |
updated_at |
string,可缺省 | 安装提交时间,UTC ISO 8601;回滚后恢复旧值 |
package_id |
int,可缺省 | 目标完整包 ID;0 表示未知,不能用于增量匹配 |
package_sha256 |
string,可缺省 | 目标完整 ZIP 的 SHA-256 |
transaction_status |
string | none、applying、complete、rolling_back、rolled_back 或 unknown |
不返回内部安装身份摘要、机器摘要和文件清单。此方法不是进度接口;安装持锁时同样会被拒绝。complete 表示文件与版本已提交,不保证后续回调或框架重载成功。
状态文件缺失时的恢复(v2.1.2+)
当 state.json 缺失、transaction.json 仍在时,status()、getClientKey() 及其他需要读取状态的方法自动利用事务记录恢复,无需手动创建状态或重新授权。恢复仍验证项目路径、安装身份、显式配置 key 和可获取的机器标识;不修改应用文件、不运行回调、不改写原事务记录。
| 事务状态 | 恢复行为 |
|---|---|
complete |
保留事务中的原实例 key,采用该事务目标版本;清除无法重建的完整文件基准、包 ID、包哈希和提交时间。后续有更新时使用完整包,成功后重建增量基准 |
rolled_back |
恢复事务中的更新前状态,包括原版本和文件基准;可以继续更新 |
applying / rolling_back |
读取状态时恢复更新前的已提交记录,但不将当前文件视为完整旧版或新版。check() / update() 仍要求先恢复事务;可直接调用 rollback(),不必先调用 status() |
| 事务损坏、身份不匹配或状态无法识别 | 抛异常,不生成替代 key,也不写入新状态 |
完整事务只保存变化文件的恢复计划,不能重建新版完整清单。缺失状态恢复后的首次完整包安装不会清理无法确认归属的旧文件;新包包含的非保护文件正常覆盖。已有但损坏的 state.json 不属于自动恢复范围,应从可信备份恢复。状态和事务同时不存在时,按首次安装初始化,不能自动找回随机 key 或历史版本。
接入层应使用 status()['version_code'] 获取更新器记录的版本。若应用自行要求该值始终等于 config/app.php,这属于应用的额外限制,SDK 无法取消该检查;手工改动应用版本后,应由接入层明确登记实际部署版本。SDK 不读取或执行应用的 config/app.php,也不会猜测版本号。
report(): array
登记实例并上报当前版本、platform=php、渠道、域名及操作系统/PHP 信息。无参数,使用 POST 请求。返回:
| 字段 | 类型 | 说明 |
|---|---|---|
registered |
bool | 成功为 true |
client_id |
int | 中心安装实例记录 ID |
last_time |
string | 中心记录的最近上报时间 |
登记不授予更新权益。check()、authorize() 和 changelog() 也会在中心登记实例,通常不必单独调用。
authorize(): array
在线验证更新权益,无参数,使用 POST 请求。拒绝时抛异常,成功返回:
| 字段 | 类型 | 说明 |
|---|---|---|
authorized |
bool | true |
license_value |
string|null | 在线凭证,公开产品可为 null |
expires_at |
string|null | 可获取版本的发布时间截止点;null 不限制,不是软件运行到期时间 |
license_mode |
int | 1 授权下载,2 公开下载 |
不安装文件,也不自动把返回凭证保存到配置。授权产品需在中心配置安装实例、域名、来源 IP 等绑定;product_key、client_key 和 upgrade_token 分别用于产品通信、实例识别和客户在线授权。
check(array $hooks = []): array
检查中心可获取的新版本,业务 API 使用 GET;自动初始化本地状态并登记实例。中心按产品、PHP 目标、渠道、发布状态和更新权益筛选版本。
当 update=true 且 force_update=true 时,直接同步下载并安装目标版本,不等待第二次调用或用户确认。授权、哈希、增量基准、保护路径、事务锁和回滚规则仍全部执行。hooks 与 update() 使用同一回调约定。
这不是只读方法:宿主应将入口设为有升级权限的 POST 操作,并处理 CSRF、维护状态和超时。只查看更新说明时可使用 changelog()。库不会在 Composer 安装、自动加载或普通页面请求时自行检查;需要自动发现版本时,由应用已有任务周期调用 check()。
| 字段 | 类型 | 返回条件与含义 |
|---|---|---|
update |
bool | 检查时有无更新;强制安装成功后本次仍为 true,应结合 installed 判断 |
force_update |
bool | 当前已安装版本与目标之间存在适用的强制版本时为 true;旧中心省略时补 false,非法类型抛异常 |
installed |
bool | 本次检查是否已完成强制安装;普通检查与无更新均为 false |
installation |
array | 仅强制安装成功时存在,结构与 update() 的安装结果一致 |
status_code |
int | 有更新 200,无更新 304;这是业务字段,不是 HTTP 状态码 |
license_value |
string|null | 在线凭证 |
version |
string | 有更新:显示版本 |
version_code |
int | 有更新:递增版本序号 |
changelog |
string | 有更新:更新说明 |
published_at |
string | 有更新:中心记录的首次发布时间 |
package |
array | 有更新:目标完整包 |
delta_package |
array|null | 有更新:可选增量候选;未提供增量的中心可缺省 |
package 中与本库接入有关的字段:
| 字段 | 类型 | 说明 |
|---|---|---|
id |
int | 完整包 ID,安装后保存为增量基准 |
platform |
string | 必须为 php |
package_type |
int | 完整包为 1 |
file_name |
string | 扩展名必须为 .zip,不区分大小写 |
file_size |
int | ZIP 字节数,大于 0 且不超过 max_package_bytes |
sha256 |
string | ZIP 的 64 位小写十六进制 SHA-256 |
file_url |
string | 中心返回的受控相对下载票据路径 |
requirements |
string | 运行要求文本;库不自动解析或执行 |
config |
string|null,可缺省 | 中心完整包的扩展参数 JSON 对象原文;用 Updater::packageConfig($release) 解码 |
manifest_state |
string | 清单状态;ready 时可读取 |
manifest_url |
string|null | 受控清单票据路径 |
manifest_sha256 |
string | 清单原始 JSON 字节的 SHA-256 |
增量候选沿用包字段,package_type=2,另有整数 base_package_id 和 target_package_id。check() 提交持久状态中的基准 ID;返回候选不表示本地文件已经通过核验,实际选择在安装阶段完成,包括 check() 触发的强制安装。
中心可能返回其他元数据;库不使用 file_full_url 跨站下载,不执行扩展 config。原始结果不能直接交给浏览器或普通日志。授权拒绝、损坏响应和非法包信息会抛异常,不转换成 update=false。
changelog(string $direction = 'after', int $page = 1, int $size = 10): array
查询相对于本地已安装 version_code 的更新日志。
| 参数 | 默认值 | 取值 |
|---|---|---|
direction |
'after' |
after:之后的版本;before:之前的版本,均排除当前版本 |
page |
1 |
整数 1~1000000 |
size |
10 |
整数 1~100 |
$pending = $updater->changelog(); $history = $updater->changelog('before', 1, 20);
返回字段:list: array、total: int、page: int、size: int、direction: string、current_version_code: int。list 按版本序号倒序,每项包含 version: string、version_code: int、changelog: string、published_at: string、channel: string、force_update: bool;无结果时为 []。
筛选范围与更新检查一致。不下载包、不改变本地版本;首次调用可能初始化本地状态。长日志应减小 size 以满足 2 MiB 响应上限;展示时按应用规则转义或过滤 HTML。
download(array $release): string
传入近期 check() 的完整返回值,且 update=true。始终下载 release['package'] 的完整包,校验大小与 SHA-256,返回 work_dir/downloads 中 ZIP 的绝对路径。
只下载,不安装、不推进版本。成功文件由调用方保管或清理;失败的临时下载自动清理。不能传入 summary() 的结果,也不能将返回路径传给 update()。票据过期或来源 IP 变化后重新 check()。
$release = $updater->check(); if ($release['update'] && !$release['installed']) { $zipPath = $updater->download($release); }
manifest(array $release): array
传入近期 check() 的完整返回值,要求 update=true 且 package.manifest_state='ready'。读取并校验目标完整包清单,不修改应用文件或版本。
返回:
| 字段 | 类型 | 说明 |
|---|---|---|
schema |
string | apps.manifest.v1 |
files |
array | 相对文件路径到文件信息的映射 |
file_count |
int | 文件数 |
expanded_size |
int | 文件总字节数 |
每项文件信息为 ['size' => int, 'sha256' => string, 'mode' => int],mode 为 0644 或 0755(JSON 中为十进制 420 或 493)。校验原始字节哈希、路径、文件数量、大小和配置限额;未就绪、拒绝授权或校验失败均抛异常。
$release = $updater->check(); if ($release['update'] && ($release['package']['manifest_state'] ?? '') === 'ready') { $manifest = $updater->manifest($release); foreach ($manifest['files'] as $path => $file) { // $path 为项目相对路径,$file['size'] 为字节数。 } }
清单描述中心完整包,可能包含客户端保护路径;它不是删除本地额外文件的授权指令。
update(array $hooks = []): ?array
同步完成:取锁 → 检查授权与版本 → 选择完整/增量包并读取就绪清单 → 下载校验 → 审核完整 ZIP 目录表 → 根据清单比较本地文件 → 对变更路径预检 → 仅解压变化文件并校验 → 备份变更及恢复计划落盘 → 替换/删除 → 提交版本和文件基准 → 返回。旧中心没有就绪清单时,先解压校验再比较本地内容。
hooks 是可选回调数组,详见后文。无更新返回 null,不运行安装回调。成功返回版本摘要字段以及:
| 字段 | 类型 | 说明 |
|---|---|---|
backup_dir |
string | 本次事务备份的本地绝对路径 |
package_type |
int | 实际安装方式:1 完整,2 增量 |
retained_files |
string[] | 新版本已废弃、但因本地修改而保留的文件相对路径 |
updated_files |
int | 本次实际新增或替换的文件数量 |
unchanged_files |
int | 包内可安装文件中,与本地大小和 SHA-256 相同而跳过的数量;增量包未携带的文件不计入 |
deleted_files |
int | 本次实际执行废弃清理的文件数量 |
extracted_files |
int | 实际解压的应用文件数量,不含增量 update.json;有清单时未变化文件不解压 |
config |
array | 目标完整包扩展参数的解析结果,与 Updater::packageConfig($release) 相同 |
timings |
array<string, float> | 安装阶段耗时,单位秒;各值为独立时长,不是累计值,详见下表 |
timings 不含中心检查、增量选择、清单下载、ZIP 下载及下载文件清理;仅在安装成功时返回,不是实时进度接口。
| 阶段 | 包含工作 |
|---|---|
baseline |
初始化暂存/备份目录、读取旧状态、安装前增量基准复核、清单格式校验 |
archive_scan |
ZIP 目录表、增量元数据、路径类型、数量大小与声明文件核对 |
local_compare |
有清单时读取本地文件并比较大小、SHA-256 |
preflight |
变更目标和备份条件、父目录写入探测、空间检查 |
extract_verify |
选择性批量解压、实际大小、CRC 和 SHA-256 核验 |
plan_backup |
生成完整基准、废弃清理判断、目标清单核对、备份和恢复记录;无清单时的本地比较也计入此项 |
apply |
before_apply、文件替换/删除、after_apply |
commit_cleanup |
写入版本状态及事务完成状态、清理暂存目录 |
after_commit |
提交后的应用回调 |
返回的 update=true 是本次安装的版本摘要,不表示还有下一个版本。安装失败会尝试恢复文件和版本;提交后回调失败不撤销已提交结果,见错误处理。
rollback(array $hooks = []): void
恢复最近一次事务:还原覆盖或删除的旧文件,移除新增文件及事务创建的空目录,恢复原版本和文件基准。恢复前检查全部备份完整性。
无事务时抛异常;事务已为 rolled_back 时直接返回。不能选择任意历史备份,不回滚数据库或外部服务。备份目录和状态文件必须保留。
Updater::summary(array $release): array
静态字段筛选方法,返回输入中存在的 update、installed、status_code、version、version_code、changelog、published_at,并添加布尔 force_update(严格等于 true 才为真)和 requirements(取自 package.requirements,缺省 '')。
不包含凭证、票据、包详情或本地备份路径。不验证输入,不取锁;结果用于展示,不能再传给 download() 或 manifest()。
Updater::packageConfig(array $release): array
从 check() 完整响应的 package.config 解析中心扩展参数。静态方法,不联网、不取锁、不安装。无更新、字段缺省、null、空字符串或空对象 {} 返回 [];非对象 JSON、非法 JSON 或非字符串值抛 RuntimeException。
中心发布版本时,在完整包的扩展配置中填写 JSON 对象,例如:
{"migration_required": true, "schema_version": 12, "notice": "升级后请刷新缓存"}
// 已完成权限校验和维护准备;check() 可能同步安装强制版本。 $release = $updater->check(); $parameters = Updater::packageConfig($release); $schemaVersion = $parameters['schema_version'] ?? null; // 按业务需要读取字段,验证类型;仅将允许公开的字段交给前端。 $notice = is_string($parameters['notice'] ?? null) ? $parameters['notice'] : '';
JSON 对象递归转换为关联数组,JSON 数组、布尔、数字和 null 按 PHP JSON 解码规则保留;需要无损表达的大整数应由中心写为字符串。该方法只校验外层对象,业务字段及其类型由调用者定义和验证。
update() 的返回值、强制安装的 check()['installation'] 及安装回调参数均包含解析后的 config。无更新时 update() 仍返回 null。增量安装使用目标完整包的配置,不使用增量容器的配置。
$result = $updater->update([ 'after_apply' => static function (array $release): void { $parameters = $release['config']; if (($parameters['migration_required'] ?? false) === true) { // 调用应用自己的迁移入口;迁移的事务和失败恢复由应用管理。 } }, ]); if ($result !== null) { $parameters = $result['config']; }
扩展参数只作为数据传递,不自动执行命令、脚本或迁移,不覆盖本地 updater.php、排除规则或更新器配置。summary() 不包含扩展参数;不要把整个 config 默认写入日志或返回浏览器。
扩展参数随本次事务记录保存,显式回滚的回调收到的是被回滚事务的目标版本配置,不是旧版本配置;旧版本产生的事务可能没有 config,恢复回调可用 $release['config'] ?? []。status() 不提供远程配置缓存,也不会重新向中心读取扩展参数。
完整包、增量包与文件保护
完整 ZIP 直接包含应用文件,依赖与前端产物应在发布前构建好。库不在线运行 Composer、不执行 ZIP 内脚本、不创建数据库或生成业务配置。
增量安装同时满足以下条件才启用:
prefer_delta=true,中心提供精确基准对应的增量,且增量比完整包小。- 状态记录的基础包来自当前中心地址,基准完整包 ID 与候选一致,具有完整包哈希和文件清单。
- 非保护基准文件在本地存在,大小和 SHA-256 与记录一致。
- 目标完整清单已就绪,增量元数据中的基准/目标身份通过核验。
无基准、本地文件缺失或修改、候选不匹配或不够小时使用完整包。已选择增量后,安装前基准发生变化或增量声明的基础包哈希不一致时,自动改用同一目标完整包;下载完整包仍独立校验。包或目标清单损坏、授权拒绝等错误则停止。增量逐文件替换,不是二进制差分;支持只删除文件的增量。
两种安装方式使用相同事务规则:
| 文件情况 | 处理 |
|---|---|
| 位于保护路径 | 不覆盖、不删除 |
| 新包包含、与本地大小和 SHA-256 相同 | 不备份、不替换,保留时间和权限;仍纳入完整安装清单 |
| 新包包含的新增或内容变化文件 | 安装或覆盖;已有文件保留原权限,新文件按包权限设置 |
| 旧清单记录、新版本不再需要、本地内容未修改 | 备份后删除 |
| 旧清单记录、新版本不再需要、本地内容已修改 | 保留,列入 retained_files |
| 本地自建、旧清单未记录、新包未包含 | 保留 |
| 旧状态没有安装清单 | 完整安装建立基准,不猜测历史文件归属 |
完整包回退仍会覆盖新包包含的非保护文件,包括本地改动。 需要长期保留的配置和客户数据应加入 exclude 或 preserve。
默认保护:根 .updater、根 updater.php、实际工作目录、.git、.env、.user.ini、runtime、storage、upload、uploads、public/upload、public/uploads、public/storage;任意层级的 .git、.env、.env.* 也受保护。追加的目录保护所有子路径,路径比较不区分大小写;中心扩展配置不能改写本地保护规则。
ZIP 文件名使用 UTF-8,支持中文与纯数字文件名。拒绝路径穿越、绝对路径、符号链接、特殊文件、加密条目、重复/大小写冲突、含糊编码及超限 ZIP。文件与目录互换、仅改大小写的已记录路径变更会被拒绝,应单独规划迁移。
大量文件与预检
先读取并校验整个 ZIP 目录表。有就绪清单时,核对包内路径、大小和安全权限,再按本地大小与 SHA-256 筛选变化文件。仅对变化目标及候选废弃路径检查旧文件可读性、目标父目录创建/删除临时文件的能力及备份空间,再解压应用文件。缺失的目录检查最近的已存在父目录;错误包含具体路径。预检不改变应用内容,会在目录内短暂创建并删除空探测文件。它不能保证之后权限、磁盘空间或文件没有变化,因此实际写入仍校验并保留恢复机制。
允许安装的条目按每批 256 个交给原生 extractTo(),不对每个条目重新打开 ZIP。Windows 非 ASCII 路径使用同一 ZIP 句柄隔离提取后移到已校验的位置,避免部分 PHP 构建丢失中文目录。每批解压后核对实际大小;一次文件读取同时计算 CRC 和 SHA-256,后者复用于增量校验、安装清单和变更比较。原文件权限由安装器显式保留,新文件使用包声明的安全权限(0644/0755);不依赖原生解压恢复权限。
完整包 manifest_state=ready 时自动获取并核验清单;没有就绪清单时兼容原流程,全部解压后再跳过内容相同的文件。清单已就绪但下载或校验失败时停止安装,不静默降级。整个 ZIP 的下载哈希、完整目录表和资源限制仍检查;仅解压文件执行展开后的 CRC 与 SHA-256 校验。清单相同的本地文件仍读取内容校验,不单凭修改时间判断。
同一文件系统内优先将校验后的暂存文件移动到目标位置,避免复制一次新文件内容;跨文件系统或移动失败时回退为目标目录中的临时文件复制后替换。不会先删除目标再尝试替换。已有文件仍先备份,恢复记录在任何应用文件变更前写入;移动失败、回调失败和中断恢复共用原事务机制。
即使所有文件相同,也下载并校验 ZIP、运行安装回调、提交新版本,并可回滚版本状态;有清单时解压数量为零。回滚不触碰跳过的文件。预检展开空间按实际待解压文件计算,另保留候选旧文件备份空间和安全余量;包的最大展开限制仍按整个 ZIP 审核。安装期间应暂停应用代码写入;更新锁仅协调本库操作,不能阻止其他部署程序改文件。
可用 php tests/performance.php 30000 fresh、identical、changed、changed10、changed100 测量首次安装、内容全同及 1%/10%/100% 内容变化。默认提供目标清单;测试旧中心兼容路径可用 php tests/performance.php 30000 changed autoload.php legacy(在包根目录执行)。每个场景用独立进程运行,自动清理测试目录;生成包、准备旧文件和清单不计入安装耗时,下载网络耗时也不计入。测试源码可从 GitHub 获取。
测量环境、旧版对比和文件数量验证见 性能验证记录。
回调
check($hooks)、update($hooks)、rollback($hooks) 接受 array<string, callable>。默认读取配置的 hooks,方法参数按名称覆盖默认回调,未覆盖的保留。每个回调接收一个 array $release,包含版本摘要及解析后的 config 扩展参数;返回 false 或抛异常视为失败,其他返回值(含无返回值)视为成功。
| 名称 | 所属操作 | 调用时机 |
|---|---|---|
before_apply |
check 强制安装 / update | 备份和事务记录已完成,覆盖前 |
after_apply |
check 强制安装 / update | 文件已更新,版本状态提交前 |
after_commit |
check 强制安装 / update | 文件和版本已提交 |
before_rollback |
显式 rollback | 全部备份校验后,恢复前 |
after_rollback |
显式 rollback | 文件和版本恢复后 |
$result = $updater->update([ 'after_apply' => static function (array $release): void { // 调用应用健康检查;不通过时抛出 RuntimeException。 }, 'after_commit' => static function (array $release): void { // 完成应用缓存刷新或交由外部管理器安排进程重载。 }, ]);
回调在更新锁内执行,不能再次调用同一站点的 Updater 实例方法。自动故障恢复不调用恢复回调;恢复回调仅由显式 rollback($hooks) 执行。未知回调名称或不可调用值抛 InvalidArgumentException。
维护与暂停写入应在调用 update() 前完成,before_apply 已晚于备份。数据库迁移及其恢复策略由应用负责。安装逐文件替换,不是整站原子切换。
HTTP 与常驻进程接入
在应用已有的后台控制器中完成登录、升级权限、POST 和 CSRF 校验后调用方法。配置与回调来自服务端,不能由请求传入。
// 框架已完成自动加载和权限校验,应用已进入维护。 $updater = new \BuTing\CliAppUpdater\Updater($config); if (session_status() === PHP_SESSION_ACTIVE) { session_write_close(); } $result = $updater->update($hooks); if ($result !== null) { unset($result['backup_dir'], $result['config']); // 业务扩展参数按字段选择是否公开。 } return json(['updated' => $result !== null, 'release' => $result]);
这里的 json() 使用宿主框架响应函数。完整适配函数见 examples/http.php,可由控制器 require 后调用;它不会自行注册公开路由。
| 运行方式 | 执行行为 |
|---|---|
| FPM 请求 | 同步等待结束;需配置足够的 PHP、FPM 和代理请求时限 |
| Webman 请求/worker | 同步下载和文件操作占用执行 worker;耗时任务可交给已有专用 worker |
| 队列任务 | 在任务内调用同一个 update(),由应用记录任务状态 |
| CLI | 可选命令入口,调用同一套方法 |
安装不依赖 exec、shell_exec、proc_open、popen 或 fastcgi_finish_request()。Windows 系统 ID 自动探测会尝试可用的进程函数,但允许回退或通过 machine_id 显式配置。
库不内置队列、异步任务 ID、实时进度或断点续传,不更改 PHP 全局执行时限。FPM 的 request_terminate_timeout、代理超时与出站下载超时需分别配置。常驻进程重载和 OPcache 刷新由应用安排;CLI 中刷新缓存不能代表 FPM 缓存已刷新。
异常与恢复
参数错误使用 InvalidArgumentException;网络、授权、JSON、锁、文件和事务错误通常使用 RuntimeException。调用边界可捕获 Throwable。错误文本不是稳定业务码,不应依靠字符串判断流程。
HTTP 拒绝通常通过异常 getCode() 返回实际 HTTP 状态码;传输错误和本地校验错误没有统一业务码。check() 无更新返回 update=false,授权拒绝则抛异常。
| 情况 | 状态与处理 |
|---|---|
| 下载/解压/安装前校验失败 | 未修改应用文件,处理具体原因后重新检查 |
覆盖、before_apply、after_apply 或提交失败 |
自动尝试恢复文件和版本;回调中的数据库与外部副作用由应用处理 |
after_commit 失败 |
安装已提交;补完缓存、重载或退出维护步骤 |
| HTTP 超时、断网、页面关闭 | 结果未确认;等待原操作结束后核对状态,不立即重试安装或回滚 |
| 其他操作持锁 | 本次调用被拒绝;status() 也不能越过该锁 |
无锁且事务为 applying / rolling_back |
保持维护,通过 rollback() 恢复;新的 check() / update() 会被拒绝 |
| 备份损坏或恢复失败 | 保留工作目录,修复备份或文件权限后恢复 |
普通日志和 HTTP 响应不应包含密钥、完整平台响应、下载票据或异常堆栈。保留最近事务引用的备份;旧备份和只下载未安装的 ZIP 由应用在无任务运行时清理,库不自动轮转备份。
应用路由本身可能被更新替换。需要独立恢复能力时,可将受保护的恢复入口和更新器副本部署在被更新目录之外。
离线授权 API
离线验签独立于在线更新,需要 ext-sodium。离线文件是更新权益快照,不是下载票据;update() 仍使用在线授权和下载流程。
OfflineLicense::verify(string $document, string $publicKey, string $productCode, string $clientKey, string $domain = '', ?string $publishedAt = null): array
| 参数 | 说明 |
|---|---|
document |
授权 JSON 原文,不是文件路径;最多 65536 字节 |
publicKey |
可信预置的 Ed25519 公钥 Base64,解码后 32 字节;不能信任待验证文件自带的公钥 |
productCode |
预期产品 Code |
clientKey |
当前实例 ID;证书声明该绑定时必须匹配 |
domain |
可信当前域名;证书声明该绑定时必须匹配 |
publishedAt |
可选的可信版本首次发布时间,ISO 8601 且带时区,用于检查更新权益截止点 |
use BuTing\CliAppUpdater\OfflineLicense; $license = OfflineLicense::verify( file_get_contents('/srv/private/update.license.json'), $trustedPublicKeyBase64, 'my-shop', $updater->getClientKey(), 'shop.example.com', '2026-10-01T12:00:00+08:00' );
返回已验证的签名载荷:
| 字段 | 类型 | 含义 |
|---|---|---|
schema |
string | apps.update-license.v1 |
key_id |
string | 公钥 SHA-256 |
license_id |
string | 授权记录 ID |
product_code |
string | 产品 Code |
issued_at |
string | ISO 8601 签发时间 |
updates_until |
string|null | 允许版本的首次发布时间截止点,null 不限制 |
constraints |
array | 证书声明的 client_key、domain 绑定,可为空 |
校验签名、产品和全部声明的绑定,未知绑定被拒绝。不传 publishedAt 时不会证明某个版本在权益范围内。在线接口的时间字符串须按中心实际时区转换为带时区的 ISO 8601 后传入,不能直接假定为 UTC。
离线文件无法验证公网来源 IP,导出后不能即时远程撤销。更新权益截止点不限制软件运行时间。本库不提供本地离线 ZIP 安装方法,授权文件签名也不等同于更新 ZIP 签名。
OfflineLicense::domain(string $domain): string
规范化并验证域名:去首尾空白和末尾点,转小写;空串返回空串。有 intl 时可转换 IDN,否则传入 Punycode。要求包含点的合法主机名,拒绝 IP、协议、端口和路径;非法输入抛 InvalidArgumentException。
CLI 与示例
CLI 默认读取当前工作目录的 updater.php,可用第二个参数指定配置文件。init 的第二个参数是已存在的项目目录,省略时为当前目录。CLI 与 PHP 方法均自动应用配置中的 hooks。
php vendor/bin/cli-app-updater init php vendor/bin/cli-app-updater check php vendor/bin/cli-app-updater update php vendor/bin/cli-app-updater rollback /srv/shop/updater.php
| 命令 | 输出 |
|---|---|
init |
初始化结果 config_file、work_dir,不要求先填写产品密钥 |
client-key |
{"client_key":"..."} |
status |
本地状态 |
report |
登记结果 |
authorize |
授权结果,去掉 license_value |
check |
版本摘要;强制版本会在返回前安装,installed=true |
changelog |
默认 after / 1 / 10 日志结果 |
manifest |
检查后读取目标清单;无更新时返回摘要 |
download |
先调用 check();普通版本返回完整包摘要及 downloaded_file,强制版本安装后仅返回摘要,不重复下载 |
update |
安装结果;无更新时 {"update":false} |
rollback |
rolled_back=true 与恢复后的状态 |
manifest 也会先执行 check(),因此可能触发强制安装。CLI 没有绕过强制更新的检查选项。
输出 JSON;退出码 0 成功或无更新,1 执行失败,2 命令参数错误。
- examples/config.php:共享配置及注释。
- examples/updater.php:精简检查示例。
- examples/demo.php:完整命令演示与回调。
- examples/http.php:控制器处理函数,支持
client-key/status/check/changelog/manifest/update/rollback。安装返回updated和release,去掉本地备份路径及业务扩展参数;恢复返回rolled_back。
示例使用占位配置,接入时配置实际中心和项目目录。Files、HttpClient、Installer、Manifest、Json、ClientIdentity、DeltaUnavailable 是内部辅助类,不属于应用集成 API。
中心协议兼容
| 功能 | 最低中心版本 | 请求 |
|---|---|---|
| 登记、授权、更新检查、完整包下载 | v0.13 | /api/{product_code},action=report/authorize/check/download |
| 更新日志 | v0.13.1 | action=changelog |
| 文件清单与增量分发 | v0.14 | action=manifest,检查提交 supports_delta/base_package_id |
| 强制更新 | v0.15 | 检查返回布尔 force_update |
库固定请求 platform=php,并提交已安装版本与配置渠道。产品通信密钥和实例 ID 经请求头传输;下载和清单使用中心签发的同产品相对票据地址,不附带产品密钥,不跟随跨站跳转。检查与下载须使用相同出口 IP,中心会在下载时重新验证授权及包流量额度。
不提供增量候选的中心按完整包更新。离线授权签发公钥由应用通过可信渠道配置。
强制更新标记(中心 v0.15.0+)
check() 和 summary() 提供布尔值 force_update。当前版本之后、可获取的目标版本之前(含目标)存在强制版本时为 true;已安装版本、草稿、撤回、其他渠道/目标或授权截止后的版本不参与判断。没有更新时为 false。changelog() 的每条记录提供该版本自己的 force_update。
check() 遇到强制版本会直接同步安装,成功后返回 installed=true;普通版本只返回信息。应用负责调用前的维护准备和安装后的进程生效。旧中心未提供字段时按非强制处理。