From 277d44263489cac7d5128303a97e0fe99c6053ec Mon Sep 17 00:00:00 2001 From: crazywhalecc Date: Fri, 6 May 2022 23:34:33 +0800 Subject: [PATCH 1/5] move all scripts to ext/ dir --- ext/{go-cqhttp => }/go-cqhttp-down.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename ext/{go-cqhttp => }/go-cqhttp-down.sh (100%) diff --git a/ext/go-cqhttp/go-cqhttp-down.sh b/ext/go-cqhttp-down.sh similarity index 100% rename from ext/go-cqhttp/go-cqhttp-down.sh rename to ext/go-cqhttp-down.sh From 19c792209b6ec482a1f6e95a64baf385e2482364 Mon Sep 17 00:00:00 2001 From: crazywhalecc Date: Fri, 6 May 2022 23:35:24 +0800 Subject: [PATCH 2/5] add go.sh one-step installing script --- ext/go.sh | 264 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 264 insertions(+) create mode 100755 ext/go.sh diff --git a/ext/go.sh b/ext/go.sh new file mode 100755 index 00000000..ef449984 --- /dev/null +++ b/ext/go.sh @@ -0,0 +1,264 @@ +#!/usr/bin/env bash + +# 支持的环境变量： +# ZM_DOWN_PHP_VERSION php版本，默认为8.0 +# ZM_NO_LOCAL_PHP 如果填入任意内容，则不检查本地PHP，直接安装内建PHP（仅限Linux） +# ZM_TEMP_DIR 脚本下载内建PHP和Composer的临时目录，默认为/tmp/.zm-runtime +# ZM_CUSTOM_DIR 自定义新建目录名称，默认为zhamao-app +# ZM_COMPOSER_PACKAGIST 是否使用Composer的国外源，默认使用国内阿里云，如果设置并填写了内容，则自动使用Composer的国外源 + +ZM_PWD=$(pwd) +_cyan="\033[0;36m" +_reset="\033[0m" + +# 彩头 +function nhead() { + if [ "$1" = "red" ]; then + echo -ne "\033[0;31m[!]" + elif [ "$1" = "yellow" ]; then + echo -ne "\033[0;33m[?]" + else + echo -ne "\033[0;32m[*]" + fi + echo -e "\033[0m" +} + +# 下载文件 $1 到目录 $2，自动选择使用 curl 或者 wget +function download_file() { + downloader="wget" + type wget >/dev/null 2>&1 || { downloader="curl"; } + if [ "$downloader" = "wget" ]; then + _down_prefix="O" + else + _down_prefix="o" + fi + _down_symbol=0 + if [ ! -f "$2" ]; then + echo -ne "$(nhead) 正在下载 $1 ... " + $downloader "$1" -$_down_prefix "$2" >/dev/null 2>&1 && echo "完成！" && _down_symbol=1 + else + echo "已存在！" && _down_symbol=1 + fi + if [ $_down_symbol == 0 ]; then + echo "$(nhead red) 下载失败！请检查网络连接！" + rm -rf "$2" + return 1 + fi + return 0 +} + +# 安装下载内建PHP +function install_native_php() { + ZM_PHP_VERSION="8.0" + if [ "$ZM_DOWN_PHP_VERSION" != "" ]; then + ZM_PHP_VERSION="$ZM_DOWN_PHP_VERSION" + fi + echo "$(nhead) 使用的内建 PHP 版本: $ZM_PHP_VERSION" + + rm -rf "$ZM_TEMP_DIR" + mkdir "$ZM_TEMP_DIR" >/dev/null 2>&1 + if [ ! -f "$ZM_TEMP_DIR/php" ]; then + download_file "https://dl.zhamao.xin/php-bin/down.php?php_ver=$ZM_PHP_VERSION&arch=$(uname -m)" "$ZM_TEMP_DIR/php.tgz" || return 1 + tar -xf "$ZM_TEMP_DIR/php.tgz" -C "$ZM_TEMP_DIR/" && rm -rf "$ZM_TEMP_DIR/php.tgz" + fi + echo "$(nhead) 安装内建 PHP 完成！" + php_executable="$ZM_TEMP_DIR/php" + return 0 +} + +# 安装下载Composer +function install_native_composer() { + if [ ! -f "$ZM_TEMP_DIR/composer.phar" ]; then + # 下载 composer.phar + download_file "https://mirrors.aliyun.com/composer/composer.phar" "$ZM_TEMP_DIR/composer.phar" || return 1 + if [ "$php_executable" = "$ZM_TEMP_DIR/php" ]; then + # shellcheck disable=SC2016 + txt='#!/usr/bin/env sh +if [ -f "$(dirname $0)/php" ]; then + "$(dirname $0)/php" "$(dirname $0)/composer.phar" $* +else + php "$(dirname $0)/composer.phar" $* +fi' + echo "$txt" >"$ZM_TEMP_DIR/composer" + chmod +x "$ZM_TEMP_DIR/composer" + else + mv "$ZM_TEMP_DIR/composer.phar" "$ZM_TEMP_DIR/composer" && chmod +x "$ZM_TEMP_DIR/composer" + fi + fi + echo "$(nhead) 安装内建 Composer 完成！" + composer_executable="$ZM_TEMP_DIR/composer" + return 0 +} + +# 检查Composer可用性 +function composer_check() { + # 顺带检查一下 + echo "$(nhead) 正在检查 Git、unzip、7z 能否正常使用 ... " + type git >/dev/null 2>&1 || { + echo "$(nhead red) 检测到系统不存在 git 命令，可能无法正常使用 Composer 下载 GitHub 等仓库项目！" + } + zip_check_symbol=0 + if type unzip >/dev/null 2>&1; then + zip_check_symbol=1 + fi + if type 7z >/dev/null 2>&1; then + zip_check_symbol=1 + fi + if [ $zip_check_symbol -eq 0 ]; then + if [ "$($php_executable -m | grep zip)" = "" ]; then + echo "$(nhead red) 检测到系统不存在 unzip 或 7z 命令，PHP 不存在 zip 扩展，可能无法正常使用 Composer 下载压缩包项目！" + fi + fi + + # 测试 Composer 和 PHP 是否能正常使用 + if [ "$("$composer_executable" -n about | grep Manager)" = "" ]; then + echo "$(nhead red) Download PHP binary and composer failed!" + return 1 + fi + echo "$(nhead) 环境检查完成！" + return 0 +} + +# 环境检查 +function darwin_env_check() { + echo -ne "$(nhead) 检查是否存在 PHP ... " + if type php >/dev/null 2>&1; then + php_executable=$(which php) + echo "位置：$php_executable" + if [ "$($php_executable -m | grep swoole)" = "" ]; then + echo "$(nhead red) PHP 不存在 swoole 扩展，可能无法正常使用 Swoole 框架！" && return 1 + fi + else + echo "不存在" + if type brew >/dev/null 2>&1; then + echo -n "$(nhead yellow) 是否使用 Homebrew 安装 PHP？[y/N] " + read -r y + if [ "$y" = "" ]; then y="N"; fi + if [ "$y" = "y" ]; then + brew install php || echo "$(nhead red) 安装 PHP 失败！" && return 1 + else + echo "$(nhead red) 跳过安装 PHP！" && return 1 + fi + fi + fi + + echo -ne "$(nhead) 检查是否存在 Composer ... " + if type composer >/dev/null 2>&1; then + composer_executable=$(which composer) + echo "位置：$composer_executable" + else + echo "不存在，正在下载 Composer ..." + install_native_composer || return 1 + fi + + composer_check || return 1 +} + +# 询问是否安装 native php +function prompt_install_native_php() { + echo -ne "$(nhead yellow) 检测到系统的 PHP 不存在 swoole 扩展，是否下载安装独立的内建 PHP 和 Composer？[Y/n] " + read -r y + case $y in + Y|y|"") return 0 ;; + *) echo "$(nhead red) 跳过安装内建 PHP！" && return 1 ;; + esac +} + +# 环境检查 +function linux_env_check() { + if [ "$ZM_NO_LOCAL_PHP" != "" ]; then # 如果指定了不使用本地 php，则不检查，直接下载 + install_native_php && install_native_composer && composer_check && return 0 || return 1 + else + echo -ne "$(nhead) 检查是否存在 PHP ... " + if type php >/dev/null 2>&1; then + php_executable=$(which php) + echo "位置：$php_executable" + if [ "$($php_executable -m | grep swoole)" = "" ]; then + echo "$(nhead red) PHP 不存在 swoole 扩展，可能无法正常使用 Swoole 框架！" && \ + prompt_install_native_php && \ + install_native_php && \ + install_native_composer && composer_check && return 0 || return 1 + fi + else + echo "不存在，将下载内建 PHP" + install_native_php || return 1 + fi + fi + + echo -ne "$(nhead) 检查是否存在 Composer ... " + if type composer >/dev/null 2>&1; then + composer_executable=$(which composer) + echo "位置：$composer_executable" + else + echo "不存在，将下载内建 Composer" + install_native_composer || return 1 + fi + + composer_check || return 1 +} + +function if_use_aliyun() { + if [ "$ZM_COMPOSER_PACKAGIST" = "" ]; then + $composer_executable -n config repos.packagist composer https://mirrors.aliyun.com/composer + fi +} + +function if_restore_native_runtime() { + ZM_RUNTIME_DIR="$ZM_PWD/$ZM_CUSTOM_DIR/runtime/" + if [ "$php_executable" = "$ZM_TEMP_DIR/php" ]; then + echo "$(nhead) 移动内建 PHP 到框架目录 $ZM_RUNTIME_DIR ..." && \ + mkdir -p "$ZM_RUNTIME_DIR" && \ + mv "$ZM_TEMP_DIR/php" "$ZM_RUNTIME_DIR" || { + echo "$(nhead red) 移动内建 PHP 到框架目录失败！" && return 1 + } + php_executable="$ZM_RUNTIME_DIR/php" + fi + if [ "$composer_executable" = "$ZM_TEMP_DIR/composer" ]; then + echo "$(nhead) 移动内建 Composer 到框架目录 $ZM_RUNTIME_DIR ..." && \ + mkdir -p "$ZM_CUSTOM_DIR/runtime" && \ + mv "$ZM_TEMP_DIR/composer" "$ZM_RUNTIME_DIR" && \ + mv "$ZM_TEMP_DIR/composer.phar" "$ZM_RUNTIME_DIR" || { + echo "$(nhead red) 移动内建 Composer 到框架目录失败！" && return 1 + } + composer_executable="$ZM_RUNTIME_DIR/composer" + fi + return 0 +} + +function install_framework() { + echo "$(nhead) 开始安装框架到目录 $ZM_CUSTOM_DIR ..." + mkdir -p "$ZM_PWD/$ZM_CUSTOM_DIR" && \ + cd "$ZM_PWD/$ZM_CUSTOM_DIR" && \ + $composer_executable init --name="zhamao/framework-starter" -n -q && \ + if_use_aliyun && \ + echo "$(nhead) 从 Composer 拉取框架 ..." && \ + $composer_executable require -n -q zhamao/framework:^2.7 && \ + $composer_executable require -n -q --dev swoole/ide-helper:^4.5 && \ + if_restore_native_runtime && \ + echo "$(nhead) 初始化框架脚手架文件 ..." && \ + vendor/bin/start init >/dev/null 2>&1 && \ + $composer_executable dump-autoload -n -q && \ + echo "$(nhead) 安装框架完成，已安装到目录 $ZM_CUSTOM_DIR" && \ + echo -e "$(nhead) 启动框架命令：""$_cyan""cd $ZM_CUSTOM_DIR && ./zhamao server""$_reset" || { + echo "$(nhead red) 安装框架失败！" && return 1 + } +} + +# 环境变量设置 +test "$ZM_TEMP_DIR" = "" && ZM_TEMP_DIR="/tmp/.zm-runtime" +test "$ZM_CUSTOM_DIR" = "" && ZM_CUSTOM_DIR="zhamao-app" + +if [ -d "$ZM_PWD/$ZM_CUSTOM_DIR" ]; then + echo "$(nhead red) 检测到目录 $ZM_CUSTOM_DIR/ 已安装过框架，请更换文件夹名称或删除旧文件夹再试！" + exit 1 +fi + +# 检查系统环境，目前只支持 Linux +case $(uname -s) in +Linux) linux_env_check || exit 1 ;; +Darwin) darwin_env_check || exit 1 ;; +*) echo "$(nhead red) Only support Linux and macOS!" && exit 1 ;; +esac + +# 安装框架 +install_framework From e843aeac5593d92e9e9560b820cf95023603ce37 Mon Sep 17 00:00:00 2001 From: crazywhalecc Date: Fri, 6 May 2022 23:36:29 +0800 Subject: [PATCH 3/5] prevent server:stop command error when daemon file not exists --- src/ZM/Command/Server/ServerStopCommand.php | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/ZM/Command/Server/ServerStopCommand.php b/src/ZM/Command/Server/ServerStopCommand.php index 165faad8..c78eeefc 100644 --- a/src/ZM/Command/Server/ServerStopCommand.php +++ b/src/ZM/Command/Server/ServerStopCommand.php @@ -43,7 +43,9 @@ class ServerStopCommand extends DaemonCommand } else { parent::execute($input, $output); } - Process::kill(intval($this->daemon_file['pid']), SIGTERM); + if ($this->daemon_file !== null) { + Process::kill(intval($this->daemon_file['pid']), SIGTERM); + } $i = 10; while (Framework::getProcessState(ZM_PROCESS_MASTER) !== false && $i > 0) { sleep(1); From 5299061c871ce4b67561a5dd7548652127f137ca Mon Sep 17 00:00:00 2001 From: crazywhalecc Date: Fri, 6 May 2022 23:49:38 +0800 Subject: [PATCH 4/5] change one-step installation method --- README.md | 32 +++++++++++++++++++++++--------- docs/README.md | 7 +++---- docs/guide/installation.md | 12 +++--------- 3 files changed, 29 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 20f3c6ef..93ec8716 100644 --- a/README.md +++ b/README.md @@ -74,18 +74,32 @@ public function index() { ## 开始 -如果你是初学者，可以直接使用以下脚本部署 PHP 环境和安装框架的脚手架： +框架目前支持 Linux、WSL、macOS 环境直接运行，上述环境可直接使用下方一键安装脚本。 + +> 如果你想在其他环境安装部署，可使用 Docker、Cygwin，详见文档。 ```bash -# 新建一个自己喜欢名字的文件夹，运行一键安装脚本 (仅限 x86-64(AMD64) 和 AArch64(ARM64) 平台) -mkdir zhamao-app/ -cd zhamao-app/ -# 默认安装的 PHP 版本为 7.4，如需使用其他版本，请设置环境变量 ZM_DOWN_PHP_VERSION 为对应的 PHP 版本，例如： -# export ZM_DOWN_PHP_VERSION=8.1 -bash -c "$(curl -fsSL https://api.zhamao.xin/go.sh)" +# 检测PHP环境、安装框架 +bash <(curl -fsSL https://zhamao.xin/go.sh) -# 启动 -./zhamao server:start +# 启动框架 +cd zhamao-app +./zhamao server +``` + +一键安装脚本还有可以自定义参数的方式，比如： + +```bash +# 脚本默认会检测系统的PHP，如果想直接跳过检测，安装独立的PHP版本，则添加此环境变量 +export ZM_NO_LOCAL_PHP="yes" +# 脚本如果安装独立版本PHP，默认版本为8.0，如果想使用其他版本，则添加此环境变量指定版本 +export ZM_DOWN_PHP_VERSION="8.1" +# 脚本默认会将框架在当前目录下的 `zhamao-app` 目录进行安装，如果想使用其他目录，则添加此环境变量 +export ZM_CUSTOM_DIR="my-custom-app" +# 脚本默认会对本项目使用阿里云国内加速镜像，如果想使用packagist源，则添加此环境变量 +export ZM_COMPOSER_PACKAGIST="yes" +# 执行完前面的环境变量再执行一键安装脚本，就可以实现自定义参数！ +bash <(curl -fsSL https://zhamao.xin/go.sh) ``` 关于其他安装方式，请参阅[文档](https://framework.zhamao.xin/guide/installation.html) 。 diff --git a/docs/README.md b/docs/README.md index 024f70b1..bda4a3e9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -21,17 +21,16 @@ footer: | ## 安装框架和环境 -此命令可一键以模板安装 `zhamao-framework` 和 `PHP` 独立环境到目录下，无需 root！（仅限 Linux） +此命令可一键以模板安装框架！（仅限 Linux 和 macOS） ```bash -mkdir my-app -cd my-app -bash <(curl -fsSL https://api.zhamao.xin/go.sh) +bash <(curl -fsSL https://zhamao.xin/go.sh) ``` ## 运行框架 ```bash +cd zhamao-app/ ./zhamao server ``` diff --git a/docs/guide/installation.md b/docs/guide/installation.md index bc68cb16..1183a0d5 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -6,21 +6,15 @@ ## 一键下载静态 PHP 环境和框架脚手架 -从 2.4.4 版本起，炸毛框架支持一键拉取一个静态的 PHP 运行时和脚手架，只需运行下面的脚本即可。（开发环境推荐此方法） +从 2.4.4 版本起，炸毛框架支持一键拉取一个静态的 PHP 运行时和脚手架（如果本机内安装的 PHP 已符合要求，则不安装），只需运行下面的脚本即可。 ```bash # 将会把 PHP、框架都安装在此目录下 -mkdir zhamao-app/ # 这里可以取自己的项目名字 -cd zhamao-app/ -bash -c "$(curl -fsSL https://api.zhamao.xin/go.sh)" +bash <(curl -fsSL https://zhamao.xin/go.sh) # 安装完成后的启动框架命令（2.5.0 版本后可省略掉 runtime/php 前缀） +cd zhamao-app ./zhamao server - -# 扩展用法：使用静态 PHP 版本的 Composer update -runtime/composer update -# 扩展用法：使用静态 PHP 运行别的 CLI 脚本 -runtime/php path/to/your/script.php ``` > 有关静态 PHP 的多种用法（如 Composer），见 [进阶 - PHP 环境高级](/advanced/php-env) From bd8270a4aed285a3b632bb5714ddc4a15237b69a Mon Sep 17 00:00:00 2001 From: crazywhalecc Date: Fri, 6 May 2022 23:58:30 +0800 Subject: [PATCH 5/5] add script file auto-deploy action --- .github/workflows/vuepress-deploy.yml | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/workflows/vuepress-deploy.yml b/.github/workflows/vuepress-deploy.yml index b115eb01..cff0012e 100644 --- a/.github/workflows/vuepress-deploy.yml +++ b/.github/workflows/vuepress-deploy.yml @@ -1,10 +1,11 @@ -name: VuePress Auto Deploy +name: Docs and Script Auto Deploy on: push: branches: - master paths: - 'docs/**' + - 'ext/**' jobs: build: @@ -32,3 +33,11 @@ jobs: REMOTE_HOST: ${{ secrets.ZHAMAO_XIN_HOST }} REMOTE_USER: ${{ secrets.ZHAMAO_XIN_USER }} TARGET: ${{ secrets.ZHAMAO_XIN_TARGET }} + - name: deploy script file + uses: wlixcc/SFTP-Deploy-Action@v1.0 + with: + username: ${{ secrets.ZHAMAO_XIN_USER }} + server: ${{ secrets.ZHAMAO_XIN_HOST }} + ssh_private_key: ${{ secrets.ZHAMAO_XIN_PRIVATE_KEY }} + local_path: './ext/go.sh' + remote_path: ${{ secrets.ZHAMAO_XIN_MAIN_TARGET }}