kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2026-05-03 20:56:21 +00:00
Code Issues Projects Releases Wiki Activity

Implement first version of the new rule engine.

Browse Source
This commit is contained in:
James Cole
2020-08-22 16:55:54 +02:00
parent 14df37712c
commit 216a0a186c
12 changed files with 825 additions and 586 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
app/TransactionRules/Actions/ActionInterface.php
View File

@@ -45,4 +45,12 @@ interface ActionInterface
* @return bool
*/
public function act(TransactionJournal $journal): bool;
/**
* Execute the action on an array.
*
* @param array $journal
* @return bool
*/
public function actOnArray(array $journal): bool;
}

44
app/TransactionRules/Actions/AddTag.php
View File

@@ -22,9 +22,11 @@ declare(strict_types=1);
namespace FireflyIII\TransactionRules\Actions;
use DB;
use FireflyIII\Factory\TagFactory;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\User;
use Log;
/**
@@ -32,8 +34,7 @@ use Log;
*/
class AddTag implements ActionInterface
{
/** @var RuleAction The rule action */
private $action;
private RuleAction $action;
/**
* TriggerInterface constructor.
@@ -46,11 +47,8 @@ class AddTag implements ActionInterface
}
/**
* Add a tag
*
* @param TransactionJournal $journal
*
* @return bool
* @inheritDoc
* @deprecated
*/
public function act(TransactionJournal $journal): bool
{
@@ -77,4 +75,36 @@ class AddTag implements ActionInterface
return false;
}
/**
* @inheritDoc
*/
public function actOnArray(array $journal): bool
{
// journal has this tag maybe?
/** @var TagFactory $factory */
$factory = app(TagFactory::class);
$factory->setUser(User::find($journal['user_id']));
$tag = $factory->findOrCreate($this->action->action_value);
if (null === $tag) {
// could not find, could not create tag.
Log::error(sprintf('RuleAction AddTag. Could not find or create tag "%s"', $this->action->action_value));
return false;
}
$count = DB::table('tag_transaction_journal')
->where('tag_id', $tag->id)
->where('transaction_journal_id', $journal['transaction_journal_id'])
->count();
if (0 === $count) {
// add to journal:
DB::table('tag_transaction_journal')->insert(['tag_id' => $tag->id, 'transaction_journal_id' => $journal['transaction_journal_id']]);
Log::debug(sprintf('RuleAction AddTag. Added tag #%d ("%s") to journal %d.', $tag->id, $tag->tag, $journal['transaction_journal_id']));
return true;
}
Log::debug(sprintf('RuleAction AddTag fired but tag %d ("%s") was already added to journal %d.', $tag->id, $tag->tag, $journal['transaction_journal_id']));
return false;
}
}

10
app/TransactionRules/Engine/RuleEngineInterface.php
View File

@@ -21,6 +21,7 @@
namespace FireflyIII\TransactionRules\Engine;
use FireflyIII\User;
use Illuminate\Support\Collection;
/**
@@ -28,6 +29,10 @@ use Illuminate\Support\Collection;
*/
interface RuleEngineInterface
{
/**
* @param User $user
*/
public function setUser(User $user): void;
/**
* Add rules for the engine to execute.
*
@@ -49,4 +54,9 @@ interface RuleEngineInterface
*/
public function addOperator(array $operator): void;
/**
* Fire the rule engine.
*/
public function fire(): void;
}

169
app/TransactionRules/Engine/SearchRuleEngine.php
View File

@@ -21,10 +21,179 @@
namespace FireflyIII\TransactionRules\Engine;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\Rule;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\RuleTrigger;
use FireflyIII\Support\Search\SearchInterface;
use FireflyIII\TransactionRules\Factory\ActionFactory;
use FireflyIII\User;
use Illuminate\Support\Collection;
use Log;
/**
* Class SearchRuleEngine
*/
class SearchRuleEngine implements RuleEngineInterface
{
private User $user;
private Collection $rules;
private array $operators;
public function __construct()
{
$this->rules = new Collection;
}
/**
* @inheritDoc
*/
public function setUser(User $user): void
{
$this->user = $user;
$this->operators = [];
}
/**
* @inheritDoc
*/
public function setRules(Collection $rules): void
{
foreach ($rules as $rule) {
if ($rule instanceof Rule) {
Log::debug(sprintf('Adding a rule to the SearchRuleEngine: #%d ("%s")', $rule->id, $rule->title));
$this->rules->push($rule);
}
}
}
/**
* @inheritDoc
*/
public function setRuleGroups(Collection $ruleGroups): void
{
die(__METHOD__);
}
/**
* @inheritDoc
*/
public function addOperator(array $operator): void
{
Log::debug('Add operator: ', $operator);
$this->operators[] = $operator;
}
/**
* @inheritDoc
* @throws FireflyException
*/
public function fire(): void
{
Log::debug('SearchRuleEngine::fire()!');
foreach ($this->rules as $rule) {
$this->fireRule($rule);
}
}
/**
* @param Rule $rule
* @throws FireflyException
*/
private function fireRule(Rule $rule): void
{
$searchArray = [];
/** @var RuleTrigger $ruleTrigger */
foreach ($rule->ruleTriggers as $ruleTrigger) {
$searchArray[$ruleTrigger->trigger_type] = sprintf('"%s"', $ruleTrigger->trigger_value);
}
// add local operators:
foreach ($this->operators as $operator) {
$searchArray[$operator['type']] = sprintf('"%s"', $operator['value']);
}
$toJoin = [];
foreach ($searchArray as $type => $value) {
$toJoin[] = sprintf('%s:%s', $type, $value);
}
$searchQuery = join(' ', $toJoin);
Log::debug(sprintf('Search query for rule #%d ("%s") = %s', $rule->id, $rule->title, $searchQuery));
// build and run the search engine.
$searchEngine = app(SearchInterface::class);
$searchEngine->setUser($this->user);
$searchEngine->setPage(1);
$searchEngine->setLimit(1337);
$searchEngine->parseQuery($searchQuery);
$result = $searchEngine->searchTransactions();
$collection = $result->getCollection();
Log::debug(sprintf('Found %d transactions using search engine.', $collection->count()));
$this->processResults($rule, $collection);
}
/**
* @param Rule $rule
* @param Collection $collection
* @throws FireflyException
*/
private function processResults(Rule $rule, Collection $collection): void
{
Log::debug('Going to process results.');
/** @var array $group */
foreach ($collection as $group) {
$this->processTransactionGroup($rule, $group);
}
}
/**
* @param Rule $rule
* @param array $group
* @throws FireflyException
*/
private function processTransactionGroup(Rule $rule, array $group): void
{
Log::debug(sprintf('Will now execute actions on transaction group #%d', $group['id']));
/** @var array $transaction */
foreach ($group['transactions'] as $transaction) {
$this->processTransactionJournal($rule, $transaction);
}
}
/**
* @param Rule $rule
* @param array $transaction
* @throws FireflyException
*/
private function processTransactionJournal(Rule $rule, array $transaction): void
{
Log::debug(sprintf('Will now execute actions on transaction journal #%d', $transaction['transaction_journal_id']));
/** @var RuleAction $ruleAction */
foreach ($rule->ruleActions as $ruleAction) {
$break = $this->processRuleAction($ruleAction, $transaction);
if (true === $break) {
break;
}
}
}
/**
* @param RuleAction $ruleAction
* @param array $transaction
* @return bool
* @throws FireflyException
*/
private function processRuleAction(RuleAction $ruleAction, array $transaction): bool
{
Log::debug(sprintf('Executing rule action "%s" with value "%s"', $ruleAction->action_type, $ruleAction->action_value));
$actionClass = ActionFactory::getAction($ruleAction);
$actionClass->actOnArray($transaction);
if ($ruleAction->stop_processing) {
Log::debug(sprintf('Rule action "%s" asks to break, so break!', $ruleAction->action_value));
return true;
}
return false;
}
}