From db8a3d674da5550dd7562665cbc477c7caec28f7 Mon Sep 17 00:00:00 2001 From: boyska Date: Mon, 4 Mar 2024 15:30:22 +0100 Subject: [PATCH 01/10] [M3uFormat] basic M3U support --- formats/M3uFormat.php | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 formats/M3uFormat.php diff --git a/formats/M3uFormat.php b/formats/M3uFormat.php new file mode 100644 index 00000000..be2895cf --- /dev/null +++ b/formats/M3uFormat.php @@ -0,0 +1,24 @@ +getItems() as $item) { + $itemArray = $item->toArray(); + + if (isset($itemArray['itunes']) && isset($itemArray['enclosure'])) { + $contents .= $itemArray['enclosure']['url'] . "\n"; + } + } + return mb_convert_encoding($contents, $this->getCharset(), 'UTF-8'); + } +} From 36f69af043c5c5d2c3576c9616b70edbe7f78d00 Mon Sep 17 00:00:00 2001 From: boyska Date: Mon, 4 Mar 2024 15:52:05 +0100 Subject: [PATCH 02/10] [M3uFormat] extended M3U formatter --- formats/M3uFormat.php | 54 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 52 insertions(+), 2 deletions(-) diff --git a/formats/M3uFormat.php b/formats/M3uFormat.php index be2895cf..3c580c49 100644 --- a/formats/M3uFormat.php +++ b/formats/M3uFormat.php @@ -15,10 +15,60 @@ class M3uFormat extends FormatAbstract foreach ($this->getItems() as $item) { $itemArray = $item->toArray(); - if (isset($itemArray['itunes']) && isset($itemArray['enclosure'])) { - $contents .= $itemArray['enclosure']['url'] . "\n"; + $m3uitem = new M3uItem(); + + if (isset($itemArray['enclosure'])) { + $m3uitem->url = $itemArray['enclosure']['url']; + $m3uitem->bytes = $itemArray['enclosure']['length']; } + if (isset($itemArray['itunes']) && isset($itemArray['itunes']['duration'])) { + $m3uitem->duration = parse_duration($itemArray['itunes']['duration']); + } + if (isset($itemArray['title'])) { + $m3uitem->title = $itemArray['title']; + } + $contents .= $m3uitem->render(); } return mb_convert_encoding($contents, $this->getCharset(), 'UTF-8'); } } + +function parse_duration($duration_string) +{ + $seconds = 0; + $parts = explode(':', $duration_string); + for ($i = 0; $i < count($parts); $i++) { + $seconds += intval($parts[count($parts) - $i - 1]) * pow(60, $i); + } + return $seconds; +} + +class M3uItem +{ + public $duration = null; + public $title = null; + public $url = null; + public $bytes = null; + + public function render() + { + if ($this->url === null) { + return ''; + } + $text = ''; + $commentParts = []; + if ($this->duration !== null && $this->duration > 0) { + $commentParts[] = $this->duration; + } + if ($this->title !== null) { + $commentParts[] = $this->title; + } + + if (count($commentParts) !== 0) { + $text .= '#EXTINF:' . implode(',', $commentParts) . "\n"; + } + + $text .= $this->url . "\n"; + return $text; + } +} From e4a673aae5ff37533ce635d1f5d1f856f77041e0 Mon Sep 17 00:00:00 2001 From: boyska Date: Tue, 5 Mar 2024 19:54:37 +0100 Subject: [PATCH 03/10] [M3uFormat] type hinting and comments --- formats/M3uFormat.php | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/formats/M3uFormat.php b/formats/M3uFormat.php index 3c580c49..f81a2481 100644 --- a/formats/M3uFormat.php +++ b/formats/M3uFormat.php @@ -33,7 +33,11 @@ class M3uFormat extends FormatAbstract } } -function parse_duration($duration_string) +/* + * parse_duration converts a string like "00:4:20" to 260 + * allowing to convert duration as used in the itunes:duration tag to the number of seconds + */ +function parse_duration(string $duration_string): int { $seconds = 0; $parts = explode(':', $duration_string); @@ -50,7 +54,7 @@ class M3uItem public $url = null; public $bytes = null; - public function render() + public function render(): string { if ($this->url === null) { return ''; From 03652998c86cffdf362711c0f54af395d3a5d44a Mon Sep 17 00:00:00 2001 From: boyska Date: Tue, 5 Mar 2024 19:55:01 +0100 Subject: [PATCH 04/10] [M3uFormat] more readable playlists --- formats/M3uFormat.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/formats/M3uFormat.php b/formats/M3uFormat.php index f81a2481..6c175837 100644 --- a/formats/M3uFormat.php +++ b/formats/M3uFormat.php @@ -59,7 +59,7 @@ class M3uItem if ($this->url === null) { return ''; } - $text = ''; + $text = "\n"; $commentParts = []; if ($this->duration !== null && $this->duration > 0) { $commentParts[] = $this->duration; From 2597cff5e01cb645a8997e85241eb4d4029dbe88 Mon Sep 17 00:00:00 2001 From: boyska Date: Thu, 7 Mar 2024 12:11:14 +0100 Subject: [PATCH 05/10] [M3uFormat] function -> private static method --- formats/M3uFormat.php | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/formats/M3uFormat.php b/formats/M3uFormat.php index 6c175837..a8328cb7 100644 --- a/formats/M3uFormat.php +++ b/formats/M3uFormat.php @@ -22,7 +22,7 @@ class M3uFormat extends FormatAbstract $m3uitem->bytes = $itemArray['enclosure']['length']; } if (isset($itemArray['itunes']) && isset($itemArray['itunes']['duration'])) { - $m3uitem->duration = parse_duration($itemArray['itunes']['duration']); + $m3uitem->duration = self::parseDuration($itemArray['itunes']['duration']); } if (isset($itemArray['title'])) { $m3uitem->title = $itemArray['title']; @@ -31,21 +31,21 @@ class M3uFormat extends FormatAbstract } return mb_convert_encoding($contents, $this->getCharset(), 'UTF-8'); } + /* + * parseDuration converts a string like "00:4:20" to 260 + * allowing to convert duration as used in the itunes:duration tag to the number of seconds + */ + private static function parseDuration(string $duration_string): int + { + $seconds = 0; + $parts = explode(':', $duration_string); + for ($i = 0; $i < count($parts); $i++) { + $seconds += intval($parts[count($parts) - $i - 1]) * pow(60, $i); + } + return $seconds; + } } -/* - * parse_duration converts a string like "00:4:20" to 260 - * allowing to convert duration as used in the itunes:duration tag to the number of seconds - */ -function parse_duration(string $duration_string): int -{ - $seconds = 0; - $parts = explode(':', $duration_string); - for ($i = 0; $i < count($parts); $i++) { - $seconds += intval($parts[count($parts) - $i - 1]) * pow(60, $i); - } - return $seconds; -} class M3uItem { From 624fc8d551faee8bcceedcaa5f9a9568fea54309 Mon Sep 17 00:00:00 2001 From: boyska Date: Thu, 7 Mar 2024 12:26:17 +0100 Subject: [PATCH 06/10] [M3uFormat] add basic m3u tests those are a bit silly, but let's be coherent with other tests --- tests/Formats/M3uFormatTest.php | 29 +++++++++++++++++++ .../samples/expectedM3uFormat/feed.common.m3u | 1 + .../samples/expectedM3uFormat/feed.empty.m3u | 1 + .../expectedM3uFormat/feed.emptyItems.m3u | 1 + .../expectedM3uFormat/feed.microblog.m3u | 1 + 5 files changed, 33 insertions(+) create mode 100644 tests/Formats/M3uFormatTest.php create mode 100644 tests/Formats/samples/expectedM3uFormat/feed.common.m3u create mode 100644 tests/Formats/samples/expectedM3uFormat/feed.empty.m3u create mode 100644 tests/Formats/samples/expectedM3uFormat/feed.emptyItems.m3u create mode 100644 tests/Formats/samples/expectedM3uFormat/feed.microblog.m3u diff --git a/tests/Formats/M3uFormatTest.php b/tests/Formats/M3uFormatTest.php new file mode 100644 index 00000000..22743e66 --- /dev/null +++ b/tests/Formats/M3uFormatTest.php @@ -0,0 +1,29 @@ +formatData('M3u', $this->loadSample($path)); + + $expected = file_get_contents(self::PATH_EXPECTED . $name . '.m3u'); + $this->assertEquals($expected, $data); + } +} + diff --git a/tests/Formats/samples/expectedM3uFormat/feed.common.m3u b/tests/Formats/samples/expectedM3uFormat/feed.common.m3u new file mode 100644 index 00000000..fcd71879 --- /dev/null +++ b/tests/Formats/samples/expectedM3uFormat/feed.common.m3u @@ -0,0 +1 @@ +#EXTM3U diff --git a/tests/Formats/samples/expectedM3uFormat/feed.empty.m3u b/tests/Formats/samples/expectedM3uFormat/feed.empty.m3u new file mode 100644 index 00000000..fcd71879 --- /dev/null +++ b/tests/Formats/samples/expectedM3uFormat/feed.empty.m3u @@ -0,0 +1 @@ +#EXTM3U diff --git a/tests/Formats/samples/expectedM3uFormat/feed.emptyItems.m3u b/tests/Formats/samples/expectedM3uFormat/feed.emptyItems.m3u new file mode 100644 index 00000000..fcd71879 --- /dev/null +++ b/tests/Formats/samples/expectedM3uFormat/feed.emptyItems.m3u @@ -0,0 +1 @@ +#EXTM3U diff --git a/tests/Formats/samples/expectedM3uFormat/feed.microblog.m3u b/tests/Formats/samples/expectedM3uFormat/feed.microblog.m3u new file mode 100644 index 00000000..fcd71879 --- /dev/null +++ b/tests/Formats/samples/expectedM3uFormat/feed.microblog.m3u @@ -0,0 +1 @@ +#EXTM3U From f0fc9a7ae29b14bddd5e9f14cc30b9b0674e8425 Mon Sep 17 00:00:00 2001 From: boyska Date: Thu, 7 Mar 2024 12:41:52 +0100 Subject: [PATCH 07/10] [M3uFormat] small refactoring --- formats/M3uFormat.php | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/formats/M3uFormat.php b/formats/M3uFormat.php index a8328cb7..f2218350 100644 --- a/formats/M3uFormat.php +++ b/formats/M3uFormat.php @@ -54,9 +54,14 @@ class M3uItem public $url = null; public $bytes = null; + public function isEmpty(): bool + { + return $this->url === null; + } + public function render(): string { - if ($this->url === null) { + if ($this->isEmpty()) { return ''; } $text = "\n"; From 2ab615162c8c0b49bc485133f19f9e0584cfa70d Mon Sep 17 00:00:00 2001 From: boyska Date: Thu, 7 Mar 2024 12:42:06 +0100 Subject: [PATCH 08/10] [M3uFormat] supports "enclosures" field --- formats/M3uFormat.php | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/formats/M3uFormat.php b/formats/M3uFormat.php index f2218350..e7bb19ec 100644 --- a/formats/M3uFormat.php +++ b/formats/M3uFormat.php @@ -20,14 +20,25 @@ class M3uFormat extends FormatAbstract if (isset($itemArray['enclosure'])) { $m3uitem->url = $itemArray['enclosure']['url']; $m3uitem->bytes = $itemArray['enclosure']['length']; - } - if (isset($itemArray['itunes']) && isset($itemArray['itunes']['duration'])) { - $m3uitem->duration = self::parseDuration($itemArray['itunes']['duration']); + if (isset($itemArray['itunes']) && isset($itemArray['itunes']['duration'])) { + $m3uitem->duration = self::parseDuration($itemArray['itunes']['duration']); + } } if (isset($itemArray['title'])) { $m3uitem->title = $itemArray['title']; } - $contents .= $m3uitem->render(); + if (! $m3uitem->isEmpty()) { + $contents .= $m3uitem->render(); + } else { + foreach ($item->enclosures as $url) { + $m3uitem = new M3uItem(); + $m3uitem->url = $url; + if (isset($itemArray['title'])) { + $m3uitem->title = $itemArray['title']; + } + $contents .= $m3uitem->render(); + } + } } return mb_convert_encoding($contents, $this->getCharset(), 'UTF-8'); } From c3d4526cd67d3f1783cf253090b670bacf1a8231 Mon Sep 17 00:00:00 2001 From: boyska Date: Thu, 7 Mar 2024 12:42:35 +0100 Subject: [PATCH 09/10] [M3uFormat] more complete test --- tests/Formats/samples/expectedM3uFormat/feed.common.m3u | 3 +++ 1 file changed, 3 insertions(+) diff --git a/tests/Formats/samples/expectedM3uFormat/feed.common.m3u b/tests/Formats/samples/expectedM3uFormat/feed.common.m3u index fcd71879..80199607 100644 --- a/tests/Formats/samples/expectedM3uFormat/feed.common.m3u +++ b/tests/Formats/samples/expectedM3uFormat/feed.common.m3u @@ -1 +1,4 @@ #EXTM3U + +#EXTINF:Atom draft-07 snapshot +http://example.org/audio/ph34r_my_podcast.mp3 From 266a6c01380b3feb0f89e63b5480d46bbffc681c Mon Sep 17 00:00:00 2001 From: boyska Date: Thu, 7 Mar 2024 15:21:23 +0100 Subject: [PATCH 10/10] [M3uFormat] inline all code --- formats/M3uFormat.php | 96 +++++++++++++++++++++---------------------- 1 file changed, 48 insertions(+), 48 deletions(-) diff --git a/formats/M3uFormat.php b/formats/M3uFormat.php index e7bb19ec..50d75c2b 100644 --- a/formats/M3uFormat.php +++ b/formats/M3uFormat.php @@ -7,36 +7,72 @@ class M3uFormat extends FormatAbstract { const MIME_TYPE = 'application/mpegurl'; + private $item_duration = null; + private $item_title = null; + private $item_url = null; + private $item_bytes = null; + + private function resetItem() + { + $this->item_duration = null; + $this->item_title = null; + $this->item_url = null; + $this->item_bytes = null; + } + private function itemIsEmpty(): bool + { + return $this->item_url === null; + } + private function itemRender(): string + { + if ($this->itemIsEmpty()) { + return ''; + } + $text = "\n"; + $commentParts = []; + if ($this->item_duration !== null && $this->item_duration > 0) { + $commentParts[] = $this->item_duration; + } + if ($this->item_title !== null) { + $commentParts[] = $this->item_title; + } + + if (count($commentParts) !== 0) { + $text .= '#EXTINF:' . implode(',', $commentParts) . "\n"; + } + + $text .= $this->item_url . "\n"; + return $text; + } public function stringify() { $contents = "#EXTM3U\n"; foreach ($this->getItems() as $item) { + $this->resetItem(); $itemArray = $item->toArray(); - $m3uitem = new M3uItem(); - if (isset($itemArray['enclosure'])) { - $m3uitem->url = $itemArray['enclosure']['url']; - $m3uitem->bytes = $itemArray['enclosure']['length']; + $this->item_url = $itemArray['enclosure']['url']; + $this->item_bytes = $itemArray['enclosure']['length']; if (isset($itemArray['itunes']) && isset($itemArray['itunes']['duration'])) { - $m3uitem->duration = self::parseDuration($itemArray['itunes']['duration']); + $this->item_duration = self::parseDuration($itemArray['itunes']['duration']); } } if (isset($itemArray['title'])) { - $m3uitem->title = $itemArray['title']; + $item->item_title = $itemArray['title']; } - if (! $m3uitem->isEmpty()) { - $contents .= $m3uitem->render(); + if (! $this->itemIsEmpty()) { + $contents .= $this->itemRender(); } else { foreach ($item->enclosures as $url) { - $m3uitem = new M3uItem(); - $m3uitem->url = $url; + $this->resetItem(); + $this->item_url = $url; if (isset($itemArray['title'])) { - $m3uitem->title = $itemArray['title']; + $this->item_title = $itemArray['title']; } - $contents .= $m3uitem->render(); + $contents .= $this->itemRender(); } } } @@ -56,39 +92,3 @@ class M3uFormat extends FormatAbstract return $seconds; } } - - -class M3uItem -{ - public $duration = null; - public $title = null; - public $url = null; - public $bytes = null; - - public function isEmpty(): bool - { - return $this->url === null; - } - - public function render(): string - { - if ($this->isEmpty()) { - return ''; - } - $text = "\n"; - $commentParts = []; - if ($this->duration !== null && $this->duration > 0) { - $commentParts[] = $this->duration; - } - if ($this->title !== null) { - $commentParts[] = $this->title; - } - - if (count($commentParts) !== 0) { - $text .= '#EXTINF:' . implode(',', $commentParts) . "\n"; - } - - $text .= $this->url . "\n"; - return $text; - } -}