kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-12 23:45:10 +00:00
Code Issues Projects Releases Wiki Activity

Expand webhook API, edit and create screen.

Browse Source
This commit is contained in:
James Cole
2025-08-20 06:22:55 +02:00
parent 293be04d40
commit 01cce49070
18 changed files with 421 additions and 232 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
app/Api/V1/Controllers/Webhook/ShowController.php
View File

@@ -126,6 +126,13 @@ class ShowController extends Controller
Log::channel('audit')->info(sprintf('User views webhook #%d.', $webhook->id)); Log::channel('audit')->info(sprintf('User views webhook #%d.', $webhook->id));
$manager = $this->getManager(); $manager = $this->getManager();
// enrich
/** @var User $admin */
$admin = auth()->user();
$enrichment = new WebhookEnrichment();
$enrichment->setUser($admin);
$webhook = $enrichment->enrichSingle($webhook);
/** @var WebhookTransformer $transformer */ /** @var WebhookTransformer $transformer */
$transformer = app(WebhookTransformer::class); $transformer = app(WebhookTransformer::class);
$transformer->setParameters($this->parameters); $transformer->setParameters($this->parameters);

11
app/Api/V1/Controllers/Webhook/StoreController.php
View File

@@ -27,7 +27,9 @@ namespace FireflyIII\Api\V1\Controllers\Webhook;
use FireflyIII\Api\V1\Controllers\Controller; use FireflyIII\Api\V1\Controllers\Controller;
use FireflyIII\Api\V1\Requests\Models\Webhook\CreateRequest; use FireflyIII\Api\V1\Requests\Models\Webhook\CreateRequest;
use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface; use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface;
use FireflyIII\Support\JsonApi\Enrichments\WebhookEnrichment;
use FireflyIII\Transformers\WebhookTransformer; use FireflyIII\Transformers\WebhookTransformer;
use FireflyIII\User;
use Illuminate\Http\JsonResponse; use Illuminate\Http\JsonResponse;
use Illuminate\Support\Facades\Log; use Illuminate\Support\Facades\Log;
use League\Fractal\Resource\Item; use League\Fractal\Resource\Item;
@@ -68,6 +70,15 @@ class StoreController extends Controller
} }
$webhook = $this->repository->store($data); $webhook = $this->repository->store($data);
// enrich
/** @var User $admin */
$admin = auth()->user();
$enrichment = new WebhookEnrichment();
$enrichment->setUser($admin);
$webhook = $enrichment->enrichSingle($webhook);
$manager = $this->getManager(); $manager = $this->getManager();
Log::channel('audit')->info('User stores new webhook', $data); Log::channel('audit')->info('User stores new webhook', $data);

27
app/Api/V1/Controllers/Webhook/UpdateController.php
View File

@@ -24,15 +24,17 @@ declare(strict_types=1);
namespace FireflyIII\Api\V1\Controllers\Webhook; namespace FireflyIII\Api\V1\Controllers\Webhook;
use FireflyIII\Api\V1\Controllers\Controller; use FireflyIII\Api\V1\Controllers\Controller;
use FireflyIII\Api\V1\Requests\Models\Webhook\UpdateRequest; use FireflyIII\Api\V1\Requests\Models\Webhook\UpdateRequest;
use FireflyIII\Models\Webhook; use FireflyIII\Models\Webhook;
use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface; use FireflyIII\Repositories\Webhook\WebhookRepositoryInterface;
use FireflyIII\Transformers\WebhookTransformer; use FireflyIII\Support\JsonApi\Enrichments\WebhookEnrichment;
use Illuminate\Http\JsonResponse; use FireflyIII\Transformers\WebhookTransformer;
use Illuminate\Support\Facades\Log; use FireflyIII\User;
use League\Fractal\Resource\Item; use Illuminate\Http\JsonResponse;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; use Illuminate\Support\Facades\Log;
use League\Fractal\Resource\Item;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
/** /**
* Class UpdateController * Class UpdateController
@@ -70,6 +72,13 @@ class UpdateController extends Controller
$webhook = $this->repository->update($webhook, $data); $webhook = $this->repository->update($webhook, $data);
$manager = $this->getManager(); $manager = $this->getManager();
// enrich
/** @var User $admin */
$admin = auth()->user();
$enrichment = new WebhookEnrichment();
$enrichment->setUser($admin);
$webhook = $enrichment->enrichSingle($webhook);
Log::channel('audit')->info(sprintf('User updates webhook #%d', $webhook->id), $data); Log::channel('audit')->info(sprintf('User updates webhook #%d', $webhook->id), $data);
/** @var WebhookTransformer $transformer */ /** @var WebhookTransformer $transformer */

114
app/Api/V1/Requests/Models/Webhook/CreateRequest.php
View File

@@ -24,8 +24,7 @@ declare(strict_types=1);
namespace FireflyIII\Api\V1\Requests\Models\Webhook; namespace FireflyIII\Api\V1\Requests\Models\Webhook;
use FireflyIII\Enums\WebhookResponse; use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Enums\WebhookTrigger;
use FireflyIII\Models\Webhook; use FireflyIII\Models\Webhook;
use FireflyIII\Rules\IsBoolean; use FireflyIII\Rules\IsBoolean;
use FireflyIII\Support\Request\ChecksLogin; use FireflyIII\Support\Request\ChecksLogin;
@@ -44,24 +43,24 @@ class CreateRequest extends FormRequest
public function getData(): array public function getData(): array
{ {
$triggers = Webhook::getTriggersForValidation(); $fields = [
$responses = Webhook::getResponsesForValidation(); 'title' => ['title', 'convertString'],
$deliveries = Webhook::getDeliveriesForValidation(); 'active' => ['active', 'boolean'],
'url' => ['url', 'convertString'],
$fields = [
'title' => ['title', 'convertString'],
'active' => ['active', 'boolean'],
'trigger' => ['trigger', 'convertString'],
'response' => ['response', 'convertString'],
'delivery' => ['delivery', 'convertString'],
'url' => ['url', 'convertString'],
]; ];
$triggers = $this->get('triggers', []);
$responses = $this->get('responses', []);
$deliveries = $this->get('deliveries', []);
// this is the way. if (0 === count($triggers) || 0 === count($responses) || 0 === count($deliveries)) {
$return = $this->getAllData($fields); throw new FireflyException('Unexpectedly got no responses, triggers or deliveries.');
$return['trigger'] = $triggers[$return['trigger']] ?? (int)$return['trigger']; }
$return['response'] = $responses[$return['response']] ?? (int)$return['response'];
$return['delivery'] = $deliveries[$return['delivery']] ?? (int)$return['delivery'];
$return = $this->getAllData($fields);
$return['triggers'] = $triggers;
$return['responses'] = $responses;
$return['deliveries'] = $deliveries;
return $return; return $return;
} }
@@ -71,18 +70,24 @@ class CreateRequest extends FormRequest
*/ */
public function rules(): array public function rules(): array
{ {
$triggers = implode(',', array_keys(Webhook::getTriggersForValidation())); $triggers = implode(',', array_values(Webhook::getTriggers()));
$responses = implode(',', array_keys(Webhook::getResponsesForValidation())); $responses = implode(',', array_values(Webhook::getResponses()));
$deliveries = implode(',', array_keys(Webhook::getDeliveriesForValidation())); $deliveries = implode(',', array_values(Webhook::getDeliveries()));
$validProtocols = config('firefly.valid_url_protocols'); $validProtocols = config('firefly.valid_url_protocols');
return [ return [
'title' => 'required|min:1|max:255|uniqueObjectForUser:webhooks,title', 'title' => 'required|min:1|max:255|uniqueObjectForUser:webhooks,title',
'active' => [new IsBoolean()], 'active' => [new IsBoolean()],
'trigger' => sprintf('required|in:%s', $triggers), 'trigger' => 'prohibited',
'response' => sprintf('required|in:%s', $responses), 'triggers' => 'required|array|min:1|max:10',
'delivery' => sprintf('required|in:%s', $deliveries), 'triggers.*' => sprintf('required|in:%s', $triggers),
'url' => ['required', sprintf('url:%s', $validProtocols), 'uniqueWebhook'], 'response' => 'prohibited',
'responses' => 'required|array|min:1|max:1',
'responses.*' => sprintf('required|in:%s', $responses),
'delivery' => 'prohibited',
'deliveries' => 'required|array|min:1|max:1',
'deliveries.*' => sprintf('required|in:%s', $deliveries),
'url' => ['required', sprintf('url:%s', $validProtocols)],
]; ];
} }
@@ -91,37 +96,44 @@ class CreateRequest extends FormRequest
$validator->after( $validator->after(
function (Validator $validator): void { function (Validator $validator): void {
Log::debug('Validating webhook'); Log::debug('Validating webhook');
if ($validator->failed()) {
return;
}
$data = $validator->getData(); $data = $validator->getData();
$trigger = $data['trigger'] ?? null; $triggers = $data['triggers'] ?? [];
$response = $data['response'] ?? null; $responses = $data['responses'] ?? [];
if (null === $trigger || null === $response) {
if (0 === count($triggers) || 0 === count($responses)) {
Log::debug('No trigger or response, return.'); Log::debug('No trigger or response, return.');
return; return;
} }
$triggers = array_keys(Webhook::getTriggersForValidation()); $validTriggers = array_values(Webhook::getTriggers());
$responses = array_keys(Webhook::getResponsesForValidation()); $validResponses = array_values(Webhook::getResponses());
if (!in_array($trigger, $triggers, true) || !in_array($response, $responses, true)) { foreach ($triggers as $trigger) {
return; if (!in_array($trigger, $validTriggers, true)) {
return;
}
} }
// cannot deliver budget info. foreach ($responses as $response) {
if (is_int($trigger)) { if (!in_array($response, $validResponses, true)) {
Log::debug(sprintf('Trigger was integer (%d).', $trigger)); return;
$trigger = WebhookTrigger::from($trigger)->name; }
} }
if (is_int($response)) { // some combinations are illegal.
Log::debug(sprintf('Response was integer (%d).', $response)); foreach ($triggers as $i => $trigger) {
$response = WebhookResponse::from($response)->name; $forbidden = config(sprintf('webhooks.forbidden_responses.%s', $trigger));
} if (null === $forbidden) {
Log::debug(sprintf('Trigger is %s, response is %s', $trigger, $response)); $validator->errors()->add(sprintf('triggers.%d', $i), trans('validation.unknown_webhook_trigger', ['trigger' => $trigger,]));
if (str_contains($trigger, 'TRANSACTION') && str_contains($response, 'BUDGET')) { continue;
$validator->errors()->add('response', trans('validation.webhook_budget_info')); }
} foreach ($responses as $ii => $response) {
if (str_contains($trigger, 'BUDGET') && str_contains($response, 'ACCOUNT')) { if (in_array($response, $forbidden, true)) {
$validator->errors()->add('response', trans('validation.webhook_account_info')); Log::debug(sprintf('Trigger %s and response %s are forbidden.', $trigger, $response));
} $validator->errors()->add(sprintf('responses.%d', $ii), trans('validation.bad_webhook_combination', ['trigger' => $trigger, 'response' => $response,]));
if (str_contains($trigger, 'BUDGET') && str_contains($response, 'TRANSACTION')) { return;
$validator->errors()->add('response', trans('validation.webhook_transaction_info')); }
}
} }
} }
); );

110
app/Api/V1/Requests/Models/Webhook/UpdateRequest.php
View File

@@ -26,6 +26,7 @@ namespace FireflyIII\Api\V1\Requests\Models\Webhook;
use FireflyIII\Enums\WebhookResponse; use FireflyIII\Enums\WebhookResponse;
use FireflyIII\Enums\WebhookTrigger; use FireflyIII\Enums\WebhookTrigger;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\Webhook; use FireflyIII\Models\Webhook;
use FireflyIII\Rules\IsBoolean; use FireflyIII\Rules\IsBoolean;
use FireflyIII\Support\Request\ChecksLogin; use FireflyIII\Support\Request\ChecksLogin;
@@ -44,35 +45,25 @@ class UpdateRequest extends FormRequest
public function getData(): array public function getData(): array
{ {
$triggers = Webhook::getTriggersForValidation();
$responses = Webhook::getResponsesForValidation();
$deliveries = Webhook::getDeliveriesForValidation();
$fields = [ $fields = [
'title' => ['title', 'convertString'], 'title' => ['title', 'convertString'],
'active' => ['active', 'boolean'], 'active' => ['active', 'boolean'],
'trigger' => ['trigger', 'convertString'],
'response' => ['response', 'convertString'],
'delivery' => ['delivery', 'convertString'],
'url' => ['url', 'convertString'], 'url' => ['url', 'convertString'],
]; ];
// this is the way. $triggers = $this->get('triggers', []);
$return = $this->getAllData($fields); $responses = $this->get('responses', []);
if (array_key_exists('trigger', $return)) { $deliveries = $this->get('deliveries', []);
$return['trigger'] = $triggers[$return['trigger']] ?? 0;
} if (0 === count($triggers) || 0 === count($responses) || 0 === count($deliveries)) {
if (array_key_exists('response', $return)) { throw new FireflyException('Unexpectedly got no responses, triggers or deliveries.');
$return['response'] = $responses[$return['response']] ?? 0;
}
if (array_key_exists('delivery', $return)) {
$return['delivery'] = $deliveries[$return['delivery']] ?? 0;
}
$return['secret'] = null !== $this->get('secret');
if (null !== $this->get('title')) {
$return['title'] = $this->convertString('title');
} }
$return = $this->getAllData($fields);
$return['triggers'] = $triggers;
$return['responses'] = $responses;
$return['deliveries'] = $deliveries;
return $return; return $return;
} }
@@ -81,9 +72,9 @@ class UpdateRequest extends FormRequest
*/ */
public function rules(): array public function rules(): array
{ {
$triggers = implode(',', array_keys(Webhook::getTriggersForValidation())); $triggers = implode(',', array_values(Webhook::getTriggers()));
$responses = implode(',', array_keys(Webhook::getResponsesForValidation())); $responses = implode(',', array_values(Webhook::getResponses()));
$deliveries = implode(',', array_keys(Webhook::getDeliveriesForValidation())); $deliveries = implode(',', array_values(Webhook::getDeliveries()));
$validProtocols = config('firefly.valid_url_protocols'); $validProtocols = config('firefly.valid_url_protocols');
/** @var Webhook $webhook */ /** @var Webhook $webhook */
@@ -92,9 +83,17 @@ class UpdateRequest extends FormRequest
return [ return [
'title' => sprintf('min:1|max:255|uniqueObjectForUser:webhooks,title,%d', $webhook->id), 'title' => sprintf('min:1|max:255|uniqueObjectForUser:webhooks,title,%d', $webhook->id),
'active' => [new IsBoolean()], 'active' => [new IsBoolean()],
'trigger' => sprintf('in:%s', $triggers),
'response' => sprintf('in:%s', $responses), 'trigger' => 'prohibited',
'delivery' => sprintf('in:%s', $deliveries), 'triggers' => 'required|array|min:1|max:10',
'triggers.*' => sprintf('required|in:%s', $triggers),
'response' => 'prohibited',
'responses' => 'required|array|min:1|max:1',
'responses.*' => sprintf('required|in:%s', $responses),
'delivery' => 'prohibited',
'deliveries' => 'required|array|min:1|max:1',
'deliveries.*' => sprintf('required|in:%s', $deliveries),
'url' => [sprintf('url:%s', $validProtocols), sprintf('uniqueExistingWebhook:%d', $webhook->id)], 'url' => [sprintf('url:%s', $validProtocols), sprintf('uniqueExistingWebhook:%d', $webhook->id)],
]; ];
} }
@@ -104,38 +103,47 @@ class UpdateRequest extends FormRequest
$validator->after( $validator->after(
function (Validator $validator): void { function (Validator $validator): void {
Log::debug('Validating webhook'); Log::debug('Validating webhook');
if ($validator->failed()) {
return;
}
$data = $validator->getData(); $data = $validator->getData();
$trigger = $data['trigger'] ?? null; $triggers = $data['triggers'] ?? [];
$response = $data['response'] ?? null; $responses = $data['responses'] ?? [];
if (null === $trigger || null === $response) {
if (0 === count($triggers) || 0 === count($responses)) {
Log::debug('No trigger or response, return.'); Log::debug('No trigger or response, return.');
return; return;
} }
$triggers = array_keys(Webhook::getTriggersForValidation()); $validTriggers = array_values(Webhook::getTriggers());
$responses = array_keys(Webhook::getResponsesForValidation()); $validResponses = array_values(Webhook::getResponses());
if (!in_array($trigger, $triggers, true) || !in_array($response, $responses, true)) { foreach ($triggers as $trigger) {
return; if (!in_array($trigger, $validTriggers, true)) {
return;
}
} }
// cannot deliver budget info. foreach ($responses as $response) {
if (is_int($trigger)) { if (!in_array($response, $validResponses, true)) {
Log::debug(sprintf('Trigger was integer (%d).', $trigger)); return;
$trigger = WebhookTrigger::from($trigger)->name; }
} }
if (is_int($response)) { // some combinations are illegal.
Log::debug(sprintf('Response was integer (%d).', $response)); foreach ($triggers as $i => $trigger) {
$response = WebhookResponse::from($response)->name; $forbidden = config(sprintf('webhooks.forbidden_responses.%s', $trigger));
} if (null === $forbidden) {
Log::debug(sprintf('Trigger is %s, response is %s', $trigger, $response)); $validator->errors()->add(sprintf('triggers.%d', $i), trans('validation.unknown_webhook_trigger', ['trigger' => $trigger,]));
if (str_contains($trigger, 'TRANSACTION') && str_contains($response, 'BUDGET')) { continue;
$validator->errors()->add('response', trans('validation.webhook_budget_info')); }
} foreach ($responses as $ii => $response) {
if (str_contains($trigger, 'BUDGET') && str_contains($response, 'ACCOUNT')) { if (in_array($response, $forbidden, true)) {
$validator->errors()->add('response', trans('validation.webhook_account_info')); Log::debug(sprintf('Trigger %s and response %s are forbidden.', $trigger, $response));
} $validator->errors()->add(sprintf('responses.%d', $ii), trans('validation.bad_webhook_combination', ['trigger' => $trigger, 'response' => $response,]));
if (str_contains($trigger, 'BUDGET') && str_contains($response, 'TRANSACTION')) { return;
$validator->errors()->add('response', trans('validation.webhook_transaction_info')); }
}
} }
} }
); );
} }

1
app/Enums/WebhookResponse.php
View File

@@ -32,5 +32,6 @@ enum WebhookResponse: int
case TRANSACTIONS = 200; case TRANSACTIONS = 200;
case ACCOUNTS = 210; case ACCOUNTS = 210;
case BUDGET = 230; case BUDGET = 230;
case RELEVANT = 240;
case NONE = 220; case NONE = 220;
} }

80
app/Repositories/Webhook/WebhookRepository.php
View File

@@ -24,9 +24,13 @@ declare(strict_types=1);
namespace FireflyIII\Repositories\Webhook; namespace FireflyIII\Repositories\Webhook;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\Webhook; use FireflyIII\Models\Webhook;
use FireflyIII\Models\WebhookAttempt; use FireflyIII\Models\WebhookAttempt;
use FireflyIII\Models\WebhookDelivery;
use FireflyIII\Models\WebhookMessage; use FireflyIII\Models\WebhookMessage;
use FireflyIII\Models\WebhookResponse;
use FireflyIII\Models\WebhookTrigger;
use FireflyIII\Support\Repositories\UserGroup\UserGroupInterface; use FireflyIII\Support\Repositories\UserGroup\UserGroupInterface;
use FireflyIII\Support\Repositories\UserGroup\UserGroupTrait; use FireflyIII\Support\Repositories\UserGroup\UserGroupTrait;
use Illuminate\Support\Collection; use Illuminate\Support\Collection;
@@ -105,26 +109,92 @@ class WebhookRepository implements WebhookRepositoryInterface, UserGroupInterfac
'secret' => $secret, 'secret' => $secret,
'url' => $data['url'], 'url' => $data['url'],
]; ];
/** @var Webhook $webhook */
$webhook = Webhook::create($fullData);
$triggers = new Collection();
$responses = new Collection();
$deliveries = new Collection();
return Webhook::create($fullData); foreach ($data['triggers'] as $trigger) {
// get the relevant ID:
$object = WebhookTrigger::where('title', $trigger)->first();
if (null === $object) {
throw new FireflyException(sprintf('Could not find webhook trigger with title "%s".', $trigger));
}
$triggers->push($object);
}
$webhook->webhookTriggers()->saveMany($triggers);
foreach ($data['responses'] as $response) {
// get the relevant ID:
$object = WebhookResponse::where('title', $response)->first();
if (null === $object) {
throw new FireflyException(sprintf('Could not find webhook response with title "%s".', $response));
}
$responses->push($object);
}
$webhook->webhookResponses()->saveMany($responses);
foreach ($data['deliveries'] as $delivery) {
// get the relevant ID:
$object = WebhookDelivery::where('title', $delivery)->first();
if (null === $object) {
throw new FireflyException(sprintf('Could not find webhook delivery with title "%s".', $delivery));
}
$deliveries->push($object);
}
$webhook->webhookDeliveries()->saveMany($deliveries);
return $webhook;
} }
public function update(Webhook $webhook, array $data): Webhook public function update(Webhook $webhook, array $data): Webhook
{ {
$webhook->active = $data['active'] ?? $webhook->active; $webhook->active = $data['active'] ?? $webhook->active;
// $webhook->trigger = $data['trigger'] ?? $webhook->trigger;
// $webhook->response = $data['response'] ?? $webhook->response;
// $webhook->delivery = $data['delivery'] ?? $webhook->delivery;
$webhook->title = $data['title'] ?? $webhook->title; $webhook->title = $data['title'] ?? $webhook->title;
$webhook->url = $data['url'] ?? $webhook->url; $webhook->url = $data['url'] ?? $webhook->url;
if (true === $data['secret']) { if (array_key_exists('secret', $data) && true === $data['secret']) {
$secret = Str::random(24); $secret = Str::random(24);
$webhook->secret = $secret; $webhook->secret = $secret;
} }
$webhook->save(); $webhook->save();
$triggers = new Collection();
$responses = new Collection();
$deliveries = new Collection();
foreach ($data['triggers'] as $trigger) {
// get the relevant ID:
$object = WebhookTrigger::where('title', $trigger)->first();
if (null === $object) {
throw new FireflyException(sprintf('Could not find webhook trigger with title "%s".', $trigger));
}
$triggers->push($object);
}
$webhook->webhookTriggers()->sync($triggers);
foreach ($data['responses'] as $response) {
// get the relevant ID:
$object = WebhookResponse::where('title', $response)->first();
if (null === $object) {
throw new FireflyException(sprintf('Could not find webhook response with title "%s".', $response));
}
$responses->push($object);
}
$webhook->webhookResponses()->sync($responses);
foreach ($data['deliveries'] as $delivery) {
// get the relevant ID:
$object = WebhookDelivery::where('title', $delivery)->first();
if (null === $object) {
throw new FireflyException(sprintf('Could not find webhook delivery with title "%s".', $delivery));
}
$deliveries->push($object);
}
$webhook->webhookDeliveries()->sync($deliveries);
return $webhook; return $webhook;
} }
} }

79
config/webhooks.php Normal file
View File

@@ -0,0 +1,79 @@
<?php
// this is hard coded, which is unfortunate.
use FireflyIII\Enums\WebhookResponse;
use FireflyIII\Enums\WebhookTrigger;
return [
'force_relevant_response' => [
WebhookTrigger::STORE_TRANSACTION->name => [
WebhookTrigger::STORE_BUDGET->name,
WebhookTrigger::UPDATE_BUDGET->name,
WebhookTrigger::DESTROY_BUDGET->name,
WebhookTrigger::STORE_UPDATE_BUDGET_LIMIT->name,
],
WebhookTrigger::UPDATE_TRANSACTION->name => [
WebhookTrigger::STORE_BUDGET->name,
WebhookTrigger::UPDATE_BUDGET->name,
WebhookTrigger::DESTROY_BUDGET->name,
WebhookTrigger::STORE_UPDATE_BUDGET_LIMIT->name,
],
WebhookTrigger::DESTROY_TRANSACTION->name => [
WebhookTrigger::STORE_BUDGET->name,
WebhookTrigger::UPDATE_BUDGET->name,
WebhookTrigger::DESTROY_BUDGET->name,
WebhookTrigger::STORE_UPDATE_BUDGET_LIMIT->name,
],
WebhookTrigger::STORE_BUDGET->name => [
WebhookTrigger::STORE_TRANSACTION->name,
WebhookTrigger::UPDATE_TRANSACTION->name,
WebhookTrigger::DESTROY_TRANSACTION->name,
],
WebhookTrigger::UPDATE_BUDGET->name => [
WebhookTrigger::STORE_TRANSACTION->name,
WebhookTrigger::UPDATE_TRANSACTION->name,
WebhookTrigger::DESTROY_TRANSACTION->name,
],
WebhookTrigger::DESTROY_BUDGET->name => [
WebhookTrigger::STORE_TRANSACTION->name,
WebhookTrigger::UPDATE_TRANSACTION->name,
WebhookTrigger::DESTROY_TRANSACTION->name,
],
WebhookTrigger::STORE_UPDATE_BUDGET_LIMIT->name => [
WebhookTrigger::STORE_TRANSACTION->name,
WebhookTrigger::UPDATE_TRANSACTION->name,
WebhookTrigger::DESTROY_TRANSACTION->name,
],
],
'forbidden_responses' => [
WebhookTrigger::STORE_TRANSACTION->name => [
WebhookResponse::BUDGET->name,
],
WebhookTrigger::UPDATE_TRANSACTION->name => [
WebhookResponse::BUDGET->name,
],
WebhookTrigger::DESTROY_TRANSACTION->name => [
WebhookResponse::BUDGET->name,
],
WebhookTrigger::STORE_BUDGET->name => [
WebhookResponse::TRANSACTIONS->name,
WebhookResponse::ACCOUNTS->name,
],
WebhookTrigger::UPDATE_BUDGET->name => [
WebhookResponse::TRANSACTIONS->name,
WebhookResponse::ACCOUNTS->name,
],
WebhookTrigger::DESTROY_BUDGET->name => [
WebhookResponse::TRANSACTIONS->name,
WebhookResponse::ACCOUNTS->name,
],
WebhookTrigger::STORE_UPDATE_BUDGET_LIMIT->name => [
WebhookResponse::TRANSACTIONS->name,
WebhookResponse::ACCOUNTS->name,
],
]
];

0
public/v1/js/.gitkeep Normal file → Executable file
View File

4
resources/assets/v1/src/components/form/WebhookDelivery.vue
View File

@@ -68,7 +68,7 @@ export default {
} }
}, },
value: { value: {
type: Number, type: String,
required: true, required: true,
} }
}, },
@@ -84,7 +84,7 @@ export default {
} }
this.deliveries.push( this.deliveries.push(
{ {
id: response.data.data.value[key], id: key,
name: this.$t('firefly.webhook_delivery_' + key), name: this.$t('firefly.webhook_delivery_' + key),
} }
); );

4
resources/assets/v1/src/components/form/WebhookResponse.vue
View File

@@ -66,7 +66,7 @@ export default {
} }
}, },
value: { value: {
type: Number, type: String,
required: true, required: true,
} }
}, },
@@ -88,7 +88,7 @@ export default {
} }
this.responses.push( this.responses.push(
{ {
id: response.data.data.value[key], id: key,
name: this.$t('firefly.webhook_response_' + key), name: this.$t('firefly.webhook_response_' + key),
} }
); );

9
resources/assets/v1/src/components/form/WebhookTrigger.vue
View File

@@ -29,6 +29,7 @@
</div> </div>
<select v-if="!loading" <select v-if="!loading"
ref="trigger" ref="trigger"
multiple
v-model="trigger" v-model="trigger"
:title="$t('form.webhook_trigger')" :title="$t('form.webhook_trigger')"
class="form-control" class="form-control"
@@ -52,7 +53,7 @@ export default {
name: "WebhookTrigger", name: "WebhookTrigger",
data() { data() {
return { return {
trigger: 0, trigger: [],
loading: true, loading: true,
triggers: [], triggers: [],
}; };
@@ -66,7 +67,7 @@ export default {
} }
}, },
value: { value: {
type: Number, type: Array,
required: true, required: true,
} }
}, },
@@ -80,11 +81,11 @@ export default {
} }
this.triggers.push( this.triggers.push(
{ {
id: response.data.data.value[key], id: key,
name: this.$t('firefly.webhook_trigger_' + key), name: this.$t('firefly.webhook_trigger_' + key),
} }
); );
console.log('webhook trigger: id=' + response.data.data.value[key] + ', name=' + key); // console.log('webhook trigger: id=' + response.data.data.value[key] + ', name=' + key);
} }
this.loading = false; this.loading = false;
}).catch((error) => { }).catch((error) => {

42
resources/assets/v1/src/components/webhooks/Create.vue
View File

@@ -54,12 +54,12 @@
<div class="row"> <div class="row">
<div class="col-lg-12"> <div class="col-lg-12">
<Title :value=this.title :error="errors.title" v-on:input="title = $event"></Title> <Title :value=this.title :error="errors.title" v-on:input="title = $event"></Title>
<WebhookTrigger :value=this.trigger :error="errors.trigger" <WebhookTrigger :value=this.triggers :error="errors.trigger"
v-on:input="trigger = $event"></WebhookTrigger> v-on:input="triggers = $event"></WebhookTrigger>
<WebhookResponse :value=this.response :error="errors.response" <WebhookResponse :value=this.responses :error="errors.response"
v-on:input="response = $event"></WebhookResponse> v-on:input="responses = $event"></WebhookResponse>
<WebhookDelivery :value=this.delivery :error="errors.delivery" <WebhookDelivery :value=this.deliveries :error="errors.delivery"
v-on:input="delivery = $event"></WebhookDelivery> v-on:input="deliveries = $event"></WebhookDelivery>
<URL :value=this.url :error="errors.url" v-on:input="url = $event"></URL> <URL :value=this.url :error="errors.url" v-on:input="url = $event"></URL>
<Checkbox :value=this.active :error="errors.active" help="ACTIVE HELP TODO" :title="$t('form.active')" v-on:input="active = $event"></Checkbox> <Checkbox :value=this.active :error="errors.active" help="ACTIVE HELP TODO" :title="$t('form.active')" v-on:input="active = $event"></Checkbox>
</div> </div>
@@ -96,16 +96,16 @@ export default {
error_message: '', error_message: '',
success_message: '', success_message: '',
title: '', title: '',
trigger: 100, triggers: ["STORE_TRANSACTION"],
response: 200, responses: "RELEVANT",
delivery: 300, deliveries: "JSON",
active: true, active: true,
url: '', url: '',
errors: { errors: {
title: [], title: [],
trigger: [], triggers: [],
response: [], responses: [],
delivery: [], deliveries: [],
url: [], url: [],
active: [] active: []
} }
@@ -118,9 +118,9 @@ export default {
this.success_message = ''; this.success_message = '';
this.errors = { this.errors = {
title: [], title: [],
trigger: [], triggers: [],
response: [], responses: [],
delivery: [], deliveries: [],
url: [], url: [],
active: [], active: [],
}; };
@@ -131,9 +131,9 @@ export default {
// collect data // collect data
let data = { let data = {
title: this.title, title: this.title,
trigger: this.trigger, triggers: this.triggers,
response: this.response, responses: [this.responses],
delivery: this.delivery, deliveries: [this.deliveries],
url: this.url, url: this.url,
active: this.active, active: this.active,
}; };
@@ -148,9 +148,9 @@ export default {
//console.log(error.response.data); //console.log(error.response.data);
this.error_message = error.response.data.message; this.error_message = error.response.data.message;
this.errors.title = error.response.data.errors.title; this.errors.title = error.response.data.errors.title;
this.errors.trigger = error.response.data.errors.trigger; this.errors.triggers = error.response.data.errors.triggers;
this.errors.response = error.response.data.errors.response; this.errors.responses = error.response.data.errors.responses;
this.errors.delivery = error.response.data.errors.delivery; this.errors.deliveries = error.response.data.errors.deliveries;
this.errors.url = error.response.data.errors.url; this.errors.url = error.response.data.errors.url;
// enable button again // enable button again

88
resources/assets/v1/src/components/webhooks/Edit.vue
View File

@@ -54,12 +54,12 @@
<div class="row"> <div class="row">
<div class="col-lg-12"> <div class="col-lg-12">
<Title :value=this.title :error="errors.title" v-on:input="title = $event"></Title> <Title :value=this.title :error="errors.title" v-on:input="title = $event"></Title>
<WebhookTrigger :value=this.trigger :error="errors.trigger" <WebhookTrigger :value=this.triggers :error="errors.triggers"
v-on:input="trigger = $event"></WebhookTrigger> v-on:input="triggers = $event"></WebhookTrigger>
<WebhookResponse :value=this.response :error="errors.response" <WebhookResponse :value=this.responses :error="errors.responses"
v-on:input="response = $event"></WebhookResponse> v-on:input="responses = $event"></WebhookResponse>
<WebhookDelivery :value=this.delivery :error="errors.delivery" <WebhookDelivery :value=this.deliveries :error="errors.deliveries"
v-on:input="delivery = $event"></WebhookDelivery> v-on:input="deliveries = $event"></WebhookDelivery>
<URL :value=this.url :error="errors.url" v-on:input="url = $event"></URL> <URL :value=this.url :error="errors.url" v-on:input="url = $event"></URL>
<Checkbox :value=this.active :error="errors.active" help="ACTIVE HELP TODO" :title="$t('form.active')" <Checkbox :value=this.active :error="errors.active" help="ACTIVE HELP TODO" :title="$t('form.active')"
v-on:input="active = $event"></Checkbox> v-on:input="active = $event"></Checkbox>
@@ -97,17 +97,17 @@ export default {
error_message: '', error_message: '',
success_message: '', success_message: '',
title: '', title: '',
trigger: 100, triggers: ["STORE_TRANSACTION"],
response: 200, responses: "RELEVANT",
delivery: 300, deliveries: "JSON",
id: 0, id: 0,
active: false, active: false,
url: '', url: '',
errors: { errors: {
title: [], title: [],
trigger: [], triggers: [],
response: [], responses: [],
delivery: [], deliveries: [],
url: [], url: [],
active: [] active: []
} }
@@ -127,49 +127,9 @@ export default {
// console.log(response.data.data.attributes); // console.log(response.data.data.attributes);
this.title = response.data.data.attributes.title; this.title = response.data.data.attributes.title;
this.id = parseInt(response.data.data.id); this.id = parseInt(response.data.data.id);
this.triggers = response.data.data.attributes.triggers;
// trigger value on content this.responses = response.data.data.attributes.responses[0];
console.log('Trigger is ' + response.data.data.attributes.trigger); this.deliveries = response.data.data.attributes.deliveries[0];
// TODO does not need to be hard coded.
if ('STORE_TRANSACTION' === response.data.data.attributes.trigger) {
this.trigger = 100;
}
if ('UPDATE_TRANSACTION' === response.data.data.attributes.trigger) {
this.trigger = 110;
}
if ('DESTROY_TRANSACTION' === response.data.data.attributes.trigger) {
this.trigger = 120;
}
if ('STORE_BUDGET' === response.data.data.attributes.trigger) {
this.trigger = 200;
}
if ('UPDATE_BUDGET' === response.data.data.attributes.trigger) {
this.trigger = 210;
}
if ('DESTROY_BUDGET' === response.data.data.attributes.trigger) {
this.trigger = 220;
}
if ('STORE_UPDATE_BUDGET_LIMIT' === response.data.data.attributes.trigger) {
this.trigger = 230;
}
// response value
if ('TRANSACTIONS' === response.data.data.attributes.response) {
this.response = 200;
}
if ('ACCOUNTS' === response.data.data.attributes.response) {
this.response = 210;
}
if ('BUDGET' === response.data.data.attributes.response) {
this.response = 230;
}
if ('NONE' === response.data.data.attributes.response) {
this.response = 220;
}
if ('JSON' === response.data.data.attributes.delivery) {
this.delivery = 300;
}
this.active = response.data.data.attributes.active; this.active = response.data.data.attributes.active;
this.url = response.data.data.attributes.url; this.url = response.data.data.attributes.url;
}).catch(error => { }).catch(error => {
@@ -182,9 +142,9 @@ export default {
this.success_message = ''; this.success_message = '';
this.errors = { this.errors = {
title: [], title: [],
trigger: [], triggers: [],
response: [], responses: [],
delivery: [], deliveries: [],
url: [], url: [],
active: [], active: [],
}; };
@@ -195,9 +155,9 @@ export default {
// collect data // collect data
let data = { let data = {
title: this.title, title: this.title,
trigger: this.trigger, triggers: this.triggers,
response: this.response, responses: [this.responses],
delivery: this.delivery, deliveries: [this.deliveries],
url: this.url, url: this.url,
active: this.active, active: this.active,
}; };
@@ -210,9 +170,9 @@ export default {
this.error_message = error.response.data.message; this.error_message = error.response.data.message;
this.errors.title = error.response.data.errors.title; this.errors.title = error.response.data.errors.title;
this.errors.trigger = error.response.data.errors.trigger; this.errors.triggers = error.response.data.errors.trigger;
this.errors.response = error.response.data.errors.response; this.errors.responses = error.response.data.errors.response;
this.errors.delivery = error.response.data.errors.delivery; this.errors.deliveries = error.response.data.errors.deliveries;
this.errors.url = error.response.data.errors.url; this.errors.url = error.response.data.errors.url;
// enable button again // enable button again

28
resources/assets/v1/src/components/webhooks/Index.vue
View File

@@ -50,12 +50,24 @@
<a :href="'webhooks/show/' + webhook.id">{{ webhook.title }}</a> <a :href="'webhooks/show/' + webhook.id">{{ webhook.title }}</a>
</td> </td>
<td> <td>
<span v-if="webhook.active">{{ triggers[webhook.trigger] }}</span> <span v-if="webhook.active">
<span v-if="!webhook.active" class="text-muted"><s>{{ triggers[webhook.trigger] }}</s> ({{ <ul class="list-unstyled">
$t('firefly.inactive') <li v-for="trigger in webhook.triggers" :key="trigger">
}})</span> {{ triggers[trigger] }}
</li>
</ul>
</span>
<span v-if="!webhook.active" class="text-muted">
<ul class="list-unstyled">
<li v-for="trigger in webhook.triggers" :key="trigger">
<s>{{ triggers[trigger] }}</s> ({{$t('firefly.inactive') }})
</li>
</ul>
</span>
</td>
<td>
{{ responses[webhook.responses[0]] }} ({{ deliveries[webhook.deliveries[0]] }})
</td> </td>
<td>{{ responses[webhook.response] }} ({{ deliveries[webhook.delivery] }})</td>
<td> <td>
<em style="cursor:pointer" <em style="cursor:pointer"
v-if="webhook.show_secret" class="fa fa-eye" @click="toggleSecret(webhook)"></em> v-if="webhook.show_secret" class="fa fa-eye" @click="toggleSecret(webhook)"></em>
@@ -167,9 +179,9 @@ export default {
active: current.attributes.active, active: current.attributes.active,
full_url: current.attributes.url, full_url: current.attributes.url,
secret: current.attributes.secret, secret: current.attributes.secret,
trigger: current.attributes.trigger, triggers: current.attributes.triggers,
response: current.attributes.response, responses: current.attributes.responses,
delivery: current.attributes.delivery, deliveries: current.attributes.deliveries,
show_secret: false, show_secret: false,
}; };
if (current.attributes.url.length > 20) { if (current.attributes.url.length > 20) {

42
resources/assets/v1/src/components/webhooks/Show.vue
View File

@@ -40,27 +40,39 @@
<table class="table table-hover" aria-label="A table"> <table class="table table-hover" aria-label="A table">
<tbody> <tbody>
<tr> <tr>
<th scope="row" style="width:40%;">Title</th> <td style="width:40%;"><strong>{{ $t('list.title') }}</strong></td>
<td>{{ title }}</td> <td>{{ title }}</td>
</tr> </tr>
<tr> <tr>
<th scope="row">{{ $t('list.active') }}</th> <td style="width:40%;"><strong>{{ $t('list.active') }}</strong></td>
<td> <td>
<em class="fa fa-check text-success" v-if="active"></em> <em class="fa fa-check text-success" v-if="active"></em>
<em class="fa fa-times text-danger" v-if="!active"></em> <em class="fa fa-times text-danger" v-if="!active"></em>
</td> </td>
</tr> </tr>
<tr> <tr>
<th scope="row">{{ $t('list.trigger') }}</th> <td style="width:40%;"><strong>{{ $t('list.trigger') }}</strong></td>
<td> {{ trigger }}</td> <td>
<span v-for="trigger in triggers" :key="trigger">
{{ $t('firefly.webhook_trigger_' + trigger) }}<br>
</span>
</td>
</tr> </tr>
<tr> <tr>
<th scope="row">{{ $t('list.response') }}</th> <td style="width:40%;"><strong>{{ $t('list.response') }}</strong></td>
<td> {{ response }}</td> <td>
<span v-for="response in responses" :key="response">
{{ $t('firefly.webhook_response_' + response) }}
</span>
</td>
</tr> </tr>
<tr> <tr>
<th scope="row">{{ $t('list.delivery') }}</th> <td style="width:40%;"><strong>{{ $t('list.delivery') }}</strong></td>
<td> {{ delivery }}</td> <td>
<span v-for="delivery in deliveries" :key="delivery">
{{ $t('firefly.webhook_delivery_' + delivery) }}
</span>
</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@@ -86,12 +98,13 @@
<table class="table table-hover" aria-label="A table"> <table class="table table-hover" aria-label="A table">
<tbody> <tbody>
<tr> <tr>
<th scope="row" style="width:40%;">{{ $t('list.url') }}</th> <td style="width:40%;"><strong>{{ $t('list.url') }}</strong></td>
<td><input type="text" readonly class="form-control" :value=url></td> <td><input type="text" readonly class="form-control" :value=url></td>
</tr> </tr>
<tr> <tr>
<td> <td style="width:40%;"><strong>
{{ $t('list.secret') }} {{ $t('list.secret') }}
</strong>
</td> </td>
<td> <td>
<em style="cursor:pointer" <em style="cursor:pointer"
@@ -260,11 +273,14 @@ export default {
secret: '', secret: '',
show_secret: false, show_secret: false,
trigger: '', trigger: '',
triggers: [],
loading: true, loading: true,
response: '', response: '',
responses: [],
message_content: '', message_content: '',
message_attempts: [], message_attempts: [],
delivery: '', delivery: '',
deliveries: [],
messages: [], messages: [],
active: false, active: false,
edit_url: '#', edit_url: '#',
@@ -369,9 +385,9 @@ export default {
this.title = response.data.data.attributes.title; this.title = response.data.data.attributes.title;
this.url = response.data.data.attributes.url; this.url = response.data.data.attributes.url;
this.secret = response.data.data.attributes.secret; this.secret = response.data.data.attributes.secret;
this.trigger = this.$t('firefly.webhook_trigger_' + response.data.data.attributes.trigger); this.triggers = response.data.data.attributes.triggers;
this.response = this.$t('firefly.webhook_response_' + response.data.data.attributes.response); this.responses = response.data.data.attributes.responses;
this.delivery = this.$t('firefly.webhook_delivery_' + response.data.data.attributes.delivery); this.deliveries = response.data.data.attributes.deliveries;
this.active = response.data.data.attributes.active; this.active = response.data.data.attributes.active;
this.url = response.data.data.attributes.url; this.url = response.data.data.attributes.url;

4
resources/lang/en_US/firefly.php
View File

@@ -250,8 +250,8 @@ return [
'webhook_trigger_STORE_UPDATE_BUDGET_LIMIT' => 'After budgeted amount change', 'webhook_trigger_STORE_UPDATE_BUDGET_LIMIT' => 'After budgeted amount change',
'webhook_response_TRANSACTIONS' => 'Transaction details', 'webhook_response_TRANSACTIONS' => 'Transaction details',
'webhook_response_ACCOUNTS' => 'Account details', 'webhook_response_ACCOUNTS' => 'Account details',
'webhook_response_none_BUDGET' => 'Budget details', 'webhook_response_BUDGET' => 'Budget details',
'webhook_response_none_NONE' => 'No details', 'webhook_response_RELEVANT' => 'Relevant details',
'webhook_response_NONE' => 'No details', 'webhook_response_NONE' => 'No details',
'webhook_delivery_JSON' => 'JSON', 'webhook_delivery_JSON' => 'JSON',
'inspect' => 'Inspect', 'inspect' => 'Inspect',

3
resources/lang/en_US/validation.php
View File

@@ -34,6 +34,9 @@ return [
'filter_not_string' => 'Filter ":filter" is expected to be a string of text', 'filter_not_string' => 'Filter ":filter" is expected to be a string of text',
'bad_api_filter' => 'This API endpoint does not support ":filter" as a filter.', 'bad_api_filter' => 'This API endpoint does not support ":filter" as a filter.',
'nog_logged_in' => 'You are not logged in.', 'nog_logged_in' => 'You are not logged in.',
'prohibited' => 'You must not submit anything in field.',
'bad_webhook_combination' => 'Webhook trigger ":trigger" cannot be combined with webhook response ":response".',
'unknown_webhook_trigger' => 'Unknown webhook trigger ":trigger".',
'bad_type_source' => 'Firefly III can\'t determine the transaction type based on this source account.', 'bad_type_source' => 'Firefly III can\'t determine the transaction type based on this source account.',
'bad_type_destination' => 'Firefly III can\'t determine the transaction type based on this destination account.', 'bad_type_destination' => 'Firefly III can\'t determine the transaction type based on this destination account.',
'missing_where' => 'Array is missing "where"-clause', 'missing_where' => 'Array is missing "where"-clause',