Viewing file:  Filesystem.php (7.08 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
declare(strict_types=1);
namespace Arcanedev\LogViewer\Utilities;
use Arcanedev\LogViewer\Contracts\Utilities\Filesystem as FilesystemContract;
use Arcanedev\LogViewer\Exceptions\FilesystemException;
use Arcanedev\LogViewer\Helpers\LogParser;
use Exception;
use Illuminate\Filesystem\Filesystem as IlluminateFilesystem;
/**
* Class Filesystem
*
* @author ARCANEDEV <arcanedev.maroc@gmail.com>
*/
class Filesystem implements FilesystemContract
{
/* -----------------------------------------------------------------
| Properties
| -----------------------------------------------------------------
*/
/**
* The filesystem instance.
*
* @var \Illuminate\Filesystem\Filesystem
*/
protected $filesystem;
/**
* The base storage path.
*
* @var string
*/
protected $storagePath;
/**
* The log files prefix pattern.
*
* @var string
*/
protected $prefixPattern;
/**
* The log files date pattern.
*
* @var string
*/
protected $datePattern;
/**
* The log files extension.
*
* @var string
*/
protected $extension;
/* -----------------------------------------------------------------
| Constructor
| -----------------------------------------------------------------
*/
/**
* Filesystem constructor.
*
* @param \Illuminate\Filesystem\Filesystem $files
* @param string $storagePath
*/
public function __construct(IlluminateFilesystem $files, $storagePath)
{
$this->filesystem = $files;
$this->setPath($storagePath);
$this->setPattern();
}
/* -----------------------------------------------------------------
| Getters & Setters
| -----------------------------------------------------------------
*/
/**
* Get the files instance.
*
* @return \Illuminate\Filesystem\Filesystem
*/
public function getInstance()
{
return $this->filesystem;
}
/**
* Set the log storage path.
*
* @param string $storagePath
*
* @return $this
*/
public function setPath($storagePath)
{
$this->storagePath = $storagePath;
return $this;
}
/**
* Get the log pattern.
*
* @return string
*/
public function getPattern(): string
{
return $this->prefixPattern.$this->datePattern.$this->extension;
}
/**
* Set the log pattern.
*
* @param string $date
* @param string $prefix
* @param string $extension
*
* @return $this
*/
public function setPattern(
$prefix = self::PATTERN_PREFIX,
$date = self::PATTERN_DATE,
$extension = self::PATTERN_EXTENSION
) {
$this->setPrefixPattern($prefix);
$this->setDatePattern($date);
$this->setExtension($extension);
return $this;
}
/**
* Set the log date pattern.
*
* @param string $datePattern
*
* @return $this
*/
public function setDatePattern($datePattern)
{
$this->datePattern = $datePattern;
return $this;
}
/**
* Set the log prefix pattern.
*
* @param string $prefixPattern
*
* @return $this
*/
public function setPrefixPattern($prefixPattern)
{
$this->prefixPattern = $prefixPattern;
return $this;
}
/**
* Set the log extension.
*
* @param string $extension
*
* @return $this
*/
public function setExtension($extension)
{
$this->extension = $extension;
return $this;
}
/* -----------------------------------------------------------------
| Main Methods
| -----------------------------------------------------------------
*/
/**
* Get all log files.
*
* @return array
*/
public function all()
{
return $this->getFiles('*'.$this->extension);
}
/**
* Get all valid log files.
*
* @return array
*/
public function logs()
{
return $this->getFiles($this->getPattern());
}
/**
* List the log files (Only dates).
*
* @param bool $withPaths
*
* @return array
*/
public function dates($withPaths = false)
{
$files = array_reverse($this->logs());
$dates = $this->extractDates($files);
if ($withPaths) {
$dates = array_combine($dates, $files); // [date => file]
}
return $dates;
}
/**
* Read the log.
*
* @param string $date
*
* @return string
*
* @throws \Arcanedev\LogViewer\Exceptions\FilesystemException
*/
public function read($date)
{
try {
$log = $this->filesystem->get(
$this->getLogPath($date)
);
}
catch (Exception $e) {
throw new FilesystemException($e->getMessage());
}
return $log;
}
/**
* Delete the log.
*
* @param string $date
*
* @return bool
*
* @throws \Arcanedev\LogViewer\Exceptions\FilesystemException
*/
public function delete(string $date)
{
$path = $this->getLogPath($date);
throw_unless($this->filesystem->delete($path), FilesystemException::cannotDeleteLog());
return true;
}
/**
* Clear the log files.
*
* @return bool
*/
public function clear()
{
return $this->filesystem->delete($this->logs());
}
/**
* Get the log file path.
*
* @param string $date
*
* @return string
*/
public function path($date)
{
return $this->getLogPath($date);
}
/* -----------------------------------------------------------------
| Other Methods
| -----------------------------------------------------------------
*/
/**
* Get all files.
*
* @param string $pattern
*
* @return array
*/
private function getFiles($pattern)
{
$files = $this->filesystem->glob(
$this->storagePath.DIRECTORY_SEPARATOR.$pattern, defined('GLOB_BRACE') ? GLOB_BRACE : 0
);
return array_filter(array_map('realpath', $files));
}
/**
* Get the log file path.
*
* @param string $date
*
* @return string
*
* @throws \Arcanedev\LogViewer\Exceptions\FilesystemException
*/
private function getLogPath(string $date)
{
$path = $this->storagePath.DIRECTORY_SEPARATOR.$this->prefixPattern.$date.$this->extension;
if ( ! $this->filesystem->exists($path)) {
throw FilesystemException::invalidPath($path);
}
return realpath($path);
}
/**
* Extract dates from files.
*
* @param array $files
*
* @return array
*/
private function extractDates(array $files)
{
return array_map(function ($file) {
return LogParser::extractDate(basename($file));
}, $files);
}
}
|