Files
Xboard/app/Console/Commands/XboardInstall.php

398 lines
16 KiB
PHP
Raw Normal View History

2023-11-17 14:44:01 +08:00
<?php
namespace App\Console\Commands;
use App\Services\Plugin\PluginManager;
2023-11-17 14:44:01 +08:00
use Illuminate\Console\Command;
use Illuminate\Encryption\Encrypter;
use App\Models\User;
use App\Utils\Helper;
use Illuminate\Support\Env;
2025-01-21 14:57:54 +08:00
use Illuminate\Support\Facades\Artisan;
use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\File;
2023-12-08 08:53:19 +08:00
use function Laravel\Prompts\confirm;
use function Laravel\Prompts\text;
use function Laravel\Prompts\note;
use function Laravel\Prompts\select;
use App\Models\Plugin;
use Illuminate\Support\Str;
2023-11-17 14:44:01 +08:00
class XboardInstall extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'xboard:install';
/**
* The console command description.
*
* @var string
*/
protected $description = 'xboard 初始化安装';
/**
* Create a new command instance.
*
* @return void
*/
public function __construct()
{
parent::__construct();
}
/**
* Execute the console command.
*
* @return mixed
*/
public function handle()
{
try {
2025-01-21 14:57:54 +08:00
$isDocker = file_exists('/.dockerenv');
$enableSqlite = getenv('ENABLE_SQLITE', false);
$enableRedis = getenv('ENABLE_REDIS', false);
$adminAccount = getenv('ADMIN_ACCOUNT', false);
2023-11-17 14:44:01 +08:00
$this->info("__ __ ____ _ ");
$this->info("\ \ / /| __ ) ___ __ _ _ __ __| | ");
$this->info(" \ \/ / | __ \ / _ \ / _` | '__/ _` | ");
$this->info(" / /\ \ | |_) | (_) | (_| | | | (_| | ");
$this->info("/_/ \_\|____/ \___/ \__,_|_| \__,_| ");
if (
2025-01-21 14:57:54 +08:00
(File::exists(base_path() . '/.env') && $this->getEnvValue('INSTALLED'))
|| (getenv('INSTALLED', false) && $isDocker)
) {
2023-11-17 14:44:01 +08:00
$securePath = admin_setting('secure_path', admin_setting('frontend_admin_path', hash('crc32b', config('app.key'))));
$this->info("访问 http(s)://你的站点/{$securePath} 进入管理面板,你可以在用户中心修改你的密码。");
$this->warn("如需重新安装请清空目录下 .env 文件的内容Docker安装方式不可以删除此文件");
2023-12-08 08:53:19 +08:00
$this->warn("快捷清空.env命令");
note('rm .env && touch .env');
return;
2023-12-08 08:53:19 +08:00
}
if (is_dir(base_path() . '/.env')) {
2023-12-08 08:53:19 +08:00
$this->error('😔安装失败Docker环境下安装请保留空的 .env 文件');
return;
2023-11-17 14:44:01 +08:00
}
// 选择数据库类型
$dbType = $enableSqlite ? 'sqlite' : select(
label: '请选择数据库类型',
options: [
'sqlite' => 'SQLite (无需额外安装)',
'mysql' => 'MySQL',
'postgresql' => 'PostgreSQL'
],
default: 'sqlite'
);
// 使用 match 表达式配置数据库
$envConfig = match ($dbType) {
'sqlite' => $this->configureSqlite(),
'mysql' => $this->configureMysql(),
'postgresql' => $this->configurePostgresql(),
default => throw new \InvalidArgumentException("不支持的数据库类型: {$dbType}")
};
if (is_null($envConfig)) {
return; // 用户选择退出安装
}
$envConfig['APP_KEY'] = 'base64:' . base64_encode(Encrypter::generateKey('AES-256-CBC'));
$isReidsValid = false;
while (!$isReidsValid) {
// 判断是否为Docker环境
if ($isDocker == 'true' && ($enableRedis || confirm(label: '是否启用Docker内置的Redis', default: true, yes: '启用', no: '不启用'))) {
2025-01-21 14:57:54 +08:00
$envConfig['REDIS_HOST'] = '/data/redis.sock';
$envConfig['REDIS_PORT'] = 0;
$envConfig['REDIS_PASSWORD'] = null;
} else {
$envConfig['REDIS_HOST'] = text(label: '请输入Redis地址', default: '127.0.0.1', required: true);
$envConfig['REDIS_PORT'] = text(label: '请输入Redis端口', default: '6379', required: true);
$envConfig['REDIS_PASSWORD'] = text(label: '请输入redis密码(默认: null)', default: '');
}
$redisConfig = [
2024-05-24 13:06:25 +08:00
'client' => 'phpredis',
'default' => [
'host' => $envConfig['REDIS_HOST'],
'password' => $envConfig['REDIS_PASSWORD'],
'port' => $envConfig['REDIS_PORT'],
'database' => 0,
],
];
try {
$redis = new \Illuminate\Redis\RedisManager(app(), 'phpredis', $redisConfig);
$redis->ping();
$isReidsValid = true;
} catch (\Exception $e) {
// 连接失败,输出错误消息
$this->error("redis连接失败" . $e->getMessage());
$this->info("请重新输入REDIS配置");
2025-01-21 14:57:54 +08:00
$enableRedis = false;
sleep(1);
}
}
if (!copy(base_path() . '/.env.example', base_path() . '/.env')) {
abort(500, '复制环境文件失败,请检查目录权限');
}
;
$email = !empty($adminAccount) ? $adminAccount : text(
label: '请输入管理员账号',
2024-05-24 13:06:25 +08:00
default: 'admin@demo.com',
required: true,
validate: fn(string $email): ?string => match (true) {
!filter_var($email, FILTER_VALIDATE_EMAIL) => '请输入有效的邮箱地址.',
2023-12-08 08:53:19 +08:00
default => null,
}
);
2023-12-08 08:53:19 +08:00
$password = Helper::guid(false);
$this->saveToEnv($envConfig);
2023-11-17 14:44:01 +08:00
2024-05-24 13:06:25 +08:00
$this->call('config:cache');
2025-01-21 14:57:54 +08:00
Artisan::call('cache:clear');
2023-11-17 14:44:01 +08:00
$this->info('正在导入数据库请稍等...');
2025-01-21 14:57:54 +08:00
Artisan::call("migrate", ['--force' => true]);
$this->info(Artisan::output());
2023-11-17 14:44:01 +08:00
$this->info('数据库导入完成');
2023-12-08 08:53:19 +08:00
$this->info('开始注册管理员账号');
if (!self::registerAdmin($email, $password)) {
2023-11-17 14:44:01 +08:00
abort(500, '管理员账号注册失败,请重试');
}
self::restoreProtectedPlugins($this);
$this->info('正在安装默认插件...');
PluginManager::installDefaultPlugins();
$this->info('默认插件安装完成');
2023-12-08 08:53:19 +08:00
$this->info('🎉:一切就绪');
2023-11-17 14:44:01 +08:00
$this->info("管理员邮箱:{$email}");
$this->info("管理员密码:{$password}");
$defaultSecurePath = hash('crc32b', config('app.key'));
$this->info("访问 http(s)://你的站点/{$defaultSecurePath} 进入管理面板,你可以在用户中心修改你的密码。");
2025-01-21 14:57:54 +08:00
$envConfig['INSTALLED'] = true;
$this->saveToEnv($envConfig);
2023-11-17 14:44:01 +08:00
} catch (\Exception $e) {
$this->error($e);
2023-11-17 14:44:01 +08:00
}
}
public static function registerAdmin($email, $password)
2023-11-17 14:44:01 +08:00
{
$user = new User();
$user->email = $email;
if (strlen($password) < 8) {
abort(500, '管理员密码长度最小为8位字符');
}
$user->password = password_hash($password, PASSWORD_DEFAULT);
$user->uuid = Helper::guid(true);
$user->token = Helper::guid();
$user->is_admin = 1;
return $user->save();
}
2024-04-10 19:09:16 +08:00
private function set_env_var($key, $value)
2023-11-17 14:44:01 +08:00
{
2024-04-10 19:09:16 +08:00
$value = !strpos($value, ' ') ? $value : '"' . $value . '"';
$key = strtoupper($key);
2023-11-17 14:44:01 +08:00
2024-04-10 19:09:16 +08:00
$envPath = app()->environmentFilePath();
$contents = file_get_contents($envPath);
2023-11-17 14:44:01 +08:00
2024-04-10 19:09:16 +08:00
if (preg_match("/^{$key}=[^\r\n]*/m", $contents, $matches)) {
$contents = str_replace($matches[0], "{$key}={$value}", $contents);
} else {
$contents .= "\n{$key}={$value}\n";
}
2023-11-17 14:44:01 +08:00
2024-04-10 19:09:16 +08:00
return file_put_contents($envPath, $contents) !== false;
}
2023-11-17 14:44:01 +08:00
2024-04-10 19:09:16 +08:00
private function saveToEnv($data = [])
{
foreach ($data as $key => $value) {
self::set_env_var($key, $value);
2023-11-17 14:44:01 +08:00
}
return true;
}
function getEnvValue($key, $default = null)
{
$dotenv = \Dotenv\Dotenv::createImmutable(base_path());
$dotenv->load();
return Env::get($key, $default);
}
/**
* 配置 SQLite 数据库
*
* @return array|null
*/
private function configureSqlite(): ?array
{
$sqliteFile = '.docker/.data/database.sqlite';
if (!file_exists(base_path($sqliteFile))) {
// 创建空文件
if (!touch(base_path($sqliteFile))) {
$this->info("sqlite创建成功: $sqliteFile");
}
}
$envConfig = [
'DB_CONNECTION' => 'sqlite',
'DB_DATABASE' => $sqliteFile,
'DB_HOST' => '',
'DB_USERNAME' => '',
'DB_PASSWORD' => '',
];
try {
Config::set("database.default", 'sqlite');
Config::set("database.connections.sqlite.database", base_path($envConfig['DB_DATABASE']));
DB::purge('sqlite');
DB::connection('sqlite')->getPdo();
if (!blank(DB::connection('sqlite')->getPdo()->query("SELECT name FROM sqlite_master WHERE type='table'")->fetchAll(\PDO::FETCH_COLUMN))) {
if (confirm(label: '检测到数据库中已经存在数据,是否要清空数据库以便安装新的数据?', default: false, yes: '清空', no: '退出安装')) {
$this->info('正在清空数据库请稍等');
$this->call('db:wipe', ['--force' => true]);
$this->info('数据库清空完成');
} else {
return null;
}
}
} catch (\Exception $e) {
$this->error("SQLite数据库连接失败" . $e->getMessage());
return null;
}
return $envConfig;
}
/**
* 配置 MySQL 数据库
*
* @return array
*/
private function configureMysql(): array
{
while (true) {
$envConfig = [
'DB_CONNECTION' => 'mysql',
'DB_HOST' => text(label: "请输入MySQL数据库地址", default: '127.0.0.1', required: true),
'DB_PORT' => text(label: '请输入MySQL数据库端口', default: '3306', required: true),
'DB_DATABASE' => text(label: '请输入MySQL数据库名', default: 'xboard', required: true),
'DB_USERNAME' => text(label: '请输入MySQL数据库用户名', default: 'root', required: true),
'DB_PASSWORD' => text(label: '请输入MySQL数据库密码', required: false),
];
try {
Config::set("database.default", 'mysql');
Config::set("database.connections.mysql.host", $envConfig['DB_HOST']);
Config::set("database.connections.mysql.port", $envConfig['DB_PORT']);
Config::set("database.connections.mysql.database", $envConfig['DB_DATABASE']);
Config::set("database.connections.mysql.username", $envConfig['DB_USERNAME']);
Config::set("database.connections.mysql.password", $envConfig['DB_PASSWORD']);
DB::purge('mysql');
DB::connection('mysql')->getPdo();
if (!blank(DB::connection('mysql')->select('SHOW TABLES'))) {
if (confirm(label: '检测到数据库中已经存在数据,是否要清空数据库以便安装新的数据?', default: false, yes: '清空', no: '不清空')) {
$this->info('正在清空数据库请稍等');
$this->call('db:wipe', ['--force' => true]);
$this->info('数据库清空完成');
return $envConfig;
} else {
continue; // 重新输入配置
}
}
return $envConfig;
} catch (\Exception $e) {
$this->error("MySQL数据库连接失败" . $e->getMessage());
$this->info("请重新输入MySQL数据库配置");
}
}
}
/**
* 配置 PostgreSQL 数据库
*
* @return array
*/
private function configurePostgresql(): array
{
while (true) {
$envConfig = [
'DB_CONNECTION' => 'pgsql',
'DB_HOST' => text(label: "请输入PostgreSQL数据库地址", default: '127.0.0.1', required: true),
'DB_PORT' => text(label: '请输入PostgreSQL数据库端口', default: '5432', required: true),
'DB_DATABASE' => text(label: '请输入PostgreSQL数据库名', default: 'xboard', required: true),
'DB_USERNAME' => text(label: '请输入PostgreSQL数据库用户名', default: 'postgres', required: true),
'DB_PASSWORD' => text(label: '请输入PostgreSQL数据库密码', required: false),
];
try {
Config::set("database.default", 'pgsql');
Config::set("database.connections.pgsql.host", $envConfig['DB_HOST']);
Config::set("database.connections.pgsql.port", $envConfig['DB_PORT']);
Config::set("database.connections.pgsql.database", $envConfig['DB_DATABASE']);
Config::set("database.connections.pgsql.username", $envConfig['DB_USERNAME']);
Config::set("database.connections.pgsql.password", $envConfig['DB_PASSWORD']);
DB::purge('pgsql');
DB::connection('pgsql')->getPdo();
// 检查PostgreSQL数据库是否有表
$tables = DB::connection('pgsql')->select("SELECT tablename FROM pg_tables WHERE schemaname = 'public'");
if (!blank($tables)) {
if (confirm(label: '检测到数据库中已经存在数据,是否要清空数据库以便安装新的数据?', default: false, yes: '清空', no: '不清空')) {
$this->info('正在清空数据库请稍等');
$this->call('db:wipe', ['--force' => true]);
$this->info('数据库清空完成');
return $envConfig;
} else {
continue; // 重新输入配置
}
}
return $envConfig;
} catch (\Exception $e) {
$this->error("PostgreSQL数据库连接失败" . $e->getMessage());
$this->info("请重新输入PostgreSQL数据库配置");
}
}
}
/**
* 还原内置受保护插件(可在安装和更新时调用)
* Docker 部署时 plugins/ 目录被外部挂载覆盖,需要从镜像备份中还原默认插件
*/
public static function restoreProtectedPlugins(Command $console = null)
{
$backupBase = '/opt/default-plugins';
$pluginsBase = base_path('plugins');
if (!File::isDirectory($backupBase)) {
$console?->info('非 Docker 环境或备份目录不存在,跳过插件还原。');
return;
}
foreach (Plugin::PROTECTED_PLUGINS as $pluginCode) {
$dirName = Str::studly($pluginCode);
$source = "{$backupBase}/{$dirName}";
$target = "{$pluginsBase}/{$dirName}";
if (!File::isDirectory($source)) {
continue;
}
// 先清除旧文件再复制,避免重命名后残留旧文件
File::deleteDirectory($target);
File::copyDirectory($source, $target);
$console?->info("已同步默认插件 [{$dirName}]");
}
}
2023-11-17 14:44:01 +08:00
}