niucloud-admin/niucloud/app/job/schedule/AutoClearLogFiles.php

<?php
// +----------------------------------------------------------------------
// | Niucloud-admin 企业快速开发的多应用管理平台
// +----------------------------------------------------------------------
// | 官方网址：https://www.niucloud.com
// +----------------------------------------------------------------------
// | niucloud团队 版权所有 开源版本可自由商用
// +----------------------------------------------------------------------
// | Author: Niucloud Team
// +----------------------------------------------------------------------

namespace app\job\schedule;

use core\base\BaseJob;
use think\facade\Log;

/**
 * 队列异步调用定时任务 - 清理日志文件
 */
class AutoClearLogFiles extends BaseJob
{

    public function doJob()
    {
        Log::write('AutoClearLogFiles 定时清理日志文件开始 ' . date('Y-m-d H:i:s'));
        try {
            // 定义需要清理的日志目录数组
            $log_dirs = [
                'log',
                'adminapi/log',
                'api/log'
            ];

            // 遍历每个日志目录进行清理
            foreach ($log_dirs as $dir) {
                $abs_dir = runtime_path($dir);
                // runtime_path，补充根目录拼接方式
                if (!is_dir($abs_dir)) {
                    $abs_dir = root_path() . $dir;
                }
                $this->clearDirectory($abs_dir);
            }

            Log::write('AutoClearLogFiles 定时清理日志文件完成 ' . date('Y-m-d H:i:s'));
            return true;
        } catch (\Exception $e) {
            Log::write('AutoClearLogFiles 定时清除异常: ' . $e->getMessage() . ' 位置: ' . $e->getFile() . ':' . $e->getLine() . $e->getTraceAsString());
            return false;
        }
    }

    /**
     * 清空指定目录下一周前的日志文件和空的子目录
     *
     * @param string $directory 目录路径
     * @param bool $preserveDirectory 是否保留根目录（默认保留）
     * @return bool 是否成功执行
     */
    function clearDirectory(string $directory, bool $preserveDirectory = true): bool
    {
        // 规范化目录路径，统一使用DIRECTORY_SEPARATOR
        $directory = rtrim(realpath($directory), DIRECTORY_SEPARATOR);

        Log::write('AutoClearLogFiles开始清理目录: ' . $directory);

        // 检查目录是否存在
        if (!is_dir($directory)) {
            Log::write('AutoClearLogFiles目录不存在或不是有效目录: ' . $directory);
            return false;
        }

        // 计算一周前的时间戳（7天 = 7*24*60*60 = 604800秒）
        $one_week_ago = time() - 604800;

        // 打开目录
        $handle = opendir($directory);
        if (!$handle) {
            Log::write('AutoClearLogFiles无法打开目录: ' . $directory);
            return false;
        }

        // 遍历目录内容
        while (($entry = readdir($handle)) !== false) {
            // 跳过当前目录和上级目录
            if ($entry === '.' || $entry === '..') {
                continue;
            }

            // 使用DIRECTORY_SEPARATOR确保路径分隔符正确
            $path = $directory . DIRECTORY_SEPARATOR . $entry;

            // 递归处理子目录
            if (is_dir($path)) {
                // 递归清理子目录（只删一周前文件，保留子目录本身）
                if (!$this->clearDirectory($path, true)) {
                    Log::write('AutoClearLogFiles递归清理子目录失败: ' . $path);
                    closedir($handle);
                    return false;
                }

                // 检查子目录是否为空，若为空则删除
                $isEmpty = true;
                $sub_handle = opendir($path);
                while (($sub_entry = readdir($sub_handle)) !== false) {
                    if ($sub_entry !== '.' && $sub_entry !== '..') {
                        $isEmpty = false;
                        break;
                    }
                }
                closedir($sub_handle);

                if ($isEmpty && !$preserveDirectory) {
                    if (!rmdir($path)) {
                        Log::write('AutoClearLogFiles删除空目录失败: ' . $path);
                    } else {
                        Log::write('AutoClearLogFiles已删除空目录: ' . $path);
                    }
                }
            } else {
                // 过滤日志文件（可选：只清理.log后缀的文件，避免误删其他类型文件）
                $file_ext = pathinfo($path, PATHINFO_EXTENSION);
                if ($file_ext !== 'log') {
                    Log::write('AutoClearLogFiles跳过非日志文件: ' . $path);
                    continue;
                }

                // 获取文件的最后修改时间
                $file_time = filemtime($path);

                // 校验：文件时间有效 且 早于/等于一周前
                if ($file_time !== false && $file_time <= $one_week_ago) {
                    // 删除一周前的日志文件
                    if (!unlink($path)) {
                        Log::write('AutoClearLogFiles删除日志文件失败: ' . $path);
                        closedir($handle);
                        return false;
                    }
                    Log::write('AutoClearLogFiles已删除一周前的日志文件: ' . $path);
                } else {
                    // 跳过近期日志文件
                    Log::write('AutoClearLogFiles跳过近期日志文件: ' . $path);
                }
            }
        }

        // 关闭目录句柄
        closedir($handle);

        // 根目录是否删除（默认保留，避免目录丢失）
        if (!$preserveDirectory) {
            Log::write('AutoClearLogFiles准备删除根目录: ' . $directory);
            if (!rmdir($directory)) {
                Log::write('AutoClearLogFiles删除根目录失败: ' . $directory);
                return false;
            }
            Log::write('AutoClearLogFiles成功删除根目录: ' . $directory);
        } else {
            Log::write('AutoClearLogFiles保留根目录: ' . $directory);
        }

        return true;
    }
}