feat: improve cache, refactor code, add api key support

.gitignore

@@ -7,6 +7,10 @@
 # Coingecko export data
 /coingecko.json
 /coingecko-original.json
+/coingecko-currencies.json
+
+# Secret files
+/secrets.php
 
 # Compiled files
 /js/

README.md

@@ -117,6 +117,18 @@ return [
 ];
 ```
 
+Create a `secrets.php` file in the root directory to store CoinGecko API keys. Example:
+
+```php
+<?php
+return [
+	'coingecko_api_key' => 'CG-xxxx',
+	'coingecko_key_is_demo' => true,
+];
+```
+
+**Note:** The `secrets.dist.php` file should not be accessible from the web server.
+
 ### Fetching Exchange Rates
 
 Exchange rates are fetched from the CoinGecko API. The `coingecko.php` file handles the API requests and attempts to update exchange rates every 5 seconds. Due to the rate limits of the CoinGecko API, actual update intervals may vary and are closer to 60 seconds.

coingecko.php

@@ -6,77 +6,120 @@ date_default_timezone_set('Europe/Berlin');
 // Define currencies that should *not* be included in the list
 $excludedCurrencies = ['bits', 'sats'];
 
-// Fetch the previously stored data
-$previousData = json_decode(file_get_contents("coingecko.json"), true);
-$output = $previousData;
-
-$currentTime = time();
-
-// Check if five seconds have passed since the last update
-if (($currentTime - $previousData['time']) >= 5) {
-    // Fetch the available currencies from CoinGecko API
-    $availableCurrenciesApi = "https://api.coingecko.com/api/v3/simple/supported_vs_currencies";
-
-    $currenciesCh = curl_init($availableCurrenciesApi);
-    curl_setopt($currenciesCh, CURLOPT_RETURNTRANSFER, true);
-    $availableCurrenciesJson = curl_exec($currenciesCh);
-
-    $currenciesHttpCode = curl_getinfo($currenciesCh, CURLINFO_HTTP_CODE);
-
-    curl_close($currenciesCh);
-
-    if ($currenciesHttpCode == 200) {
-        $availableCurrencies = json_decode($availableCurrenciesJson, true);
-    } else {
-        $availableCurrencies = array_keys($previousData);
-        unset($availableCurrencies[array_search('time', $availableCurrencies)]);
+// Fetch JSON data from a file and decode it
+function fetchJson($filename) {
+    return json_decode(file_get_contents($filename), true);
 }
 
-    // Remove excluded currencies
-    $availableCurrencies = array_diff($availableCurrencies, $excludedCurrencies);
-
-    $currencies = array_map('strtoupper', $availableCurrencies);
-
-    // Fetch the latest data from CoinGecko API
-    $apiUrl = 'https://api.coingecko.com/api/v3/simple/price?ids=monero&vs_currencies=' . implode('%2C', array_map('strtolower', $currencies)) . '&include_market_cap=true&include_24hr_vol=true&include_24hr_change=true&include_last_updated_at=true';
-
-    $ch = curl_init($apiUrl);
+// Make an API request and return the JSON response
+function makeApiRequest($url) {
+    $ch = curl_init($url);
     curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
     $json = curl_exec($ch);
-
     $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
     curl_close($ch);
 
-    // If the request worked and was not rate-limited
     if ($httpCode == 200) {
-        // Decode the fetched data
-        $fetchedData = json_decode($json, true);
-        $moneroData = $fetchedData['monero'];
+        return json_decode($json, true);
+    }
 
-        // Initialize new data array
+    return null;
+}
+
+// Get CoinGecko key URL parameter
+function getCoinGeckoApiUrl($path, $params = []) {
+    $secrets = require_once 'secrets.php';
+    $key = $secrets['coingecko_api_key'];
+    $demo = $secrets['coingecko_key_is_demo'];
+
+    $paramName = $demo ? 'x_cg_demo_api_key' : 'x_cg_pro_api_key';
+    $baseUrl = $demo ? "https://api.coingecko.com/api/v3/" : "https://pro-api.coingecko.com/api/v3/";
+
+    $params[$paramName] = $key;
+    $url = $baseUrl . $path;
+
+    if (!empty($params)) {
+        $url .= '?' . http_build_query($params);
+    }
+
+    return $url;
+}
+
+$currentTime = time();
+
+// Fetch list of available currencies from CoinGecko API
+// Available currencies are cached for 24 hours
+function fetchAvailableCurrencies() {
+    $cacheFile = 'coingecko-currencies.json';
+    $cacheTime = 86400;
+
+    // Return cached data if it exists and is less than 24 hours old
+    if (file_exists($cacheFile) && (time() - filemtime($cacheFile) < $cacheTime)) {
+        return fetchJson($cacheFile);
+    }
+
+    $apiUrl = getCoinGeckoApiUrl('simple/supported_vs_currencies');
+    $data = makeApiRequest($apiUrl);
+
+    if ($data) {
+        file_put_contents($cacheFile, json_encode($data, JSON_PRETTY_PRINT));
+        return $data;
+    }
+
+    return null;
+}
+
+// Fetch currency data from CoinGecko API
+function fetchCurrencyData($currencies) {
+    $apiUrl = getCoinGeckoApiUrl('simple/price', ['ids' => 'monero', 'vs_currencies' => implode(',', array_map('strtolower', $currencies))]);
+    return makeApiRequest($apiUrl);
+}
+
+$currencyFile = 'coingecko.json';
+$originalFile = 'coingecko-original.json';
+
+// Function to process currency data
+function processCurrencyData($availableCurrencies, $previousData, $currentTime, $excludedCurrencies) {
+    // Remove excluded currencies
+    $availableCurrencies = array_diff($availableCurrencies, $excludedCurrencies);
+    $currencies = array_map('strtoupper', $availableCurrencies);
+
+    // Fetch the latest data from CoinGecko API
+    $fetchedData = fetchCurrencyData($currencies);
+
+    if ($fetchedData) {
+        $moneroData = $fetchedData['monero'];
         $newData = ['time' => $currentTime];
 
         // Update the data for each currency
         foreach ($currencies as $currency) {
             $currencyLower = strtolower($currency);
-            if (isset($moneroData[$currencyLower])) {
             $newData[$currencyLower] = [
-                    'lastValue' => $moneroData[$currencyLower],
+                'lastValue' => $moneroData[$currencyLower] ?? $previousData[$currencyLower]['lastValue'] ?? null,
                 'lastDate' => $currentTime
             ];
-            } else {
-                $newData[$currencyLower] = [
-                    'lastValue' => $previousData[$currencyLower]['lastValue'] ?? null,
-                    'lastDate' => $previousData[$currencyLower]['lastDate'] ?? null
-                ];
-            }
         }
 
-        // Save the new data to JSON files
-        file_put_contents("coingecko.json", json_encode($newData, JSON_PRETTY_PRINT));
-        file_put_contents("coingecko-original.json", json_encode($moneroData, JSON_PRETTY_PRINT));
+        return $newData;
+    }
 
-        $output = $newData;
+    return null;
+}
+
+$previousData = fetchJson($currencyFile);
+$output = $previousData;
+
+// Check if five seconds have passed since the last update
+if (($currentTime - $previousData['time']) >= 5) {
+    $availableCurrencies = fetchAvailableCurrencies();
+    if ($availableCurrencies !== null) {
+        $output = processCurrencyData($availableCurrencies, $previousData, $currentTime, $excludedCurrencies);
+
+        // Save the data if the API call was successful
+        if ($output !== null) {
+            file_put_contents($currencyFile, json_encode($output, JSON_PRETTY_PRINT));
+            file_put_contents($originalFile, json_encode($output, JSON_PRETTY_PRINT));
+        }
     }
 }
 

secrets.dist.php

@@ -0,0 +1,5 @@
+<?php
+return [
+	'coingecko_api_key' => 'CG-xxxx',
+	'coingecko_key_is_demo' => true,
+];