207 lines
4.6 KiB
PHP
Executable File
207 lines
4.6 KiB
PHP
Executable File
<?php
|
|
|
|
namespace mpba\Modules\Activators;
|
|
|
|
use Illuminate\Cache\CacheManager;
|
|
use Illuminate\Config\Repository as Config;
|
|
use Illuminate\Container\Container;
|
|
use Illuminate\Contracts\Filesystem\FileNotFoundException;
|
|
use Illuminate\Filesystem\Filesystem;
|
|
use mpba\Modules\Contracts\ActivatorInterface;
|
|
use mpba\Modules\Module;
|
|
|
|
class FileActivator implements ActivatorInterface
|
|
{
|
|
/**
|
|
* Laravel cache instance
|
|
*
|
|
* @var CacheManager
|
|
*/
|
|
private $cache;
|
|
|
|
/**
|
|
* Laravel Filesystem instance
|
|
*
|
|
* @var Filesystem
|
|
*/
|
|
private $files;
|
|
|
|
/**
|
|
* Laravel config instance
|
|
*
|
|
* @var Config
|
|
*/
|
|
private $config;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $cacheKey;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $cacheLifetime;
|
|
|
|
/**
|
|
* Array of modules activation statuses
|
|
*
|
|
* @var array
|
|
*/
|
|
private $modulesStatuses;
|
|
|
|
/**
|
|
* File used to store activation statuses
|
|
*
|
|
* @var string
|
|
*/
|
|
private $statusesFile;
|
|
|
|
public function __construct(Container $app)
|
|
{
|
|
$this->cache = $app['cache'];
|
|
$this->files = $app['files'];
|
|
$this->config = $app['config'];
|
|
$this->statusesFile = $this->config('statuses-file');
|
|
$this->cacheKey = $this->config('cache-key');
|
|
$this->cacheLifetime = $this->config('cache-lifetime');
|
|
$this->modulesStatuses = $this->getModulesStatuses();
|
|
}
|
|
|
|
/**
|
|
* Get the path of the file where statuses are stored
|
|
*/
|
|
public function getStatusesFilePath(): string
|
|
{
|
|
return $this->statusesFile;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function reset(): void
|
|
{
|
|
if ($this->files->exists($this->statusesFile)) {
|
|
$this->files->delete($this->statusesFile);
|
|
}
|
|
$this->modulesStatuses = [];
|
|
$this->flushCache();
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function enable(Module $module): void
|
|
{
|
|
$this->setActiveByName($module->getName(), true);
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function disable(Module $module): void
|
|
{
|
|
$this->setActiveByName($module->getName(), false);
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function hasStatus(Module $module, bool $status): bool
|
|
{
|
|
if (! isset($this->modulesStatuses[$module->getName()])) {
|
|
return $status === false;
|
|
}
|
|
|
|
return $this->modulesStatuses[$module->getName()] === $status;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function setActive(Module $module, bool $active): void
|
|
{
|
|
$this->setActiveByName($module->getName(), $active);
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function setActiveByName(string $name, bool $status): void
|
|
{
|
|
$this->modulesStatuses[$name] = $status;
|
|
$this->writeJson();
|
|
$this->flushCache();
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function delete(Module $module): void
|
|
{
|
|
if (! isset($this->modulesStatuses[$module->getName()])) {
|
|
return;
|
|
}
|
|
unset($this->modulesStatuses[$module->getName()]);
|
|
$this->writeJson();
|
|
$this->flushCache();
|
|
}
|
|
|
|
/**
|
|
* Writes the activation statuses in a file, as json
|
|
*/
|
|
private function writeJson(): void
|
|
{
|
|
$this->files->put($this->statusesFile, json_encode($this->modulesStatuses, JSON_PRETTY_PRINT));
|
|
}
|
|
|
|
/**
|
|
* Reads the json file that contains the activation statuses.
|
|
*
|
|
* @throws FileNotFoundException
|
|
*/
|
|
private function readJson(): array
|
|
{
|
|
if (! $this->files->exists($this->statusesFile)) {
|
|
return [];
|
|
}
|
|
|
|
return json_decode($this->files->get($this->statusesFile), true);
|
|
}
|
|
|
|
/**
|
|
* Get modules statuses, either from the cache or from
|
|
* the json statuses file if the cache is disabled.
|
|
*
|
|
* @throws FileNotFoundException
|
|
*/
|
|
private function getModulesStatuses(): array
|
|
{
|
|
if (! $this->config->get('modules.cache.enabled')) {
|
|
return $this->readJson();
|
|
}
|
|
|
|
return $this->cache->remember($this->cacheKey, $this->cacheLifetime, function () {
|
|
return $this->readJson();
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Reads a config parameter under the 'activators.file' key
|
|
*
|
|
* @return mixed
|
|
*/
|
|
private function config(string $key, $default = null)
|
|
{
|
|
return $this->config->get('modules.activators.file.'.$key, $default);
|
|
}
|
|
|
|
/**
|
|
* Flushes the modules activation statuses cache
|
|
*/
|
|
private function flushCache(): void
|
|
{
|
|
$this->cache->forget($this->cacheKey);
|
|
}
|
|
}
|