mirror of
https://github.com/NNTmux/newznab-tmux.git
synced 2026-08-29 09:18:54 +00:00
DariusIII
355 lines
11 KiB
PHP
355 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program (see LICENSE.txt in the base directory. If
|
|
* not, see:.
|
|
*
|
|
* @link <http://www.gnu.org/licenses/>.
|
|
* @author niel
|
|
* @author DariusIII
|
|
* @copyright 2016 nZEDb, 2017 NNTmux
|
|
*/
|
|
|
|
namespace App\Models;
|
|
|
|
use Blacklight\utility\Utility;
|
|
use Illuminate\Console\Command;
|
|
use Illuminate\Support\Facades\DB;
|
|
use Yadakhov\InsertOnDuplicateKey;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use App\Support\Database\CacheQueryBuilder;
|
|
|
|
/**
|
|
* Settings - model for settings table.
|
|
*
|
|
* @property string $section
|
|
* @property string $subsection
|
|
* @property string $name
|
|
* @property string $value
|
|
* @property string $hint
|
|
* @property string $setting
|
|
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings whereHint($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings whereName($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings whereSection($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings whereSetting($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings whereSubsection($value)
|
|
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Settings whereValue($value)
|
|
* @mixin \Eloquent
|
|
*/
|
|
class Settings extends Model
|
|
{
|
|
use InsertOnDuplicateKey;
|
|
use CacheQueryBuilder;
|
|
|
|
public const REGISTER_STATUS_OPEN = 0;
|
|
|
|
public const REGISTER_STATUS_INVITE = 1;
|
|
|
|
public const REGISTER_STATUS_CLOSED = 2;
|
|
|
|
public const ERR_BADUNRARPATH = -1;
|
|
|
|
public const ERR_BADFFMPEGPATH = -2;
|
|
|
|
public const ERR_BADMEDIAINFOPATH = -3;
|
|
|
|
public const ERR_BADNZBPATH = -4;
|
|
|
|
public const ERR_DEEPNOUNRAR = -5;
|
|
|
|
public const ERR_BADTMPUNRARPATH = -6;
|
|
|
|
public const ERR_BADNZBPATH_UNREADABLE = -7;
|
|
|
|
public const ERR_BADNZBPATH_UNSET = -8;
|
|
|
|
public const ERR_BAD_COVERS_PATH = -9;
|
|
|
|
public const ERR_BAD_YYDECODER_PATH = -10;
|
|
|
|
public const ERR_BADLAMEPATH = -11;
|
|
|
|
public const ERR_SABCOMPLETEPATH = -12;
|
|
|
|
/**
|
|
* @var Command
|
|
*/
|
|
protected $console;
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $primaryKey = ['section', 'subsection', 'name'];
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $table = 'settings';
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
protected $dateFormat = false;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
public $timestamps = false;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
public $incrementing = false;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $guarded = [];
|
|
|
|
private $dbVersion;
|
|
|
|
/**
|
|
* Adapted from https://laravel.io/forum/01-15-2016-overriding-eloquent-attributes.
|
|
*
|
|
* @param string $key
|
|
* @return mixed
|
|
*/
|
|
public function __get($key)
|
|
{
|
|
$override = self::query()->where('name', $key)->first();
|
|
|
|
// If there's an override and no mutator has been explicitly defined on
|
|
// the model then use the override value
|
|
if ($override && ! $this->hasGetMutator($key)) {
|
|
return $override->value;
|
|
}
|
|
|
|
// If the attribute is not overridden the use the usual __get() magic method
|
|
return parent::__get($key);
|
|
}
|
|
|
|
/**
|
|
* @param $console
|
|
* @return bool
|
|
* @throws \Exception
|
|
*/
|
|
public static function hasAllEntries($console): bool
|
|
{
|
|
$filepath = Utility::pathCombine(['db', 'schema', 'data', '10-settings.tsv'], NN_RES);
|
|
if (! file_exists($filepath)) {
|
|
throw new \InvalidArgumentException("Unable to find {$filepath}");
|
|
}
|
|
$settings = file($filepath);
|
|
|
|
if (! \is_array($settings)) {
|
|
throw new \InvalidArgumentException('Settings is not an array!');
|
|
}
|
|
|
|
$setting = [];
|
|
$dummy = array_shift($settings);
|
|
$result = false;
|
|
if ($dummy !== null) {
|
|
if ($console) {
|
|
$console->info('Verifying settings table...');
|
|
$console->info('(section, subsection, name):');
|
|
}
|
|
$result = true;
|
|
foreach ($settings as $line) {
|
|
$message = '';
|
|
[$setting['section'], $setting['subsection'], $setting['name']] =
|
|
explode("\t", $line);
|
|
|
|
$value = self::settingValue(
|
|
[
|
|
'section' => $setting['section'],
|
|
'subsection' => $setting['subsection'],
|
|
'name' => $setting['name'],
|
|
],
|
|
true
|
|
);
|
|
if ($value === null) {
|
|
$result = false;
|
|
$message = 'error';
|
|
}
|
|
|
|
if ($message !== '' && $console !== null) {
|
|
$console->error(" {$setting['section']}, {$setting['subsection']}, {$setting['name']}: "
|
|
.'MISSING!');
|
|
}
|
|
}
|
|
}
|
|
$console->info('Settings table has all the required data');
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Return a tree-like array of all or selected settings.
|
|
*
|
|
* @param bool $excludeUnsectioned If rows with empty 'section' field should be excluded.
|
|
* Note this doesn't prevent empty 'subsection' fields.
|
|
* @return array
|
|
* @throws \RuntimeException
|
|
*/
|
|
public static function toTree($excludeUnsectioned = true): array
|
|
{
|
|
$results = self::query()->get()->all();
|
|
|
|
$tree = [];
|
|
if (\is_array($results)) {
|
|
foreach ($results as $result) {
|
|
if (! $excludeUnsectioned || ! empty($result['section'])) {
|
|
$tree[$result['section']][$result['subsection']][$result['name']] =
|
|
['value' => $result['value'], 'hint' => $result['hint']];
|
|
}
|
|
}
|
|
} else {
|
|
throw new \RuntimeException(
|
|
'NO results from Settings table! Check your table has been created and populated.'
|
|
);
|
|
}
|
|
|
|
return $tree;
|
|
}
|
|
|
|
/**
|
|
* Checks the supplied parameter is either a string or an array with single element. If
|
|
* either the value is passed to Settings::dottedToArray() for conversion. Otherwise the
|
|
* value is returned unchanged.
|
|
*
|
|
* @param $setting array|bool
|
|
*
|
|
* @return array|bool
|
|
*/
|
|
public static function settingToArray($setting)
|
|
{
|
|
if (! \is_array($setting)) {
|
|
$setting = self::dottedToArray($setting);
|
|
} elseif (\count($setting) === 1) {
|
|
$setting = self::dottedToArray($setting[0]);
|
|
}
|
|
|
|
return $setting;
|
|
}
|
|
|
|
/**
|
|
* Return the value of supplied setting.
|
|
* The setting can be either a normal condition array for the custom 'setting' finder or a
|
|
* dotted string notation setting. Note that dotted notation will be converted to an array,
|
|
* so it will be slower: Explicitly use the array format if speed it paramount.
|
|
* Be aware that this method only returns the first of any values found, so make sure your
|
|
* $setting produces a unique result.
|
|
* @param bool|array $setting
|
|
* @param bool $returnAlways Indicates if the method should throw an exception (false) or return
|
|
* null on failure. Defaults to throwing an exception.
|
|
*
|
|
* @return string|null The setting's value, or null on failure IF 'returnAlways' is true.
|
|
* @throws \Exception
|
|
*/
|
|
public static function settingValue($setting, $returnAlways = false): ?string
|
|
{
|
|
$setting = self::settingToArray($setting);
|
|
$result = self::query()->where([
|
|
'section' => $setting['section'] ?? '',
|
|
'subsection' => $setting['subsection'] ?? '',
|
|
'name' => $setting['name'],
|
|
])->value('value');
|
|
|
|
if ($result !== null) {
|
|
$value = $result;
|
|
} elseif ($returnAlways === false) {
|
|
throw new \RuntimeException('Unable to fetch setting from Db!');
|
|
} else {
|
|
$value = null;
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* @param $setting
|
|
*
|
|
* @return array|bool
|
|
*/
|
|
protected static function dottedToArray($setting)
|
|
{
|
|
$result = [];
|
|
if (\is_string($setting)) {
|
|
$array = explode('.', $setting);
|
|
$count = \count($array);
|
|
if ($count > 3) {
|
|
return false;
|
|
}
|
|
|
|
while (3 - $count > 0) {
|
|
array_unshift($array, '');
|
|
$count++;
|
|
}
|
|
list(
|
|
$result['section'],
|
|
$result['subsection'],
|
|
$result['name']) = $array;
|
|
} else {
|
|
return false;
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* Returns the stored Db version string.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getDbVersion(): string
|
|
{
|
|
return $this->dbVersion;
|
|
}
|
|
|
|
/**
|
|
* @param string $requiredVersion The minimum version to compare against
|
|
*
|
|
* @return bool|null TRUE if Db version is greater than or eaqual to $requiredVersion,
|
|
* false if not, and null if the version isn't available to check against.
|
|
*/
|
|
public function isDbVersionAtLeast($requiredVersion): ?bool
|
|
{
|
|
$this->fetchDbVersion();
|
|
if (empty($this->dbVersion)) {
|
|
return null;
|
|
}
|
|
|
|
return version_compare($requiredVersion, $this->dbVersion, '<=');
|
|
}
|
|
|
|
/**
|
|
* Performs the fetch from the Db server and stores the resulting Major.Minor.Version number.
|
|
*/
|
|
private function fetchDbVersion()
|
|
{
|
|
$result = DB::select('SELECT VERSION() AS version');
|
|
|
|
if (! empty($result)) {
|
|
$dummy = explode('-', $result[0]->version, 2);
|
|
$this->dbVersion = $dummy[0];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param array $data
|
|
*/
|
|
public static function settingsUpdate(array $data = [])
|
|
{
|
|
foreach ($data as $key => $value) {
|
|
self::query()->where('setting', $key)->update(['value' => \is_array($value) ? implode(', ', $value) : $value]);
|
|
}
|
|
}
|
|
}
|