2015-10-31 14:42:25 +00:00
|
|
|
<?php
|
2019-10-03 19:24:12 +00:00
|
|
|
|
2015-10-31 14:42:25 +00:00
|
|
|
/**
|
2016-09-07 22:28:28 +00:00
|
|
|
* Config class.
|
2016-08-01 11:29:13 +00:00
|
|
|
*/
|
2016-12-05 12:12:27 +00:00
|
|
|
|
2015-10-31 14:42:25 +00:00
|
|
|
namespace Alltube;
|
2016-03-29 23:49:08 +00:00
|
|
|
|
2018-02-05 15:48:58 +00:00
|
|
|
use Exception;
|
2015-10-31 14:42:25 +00:00
|
|
|
use Symfony\Component\Yaml\Yaml;
|
2019-11-10 17:05:53 +00:00
|
|
|
use Jawira\CaseConverter\Convert;
|
2016-03-29 23:49:08 +00:00
|
|
|
|
2015-10-31 14:42:25 +00:00
|
|
|
/**
|
2016-09-07 22:28:28 +00:00
|
|
|
* Manage config parameters.
|
2016-08-01 11:29:13 +00:00
|
|
|
*/
|
2016-03-29 23:49:08 +00:00
|
|
|
class Config
|
2015-10-31 14:42:25 +00:00
|
|
|
{
|
2016-08-01 11:29:13 +00:00
|
|
|
/**
|
2016-09-07 22:28:28 +00:00
|
|
|
* Singleton instance.
|
|
|
|
*
|
2019-03-30 17:21:45 +00:00
|
|
|
* @var Config|null
|
2016-08-01 11:29:13 +00:00
|
|
|
*/
|
2016-03-29 23:49:08 +00:00
|
|
|
private static $instance;
|
2015-10-31 14:42:25 +00:00
|
|
|
|
2016-08-01 11:29:13 +00:00
|
|
|
/**
|
2016-09-07 22:28:28 +00:00
|
|
|
* youtube-dl binary path.
|
|
|
|
*
|
2016-08-01 11:29:13 +00:00
|
|
|
* @var string
|
|
|
|
*/
|
2015-10-31 14:56:00 +00:00
|
|
|
public $youtubedl = 'vendor/rg3/youtube-dl/youtube_dl/__main__.py';
|
2016-08-01 11:29:13 +00:00
|
|
|
|
|
|
|
/**
|
2016-09-07 22:28:28 +00:00
|
|
|
* python binary path.
|
|
|
|
*
|
2016-08-01 11:29:13 +00:00
|
|
|
* @var string
|
|
|
|
*/
|
2015-10-31 14:42:25 +00:00
|
|
|
public $python = '/usr/bin/python';
|
2016-08-01 11:29:13 +00:00
|
|
|
|
|
|
|
/**
|
2016-09-07 22:28:28 +00:00
|
|
|
* youtube-dl parameters.
|
|
|
|
*
|
2016-08-01 11:29:13 +00:00
|
|
|
* @var array
|
|
|
|
*/
|
2018-05-23 19:43:34 +00:00
|
|
|
public $params = ['--no-warnings', '--ignore-errors', '--flat-playlist', '--restrict-filenames', '--no-playlist'];
|
2016-08-01 11:29:13 +00:00
|
|
|
|
|
|
|
/**
|
2016-09-07 22:28:28 +00:00
|
|
|
* Enable audio conversion.
|
|
|
|
*
|
2016-08-01 11:29:13 +00:00
|
|
|
* @var bool
|
|
|
|
*/
|
2015-10-31 14:42:25 +00:00
|
|
|
public $convert = false;
|
2016-08-01 11:29:13 +00:00
|
|
|
|
2018-01-24 22:30:24 +00:00
|
|
|
/**
|
|
|
|
* Enable advanced conversion mode.
|
|
|
|
*
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $convertAdvanced = false;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* List of formats available in advanced conversion mode.
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
public $convertAdvancedFormats = ['mp3', 'avi', 'flv', 'wav'];
|
|
|
|
|
2016-08-01 11:29:13 +00:00
|
|
|
/**
|
2016-09-07 22:28:28 +00:00
|
|
|
* avconv or ffmpeg binary path.
|
|
|
|
*
|
2016-08-01 11:29:13 +00:00
|
|
|
* @var string
|
|
|
|
*/
|
2015-11-21 19:54:38 +00:00
|
|
|
public $avconv = 'vendor/bin/ffmpeg';
|
2016-08-01 11:29:13 +00:00
|
|
|
|
2018-01-25 14:10:11 +00:00
|
|
|
/**
|
|
|
|
* Path to the directory that contains the phantomjs binary.
|
2018-01-25 14:13:13 +00:00
|
|
|
*
|
2018-01-25 14:10:11 +00:00
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
public $phantomjsDir = 'vendor/bin/';
|
|
|
|
|
2017-01-10 22:37:29 +00:00
|
|
|
/**
|
|
|
|
* Disable URL rewriting.
|
2017-01-10 22:39:58 +00:00
|
|
|
*
|
|
|
|
* @var bool
|
2017-01-10 22:37:29 +00:00
|
|
|
*/
|
|
|
|
public $uglyUrls = false;
|
|
|
|
|
2017-01-16 10:29:56 +00:00
|
|
|
/**
|
|
|
|
* Stream downloaded files trough server?
|
2017-01-16 11:11:37 +00:00
|
|
|
*
|
|
|
|
* @var bool
|
2017-01-16 10:29:56 +00:00
|
|
|
*/
|
|
|
|
public $stream = false;
|
|
|
|
|
2017-04-24 22:40:24 +00:00
|
|
|
/**
|
|
|
|
* Allow to remux video + audio?
|
|
|
|
*
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
public $remux = false;
|
|
|
|
|
2017-11-10 22:50:17 +00:00
|
|
|
/**
|
2017-11-10 22:52:04 +00:00
|
|
|
* MP3 bitrate when converting (in kbit/s).
|
2017-11-10 22:50:17 +00:00
|
|
|
*
|
|
|
|
* @var int
|
|
|
|
*/
|
|
|
|
public $audioBitrate = 128;
|
|
|
|
|
2017-12-09 22:16:48 +00:00
|
|
|
/**
|
|
|
|
* avconv/ffmpeg logging level.
|
2017-12-09 22:57:21 +00:00
|
|
|
* Must be one of these: quiet, panic, fatal, error, warning, info, verbose, debug.
|
2017-12-09 22:16:48 +00:00
|
|
|
*
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
public $avconvVerbosity = 'error';
|
|
|
|
|
2019-01-06 15:59:16 +00:00
|
|
|
/**
|
2019-01-06 16:00:12 +00:00
|
|
|
* App name.
|
2019-01-06 15:59:16 +00:00
|
|
|
*
|
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
public $appName = 'AllTube Download';
|
|
|
|
|
2016-09-05 22:36:47 +00:00
|
|
|
/**
|
2016-09-07 22:28:28 +00:00
|
|
|
* YAML config file path.
|
|
|
|
*
|
2016-09-05 22:36:47 +00:00
|
|
|
* @var string
|
|
|
|
*/
|
|
|
|
private $file;
|
2016-08-18 23:07:51 +00:00
|
|
|
|
2019-05-08 17:46:37 +00:00
|
|
|
/**
|
|
|
|
* Generic formats supported by youtube-dl.
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
public $genericFormats = [];
|
|
|
|
|
2019-11-27 20:22:23 +00:00
|
|
|
public $debug = false;
|
|
|
|
|
2015-10-31 14:50:32 +00:00
|
|
|
/**
|
2016-09-07 22:28:28 +00:00
|
|
|
* Config constructor.
|
2016-09-05 22:36:47 +00:00
|
|
|
*
|
2019-04-21 16:30:02 +00:00
|
|
|
* @param array $options Options
|
2015-10-31 14:50:32 +00:00
|
|
|
*/
|
2019-04-21 16:30:02 +00:00
|
|
|
private function __construct(array $options = [])
|
|
|
|
{
|
|
|
|
$this->applyOptions($options);
|
|
|
|
$this->getEnv();
|
2019-05-08 17:46:37 +00:00
|
|
|
|
|
|
|
if (empty($this->genericFormats)) {
|
|
|
|
// We don't put this in the class definition so it can be detected by xgettext.
|
|
|
|
$this->genericFormats = [
|
2019-05-08 17:55:18 +00:00
|
|
|
'best' => _('Best'),
|
2019-05-08 17:46:37 +00:00
|
|
|
'bestvideo+bestaudio' => _('Remux best video with best audio'),
|
2019-05-08 17:55:18 +00:00
|
|
|
'worst' => _('Worst'),
|
2019-05-08 17:46:37 +00:00
|
|
|
];
|
|
|
|
}
|
|
|
|
|
|
|
|
foreach ($this->genericFormats as $format => $name) {
|
|
|
|
if (strpos($format, '+') !== false) {
|
|
|
|
if (!$this->remux) {
|
|
|
|
// Disable combined formats if remux mode is not enabled.
|
|
|
|
unset($this->genericFormats[$format]);
|
|
|
|
}
|
|
|
|
} elseif (!$this->stream) {
|
|
|
|
// Force HTTP if stream is not enabled.
|
2019-10-03 19:24:12 +00:00
|
|
|
$this->replaceGenericFormat($format, $format . '[protocol=https]/' . $format . '[protocol=http]');
|
2019-05-08 17:46:37 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Replace a format key.
|
|
|
|
*
|
|
|
|
* @param string $oldFormat Old format
|
|
|
|
* @param string $newFormat New format
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
private function replaceGenericFormat($oldFormat, $newFormat)
|
|
|
|
{
|
|
|
|
$keys = array_keys($this->genericFormats);
|
|
|
|
$keys[array_search($oldFormat, $keys)] = $newFormat;
|
2019-06-17 21:19:18 +00:00
|
|
|
if ($genericFormats = array_combine($keys, $this->genericFormats)) {
|
|
|
|
$this->genericFormats = $genericFormats;
|
|
|
|
}
|
2019-04-21 16:30:02 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Throw an exception if some of the options are invalid.
|
|
|
|
*
|
|
|
|
* @throws Exception If youtube-dl is missing
|
|
|
|
* @throws Exception If Python is missing
|
2019-04-21 16:35:24 +00:00
|
|
|
*
|
|
|
|
* @return void
|
2019-04-21 16:30:02 +00:00
|
|
|
*/
|
|
|
|
private function validateOptions()
|
|
|
|
{
|
|
|
|
/*
|
|
|
|
We don't translate these exceptions because they usually occur before Slim can catch them
|
|
|
|
so they will go to the logs.
|
|
|
|
*/
|
|
|
|
if (!is_file($this->youtubedl)) {
|
2019-10-03 19:24:12 +00:00
|
|
|
throw new Exception("Can't find youtube-dl at " . $this->youtubedl);
|
2019-04-21 16:30:02 +00:00
|
|
|
} elseif (!Video::checkCommand([$this->python, '--version'])) {
|
2019-10-03 19:24:12 +00:00
|
|
|
throw new Exception("Can't find Python at " . $this->python);
|
2019-04-21 16:30:02 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Apply the provided options.
|
|
|
|
*
|
|
|
|
* @param array $options Options
|
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
private function applyOptions(array $options)
|
2015-10-31 14:50:32 +00:00
|
|
|
{
|
2019-03-30 17:21:45 +00:00
|
|
|
foreach ($options as $option => $value) {
|
|
|
|
if (isset($this->$option) && isset($value)) {
|
|
|
|
$this->$option = $value;
|
2015-10-31 14:42:25 +00:00
|
|
|
}
|
|
|
|
}
|
2018-01-06 17:03:06 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Override options from environement variables.
|
2019-11-10 17:05:53 +00:00
|
|
|
* Environment variables should use screaming snake case: CONVERT, PYTHON, AUDIO_BITRATE, etc.
|
|
|
|
* If the value is an array, you should use the YAML format: "CONVERT_ADVANCED_FORMATS='[foo, bar]'"
|
2018-01-06 17:03:06 +00:00
|
|
|
*
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
private function getEnv()
|
|
|
|
{
|
2019-11-10 17:05:53 +00:00
|
|
|
foreach (get_object_vars($this) as $prop => $value) {
|
|
|
|
$convert = new Convert($prop);
|
|
|
|
$env = getenv($convert->toSnake(true));
|
2018-01-06 17:03:06 +00:00
|
|
|
if ($env) {
|
2019-11-10 17:05:53 +00:00
|
|
|
$this->$prop = Yaml::parse($env);
|
2018-01-06 17:03:06 +00:00
|
|
|
}
|
2016-12-22 12:46:31 +00:00
|
|
|
}
|
2015-10-31 14:42:25 +00:00
|
|
|
}
|
|
|
|
|
2015-10-31 14:50:32 +00:00
|
|
|
/**
|
2019-04-21 16:30:02 +00:00
|
|
|
* Get Config singleton instance.
|
2016-09-05 22:36:47 +00:00
|
|
|
*
|
2015-10-31 14:50:32 +00:00
|
|
|
* @return Config
|
|
|
|
*/
|
2019-04-21 16:30:02 +00:00
|
|
|
public static function getInstance()
|
2015-10-31 14:50:32 +00:00
|
|
|
{
|
2019-04-21 16:30:02 +00:00
|
|
|
if (!isset(self::$instance)) {
|
|
|
|
self::$instance = new self();
|
2015-10-31 14:42:25 +00:00
|
|
|
}
|
2016-09-07 22:28:28 +00:00
|
|
|
|
2016-03-29 23:49:08 +00:00
|
|
|
return self::$instance;
|
2015-10-31 14:42:25 +00:00
|
|
|
}
|
2016-07-30 10:40:49 +00:00
|
|
|
|
2019-04-21 16:30:02 +00:00
|
|
|
/**
|
|
|
|
* Set options from a YAML file.
|
|
|
|
*
|
|
|
|
* @param string $file Path to the YAML file
|
|
|
|
*/
|
|
|
|
public static function setFile($file)
|
|
|
|
{
|
|
|
|
if (is_file($file)) {
|
|
|
|
$options = Yaml::parse(file_get_contents($file));
|
|
|
|
self::$instance = new self($options);
|
2019-04-28 13:52:01 +00:00
|
|
|
self::$instance->validateOptions();
|
2019-04-21 16:30:02 +00:00
|
|
|
} else {
|
2019-10-03 19:24:12 +00:00
|
|
|
throw new Exception("Can't find config file at " . $file);
|
2019-04-21 16:30:02 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Manually set some options.
|
|
|
|
*
|
2019-04-21 16:35:24 +00:00
|
|
|
* @param array $options Options (see `config/config.example.yml` for available options)
|
|
|
|
* @param bool $update True to update an existing instance
|
2019-04-21 16:30:02 +00:00
|
|
|
*/
|
|
|
|
public static function setOptions(array $options, $update = true)
|
|
|
|
{
|
|
|
|
if ($update) {
|
|
|
|
$config = self::getInstance();
|
|
|
|
$config->applyOptions($options);
|
|
|
|
$config->validateOptions();
|
|
|
|
} else {
|
|
|
|
self::$instance = new self($options);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-08-01 11:29:13 +00:00
|
|
|
/**
|
2016-09-07 22:28:28 +00:00
|
|
|
* Destroy singleton instance.
|
|
|
|
*
|
2016-08-01 11:29:13 +00:00
|
|
|
* @return void
|
|
|
|
*/
|
2016-07-30 10:40:49 +00:00
|
|
|
public static function destroyInstance()
|
|
|
|
{
|
|
|
|
self::$instance = null;
|
|
|
|
}
|
2015-10-31 14:42:25 +00:00
|
|
|
}
|