catchAdmin/catch/src/Support/Module/Driver/FileDriver.php

<?php

// +----------------------------------------------------------------------
// | CatchAdmin [Just Like ～ ]
// +----------------------------------------------------------------------
// | Copyright (c) 2017~2021 https://catchadmin.com All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( https://github.com/JaguarJack/catchadmin-laravel/blob/master/LICENSE.md )
// +----------------------------------------------------------------------
// | Author: JaguarJack [ njphper@gmail.com ]
// +----------------------------------------------------------------------


declare(strict_types=1);

namespace Catch\Support\Module\Driver;

use Catch\CatchAdmin;
use Catch\Contracts\ModuleRepositoryInterface;
use Catch\Exceptions\FailedException;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\File;
use Illuminate\Support\Str;

/**
 * FileDriver
 */
class FileDriver implements ModuleRepositoryInterface
{
    protected string $moduleJson;

    /**
     * construct
     */
    public function __construct()
    {
        $this->moduleJson = storage_path('app').DIRECTORY_SEPARATOR.'modules.json';
    }

    /**
     * all
     *
     * @param array $search
     * @return Collection
     */
    public function all(array $search = []): Collection
    {
        if (! File::exists($this->moduleJson)) {
            return Collection::make([]);
        }

        if (! Str::length(File::get($this->moduleJson))) {
            return Collection::make([]);
        }

        $modules = Collection::make(\json_decode(File::get($this->moduleJson), true))->values();

        $name = $search['name'] ?? '';

        if (! $name) {
            return $modules;
        }

        return $modules->filter(function ($module) use ($name) {
            return Str::of($module['name'])->contains($name);
        });
    }

    /**
     * create module json
     *
     * @param array $module
     * @return bool
     */
    public function create(array $module): bool
    {
        $modules = $this->all();

        $this->hasSameModule($module, $modules);

        $module['provider'] = sprintf('\\%s', CatchAdmin::getModuleServiceProvider($module['path']));
        $module['version'] = '1.0.0';
        $module['enable'] = true;

        File::put($this->moduleJson, $modules->push($module)->toJson(JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));

        return true;
    }

    /**
     * module info
     *
     * @param string $name
     * @return Collection
     */
    public function show(string $name): Collection
    {
        foreach ($this->all() as $module) {
            if (Str::of($module['name'])->exactly($name)) {
                return Collection::make($module);
            }
        }

        throw new FailedException("Module [$name] not Found");
    }

    /**
     * update module json
     *
     * @param string $name
     * @param array $module
     * @return bool
     */
    public function update(string $name, array $module): bool
    {
        File::put($this->moduleJson, $this->all()->map(function ($m) use ($module, $name) {
            if (Str::of($name)->exactly($m['name'])) {
                $m['path'] = $module['path'];
                $m['name'] = $module['name'];
                $m['description'] = $module['description'] ?? '';
                $m['keywords'] = $module['keywords'] ?? '';
                $m['enable'] = $module['enable'];
            }
            return $m;
        })->toJson(JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));

        return true;
    }

    /**
     * delete module json
     *
     * @param string $name
     * @return bool
     */
    public function delete(string $name): bool
    {
        File::put($this->moduleJson, $this->all()->filter(function ($module) use ($name) {
            if (! Str::of($name)->exactly($module['name'])) {
                return $module;
            }
        })->toJson(JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));


        return true;
    }

    /**
     * disable or enable
     *
     * @param $name
     * @return bool|int
     */
    public function disOrEnable($name): bool|int
    {
        return File::put($this->moduleJson, $this->all()->map(function ($module) use ($name) {
            if (Str::of($module['name'])->exactly($name)) {
                $module['enable'] = ! $module['enable'];
            }
            return $module;
        })->toJson(JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE));
    }

    /**
     * get enabled
     *
     * @return Collection
     */
    public function getEnabled(): Collection
    {
        // TODO: Implement getEnabled() method.
        return $this->all()->where('enable', true)->values();
    }

    /**
     *
     * @param array $module
     * @param Collection $modules
     * @return void
     */
    protected function hasSameModule(array $module, Collection $modules): void
    {
        if ($modules->count()) {
            if ($modules->pluck('name')->contains($module['name'])) {
                throw new FailedException(sprintf('Module [%s] has been created', $module['name']));
            }

            if ($modules->pluck('path')->contains($module['path'])) {
                throw new FailedException(sprintf('Module path [%s] has been existed', $module['path']));
            }
        }
    }
}