Merge pull request #54 from KIMB-technologies/logo-cache

Logo cache

.gitignore

@@ -3,5 +3,6 @@
 /php/getr.php
 
 /data/
+/media/
 /redis/
 .DS_Store

Setup.md

@@ -63,7 +63,7 @@ The image of [Radio DNS](https://hub.docker.com/r/kimbtechnologies/radio_dns) is
 		- You may change the folder for cache files to, e.g., a ramdisk. If you do so, use the script `./utils/backup-restore.php` to backup data which is only stored by the cache (using Docker this is done by the cron job).
 		- The proxy feature is provided by PHP, but might be less stable than the NGINX proxy.
 		- The EndURL feature uses the cURL extension of PHP (else it will error!).
-		- Assure, that PHP/ the webserver can write to `./data/` (and the folders configured for logs and cache files)!
+		- Assure, that PHP/ the webserver can write to `./data/` (and the folders configured for logs and cache files)! If you use logo caching, also `./media/` needs to be writable.
 	- Download the lastest source of the *Radio-API* [here](https://github.com/KIMB-technologies/Radio-API/releases/latest).
 	- Extract the zip and place the folder `php` in the web-root of our server (this is our  `./`, other files are not needed).
 	- Configure *Radio-API* in `./data/env.json` (The config values are the same as for the Docker-based mode, always use strings for the values!):
@@ -80,6 +80,7 @@ The image of [Radio DNS](https://hub.docker.com/r/kimbtechnologies/radio_dns) is
 		- `CONF_LOG_DIR` (optional) Change the folder where log files are written to (defaults to `./data/`).
 		- `CONF_CACHE_DIR` (optional) Change the folder used by the file based cache (defaults to `./data/cache/`).
 		- `CONF_IM_EXPORT_TOKEN` (optional) Define a token for use with the Im- & Export web interface *Im- & Export* [↓](#im---export).
+		- `CONF_USE_LOGO_CACHE` (optional, default `false`) Cache logos of radio stations. This will make sure logos are served without https and convert svg file to png (assuming [`rsvg-convert`](https://pkgs.alpinelinux.org/package/v3.19/community/x86_64/rsvg-convert) is available on system). Logos are stored in `./media/`.
 		- **Attention:** Optional parameters have a leading `____` in the default `env.json`, make sure to remove them.
 		- The `CONF_REDIS_*` values are ignored and `CONF_USE_JSON_CACHE` is always `true`.
 	- Make sure, that *Radio-API* is available at port `80` for requests with the hostname `*.wifiradiofrontier.com` and `CONF_DOMAIN`.

VERSION

@@ -1,3 +1,3 @@
-2.8.4
-2.8
+2.9.0
+2.9
 2

docker-compose.dev.yml

@@ -16,6 +16,7 @@ services:
     volumes:
       - ./php/:/php-code/
       - ./data/:/php-code/data/
+      - ./media/:/php-code/media/
       - ./utils/getr.php:/php-code/getr.php:ro # redis all values listing
       - ./utils/backup-restore.php:/backup-restore.php:ro # backup restore tool for cache values
     environment:
@@ -29,6 +30,7 @@ services:
       - CONF_REDIS_HOST=redis
       - CONF_STREAM_JSON=false #http://192.168.0.10:8081/list.json
       - CONF_IM_EXPORT_TOKEN=LP75Djdj195DL8SZnfY3
+      - CONF_USE_LOGO_CACHE=true
     depends_on:
       - redis
   redis:

docker-compose.yml

@@ -8,8 +8,8 @@ services:
     ports:
       - "80:80" # make sure, Radio-API is avaliable at port 80
     volumes:
-      - ./data/:/php-code/data/
-      #- ./media/:/php-code/media/:ro # directory to add images for stations
+      - ./data/:/php-code/data/ # directory storing data, cache, and setting od Radio-API
+      - ./media/:/php-code/media/ # directory storing images for stations
     environment:
       - CONF_DOMAIN=http://radio.example.com/ # the domain where the system is hosted
       # - CONF_RADIO_DOMAIN=http://hama.wifiradiofrontier.com # different domain to use for connections of the radio (if set CONF_DOMAIN is for GUI)
@@ -23,6 +23,7 @@ services:
       - CONF_STREAM_JSON=false # to disable or an url where to fetch list of own streams, e.g., http://stream.example.com/list.json 
       # -CONF_LOG_DIR= # set a custom directory for log files (defaults to ./data/)
       # -CONF_IM_EXPORT_TOKEN= # define a token for use with the im-, export web interface at ./gui/im-export.php
+      - CONF_USE_LOGO_CACHE=true # cache logos (make them accessible without ssl and convert svgs to pngs for the radio, stores files in ./media/)
     depends_on:
       - redis
 

php/classes/Auth.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3

php/classes/Cache.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3

php/classes/Config.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3
@@ -64,7 +64,11 @@
 );
 define(
 	'ENV_USE_JSON_CACHE',
-		!empty($_ENV['CONF_USE_JSON_CACHE']) && $_ENV['CONF_USE_JSON_CACHE'] == 'true'
+		!empty($ENV['CONF_USE_JSON_CACHE']) && $ENV['CONF_USE_JSON_CACHE'] == 'true'
+);
+define(
+	'ENV_USE_LOGO_CACHE',
+		!empty($ENV['CONF_USE_LOGO_CACHE']) && $ENV['CONF_USE_LOGO_CACHE'] == 'true'
 );
 
 // IP on reverse proxy setup
@@ -81,7 +85,7 @@ class Config {
 	/**
 	 * The system's version.
 	 */
-	const VERSION = 'v2.8.4';
+	const VERSION = 'v2.9.0';
 
 	/**
 	 * The real domain which should be used.
@@ -130,6 +134,11 @@ class Config {
 	 */
 	const USE_JSON_CACHE = ENV_USE_JSON_CACHE;
 
+	/**
+	 * Cache logos and make them accessible without ssl.
+	 */
+	const USE_LOGO_CACHE = ENV_USE_LOGO_CACHE;
+
 	/**
 	 * Store redis cache for ALLOWED_DOMAINS
 	 */

php/classes/Data.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3

php/classes/Helper.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3

php/classes/Id.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3

php/classes/ImExport.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3

php/classes/Inner.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3

php/classes/JSONCache.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3

php/classes/Login.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3

php/classes/M3U.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3

php/classes/Output.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3
@@ -21,7 +21,8 @@ class Output {
 		$items = array(),
 		$itemsSortKeys = array(),
 		$prevurl = '',
-		$language;
+		$language,
+		$logo;
 
 	const MAX_ITEMS = 200; // to many items will cause the radio to crash (one could add paging, but until then, we remove too much items)
 
@@ -52,6 +53,7 @@ class Output {
 	 */
 	public function __construct(string $lang = 'eng'){
 		$this->language = array_search($lang, self::ALL_LANGUAGES) ?? 0;
+		$this->logo = new RadioLogo();
 	}
 
 	/**
@@ -65,11 +67,10 @@ public function addStation( int|string $id, string $name, string $url,
 			'StationName' => $this->cleanText($name, true),
 		);
 		if( !$light ){
-			$logo = empty($logo) || substr($logo, 0, 4) != 'http' ? Config::RADIO_DOMAIN . 'media/default.png' : $logo;
 			$b = array(
 				'StationUrl' => $this->cleanUrl($url),
 				'StationDesc' => $this->cleanText($desc),
-				'Logo' => $this->cleanUrl($logo),
+				'Logo' => $this->cleanUrl($this->logo->logoUrl($logo)),
 				'StationFormat' => 'Radio',
 				'StationLocation' => 'Earth',
 				'StationBandWidth' => 32,
@@ -104,12 +105,11 @@ public function addPodcast( int $podcastid, string $name, string $url, int|strin
 	 */
 	public function addEpisode( int $podcastid, int|null $episodeid, string $podcastname, string $episodename,
 						string $url, string $desc = '', string $logo = '', bool $top = false ) : void {
-		$logo = empty($logo) || substr($logo, 0, 4) != 'http' ? Config::RADIO_DOMAIN . 'media/default.png' : $logo;
 		$this->items[] = array(
 			'ItemType' => 'ShowEpisode',
 			'ShowEpisodeID' =>  $podcastid . (!is_null($episodeid) ? 'X' . $episodeid : ''),	
 			'ShowName' => $this->cleanText($podcastname, true),
-			'Logo' => $this->cleanUrl($logo),
+			'Logo' => $this->cleanUrl($this->logo->logoUrl($logo)),
 			'ShowEpisodeName' => $this->cleanText($episodename, true),
 			'ShowEpisodeURL' => $this->cleanUrl($url),
 			'BookmarkShow' => '',

php/classes/OwnStreams.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3

php/classes/PodcastLoader.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3

php/classes/RadioBrowser.php

@@ -3,7 +3,7 @@
  * Radio-API
  * https://github.com/KIMB-technologies/Radio-API
  * 
- * (c) 2019 - 2023 KIMB-technologies 
+ * (c) 2019 - 2024 KIMB-technologies 
  * https://github.com/KIMB-technologies/
  * 
  * released under the terms of GNU Public License Version 3