Slack-Discord extra feature (#176)

* Enable Pro plan - WIP

* no pricing page if have no paid plans

* Set pricing ids in env

* views & submissions FREE for all

* extra param for env

* form password FREE for all

* Custom Code is PRO feature

* Replace codeinput prism with codemirror

* Better form Cleaning message

* Added risky user email spam protection

* fix form cleaning

* Custom SEO

* fix custom seo formcleaner

* Better webhooks

* Slack-Discord extra feature

* fix conflict
This commit is contained in:
formsdev 2023-08-30 17:50:14 +05:30 committed by GitHub
parent 057bfde8b7
commit 662088e20f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 248 additions and 111 deletions

View File

@ -43,6 +43,7 @@ abstract class UserFormRequest extends \Illuminate\Foundation\Http\FormRequest
'use_captcha' => 'boolean', 'use_captcha' => 'boolean',
'slack_webhook_url' => 'url|nullable', 'slack_webhook_url' => 'url|nullable',
'discord_webhook_url' => 'url|nullable', 'discord_webhook_url' => 'url|nullable',
'notification_settings' => 'nullable',
// Customization // Customization
'theme' => ['required',Rule::in(Form::THEMES)], 'theme' => ['required',Rule::in(Form::THEMES)],

View File

@ -47,6 +47,7 @@ class FormResource extends JsonResource
'notification_emails' => $this->notification_emails, 'notification_emails' => $this->notification_emails,
'slack_webhook_url' => $this->slack_webhook_url, 'slack_webhook_url' => $this->slack_webhook_url,
'discord_webhook_url' => $this->discord_webhook_url, 'discord_webhook_url' => $this->discord_webhook_url,
'notification_settings' => $this->notification_settings,
'removed_properties' => $this->removed_properties, 'removed_properties' => $this->removed_properties,
'last_edited_human' => $this->updated_at?->diffForHumans(), 'last_edited_human' => $this->updated_at?->diffForHumans(),
'seo_meta' => $this->seo_meta 'seo_meta' => $this->seo_meta

View File

@ -41,6 +41,7 @@ class Form extends Model
'notifications_include_submission', 'notifications_include_submission',
'slack_webhook_url', 'slack_webhook_url',
'discord_webhook_url', 'discord_webhook_url',
'notification_settings',
// integrations // integrations
'webhook_url', 'webhook_url',
@ -83,10 +84,7 @@ class Form extends Model
// Security & Privacy // Security & Privacy
'can_be_indexed', 'can_be_indexed',
'password', 'password'
// Custom SEO
'seo_meta'
]; ];
protected $casts = [ protected $casts = [
@ -95,7 +93,8 @@ class Form extends Model
'closes_at' => 'datetime', 'closes_at' => 'datetime',
'tags' => 'array', 'tags' => 'array',
'removed_properties' => 'array', 'removed_properties' => 'array',
'seo_meta' => 'object' 'seo_meta' => 'object',
'notification_settings' => 'object'
]; ];
protected $appends = [ protected $appends = [

View File

@ -3,7 +3,8 @@
namespace App\Service\Forms\Webhooks; namespace App\Service\Forms\Webhooks;
use App\Service\Forms\FormSubmissionFormatter; use App\Service\Forms\FormSubmissionFormatter;
use Illuminate\Support\Str; use Vinkla\Hashids\Facades\Hashids;
use Illuminate\Support\Arr;
class DiscordHandler extends AbstractWebhookHandler class DiscordHandler extends AbstractWebhookHandler
{ {
@ -20,58 +21,60 @@ class DiscordHandler extends AbstractWebhookHandler
protected function getWebhookData(): array protected function getWebhookData(): array
{ {
$submissionString = ""; $settings = (array) Arr::get((array)$this->form->notification_settings, 'discord', []);
$formatter = (new FormSubmissionFormatter($this->form, $this->data))->outputStringsOnly(); $externalLinks = [];
if(Arr::get($settings, 'link_open_form', true)){
foreach ($formatter->getFieldsWithValue() as $field) { $externalLinks[] = '[**🔗 Open Form**](' . $this->form->share_url . ')';
$tmpVal = is_array($field['value']) ? implode(",", $field['value']) : $field['value']; }
$submissionString .= "**" . ucfirst($field['name']) . "**: `" . $tmpVal . "`\n"; if(Arr::get($settings, 'link_edit_form', true)){
$editFormURL = url('forms/' . $this->form->slug . '/show');
$externalLinks[] = '[**✍️ Edit Form**](' . $editFormURL . ')';
}
if (Arr::get($settings, 'link_edit_submission', true) && $this->form->editable_submissions) {
$submissionId = Hashids::encode($this->data['submission_id']);
$externalLinks[] = '[**✍️ ' . $this->form->editable_submissions_button_text . '**](' . $this->form->share_url . '?submission_id=' . $submissionId . ')';
} }
$form_name = $this->form->title; $color = hexdec(str_replace('#', '', $this->form->color));
$formURL = url("forms/" . $this->form->slug . "/show/submissions"); $blocks = [];
if(Arr::get($settings, 'include_submission_data', true)){
$submissionString = "";
$formatter = (new FormSubmissionFormatter($this->form, $this->data))->outputStringsOnly();
foreach ($formatter->getFieldsWithValue() as $field) {
$tmpVal = is_array($field['value']) ? implode(",", $field['value']) : $field['value'];
$submissionString .= "**" . ucfirst($field['name']) . "**: " . $tmpVal . "\n";
}
$blocks[] = [
"type" => "rich",
"color" => $color,
"description" => $submissionString
];
}
if(Arr::get($settings, 'views_submissions_count', true)){
$countString = '**👀 Views**: ' . (string)$this->form->views_count . " \n";
$countString .= '**🖊️ Submissions**: ' . (string)$this->form->submissions_count;
$blocks[] = [
"type" => "rich",
"color" => $color,
"description" => $countString
];
}
if(count($externalLinks) > 0){
$blocks[] = [
"type" => "rich",
"color" => $color,
"description" => implode(' - ', $externalLinks)
];
}
return [ return [
"content" => "@here We have received a new submission for **$form_name**", 'content' => 'New submission for your form **' . $this->form->title . '**',
"username" => config('app.name'), 'tts' => false,
"avatar_url" => asset('img/logo.png'), 'username' => config('app.name'),
"tts" => false, 'avatar_url' => asset('img/logo.png'),
"embeds" => [ 'embeds' => $blocks
[
"title" => "🔗 Go to $form_name",
"type" => "rich",
"description" => $submissionString,
"url" => $formURL,
"color" => hexdec(str_replace('#', '', $this->form->color)),
"footer" => [
"text" => config('app.name'),
"icon_url" => asset('img/logo.png'),
],
"author" => [
"name" => config('app.name'),
"url" => config('app.url'),
],
"fields" => [
[
"name" => "Views 👀",
"value" => (string)$this->form->views_count,
"inline" => true
],
[
"name" => "Submissions 🖊️",
"value" => (string)$this->form->submissions_count,
"inline" => true
]
]
]
]
]; ];
} }

View File

@ -3,8 +3,8 @@
namespace App\Service\Forms\Webhooks; namespace App\Service\Forms\Webhooks;
use App\Service\Forms\FormSubmissionFormatter; use App\Service\Forms\FormSubmissionFormatter;
use Illuminate\Support\Str;
use Vinkla\Hashids\Facades\Hashids; use Vinkla\Hashids\Facades\Hashids;
use Illuminate\Support\Arr;
class SlackHandler extends AbstractWebhookHandler class SlackHandler extends AbstractWebhookHandler
{ {
@ -21,48 +21,70 @@ class SlackHandler extends AbstractWebhookHandler
protected function getWebhookData(): array protected function getWebhookData(): array
{ {
$settings = (array) Arr::get((array)$this->form->notification_settings, 'slack', []);
$externalLinks = [];
if(Arr::get($settings, 'link_open_form', true)){
$externalLinks[] = '*<' . $this->form->share_url . '|🔗 Open Form>*';
}
if(Arr::get($settings, 'link_edit_form', true)){
$editFormURL = url('forms/' . $this->form->slug . '/show');
$externalLinks[] = '*<' . $editFormURL . '|✍️ Edit Form>*';
}
if (Arr::get($settings, 'link_edit_submission', true) && $this->form->editable_submissions) {
$submissionId = Hashids::encode($this->data['submission_id']);
$externalLinks[] = '*<' . $this->form->share_url . '?submission_id=' . $submissionId . '|✍️ ' . $this->form->editable_submissions_button_text . '>*';
}
$blocks = [
[
'type' => 'section',
'text' => [
'type' => 'mrkdwn',
'text' => 'New submission for your form *' . $this->form->title . '*',
]
]
];
if(Arr::get($settings, 'include_submission_data', true)){
$submissionString = ''; $submissionString = '';
$formatter = (new FormSubmissionFormatter($this->form, $this->data))->outputStringsOnly(); $formatter = (new FormSubmissionFormatter($this->form, $this->data))->outputStringsOnly();
foreach ($formatter->getFieldsWithValue() as $field) { foreach ($formatter->getFieldsWithValue() as $field) {
$tmpVal = is_array($field['value']) ? implode(',', $field['value']) : $field['value']; $tmpVal = is_array($field['value']) ? implode(',', $field['value']) : $field['value'];
$submissionString .= '>*' . ucfirst($field['name']) . '*: ' . $tmpVal . " \n"; $submissionString .= '>*' . ucfirst($field['name']) . '*: ' . $tmpVal . " \n";
} }
$blocks[] = [
$formURL = url('forms/' . $this->form->slug);
$editFormURL = url('forms/' . $this->form->slug . '/show');
$submissionId = Hashids::encode($this->data['submission_id']);
$externalLinks = [
'*<' . $formURL . '|🔗 Open Form>*',
'*<' . $editFormURL . '|✍️ Edit Form>*'
];
if ($this->form->editable_submissions) {
$externalLinks[] = '*<' . $this->form->share_url . '?submission_id=' . $submissionId . '|✍️ ' . $this->form->editable_submissions_button_text . '>*';
}
return [
'blocks' => [
[
'type' => 'section',
'text' => [
'type' => 'mrkdwn',
'text' => 'New submission for your form *<' . $formURL . '|' . $this->form->title . ':>*',
],
],
[
'type' => 'section', 'type' => 'section',
'text' => [ 'text' => [
'type' => 'mrkdwn', 'type' => 'mrkdwn',
'text' => $submissionString, 'text' => $submissionString,
], ]
], ];
[ }
if(Arr::get($settings, 'views_submissions_count', true)){
$countString = '*👀 Views*: ' . (string)$this->form->views_count . " \n";
$countString .= '*🖊️ Submissions*: ' . (string)$this->form->submissions_count;
$blocks[] = [
'type' => 'section',
'text' => [
'type' => 'mrkdwn',
'text' => $countString,
]
];
}
if(count($externalLinks) > 0){
$blocks[] = [
'type' => 'section', 'type' => 'section',
'text' => [ 'text' => [
'type' => 'mrkdwn', 'type' => 'mrkdwn',
'text' => implode(' ', $externalLinks), 'text' => implode(' ', $externalLinks),
], ]
], ];
], }
return [
'blocks' => $blocks
]; ];
} }

View File

@ -84,6 +84,8 @@ class FormFactory extends Factory
'password' => false, 'password' => false,
'tags' => [], 'tags' => [],
'slack_webhook_url' => null, 'slack_webhook_url' => null,
'discord_webhook_url' => null,
'notification_settings' => [],
'editable_submissions_button_text' => 'Edit submission', 'editable_submissions_button_text' => 'Edit submission',
'confetti_on_submission' => false, 'confetti_on_submission' => false,
'seo_meta' => [], 'seo_meta' => [],

View File

@ -0,0 +1,32 @@
<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
return new class extends Migration
{
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::table('forms', function (Blueprint $table) {
$table->json('notification_settings')->default('{}')->nullable(true);
});
}
/**
* Reverse the migrations.
*
* @return void
*/
public function down()
{
Schema::table('forms', function (Blueprint $table) {
$table->dropColumn('notification_settings');
});
}
};

View File

@ -28,23 +28,29 @@
<toggle-switch-input name="notifies_discord" :form="form" class="mt-4" <toggle-switch-input name="notifies_discord" :form="form" class="mt-4"
label="Receive a Discord notification on submission" label="Receive a Discord notification on submission"
/> />
<text-input v-if="form.notifies_discord" name="discord_webhook_url" :form="form" class="mt-4" <template v-if="form.notifies_discord">
<text-input name="discord_webhook_url" :form="form" class="mt-4"
label="Discord webhook url" help="help" label="Discord webhook url" help="help"
> >
<template #help> <template #help>
Receive a discord message on each form submission. Receive a discord message on each form submission.
<a href="https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks" target="_blank">Click here</a> to learn how to get a discord webhook url. <a href="https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks" target="_blank">Click
here</a> to learn how to get a discord webhook url.
</template> </template>
</text-input> </text-input>
<h4 class="font-bold mt-4">Discord message actions</h4>
<form-notifications-message-actions v-model="form.notification_settings.discord" />
</template>
</modal> </modal>
</div> </div>
</template> </template>
<script> <script>
import ProTag from '../../../../../common/ProTag.vue' import ProTag from '../../../../../common/ProTag.vue'
import FormNotificationsMessageActions from './FormNotificationsMessageActions.vue'
export default { export default {
components: { ProTag }, components: { ProTag, FormNotificationsMessageActions },
props: {}, props: {},
data () { data () {
return { return {

View File

@ -0,0 +1,64 @@
<template>
<div>
<toggle-switch-input name="include_submission_data" v-model="compVal.include_submission_data" class="mt-4"
label="Include submission data"
help="With form submission answers"
/>
<toggle-switch-input name="link_open_form" v-model="compVal.link_open_form" class="mt-4"
label="Open Form"
help="Link to the form public page"
/>
<toggle-switch-input name="link_edit_form" v-model="compVal.link_edit_form" class="mt-4"
label="Edit Form"
help="Link to the form admin page"
/>
<toggle-switch-input name="views_submissions_count" v-model="compVal.views_submissions_count" class="mt-4"
label="Analytics (views & submissions)"
/>
<toggle-switch-input name="link_edit_submission" v-model="compVal.link_edit_submission" class="mt-4"
label="Link to the Edit Submission Record"
/>
</div>
</template>
<script>
export default {
name: 'FormNotificationsMessageActions',
components: { },
props: {
value: { required: false }
},
data () {
return {
content: this.value
}
},
computed: {
compVal: {
set (val) {
this.content = val
this.$emit('input', this.compVal)
},
get () {
return this.content
}
}
},
watch: {},
mounted () {
if(this.compVal === undefined || this.compVal === null){
this.compVal = {}
}
['include_submission_data', 'link_open_form', 'link_edit_form', 'views_submissions_count', 'link_edit_submission'].forEach((keyname) => {
if (this.compVal[keyname] === undefined) {
this.compVal[keyname] = true
}
})
},
methods: { }
}
</script>

View File

@ -28,22 +28,30 @@
<toggle-switch-input name="notifies_slack" :form="form" class="mt-4" <toggle-switch-input name="notifies_slack" :form="form" class="mt-4"
label="Receive a Slack notification on submission" label="Receive a Slack notification on submission"
/> />
<text-input v-if="form.notifies_slack" name="slack_webhook_url" :form="form" class="mt-4" <template v-if="form.notifies_slack">
<text-input name="slack_webhook_url" :form="form" class="mt-4"
label="Slack webhook url" help="help" label="Slack webhook url" help="help"
> >
<template #help> <template #help>
Receive slack message on each form submission. <a href="https://api.slack.com/messaging/webhooks" target="_blank">Click here</a> to learn how to get a slack webhook url Receive slack message on each form submission. <a href="https://api.slack.com/messaging/webhooks"
target="_blank"
>Click here</a> to learn how to get a slack
webhook url
</template> </template>
</text-input> </text-input>
<h4 class="font-bold mt-4">Slack message actions</h4>
<form-notifications-message-actions v-model="form.notification_settings.slack" />
</template>
</modal> </modal>
</div> </div>
</template> </template>
<script> <script>
import ProTag from '../../../../../common/ProTag.vue' import ProTag from '../../../../../common/ProTag.vue'
import FormNotificationsMessageActions from './FormNotificationsMessageActions.vue'
export default { export default {
components: { ProTag }, components: { ProTag, FormNotificationsMessageActions },
props: {}, props: {},
data () { data () {
return { return {

View File

@ -14,6 +14,7 @@ export default {
slack_notifies: false, slack_notifies: false,
send_submission_confirmation: false, send_submission_confirmation: false,
webhook_url: null, webhook_url: null,
notification_settings: {},
// Customization // Customization
theme: 'default', theme: 'default',

View File

@ -38,8 +38,6 @@ it('check formstat chart data', function () {
} }
// Now check chart data // Now check chart data
$response = $this->getJson(route('open.workspaces.form.stats', [$workspace->id, $form->id]));
$this->getJson(route('open.workspaces.form.stats', [$workspace->id, $form->id])) $this->getJson(route('open.workspaces.form.stats', [$workspace->id, $form->id]))
->assertSuccessful() ->assertSuccessful()
->assertJson(function (\Illuminate\Testing\Fluent\AssertableJson $json) use ($views, $submissions) { ->assertJson(function (\Illuminate\Testing\Fluent\AssertableJson $json) use ($views, $submissions) {