diff --git a/plugin/SqueezeESP32.zip b/plugin/SqueezeESP32.zip index f9bb8cf0..9180a8fa 100644 Binary files a/plugin/SqueezeESP32.zip and b/plugin/SqueezeESP32.zip differ diff --git a/plugin/SqueezeESP32/FirmwareHelper.pm b/plugin/SqueezeESP32/FirmwareHelper.pm new file mode 100644 index 00000000..3f0c192e --- /dev/null +++ b/plugin/SqueezeESP32/FirmwareHelper.pm @@ -0,0 +1,237 @@ +package Plugins::SqueezeESP32::FirmwareHelper; + +use strict; + +use File::Basename qw(basename); +use File::Spec::Functions qw(catfile); +use JSON::XS::VersionOneAndTwo; + +use Slim::Utils::Log; +use Slim::Utils::Prefs; + +use constant FIRMWARE_POLL_INTERVAL => 3600 * (5 + rand()); +use constant GITHUB_RELEASES_URI => "https://api.github.com/repos/sle118/squeezelite-esp32/releases"; +use constant GITHUB_ASSET_URI => GITHUB_RELEASES_URI . "/assets/"; +use constant GITHUB_DOWNLOAD_URI => "https://github.com/sle118/squeezelite-esp32/releases/download/"; +my $FW_DOWNLOAD_ID_REGEX = qr|plugins/SqueezeESP32/firmware/(-?\d+)|; +my $FW_DOWNLOAD_REGEX = qr|plugins/SqueezeESP32/firmware/([-a-z0-9-/.]+\.bin)$|i; +my $FW_FILENAME_REGEX = qr/^squeezelite-esp32-.*\.bin(\.tmp)?$/; +my $FW_TAG_REGEX = qr/\/(ESP32-A1S|SqueezeAmp|I2S-4MFlash)\.(16|32)\.(\d+)\.(.*)\//; + +my $prefs = preferences('plugin.squeezeesp32'); +my $log = logger('plugin.squeezeesp32'); + +sub init { + Slim::Web::Pages->addRawFunction($FW_DOWNLOAD_ID_REGEX, \&handleFirmwareDownload); + Slim::Web::Pages->addRawFunction($FW_DOWNLOAD_REGEX, \&handleFirmwareDownloadDirect); + + # start checking for firmware updates + Slim::Utils::Timers::setTimer(undef, Time::HiRes::time() + 30 + rand(30), \&prefetchFirmware); +} + +sub prefetchFirmware { + Slim::Utils::Timers::killTimers(undef, \&prefetchFirmware); + my $releaseInfo = $prefs->get('lastReleaseTagUsed'); + + Slim::Networking::SimpleAsyncHTTP->new( + sub { + my $http = shift; + my $content = eval { from_json( $http->content ) }; + + if (!$content || !ref $content) { + $@ && $log->error("Failed to parse response: $@"); + } + + my $regex = $releaseInfo->{model} . '\.' . $releaseInfo->{res} . '\.\d+\.' . $releaseInfo->{branch}; + my $url; + foreach (@$content) { + if ($_->{tag_name} =~ /$regex/ && $_->{assets} && ref $_->{assets}) { + ($url) = grep /\.bin$/, map { + $_->{browser_download_url} + } @{$_->{assets}}; + + last if $url; + } + } + + downloadFirmwareFile(sub { + main::INFOLOG && $log->is_info && $log->info("Pre-cached firmware file: " . $_[0]); + }, sub { + my ($http, $error, $url, $code) = @_; + $error ||= ($http && $http->error) || 'unknown error'; + $url ||= ($http && $http->url) || 'no URL'; + + $log->error(sprintf("Failed to get firmware image from Github: %s (%s)", $error || $http->error, $url)); + }, $url) if $url && $url =~ /^https?/; + + }, + sub { + my ($http, $error) = @_; + $log->error("Failed to get releases from Github: $error"); + }, + { + timeout => 10, + cache => 1, + expires => 3600 + } + )->get(GITHUB_RELEASES_URI) if $releaseInfo; + + Slim::Utils::Timers::setTimer(undef, Time::HiRes::time() + FIRMWARE_POLL_INTERVAL, \&prefetchFirmware); +} + +sub handleFirmwareDownload { + my ($httpClient, $response) = @_; + + my $request = $response->request; + + my $_errorDownloading = sub { + _errorDownloading($httpClient, $response, @_); + }; + + my $id; + if (!defined $request || !(($id) = $request->uri =~ $FW_DOWNLOAD_ID_REGEX)) { + return $_errorDownloading->(undef, 'Invalid request', $request->uri, 400); + } + + # this is the magic number used on the client to figure out whether the plugin does support download proxying + if ($id == -99) { + $response->code(204); + $response->header('Access-Control-Allow-Origin' => '*'); + + $httpClient->send_response($response); + return Slim::Web::HTTP::closeHTTPSocket($httpClient); + } + + Slim::Networking::SimpleAsyncHTTP->new( + sub { + my $http = shift; + my $content = eval { from_json( $http->content ) }; + + if (!$content || !ref $content) { + $@ && $log->error("Failed to parse response: $@"); + return $_errorDownloading->($http); + } + elsif (!$content->{browser_download_url} || !$content->{name}) { + return $_errorDownloading->($http, 'No download URL found'); + } + + downloadFirmwareFile(sub { + my $firmwareFile = shift; + $response->code(200); + Slim::Web::HTTP::sendStreamingFile($httpClient, $response, 'application/octet-stream', $firmwareFile, undef, 1); + }, $_errorDownloading, $content->{browser_download_url}, $content->{name}); + }, + $_errorDownloading, + { + timeout => 10, + cache => 1, + expires => 86400 + } + )->get(GITHUB_ASSET_URI . $id); + + return; +} + +sub handleFirmwareDownloadDirect { + my ($httpClient, $response) = @_; + + my $request = $response->request; + + my $_errorDownloading = sub { + _errorDownloading($httpClient, $response, @_); + }; + + my $path; + if (!defined $request || !(($path) = $request->uri =~ $FW_DOWNLOAD_REGEX)) { + return $_errorDownloading->(undef, 'Invalid request', $request->uri, 400); + } + + main::INFOLOG && $log->is_info && $log->info("Requesting firmware from: $path"); + + downloadFirmwareFile(sub { + my $firmwareFile = shift; + $response->code(200); + Slim::Web::HTTP::sendStreamingFile($httpClient, $response, 'application/octet-stream', $firmwareFile, undef, 1); + }, $_errorDownloading, GITHUB_DOWNLOAD_URI . $path); +} + +sub downloadFirmwareFile { + my ($cb, $ecb, $url, $name) = @_; + + # keep track of the last firmware we requested, to prefetch it in the future + _getFirmwareTag($url); + + $name ||= basename($url); + + if ($name !~ $FW_FILENAME_REGEX) { + return $ecb->(undef, 'Unexpected firmware image name: ' . $name, $url, 400); + } + + my $updatesDir = Slim::Utils::OSDetect::dirsFor('updates'); + my $firmwareFile = catfile($updatesDir, $name); + Slim::Utils::Misc::deleteFiles($updatesDir, $FW_FILENAME_REGEX, $firmwareFile); + + if (-f $firmwareFile) { + main::INFOLOG && $log->is_info && $log->info("Found cached firmware file"); + return $cb->($firmwareFile); + } + + Slim::Networking::SimpleAsyncHTTP->new( + sub { + my $http = shift; + + if ($http->code != 200 || !-e "$firmwareFile.tmp") { + return $ecb->($http, $http->mess); + } + + rename "$firmwareFile.tmp", $firmwareFile or return $ecb->($http, "Unable to rename temporary $firmwareFile file" ); + + return $cb->($firmwareFile); + }, + $ecb, + { + saveAs => "$firmwareFile.tmp", + } + )->get($url); + + return; +} + +sub _getFirmwareTag { + my ($url) = @_; + + if (my ($model, $resolution, $version, $branch) = $url =~ $FW_TAG_REGEX) { + my $releaseInfo = { + model => $model, + res => $resolution, + version => $version, + branch => $branch + }; + + $prefs->set('lastReleaseTagUsed', $releaseInfo); + + return $releaseInfo; + } +} + +sub _errorDownloading { + my ($httpClient, $response, $http, $error, $url, $code) = @_; + + $error ||= ($http && $http->error) || 'unknown error'; + $url ||= ($http && $http->url) || 'no URL'; + $code ||= ($http && $http->code) || 500; + + $log->error(sprintf("Failed to get data from Github: %s (%s)", $error || $http->error, $url)); + + $response->headers->remove_content_headers; + $response->code($code); + $response->content_type('text/plain'); + $response->header('Connection' => 'close'); + $response->content(''); + + $httpClient->send_response($response); + Slim::Web::HTTP::closeHTTPSocket($httpClient); +}; + + +1; \ No newline at end of file diff --git a/plugin/SqueezeESP32/Player.pm b/plugin/SqueezeESP32/Player.pm index 158d1395..d82b3b5c 100644 --- a/plugin/SqueezeESP32/Player.pm +++ b/plugin/SqueezeESP32/Player.pm @@ -343,4 +343,9 @@ sub lineInOutStatus { } } +sub voltage { + my $voltage = Slim::Networking::Slimproto::voltage(shift) || return 0; + return sprintf("%.2f", ($voltage >> 4) / 128); +} + 1; diff --git a/plugin/SqueezeESP32/Plugin.pm b/plugin/SqueezeESP32/Plugin.pm index 9ba733a6..6614c179 100644 --- a/plugin/SqueezeESP32/Plugin.pm +++ b/plugin/SqueezeESP32/Plugin.pm @@ -3,14 +3,13 @@ package Plugins::SqueezeESP32::Plugin; use strict; use base qw(Slim::Plugin::Base); -use File::Basename qw(basename); -use File::Spec::Functions qw(catfile); -use JSON::XS::VersionOneAndTwo; use Slim::Utils::Prefs; use Slim::Utils::Log; use Slim::Web::ImageProxy; +use Plugins::SqueezeESP32::FirmwareHelper; + my $prefs = preferences('plugin.squeezeesp32'); my $log = Slim::Utils::Log->addLogCategory({ @@ -19,12 +18,6 @@ my $log = Slim::Utils::Log->addLogCategory({ 'description' => 'PLUGIN_SQUEEZEESP32', }); -use constant GITHUB_ASSET_URI => "https://api.github.com/repos/sle118/squeezelite-esp32/releases/assets/"; -use constant GITHUB_DOWNLOAD_URI => "https://github.com/sle118/squeezelite-esp32/releases/download/"; -my $FW_DOWNLOAD_ID_REGEX = qr|plugins/SqueezeESP32/firmware/(-?\d+)|; -my $FW_DOWNLOAD_REGEX = qr|plugins/SqueezeESP32/firmware/([-a-z0-9-/.]+\.bin)$|i; -my $FW_FILENAME_REGEX = qr/^squeezelite-esp32-.*\.bin(\.tmp)?$/; - # migrate 'eq' pref, as that's a reserved word and could cause problems in the future $prefs->migrateClient(1, sub { my ($cprefs, $client) = @_; @@ -68,8 +61,7 @@ sub initPlugin { Slim::Control::Request::subscribe( sub { onNotification(@_) }, [ ['playlist'], ['open', 'newsong'] ]); Slim::Control::Request::subscribe( \&onStopClear, [ ['playlist'], ['stop', 'clear'] ]); - Slim::Web::Pages->addRawFunction($FW_DOWNLOAD_ID_REGEX, \&handleFirmwareDownload); - Slim::Web::Pages->addRawFunction($FW_DOWNLOAD_REGEX, \&handleFirmwareDownloadDirect); + Plugins::SqueezeESP32::FirmwareHelper->init(); } sub onStopClear { @@ -111,137 +103,4 @@ sub setEQ { $client->send_equalizer(\@eqParams); } -sub handleFirmwareDownload { - my ($httpClient, $response) = @_; - - my $request = $response->request; - - my $_errorDownloading = sub { - _errorDownloading($httpClient, $response, @_); - }; - - my $id; - if (!defined $request || !(($id) = $request->uri =~ $FW_DOWNLOAD_ID_REGEX)) { - return $_errorDownloading->(undef, 'Invalid request', $request->uri, 400); - } - - # this is the magic number used on the client to figure out whether the plugin does support download proxying - if ($id == -99) { - $response->code(204); - $response->header('Access-Control-Allow-Origin' => '*'); - - $httpClient->send_response($response); - return Slim::Web::HTTP::closeHTTPSocket($httpClient); - } - - Slim::Networking::SimpleAsyncHTTP->new( - sub { - my $http = shift; - my $content = eval { from_json( $http->content ) }; - - if (!$content || !ref $content) { - $@ && $log->error("Failed to parse response: $@"); - return $_errorDownloading->($http); - } - elsif (!$content->{browser_download_url} || !$content->{name}) { - return $_errorDownloading->($http, 'No download URL found'); - } - - downloadAndStreamFirmware($httpClient, $response, $content->{browser_download_url}, $content->{name}); - }, - $_errorDownloading, - { - timeout => 10, - cache => 1, - expires => 86400 - } - )->get(GITHUB_ASSET_URI . $id); - - return; -} - -sub handleFirmwareDownloadDirect { - my ($httpClient, $response) = @_; - - my $request = $response->request; - - my $_errorDownloading = sub { - _errorDownloading($httpClient, $response, @_); - }; - - my $path; - if (!defined $request || !(($path) = $request->uri =~ $FW_DOWNLOAD_REGEX)) { - return $_errorDownloading->(undef, 'Invalid request', $request->uri, 400); - } - - main::INFOLOG && $log->is_info && $log->info("Requesting firmware from: $path"); - - downloadAndStreamFirmware($httpClient, $response, GITHUB_DOWNLOAD_URI . $path); -} - -sub downloadAndStreamFirmware { - my ($httpClient, $response, $url, $name) = @_; - - my $_errorDownloading = sub { - _errorDownloading($httpClient, $response, @_); - }; - - $name ||= basename($url); - - if ($name !~ $FW_FILENAME_REGEX) { - return $_errorDownloading->(undef, 'Unexpected firmware image name: ' . $name, $url, 400); - } - - my $updatesDir = Slim::Utils::OSDetect::dirsFor('updates'); - my $firmwareFile = catfile($updatesDir, $name); - Slim::Utils::Misc::deleteFiles($updatesDir, $FW_FILENAME_REGEX, $firmwareFile); - - if (-f $firmwareFile) { - main::INFOLOG && $log->is_info && $log->info("Found cached firmware version"); - $response->code(200); - return Slim::Web::HTTP::sendStreamingFile($httpClient, $response, 'application/octet-stream', $firmwareFile, undef, 1); - } - - Slim::Networking::SimpleAsyncHTTP->new( - sub { - my $http = shift; - - if ($http->code != 200 || !-e "$firmwareFile.tmp") { - return $_errorDownloading->($http, $http->mess); - } - - rename "$firmwareFile.tmp", $firmwareFile or return $_errorDownloading->($http, "Unable to rename temporary $firmwareFile file" ); - - $response->code(200); - Slim::Web::HTTP::sendStreamingFile($httpClient, $response, 'application/octet-stream', $firmwareFile, undef, 1); - }, - $_errorDownloading, - { - saveAs => "$firmwareFile.tmp", - } - )->get($url); - - return; -} - -sub _errorDownloading { - my ($httpClient, $response, $http, $error, $url, $code) = @_; - - $error ||= ($http && $http->error) || 'unknown error'; - $url ||= ($http && $http->url) || 'no URL'; - $code ||= ($http && $http->code) || 500; - - $log->error(sprintf("Failed to get data from Github: %s (%s)", $error || $http->error, $url)); - - $response->headers->remove_content_headers; - $response->code($code); - $response->content_type('text/plain'); - $response->header('Connection' => 'close'); - $response->content(''); - - $httpClient->send_response($response); - Slim::Web::HTTP::closeHTTPSocket($httpClient); -}; - - 1; diff --git a/plugin/SqueezeESP32/install.xml b/plugin/SqueezeESP32/install.xml index 56551748..44753dce 100644 --- a/plugin/SqueezeESP32/install.xml +++ b/plugin/SqueezeESP32/install.xml @@ -10,6 +10,6 @@ PLUGIN_SQUEEZEESP32 PLUGIN_SQUEEZEESP32_DESC Plugins::SqueezeESP32::Plugin - 0.300 + 0.310 Philippe diff --git a/plugin/repo.xml b/plugin/repo.xml index 3a473e19..4e6770bd 100644 --- a/plugin/repo.xml +++ b/plugin/repo.xml @@ -1,10 +1,10 @@ - + https://github.com/sle118/squeezelite-esp32 Philippe - 0763bf75e2c8e7d535d50959916053d865ce2c4d + 39e70a87ce903cc8651e6b3bb2dc86609a8d0541 philippe_44@outlook.com SqueezeESP32 additional player id (100) http://github.com/sle118/squeezelite-esp32/raw/master/plugin/SqueezeESP32.zip