RadioMetadata::fetchStreamData() - Code Metrics - Inspection of "Support also Shoutcast V2 format of radio metadata" - owncloud/music - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b75966...f85fb3 )

by Pauli

created 2022-07-07 20:24 UTC

RadioMetadata::fetchStreamData() C

↳ Parent: RadioMetadata

Complexity

Conditions	16
Paths	22

Size

Total Lines	59
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
eloc	43
c	3
b	0
f	0
dl	0
loc	59
rs	5.5666
cc	16
nc	22
nop	3

1 Method

Rating	Name	Duplication	Size	Complexity
A	RadioMetadata::readShoutcastV2Metadata()	0	13	2

How to fix Long Method Complexity

<?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 Moahmed-Ismail MEJRI <[email protected]>
 * @author Pauli Järvinen <[email protected]>
 * @copyright Moahmed-Ismail MEJRI 2022
 * @copyright Pauli Järvinen 2022
 */

namespace OCA\Music\Utility;

use OCA\Music\AppFramework\Core\Logger;

/**
 * MetaData radio utility functions
 */
class RadioMetadata {

	private $logger;

	public function __construct(Logger $logger) {
		$this->logger = $logger;
	}

	/**
	 * Loop through the array and try to find the given key. On match,
	 * return the text in the array cell following the key.
	 */
	private static function findStrFollowing(array $data, string $key) : ?string {
		foreach ($data as $value) {
			$find = \strstr($value, $key);
			if ($find !== false) {
				return \substr($find, \strlen($key));
			}
		}
		return null;
	}

	private static function parseStreamUrl(string $url) : array {
		$ret = [];
		$parse_url = \parse_url($url);

		$ret['port'] = 80;
		if (isset($parse_url['port'])) {
			$ret['port'] = $parse_url['port'];
		} else if ($parse_url['scheme'] == "https") {
			$ret['port'] = 443;
		}

		$ret['scheme'] = $parse_url['scheme'];
		$ret['hostname'] = $parse_url['host'];
		$ret['pathname'] = $parse_url['path'];

		if (isset($parse_url['query'])) {
			$ret['pathname'] .= "?" . $parse_url['query'];
		}

		if ($parse_url['scheme'] == "https") {
			$ret['sockAddress'] = "ssl://" . $ret['hostname'];
		} else {
			$ret['sockAddress'] = $ret['hostname'];
		}

		return $ret;
	}

	private static function parseTitleFromStreamMetadata($fp) : ?string {
		$meta_length = \ord(\fread($fp, 1)) * 16;
		if ($meta_length) {
			$metadatas = \explode(';', \fread($fp, $meta_length));
			$title = self::findStrFollowing($metadatas, "StreamTitle=");
			if ($title) {
				return Util::truncate(\trim($title, "'"), 256);
			}
		}
		return null;
	}

	public function readShoutcastV1Metadata(string $streamUrl) : ?string {
		// cut the URL from the last '/' and append 7.html
		$lastSlash = \strrpos($streamUrl, '/');
		$metaUrl = \substr($streamUrl, 0, $lastSlash) . '/7.html';

		list('content' => $content, 'status_code' => $status_code, 'message' => $message) = HttpUtil::loadFromUrl($metaUrl);

		if ($status_code == 200) {
			$content = \strip_tags($content); // get rid of the <html><body>...</html></body> decorations
			$data = \explode(',', $content);
			return \count($data) > 6 ? \trim($data[6]) : null; // the title field is optional
		} else {
			$this->logger->log("Failed to read $metaUrl: $status_code $message", 'debug');
			return null;
		}
	}

	public function readShoutcastV2Metadata(string $streamUrl) : ?string {
		// cut the URL from the last '/' and append 'stats'
		$lastSlash = \strrpos($streamUrl, '/');
		$metaUrl = \substr($streamUrl, 0, $lastSlash) . '/stats';

		list('content' => $content, 'status_code' => $status_code, 'message' => $message) = HttpUtil::loadFromUrl($metaUrl);

		if ($status_code == 200) {
			$rootNode = \simplexml_load_string($content, \SimpleXMLElement::class, LIBXML_NOCDATA);
			return (string)$rootNode->SONGTITLE;
		} else {
			$this->logger->log("Failed to read $metaUrl: $status_code $message", 'debug');
			return null;
		}
	}

	public function readIcyMetadata(string $streamUrl, int $maxattempts, int $maxredirect) : ?string {
		$timeout = 10;
		$streamTitle = null;
		$pUrl = self::parseStreamUrl($streamUrl);
		if ($pUrl['sockAddress'] && $pUrl['port']) {
			$fp = \fsockopen($pUrl['sockAddress'], $pUrl['port'], $errno, $errstr, $timeout);
			if ($fp !== false) {
				$out = "GET " . $pUrl['pathname'] . " HTTP/1.1\r\n";
				$out .= "Host: ". $pUrl['hostname'] . "\r\n";
				$out .= "Accept: */*\r\n";
				$out .= HttpUtil::userAgentHeader() . "\r\n";
				$out .= "Icy-MetaData: 1\r\n";
				$out .= "Connection: Close\r\n\r\n";
				\fwrite($fp, $out);
				\stream_set_timeout($fp, $timeout);

				$header = \fread($fp, 1024);
				$headers = \explode("\n", $header);

				if (\strpos($headers[0], "200 OK") !== false) {
					$interval = self::findStrFollowing($headers, "icy-metaint:") ?? '0';
					$interval = (int)\trim($interval);

					if ($interval > 0 && $interval <= 64*1024) {
						$attempts = 0;
						while ($attempts < $maxattempts && $streamTitle === null) {
							$bytesToSkip = $interval;
							if ($attempts === 0) {
								// The first chunk containing the header may also already contain the beginning of the body,
								// but this depends on the case. Subtract the body bytes which we already got.
								$headerEndPos = \strpos($header, "\r\n\r\n") + 4;
								$bytesToSkip -= \strlen($header) - $headerEndPos;
							}

							\fseek($fp, $bytesToSkip, SEEK_CUR);

							$streamTitle = self::parseTitleFromStreamMetadata($fp);

							$attempts++;
						}
					}
				} else if ($maxredirect > 0 && \strpos($headers[0], "302 Found") !== false) {
					$location = self::findStrFollowing($headers, "Location: ");
					if ($location) {
						$location = \trim($location, "\r");
						$streamTitle = $this->readIcyMetadata($location, $maxattempts, $maxredirect-1);
					}
				}
				\fclose($fp);
			}
		}

		return $streamTitle === '' ? null : $streamTitle;
	}

}


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 Moahmed-Ismail MEJRI <[email protected]>
10			* @author Pauli Järvinen <[email protected]>
11			* @copyright Moahmed-Ismail MEJRI 2022
12			* @copyright Pauli Järvinen 2022
13			*/
14
15			namespace OCA\Music\Utility;
16
17			use OCA\Music\AppFramework\Core\Logger;
18
19			/**
20			* MetaData radio utility functions
21			*/
22			class RadioMetadata {
23
24			private $logger;
25
26			public function __construct(Logger $logger) {
27			$this->logger = $logger;
28			}
29
30			/**
31			* Loop through the array and try to find the given key. On match,
32			* return the text in the array cell following the key.
33			*/
34			private static function findStrFollowing(array $data, string $key) : ?string {
35			foreach ($data as $value) {
36			$find = \strstr($value, $key);
37			if ($find !== false) {
38			return \substr($find, \strlen($key));
39			}
40			}
41			return null;
42			}
43
44			private static function parseStreamUrl(string $url) : array {
45			$ret = [];
46			$parse_url = \parse_url($url);
47
48			$ret['port'] = 80;
49			if (isset($parse_url['port'])) {
50			$ret['port'] = $parse_url['port'];
51			} else if ($parse_url['scheme'] == "https") {
52			$ret['port'] = 443;
53			}
54
55			$ret['scheme'] = $parse_url['scheme'];
56			$ret['hostname'] = $parse_url['host'];
57			$ret['pathname'] = $parse_url['path'];
58
59			if (isset($parse_url['query'])) {
60			$ret['pathname'] .= "?" . $parse_url['query'];
61			}
62
63			if ($parse_url['scheme'] == "https") {
64			$ret['sockAddress'] = "ssl://" . $ret['hostname'];
65			} else {
66			$ret['sockAddress'] = $ret['hostname'];
67			}
68
69			return $ret;
70			}
71
72			private static function parseTitleFromStreamMetadata($fp) : ?string {
73			$meta_length = \ord(\fread($fp, 1)) * 16;
74			if ($meta_length) {
75			$metadatas = \explode(';', \fread($fp, $meta_length));
76			$title = self::findStrFollowing($metadatas, "StreamTitle=");
77			if ($title) {
78			return Util::truncate(\trim($title, "'"), 256);
79			}
80			}
81			return null;
82			}
83
84			public function readShoutcastV1Metadata(string $streamUrl) : ?string {
85			// cut the URL from the last '/' and append 7.html
86			$lastSlash = \strrpos($streamUrl, '/');
87			$metaUrl = \substr($streamUrl, 0, $lastSlash) . '/7.html';
88
89			list('content' => $content, 'status_code' => $status_code, 'message' => $message) = HttpUtil::loadFromUrl($metaUrl);
90
91			if ($status_code == 200) {
92			$content = \strip_tags($content); // get rid of the <html><body>...</html></body> decorations
93			$data = \explode(',', $content);
94			return \count($data) > 6 ? \trim($data[6]) : null; // the title field is optional
95			} else {
96			$this->logger->log("Failed to read $metaUrl: $status_code $message", 'debug');
97			return null;
98			}
99			}
100
101			public function readShoutcastV2Metadata(string $streamUrl) : ?string {
102			// cut the URL from the last '/' and append 'stats'
103			$lastSlash = \strrpos($streamUrl, '/');
104			$metaUrl = \substr($streamUrl, 0, $lastSlash) . '/stats';
105
106			list('content' => $content, 'status_code' => $status_code, 'message' => $message) = HttpUtil::loadFromUrl($metaUrl);
107
108			if ($status_code == 200) {
109			$rootNode = \simplexml_load_string($content, \SimpleXMLElement::class, LIBXML_NOCDATA);
110			return (string)$rootNode->SONGTITLE;
111			} else {
112			$this->logger->log("Failed to read $metaUrl: $status_code $message", 'debug');
113			return null;
114			}
115			}
116
117			public function readIcyMetadata(string $streamUrl, int $maxattempts, int $maxredirect) : ?string {
118			$timeout = 10;
119			$streamTitle = null;
120			$pUrl = self::parseStreamUrl($streamUrl);
121			if ($pUrl['sockAddress'] && $pUrl['port']) {
122			$fp = \fsockopen($pUrl['sockAddress'], $pUrl['port'], $errno, $errstr, $timeout);
123			if ($fp !== false) {
124			$out = "GET " . $pUrl['pathname'] . " HTTP/1.1\r\n";
125			$out .= "Host: ". $pUrl['hostname'] . "\r\n";
126			$out .= "Accept: /\r\n";
127			$out .= HttpUtil::userAgentHeader() . "\r\n";
128			$out .= "Icy-MetaData: 1\r\n";
129			$out .= "Connection: Close\r\n\r\n";
130			\fwrite($fp, $out);
131			\stream_set_timeout($fp, $timeout);
132
133			$header = \fread($fp, 1024);
134			$headers = \explode("\n", $header);
135
136			if (\strpos($headers[0], "200 OK") !== false) {
137			$interval = self::findStrFollowing($headers, "icy-metaint:") ?? '0';
138			$interval = (int)\trim($interval);
139
140			if ($interval > 0 && $interval <= 64*1024) {
141			$attempts = 0;
142			while ($attempts < $maxattempts && $streamTitle === null) {
143			$bytesToSkip = $interval;
144			if ($attempts === 0) {
145			// The first chunk containing the header may also already contain the beginning of the body,
146			// but this depends on the case. Subtract the body bytes which we already got.
147			$headerEndPos = \strpos($header, "\r\n\r\n") + 4;
148			$bytesToSkip -= \strlen($header) - $headerEndPos;
149			}
150
151			\fseek($fp, $bytesToSkip, SEEK_CUR);
152
153			$streamTitle = self::parseTitleFromStreamMetadata($fp);
154
155			$attempts++;
156			}
157			}
158			} else if ($maxredirect > 0 && \strpos($headers[0], "302 Found") !== false) {
159			$location = self::findStrFollowing($headers, "Location: ");
160			if ($location) {
161			$location = \trim($location, "\r");
162			$streamTitle = $this->readIcyMetadata($location, $maxattempts, $maxredirect-1);
163			}
164			}
165			\fclose($fp);
166			}
167			}
168
169			return $streamTitle === '' ? null : $streamTitle;
170			}
171
172			}
173

owncloud / music

Push — master ( b75966...f85fb3 )

RadioMetadata::fetchStreamData() C

Complexity

Size

Duplication

Importance

1 Method

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like