Refactor repository and some commands for upgrading

app/Console/Commands/Upgrade/AccountCurrencies.php

@@ -129,20 +129,7 @@ class AccountCurrencies extends Command
         $accounts = $this->accountRepos->getAccountsByType([AccountType::DEFAULT, AccountType::ASSET]);
 
         // get user's currency preference:
-        $defaultCurrencyCode = app('preferences')->getForUser($user, 'currencyPreference', $systemCurrencyCode)->data;
+        $defaultCurrency = app('amount')->getDefaultCurrencyByUser($user);
-        if (!is_string($defaultCurrencyCode)) {
-            $defaultCurrencyCode = $systemCurrencyCode;
-        }
-
-        /** @var TransactionCurrency|null $defaultCurrency */
-        $defaultCurrency = TransactionCurrency::where('code', $defaultCurrencyCode)->first();
-
-        if (null === $defaultCurrency) {
-            Log::error(sprintf('Users currency pref "%s" does not exist!', $defaultCurrencyCode));
-            $this->friendlyError(sprintf('User has a preference for "%s", but this currency does not exist.', $defaultCurrencyCode));
-
-            return;
-        }
 
         /** @var Account $account */
         foreach ($accounts as $account) {

app/Console/Commands/Upgrade/UpgradeCurrencyPreferences.php

@@ -0,0 +1,153 @@
+<?php
+
+namespace FireflyIII\Console\Commands\Upgrade;
+
+use FireflyIII\Console\Commands\ShowsFriendlyMessages;
+use FireflyIII\Models\Preference;
+use FireflyIII\Models\TransactionCurrency;
+use FireflyIII\Models\UserGroup;
+use FireflyIII\User;
+use Illuminate\Console\Command;
+use Illuminate\Support\Collection;
+
+/**
+ * Class UpgradeCurrencyPreferences
+ * TODO DONT FORGET TO ADD THIS TO THE DOCKER BUILD
+ */
+class UpgradeCurrencyPreferences extends Command
+{
+    use ShowsFriendlyMessages;
+
+    public const CONFIG_NAME = '610_upgrade_currency_prefs';
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Upgrade user currency preferences';
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'firefly-iii:upgrade-currency-preferences {--F|force : Force the execution of this command.}';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle(): int
+    {
+        if ($this->isExecuted() && true !== $this->option('force')) {
+            $this->friendlyInfo('This command has already been executed.');
+
+            return 0;
+        }
+        $this->runUpgrade();
+
+        $this->friendlyPositive('Currency preferences migrated.');
+
+        //$this->markAsExecuted();
+
+        return 0;
+    }
+
+    /**
+     * @return bool
+     */
+    private function isExecuted(): bool
+    {
+        $configVar = app('fireflyconfig')->get(self::CONFIG_NAME, false);
+        if (null !== $configVar) {
+            return (bool)$configVar->data;
+        }
+
+        return false;
+    }
+
+    /**
+     * @param User $user
+     *
+     * @return string
+     */
+    private function getPreference(User $user): string
+    {
+        $preference = Preference::where('user_id', $user->id)->where('name', 'currencyPreference')->first(['id', 'user_id', 'name', 'data', 'updated_at', 'created_at']);
+
+        if (null !== $preference) {
+            return (string)$preference->data;
+        }
+        return 'EUR';
+    }
+
+
+    /**
+     *
+     */
+    private function markAsExecuted(): void
+    {
+        app('fireflyconfig')->set(self::CONFIG_NAME, true);
+    }
+
+    private function runUpgrade(): void
+    {
+        $groups = UserGroup::get();
+        /** @var UserGroup $group */
+        foreach ($groups as $group) {
+            $this->upgradeGroupPreferences($group);
+        }
+
+        $users = User::get();
+        /** @var User $user */
+        foreach ($users as $user) {
+            $this->upgradeUserPreferences($user);
+        }
+    }
+
+    /**
+     * @param User $user
+     *
+     * @return void
+     */
+    private function upgradeUserPreferences(User $user): void
+    {
+        $currencies = TransactionCurrency::get();
+        $enabled    = new Collection();
+        /** @var TransactionCurrency $currency */
+        foreach ($currencies as $currency) {
+            if ($currency->enabled) {
+                $enabled->push($currency);
+            }
+        }
+        $user->currencies()->sync($enabled->pluck('id')->toArray());
+
+        // set the default currency for the user and for the group:
+        $preference      = $this->getPreference($user);
+        $defaultCurrency = TransactionCurrency::where('code', $preference)->first();
+        if (null === $currency) {
+            // get EUR
+            $defaultCurrency = TransactionCurrency::where('code', 'EUR')->first();
+        }
+        $user->currencies()->updateExistingPivot($defaultCurrency->id, ['user_default' => true]);
+        $user->userGroup->currencies()->updateExistingPivot($defaultCurrency->id, ['group_default' => true]);
+    }
+
+    /**
+     * @param UserGroup $group
+     *
+     * @return void
+     */
+    private function upgradeGroupPreferences(UserGroup $group)
+    {
+        $currencies = TransactionCurrency::get();
+        $enabled    = new Collection();
+        /** @var TransactionCurrency $currency */
+        foreach ($currencies as $currency) {
+            if ($currency->enabled) {
+                $enabled->push($currency);
+            }
+        }
+        $group->currencies()->sync($enabled->pluck('id')->toArray());
+    }
+}

app/Console/Commands/Upgrade/UpgradeSkeleton.php.stub

@@ -10,6 +10,7 @@ use Illuminate\Console\Command;
  */
 class UpgradeSkeleton extends Command
 {
+    use ShowsFriendlyMessages;
     public const CONFIG_NAME = '480_some_name';
     /**
      * The console command description.

app/Repositories/Currency/CurrencyRepository.php

@@ -140,8 +140,8 @@ class CurrencyRepository implements CurrencyRepositoryInterface
         }
 
         // is the default currency for the user or the system
-        $defaultCode = app('preferences')->getForUser($this->user, 'currencyPreference', config('firefly.default_currency', 'EUR'))->data;
+        $count = $this->user->currencies()->where('transaction_currencies.id', $currency->id)->wherePivot('user_default', 1)->count();
-        if ($currency->code === $defaultCode) {
+        if ($count > 0) {
             Log::info('Is the default currency of the user, return true.');
 
             return 'current_default';
@@ -226,6 +226,7 @@ class CurrencyRepository implements CurrencyRepositoryInterface
      */
     public function disable(TransactionCurrency $currency): void
     {
+        $this->user->currencies()->detach($currency->id);
         $currency->enabled = false;
         $currency->save();
     }
@@ -236,15 +237,13 @@ class CurrencyRepository implements CurrencyRepositoryInterface
     public function ensureMinimalEnabledCurrencies(): void
     {
         // if no currencies are enabled, enable the first one in the DB (usually the EUR)
-        if (0 === $this->get()->count()) {
+        if (0 === $this->user->currencies()->count()) {
-            /** @var TransactionCurrency $first */
+            $euro = app('amount')->getSystemCurrency();
-            $first = $this->getAll()->first();
+            if (null === $euro) {
-            if (null === $first) {
                 throw new FireflyException('No currencies found. You broke Firefly III');
             }
-            Log::channel('audit')->info(sprintf('Auto-enabled currency %s.', $first->code));
+            Log::channel('audit')->info(sprintf('Auto-enabled currency %s.', $euro->code));
-            $this->enable($first);
+            $this->enable($euro);
-            app('preferences')->set('currencyPreference', $first->code);
             app('preferences')->mark();
         }
     }
@@ -255,7 +254,8 @@ class CurrencyRepository implements CurrencyRepositoryInterface
      */
     public function enable(TransactionCurrency $currency): void
     {
-        $currency->enabled = true;
+        $this->user->currencies()->syncWithoutDetaching([$currency->id]);
+        $currency->enabled = false;
         $currency->save();
     }
 
@@ -462,6 +462,14 @@ class CurrencyRepository implements CurrencyRepositoryInterface
         return null;
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function getUserCurrencies(User $user): Collection
+    {
+        return $user->currencies()->get();
+    }
+
     /**
      * @inheritDoc
      */
@@ -527,6 +535,7 @@ class CurrencyRepository implements CurrencyRepositoryInterface
      */
     public function store(array $data): TransactionCurrency
     {
+        throw new FireflyException(sprintf('Method "%s" needs a refactor.', __METHOD__));
         /** @var TransactionCurrencyFactory $factory */
         $factory = app(TransactionCurrencyFactory::class);
         $result  = $factory->create($data);
@@ -546,9 +555,61 @@ class CurrencyRepository implements CurrencyRepositoryInterface
      */
     public function update(TransactionCurrency $currency, array $data): TransactionCurrency
     {
+        app('log')->debug('Now in update()');
+        // can be true, false, null
+        $enabled = array_key_exists('enabled', $data) ? $data['enabled'] : null;
+        // can be true, false, but method only responds to "true".
+        $default = array_key_exists('default', $data) ? $data['default'] : false;
+
+        // remove illegal combo's:
+        if (false === $enabled && true === $default) {
+            $enabled = true;
+        }
+        if (false === $default) {
+            app('log')->warning(sprintf('Set default=false will NOT do anything for currency %s', $currency->code));
+        }
+
+        // update currency with current user specific settings
+        $currency->refreshForUser($this->user);
+
+        // currency is enabled, must be disabled.
+        if (false === $enabled) {
+            app('log')->debug(sprintf('Disabled currency %s for user #%d', $currency->code, $this->user->id));
+            $this->user->currencies()->detach($currency->id);
+        }
+        // currency must be enabled
+        if (true === $enabled) {
+            app('log')->debug(sprintf('Enabled currency %s for user #%d', $currency->code, $this->user->id));
+            $this->user->currencies()->detach($currency->id);
+            $this->user->currencies()->syncWithoutDetaching([$currency->id => ['user_default' => false]]);
+        }
+
+        // currency must be made default.
+        if (true === $default) {
+            app('log')->debug(sprintf('Enabled + made default currency %s for user #%d', $currency->code, $this->user->id));
+            $this->user->currencies()->detach($currency->id);
+            foreach ($this->user->currencies()->get() as $item) {
+                $this->user->currencies()->updateExistingPivot($item->id, ['user_default' => false]);
+            }
+            $this->user->currencies()->syncWithoutDetaching([$currency->id => ['user_default' => true]]);
+        }
+
         /** @var CurrencyUpdateService $service */
         $service = app(CurrencyUpdateService::class);
 
         return $service->update($currency, $data);
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function makeDefault(TransactionCurrency $currency): void
+    {
+        app('log')->debug(sprintf('Enabled + made default currency %s for user #%d', $currency->code, $this->user->id));
+        $this->user->currencies()->detach($currency->id);
+        foreach ($this->user->currencies()->get() as $item) {
+            $this->user->currencies()->updateExistingPivot($item->id, ['user_default' => false]);
+        }
+        $this->user->currencies()->syncWithoutDetaching([$currency->id => ['user_default' => true]]);
+    }
 }

app/Repositories/Currency/CurrencyRepositoryInterface.php

@@ -204,6 +204,20 @@ interface CurrencyRepositoryInterface
      */
     public function getExchangeRate(TransactionCurrency $fromCurrency, TransactionCurrency $toCurrency, Carbon $date): ?CurrencyExchangeRate;
 
+    /**
+     * @param TransactionCurrency $currency
+     *
+     * @return void
+     */
+    public function makeDefault(TransactionCurrency $currency): void;
+
+    /**
+     * @param User $user
+     *
+     * @return Collection
+     */
+    public function getUserCurrencies(User $user): Collection;
+
     /**
      * @param TransactionCurrency $currency
      *

app/Services/Internal/Update/CurrencyUpdateService.php

@@ -52,14 +52,13 @@ class CurrencyUpdateService
             $currency->name = e($data['name']);
         }
 
-        if (array_key_exists('enabled', $data) && is_bool($data['enabled'])) {
+        $currency->enabled = false;
-            $currency->enabled = (bool)$data['enabled'];
-        }
 
         if (array_key_exists('decimal_places', $data) && is_int($data['decimal_places'])) {
             $currency->decimal_places = (int)$data['decimal_places'];
         }
-
+        unset($currency->userEnabled);
+        unset($currency->userDefault);
         $currency->save();
 
         return $currency;