-
Notifications
You must be signed in to change notification settings - Fork 5
/
class-gf-helpscout.php
2549 lines (2037 loc) · 70.4 KB
/
class-gf-helpscout.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
// don't load directly
if ( ! defined( 'ABSPATH' ) ) {
die();
}
GFForms::include_feed_addon_framework();
/**
* Gravity Forms Help Scout Add-On.
*
* @since 1.0
* @package GravityForms
* @author Rocketgenius
* @copyright Copyright (c) 2016, Rocketgenius
*/
class GFHelpScout extends GFFeedAddOn {
/**
* Contains an instance of this class, if available.
*
* @since 1.0
* @access private
* @var object $_instance If available, contains an instance of this class.
*/
private static $_instance = null;
/**
* Defines the version of the Help Scout Add-On.
*
* @since 1.0
* @access protected
* @var string $_version Contains the version, defined from helpscout.php
*/
protected $_version = GF_HELPSCOUT_VERSION;
/**
* Defines the minimum Gravity Forms version required.
*
* @since 1.0
* @access protected
* @var string $_min_gravityforms_version The minimum version required.
*/
protected $_min_gravityforms_version = '2.4.6';
/**
* Defines the plugin slug.
*
* @since 1.0
* @access protected
* @var string $_slug The slug used for this plugin.
*/
protected $_slug = 'gravityformshelpscout';
/**
* Defines the main plugin file.
*
* @since 1.0
* @access protected
* @var string $_path The path to the main plugin file, relative to the plugins folder.
*/
protected $_path = 'gravityformshelpscout/helpscout.php';
/**
* Defines the full path to this class file.
*
* @since 1.0
* @access protected
* @var string $_full_path The full path.
*/
protected $_full_path = __FILE__;
/**
* Defines the URL where this Add-On can be found.
*
* @since 1.0
* @access protected
* @var string The URL of the Add-On.
*/
protected $_url = 'http://www.gravityforms.com/';
/**
* Defines the title of this Add-On.
*
* @since 1.0
* @access protected
* @var string $_title The title of the Add-On.
*/
protected $_title = 'Gravity Forms Help Scout Add-On';
/**
* Defines the short title of the Add-On.
*
* @since 1.0
* @access protected
* @var string $_short_title The short title.
*/
protected $_short_title = 'Help Scout';
/**
* Defines if Add-On should use Gravity Forms servers for update data.
*
* @since 1.0
* @access protected
* @var bool
*/
protected $_enable_rg_autoupgrade = true;
/**
* Defines if only the first matching feed will be processed.
*
* @since 1.0
* @access protected
* @var bool
*/
protected $_single_feed_submission = true;
/**
* Defines the capability needed to access the Add-On settings page.
*
* @since 1.0
* @access protected
* @var string $_capabilities_settings_page The capability needed to access the Add-On settings page.
*/
protected $_capabilities_settings_page = 'gravityforms_helpscout';
/**
* Defines the capability needed to access the Add-On form settings page.
*
* @since 1.0
* @access protected
* @var string $_capabilities_form_settings The capability needed to access the Add-On form settings page.
*/
protected $_capabilities_form_settings = 'gravityforms_helpscout';
/**
* Defines the capability needed to uninstall the Add-On.
*
* @since 1.0
* @access protected
* @var string $_capabilities_uninstall The capability needed to uninstall the Add-On.
*/
protected $_capabilities_uninstall = 'gravityforms_helpscout_uninstall';
/**
* Defines the capabilities needed for the Help Scout Add-On
*
* @since 1.0
* @access protected
* @var array $_capabilities The capabilities needed for the Add-On
*/
protected $_capabilities = array( 'gravityforms_helpscout', 'gravityforms_helpscout_uninstall' );
/**
* Contains an instance of the Help Scout API library, if available.
*
* @since 1.0
* @access protected
* @var GF_HelpScout_API $api If available, contains an instance of the Help Scout API library.
*/
protected $api = null;
/**
* Indicates if the add-on is authenticated with the Help Scout API.
*
* @since 1.13
*
* @var null|bool
*/
protected $_is_authenticated = null;
/**
* Get instance of this class.
*
* @since 1.0
* @access public
* @static
*
* @return $_instance
*/
public static function get_instance() {
if ( null === self::$_instance ) {
self::$_instance = new GFHelpScout();
}
return self::$_instance;
}
/**
* Register needed plugin hooks and PayPal delayed payment support.
*
* @since 1.0
* @access public
*
* @uses GFAddOn::is_gravityforms_supported()
* @uses GFFeedAddOn::add_delayed_payment_support()
*/
public function init() {
parent::init();
if ( $this->is_gravityforms_supported( '2.0-beta-3' ) ) {
add_filter( 'gform_entry_detail_meta_boxes', array( $this, 'register_meta_box' ), 10, 3 );
} else {
add_action( 'gform_entry_detail_sidebar_middle', array( $this, 'add_entry_detail_panel' ), 10, 2 );
}
add_action( 'admin_init', array( $this, 'maybe_create_conversation' ) );
add_action( 'admin_init', array( $this, 'maybe_conversation_redirect' ) );
add_filter( 'gform_addnote_button', array( $this, 'add_note_checkbox' ) );
add_action( 'gform_post_note_added', array( $this, 'add_note_to_conversation' ), 10, 6 );
add_filter( 'gform_entries_column_filter', array( $this, 'add_entry_conversation_column_link' ), 10, 5 );
add_filter( 'gform_entry_list_bulk_actions', array( $this, 'add_bulk_action' ), 10, 2 );
add_action( 'gform_entry_list_action_helpscout', array( $this, 'process_entry_list_bulk_action' ), 10, 3 );
$this->add_delayed_payment_support(
array(
'option_label' => esc_html__( 'Create conversation in Help Scout only when payment is received.', 'gravityformshelpscout' ),
)
);
add_filter( 'gform_replace_merge_tags', array( $this, 'replace_merge_tags' ), 10, 7 );
add_filter( 'gform_settings_header_buttons', array( $this, 'filter_gform_settings_header_buttons' ), 99 );
}
public function init_ajax() {
parent::init_ajax();
add_action( 'wp_ajax_gform_helpscout_save_app_keys', array( $this, 'ajax_save_app_keys' ) );
}
public function scripts() {
$min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG || isset( $_GET['gform_debug'] ) ? '' : '.min';
$scripts = array(
array(
'handle' => 'gform_helpscout_plugin_settings',
'deps' => array( 'jquery', 'gform_form_admin' ),
'src' => $this->get_base_url() . "/js/plugin_settings{$min}.js",
'version' => $this->_version,
'enqueue' => array(
array(
'admin_page' => array( 'plugin_settings' ),
'tab' => $this->_slug,
),
),
'strings' => array(
'nonce_save' => wp_create_nonce( 'gform_helpscout_save_app_keys' ),
'settings_url' => admin_url( 'admin.php?page=gf_settings&subview=' . $this->_slug ),
),
),
array(
'handle' => 'gform_helpscout_merge_tags',
'deps' => array( 'gform_gravityforms' ),
'src' => $this->get_base_url() . "/js/merge_tags{$min}.js",
'version' => $this->_version,
'enqueue' => array(
array(
'admin_page' => array( 'form_settings' ),
'tab' => 'notification'
),
),
'strings' => array(
'id' => wp_strip_all_tags( __( 'Conversation ID', 'gravityformshelpscout' ) ),
'number' => wp_strip_all_tags( __( 'Conversation Number', 'gravityformshelpscout' ) ),
'status' => wp_strip_all_tags( __( 'Conversation Status', 'gravityformshelpscout' ) ),
'subject' => wp_strip_all_tags( __( 'Conversation Subject', 'gravityformshelpscout' ) ),
'url' => wp_strip_all_tags( __( 'Conversation URL', 'gravityformshelpscout' ) ),
),
)
);
return array_merge( parent::scripts(), $scripts );
}
public function styles() {
$min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG || isset( $_GET['gform_debug'] ) ? '' : '.min';
$styles = array(
array(
'handle' => 'gform_helpscout_admin',
'src' => $this->get_base_url() . "/css/admin{$min}.css",
'version' => $this->_version,
'enqueue' => array(
array(
'admin_page' => array( 'plugin_settings' ),
'tab' => $this->_slug,
),
),
),
);
return array_merge( parent::styles(), $styles );
}
// # PLUGIN SETTINGS -----------------------------------------------------------------------------------------------
public function plugin_settings_page() {
if ( ! rgempty( 'gform_helpscout_retry_refresh' ) && ! $this->is_authenticated() && $this->api()->is_access_token_expired() ) {
GFCommon::add_error_message( esc_html__( 'Unable to refresh access token with Help Scout.', 'gravityformshelpscout' ) );
}
// If deauth button is clicked, deauth plugin.
elseif( rgpost( '_gaddon_setting_deauth' ) ) {
$this->api()->delete_access_token();
GFCache::delete( $this->get_slug() . '_mailboxes_choices' );
}
// If access token is provided, save it.
elseif ( rgpost( 'access_token' ) && ! rgpost( '_gaddon_setting_deauth' ) ) {
// Verify state.
if ( ! wp_verify_nonce( rgpost( 'state') , $this->get_authentication_state_action() ) ) {
GFCommon::add_error_message( esc_html__( 'Unable to authenticate with Help Scout due to mismatched state.', 'gravityformshelpscout' ) );
} else {
$this->api()->save_access_token( $_POST );
}
}
// If error is provided, display message.
elseif ( rgpost( 'auth_error' ) ) {
// Add error message.
GFCommon::add_error_message( esc_html__( 'Unable to authenticate with Help Scout.', 'gravityformshelpscout' ) );
} elseif( rgpost( 'gform_helpscout_enable_custom_app' ) ) {
$settings = $this->get_plugin_settings();
$settings['customAppEnable'] = 1;
$this->update_plugin_settings( $settings );
} elseif( rgpost( 'gform_helpscout_disable_custom_app' ) ) {
$settings = $this->get_plugin_settings();
$settings['customAppEnable'] = 0;
$this->update_plugin_settings( $settings );
$this->api()->delete_app_keys();
} elseif( rgget( 'code' ) && wp_verify_nonce( rgget( 'state' ), $this->get_authentication_state_action() ) ) {
$this->api()->do_custom_app_auth( rgget( 'code' ) );
}
// Migrate v1 API key to v2 access token.
elseif( $this->get_plugin_setting( 'api_key' ) ) {
$this->transition();
}
parent::plugin_settings_page();
}
/**
* Hide submit button on plugin settings page.
*
* @since 1.13
*
* @param string $html
*
* @return string
*/
public function filter_gform_settings_header_buttons( $html = '' ) {
// If this is not the plugin settings page, return.
if ( ! $this->is_plugin_settings( $this->get_slug() ) ) {
return $html;
}
return '';
}
/**
* Exchanges a v1 API Key for a v2 OAuth token.
*
* @since 1.6
*/
public function transition() {
$this->log_debug( __METHOD__ . '(): Requesting v2 OAuth token for v1 API key.' );
$settings = $this->get_plugin_settings();
$v1_api_key = rgar( $settings, 'api_key' );
$access_token = $this->api()->transition( $v1_api_key );
if ( $access_token ) {
$this->log_debug( __METHOD__ . '(): Refreshing token.' );
// Clear the v1 API key since we've now authenticated via oAuth.
$settings['api_key'] = '';
$this->update_plugin_settings( $settings );
// v1 API keys can only be migrated once but will always generated a valid refresh token.
// Let's assume that the key has been migrated before and refresh it immediately.
$access_token = $this->api()->refresh( $access_token['refresh_token'] );
if ( $access_token ) {
$this->log_debug( __METHOD__ . '(): Saving token.' );
$this->api()->save_access_token( $access_token );
} else {
$this->log_error( __METHOD__ . '(): Refresh request failed.' );
}
} else {
$this->log_error( __METHOD__ . '(): Transition request failed.' );
}
}
/**
* Setup plugin settings fields.
*
* @since 1.0
* @access public
*
* @uses GFHelpScout::plugin_settings_description()
*
* @return array
*/
public function plugin_settings_fields() {
$fields = array(
array(
'name' => 'accessToken',
'type' => 'hidden',
),
array(
'name' => 'customAppEnable',
'type' => 'hidden',
),
array(
'name' => 'auth',
'label' => null,
'type' => 'auth_token_button',
),
);
return array(
array(
'title' => '',
'description' => $this->plugin_settings_description(),
'fields' => $fields,
),
);
}
/**
* Prepare plugin settings description.
*
* @since 1.0
* @access public
*
* @return string
*/
public function plugin_settings_description() {
// Prepare description.
$description = sprintf(
'<p>%s</p>',
sprintf(
esc_html__( 'Help Scout makes it easy to provide your customers with a great support experience. Use Gravity Forms to collect customer information and automatically create a new Help Scout conversation. If you don\'t have a Help Scout account, you can %1$ssign up for one here.%2$s', 'gravityformshelpscout' ),
'<a href="http://www.helpscout.net/" target="_blank">', '</a>'
)
);
return $description;
}
/**
* Create Generate Auth Token settings field.
*
* @since 2.0
* @access public
*
* @param array $field Field settings.
* @param bool $echo Display field. Defaults to true.
*
* @return string
*/
public function settings_auth_token_button( $field, $echo = true ) {
// Initialize return HTML.
$html = '';
// Get the plugin settings.
$settings = $this->get_plugin_settings();
$custom_app_enabled = '1' == rgar( $settings, 'customAppEnable' );
// Get button class.
$button_class = version_compare( GFForms::$version, '2.5-dev-1', '<' ) ? 'button-secondary' : 'button secondary';
// If HelpScout is authenticated, display de-authorize button.
if ( $this->is_authenticated() ) {
$message = $custom_app_enabled ? __( 'Custom app authenticated with Help Scout.', 'gravityformshelpscout' ) : __( 'Authenticated with Help Scout.', 'gravityformshelpscout' );
$html .= sprintf( '<p><i class="fa fa-check gf_valid"></i> %s</p>', esc_html( $message ) );
$html .= sprintf(
' <button class="%2$s" name="_gaddon_setting_deauth" value="1">%1$s</a>',
esc_html__( 'Disconnect Help Scout', 'gravityformshelpscout' ),
$button_class
);
} else {
if ( rgempty( 'gform_helpscout_retry_refresh' ) && $this->api()->is_access_token_expired() ) {
$html .= sprintf(
' <button class="%2$s" name="gform_helpscout_retry_refresh" value="1">%1$s</a>',
esc_html__( 'Click here to refresh access token.', 'gravityformshelpscout' ),
$button_class
);
} elseif ( $custom_app_enabled ) {
// If SSL is available, display custom app settings.
if ( is_ssl() ) {
$html .= $this->custom_app_settings();
} else {
// @todo style this as an error
$html .= '<p>';
$html .= esc_html__( 'To use a custom Help Scout app, you must have an SSL certificate installed and enabled. Visit this page after configuring your SSL certificate to use a custom Help Scout app.', 'gravityformshelpscout' );
$html .= '</p>';
}
$html .= '<p class="gform_helpscout_disclaimer">';
$html .= sprintf(
'<button type="submit" id="gform_helpscout_disable_custom_app" name="gform_helpscout_disable_custom_app" value="1">%s</button>',
esc_html__( 'I don\'t want to use a custom Help Scout app.', 'gravityformshelpscout' )
);
$html .= '</p>';
} else {
// Prepare authorization URL.
$license_key = GFCommon::get_key();
$settings_url = urlencode( $this->get_redirect_url() );
$auth_url = add_query_arg(
array(
'redirect_to' => $settings_url,
'license' => $license_key,
'state' => wp_create_nonce( $this->get_authentication_state_action() ),
),
$this->api()->get_gravity_api_url( '/auth/helpscout' )
);
$html .= sprintf(
'<a href="%2$s" class="button" id="gform_helpscout_auth_button">%1$s</a>',
esc_html__( 'Click here to connect to Help Scout.', 'gravityformshelpscout' ),
$auth_url
);
$html .= '<p class="gform_helpscout_disclaimer">';
$html .= sprintf(
'<button type="submit" id="gform_helpscout_enable_custom_app" name="gform_helpscout_enable_custom_app" value="1">%s</button> %s',
esc_html__( 'I want to use a custom Help Scout app.', 'gravityformshelpscout' ),
esc_html__( '(Recommended for advanced users only.)')
);
$html .= '</p>';
}
}
if ( $echo ) {
echo $html;
}
return $html;
}
/**
* Renders settings section for custom Dropbox app.
*
* @since 2.0
* @access public
*
* @uses GFAddOn::get_plugin_settings()
* @uses GFAddOn::single_setting_row()
* @uses GF_Dropbox::get_auth_url()
* @uses GF_Dropbox::get_redirect_uri()
* @uses GF_Dropbox::is_valid_app_key_secret()
*
* @return string
*/
public function custom_app_settings() {
// Open custom app table.
$html = '<table class="form-table gf-helpscout-custom-app">';
ob_start();
// Display redirect URI.
$this->single_setting_row(
array(
'name' => '',
'type' => 'text',
'label' => esc_html__( 'OAuth Redirect URI', 'gravityformshelpscout' ),
'class' => 'large',
'value' => $this->get_redirect_url(),
'readonly' => true,
'onclick' => 'this.select();',
)
);
// Display custom app key.
$this->single_setting_row(
array(
'name' => 'customAppKey',
'type' => 'api_key',
'label' => esc_html__( 'App Key', 'gravityformshelpscout' ),
'class' => 'medium',
'callback' => array( $this, 'settings_api_key' ),
'feedback_callback' => array( $this, 'is_valid_app_key_secret' ),
'value' => $this->api()->get_custom_app_keys( 'app_key' ),
)
);
// Display custom app secret.
$this->single_setting_row(
array(
'name' => 'customAppSecret',
'type' => 'api_key',
'label' => esc_html__( 'App Secret', 'gravityformshelpscout' ),
'class' => 'medium',
'callback' => array( $this, 'settings_api_key' ),
'value' => $this->api()->get_custom_app_keys( 'app_secret' ),
)
);
$html .= ob_get_contents();
ob_end_clean();
// Close custom app table.
$html .= '</table>';
// Prepare authorization URL.
$auth_url = '';
$app_keys = $this->api()->get_custom_app_keys();
if( ! empty( $app_keys['app_key'] ) && ! empty( $app_keys['app_secret'] ) && ! is_wp_error( $this->api()->validate_app_keys( $app_keys['app_key'], $app_keys['app_secret'] ) ) ) {
$auth_url = $this->api()->get_auth_url();
}
$html .= sprintf(
'<a href="%2$s" class="button" id="authButton">%1$s</a>',
esc_html__( 'Click here to connect to Help Scout.', 'gravityformshelpscout' ),
$auth_url
);
return $html;
}
public function settings_api_key( $field, $echo = true ) {
$attributes = $this->get_field_attributes( $field );
$value = rgar( $field, 'value' );
$html = '';
$html .= '<input
type="text"
name="_gaddon_setting_' . esc_attr( $field['name'] ) . '"
value="' . esc_attr( htmlspecialchars( $value, ENT_QUOTES ) ) . '" ' .
implode( ' ', $attributes ) .
' />';
if ( $echo ) {
echo $html;
}
return $html;
}
public function ajax_save_app_keys() {
// Verify nonce.
if ( false === wp_verify_nonce( rgpost( 'nonce' ), 'gform_helpscout_save_app_keys' ) ) {
wp_send_json_error( array( 'message' => esc_html__( 'Access denied.', 'gravityformshelpscout' ) ) );
}
// If user is not authorized, exit.
if ( ! GFCommon::current_user_can_any( $this->_capabilities_settings_page ) ) {
wp_send_json_error( array( 'message' => esc_html__( 'Access denied.', 'gravityformshelpscout' ) ) );
}
$app_key = rgpost( 'app_key' );
$app_secret = rgpost( 'app_secret' );
if ( ! $app_key || ! $app_secret ) {
wp_send_json_error( array( 'message' => 'The app key or app secret is missing.' ) );
}
$response = $this->api()->validate_app_keys( $app_key, $app_secret );
if ( is_wp_error( $response ) ) {
wp_send_json_error( array( 'message' => $response->get_error_message() ) );
}
$this->api()->save_app_keys( $app_key, $app_secret );
wp_send_json_success( array(
'authUrl' => $this->api()->get_auth_url()
) );
}
public function uninstall() {
parent::uninstall();
delete_option( 'gravityformsaddon_gravityformshelpscout_version' );
delete_option( 'gf_helpscout_api_access_token' );
delete_option( 'gf_helpscout_api_custom_app_keys' );
}
/**
* Defines the supported notification events.
*
* @since 1.8
*
* @param array $form The current form.
*
* @return array
*/
public function supported_notification_events( $form ) {
$slug = $this->get_slug();
return array(
"{$slug}_conversation_created" => __( 'Help Scout Conversation Created', 'gravityformshelpscout' ),
);
}
// # FEED SETTINGS -------------------------------------------------------------------------------------------------
/**
* Setup fields for feed settings.
*
* @since 1.0
* @access public
*
* @uses GFAddOn::add_field_after()
* @uses GFAddOn::get_first_field_by_type()
* @uses GFFeedAddOn::get_default_feed_name()
* @uses GFHelpScout::file_fields_for_feed_setup()
* @uses GFHelpScout::mailboxes_for_feed_setting()
* @uses GFHelpScout::message_types_for_feed_setup()
* @uses GFHelpScout::status_types_for_feed_setup()
* @uses GFHelpScout::users_for_feed_settings()
*
* @return array
*/
public function feed_settings_fields() {
$settings = array(
array(
'fields' => array(
array(
'name' => 'feed_name',
'type' => 'text',
'required' => true,
'class' => 'medium',
'label' => esc_html__( 'Name', 'gravityformshelpscout' ),
'default_value' => $this->get_default_feed_name(),
'tooltip' => sprintf(
'<h6>%s</h6>%s',
esc_html__( 'Name', 'gravityformshelpscout' ),
esc_html__( 'Enter a feed name to uniquely identify this setup.', 'gravityformshelpscout' )
),
),
array(
'name' => 'mailbox',
'type' => 'select',
'required' => true,
'choices' => $this->mailboxes_for_feed_setting(),
'onchange' => "jQuery(this).parents('form').submit();",
'label' => esc_html__( 'Destination Mailbox', 'gravityformshelpscout' ),
'tooltip' => sprintf(
'<h6>%s</h6>%s',
esc_html__( 'Destination Mailbox', 'gravityformshelpscout' ),
esc_html__( 'Select the Help Scout Mailbox this form entry will be sent to.', 'gravityformshelpscout' )
),
),
array(
'name' => 'user',
'type' => 'select',
'dependency' => 'mailbox',
'choices' => $this->users_for_feed_settings(),
'label' => esc_html__( 'Assignee', 'gravityformshelpscout' ),
'tooltip' => sprintf(
'<h6>%s</h6>%s',
esc_html__( 'Assignee', 'gravityformshelpscout' ),
esc_html__( 'Choose the Help Scout Team or User this form entry will be assigned to.', 'gravityformshelpscout' )
),
),
),
),
array(
'title' => esc_html__( 'Customer Details', 'gravityformshelpscout' ),
'dependency' => 'mailbox',
'fields' => array(
array(
'name' => 'customer_email',
'type' => 'field_select',
'required' => true,
'label' => esc_html__( 'Email Address', 'gravityformshelpscout' ),
'default_value' => $this->get_first_field_by_type( 'email' ),
'args' => array( 'input_types' => array( 'email', 'hidden' ) ),
),
array(
'name' => 'customer_first_name',
'type' => 'field_select',
'required' => true,
'label' => esc_html__( 'First Name', 'gravityformshelpscout' ),
'default_value' => $this->get_first_field_by_type( 'name', 3 ),
),
array(
'name' => 'customer_last_name',
'type' => 'field_select',
'label' => esc_html__( 'Last Name', 'gravityformshelpscout' ),
'default_value' => $this->get_first_field_by_type( 'name', 6 ),
),
array(
'name' => 'customer_phone',
'type' => 'field_select',
'required' => false,
'label' => esc_html__( 'Phone Number', 'gravityformshelpscout' ),
'default_value' => $this->get_first_field_by_type( 'phone' ),
'args' => array( 'input_types' => array( 'phone', 'hidden' ) ),
),
),
),
array(
'title' => esc_html__( 'Message Details', 'gravityformshelpscout' ),
'dependency' => 'mailbox',
'fields' => array(
array(
'name' => 'tags',
'type' => 'text',
'label' => esc_html__( 'Tags', 'gravityformshelpscout' ),
'class' => 'medium merge-tag-support mt-position-right mt-hide_all_fields',
),
array(
'name' => 'subject',
'type' => 'text',
'required' => true,
'class' => 'medium merge-tag-support mt-position-right mt-hide_all_fields',
'label' => esc_html__( 'Subject', 'gravityformshelpscout' ),
'default_value' => 'New submission from {form_title}',
),
array(
'name' => 'body',
'type' => 'textarea',
'required' => true,
'use_editor' => true,
'class' => 'large',
'label' => esc_html__( 'Message Body', 'gravityformshelpscout' ),
'default_value' => '{all_fields}',
),
),
),
array(
'title' => esc_html__( 'Message Options', 'gravityformshelpscout' ),
'dependency' => 'mailbox',
'fields' => array(
array(
'name' => 'status',
'type' => 'select',
'choices' => $this->status_types_for_feed_setup(),
'label' => esc_html__( 'Message Status', 'gravityformshelpscout' ),
),
array(
'name' => 'type',
'type' => 'select',
'choices' => $this->message_types_for_feed_setup(),
'label' => esc_html__( 'Message Type', 'gravityformshelpscout' ),
),
array(
'name' => 'note',
'type' => 'textarea',
'use_editor' => true,
'class' => 'medium',
'label' => esc_html__( 'Note', 'gravityformshelpscout' ),
),
array(
'name' => 'auto_reply',
'type' => 'checkbox',
'label' => esc_html__( 'Auto Reply', 'gravityformshelpscout' ),
'choices' => array(
array(
'name' => 'auto_reply',
'label' => esc_html__( 'Send Help Scout auto reply when message is created', 'gravityformshelpscout' ),
),
),
),
),
),
array(
'title' => esc_html__( 'Feed Conditional Logic', 'gravityformshelpscout' ),
'dependency' => 'mailbox',
'fields' => array(
array(
'name' => 'feed_condition',
'type' => 'feed_condition',
'label' => esc_html__( 'Conditional Logic', 'gravityformshelpscout' ),
'checkbox_label' => esc_html__( 'Enable', 'gravityformshelpscout' ),
'instructions' => esc_html__( 'Export to Help Scout if', 'gravityformshelpscout' ),
'tooltip' => sprintf(
'<h6>%s</h6>%s',
esc_html__( 'Conditional Logic', 'gravityformshelpscout' ),
esc_html__( 'When conditional logic is enabled, form submissions will only be exported to Help Scout when the condition is met. When disabled, all form submissions will be posted.', 'gravityformshelpscout' )
),
),
),
),
);
// Get available file fields.
$file_fields = $this->file_fields_for_feed_setup();
// If file fields are available, add feed setting.
if ( ! empty( $file_fields ) ) {
// Prepare field.
$field = array(
'name' => 'attachments',
'type' => 'checkbox',
'label' => esc_html__( 'Attachments', 'gravityformshelpscout' ),
'choices' => $file_fields,
);
// Add field.
$settings = $this->add_field_after( 'body', $field, $settings );
}
/**
* Enable the display of the CC setting on the Help Scout feed.
*
* @since 1.0
*
* @param bool $enable_cc Display CC setting.
*/
$enable_cc = apply_filters( 'gform_helpscout_enable_cc', true );
// If CC field is enabled, add feed setting.
if ( $enable_cc ) {
// Prepare field.
$field = array(
'name' => 'cc',
'type' => 'text',
'required' => false,
'class' => 'medium merge-tag-support mt-position-right mt-hide_all_fields',
'label' => esc_html__( 'CC', 'gravityformshelpscout' ),
);
// Add field.
$settings = $this->add_field_after( empty( $file_fields ) ? 'body' : 'attachments', $field, $settings );
}
/**
* Enable the display of the BCC setting on the Help Scout feed.
*
* @since 1.0
*
* @param bool $enable_bcc Display BCC setting.
*/
$enable_bcc = apply_filters( 'gform_helpscout_enable_bcc', false );
// If BCC field is enabled, add feed setting.
if ( $enable_bcc ) {
// Prepare field.
$field = array(
'name' => 'bcc',
'type' => 'text',
'required' => false,
'class' => 'medium merge-tag-support mt-position-right mt-hide_all_fields',
'label' => esc_html__( 'BCC', 'gravityformshelpscout' ),
);