fix: replace console messages with unified command.

This commit is contained in:
James Cole
2023-06-20 07:16:56 +02:00
parent f2b2c2109f
commit 42043de34f
62 changed files with 767 additions and 512 deletions

View File

@@ -24,6 +24,7 @@ declare(strict_types=1);
namespace FireflyIII\Console\Commands\Integrity;
use FireflyIII\Console\Commands\ShowsFriendlyMessages;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\GroupMembership;
use FireflyIII\Models\UserGroup;
@@ -37,6 +38,8 @@ use Illuminate\Support\Facades\Log;
*/
class CreateGroupMemberships extends Command
{
use ShowsFriendlyMessages;
public const CONFIG_NAME = '560_create_group_memberships';
protected $description = 'Update group memberships';
protected $signature = 'firefly-iii:create-group-memberships';
@@ -88,7 +91,7 @@ class CreateGroupMemberships extends Command
public function handle(): int
{
$this->createGroupMemberships();
$this->info('Correct: validated group memberships');
$this->friendlyPositive('Validated group memberships');
return 0;
}

View File

@@ -23,6 +23,7 @@ declare(strict_types=1);
namespace FireflyIII\Console\Commands\Integrity;
use FireflyIII\Console\Commands\ShowsFriendlyMessages;
use FireflyIII\Models\Account;
use FireflyIII\Models\Budget;
use FireflyIII\Models\Category;
@@ -35,6 +36,8 @@ use stdClass;
*/
class ReportEmptyObjects extends Command
{
use ShowsFriendlyMessages;
/**
* The console command description.
*
@@ -81,7 +84,7 @@ class ReportEmptyObjects extends Command
foreach ($set as $entry) {
$line = 'User #%d (%s) has account #%d ("%s") which has no transactions.';
$line = sprintf($line, $entry->user_id, $entry->email, $entry->id, $entry->name);
$this->line($line);
$this->friendlyWarning($line);
}
}
@@ -105,7 +108,7 @@ class ReportEmptyObjects extends Command
$entry->id,
$entry->name
);
$this->line($line);
$this->friendlyWarning($line);
}
}
@@ -130,7 +133,7 @@ class ReportEmptyObjects extends Command
$entry->id,
$entry->name
);
$this->line($line);
$this->friendlyWarning($line);
}
}
@@ -155,7 +158,7 @@ class ReportEmptyObjects extends Command
$entry->id,
$entry->name
);
$this->line($line);
$this->friendlyWarning($line);
}
}
@@ -180,7 +183,7 @@ class ReportEmptyObjects extends Command
$entry->id,
$entry->tag
);
$this->line($line);
$this->friendlyWarning($line);
}
}
}

View File

@@ -24,6 +24,7 @@ declare(strict_types=1);
namespace FireflyIII\Console\Commands\Integrity;
use Artisan;
use FireflyIII\Console\Commands\ShowsFriendlyMessages;
use Illuminate\Console\Command;
use Schema;
@@ -34,6 +35,8 @@ use Schema;
*/
class ReportIntegrity extends Command
{
use ShowsFriendlyMessages;
/**
* The console command description.
*
@@ -63,7 +66,7 @@ class ReportIntegrity extends Command
'firefly-iii:upgrade-group-information',
];
foreach ($commands as $command) {
$this->line(sprintf('Now executing %s', $command));
$this->friendlyLine(sprintf('Now executing %s', $command));
$this->call($command);
}

View File

@@ -23,6 +23,7 @@ declare(strict_types=1);
namespace FireflyIII\Console\Commands\Integrity;
use FireflyIII\Console\Commands\ShowsFriendlyMessages;
use FireflyIII\Repositories\User\UserRepositoryInterface;
use FireflyIII\User;
use Illuminate\Console\Command;
@@ -32,6 +33,8 @@ use Illuminate\Console\Command;
*/
class ReportSum extends Command
{
use ShowsFriendlyMessages;
protected $description = 'Report on the total sum of transactions. Must be 0.';
protected $signature = 'firefly-iii:report-sum';
@@ -60,15 +63,15 @@ class ReportSum extends Command
$sum = (string)$user->transactions()->sum('amount');
if (!is_numeric($sum)) {
$message = sprintf('Error: Transactions for user #%d (%s) have an invalid sum ("%s").', $user->id, $user->email, $sum);
$this->error($message);
$this->friendlyError($message);
continue;
}
if (0 !== bccomp($sum, '0')) {
$message = sprintf('Error: Transactions for user #%d (%s) are off by %s!', $user->id, $user->email, $sum);
$this->error($message);
$this->friendlyError($message);
}
if (0 === bccomp($sum, '0')) {
$this->info(sprintf('Correct: Amount integrity OK for user #%d', $user->id));
$this->friendlyPositive(sprintf('Amount integrity OK for user #%d', $user->id));
}
}
}

View File

@@ -24,6 +24,7 @@ declare(strict_types=1);
namespace FireflyIII\Console\Commands\Integrity;
use FireflyIII\Console\Commands\ShowsFriendlyMessages;
use FireflyIII\Support\System\OAuthKeys;
use Illuminate\Console\Command;
@@ -32,6 +33,8 @@ use Illuminate\Console\Command;
*/
class RestoreOAuthKeys extends Command
{
use ShowsFriendlyMessages;
protected $description = 'Will restore the OAuth keys generated for the system.';
protected $signature = 'firefly-iii:restore-oauth-keys';
@@ -87,30 +90,30 @@ class RestoreOAuthKeys extends Command
if (!$this->keysInDatabase() && !$this->keysOnDrive()) {
$this->generateKeys();
$this->storeKeysInDB();
$this->line('Correct: generated and stored new keys.');
$this->friendlyInfo('Generated and stored new keys.');
return;
}
if ($this->keysInDatabase() && !$this->keysOnDrive()) {
$result = $this->restoreKeysFromDB();
if (true === $result) {
$this->line('Correct: restored OAuth keys from database.');
$this->friendlyInfo('Restored OAuth keys from database.');
return;
}
$this->generateKeys();
$this->storeKeysInDB();
$this->line('Correct: generated and stored new keys.');
$this->friendlyInfo('Generated and stored new keys.');
return;
}
if (!$this->keysInDatabase() && $this->keysOnDrive()) {
$this->storeKeysInDB();
$this->line('Correct: stored OAuth keys in database.');
$this->friendlyInfo('Stored OAuth keys in database.');
return;
}
$this->line('Correct: OAuth keys are OK');
$this->friendlyPositive('OAuth keys are OK');
}
/**

View File

@@ -24,6 +24,7 @@ declare(strict_types=1);
namespace FireflyIII\Console\Commands\Integrity;
use FireflyIII\Console\Commands\ShowsFriendlyMessages;
use FireflyIII\Models\Account;
use FireflyIII\Models\Attachment;
use FireflyIII\Models\AvailableBudget;
@@ -48,6 +49,8 @@ use Illuminate\Database\QueryException;
*/
class UpdateGroupInformation extends Command
{
use ShowsFriendlyMessages;
protected $description = 'Makes sure that every object is linked to a group';
protected $signature = 'firefly-iii:upgrade-group-information';
@@ -74,7 +77,7 @@ class UpdateGroupInformation extends Command
{
$group = $user->userGroup;
if (null === $group) {
$this->warn(sprintf('User "%s" has no group.', $user->email));
$this->friendlyWarning(sprintf('User "%s" has no group.', $user->email));
return;
}
@@ -111,12 +114,12 @@ class UpdateGroupInformation extends Command
try {
$result = $className::where('user_id', $user->id)->where('user_group_id', null)->update(['user_group_id' => $group->id]);
} catch (QueryException $e) {
$this->error(sprintf('Could not update group information for "%s" because of error "%s"', $className, $e->getMessage()));
$this->friendlyError(sprintf('Could not update group information for "%s" because of error "%s"', $className, $e->getMessage()));
return;
}
if (0 !== $result) {
$this->info(sprintf('Correct: Moved %d %s objects to the correct group.', $result, str_replace('FireflyIII\\Models\\', '', $className)));
$this->friendlyPositive(sprintf('Moved %d %s objects to the correct group.', $result, str_replace('FireflyIII\\Models\\', '', $className)));
}
}
}