PrivateCoffee/alltube
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Applied fixes from StyleCI

Browse source
This commit is contained in:
Pierre Rudloff 2016-09-07 22:28:28 +00:00 committed by StyleCI Bot
parent 6df1eccb9e
commit 13c3366e9d
6 changed files with 203 additions and 178 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
classes/Config.php
View file

@ -1,78 +1,88 @@
<?php
/**
* Config class
* Config class.
*/
namespace Alltube;
use Symfony\Component\Yaml\Yaml;
/**
* Manage config parameters
* Manage config parameters.
*/
class Config
{
/**
* Singleton instance
* Singleton instance.
*
* @var Config
*/
private static $instance;
/**
* youtube-dl binary path
* youtube-dl binary path.
*
* @var string
*/
public $youtubedl = 'vendor/rg3/youtube-dl/youtube_dl/__main__.py';
/**
* python binary path
* python binary path.
*
* @var string
*/
public $python = '/usr/bin/python';
/**
* youtube-dl parameters
* youtube-dl parameters.
*
* @var array
*/
public $params = array('--no-playlist', '--no-warnings', '-f best[protocol^=http]', '--playlist-end', 1);
public $params = ['--no-playlist', '--no-warnings', '-f best[protocol^=http]', '--playlist-end', 1];
/**
* Enable audio conversion
* Enable audio conversion.
*
* @var bool
*/
public $convert = false;
/**
* avconv or ffmpeg binary path
* avconv or ffmpeg binary path.
*
* @var string
*/
public $avconv = 'vendor/bin/ffmpeg';
/**
* rtmpdump binary path
* rtmpdump binary path.
*
* @var string
*/
public $rtmpdump = 'vendor/bin/rtmpdump';
/**
* curl binary path
* curl binary path.
*
* @var string
*/
public $curl = '/usr/bin/curl';
/**
* curl parameters
* curl parameters.
*
* @var array
*/
public $curl_params = array();
public $curl_params = [];
/**
* YAML config file path
* YAML config file path.
*
* @var string
*/
private $file;
/**
* Config constructor
* Config constructor.
*
* @param string $yamlfile YAML config file path
*/
@ -95,7 +105,7 @@ class Config
}
/**
* Get singleton instance
* Get singleton instance.
*
* @param string $yamlfile YAML config file name
*
@ -105,13 +115,15 @@ class Config
{
$yamlfile = __DIR__.'/../'.$yamlfile;
if (is_null(self::$instance) || self::$instance->file != $yamlfile) {
self::$instance = new Config($yamlfile);
self::$instance = new self($yamlfile);
}
return self::$instance;
}
/**
* Destroy singleton instance
* Destroy singleton instance.
*
* @return void
*/
public static function destroyInstance()

68
classes/VideoDownload.php
View file

@ -1,21 +1,19 @@
<?php
/**
* VideoDownload class
* VideoDownload class.
*/
namespace Alltube;
use Symfony\Component\Process\Process;
use Symfony\Component\Process\ProcessBuilder;
use Chain\Chain;
use Symfony\Component\Process\ProcessBuilder;
/**
* Extract info about videos
* Extract info about videos.
*/
class VideoDownload
{
/**
* VideoDownload constructor
* VideoDownload constructor.
*/
public function __construct()
{
@ -23,31 +21,32 @@ class VideoDownload
$this->procBuilder = new ProcessBuilder();
$this->procBuilder->setPrefix(
array_merge(
array($this->config->python, $this->config->youtubedl),
[$this->config->python, $this->config->youtubedl],
$this->config->params
)
);
}
/**
* List all extractors
* List all extractors.
*
* @return string[] Extractors
* */
public function listExtractors()
{
$this->procBuilder->setArguments(
array(
'--list-extractors'
)
[
'--list-extractors',
]
);
$process = $this->procBuilder->getProcess();
$process->run();
return explode(PHP_EOL, trim($process->getOutput()));
}
/**
* Get all information about a video
* Get all information about a video.
*
* @param string $url URL of page
* @param string $format Format to use for the video
@ -57,10 +56,10 @@ class VideoDownload
public function getJSON($url, $format = null)
{
$this->procBuilder->setArguments(
array(
[
'--dump-json',
$url
)
$url,
]
);
if (isset($format)) {
$this->procBuilder->add('-f '.$format);
@ -75,7 +74,7 @@ class VideoDownload
}
/**
* Get URL of video from URL of page
* Get URL of video from URL of page.
*
* @param string $url URL of page
* @param string $format Format to use for the video
@ -85,10 +84,10 @@ class VideoDownload
public function getURL($url, $format = null)
{
$this->procBuilder->setArguments(
array(
[
'--get-url',
$url
)
$url,
]
);
if (isset($format)) {
$this->procBuilder->add('-f '.$format);
@ -103,7 +102,7 @@ class VideoDownload
}
/**
* Get filename of video file from URL of page
* Get filename of video file from URL of page.
*
* @param string $url URL of page
* @param string $format Format to use for the video
@ -113,10 +112,10 @@ class VideoDownload
public function getFilename($url, $format = null)
{
$this->procBuilder->setArguments(
array(
[
'--get-filename',
$url
)
$url,
]
);
if (isset($format)) {
$this->procBuilder->add('-f '.$format);
@ -131,7 +130,7 @@ class VideoDownload
}
/**
* Get filename of audio from URL of page
* Get filename of audio from URL of page.
*
* @param string $url URL of page
* @param string $format Format to use for the video
@ -151,7 +150,7 @@ class VideoDownload
}
/**
* Get audio stream of converted video
* Get audio stream of converted video.
*
* @param string $url URL of page
* @param string $format Format to use for the video
@ -172,14 +171,14 @@ class VideoDownload
$video->http_headers->{'User-Agent'}
);
$avconvProc = ProcessBuilder::create(
array(
[
$this->config->avconv,
'-v', 'quiet',
'-i', '-',
'-f', 'mp3',
'-vn',
'pipe:1'
)
'pipe:1',
]
);
if (parse_url($video->url, PHP_URL_SCHEME) == 'rtmp') {
@ -187,13 +186,13 @@ class VideoDownload
throw(new \Exception('Can\'t find rtmpdump'));
}
$builder = new ProcessBuilder(
array(
[
$this->config->rtmpdump,
'-q',
'-r',
$video->url,
'--pageUrl', $video->webpage_url
)
'--pageUrl', $video->webpage_url,
]
);
if (isset($video->player_url)) {
$builder->add('--swfVfy');
@ -226,19 +225,20 @@ class VideoDownload
$chain = new Chain(
ProcessBuilder::create(
array_merge(
array(
[
$this->config->curl,
'--silent',
'--location',
'--user-agent', $video->http_headers->{'User-Agent'},
$video->url
),
$video->url,
],
$this->config->curl_params
)
)
);
$chain->add('|', $avconvProc);
}
return popen($chain->getProcess()->getCommandLine(), 'r');
}
}

113
controllers/FrontController.php
View file

@ -1,41 +1,45 @@
<?php
/**
* FrontController class
* FrontController class.
*/
namespace Alltube\Controller;
use Alltube\VideoDownload;
use Alltube\Config;
use Slim\Http\Stream;
use Alltube\VideoDownload;
use Slim\Container;
use Slim\Http\Request;
use Slim\Http\Response;
use Slim\Container;
use Slim\Http\Stream;
/**
* Main controller
* Main controller.
*/
class FrontController
{
/**
* Config instance
* Config instance.
*
* @var Config
*/
private $config;
/**
* VideoDownload instance
* VideoDownload instance.
*
* @var VideoDownload
*/
private $download;
/**
* Slim dependency container
* Slim dependency container.
*
* @var Container
*/
private $container;
/**
* FrontController constructor
* FrontController constructor.
*
* @param Container $container Slim dependency container
*/
public function __construct(Container $container)
@ -46,7 +50,7 @@ class FrontController
}
/**
* Display index page
* Display index page.
*
* @param Request $request PSR-7 request
* @param Response $response PSR-7 response
@ -58,16 +62,16 @@ class FrontController
$this->container->view->render(
$response,
'index.tpl',
array(
'convert'=>$this->config->convert,
'class'=>'index',
'description'=>'Easily download videos from Youtube, Dailymotion, Vimeo and other websites.'
)
[
'convert' => $this->config->convert,
'class' => 'index',
'description' => 'Easily download videos from Youtube, Dailymotion, Vimeo and other websites.',
]
);
}
/**
* Display a list of extractors
* Display a list of extractors.
*
* @param Request $request PSR-7 request
* @param Response $response PSR-7 response
@ -79,18 +83,17 @@ class FrontController
$this->container->view->render(
$response,
'extractors.tpl',
array(
'extractors'=>$this->download->listExtractors(),
'class'=>'extractors',
'title'=>'Supported websites',
'description'
=>'List of all supported websites from which Alltube Download can extract video or audio files'
)
[
'extractors' => $this->download->listExtractors(),
'class' => 'extractors',
'title' => 'Supported websites',
'description' => 'List of all supported websites from which Alltube Download can extract video or audio files',
]
);
}
/**
* Dislay information about the video
* Dislay information about the video.
*
* @param Request $request PSR-7 request
* @param Response $response PSR-7 response
@ -101,36 +104,38 @@ class FrontController
{
$params = $request->getQueryParams();
$this->config = Config::getInstance();
if (isset($params["url"])) {
if (isset($params['url'])) {
if (isset($params['audio'])) {
try {
$url = $this->download->getURL($params["url"], 'mp3[protocol^=http]');
$url = $this->download->getURL($params['url'], 'mp3[protocol^=http]');
return $response->withRedirect($url);
} catch (\Exception $e) {
$response = $response->withHeader(
'Content-Disposition',
'attachment; filename="'.
$this->download->getAudioFilename($params["url"], 'bestaudio/best').'"'
$this->download->getAudioFilename($params['url'], 'bestaudio/best').'"'
);
$response = $response->withHeader('Content-Type', 'audio/mpeg');
if ($request->isGet()) {
$process = $this->download->getAudioStream($params["url"], 'bestaudio/best');
$process = $this->download->getAudioStream($params['url'], 'bestaudio/best');
$response = $response->withBody(new Stream($process));
}
return $response;
}
} else {
$video = $this->download->getJSON($params["url"]);
$video = $this->download->getJSON($params['url']);
$this->container->view->render(
$response,
'video.tpl',
array(
'video'=>$video,
'class'=>'video',
'title'=>$video->title,
'description'=>'Download "'.$video->title.'" from '.$video->extractor_key
)
[
'video' => $video,
'class' => 'video',
'title' => $video->title,
'description' => 'Download "'.$video->title.'" from '.$video->extractor_key,
]
);
}
} else {
@ -139,10 +144,12 @@ class FrontController
}
/**
* Display an error page
* @param Request $request PSR-7 request
* @param Response $response PSR-7 response
* @param \Exception $exception Error to display
* Display an error page.
*
* @param Request $request PSR-7 request
* @param Response $response PSR-7 response
* @param \Exception $exception Error to display
*
* @return Response HTTP response
*/
public function error(Request $request, Response $response, \Exception $exception)
@ -150,17 +157,18 @@ class FrontController
$this->container->view->render(
$response,
'error.tpl',
array(
'errors'=>$exception->getMessage(),
'class'=>'video',
'title'=>'Error'
)
[
'errors' => $exception->getMessage(),
'class' => 'video',
'title' => 'Error',
]
);
return $response->withStatus(500);
}
/**
* Redirect to video file
* Redirect to video file.
*
* @param Request $request PSR-7 request
* @param Response $response PSR-7 response
@ -170,19 +178,21 @@ class FrontController
public function redirect(Request $request, Response $response)
{
$params = $request->getQueryParams();
if (isset($params["url"])) {
if (isset($params['url'])) {
try {
$url = $this->download->getURL($params["url"], $params["format"]);
$url = $this->download->getURL($params['url'], $params['format']);
return $response->withRedirect($url);
} catch (\Exception $e) {
$response->getBody()->write($e->getMessage());
return $response->withHeader('Content-Type', 'text/plain');
}
}
}
/**
* Output JSON info about the video
* Output JSON info about the video.
*
* @param Request $request PSR-7 request
* @param Response $response PSR-7 response
@ -192,13 +202,14 @@ class FrontController
public function json(Request $request, Response $response)
{
$params = $request->getQueryParams();
if (isset($params["url"])) {
if (isset($params['url'])) {
try {
$video = $this->download->getJSON($params["url"]);
$video = $this->download->getJSON($params['url']);
return $response->withJson($video);
} catch (\Exception $e) {
return $response->withJson(
array('success'=>false, 'error'=>$e->getMessage())
['success' => false, 'error' => $e->getMessage()]
);
}
}

14
index.php
View file

@ -1,6 +1,6 @@
<?php
require_once __DIR__.'/vendor/autoload.php';
use Alltube\VideoDownload;
use Alltube\Controller\FrontController;
if (strpos($_SERVER['REQUEST_URI'], '/index.php') !== false) {
@ -22,26 +22,26 @@ $container['view'] = function ($c) {
$controller = new FrontController($container);
$container['errorHandler'] = array($controller, 'error');
$container['errorHandler'] = [$controller, 'error'];
$app->get(
'/',
array($controller, 'index')
[$controller, 'index']
)->setName('index');
$app->get(
'/extractors',
array($controller, 'extractors')
[$controller, 'extractors']
)->setName('extractors');
$app->get(
'/video',
array($controller, 'video')
[$controller, 'video']
)->setName('video');
$app->get(
'/redirect',
array($controller, 'redirect')
[$controller, 'redirect']
)->setName('redirect');
$app->get(
'/json',
array($controller, 'json')
[$controller, 'json']
);
$app->run();

15
tests/ConfigTest.php
View file

@ -1,25 +1,25 @@
<?php
/**
* ConfigTest class
* ConfigTest class.
*/
namespace Alltube\Test;
use Alltube\Config;
/**
* Unit tests for the Config class
* Unit tests for the Config class.
*/
class ConfigTest extends \PHPUnit_Framework_TestCase
{
/**
* Config class instance
* Config class instance.
*
* @var Config
*/
private $config;
/**
* Prepare tests
* Prepare tests.
*/
protected function setUp()
{
@ -27,7 +27,7 @@ class ConfigTest extends \PHPUnit_Framework_TestCase
}
/**
* Test the getInstance function
* Test the getInstance function.
*
* @return void
*/
@ -43,7 +43,8 @@ class ConfigTest extends \PHPUnit_Framework_TestCase
}
/**
* Test the getInstance function with the CONVERT environment variable
* Test the getInstance function with the CONVERT environment variable.
*
* @return void
*/
public function testGetInstanceWithEnv()

123
tests/VideoDownloadTest.php
View file

@ -1,24 +1,25 @@
<?php
/**
* VideoDownloadTest class
* VideoDownloadTest class.
*/
namespace Alltube\Test;
use Alltube\VideoDownload;
/**
* Unit tests for the VideoDownload class
* Unit tests for the VideoDownload class.
*/
class VideoDownloadTest extends \PHPUnit_Framework_TestCase
{
/**
* VideoDownload instance
* VideoDownload instance.
*
* @var VideoDownload
*/
private $download;
/**
* Initialize properties used by test
* Initialize properties used by test.
*/
protected function setUp()
{
@ -26,7 +27,7 @@ class VideoDownloadTest extends \PHPUnit_Framework_TestCase
}
/**
* Destroy properties after test
* Destroy properties after test.
*/
protected function tearDown()
{
@ -34,7 +35,7 @@ class VideoDownloadTest extends \PHPUnit_Framework_TestCase
}
/**
* Test listExtractors function
* Test listExtractors function.
*
* @return void
*/
@ -45,14 +46,14 @@ class VideoDownloadTest extends \PHPUnit_Framework_TestCase
}
/**
* Test getURL function
* Test getURL function.
*
* @param string $url URL
* @param string $format Format
* @param string $url URL
* @param string $format Format
* @param string $filename Filename
* @param string $domain Domain
* @param string $domain Domain
*
* @return void
* @return void
* @dataProvider urlProvider
*/
public function testGetURL($url, $format, $filename, $domain)
@ -62,11 +63,11 @@ class VideoDownloadTest extends \PHPUnit_Framework_TestCase
}
/**
* Test getURL function errors
* Test getURL function errors.
*
* @param string $url URL
*
* @return void
* @return void
* @expectedException Exception
* @dataProvider ErrorUrlProvider
*/
@ -76,67 +77,67 @@ class VideoDownloadTest extends \PHPUnit_Framework_TestCase
}
/**
* Provides URLs for tests
* Provides URLs for tests.
*
* @return array[]
*/
public function urlProvider()
{
return array(
array(
return [
[
'https://www.youtube.com/watch?v=M7IpKCZ47pU', null,
"It's Not Me, It's You - Hearts Under Fire-M7IpKCZ47pU.mp4",
'googlevideo.com',
"It's Not Me, It's You - Hearts Under Fire-M7IpKCZ47pU.mp3"
),
array(
"It's Not Me, It's You - Hearts Under Fire-M7IpKCZ47pU.mp3",
],
[
'https://www.youtube.com/watch?v=RJJ6FCAXvKg', 22,
"'Heart Attack' - Demi Lovato ".
"(Sam Tsui & Against The Current)-RJJ6FCAXvKg.mp4",
'(Sam Tsui & Against The Current)-RJJ6FCAXvKg.mp4',
'googlevideo.com',
"'Heart Attack' - Demi Lovato ".
"(Sam Tsui & Against The Current)-RJJ6FCAXvKg.mp3"
),
array(
'(Sam Tsui & Against The Current)-RJJ6FCAXvKg.mp3',
],
[
'https://vimeo.com/24195442', null,
"Carving the Mountains-24195442.mp4",
'Carving the Mountains-24195442.mp4',
'vimeocdn.com',
"Carving the Mountains-24195442.mp3"
),
array(
'Carving the Mountains-24195442.mp3',
],
[
'http://www.bbc.co.uk/programmes/b039g8p7', 'bestaudio/best',
"Leonard Cohen, Kaleidoscope - BBC Radio 4-b039d07m.flv",
'Leonard Cohen, Kaleidoscope - BBC Radio 4-b039d07m.flv',
'bbcodspdns.fcod.llnwd.net',
"Leonard Cohen, Kaleidoscope - BBC Radio 4-b039d07m.mp3"
),
array(
'Leonard Cohen, Kaleidoscope - BBC Radio 4-b039d07m.mp3',
],
[
'http://www.rtl2.de/sendung/grip-das-motormagazin/folge/folge-203-0', 'bestaudio/best',
"GRIP sucht den Sommerkönig-folge-203-0.f4v",
'GRIP sucht den Sommerkönig-folge-203-0.f4v',
'edgefcs.net',
"GRIP sucht den Sommerkönig-folge-203-0.mp3"
)
);
'GRIP sucht den Sommerkönig-folge-203-0.mp3',
],
];
}
/**
* Provides incorrect URLs for tests
* Provides incorrect URLs for tests.
*
* @return array[]
*/
public function errorUrlProvider()
{
return array(
array('http://example.com/video')
);
return [
['http://example.com/video'],
];
}
/**
* Test getJSON function
* Test getJSON function.
*
* @param string $url URL
* @param string $format Format
*
* @return void
* @return void
* @dataProvider URLProvider
*/
public function testGetJSON($url, $format)
@ -151,11 +152,11 @@ class VideoDownloadTest extends \PHPUnit_Framework_TestCase
}
/**
* Test getJSON function errors
* Test getJSON function errors.
*
* @param string $url URL
*
* @return void
* @return void
* @expectedException Exception
* @dataProvider ErrorURLProvider
*/
@ -165,13 +166,13 @@ class VideoDownloadTest extends \PHPUnit_Framework_TestCase
}
/**
* Test getFilename function
* Test getFilename function.
*
* @param string $url URL
* @param string $format Format
* @param string $url URL
* @param string $format Format
* @param string $filename Filename
*
* @return void
* @return void
* @dataProvider urlProvider
*/
public function testGetFilename($url, $format, $filename)
@ -181,11 +182,11 @@ class VideoDownloadTest extends \PHPUnit_Framework_TestCase
}
/**
* Test getFilename function errors
* Test getFilename function errors.
*
* @param string $url URL
*
* @return void
* @return void
* @expectedException Exception
* @dataProvider ErrorUrlProvider
*/
@ -195,15 +196,15 @@ class VideoDownloadTest extends \PHPUnit_Framework_TestCase
}
/**
* Test getAudioFilename function
* Test getAudioFilename function.
*
* @param string $url URL
* @param string $format Format
* @param string $filename Filename
* @param string $domain Domain
* @param string $url URL
* @param string $format Format
* @param string $filename Filename
* @param string $domain Domain
* @param string $audioFilename MP3 audio file name
*
* @return void
* @return void
* @dataProvider urlProvider
*/
public function testGetAudioFilename($url, $format, $filename, $domain, $audioFilename)
@ -213,12 +214,12 @@ class VideoDownloadTest extends \PHPUnit_Framework_TestCase
}
/**
* Test getAudioStream function
* Test getAudioStream function.
*
* @param string $url URL
* @param string $format Format
*
* @return void
* @return void
* @dataProvider urlProvider
*/
public function testGetAudioStream($url, $format)
@ -229,12 +230,12 @@ class VideoDownloadTest extends \PHPUnit_Framework_TestCase
}
/**
* Test getAudioStream function without avconv
* Test getAudioStream function without avconv.
*
* @param string $url URL
* @param string $format Format
*
* @return void
* @return void
* @expectedException Exception
* @dataProvider urlProvider
*/
@ -246,12 +247,12 @@ class VideoDownloadTest extends \PHPUnit_Framework_TestCase
}
/**
* Test getAudioStream function without curl or rtmpdump
* Test getAudioStream function without curl or rtmpdump.
*
* @param string $url URL
* @param string $format Format
*
* @return void
* @return void
* @expectedException Exception
* @dataProvider urlProvider
*/