jimlind/tivo-php

<?php

namespace JimLind\TiVo;

use Exception;
use GuzzleHttp\ClientInterface;
use GuzzleHttp\Cookie\CookieJar;
use GuzzleHttp\Exception\RequestException;
use JimLind\TiVo\Characteristic\LoggingTrait;

/**
 * Service for downloading video files from TiVo
 */
class VideoDownloader
{
    use LoggingTrait;

    /**
     * @var string
     */
    protected $mak;

    /**
     * @var ClientInterface
     */
    protected $guzzle;

    /**
     * @param string          $mak    TiVo's Media Access Key
     * @param ClientInterface $guzzle Guzzle Client
     */
    public function __construct($mak, ClientInterface $guzzle)
    {
        $this->mak    = $mak;
        $this->guzzle = $guzzle;

        $this->setNullLogger();
    }

    /**
     * Download a video file from a TiVo or log failure
     *
     * @param string $url      Where the remote file is
     * @param string $filePath Where the downloaded file goes
     */
    public function download($url, $filePath)
    {
        try {
            $this->downloadWithTimeout($url, $filePath);
        } catch (Exception $exception) {
            // Something went wrong with Guzzle
            $this->logger->warning('Unable to download a video file');
            $this->logger->warning('Message: `'.$exception->getMessage().'`');
        }
    }

    /**
     * Download a preview of a video file from a TiVo
     *
     * The download action is halted with a timeout
     * Timeout is logged as `info` and an actual error is logged as `warning`
     *
     * @param string $url      Where the remote file is
     * @param string $filePath Where the downloaded file goes
     */
    public function downloadPreview($url, $filePath)
    {
        try {
            $this->downloadWithTimeout($url, $filePath, 120);
        } catch (RequestException $requestException) {
            // Connection timed out as expected
            $this->logger->info('Intentional timeout caught');
            $this->logger->info('Message: `'.$requestException->getMessage().'`');
        } catch (Exception $exception) {
            // Something went wrong with Guzzle
            $this->logger->warning('Unable to download a video file preview');
            $this->logger->warning('Message: `'.$exception->getMessage().'`');
        }
    }

    /**
     * Download the remote file to the local system
     *
     * To get a file from TiVo via HTTP you must first touch the HTTPS interface
     * to authenticate before the actual download can start
     *
     * @param string  $url      Where the remote file is
     * @param string  $filePath Where the downloaded file goes
     * @param integer $timeout  Timeout download (Default 0, never)
     */
    protected function downloadWithTimeout($url, $filePath, $timeout = 0)
    {
        $cookieJar     = $this->touchSecureServer($url);
        $authorization = ['tivo', $this->mak, 'digest'];

        $options = [
            'auth'    => $authorization,
            'verify'  => false,
            'cookies' => $cookieJar,
            'save_to' => $filePath,
            'timeout' => $timeout,
        ];

        $this->guzzle->request(
            'GET',
            $this->escapeURL($url),
            $options
        );
    }

    /**
     * Escape the URL for downloading
     *
     * TiVo and Guzzle have differing opinions on how the exclamation point should be handled
     *
     * @param string $url Where the remote file is
     *
     * @return string
     */
    protected function escapeURL($url)
    {
        return str_replace('!', '\!', $url);
    }

    /**
     * Touch TiVo via HTTPS to start Cookie storage
     *
     * @param string $url Where the remote file is
     *
     * @return CookieJar
     */
    protected function touchSecureServer($url)
    {
        $cookieJar     = new CookieJar();
        $authorization = ['tivo', $this->mak, 'digest'];

        $httpsURL = 'https://'.$this->parseIpFromFileURL($url);
        $options  = [
            'auth'    => $authorization,
            'verify'  => false,
            'cookies' => $cookieJar,
        ];

        try {
            $this->guzzle->request('GET', $httpsURL, $options);
        } catch (Exception $exception) {
            // Something went wrong with Guzzle
            $this->logger->warning('Unable to access your TiVo via HTTPS');
            $this->logger->warning('Message: `'.$exception->getMessage().'`');
        }

        return $cookieJar;
    }

    /**
     * Parse the IP address from the file URL provided by TiVo
     *
     * @param string $url Where the remote file is
     *
     * @return string
     */
    protected function parseIpFromFileURL($url)
    {
        $matches = [];
        $pattern = '/http:..(\d+\.\d+\.\d+\.\d+):80/';
        preg_match($pattern, $url, $matches);

        if (empty($matches) || count($matches) < 2) {
            // Failure: Log and exit early
            $this->logger->warning('Unable to parse IP');
            $this->logger->warning('Input: `'.$url.'`');

            return '';
        }

        return $matches[1];
    }
}