mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-09-20 19:35:16 +00:00
New cronjob code.
This commit is contained in:
65
app/Console/Commands/Cron.php
Normal file
65
app/Console/Commands/Cron.php
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace FireflyIII\Console\Commands;
|
||||||
|
|
||||||
|
use FireflyIII\Exceptions\FireflyException;
|
||||||
|
use FireflyIII\Support\Cronjobs\RecurringCronjob;
|
||||||
|
use Illuminate\Console\Command;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class Cron
|
||||||
|
*/
|
||||||
|
class Cron extends Command
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* The console command description.
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
protected $description = 'Runs all Firefly III cron-job related commands. Configure a cron job according to the official Firefly III documentation.';
|
||||||
|
/**
|
||||||
|
* The name and signature of the console command.
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
protected $signature = 'firefly:cron';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new command instance.
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function __construct()
|
||||||
|
{
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Execute the console command.
|
||||||
|
*
|
||||||
|
* @return mixed
|
||||||
|
*/
|
||||||
|
public function handle(): int
|
||||||
|
{
|
||||||
|
$recurring = new RecurringCronjob;
|
||||||
|
try {
|
||||||
|
$result = $recurring->fire();
|
||||||
|
} catch (FireflyException $e) {
|
||||||
|
$this->error($e->getMessage());
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
if (false === $result) {
|
||||||
|
$this->line('The recurring transaction cron job did not fire.');
|
||||||
|
}
|
||||||
|
if (true === $result) {
|
||||||
|
$this->line('The recurring transaction cron job fired successfully.');
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->info('More feedback on the cron jobs can be found in the log files.');
|
||||||
|
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
}
|
@@ -52,6 +52,18 @@ class Kernel extends ConsoleKernel
|
|||||||
*/
|
*/
|
||||||
protected function schedule(Schedule $schedule): void
|
protected function schedule(Schedule $schedule): void
|
||||||
{
|
{
|
||||||
$schedule->job(new CreateRecurringTransactions(new Carbon))->daily();
|
$schedule->call(function() {
|
||||||
|
echo "\n";
|
||||||
|
echo '------------';
|
||||||
|
echo "\n";
|
||||||
|
echo wordwrap('Firefly III no longer users the Laravel scheduler to do cron jobs! Please read the instructions here:');
|
||||||
|
echo "\n";
|
||||||
|
echo 'https://firefly-iii.readthedocs.io/en/latest/';
|
||||||
|
echo "\n\n";
|
||||||
|
echo 'Disable this cron job!';
|
||||||
|
echo "\n";
|
||||||
|
echo '------------';
|
||||||
|
echo "\n";
|
||||||
|
})->everyMinute();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
65
app/Http/Controllers/System/CronController.php
Normal file
65
app/Http/Controllers/System/CronController.php
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* CronController.php
|
||||||
|
* Copyright (c) 2018 thegrumpydictator@gmail.com
|
||||||
|
*
|
||||||
|
* This file is part of Firefly III.
|
||||||
|
*
|
||||||
|
* Firefly III is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* (at your option) any later version.
|
||||||
|
*
|
||||||
|
* Firefly III is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace FireflyIII\Http\Controllers\System;
|
||||||
|
|
||||||
|
use FireflyIII\Exceptions\FireflyException;
|
||||||
|
use FireflyIII\Support\Cronjobs\RecurringCronjob;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class CronController
|
||||||
|
*/
|
||||||
|
class CronController
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @param string $token
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function cron(string $token): string
|
||||||
|
{
|
||||||
|
$results = [];
|
||||||
|
$results[] = $this->runRecurring();
|
||||||
|
|
||||||
|
return implode("<br>\n", $results);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
private function runRecurring(): string
|
||||||
|
{
|
||||||
|
$recurring = new RecurringCronjob;
|
||||||
|
try {
|
||||||
|
$result = $recurring->fire();
|
||||||
|
} catch (FireflyException $e) {
|
||||||
|
return $e->getMessage();
|
||||||
|
}
|
||||||
|
if (false === $result) {
|
||||||
|
return 'The recurring transaction cron job did not fire.';
|
||||||
|
}
|
||||||
|
|
||||||
|
return 'The recurring transaction cron job fired successfully.';
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -90,6 +90,14 @@ class Kernel extends HttpKernel
|
|||||||
CreateFreshApiToken::class,
|
CreateFreshApiToken::class,
|
||||||
],
|
],
|
||||||
|
|
||||||
|
// only the basic variable binders.
|
||||||
|
'binders-only' => [
|
||||||
|
Installer::class,
|
||||||
|
EncryptCookies::class,
|
||||||
|
AddQueuedCookiesToResponse::class,
|
||||||
|
Binder::class,
|
||||||
|
],
|
||||||
|
|
||||||
// MUST NOT be logged in. Does not care about 2FA or confirmation.
|
// MUST NOT be logged in. Does not care about 2FA or confirmation.
|
||||||
'user-not-logged-in' => [
|
'user-not-logged-in' => [
|
||||||
Installer::class,
|
Installer::class,
|
||||||
|
62
app/Support/Binder/CLIToken.php
Normal file
62
app/Support/Binder/CLIToken.php
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* CLIToken.php
|
||||||
|
* Copyright (c) 2018 thegrumpydictator@gmail.com
|
||||||
|
*
|
||||||
|
* This file is part of Firefly III.
|
||||||
|
*
|
||||||
|
* Firefly III is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* (at your option) any later version.
|
||||||
|
*
|
||||||
|
* Firefly III is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace FireflyIII\Support\Binder;
|
||||||
|
|
||||||
|
use FireflyIII\Repositories\User\UserRepositoryInterface;
|
||||||
|
use Illuminate\Routing\Route;
|
||||||
|
use Illuminate\Support\Collection;
|
||||||
|
use Log;
|
||||||
|
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class CLIToken
|
||||||
|
*/
|
||||||
|
class CLIToken implements BinderInterface
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $value
|
||||||
|
* @param Route $route
|
||||||
|
*
|
||||||
|
* @return mixed
|
||||||
|
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
|
||||||
|
*/
|
||||||
|
public static function routeBinder(string $value, Route $route)
|
||||||
|
{
|
||||||
|
/** @var UserRepositoryInterface $repository */
|
||||||
|
$repository = app(UserRepositoryInterface::class);
|
||||||
|
/** @var Collection $users */
|
||||||
|
$users = $repository->all();
|
||||||
|
|
||||||
|
foreach ($users as $user) {
|
||||||
|
$accessToken = app('preferences')->getForUser($user, 'access_token', null);
|
||||||
|
if ($accessToken->data === $value) {
|
||||||
|
Log::info(sprintf('Recognized user #%d (%s) from his acccess token.', $user->id, $user->email));
|
||||||
|
|
||||||
|
return $value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
throw new NotFoundHttpException;
|
||||||
|
}
|
||||||
|
}
|
39
app/Support/Cronjobs/AbstractCronjob.php
Normal file
39
app/Support/Cronjobs/AbstractCronjob.php
Normal file
@@ -0,0 +1,39 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* AbstractCronjob.php
|
||||||
|
* Copyright (c) 2018 thegrumpydictator@gmail.com
|
||||||
|
*
|
||||||
|
* This file is part of Firefly III.
|
||||||
|
*
|
||||||
|
* Firefly III is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* (at your option) any later version.
|
||||||
|
*
|
||||||
|
* Firefly III is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace FireflyIII\Support\Cronjobs;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class AbstractCronjob
|
||||||
|
*/
|
||||||
|
abstract class AbstractCronjob
|
||||||
|
{
|
||||||
|
/** @var int */
|
||||||
|
public $timeBetweenRuns = 43200;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
abstract public function fire(): bool;
|
||||||
|
|
||||||
|
}
|
84
app/Support/Cronjobs/RecurringCronjob.php
Normal file
84
app/Support/Cronjobs/RecurringCronjob.php
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* RecurringCronjob.php
|
||||||
|
* Copyright (c) 2018 thegrumpydictator@gmail.com
|
||||||
|
*
|
||||||
|
* This file is part of Firefly III.
|
||||||
|
*
|
||||||
|
* Firefly III is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* (at your option) any later version.
|
||||||
|
*
|
||||||
|
* Firefly III is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace FireflyIII\Support\Cronjobs;
|
||||||
|
|
||||||
|
use Carbon\Carbon;
|
||||||
|
use FireflyIII\Exceptions\FireflyException;
|
||||||
|
use FireflyIII\Jobs\CreateRecurringTransactions;
|
||||||
|
use FireflyIII\Models\Configuration;
|
||||||
|
use Log;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Class RecurringCronjob
|
||||||
|
*/
|
||||||
|
class RecurringCronjob extends AbstractCronjob
|
||||||
|
{
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return bool
|
||||||
|
* @throws FireflyException
|
||||||
|
*/
|
||||||
|
public function fire(): bool
|
||||||
|
{
|
||||||
|
/** @var Configuration $config */
|
||||||
|
$config = app('fireflyconfig')->get('last_rt_job', 0);
|
||||||
|
$lastTime = (int)$config->data;
|
||||||
|
$diff = time() - $lastTime;
|
||||||
|
$diffForHumans = Carbon::now()->diffForHumans(Carbon::createFromTimestamp($lastTime), true);
|
||||||
|
if (0 === $lastTime) {
|
||||||
|
Log::info('Recurring transactions cronjob has never fired before.');
|
||||||
|
}
|
||||||
|
// less than half a day ago:
|
||||||
|
if ($lastTime > 0 && $diff <= 43200) {
|
||||||
|
Log::info(sprintf('It has been %s since the recurring transactions cronjob has fired. It will not fire now.', $diffForHumans));
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($lastTime > 0 && $diff > 43200) {
|
||||||
|
Log::info(sprintf('It has been %s since the recurring transactions cronjob has fired. It will fire now!', $diffForHumans));
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$this->fireRecurring();
|
||||||
|
} catch (FireflyException $e) {
|
||||||
|
Log::error($e->getMessage());
|
||||||
|
Log::error($e->getTraceAsString());
|
||||||
|
throw new FireflyException(sprintf('Could not run recurring transaction cron job: %s', $e->getMessage()));
|
||||||
|
}
|
||||||
|
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
*
|
||||||
|
* @throws FireflyException
|
||||||
|
*/
|
||||||
|
private function fireRecurring(): void
|
||||||
|
{
|
||||||
|
$job = new CreateRecurringTransactions(new Carbon);
|
||||||
|
$job->handle();
|
||||||
|
app('fireflyconfig')->set('last_rt_job', time());
|
||||||
|
}
|
||||||
|
}
|
@@ -307,6 +307,7 @@ return [
|
|||||||
'fromCurrencyCode' => \FireflyIII\Support\Binder\CurrencyCode::class,
|
'fromCurrencyCode' => \FireflyIII\Support\Binder\CurrencyCode::class,
|
||||||
'toCurrencyCode' => \FireflyIII\Support\Binder\CurrencyCode::class,
|
'toCurrencyCode' => \FireflyIII\Support\Binder\CurrencyCode::class,
|
||||||
'unfinishedJournal' => \FireflyIII\Support\Binder\UnfinishedJournal::class,
|
'unfinishedJournal' => \FireflyIII\Support\Binder\UnfinishedJournal::class,
|
||||||
|
'cliToken' => \FireflyIII\Support\Binder\CLIToken::class,
|
||||||
|
|
||||||
|
|
||||||
],
|
],
|
||||||
|
@@ -33,6 +33,12 @@ Route::group(
|
|||||||
}
|
}
|
||||||
);
|
);
|
||||||
|
|
||||||
|
Route::group(
|
||||||
|
['middleware' => 'binders-only','namespace' => 'FireflyIII\Http\Controllers\System', 'as' => 'cron.', 'prefix' => 'cron'], function () {
|
||||||
|
Route::get('run/{cliToken}', ['uses' => 'CronController@cron', 'as' => 'cron']);
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* These routes only work when the user is NOT logged in.
|
* These routes only work when the user is NOT logged in.
|
||||||
*/
|
*/
|
||||||
|
Reference in New Issue
Block a user