Viewing file:  FileRepository.php (13.4 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
namespace Nwidart\Modules;
use Countable;
use Illuminate\Cache\CacheManager;
use Illuminate\Container\Container;
use Illuminate\Contracts\Config\Repository as ConfigRepository;
use Illuminate\Contracts\Routing\UrlGenerator;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Str;
use Illuminate\Support\Traits\Macroable;
use Nwidart\Modules\Contracts\RepositoryInterface;
use Nwidart\Modules\Exceptions\InvalidAssetPath;
use Nwidart\Modules\Exceptions\ModuleNotFoundException;
use Nwidart\Modules\Process\Installer;
use Nwidart\Modules\Process\Updater;
abstract class FileRepository implements RepositoryInterface, Countable
{
use Macroable;
/**
* Application instance.
*
* @var \Illuminate\Contracts\Foundation\Application|\Laravel\Lumen\Application
*/
protected $app;
/**
* The module path.
*
* @var string|null
*/
protected $path;
/**
* The scanned paths.
*
* @var array
*/
protected $paths = [];
/**
* @var string
*/
protected $stubPath;
/**
* @var UrlGenerator
*/
private $url;
/**
* @var ConfigRepository
*/
private $config;
/**
* @var Filesystem
*/
private $files;
/**
* @var CacheManager
*/
private $cache;
/**
* The constructor.
* @param Container $app
* @param string|null $path
*/
public function __construct(Container $app, $path = null)
{
$this->app = $app;
$this->path = $path;
$this->url = $app['url'];
$this->config = $app['config'];
$this->files = $app['files'];
$this->cache = $app['cache'];
}
/**
* Add other module location.
*
* @param string $path
*
* @return $this
*/
public function addLocation($path)
{
$this->paths[] = $path;
return $this;
}
/**
* Get all additional paths.
*
* @return array
*/
public function getPaths() : array
{
return $this->paths;
}
/**
* Get scanned modules paths.
*
* @return array
*/
public function getScanPaths() : array
{
$paths = $this->paths;
$paths[] = $this->getPath();
if ($this->config('scan.enabled')) {
$paths = array_merge($paths, $this->config('scan.paths'));
}
$paths = array_map(function ($path) {
return Str::endsWith($path, '/*') ? $path : Str::finish($path, '/*');
}, $paths);
return $paths;
}
/**
* Creates a new Module instance
*
* @param Container $app
* @param string $args
* @param string $path
* @return \Nwidart\Modules\Module
*/
abstract protected function createModule(...$args);
/**
* Get & scan all modules.
*
* @return array
*/
public function scan()
{
$paths = $this->getScanPaths();
$modules = [];
foreach ($paths as $key => $path) {
$manifests = $this->getFiles()->glob("{$path}/module.json");
is_array($manifests) || $manifests = [];
foreach ($manifests as $manifest) {
$name = Json::make($manifest)->get('name');
$modules[$name] = $this->createModule($this->app, $name, dirname($manifest));
}
}
return $modules;
}
/**
* Get all modules.
*
* @return array
*/
public function all() : array
{
if (!$this->config('cache.enabled')) {
return $this->scan();
}
return $this->formatCached($this->getCached());
}
/**
* Format the cached data as array of modules.
*
* @param array $cached
*
* @return array
*/
protected function formatCached($cached)
{
$modules = [];
foreach ($cached as $name => $module) {
$path = $module['path'];
$modules[$name] = $this->createModule($this->app, $name, $path);
}
return $modules;
}
/**
* Get cached modules.
*
* @return array
*/
public function getCached()
{
return $this->cache->remember($this->config('cache.key'), $this->config('cache.lifetime'), function () {
return $this->toCollection()->toArray();
});
}
/**
* Get all modules as collection instance.
*
* @return Collection
*/
public function toCollection() : Collection
{
return new Collection($this->scan());
}
/**
* Get modules by status.
*
* @param $status
*
* @return array
*/
public function getByStatus($status) : array
{
$modules = [];
/** @var Module $module */
foreach ($this->all() as $name => $module) {
if ($module->isStatus($status)) {
$modules[$name] = $module;
}
}
return $modules;
}
/**
* Determine whether the given module exist.
*
* @param $name
*
* @return bool
*/
public function has($name) : bool
{
return array_key_exists($name, $this->all());
}
/**
* Get list of enabled modules.
*
* @return array
*/
public function allEnabled() : array
{
return $this->getByStatus(true);
}
/**
* Get list of disabled modules.
*
* @return array
*/
public function allDisabled() : array
{
return $this->getByStatus(false);
}
/**
* Get count from all modules.
*
* @return int
*/
public function count() : int
{
return count($this->all());
}
/**
* Get all ordered modules.
*
* @param string $direction
*
* @return array
*/
public function getOrdered($direction = 'asc') : array
{
$modules = $this->allEnabled();
uasort($modules, function (Module $a, Module $b) use ($direction) {
if ($a->get('priority') === $b->get('priority')) {
return 0;
}
if ($direction === 'desc') {
return $a->get('priority') < $b->get('priority') ? 1 : -1;
}
return $a->get('priority') > $b->get('priority') ? 1 : -1;
});
return $modules;
}
/**
* @inheritDoc
*/
public function getPath() : string
{
return $this->path ?: $this->config('paths.modules', base_path('Modules'));
}
/**
* @inheritDoc
*/
public function register(): void
{
foreach ($this->getOrdered() as $module) {
$module->register();
}
}
/**
* @inheritDoc
*/
public function boot(): void
{
foreach ($this->getOrdered() as $module) {
$module->boot();
}
}
/**
* @inheritDoc
*/
public function find(string $name)
{
foreach ($this->all() as $module) {
if ($module->getLowerName() === strtolower($name)) {
return $module;
}
}
return;
}
/**
* @inheritDoc
*/
public function findByAlias(string $alias)
{
foreach ($this->all() as $module) {
if ($module->getAlias() === $alias) {
return $module;
}
}
return;
}
/**
* @inheritDoc
*/
public function findRequirements($name): array
{
$requirements = [];
$module = $this->findOrFail($name);
foreach ($module->getRequires() as $requirementName) {
$requirements[] = $this->findByAlias($requirementName);
}
return $requirements;
}
/**
* Find a specific module, if there return that, otherwise throw exception.
*
* @param $name
*
* @return Module
*
* @throws ModuleNotFoundException
*/
public function findOrFail(string $name)
{
$module = $this->find($name);
if ($module !== null) {
return $module;
}
throw new ModuleNotFoundException("Module [{$name}] does not exist!");
}
/**
* Get all modules as laravel collection instance.
*
* @param $status
*
* @return Collection
*/
public function collections($status = 1) : Collection
{
return new Collection($this->getByStatus($status));
}
/**
* Get module path for a specific module.
*
* @param $module
*
* @return string
*/
public function getModulePath($module)
{
try {
return $this->findOrFail($module)->getPath() . '/';
} catch (ModuleNotFoundException $e) {
return $this->getPath() . '/' . Str::studly($module) . '/';
}
}
/**
* @inheritDoc
*/
public function assetPath(string $module) : string
{
return $this->config('paths.assets') . '/' . $module;
}
/**
* @inheritDoc
*/
public function config(string $key, $default = null)
{
return $this->config->get('modules.' . $key, $default);
}
/**
* Get storage path for module used.
*
* @return string
*/
public function getUsedStoragePath() : string
{
$directory = storage_path('app/modules');
if ($this->getFiles()->exists($directory) === false) {
$this->getFiles()->makeDirectory($directory, 0777, true);
}
$path = storage_path('app/modules/modules.used');
if (!$this->getFiles()->exists($path)) {
$this->getFiles()->put($path, '');
}
return $path;
}
/**
* Set module used for cli session.
*
* @param $name
*
* @throws ModuleNotFoundException
*/
public function setUsed($name)
{
$module = $this->findOrFail($name);
$this->getFiles()->put($this->getUsedStoragePath(), $module);
}
/**
* Forget the module used for cli session.
*/
public function forgetUsed()
{
if ($this->getFiles()->exists($this->getUsedStoragePath())) {
$this->getFiles()->delete($this->getUsedStoragePath());
}
}
/**
* Get module used for cli session.
* @return string
* @throws \Nwidart\Modules\Exceptions\ModuleNotFoundException
*/
public function getUsedNow() : string
{
return $this->findOrFail($this->getFiles()->get($this->getUsedStoragePath()));
}
/**
* Get laravel filesystem instance.
*
* @return Filesystem
*/
public function getFiles(): Filesystem
{
return $this->files;
}
/**
* Get module assets path.
*
* @return string
*/
public function getAssetsPath() : string
{
return $this->config('paths.assets');
}
/**
* Get asset url from a specific module.
* @param string $asset
* @return string
* @throws InvalidAssetPath
*/
public function asset($asset) : string
{
if (Str::contains($asset, ':') === false) {
throw InvalidAssetPath::missingModuleName($asset);
}
list($name, $url) = explode(':', $asset);
$baseUrl = str_replace(public_path() . DIRECTORY_SEPARATOR, '', $this->getAssetsPath());
$url = $this->url->asset($baseUrl . "/{$name}/" . $url);
return str_replace(['http://', 'https://'], '//', $url);
}
/**
* @inheritDoc
*/
public function isEnabled(string $name) : bool
{
return $this->findOrFail($name)->isEnabled();
}
/**
* @inheritDoc
*/
public function isDisabled(string $name) : bool
{
return !$this->isEnabled($name);
}
/**
* Enabling a specific module.
* @param string $name
* @return void
* @throws \Nwidart\Modules\Exceptions\ModuleNotFoundException
*/
public function enable($name)
{
$this->findOrFail($name)->enable();
}
/**
* Disabling a specific module.
* @param string $name
* @return void
* @throws \Nwidart\Modules\Exceptions\ModuleNotFoundException
*/
public function disable($name)
{
$this->findOrFail($name)->disable();
}
/**
* @inheritDoc
*/
public function delete(string $name) : bool
{
return $this->findOrFail($name)->delete();
}
/**
* Update dependencies for the specified module.
*
* @param string $module
*/
public function update($module)
{
with(new Updater($this))->update($module);
}
/**
* Install the specified module.
*
* @param string $name
* @param string $version
* @param string $type
* @param bool $subtree
*
* @return \Symfony\Component\Process\Process
*/
public function install($name, $version = 'dev-master', $type = 'composer', $subtree = false)
{
$installer = new Installer($name, $version, $type, $subtree);
return $installer->run();
}
/**
* Get stub path.
*
* @return string|null
*/
public function getStubPath()
{
if ($this->stubPath !== null) {
return $this->stubPath;
}
if ($this->config('stubs.enabled') === true) {
return $this->config('stubs.path');
}
return $this->stubPath;
}
/**
* Set stub path.
*
* @param string $stubPath
*
* @return $this
*/
public function setStubPath($stubPath)
{
$this->stubPath = $stubPath;
return $this;
}
}
|