feat: 新增对接 cls 日志

Author: mouyong

ClsLogger/.gitignore

@@ -0,0 +1,13 @@
+node_modules/
+npm-debug.log
+*-error.log
+*lock*
+.temp
+.cache
+.settings/
+.idea
+.vscode
+.phpunit.result.cache
+.DS_Store
+dist/
+.idea/

ClsLogger/README.md

@@ -0,0 +1 @@
+# ClsLogger

ClsLogger/app/Http/Controllers/SettingController.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Plugins\ClsLogger\Http\Controllers;
+
+use Illuminate\Http\Request;
+use Illuminate\Routing\Controller;
+
+class SettingController extends Controller
+{
+    public function index(Request $request)
+    {
+        // code
+        $configs = [];
+
+        return view('ClsLogger::index', [
+            'configs' => $configs,
+        ]);
+    }
+
+    public function showSettingView(Request $request)
+    {
+        config(['session.same_site' => 'none']);
+        config(['session.secure' => uniqid()]);
+
+        // code
+        $itemKeys = [
+            // 'item_key1',
+            // 'item_key2',
+        ];
+
+        // $configs = Config::whereIn('item_key', $itemKeys)->where('item_tag', 'cls_logger')->get();
+        $configs = [];
+
+        return view('ClsLogger::setting', [
+            'configs' => $configs,
+        ]);
+    }
+
+    public function saveSetting(Request $request)
+    {
+        $request->validate([
+            // 'item_key1' => 'required|url',
+            // 'item_key2' => 'nullable|url',
+        ]);
+
+        $itemKeys = [
+            // 'item_key1',
+            // 'item_key2',
+        ];
+
+        // code
+        // Config updateConfigs with $itemKeys and 'cls_logger'
+
+        return redirect(route('cls-logger.setting'));
+    }
+}

ClsLogger/app/Logging/ClsLogger.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Plugins\ClsLogger\Logging;
+
+use Illuminate\Log\Logger;
+use Illuminate\Support\Arr;
+use Psr\Log\LoggerInterface;
+use Psr\Log\InvalidArgumentException;
+
+class ClsLogger extends Logger implements LoggerInterface
+{
+    protected $channelConfig = [];
+
+    public function __invoke(array $config)
+    {
+        $this->channelConfig = $config;
+
+        return $this;
+    }
+
+    public function info($message, array $context = []): void
+    {
+        $this->log("INFO", $message, $context);
+    }
+
+    public function log($level, $message, array $context = []): void
+    {
+        \Plugins\ClsLogger\Utilties\ClsLogUtiltity::logToCls($level, $message, $context);
+    }
+}

ClsLogger/app/Logging/ClsLoggerHandler.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Plugins\ClsLogger\Logging;
+
+use Monolog\LogRecord;
+use Monolog\Handler\AbstractProcessingHandler;
+
+class ClsLoggerHandler extends AbstractProcessingHandler
+{
+    public function write(LogRecord $record): void
+    {
+        \Plugins\ClsLogger\Utilties\ClsLogUtiltity::logToCls($record['level_name'], $record['formatted']);
+    }
+}

ClsLogger/app/Models/.gitkeep

@@ -0,0 +1,35 @@
+<?php
+
+namespace Plugins\ClsLogger\Providers;
+
+use Illuminate\Support\ServiceProvider;
+
+class ClsLoggerServiceProvider extends ServiceProvider
+{
+    /**
+     * Register services.
+     */
+    public function register(): void
+    {
+        //
+    }
+
+    /**
+     * Bootstrap services.
+     */
+    public function boot(): void
+    {
+        $channels = config('logging.channels');
+        $channels['cls'] = [
+            'driver' => 'monolog',
+            'handler' => \Plugins\ClsLogger\Logging\ClsLoggerHandler::class,
+
+            // or
+
+            // 'driver' => 'custom',
+            // 'via' => \Plugins\ClsLogger\Logging\ClsLogger::class,
+        ];
+
+        config(['logging.channels' => $channels]);
+    }
+}

ClsLogger/app/Providers/ClsLoggerServiceProvider.php

@@ -0,0 +1,57 @@
+<?php
+
+/*
+ * Fresns (https://fresns.org)
+ * Copyright (C) 2021-Present Jevan Tang
+ * Released under the Apache-2.0 License.
+ */
+
+namespace Plugins\ClsLogger\Providers;
+
+use Illuminate\Support\Arr;
+use Illuminate\Support\Facades\File;
+use Illuminate\Support\Str;
+use Illuminate\Support\ServiceProvider;
+use Symfony\Component\Finder\Finder;
+
+class CommandServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap services.
+     */
+    public function boot(): void
+    {
+        $commandsDirectory = dirname(__DIR__) . '/Console/Commands';
+        if (File::exists($commandsDirectory)) {
+            $this->load($commandsDirectory);
+        }
+    }
+
+    /**
+     * Register all of the commands in the given directory.
+     *
+     * @param array|string $paths
+     */
+    protected function load($paths): void
+    {
+        $paths = array_unique(Arr::wrap($paths));
+
+        $paths = array_filter($paths, function ($path) {
+            return is_dir($path);
+        });
+
+        if (empty($paths)) {
+            return;
+        }
+
+        $commands = [];
+        foreach ((new Finder)->in($paths)->files() as $command) {
+            $commandClass = Str::before(self::class, 'Providers\\') . 'Console\\Commands\\' . str_replace('.php', '', $command->getBasename());
+            if (class_exists($commandClass)) {
+                $commands[] = $commandClass;
+            }
+        }
+
+        $this->commands($commands);
+    }
+}

ClsLogger/app/Providers/CommandServiceProvider.php

@@ -0,0 +1,72 @@
+<?php
+
+/*
+ * Fresns (https://fresns.org)
+ * Copyright (C) 2021-Present Jevan Tang
+ * Released under the Apache-2.0 License.
+ */
+
+namespace Plugins\ClsLogger\Providers;
+
+use Illuminate\Support\ServiceProvider as BaseServiceProvider;
+
+class PluginServiceProvider extends BaseServiceProvider
+{
+    /**
+     * Boot the application events.
+     */
+    public function boot(): void
+    {
+        $this->registerTranslations();
+        $this->registerConfig();
+        $this->registerViews();
+
+        $this->loadMigrationsFrom(dirname(__DIR__, 2) . '/database/migrations');
+
+        // Event::listen(UserCreated::class, UserCreatedListener::class);
+    }
+
+    /**
+     * Register the service provider.
+     */
+    public function register(): void
+    {
+        // if ($this->app->runningInConsole()) {
+            $this->app->register(CommandServiceProvider::class);
+        // }
+    }
+
+    /**
+     * Register config.
+     */
+    protected function registerConfig(): void
+    {
+        $this->mergeConfigFrom(
+            dirname(__DIR__, 2) . '/config/cls-logger.php', 'cls-logger'
+        );
+    }
+
+    /**
+     * Register views.
+     */
+    public function registerViews(): void
+    {
+        $this->loadViewsFrom(dirname(__DIR__, 2) . '/resources/views', 'ClsLogger');
+    }
+
+    /**
+     * Register translations.
+     */
+    public function registerTranslations(): void
+    {
+        $this->loadTranslationsFrom(dirname(__DIR__, 2) . '/resources/lang', 'ClsLogger');
+    }
+
+    /**
+     * Get the services provided by the provider.
+     */
+    public function provides(): array
+    {
+        return [];
+    }
+}

ClsLogger/app/Providers/PluginServiceProvider.php

@@ -0,0 +1,83 @@
+<?php
+
+/*
+ * Fresns (https://fresns.org)
+ * Copyright (C) 2021-Present Jevan Tang
+ * Released under the Apache-2.0 License.
+ */
+
+namespace Plugins\ClsLogger\Providers;
+
+use Fresns\MarketManager\Models\Plugin;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Route;
+use Illuminate\Foundation\Support\Providers\RouteServiceProvider as BaseServiceProvider;
+
+class RouteServiceProvider extends BaseServiceProvider
+{
+    /**
+     * Called before routes are registered.
+     *
+     * Register any model bindings or pattern based filters.
+     */
+    public function boot(): void
+    {
+        parent::boot();
+    }
+
+    /**
+     * Define the routes for the application.
+     */
+    public function map(): void
+    {
+        $host = null;
+
+        // try {
+        //     if (class_exists(Plugin::class)) {
+        //         $fskey = 'ClsLogger';
+        //         $cacheKey = "{$fskey}_model";
+
+        //         $pluginModel = Cache::get($cacheKey);
+        //         if (empty($pluginModel)) {
+        //             $pluginModel = Plugin::withTrashed()->where('fskey', $fskey)->first();
+
+        //             Cache::put($cacheKey, $pluginModel, now()->addMinutes(30));
+        //         }
+
+        //         $pluginHost = $pluginModel?->plugin_host ?? '';
+
+        //         $host = str_replace(['http://', 'https://'], '', rtrim($pluginHost, '/'));
+        //     }
+        // } catch (\Throwable $e) {
+        //     info("get plugin host failed: " . $e->getMessage());
+        // }
+
+        Route::group([
+            'domain' => $host,
+        ], function () {
+            $this->mapApiRoutes();
+
+            $this->mapWebRoutes();
+        });
+    }
+
+    /**
+     * Define the "web" routes for the application.
+     *
+     * These routes all receive session state, CSRF protection, etc.
+     */
+    protected function mapWebRoutes(): void
+    {
+        Route::middleware('web')->group(dirname(__DIR__, 2) . '/routes/web.php');
+    }
+
+    /**
+     * Define the "api" routes for the application.
+     *
+     * These routes are typically stateless.
+     */
+    protected function mapApiRoutes(): void
+    {
+        Route::prefix('api')->name('api.')->middleware('api')->group(dirname(__DIR__, 2) . '/routes/api.php');
+    }
+}