newznab-tmux/newznab/controllers/TraktTv.php

<?php

use newznab\db\Settings;
use newznab\utility\Utility;

/**
 * Class TraktTv
 * Lookup information from trakt.tv using their API.
 */
class TraktTv
{
	/**
	 * The Trakt.tv API v2 Client ID (SHA256 hash - 64 characters long string). Used for movie and tv lookups.
	 * Create one here: https://trakt.tv/oauth/applications/new
	 * @var array|bool|string
	 */
	private $clientID;

	/**
	 * List of headers to send to Trakt.tv when making a request.
	 * @see http://docs.trakt.apiary.io/#introduction/required-headers
	 * @var array
	 */
	private $requestHeaders;

	/**
	 * Construct. Set up API key.
	 *
	 * @param array $options Class instances.
	 *
	 * @access public
	 */
	public function __construct(array $options = [])
	{
		$defaults = [
			'Settings' => null,
		];
		$options += $defaults;

		$settings = ($options['Settings'] instanceof Settings ? $options['Settings'] : new Settings());
		$this->clientID = $settings->getSetting('trakttvclientkey');
		$this->requestHeaders = [
			'Content-Type: application/json',
			'trakt-api-version: 2',
			'trakt-api-key: ' . $this->clientID
		];
	}

	/**
	 * Fetches summary from trakt.tv for the TV show using the title/season/episode.
	 *
	 * @param string $title
	 * @param string $season
	 * @param string $ep
	 *
	 * @see http://docs.trakt.apiary.io/#reference/episodes/summary/get-a-single-episode-for-a-show
	 *
	 * @return bool|array
	 *
	 * @access public
	 */
	public function episodeSummary($title = '', $season = '', $ep = '')
	{
		$array = $this->getJsonArray(
			'https://api-v2launch.trakt.tv/shows/' .
			str_replace([' ', '_', '.'], '-', $title) .
			'/seasons/' .
			str_replace(['S', 's'], '', $season) .
			'/episodes/' .
			str_replace(['E', 'e'], '', $ep),
			'full'
		);
		if (!$array) {
			return false;
		}
		return $array;
	}

	/**
	 * Fetches summary from trakt.tv for the movie.
	 * Accept a title (the-big-lebowski-1998), a IMDB id, or a TMDB id.
	 *
	 * @param string $movie Title or IMDB id.
	 * @param string $type  imdbID:     Return only the IMDB ID (returns string)
	 *                      full:       Return all extended properties (minus images). (returns array)
	 *                      images:     Return extended images properties (returns array)
	 *
	 * @see http://docs.trakt.apiary.io/#reference/movies/summary/get-a-movie
	 *
	 * @return bool|array|string
	 *
	 * @access public
	 */
	public function movieSummary($movie = '', $type = 'imdbID')
	{
		switch($type) {
			case 'full':
			case 'images':
			case 'full,images':
				$extended = $type;
				break;
			case 'imdbID':
			default:
				$extended = 'min';
		}
		$array = $this->getJsonArray(
			'https://api-v2launch.trakt.tv/movies/' . str_replace([' ', '_', '.'], '-', str_replace(['(', ')'], '', $movie)),
			$extended
		);
		if (!$array) {
			return false;
		} else if ($type === 'imdbID' && isset($array['ids']['imdb'])) {
			return $array['ids']['imdb'];
		}
		return $array;
	}

	/**
	 * Download JSON from Trakt, convert to array.
	 *
	 * @param string $URI URI to download.
	 * @param string $extended Extended info from trakt tv.
	 *                         Valid values:
	 *                         'min'         Returns enough info to match locally. (Default)
	 *                         'images'      Minimal info and all images.
	 *                         'full'        Complete info for an item.
	 *                         'full,images' Complete info and all images.
	 *
	 * @return bool|mixed
	 */
	private function getJsonArray($URI, $extended = 'min')
	{
		if (!empty($this->clientID)) {
			$json = Utility::getUrl([
					'url'            => $URI . "?extended=$extended",
					'requestheaders' => $this->requestHeaders
				]
			);
			if ($json !== false) {
				$json = json_decode($json, true);
				if (!is_array($json) || (isset($json['status']) && $json['status'] === 'failure')) {
					return false;
				}
				return $json;
			}
		}
		return false;
	}
}