Days to keep is new configuration key

Author: Vitexus

README.md

@@ -3,31 +3,47 @@
 ![cnb-cache](cnb-cache.svg?raw=true)
 
 
-http://localhost/CNB-cache/src/rate.php?currency=eur - todays EUR rate
-http://localhost/CNB-cache/src/rate.php?currency=usd&age=1 - yesterday $ rate
+Installation
+------------
 
 
-## Struktura projektu
+```shell
+sudo apt install lsb-release wget apt-transport-https bzip2
 
-- **src/app.php**: Hlavní logika aplikace, která načítá potřebné knihovny, nastavuje připojení k databázi MultiFlexi, získává kurzovní lístek z API ČNB a ukládá data do JSON souboru.
-- **vendor/**: Adresář obsahující závislosti projektu spravované pomocí Composeru.
-- **composer.json**: Konfigurační soubor pro Composer, obsahující informace o závislostech a dalších nastaveních.
 
-## Instalace
+wget -qO- https://repo.vitexsoftware.com/keyring.gpg | sudo tee /etc/apt/trusted.gpg.d/vitexsoftware.gpg
+echo "deb [signed-by=/etc/apt/trusted.gpg.d/vitexsoftware.gpg]  https://repo.vitexsoftware.com  $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/vitexsoftware.list
+sudo apt update
 
-1. Nainstalujte MultiFlexi podle dokumentace na GitHubu: [MultiFlexi GitHub](https://github.com/VitexSoftware/MultiFlexi).
-2. Nainstalujte závislosti pomocí Composeru:
-   ```
-   composer install
-   ```
+sudo apt install cnb-cache-DATABASE
+```
 
-## Spuštění aplikace
+database can be `mysql` or `sqlite`
 
-Ujistěte se, že máte správně nastavené prostředí a databázi. Poté aplikaci spusťte pomocí příkazu:
-```
-php src/app.php
-```
 
-## Použití
+Support the apache2 and lighthttpd web servers:
+
+![Web Servers](webservers.png?raw=true)
+
+First Configure the currencies to be cached
+
+![Currency Chooser](currency-chooser.png?raw=true)
+
+Then set the days to keep the cache
+
+![Days to Keep](daystokeep.png?raw=true)
+
+And finally the cache is initialized:
+
+![Initialization](init.png?raw=true)
+
+Final configuration is stored in `/etc/cnb-cache/cnb-cache.env` file
+
+After installation the currencies listing is available on the `/cnb-cache/` path.
+
+
+http://localhost/cnb-cache/?currency=eur - todays EUR rate
+http://localhost/cnb-cache/?currency=USD&age=yesterday - yesterday $ rate
+
 
-Před spuštěním aplikace upravte proměnné `$datum` a `$mena` v souboru `src/app.php` podle vašich potřeb. Aplikace stáhne kurzovní lístek pro zadané datum a měnu a uloží jej do souboru `kurzovni_listek.json`.
+The systemd-crond service is started and the cache is updated every day at 0:01 AM

currency-chooser.png

@@ -13,3 +13,7 @@ db_go || true
 db_title Choose currencies to cache
 db_input high cnb-cache/currencies || true
 db_go || true
+
+db_title Number of days to keep cache
+db_input high cnb-cache/keepdays || true
+db_go || true

daystokeep.png

@@ -1,4 +1,5 @@
 src/index.php                            usr/share/cnb-cache
+cnb-cache.svg                            usr/share/cnb-cache
 db/migrations/*				 usr/lib/cnb-cache/db/migrations
 #db/seeds/*				 usr/lib/cnb-cache/db/seeds
 debian/tmp/composer.json                 usr/lib/cnb-cache

debian/cnb-cache.config

@@ -156,6 +156,21 @@ configure)
         fi
     fi
 
+    db_get cnb-cache/keepdays || true
+    keepdays="$RET"
+    db_go || true
+
+    echo "Number of days to keep cache: $keepdays"
+
+    # Update or populate KEEP_DAYS key in /etc/cnb-cache/cnb-cache.env with $keepdays
+    if [ -n "$keepdays" ]; then
+        if grep -q "^KEEP_DAYS=" /etc/cnb-cache/cnb-cache.env; then
+            sed -i "s/^KEEP_DAYS=.*/KEEP_DAYS=\"$keepdays\"/" /etc/cnb-cache/cnb-cache.env
+        else
+            echo "KEEP_DAYS=\"$keepdays\"" >>/etc/cnb-cache/cnb-cache.env
+        fi
+    fi
+
     echo "Initializing cache"
 
 

debian/cnb-cache.install

@@ -18,3 +18,9 @@ Default: USD, EUR
 Choices: AUD, BRL, BGN, CNY, DKK, EUR, PHP, HKD, INR, IDR, ISK, ILS, JPY, ZAR, CAD, KRW, HUF, MYR, MXN, XDR, NOK, NZD, PLN, RON, SGD, SEK, CHF, THB, TRY, USD, GBP
  Description: Currencies to cache:
  Please choose the currencies that should be cached.
+
+Template: cnb-cache/keepdays
+Type: string
+Default: 3
+ Description: Number of days to keep cache:
+ Please enter the number of days to keep cache.

debian/cnb-cache.postinst

@@ -20,28 +20,36 @@
  *
  * @author Vitex <[email protected]>
  */
-class ExchangeRate extends \Ease\SQL\Engine
-{
+class ExchangeRate extends \Ease\SQL\Engine {
+
     public static string $baseUrl = 'https://www.cnb.cz/cs/financni_trhy/devizovy_trh/kurzy_devizoveho_trhu/denni_kurz.txt';
+    private int $keepdays = 3;
     private int $httpcode = 0;
 
     /**
      * @var array<string, string>
      */
     private array $currencies = [];
 
-    public function __construct()
-    {
+    public function __construct() {
         $this->setMyTable('rates');
         $this->setObjectName();
         $currencies = explode(',', str_replace(' ', '', \Ease\Shared::cfg('CURRENCIES', 'EUR')));
         $this->currencies = array_combine($currencies, $currencies);
+        $this->keepdays = intval(\Ease\Shared::cfg('KEEP_DAYS', 3));
         parent::__construct();
     }
 
-    public function exchangeRateRaw(string $datum): string
-    {
-        $url = self::$baseUrl.'?date='.date('d.m.Y', strtotime($datum));
+    public function getCurrencyList(): array {
+        return $this->currencies;
+    }
+
+    public function getKeepDays(): int {
+        return $this->keepdays;
+    }
+
+    public function exchangeRateRaw(string $datum): string {
+        $url = self::$baseUrl . '?date=' . date('d.m.Y', strtotime($datum));
 
         $ch = curl_init();
         curl_setopt($ch, \CURLOPT_URL, $url);
@@ -56,10 +64,9 @@ public function exchangeRateRaw(string $datum): string
     /**
      * Convert CNB CSV to Array.
      *
-     * @return array
+     * @return array<string, array<string, string>>
      */
-    public function cnbCsv2Data(string $ratesRaw)
-    {
+    public function cnbCsv2Data(string $ratesRaw) {
         $data = explode("\n", $ratesRaw);
 
         unset($data[0], $data[1]);
@@ -85,8 +92,7 @@ public function cnbCsv2Data(string $ratesRaw)
      *
      * @return bool
      */
-    public function storeDay(int $dayBack = 0): void
-    {
+    public function storeDay(int $dayBack = 0): void {
         $datum = self::dateBeforeDays($dayBack);
 
         foreach ($this->cnbCsv2Data($this->exchangeRateRaw($datum)) as $currencyData) {
@@ -102,21 +108,21 @@ public function storeDay(int $dayBack = 0): void
         }
     }
 
-    public function renderDay(): void
-    {
+    public function dropOlder(int $days): void {
+        if($this->dropFromSQL(['date' => ['<' => self::dateBeforeDays($days)]]) > 0){
+            $this->addStatusMessage(sprintf(_('Dropped rates older than %d days'), $days), 'success');
+        }
     }
 
-    public function shiftDays(): void
-    {
+    public function shiftDays(): void {
+        $this->dropOlder($this->getKeepDays());
     }
 
-    public function getRateInfo($currency, $age): array
-    {
+    public function getRateInfo($currency, $age): array {
         return $this->getColumnsFromSQL(['*'], ['code' => $currency, 'date' => self::dateBeforeDays($age)]);
     }
 
-    public static function dateBeforeDays(int $daysBack): string
-    {
-        return date('Y-m-d', strtotime('-'.(string) $daysBack.' day'));
+    public static function dateBeforeDays(int $daysBack): string {
+        return date('Y-m-d', strtotime('-' . (string) $daysBack . ' day'));
     }
 }