Update API/RSS related classes

Changelog

@@ -1,4 +1,5 @@
 2017-08-11 DariusIII
+	* Chg: Update API/RSS related classes
 	* Chg: Revert inserting apikey into old behavior
 	* Chg: Change the length of rsstoken (api key)
 	* Chg: Remove duplicate zipfile.php

nntmux/http/API.php

@@ -32,11 +32,6 @@ use nntmux\Groups;
  */
 class API extends Capabilities {
 
-	/** DB class
-	 * @var \nntmux\db\Settings
-	 */
-	public $pdo;
-
 	/**
 	 * @var array $_GET The get request from the web server
 	 */
@@ -54,7 +49,6 @@ class API extends Capabilities {
 		];
 		$options += $defaults;
 
-		$this->pdo = ($options['Settings'] instanceof DB ? $options['Settings'] : new DB());
 		$this->getRequest = $options['Request'];
 	}
 
@@ -85,11 +79,11 @@ class API extends Capabilities {
 	 *
 	 * @return int $maxAge The maximum age of the release
 	 */
-	public function maxAge()
+	public function maxAge(): int
 	{
 		$maxAge = -1;
 		if (isset($this->getRequest['maxage'])) {
-			if ($this->getRequest['maxage'] == '') {
+			if ($this->getRequest['maxage'] === '') {
 				Utility::showApiError(201, 'Incorrect parameter (maxage must not be empty)');
 			} elseif (!is_numeric($this->getRequest['maxage'])) {
 				Utility::showApiError(201, 'Incorrect parameter (maxage must be numeric)');
@@ -104,14 +98,14 @@ class API extends Capabilities {
 	 * Verify cat parameter.
 	 * @return array
 	 */
-	public function categoryID()
+	public function categoryID(): array
 	{
 		$categoryID[] = -1;
 		if (isset($this->getRequest['cat'])) {
 			$categoryIDs = urldecode($this->getRequest['cat']);
 			// Append Web-DL category ID if HD present for SickBeard / Sonarr compatibility.
-			if (strpos($categoryIDs, (string)Category::TV_HD) !== false &&
-				strpos($categoryIDs, (string)Category::TV_WEBDL) === false) {
+			if (strpos($categoryIDs, Category::TV_HD) !== false &&
+				strpos($categoryIDs, Category::TV_WEBDL) === false) {
 				$categoryIDs .= (',' . Category::TV_WEBDL);
 			}
 			$categoryID = explode(',', $categoryIDs);
@@ -139,7 +133,7 @@ class API extends Capabilities {
 	 * Verify limit parameter.
 	 * @return int
 	 */
-	public function limit()
+	public function limit(): int
 	{
 		$limit = 100;
 		if (isset($this->getRequest['limit']) && is_numeric($this->getRequest['limit']) && $this->getRequest['limit'] < 100) {
@@ -152,7 +146,7 @@ class API extends Capabilities {
 	 * Verify offset parameter.
 	 * @return int
 	 */
-	public function offset()
+	public function offset(): int
 	{
 		$offset = 0;
 		if (isset($this->getRequest['offset']) && is_numeric($this->getRequest['offset'])) {
@@ -167,7 +161,7 @@ class API extends Capabilities {
 	 */
 	public function verifyEmptyParameter($parameter)
 	{
-		if (isset($this->getRequest[$parameter]) && $this->getRequest[$parameter] == '') {
+		if (isset($this->getRequest[$parameter]) && $this->getRequest[$parameter] === '') {
 			Utility::showApiError(201, 'Incorrect parameter (' . $parameter . ' must not be empty)');
 		}
 	}

nntmux/http/Capabilities.php

@@ -34,7 +34,7 @@ use nntmux\utility\Utility;
 abstract class Capabilities
 {
 	/**
-	 * @var Settings
+	 * @var DB
 	 */
 	public $pdo;
 
@@ -66,8 +66,10 @@ abstract class Capabilities
 	 * @param bool   $xml    True: Print as XML False: Print as JSON.
 	 * @param int    $offset How much releases to skip
 	 * @param string $type   What type of API query to format if XML
+	 *
+	 * @throws \Exception
 	 */
-	public function output($data, $params, $xml = true, $offset, $type = '')
+	public function output($data, $params, $xml = true, $offset, $type = ''): void
 	{
 		$this->type = $type;
 
@@ -115,23 +117,24 @@ abstract class Capabilities
 	 * Collect and return various capability information for usage in API
 	 *
 	 * @return array
+	 * @throws \Exception
 	 */
-	public function getForMenu()
+	public function getForMenu(): array
 	{
 		$serverroot = '';
-		$https = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on' ? true : false);
+		$https = (isset($_SERVER['HTTPS']) && (int)$_SERVER['HTTPS'] === 'on');
 
 		if (isset($_SERVER['SERVER_NAME'])) {
 			$serverroot = (
 				($https === true ? 'https://' : 'http://') . $_SERVER['SERVER_NAME'] .
-				(($_SERVER['SERVER_PORT'] != '80' && $_SERVER['SERVER_PORT'] != '443') ? ':' . $_SERVER['SERVER_PORT'] : '') .
+				(($_SERVER['SERVER_PORT'] !== '80' && $_SERVER['SERVER_PORT'] !== '443') ? ':' . $_SERVER['SERVER_PORT'] : '') .
 				WWW_TOP . '/'
 			);
 		}
 
 		return [
 			'server' => [
-				'appversion' => (new Versions())->getGitTagInRepo(),
+				'appversion' => (new Versions())->getGitTagInFile(),
 				'version'    => '0.1',
 				'title'      => Settings::value('site.main.title'),
 				'strapline'  => Settings::value('site.main.strapline'),
@@ -146,7 +149,7 @@ abstract class Capabilities
 			],
 			'registration' => [
 				'available' => 'yes',
-				'open'      => Settings::value('..registerstatus') == 0 ? 'yes' : 'no'
+				'open'      => (int)Settings::value('..registerstatus') === 0 ? 'yes' : 'no'
 			],
 			'searching' => [
 				'search'       => ['available' => 'yes', 'supportedParams' => 'q'],
@@ -155,10 +158,9 @@ abstract class Capabilities
 				'audio-search' => ['available' => 'no',  'supportedParams' => '']
 			],
 			'categories' =>
-				($this->type === 'caps'
+				$this->type === 'caps'
 					? (new Category(['Settings' => $this->pdo]))->getForMenu()
 					: null
-				)
 		];
 	}
 }

nntmux/http/RSS.php

@@ -26,6 +26,8 @@ Class RSS extends Capabilities
 
 	/**
 	 * @param array $options
+	 *
+	 * @throws \Exception
 	 */
 	public function __construct(array $options = [])
 	{
@@ -37,9 +39,7 @@ Class RSS extends Capabilities
 		$options += $defaults;
 
 		$this->pdo = ($options['Settings'] instanceof DB ? $options['Settings'] : new DB());
-		$this->releases = (
-			$options['Releases'] instanceof Releases ? $options['Releases'] : new Releases(['Settings' => $this->pdo])
-		);
+		$this->releases = ($options['Releases'] instanceof Releases ? $options['Releases'] : new Releases(['Settings' => $this->pdo]));
 	}
 
 	/**
@@ -54,19 +54,19 @@ Class RSS extends Capabilities
 	 *
 	 * @return array
 	 */
-	public function getRss($cat, $offset, $videosId, $aniDbID, $userID = 0, $airDate = -1)
+	public function getRss($cat, $offset, $videosId, $aniDbID, $userID = 0, $airDate = -1): array
 	{
 		$catSearch = $cartSearch = '';
 
-		$catLimit = "AND r.categories_id BETWEEN " . Category::TV_ROOT . " AND " . Category::TV_OTHER;
+		$catLimit = 'AND r.categories_id BETWEEN ' . Category::TV_ROOT . ' AND ' . Category::TV_OTHER;
 
 		if (count($cat)) {
-			if ($cat[0] == -2) {
+			if ((int)$cat[0] === -2) {
 				$cartSearch = sprintf(
 					'INNER JOIN users_releases ON users_releases.users_id = %d AND users_releases.releases_id = r.id',
 					$userID
 				);
-			} else if ($cat[0] != -1) {
+			} else if ((int)$cat[0] !== -1) {
 				$catSearch = (new Category(['Settings' => $this->pdo]))->getCategorySearch($cat);
 			}
 		}
@@ -106,10 +106,10 @@ Class RSS extends Capabilities
 				$this->releases->showPasswords,
 				NZB::NZB_ADDED,
 				$catSearch,
-				($videosId > 0 ? sprintf('AND r.videos_id = %d %s', $videosId, ($catSearch == '' ? $catLimit : '')) : ''),
-				($aniDbID > 0 ? sprintf('AND r.anidbid = %d %s', $aniDbID, ($catSearch == '' ? $catLimit : '')) : ''),
+				($videosId > 0 ? sprintf('AND r.videos_id = %d %s', $videosId, ($catSearch === '' ? $catLimit : '')) : ''),
+				($aniDbID > 0 ? sprintf('AND r.anidbid = %d %s', $aniDbID, ($catSearch === '' ? $catLimit : '')) : ''),
 				($airDate > -1 ? sprintf('AND tve.firstaired >= DATE_SUB(CURDATE(), INTERVAL %d DAY)', $airDate) : ''),
-				(' LIMIT 0,' . ($offset > 100 ? 100 : $offset))
+				' LIMIT 0,' . ($offset > 100 ? 100 : $offset)
 			), true, NN_CACHE_EXPIRY_MEDIUM
 		);
 		return $sql;
@@ -125,7 +125,7 @@ Class RSS extends Capabilities
 	 *
 	 * @return array
 	 */
-	public function getShowsRss($limit, $userID = 0, $excludedCats = [], $airDate = -1)
+	public function getShowsRss($limit, $userID = 0, array $excludedCats = [], $airDate = -1): array
 	{
 		return $this->pdo->query(
 			sprintf("
@@ -163,7 +163,7 @@ Class RSS extends Capabilities
 				Category::TV_ROOT,
 				Category::TV_OTHER,
 				$this->releases->showPasswords,
-				(' LIMIT ' . ($limit > 100 ? 100 : $limit) . ' OFFSET 0')
+				' LIMIT ' . ($limit > 100 ? 100 : $limit) . ' OFFSET 0'
 			), true, NN_CACHE_EXPIRY_MEDIUM
 		);
 	}
@@ -177,7 +177,7 @@ Class RSS extends Capabilities
 	 *
 	 * @return array
 	 */
-	public function getMyMoviesRss($limit, $userID = 0, $excludedCats = [])
+	public function getMyMoviesRss($limit, $userID = 0, array $excludedCats = []): array
 	{
 		return $this->pdo->query(
 			sprintf("
@@ -213,7 +213,7 @@ Class RSS extends Capabilities
 				Category::MOVIE_ROOT,
 				Category::MOVIE_OTHER,
 				$this->releases->showPasswords,
-				(' LIMIT ' . ($limit > 100 ? 100 : $limit) . ' OFFSET 0')
+				' LIMIT ' . ($limit > 100 ? 100 : $limit) . ' OFFSET 0'
 			),
 			true,
 			NN_CACHE_EXPIRY_MEDIUM

nntmux/http/XML_Response.php

@@ -86,12 +86,17 @@ class XML_Response
 	 */
 	protected $xml;
 
+	/**
+	 * @var mixed
+	 */
+	protected $offset;
+
 	/**
 	 * XMLReturn constructor.
 	 *
 	 * @param array $options
 	 */
-	public function __construct($options = [])
+	public function __construct(array $options = [])
 	{
 		$defaults = [
 			'Parameters' => null,
@@ -114,9 +119,9 @@ class XML_Response
 	}
 
 	/**
-	 * @return bool|void
+	 * @return bool
 	 */
-	public function returnXML()
+	public function returnXML(): bool
 	{
 		if ($this->xml) {
 			switch ($this->type) {
@@ -147,7 +152,7 @@ class XML_Response
 	 *
 	 * @return string The XML Formatted string data
 	 */
-	protected function returnCaps()
+	protected function returnCaps(): string
 	{
 		$w = $this->xml;
 		$s = $this->server;
@@ -170,7 +175,7 @@ class XML_Response
 	 *
 	 * @return string The XML Formatted string data
 	 */
-	protected function returnApiRss()
+	protected function returnApiRss(): string
 	{
 		$w = $this->xml;
 		$this->xml->startDocument('1.0', 'UTF-8');
@@ -191,7 +196,7 @@ class XML_Response
 	/**
 	 * @return string The XML formatted registration information
 	 */
-	protected function returnReg()
+	protected function returnReg(): string
 	{
 		$this->xml->startDocument('1.0', 'UTF-8');
 		$this->xml->startElement('register');
@@ -209,7 +214,7 @@ class XML_Response
 	 *
 	 * @param array $element An array with the name of the element and the attribute data
 	 */
-	protected function addNode($element)
+	protected function addNode($element): void
 	{
 		$this->xml->startElement($element['name']);
 		foreach ($element['data'] AS $attr => $val) {
@@ -223,7 +228,7 @@ class XML_Response
 	 *
 	 * @param array $element An array with the name of the element and the attribute data
 	 */
-	protected function addNodes($element)
+	protected function addNodes($element): void
 	{
 		$this->xml->startElement($element['name']);
 		foreach ($element['data'] AS $elem => $value) {
@@ -237,21 +242,21 @@ class XML_Response
 	/**
 	 * Adds the site category listing to the XML feed
 	 */
-	protected function writeCategoryListing()
+	protected function writeCategoryListing(): void
 	{
 		$this->xml->startElement('categories');
 		foreach ($this->server['categories'] AS $p) {
 			$this->xml->startElement('category');
 			$this->xml->writeAttribute('id', $p['id']);
 			$this->xml->writeAttribute('name', html_entity_decode($p['title']));
-			if ($p['description'] != '') {
+			if ($p['description'] !== '') {
 				$this->xml->writeAttribute('description', html_entity_decode($p['description']));
 			}
 			foreach ($p['subcatlist'] AS $c) {
 				$this->xml->startElement('subcat');
 				$this->xml->writeAttribute('id', $c['id']);
 				$this->xml->writeAttribute('name', html_entity_decode($c['title']));
-				if ($c['description'] != '') {
+				if ($c['description'] !== '') {
 					$this->xml->writeAttribute('description', html_entity_decode($c['description']));
 				}
 				$this->xml->endElement();
@@ -264,7 +269,7 @@ class XML_Response
 	 * Adds RSS Atom information to the XML
 	 *
 	 */
-	protected function includeRssAtom()
+	protected function includeRssAtom(): void
 	{
 		switch ($this->namespace) {
 			case 'newznab':
@@ -285,7 +290,7 @@ class XML_Response
 	/**
 	 *
 	 */
-	protected function includeRssAtomLink()
+	protected function includeRssAtomLink(): void
 	{
 		$this->xml->startElement('atom:link');
 		$this->xml->startAttribute('href');
@@ -303,7 +308,7 @@ class XML_Response
 	/**
 	 * Writes the channel information for the feed
 	 */
-	protected function includeMetaInfo()
+	protected function includeMetaInfo(): void
 	{
 		$server = $this->server['server'];
 
@@ -332,7 +337,7 @@ class XML_Response
 	/**
 	 * Adds nntmux logo data to the XML
 	 */
-	protected function includeImage()
+	protected function includeImage(): void
 	{
 		$this->xml->startElement('image');
 		$this->xml->writeAttribute('url', $this->server['server']['url'] . 'themes/shared/images/logo.png');
@@ -345,18 +350,18 @@ class XML_Response
 		$this->xml->endElement();
 	}
 
-	public function includeTotalRows()
+	public function includeTotalRows(): void
 	{
 		$this->xml->startElement($this->namespace . ":response");
 		$this->xml->writeAttribute('offset', $this->offset);
-		$this->xml->writeAttribute('total', isset($this->releases[0]['_totalrows']) ? $this->releases[0]['_totalrows'] : 0);
+		$this->xml->writeAttribute('total', $this->releases[0]['_totalrows'] ?? 0);
 		$this->xml->endElement();
 	}
 
 	/**
 	 * Loop through the releases and add their info to the XML stream
 	 */
-	public function includeReleases()
+	public function includeReleases(): void
 	{
 		if (is_array($this->releases) && !empty($this->releases)) {
 			foreach ($this->releases AS $this->release) {
@@ -371,7 +376,7 @@ class XML_Response
 	/**
 	 * Writes the primary release information
 	 */
-	public function includeReleaseMain()
+	public function includeReleaseMain(): void
 	{
 		$this->xml->writeElement('title', $this->release['searchname']);
 		$this->xml->startElement('guid');
@@ -382,7 +387,7 @@ class XML_Response
 			'link',
 			"{$this->server['server']['url']}getnzb/{$this->release['guid']}.nzb" .
 			"&i={$this->parameters['uid']}" . "&r={$this->parameters['token']}" .
-			($this->parameters['del'] == '1' ? "&del=1" : '')
+			((int)$this->parameters['del'] === 1 ? '&del=1' : '')
 		);
 		$this->xml->writeElement('comments', "{$this->server['server']['url']}details/{$this->release['guid']}#comments");
 		$this->xml->writeElement('pubDate', date(DATE_RSS, strtotime($this->release['adddate'])));
@@ -398,7 +403,7 @@ class XML_Response
 				'url',
 				"{$this->server['server']['url']}getnzb/{$this->release['guid']}.nzb" .
 				"&i={$this->parameters['uid']}" . "&r={$this->parameters['token']}" .
-				($this->parameters['del'] == '1' ? "&del=1" : '')
+				((int)$this->parameters['del'] === 1 ? '&del=1' : '')
 			);
 			$this->xml->writeAttribute('length', $this->release['size']);
 			$this->xml->writeAttribute('type', 'application/x-nzb');
@@ -409,7 +414,7 @@ class XML_Response
 	/**
 	 * Writes the Zed (newznab) specific attributes
 	 */
-	protected function setZedAttributes()
+	protected function setZedAttributes(): void
 	{
 		$this->writeZedAttr('category', $this->release['categories_id']);
 		$this->writeZedAttr('size', $this->release['size']);
@@ -420,10 +425,10 @@ class XML_Response
 			);
 		}
 
-		if ($this->parameters['extended'] == 1) {
+		if ((int)$this->parameters['extended'] === 1) {
 			$this->writeZedAttr('files', $this->release['totalpart']);
 			$this->writeZedAttr('poster', $this->release['fromname']);
-			if (($this->release['videos_id'] > 0 || $this->release['tv_episodes_id'] > 0) && $this->namespace === 'newznab') {
+			if ($this->namespace === 'newznab' && ($this->release['videos_id'] > 0 || $this->release['tv_episodes_id'] > 0)) {
 				$this->setTvAttr();
 			}
 
@@ -436,7 +441,7 @@ class XML_Response
 			if (isset($this->release['predb_id']) && $this->release['predb_id'] > 0) {
 				$this->writeZedAttr('prematch', 1);
 			}
-			if (isset($this->release['nfostatus']) && $this->release['nfostatus'] == 1) {
+			if (isset($this->release['nfostatus']) && (int)$this->release['nfostatus'] === 1) {
 				$this->writeZedAttr(
 					'info',
 					$this->server['server']['url'] .
@@ -457,7 +462,7 @@ class XML_Response
 	/**
 	 * Writes the TV Specific attributes
 	 */
-	protected function setTvAttr()
+	protected function setTvAttr(): void
 	{
 		if (!empty($this->release['title'])) {
 			$this->writeZedAttr('title', $this->release['title']);
@@ -500,7 +505,7 @@ class XML_Response
 	 */
 	protected function writeZedAttr($name, $value)
 	{
-		$this->xml->startElement($this->namespace . ":attr");
+		$this->xml->startElement($this->namespace . ':attr');
 		$this->xml->writeAttribute('name', $name);
 		$this->xml->writeAttribute('value', $value);
 		$this->xml->endElement();
@@ -510,7 +515,7 @@ class XML_Response
 	 * Writes the cData (HTML format) for the RSS feed
 	 * Also calls supplementary cData writes depending upon post process
 	 */
-	protected function writeRssCdata()
+	protected function writeRssCdata(): void
 	{
 		$this->cdata = '';
 
@@ -538,7 +543,7 @@ class XML_Response
 				$column = 'bookinfo_id';
 				break;
 		}
-		if (isset($dir) && isset($column)) {
+		if (isset($dir, $column)) {
 			$dcov = ($dir === 'movies' ? '-cover' : '');
 			$this->cdata .=
 				"\t<img style=\"margin-left:10px;margin-bottom:10px;float:right;\" " .
@@ -579,22 +584,22 @@ class XML_Response
 				"{$r['searchname']}.nfo</a></li>\n";
 		}
 
-		if ($r['parentid'] == Category::MOVIE_ROOT && $r['imdbid'] != '') {
+		if ((int)$r['parentid'] === (int)Category::MOVIE_ROOT && $r['imdbid'] !== '') {
 			$this->writeRssMovieInfo();
-		} else if ($r['parentid'] == Category::MUSIC_ROOT && $r['musicinfo_id'] > 0) {
+		} else if ((int)$r['parentid'] === (int)Category::MUSIC_ROOT && $r['musicinfo_id'] > 0) {
 			$this->writeRssMusicInfo();
-		} else if ($r['parentid'] == Category::GAME_ROOT && $r['consoleinfo_id'] > 0) {
+		} else if ((int)$r['parentid'] === (int)Category::GAME_ROOT && $r['consoleinfo_id'] > 0) {
 			$this->writeRssConsoleInfo();
 		}
 		$w->startElement('description');
-		$w->writeCdata($this->cdata . "\t</div>");
+		$w->writeCData($this->cdata . "\t</div>");
 		$w->endElement();
 	}
 
 	/**
 	 * Writes the Movie Info for the RSS feed cData
 	 */
-	protected function writeRssMovieInfo()
+	protected function writeRssMovieInfo(): void
 	{
 		$r = $this->release;
 
@@ -615,7 +620,7 @@ class XML_Response
 	/**
 	 * Writes the Music Info for the RSS feed cData
 	 */
-	protected function writeRssMusicInfo()
+	protected function writeRssMusicInfo(): void
 	{
 		$r = $this->release;
 		$tData = $cDataUrl = '';
@@ -635,7 +640,7 @@ class XML_Response
 			{$cData}
 			</ul>
 			</li>\n";
-		if ($r['mu_tracks'] != '') {
+		if ($r['mu_tracks'] !== '') {
 			$tracks = explode('|', $r['mu_tracks']);
 			if (count($tracks) > 0) {
 				foreach ($tracks AS $track) {
@@ -655,7 +660,7 @@ class XML_Response
 	/**
 	 * Writes the Console Info for the RSS feed cData
 	 */
-	protected function writeRssConsoleInfo()
+	protected function writeRssConsoleInfo(): void
 	{
 		$r = $this->release;
 		$gamesCol = ['co_genre', 'co_publisher', 'year', 'co_review'];
@@ -678,7 +683,7 @@ class XML_Response
 	 *
 	 * @return string The HTML format cData
 	 */
-	protected function buildCdata($columns)
+	protected function buildCdata($columns): string
 	{
 		$r = $this->release;
 
@@ -686,7 +691,7 @@ class XML_Response
 
 		foreach ($columns AS $info) {
 			if (!empty($r[$info])) {
-				if ($info == 'mu_releasedate') {
+				if ($info === 'mu_releasedate') {
 					$ucInfo = 'Released';
 					$rDate = date('Y-m-d', strtotime($r[$info]));
 					$cData .= "<li>{$ucInfo}: {$rDate}</li>\n";