From 927cb17dbfa7d03283dbad27a4cfa07ebd646f86 Mon Sep 17 00:00:00 2001 From: Joseph Date: Mon, 20 Sep 2021 12:53:41 +0000 Subject: [PATCH] [SoundcloudBridge] Add support for albums, reposts & likes (#2236) --- bridges/SoundcloudBridge.php | 151 ++++++++++++++++++++++++++--------- 1 file changed, 113 insertions(+), 38 deletions(-) diff --git a/bridges/SoundcloudBridge.php b/bridges/SoundcloudBridge.php index fe1e9414..86d069a0 100644 --- a/bridges/SoundcloudBridge.php +++ b/bridges/SoundcloudBridge.php @@ -1,28 +1,36 @@ array( 'name' => 'username', 'required' => true ), 't' => array( - 'name' => 'type', + 'name' => 'Content', 'type' => 'list', 'defaultValue' => 'tracks', 'values' => array( + 'All (except likes)' => 'all', 'Tracks' => 'tracks', - 'Playlists' => 'playlists' + 'Albums' => 'albums', + 'Playlists' => 'playlists', + 'Reposts' => 'reposts', + 'Likes' => 'likes' ) ) )); + private $apiUrl = 'https://api-v2.soundcloud.com/'; + // Without url=http, player URL returns a 404 + private $playerUrl = 'https://w.soundcloud.com/player/?url=http'; + private $widgetUrl = 'https://widget.sndcdn.com/'; + private $feedTitle = null; private $feedIcon = null; private $clientIDCache = null; @@ -30,35 +38,46 @@ class SoundCloudBridge extends BridgeAbstract { private $clientIdRegex = '/client_id.*?"(.+?)"/'; private $widgetRegex = '/widget-.+?\.js/'; - public function collectData(){ - $res = $this->apiGet('resolve', array( - 'url' => 'https://soundcloud.com/' . $this->getInput('u') - )) or returnServerError('No results for this query'); + public function collectData() { + $res = $this->getUser($this->getInput('u')) + or returnServerError('No results for this query'); $this->feedTitle = $res->username; $this->feedIcon = $res->avatar_url; - $tracks = $this->apiGet( - 'users/' . urlencode($res->id) . '/' . $this->getInput('t'), - array('limit' => 31) - ) or returnServerError('No results for this user/playlist'); + $apiItems = $this->getUserItems($res->id, $this->getInput('t')) + or returnServerError('No results for ' . $this->getInput('t')); + + $hasTrackObject = array('all', 'reposts', 'likes'); + + foreach ($apiItems->collection as $index => $apiItem) { + if (in_array($this->getInput('t'), $hasTrackObject) === true) { + $apiItem = $apiItem->track; + } - foreach ($tracks->collection as $index => $track) { $item = array(); - $item['author'] = $track->user->username; - $item['title'] = $track->user->username . ' - ' . $track->title; - $item['timestamp'] = strtotime($track->created_at); - $item['content'] = nl2br($track->description); - $item['enclosures'][] = $track->artwork_url; + $item['author'] = $apiItem->user->username; + $item['title'] = $apiItem->user->username . ' - ' . $apiItem->title; + $item['timestamp'] = strtotime($apiItem->created_at); - $item['id'] = self::URI - . urlencode($this->getInput('u')) - . '/' - . urlencode($track->permalink); - $item['uri'] = self::URI - . urlencode($this->getInput('u')) - . '/' - . urlencode($track->permalink); + $description = nl2br($apiItem->description); + + $item['content'] = <<{$description}

+HTML; + + if (isset($apiItem->tracks) && $apiItem->track_count > 0) { + $list = $this->getTrackList($apiItem->tracks); + + $item['content'] .= <<Tracks ({$apiItem->track_count})

+ {$list} +HTML; + } + + $item['enclosures'][] = $apiItem->artwork_url; + $item['id'] = $apiItem->permalink_url; + $item['uri'] = $apiItem->permalink_url; $this->items[] = $item; if (count($this->items) >= 10) { @@ -75,13 +94,17 @@ class SoundCloudBridge extends BridgeAbstract { return parent::getIcon(); } - public function getURI(){ - return 'https://soundcloud.com/' . $this->getInput('u'); + public function getURI() { + if ($this->getInput('u')) { + return self::URI . $this->getInput('u') . '/' . $this->getInput('t'); + } + + return parent::getURI(); } - public function getName(){ + public function getName() { if($this->feedTitle) { - return $this->feedTitle . ' - ' . self::NAME; + return $this->feedTitle . ' - ' . ucfirst($this->getInput('t')) . ' - ' . self::NAME; } return parent::getName(); @@ -113,8 +136,7 @@ class SoundCloudBridge extends BridgeAbstract { private function refreshClientID(){ $this->initClientIDCache(); - // Without url=http, this returns a 404 - $playerHTML = getContents('https://w.soundcloud.com/player/?url=http') + $playerHTML = getContents($this->playerUrl) or returnServerError('Unable to get player page.'); // Extract widget JS filenames from player page @@ -125,7 +147,7 @@ class SoundCloudBridge extends BridgeAbstract { // Loop widget js files and extract client ID foreach ($matches[0] as $widgetFile) { - $widgetURL = 'https://widget.sndcdn.com/' . $widgetFile; + $widgetURL = $this->widgetUrl . $widgetFile; $widgetJS = getContents($widgetURL) or returnServerError('Unable to get widget JS page.'); @@ -143,22 +165,75 @@ class SoundCloudBridge extends BridgeAbstract { } } - private function buildAPIURL($endpoint, $parameters){ - return 'https://api-v2.soundcloud.com/' + private function buildApiUrl($endpoint, $parameters) { + return $this->apiUrl . $endpoint . '?' . http_build_query($parameters); } - private function apiGet($endpoint, $parameters = array()) { + private function getUser($username) { + $parameters = array('url' => self::URI . $username); + + return $this->getApi('resolve', $parameters); + } + + private function getUserItems($userId, $type) { + $parameters = array('limit' => 10); + $endpoint = 'users/' . $userId . '/' . $type; + + if ($type === 'playlists') { + $endpoint = 'users/' . $userId . '/playlists_without_albums'; + } + + if ($type === 'all') { + $endpoint = 'stream/users/' . $userId; + } + + if ($type === 'reposts') { + $endpoint = 'stream/users/' . $userId . '/' . $type; + } + + return $this->getApi($endpoint, $parameters); + } + + private function getApi($endpoint, $parameters) { $parameters['client_id'] = $this->getClientID(); + $url = $this->buildApiUrl($endpoint, $parameters); try { - return json_decode(getContents($this->buildAPIURL($endpoint, $parameters))); + return json_decode(getContents($url)); } catch (Exception $e) { // Retry once with refreshed client ID $parameters['client_id'] = $this->refreshClientID(); - return json_decode(getContents($this->buildAPIURL($endpoint, $parameters))); + $url = $this->buildApiUrl($endpoint, $parameters); + + return json_decode(getContents($url)); } } + + private function getTrackList($tracks) { + $trackids = ''; + + foreach ($tracks as $track) { + $trackids .= $track->id . ','; + } + + $apiItems = $this->getApi( + 'tracks', array('ids' => $trackids) + ); + + $list = ''; + foreach($apiItems as $track) { + $list .= <<{$track->user->username} — {$track->title} +HTML; + } + + $html = <<{$list} +HTML; + + return $html; + } }