PodcastService::__construct() - Code Metrics - Inspection of "set user agent when fetching podcasts" - owncloud/music - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#888)

by Robin

created 2021-08-31 13:30 UTC

PodcastService::__construct() A

↳ Parent: PodcastService

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
nc	1
nop	3
dl	0
loc	7
rs	10
c	1
b	0
f	0

<?php declare(strict_types=1);

/**
 * ownCloud - Music app
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Pauli Järvinen <[email protected]>
 * @copyright Pauli Järvinen 2021
 */

namespace OCA\Music\Utility;

use \OCA\Music\AppFramework\BusinessLayer\BusinessLayerException;
use \OCA\Music\AppFramework\Core\Logger;
use \OCA\Music\BusinessLayer\PodcastChannelBusinessLayer;
use \OCA\Music\BusinessLayer\PodcastEpisodeBusinessLayer;
use \OCA\Music\Db\PodcastChannel;
use \OCA\Music\Db\PodcastEpisode;
use \OCA\Music\Db\SortBy;


class PodcastService {
	private $channelBusinessLayer;
	private $episodeBusinessLayer;
	private $logger;

	public const STATUS_OK = 0;
	public const STATUS_INVALID_URL = 1;
	public const STATUS_INVALID_RSS = 2;
	public const STATUS_ALREADY_EXISTS = 3;
	public const STATUS_NOT_FOUND = 4;

	public function __construct(
			PodcastChannelBusinessLayer $channelBusinessLayer,
			PodcastEpisodeBusinessLayer $episodeBusinessLayer,
			Logger $logger) {
		$this->channelBusinessLayer = $channelBusinessLayer;
		$this->episodeBusinessLayer = $episodeBusinessLayer;
		$this->logger = $logger;
	}

	/**
	 * Get a specified podcast channel of a user
	 */
	public function getChannel(int $id, string $userId, bool $includeEpisodes) : ?PodcastChannel {
		try {
			$channel = $this->channelBusinessLayer->find($id, $userId);
			if ($includeEpisodes) {
				$channel->setEpisodes($this->episodeBusinessLayer->findAllByChannel($id, $userId));
			}
			return $channel;
		} catch (BusinessLayerException $ex) {
			$this->logger->log("Requested channel $id not found: " . $ex->getMessage(), 'warn');
			return null;
		}
	}

	/**
	 * Get all podcast channels of a user
	 * @return PodcastChannel[]
	 */
	public function getAllChannels(string $userId, bool $includeEpisodes) : array {
		$channels = $this->channelBusinessLayer->findAll($userId, SortBy::Name);

		if ($includeEpisodes) {
			$this->injectEpisodes($channels, $userId, /*$allChannelsIncluded=*/ true);
		}

		return $channels;
	}

	/**
	 * Get a specified podcast episode of a user
	 */
	public function getEpisode(int $id, string $userId) : ?PodcastEpisode {
		try {
			return $this->episodeBusinessLayer->find($id, $userId);
		} catch (BusinessLayerException $ex) {
			$this->logger->log("Requested episode $id not found: " . $ex->getMessage(), 'warn');
			return null;
		}
	}

	/**
	 * Get the latest added podcast episodes
	 * @return PodcastEpisode[]
	 */
	public function getLatestEpisodes(string $userId, int $maxCount) : array {
		return $this->episodeBusinessLayer->findAll($userId, SortBy::Newest, $maxCount);
	}

	/**
	 * Inject episodes to the given podcast channels
	 * @param PodcastChannel[] $channels input/output
	 * @param bool $allChannelsIncluded Set this to true if $channels contains all the podcasts of the user.
	 *									This helps in optimizing the DB query.
	 */
	public function injectEpisodes(array &$channels, string $userId, bool $allChannelsIncluded) : void {
		if ($allChannelsIncluded || \count($channels) > 999) {
			$episodes = $this->episodeBusinessLayer->findAll($userId, SortBy::Newest);
		} else {
			$episodes = $this->episodeBusinessLayer->findAllByChannel(Util::extractIds($channels), $userId);
		}

		$episodesPerChannel = [];
		foreach ($episodes as $episode) {
			$episodesPerChannel[$episode->getChannelId()][] = $episode;
		}

		foreach ($channels as &$channel) {
			$channel->setEpisodes($episodesPerChannel[$channel->getId()] ?? []);
		}
	}

	/**
	 * Add a followed podcast for a user from an RSS feed
	 * @return array like ['status' => int, 'channel' => ?PodcastChannel]
	 */
	public function subscribe(string $url, string $userId) : array {
		$content = self::fetchUrl($url);
		if ($content === false) {
			return ['status' => self::STATUS_INVALID_URL, 'channel' => null];
		}

		$xmlTree = \simplexml_load_string($content, \SimpleXMLElement::class, LIBXML_NOCDATA);
		if ($xmlTree === false || !$xmlTree->channel) {
			return ['status' => self::STATUS_INVALID_RSS, 'channel' => null];
		}

		try {
			$channel = $this->channelBusinessLayer->create($userId, $url, $content, $xmlTree->channel);
		} catch (\OCA\Music\AppFramework\Db\UniqueConstraintViolationException $ex) {
			return ['status' => self::STATUS_ALREADY_EXISTS, 'channel' => null];
		}

		$episodes = $this->updateEpisodesFromXml($xmlTree->channel->item, $userId, $channel->getId());
		$channel->setEpisodes(\array_reverse($episodes));

		return ['status' => self::STATUS_OK, 'channel' => $channel];
	}

	/**
	 * Deletes a podcast channel from a user
	 * @return int status code
	 */
	public function unsubscribe(int $channelId, string $userId) : int {
		try {
			$this->channelBusinessLayer->delete($channelId, $userId); // throws if not found
			$this->episodeBusinessLayer->deleteByChannel($channelId, $userId); // does not throw
			return self::STATUS_OK;
		} catch (BusinessLayerException $ex) {
			$this->logger->log("Channel $channelId to be unsubscirbed not found: " . $ex->getMessage(), 'warn');
			return self::STATUS_NOT_FOUND;
		}
	}

	/**
	 * Check a single podcast channel for updates
	 * @param ?string $prevHash Previous content hash known by the client. If given, the result will tell
	 *							if the channel content has updated from this state. If omitted, the result
	 *							will tell if the channel changed from its previous server-known state.
	 * @param bool $force Value true will cause the channel to be parsed and updated to the database even
	 *					in case the RSS hasn't been changed at all since the previous update. This might be
	 *					useful during the development or if the previous update was unexpectedly aborted.
	 * @return array like ['status' => int, 'updated' => bool, 'channel' => ?PodcastChannel]
	 */
	public function updateChannel(int $id, string $userId, ?string $prevHash = null, bool $force = false) : array {
		$updated = false;
		$status = self::STATUS_OK;

		try {
			$channel = $this->channelBusinessLayer->find($id, $userId);
		} catch (BusinessLayerException $ex) {
			$this->logger->log("Channel $id to be updated not found: " . $ex->getMessage(), 'warn');
			$status = self::STATUS_NOT_FOUND;
			$channel = null;
		}

		if ($channel !== null) {
			$xmlTree = null;
			$content = self::fetchUrl($channel->getRssUrl());
			if ($content === null) {
				$status = self::STATUS_INVALID_URL;
			} else {
				$xmlTree = \simplexml_load_string($content, \SimpleXMLElement::class, LIBXML_NOCDATA);
			}

			if (!$xmlTree || !$xmlTree->channel) {
				$this->logger->log("RSS feed for the chanenl {$channel->id} was invalid", 'warn');
				$status = self::STATUS_INVALID_RSS;
			} else if ($this->channelBusinessLayer->updateChannel($channel, $content, $xmlTree->channel, $force)) {
				// update the episodes too if channel content has actually changed or update is forced
				$episodes = $this->updateEpisodesFromXml($xmlTree->channel->item, $userId, $id);
				$channel->setEpisodes($episodes);
				$this->episodeBusinessLayer->deleteByChannelExcluding($id, Util::extractIds($episodes), $userId);
				$updated = true;
			} else if ($prevHash !== null && $prevHash !== $channel->getContentHash()) {
				// the channel content is not new for the server but it is still new for the client
				$channel->setEpisodes($this->episodeBusinessLayer->findAllByChannel($id, $userId));
				$updated = true;
			}
		}

		return [
			'status' => $status,
			'updated' => $updated,
			'channel' => $channel
		];
	}

	/**
	 * Check updates for all chanenls of the user, one-by-one
	 * @return array like ['changed' => int, 'unchanged' => int, 'failed' => int]
	 *			where each int represent number of channels in that category
	 */
	public function updateAllChannels(
			string $userId, ?float $olderThan = null, bool $force = false, ?callable $progressCallback = null) : array {

		$result = ['changed' => 0, 'unchanged' => 0, 'failed' => 0];

		if ($olderThan === null) {
			$ids = $this->channelBusinessLayer->findAllIds($userId);
		} else {
			$ids = $this->channelBusinessLayer->findAllIdsNotUpdatedForHours($userId, $olderThan);
		}

		foreach ($ids as $id) {
			$channelResult = $this->updateChannel($id, $userId, null, $force);
			if ($channelResult['updated']) {
				$result['changed']++;
			} elseif ($channelResult['status'] === self::STATUS_OK) {
				$result['unchanged']++;
			} else {
				$result['failed']++;
			}

			if ($progressCallback !== null) {
				$progressCallback($channelResult);
			}
		}

		return $result;
	}

	/**
	 * Reset all the subscribed podcasts of the user
	 */
	public function resetAll(string $userId) : void {
		$this->episodeBusinessLayer->deleteAll($userId);
		$this->channelBusinessLayer->deleteAll($userId);
	}

	private function updateEpisodesFromXml(\SimpleXMLElement $items, string $userId, int $channelId) : array {
		$episodes = [];
		// loop the episodes from XML in reverse order to get chronological order
		for ($count = \count($items), $i = $count-1; $i >= 0; --$i) {
			if ($items[$i] !== null) {
				$episodes[] = $this->episodeBusinessLayer->addOrUpdate($userId, $channelId, $items[$i]);
			}
		}
		return $episodes;
	}

	/**
	 * @param string $url
	 * @return string|false
	 */
	private static function fetchUrl(string $url) {
		// some podcast services require a valid user agent to be set
		$opts = [
			"http" => [
				"header" => "User-Agent: PodcastService"
			]
		];
		$context = stream_context_create($opts);
		return \file_get_contents($url, false, $context);
	}
}


1			<?php declare(strict_types=1);
2
3			/**
4			* ownCloud - Music app
5			*
6			* This file is licensed under the Affero General Public License version 3 or
7			* later. See the COPYING file.
8			*
9			* @author Pauli Järvinen <[email protected]>
10			* @copyright Pauli Järvinen 2021
11			*/
12
13			namespace OCA\Music\Utility;
14
15			use \OCA\Music\AppFramework\BusinessLayer\BusinessLayerException;
16			use \OCA\Music\AppFramework\Core\Logger;
17			use \OCA\Music\BusinessLayer\PodcastChannelBusinessLayer;
18			use \OCA\Music\BusinessLayer\PodcastEpisodeBusinessLayer;
19			use \OCA\Music\Db\PodcastChannel;
20			use \OCA\Music\Db\PodcastEpisode;
21			use \OCA\Music\Db\SortBy;
22
23
24			class PodcastService {
25			private $channelBusinessLayer;
26			private $episodeBusinessLayer;
27			private $logger;
28
29			public const STATUS_OK = 0;
30			public const STATUS_INVALID_URL = 1;
31			public const STATUS_INVALID_RSS = 2;
32			public const STATUS_ALREADY_EXISTS = 3;
33			public const STATUS_NOT_FOUND = 4;
34
35			public function __construct(
36			PodcastChannelBusinessLayer $channelBusinessLayer,
37			PodcastEpisodeBusinessLayer $episodeBusinessLayer,
38			Logger $logger) {
39			$this->channelBusinessLayer = $channelBusinessLayer;
40			$this->episodeBusinessLayer = $episodeBusinessLayer;
41			$this->logger = $logger;
42			}
43
44			/**
45			* Get a specified podcast channel of a user
46			*/
47			public function getChannel(int $id, string $userId, bool $includeEpisodes) : ?PodcastChannel {
48			try {
49			$channel = $this->channelBusinessLayer->find($id, $userId);
50			if ($includeEpisodes) {
51			$channel->setEpisodes($this->episodeBusinessLayer->findAllByChannel($id, $userId));
52			}
53			return $channel;
54			} catch (BusinessLayerException $ex) {
55			$this->logger->log("Requested channel $id not found: " . $ex->getMessage(), 'warn');
56			return null;
57			}
58			}
59
60			/**
61			* Get all podcast channels of a user
62			* @return PodcastChannel[]
63			*/
64			public function getAllChannels(string $userId, bool $includeEpisodes) : array {
65			$channels = $this->channelBusinessLayer->findAll($userId, SortBy::Name);
66
67			if ($includeEpisodes) {
68			$this->injectEpisodes($channels, $userId, /$allChannelsIncluded=/ true);
69			}
70
71			return $channels;
72			}
73
74			/**
75			* Get a specified podcast episode of a user
76			*/
77			public function getEpisode(int $id, string $userId) : ?PodcastEpisode {
78			try {
79			return $this->episodeBusinessLayer->find($id, $userId);
80			} catch (BusinessLayerException $ex) {
81			$this->logger->log("Requested episode $id not found: " . $ex->getMessage(), 'warn');
82			return null;
83			}
84			}
85
86			/**
87			* Get the latest added podcast episodes
88			* @return PodcastEpisode[]
89			*/
90			public function getLatestEpisodes(string $userId, int $maxCount) : array {
91			return $this->episodeBusinessLayer->findAll($userId, SortBy::Newest, $maxCount);
92			}
93
94			/**
95			* Inject episodes to the given podcast channels
96			* @param PodcastChannel[] $channels input/output
97			* @param bool $allChannelsIncluded Set this to true if $channels contains all the podcasts of the user.
98			* This helps in optimizing the DB query.
99			*/
100			public function injectEpisodes(array &$channels, string $userId, bool $allChannelsIncluded) : void {
101			if ($allChannelsIncluded \|\| \count($channels) > 999) {
102			$episodes = $this->episodeBusinessLayer->findAll($userId, SortBy::Newest);
103			} else {
104			$episodes = $this->episodeBusinessLayer->findAllByChannel(Util::extractIds($channels), $userId);
105			}
106
107			$episodesPerChannel = [];
108			foreach ($episodes as $episode) {
109			$episodesPerChannel[$episode->getChannelId()][] = $episode;
110			}
111
112			foreach ($channels as &$channel) {
113			$channel->setEpisodes($episodesPerChannel[$channel->getId()] ?? []);
114			}
115			}
116
117			/**
118			* Add a followed podcast for a user from an RSS feed
119			* @return array like ['status' => int, 'channel' => ?PodcastChannel]
120			*/
121			public function subscribe(string $url, string $userId) : array {
122			$content = self::fetchUrl($url);
123			if ($content === false) {
124			return ['status' => self::STATUS_INVALID_URL, 'channel' => null];
125			}
126
127			$xmlTree = \simplexml_load_string($content, \SimpleXMLElement::class, LIBXML_NOCDATA);
128			if ($xmlTree === false \|\| !$xmlTree->channel) {
129			return ['status' => self::STATUS_INVALID_RSS, 'channel' => null];
130			}
131
132			try {
133			$channel = $this->channelBusinessLayer->create($userId, $url, $content, $xmlTree->channel);
134			} catch (\OCA\Music\AppFramework\Db\UniqueConstraintViolationException $ex) {
135			return ['status' => self::STATUS_ALREADY_EXISTS, 'channel' => null];
136			}
137
138			$episodes = $this->updateEpisodesFromXml($xmlTree->channel->item, $userId, $channel->getId());
139			$channel->setEpisodes(\array_reverse($episodes));
140
141			return ['status' => self::STATUS_OK, 'channel' => $channel];
142			}
143
144			/**
145			* Deletes a podcast channel from a user
146			* @return int status code
147			*/
148			public function unsubscribe(int $channelId, string $userId) : int {
149			try {
150			$this->channelBusinessLayer->delete($channelId, $userId); // throws if not found
151			$this->episodeBusinessLayer->deleteByChannel($channelId, $userId); // does not throw
152			return self::STATUS_OK;
153			} catch (BusinessLayerException $ex) {
154			$this->logger->log("Channel $channelId to be unsubscirbed not found: " . $ex->getMessage(), 'warn');
155			return self::STATUS_NOT_FOUND;
156			}
157			}
158
159			/**
160			* Check a single podcast channel for updates
161			* @param ?string $prevHash Previous content hash known by the client. If given, the result will tell
162			* if the channel content has updated from this state. If omitted, the result
163			* will tell if the channel changed from its previous server-known state.
164			* @param bool $force Value true will cause the channel to be parsed and updated to the database even
165			* in case the RSS hasn't been changed at all since the previous update. This might be
166			* useful during the development or if the previous update was unexpectedly aborted.
167			* @return array like ['status' => int, 'updated' => bool, 'channel' => ?PodcastChannel]
168			*/
169			public function updateChannel(int $id, string $userId, ?string $prevHash = null, bool $force = false) : array {
170			$updated = false;
171			$status = self::STATUS_OK;
172
173			try {
174			$channel = $this->channelBusinessLayer->find($id, $userId);
175			} catch (BusinessLayerException $ex) {
176			$this->logger->log("Channel $id to be updated not found: " . $ex->getMessage(), 'warn');
177			$status = self::STATUS_NOT_FOUND;
178			$channel = null;
179			}
180
181			if ($channel !== null) {
182			$xmlTree = null;
183			$content = self::fetchUrl($channel->getRssUrl());
184			if ($content === null) {
185			$status = self::STATUS_INVALID_URL;
186			} else {
187			$xmlTree = \simplexml_load_string($content, \SimpleXMLElement::class, LIBXML_NOCDATA);
188			}
189
190			if (!$xmlTree \|\| !$xmlTree->channel) {
191			$this->logger->log("RSS feed for the chanenl {$channel->id} was invalid", 'warn');
192			$status = self::STATUS_INVALID_RSS;
193			} else if ($this->channelBusinessLayer->updateChannel($channel, $content, $xmlTree->channel, $force)) {
194			// update the episodes too if channel content has actually changed or update is forced
195			$episodes = $this->updateEpisodesFromXml($xmlTree->channel->item, $userId, $id);
196			$channel->setEpisodes($episodes);
197			$this->episodeBusinessLayer->deleteByChannelExcluding($id, Util::extractIds($episodes), $userId);
198			$updated = true;
199			} else if ($prevHash !== null && $prevHash !== $channel->getContentHash()) {
200			// the channel content is not new for the server but it is still new for the client
201			$channel->setEpisodes($this->episodeBusinessLayer->findAllByChannel($id, $userId));
202			$updated = true;
203			}
204			}
205
206			return [
207			'status' => $status,
208			'updated' => $updated,
209			'channel' => $channel
210			];
211			}
212
213			/**
214			* Check updates for all chanenls of the user, one-by-one
215			* @return array like ['changed' => int, 'unchanged' => int, 'failed' => int]
216			* where each int represent number of channels in that category
217			*/
218			public function updateAllChannels(
219			string $userId, ?float $olderThan = null, bool $force = false, ?callable $progressCallback = null) : array {
220
221			$result = ['changed' => 0, 'unchanged' => 0, 'failed' => 0];
222
223			if ($olderThan === null) {
224			$ids = $this->channelBusinessLayer->findAllIds($userId);
225			} else {
226			$ids = $this->channelBusinessLayer->findAllIdsNotUpdatedForHours($userId, $olderThan);
227			}
228
229			foreach ($ids as $id) {
230			$channelResult = $this->updateChannel($id, $userId, null, $force);
231			if ($channelResult['updated']) {
232			$result['changed']++;
233			} elseif ($channelResult['status'] === self::STATUS_OK) {
234			$result['unchanged']++;
235			} else {
236			$result['failed']++;
237			}
238
239			if ($progressCallback !== null) {
240			$progressCallback($channelResult);
241			}
242			}
243
244			return $result;
245			}
246
247			/**
248			* Reset all the subscribed podcasts of the user
249			*/
250			public function resetAll(string $userId) : void {
251			$this->episodeBusinessLayer->deleteAll($userId);
252			$this->channelBusinessLayer->deleteAll($userId);
253			}
254
255			private function updateEpisodesFromXml(\SimpleXMLElement $items, string $userId, int $channelId) : array {
256			$episodes = [];
257			// loop the episodes from XML in reverse order to get chronological order
258			for ($count = \count($items), $i = $count-1; $i >= 0; --$i) {
259			if ($items[$i] !== null) {
260			$episodes[] = $this->episodeBusinessLayer->addOrUpdate($userId, $channelId, $items[$i]);
261			}
262			}
263			return $episodes;
264			}
265
266			/**
267			* @param string $url
268			* @return string\|false
269			*/
270			private static function fetchUrl(string $url) {
271			// some podcast services require a valid user agent to be set
272			$opts = [
273			"http" => [
274			"header" => "User-Agent: PodcastService"
275			]
276			];
277			$context = stream_context_create($opts);
278			return \file_get_contents($url, false, $context);
279			}
280			}
281

owncloud / music

Pull Request — master (#888)

PodcastService::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like