| @@ -8,9 +8,12 @@ | ||
| 8 | 8 | namespace SRFM\Admin; |
| 9 | 9 | |
| 10 | 10 | use Astra_Notices; |
| 11 | 11 | use SRFM\Inc\AI_Form_Builder\AI_Helper; |
| 12 | +use SRFM\Inc\Client_Logger; | |
| 13 | +use SRFM\Inc\Database\Register; | |
| 12 | 14 | use SRFM\Inc\Database\Tables\Entries; |
| 15 | +use SRFM\Inc\Generate_Form_Markup; | |
| 13 | 16 | use SRFM\Inc\Global_Settings\Global_Settings; |
| 14 | 17 | use SRFM\Inc\Helper; |
| 15 | 18 | use SRFM\Inc\Onboarding; |
| 16 | 19 | use SRFM\Inc\Payments\Payment_Helper; |
| @@ -74,8 +77,30 @@ | ||
| 74 | 77 | */ |
| 75 | 78 | public const QUILL_1X_INLINE_CSS = '.ql-editor ul,.ql-editor ol{padding-left:1.5em}.ql-editor ul>li,.ql-editor ol>li{list-style-type:none}.ql-editor ol li:not(.ql-direction-rtl),.ql-editor ul li:not(.ql-direction-rtl){padding-left:1.5em}.ql-editor ol li.ql-direction-rtl,.ql-editor ul li.ql-direction-rtl{padding-right:1.5em}.ql-editor ul>li::before{content:"\2022"}.ql-editor li::before{display:inline-block;white-space:nowrap;width:1.2em}.ql-editor li:not(.ql-direction-rtl)::before{margin-left:-1.5em;margin-right:.3em;text-align:right}.ql-editor li.ql-direction-rtl::before{margin-left:.3em;margin-right:-1.5em}.ql-editor ol li{counter-reset:list-1 list-2 list-3 list-4 list-5 list-6 list-7 list-8 list-9;counter-increment:list-0}.ql-editor ol li::before{content:counter(list-0,decimal) ". "}.ql-editor ol li.ql-indent-1{counter-increment:list-1;counter-reset:list-2 list-3 list-4 list-5 list-6 list-7 list-8 list-9}.ql-editor ol li.ql-indent-1::before{content:counter(list-1,lower-alpha) ". "}.ql-editor ol li.ql-indent-2{counter-increment:list-2;counter-reset:list-3 list-4 list-5 list-6 list-7 list-8 list-9}.ql-editor ol li.ql-indent-2::before{content:counter(list-2,lower-roman) ". "}.ql-editor ol li.ql-indent-3{counter-increment:list-3;counter-reset:list-4 list-5 list-6 list-7 list-8 list-9}.ql-editor ol li.ql-indent-3::before{content:counter(list-3,decimal) ". "}.ql-editor ol li.ql-indent-4{counter-increment:list-4;counter-reset:list-5 list-6 list-7 list-8 list-9}.ql-editor ol li.ql-indent-4::before{content:counter(list-4,lower-alpha) ". "}.ql-editor ol li.ql-indent-5{counter-increment:list-5;counter-reset:list-6 list-7 list-8 list-9}.ql-editor ol li.ql-indent-5::before{content:counter(list-5,lower-roman) ". "}.ql-editor ol li.ql-indent-6{counter-increment:list-6;counter-reset:list-7 list-8 list-9}.ql-editor ol li.ql-indent-6::before{content:counter(list-6,decimal) ". "}.ql-editor ol li.ql-indent-7{counter-increment:list-7;counter-reset:list-8 list-9}.ql-editor ol li.ql-indent-7::before{content:counter(list-7,lower-alpha) ". "}.ql-editor ol li.ql-indent-8{counter-increment:list-8;counter-reset:list-9}.ql-editor ol li.ql-indent-8::before{content:counter(list-8,lower-roman) ". "}.ql-editor ol li.ql-indent-9{counter-increment:list-9}.ql-editor ol li.ql-indent-9::before{content:counter(list-9,decimal) ". "}'; |
| 76 | 79 | |
| 77 | 80 | /** |
| 81 | + * Notice id for the "Finish setting up" Thank You prompt (#3030). | |
| 82 | + * | |
| 83 | + * A single stable id (not per-form): keeps both the autoloaded | |
| 84 | + * `allowed_astra_notices` option and the per-user dismissal meta bounded to one | |
| 85 | + * row, and lets a dismissed user short-circuit before the query runs. | |
| 86 | + * | |
| 87 | + * @since 2.12.6 | |
| 88 | + */ | |
| 89 | + public const THANKYOU_PROMPT_NOTICE_ID = 'srfm-thankyou-prompt'; | |
| 90 | + | |
| 91 | + /** | |
| 92 | + * Where the dialog's Contact Support button goes. | |
| 93 | + * | |
| 94 | + * A form rather than an inbox: it collects the licence and site details support | |
| 95 | + * would otherwise have to ask for, and the diagnostics are already on the | |
| 96 | + * clipboard by the time someone gets here. | |
| 97 | + * | |
| 98 | + * @since 2.12.7 | |
| 99 | + */ | |
| 100 | + private const SUPPORT_CONTACT_URL = 'https://sureforms.com/form/troubleshooting-form/'; | |
| 101 | + | |
| 102 | + /** | |
| 78 | 103 | * Dashboard widget entries data. |
| 79 | 104 | * |
| 80 | 105 | * @var array |
| 81 | 106 | * @since 1.9.1 |
| @@ -124,8 +149,25 @@ | ||
| 124 | 149 | */ |
| 125 | 150 | private static $setup_card_cache = []; |
| 126 | 151 | |
| 127 | 152 | /** |
| 153 | + * Action items for this request, or null before the first build. | |
| 154 | + * | |
| 155 | + * Built twice on every admin page without this -- once for the localisation | |
| 156 | + * payload, once in the classic renderer -- and each open failure category reads | |
| 157 | + * a log excerpt. get_action_items() also records an impression, which running | |
| 158 | + * twice counted twice. | |
| 159 | + * | |
| 160 | + * Reset with reset_action_items_cache(). Admin is a singleton, so without that | |
| 161 | + * the first build pins the answer for the whole process and any test that | |
| 162 | + * records a failure and then asks again is testing the memo. | |
| 163 | + * | |
| 164 | + * @var array<int,array<string,mixed>>|null | |
| 165 | + * @since 2.12.7 | |
| 166 | + */ | |
| 167 | + private static $action_items_cache = null; | |
| 168 | + | |
| 169 | + /** | |
| 128 | 170 | * Class constructor. |
| 129 | 171 | * |
| 130 | 172 | * @return void |
| 131 | 173 | * @since 0.0.1 |
| @@ -155,8 +197,19 @@ | ||
| 155 | 197 | |
| 156 | 198 | add_action( 'current_screen', [ $this, 'enable_gutenberg_for_sureforms' ], 100 ); |
| 157 | 199 | // Register notices early for React pages (before admin_enqueue_scripts). |
| 158 | 200 | add_action( 'admin_init', [ $this, 'register_pro_compatibility_notices' ], 5 ); |
| 201 | + | |
| 202 | + // Database maintenance notice: the entries table is missing, so submissions | |
| 203 | + // cannot be saved. Registered at admin_init priority 5 so the React notice is | |
| 204 | + // in place before admin_enqueue_scripts localizes it. | |
| 205 | + add_action( 'admin_init', [ $this, 'register_database_repair_notice' ], 5 ); | |
| 206 | + add_action( 'admin_notices', [ $this, 'render_action_item_notices' ] ); | |
| 207 | + // Late priority so the items are built after anything hooking | |
| 208 | + // srfm_action_items has had a chance to register. | |
| 209 | + add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_action_item_styles' ], 20 ); | |
| 210 | + add_action( 'admin_notices', [ $this, 'render_database_repair_notice' ] ); | |
| 211 | + add_action( 'admin_post_srfm_repair_entries_table', [ $this, 'handle_database_repair' ] ); | |
| 159 | 212 | // Display notices on traditional WordPress admin pages. |
| 160 | 213 | add_action( 'admin_notices', [ $this, 'srfm_pro_version_compatibility' ] ); |
| 161 | 214 | |
| 162 | 215 | // Enfold theme compatibility to enable block editor for SureForms post type. |
| @@ -179,9 +232,14 @@ | ||
| 179 | 232 | add_action( 'wp_ajax_should_show_pointer', [ $this, 'pointer_should_show' ] ); |
| 180 | 233 | add_action( 'wp_ajax_sureforms_dismiss_pointer', [ $this, 'pointer_dismissed' ] ); |
| 181 | 234 | add_action( 'wp_ajax_sureforms_accept_cta', [ $this, 'pointer_accepted_cta' ] ); |
| 182 | 235 | add_action( 'wp_ajax_srfm_notice_response', [ $this, 'handle_notice_response' ] ); |
| 236 | + add_action( 'wp_ajax_srfm_action_item_details', [ $this, 'handle_action_item_details' ] ); | |
| 237 | + add_action( 'wp_ajax_srfm_dismiss_action_item', [ $this, 'handle_dismiss_action_item' ] ); | |
| 238 | + add_action( 'admin_post_srfm_dismiss_action_item_link', [ $this, 'handle_dismiss_action_item_link' ] ); | |
| 183 | 239 | add_action( 'wp_ajax_srfm_ai_widget_usage', [ $this, 'track_ai_widget_usage' ] ); |
| 240 | + add_action( 'load-post.php', [ $this, 'maybe_track_edit_form_button_click' ] ); | |
| 241 | + add_filter( 'removable_query_args', [ $this, 'add_removable_query_args' ] ); | |
| 184 | 242 | |
| 185 | 243 | // Register dashboard widget only if there are recent entries. |
| 186 | 244 | add_action( 'admin_init', [ $this, 'maybe_register_dashboard_widget' ] ); |
| 187 | 245 | |
| @@ -421,8 +479,22 @@ | ||
| 421 | 479 | return self::$thankyou_prompt_cache; |
| 422 | 480 | } |
| 423 | 481 | |
| 424 | 482 | /** |
| 483 | + * Clear the request memo for the action items. | |
| 484 | + * | |
| 485 | + * Admin is a singleton, so the memo outlives a request in a test process. | |
| 486 | + * Anything that records or clears a failure inside one process has to call | |
| 487 | + * this, or it reads the answer from before the change. | |
| 488 | + * | |
| 489 | + * @since 2.12.7 | |
| 490 | + * @return void | |
| 491 | + */ | |
| 492 | + public static function reset_action_items_cache() { | |
| 493 | + self::$action_items_cache = null; | |
| 494 | + } | |
| 495 | + | |
| 496 | + /** | |
| 425 | 497 | * Clear the request memo for the Thank You prompt (#3030). |
| 426 | 498 | * |
| 427 | 499 | * Lets tests exercise the memoized public path, and is a safe hook for anything |
| 428 | 500 | * that changes which form qualifies (e.g. a form save). |
| @@ -753,14 +825,19 @@ | ||
| 753 | 825 | * step (default Thank You message, or no reply destination). Uses a single |
| 754 | 826 | * stable notice id so the library's built-in ✕ dismissal is one persistent |
| 755 | 827 | * choice ("stop nudging me"), not a per-form row. |
| 756 | 828 | * |
| 757 | - * @since 2.12.4 | |
| 758 | - * @return void | |
| 829 | + * Split out from the renderer so the decision has exactly one home. The Getting | |
| 830 | + * Started notice suppresses itself when this returns a form, and duplicating the | |
| 831 | + * conditions there would have meant two copies drifting apart. Reading it costs | |
| 832 | + * nothing extra — get_thankyou_prompt_forms() memoizes its query per request. | |
| 833 | + * | |
| 834 | + * @since 2.12.6 | |
| 835 | + * @return array<string,mixed>|null The form to prompt for, or null when no prompt should render. | |
| 759 | 836 | */ |
| 760 | - public function render_thankyou_prompt_notice() { | |
| 837 | + public function get_displayable_thankyou_prompt() { | |
| 761 | 838 | if ( ! Helper::current_user_can() || ! class_exists( 'Astra_Notices' ) ) { |
| 762 | - return; | |
| 839 | + return null; | |
| 763 | 840 | } |
| 764 | 841 | |
| 765 | 842 | /** |
| 766 | 843 | * Short-circuit the "Finish setting up" Thank You notice. |
| @@ -769,9 +846,9 @@ | ||
| 769 | 846 | * |
| 770 | 847 | * @since 2.12.4 |
| 771 | 848 | */ |
| 772 | 849 | if ( ! apply_filters( 'srfm_show_thankyou_prompt', true ) ) { |
| 773 | - return; | |
| 850 | + return null; | |
| 774 | 851 | } |
| 775 | 852 | |
| 776 | 853 | // Everywhere in wp-admin except the main dashboard. A null screen fails |
| 777 | 854 | // closed (return) rather than registering the notice on an unknown screen. |
| @@ -777,21 +854,16 @@ | ||
| 777 | 854 | // closed (return) rather than registering the notice on an unknown screen. |
| 778 | 855 | $screen = get_current_screen(); |
| 779 | 856 | |
| 780 | 857 | if ( ! $screen || 'dashboard' === $screen->id ) { |
| 781 | - return; | |
| 858 | + return null; | |
| 782 | 859 | } |
| 783 | 860 | |
| 784 | - // A single stable notice id (not per-form): keeps both the autoloaded | |
| 785 | - // `allowed_astra_notices` option and the per-user dismissal meta bounded to | |
| 786 | - // one row, and lets a dismissed user short-circuit before the query runs. | |
| 787 | - $notice_id = 'srfm-thankyou-prompt'; | |
| 788 | - | |
| 789 | 861 | // The library only checks dismissal at render (priority 30, after this |
| 790 | 862 | // query would already have run). Check it up front so a user who dismissed |
| 791 | 863 | // the prompt never pays for the WP_Query on subsequent admin page views. |
| 792 | - if ( 'notice-dismissed' === get_user_meta( get_current_user_id(), $notice_id, true ) ) { | |
| 793 | - return; | |
| 864 | + if ( 'notice-dismissed' === get_user_meta( get_current_user_id(), self::THANKYOU_PROMPT_NOTICE_ID, true ) ) { | |
| 865 | + return null; | |
| 794 | 866 | } |
| 795 | 867 | |
| 796 | 868 | // array_values so a filter returning a key-preserving array (e.g. the |
| 797 | 869 | // result of array_filter()) still exposes the newest prompt at index 0. |
| @@ -805,12 +877,34 @@ | ||
| 805 | 877 | || empty( $prompts[0]['id'] ) || empty( $prompts[0]['edit_url'] ) |
| 806 | 878 | || empty( $prompts[0]['thankyou_url'] ) || empty( $prompts[0]['replies_url'] ) |
| 807 | 879 | || ! isset( $prompts[0]['title'] ) |
| 808 | 880 | ) { |
| 881 | + return null; | |
| 882 | + } | |
| 883 | + | |
| 884 | + return $prompts[0]; | |
| 885 | + } | |
| 886 | + | |
| 887 | + /** | |
| 888 | + * Render the "Finish setting up" Thank You notice (#3030). | |
| 889 | + * | |
| 890 | + * @since 2.12.4 | |
| 891 | + * @return void | |
| 892 | + */ | |
| 893 | + public function render_thankyou_prompt_notice() { | |
| 894 | + $notice_id = self::THANKYOU_PROMPT_NOTICE_ID; | |
| 895 | + $form = $this->get_displayable_thankyou_prompt(); | |
| 896 | + | |
| 897 | + if ( null === $form ) { | |
| 809 | 898 | return; |
| 810 | 899 | } |
| 811 | 900 | |
| 812 | - $form = $prompts[0]; | |
| 901 | + // A broken form outranks a setup prompt. This is the top of the existing | |
| 902 | + // precedence chain, so the action-item check goes here rather than the | |
| 903 | + // action items standing down for an engagement notice. | |
| 904 | + if ( $this->has_action_item_warnings() ) { | |
| 905 | + return; | |
| 906 | + } | |
| 813 | 907 | |
| 814 | 908 | \Astra_Notices::add_notice( |
| 815 | 909 | [ |
| 816 | 910 | 'id' => $notice_id, |
| @@ -815,9 +909,9 @@ | ||
| 815 | 909 | [ |
| 816 | 910 | 'id' => $notice_id, |
| 817 | 911 | 'type' => 'info', |
| 818 | 912 | 'message' => self::build_thankyou_notice_markup( $form ), |
| 819 | - 'class' => 'srfm-thankyou-notice', | |
| 913 | + 'class' => 'srfm-notice srfm-thankyou-notice', | |
| 820 | 914 | 'is_dismissible' => true, |
| 821 | 915 | 'display-with-other-notices' => true, |
| 822 | 916 | // Render late so this nudge never pre-empts higher-priority notices |
| 823 | 917 | // (e.g. Astra's minimum-version warnings, which are display-with- |
| @@ -827,9 +921,9 @@ | ||
| 827 | 921 | ); |
| 828 | 922 | |
| 829 | 923 | // The message is wp_kses_post'd by the library, so the brand-orange styling |
| 830 | 924 | // is printed through the notice's pre-markup hook instead of inline. |
| 831 | - add_action( 'astra_notice_before_markup_' . $notice_id, [ $this, 'print_thankyou_notice_styles' ] ); | |
| 925 | + add_action( 'astra_notice_before_markup_' . $notice_id, [ $this, 'print_srfm_notice_styles' ] ); | |
| 832 | 926 | |
| 833 | 927 | // Track clicks on the CTAs and the dismiss ✕ via the shared notice-response |
| 834 | 928 | // endpoint, enqueued only when the notice actually renders. |
| 835 | 929 | add_action( 'astra_notice_after_markup_' . $notice_id, [ $this, 'enqueue_thankyou_notice_tracking' ] ); |
| @@ -919,9 +1013,9 @@ | ||
| 919 | 1013 | * |
| 920 | 1014 | * @since 2.12.4 |
| 921 | 1015 | * @return void |
| 922 | 1016 | */ |
| 923 | - public function print_thankyou_notice_styles() { | |
| 1017 | + public function print_srfm_notice_styles() { | |
| 924 | 1018 | // The library wp_kses_post()'s the message, which strips <svg> and data: |
| 925 | 1019 | // image srcs, so the SureForms mark is painted as a CSS background here |
| 926 | 1020 | // (this hook fires outside that kses call). URL-encoded, not base64, so the |
| 927 | 1021 | // value is fully percent-encoded and safe to pass through esc_url. |
| @@ -928,20 +1022,20 @@ | ||
| 928 | 1022 | $icon = 'data:image/svg+xml,' . rawurlencode( |
| 929 | 1023 | '<svg xmlns="http://www.w3.org/2000/svg" width="36" height="36" viewBox="0 0 32 32"><path fill="#D54407" fill-rule="evenodd" clip-rule="evenodd" d="M32 0H0V32H32V0ZM22.8573 6.85728H9.14304V11.4287V13.7144L11.4288 11.4287H22.8573V6.85728ZM20.5717 13.7146H9.14314V18.286V20.5714V20.5718V25.1428H16.0003V20.5714H9.14351L11.4289 18.286H20.5717V13.7146Z"/></svg>' |
| 930 | 1024 | ); |
| 931 | 1025 | ?> |
| 932 | - <style id="srfm-thankyou-notice-styles"> | |
| 933 | - .srfm-thankyou-notice.notice { border-left-color: #D54407; } | |
| 1026 | + <style id="srfm-notice-styles"> | |
| 1027 | + .srfm-notice.notice { border-left-color: #D54407; } | |
| 934 | 1028 | /* Stack our blocks (the library lays the container out as a flex row) and reserve room on the left for the SureForms mark. */ |
| 935 | - .srfm-thankyou-notice .astra-notice-container { display: block; padding: 4px 0 4px 52px; background: url('<?php echo esc_url( $icon, [ 'data' ] ); ?>') no-repeat 4px 6px; background-size: 32px 32px; } | |
| 936 | - .srfm-thankyou-notice .srfm-thankyou-notice__title { margin: 0 0 4px; font-size: 14px; font-weight: 600; color: #1d2327; } | |
| 937 | - .srfm-thankyou-notice .srfm-thankyou-notice__text { margin: 0 0 10px; color: #50575e; } | |
| 938 | - .srfm-thankyou-notice .srfm-thankyou-notice__actions { margin: 12px 0 2px; display: flex; flex-wrap: wrap; gap: 10px 20px; align-items: center; } | |
| 939 | - .srfm-thankyou-notice .button-primary { background: #D54407; border-color: #D54407; color: #fff; box-shadow: none; text-shadow: none; } | |
| 940 | - .srfm-thankyou-notice .button-primary:hover, .srfm-thankyou-notice .button-primary:focus { background: #C83B00; border-color: #C83B00; color: #fff; box-shadow: none; } | |
| 941 | - .srfm-thankyou-notice .button:not(.button-primary) { background: transparent; border-color: transparent; color: #D54407; box-shadow: none; padding: 0; } | |
| 942 | - .srfm-thankyou-notice .button:not(.button-primary):hover, .srfm-thankyou-notice .button:not(.button-primary):focus { background: transparent; border-color: transparent; color: #C83B00; box-shadow: none; } | |
| 943 | - .srfm-thankyou-notice .button-primary:focus { outline: 2px solid #D54407; outline-offset: 1px; } | |
| 1029 | + .srfm-notice .astra-notice-container { display: block; padding: 4px 0 4px 52px; background: url('<?php echo esc_url( $icon, [ 'data' ] ); ?>') no-repeat 4px 6px; background-size: 32px 32px; } | |
| 1030 | + .srfm-notice .srfm-notice__title { margin: 0 0 4px; font-size: 14px; font-weight: 600; color: #1d2327; } | |
| 1031 | + .srfm-notice .srfm-notice__text { margin: 0 0 10px; color: #50575e; } | |
| 1032 | + .srfm-notice .srfm-notice__actions { margin: 12px 0 2px; display: flex; flex-wrap: wrap; gap: 10px 20px; align-items: center; } | |
| 1033 | + .srfm-notice .button-primary { background: #D54407; border-color: #D54407; color: #fff; box-shadow: none; text-shadow: none; } | |
| 1034 | + .srfm-notice .button-primary:hover, .srfm-notice .button-primary:focus { background: #C83B00; border-color: #C83B00; color: #fff; box-shadow: none; } | |
| 1035 | + .srfm-notice .button:not(.button-primary) { background: transparent; border-color: transparent; color: #D54407; box-shadow: none; padding: 0; } | |
| 1036 | + .srfm-notice .button:not(.button-primary):hover, .srfm-notice .button:not(.button-primary):focus { background: transparent; border-color: transparent; color: #C83B00; box-shadow: none; } | |
| 1037 | + .srfm-notice .button-primary:focus { outline: 2px solid #D54407; outline-offset: 1px; } | |
| 944 | 1038 | </style> |
| 945 | 1039 | <?php |
| 946 | 1040 | } |
| 947 | 1041 | |
| @@ -1722,8 +1816,20 @@ | ||
| 1722 | 1816 | 'is_ver_lower_than_6_7' => version_compare( $wp_version, '6.6.2', '<=' ), |
| 1723 | 1817 | 'integrations' => Helper::sureforms_get_integration(), |
| 1724 | 1818 | 'rotating_plugin_banner' => Helper::get_rotating_plugin_banner(), |
| 1725 | 1819 | 'ajax_url' => admin_url( 'admin-ajax.php' ), |
| 1820 | + 'client_logs_nonce' => Helper::current_user_can() ? wp_create_nonce( 'srfm_client_logs' ) : '', | |
| 1821 | + 'action_items' => $this->get_action_items(), | |
| 1822 | + 'details_dialog' => $this->get_details_dialog_labels(), | |
| 1823 | + // Where Contact Support goes when the details fetch fails and there is | |
| 1824 | + // no category-tagged URL to use. Untagged, because at that point we do | |
| 1825 | + // not know which check sent them -- but still a way out: these notices | |
| 1826 | + // are not dismissible and Contact Support is the only action that | |
| 1827 | + // retires them. | |
| 1828 | + 'support_url' => $this->get_support_contact_url( '' ), | |
| 1829 | + 'action_item_details_nonce' => Helper::current_user_can() ? wp_create_nonce( 'srfm_action_item_details' ) : '', | |
| 1830 | + 'notice_response_nonce' => Helper::current_user_can() ? wp_create_nonce( 'srfm_notice_response' ) : '', | |
| 1831 | + 'dismiss_action_item_nonce' => Helper::current_user_can() ? wp_create_nonce( 'srfm_dismiss_action_item' ) : '', | |
| 1726 | 1832 | 'sf_plugin_manager_nonce' => wp_create_nonce( 'sf_plugin_manager_nonce' ), |
| 1727 | 1833 | 'plugin_installer_nonce' => wp_create_nonce( 'updates' ), |
| 1728 | 1834 | 'plugin_activating_text' => __( 'Activating...', 'sureforms' ), |
| 1729 | 1835 | 'plugin_activated_text' => __( 'Activated', 'sureforms' ), |
| @@ -2250,8 +2356,234 @@ | ||
| 2250 | 2356 | } |
| 2251 | 2357 | } |
| 2252 | 2358 | |
| 2253 | 2359 | /** |
| 2360 | + * Register the React notice when the entries table is missing. | |
| 2361 | + * | |
| 2362 | + * Hooked - admin_init, priority 5. | |
| 2363 | + * | |
| 2364 | + * Priority 5 is load-bearing: Notice_Manager hands notices to the front end | |
| 2365 | + * through the `srfm_admin_filter` applied during admin_enqueue_scripts, so | |
| 2366 | + * anything registering later never reaches the page. | |
| 2367 | + * | |
| 2368 | + * @since 2.12.6 | |
| 2369 | + * @return void | |
| 2370 | + */ | |
| 2371 | + public function register_database_repair_notice() { | |
| 2372 | + // admin_init also fires on admin-ajax.php. Nothing there renders a notice, so | |
| 2373 | + // skip the work rather than reading a transient on every AJAX request. | |
| 2374 | + if ( wp_doing_ajax() ) { | |
| 2375 | + return; | |
| 2376 | + } | |
| 2377 | + | |
| 2378 | + if ( ! Helper::current_user_can() ) { | |
| 2379 | + return; | |
| 2380 | + } | |
| 2381 | + | |
| 2382 | + if ( ! class_exists( 'SRFM\Admin\Notice_Manager' ) ) { | |
| 2383 | + return; | |
| 2384 | + } | |
| 2385 | + | |
| 2386 | + // A just-completed repair reports its outcome instead of the warning. | |
| 2387 | + // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Read-only display flag; the repair itself is nonce-checked in handle_database_repair(). | |
| 2388 | + $result = isset( $_GET['srfm_db_repair'] ) ? sanitize_key( wp_unslash( $_GET['srfm_db_repair'] ) ) : ''; | |
| 2389 | + | |
| 2390 | + if ( 'done' === $result ) { | |
| 2391 | + Notice_Manager::register_notice( | |
| 2392 | + [ | |
| 2393 | + 'id' => 'srfm-database-repaired', | |
| 2394 | + 'variant' => 'success', | |
| 2395 | + 'message' => __( 'Your SureForms database is up to date. New form entries will be saved as usual.', 'sureforms' ), | |
| 2396 | + 'pages' => [ 'all' ], | |
| 2397 | + ] | |
| 2398 | + ); | |
| 2399 | + return; | |
| 2400 | + } | |
| 2401 | + | |
| 2402 | + if ( 'failed' === $result ) { | |
| 2403 | + Notice_Manager::register_notice( | |
| 2404 | + [ | |
| 2405 | + 'id' => 'srfm-database-repair-failed', | |
| 2406 | + // Still a warning, not an error: a host that does not allow | |
| 2407 | + // SureForms to create tables is not the user's mistake. | |
| 2408 | + 'variant' => 'warning', | |
| 2409 | + 'message' => __( 'SureForms could not finish updating the database. Your hosting may not allow SureForms to create database tables — please contact your hosting provider or SureForms support.', 'sureforms' ), | |
| 2410 | + 'actions' => [ | |
| 2411 | + [ | |
| 2412 | + 'label' => __( 'Contact support', 'sureforms' ), | |
| 2413 | + 'url' => 'https://sureforms.com/contact/', | |
| 2414 | + ], | |
| 2415 | + ], | |
| 2416 | + 'pages' => [ 'all' ], | |
| 2417 | + ] | |
| 2418 | + ); | |
| 2419 | + return; | |
| 2420 | + } | |
| 2421 | + | |
| 2422 | + if ( ! Register::is_entries_table_missing() ) { | |
| 2423 | + return; | |
| 2424 | + } | |
| 2425 | + | |
| 2426 | + $this->track_database_notice_impression(); | |
| 2427 | + | |
| 2428 | + Notice_Manager::register_notice( | |
| 2429 | + [ | |
| 2430 | + 'id' => 'srfm-database-maintenance', | |
| 2431 | + 'variant' => 'warning', | |
| 2432 | + 'title' => __( 'Database update needed', 'sureforms' ), | |
| 2433 | + // Plain text only. AdminNotice.js renders this as a React child, so | |
| 2434 | + // any markup here would show up as literal characters. | |
| 2435 | + 'message' => $this->get_database_notice_message(), | |
| 2436 | + 'actions' => [ | |
| 2437 | + [ | |
| 2438 | + 'label' => __( 'Fix now', 'sureforms' ), | |
| 2439 | + // Opaque identifier, resolved to a handler in AdminNotice.js. | |
| 2440 | + // Deliberately not a URL or endpoint: the server never tells | |
| 2441 | + // the browser which address to call. | |
| 2442 | + 'action' => 'repair-entries-table', | |
| 2443 | + 'url' => $this->get_database_repair_url(), | |
| 2444 | + ], | |
| 2445 | + ], | |
| 2446 | + 'pages' => [ 'all' ], | |
| 2447 | + ] | |
| 2448 | + ); | |
| 2449 | + } | |
| 2450 | + | |
| 2451 | + /** | |
| 2452 | + * Render the classic warning on the WordPress dashboard. | |
| 2453 | + * | |
| 2454 | + * Hooked - admin_notices. | |
| 2455 | + * | |
| 2456 | + * Scoped to index.php on purpose. The React notice already covers the SureForms | |
| 2457 | + * screens, so leaving this one admin-wide would stack two warnings on the same | |
| 2458 | + * page and nag on every screen in wp-admin. | |
| 2459 | + * | |
| 2460 | + * Registered as [ $this, 'method' ] rather than a closure because | |
| 2461 | + * suppress_foreign_admin_notices() strips any callback it cannot attribute to a | |
| 2462 | + * SureForms class — a closure here would be silently removed. | |
| 2463 | + * | |
| 2464 | + * @since 2.12.6 | |
| 2465 | + * @return void | |
| 2466 | + */ | |
| 2467 | + public function render_database_repair_notice() { | |
| 2468 | + if ( ! Helper::current_user_can() ) { | |
| 2469 | + return; | |
| 2470 | + } | |
| 2471 | + | |
| 2472 | + $screen = get_current_screen(); | |
| 2473 | + | |
| 2474 | + if ( ! $screen || 'dashboard' !== $screen->base ) { | |
| 2475 | + return; | |
| 2476 | + } | |
| 2477 | + | |
| 2478 | + // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Read-only display flag; the repair itself is nonce-checked in handle_database_repair(). | |
| 2479 | + $result = isset( $_GET['srfm_db_repair'] ) ? sanitize_key( wp_unslash( $_GET['srfm_db_repair'] ) ) : ''; | |
| 2480 | + | |
| 2481 | + if ( 'done' === $result ) { | |
| 2482 | + ?> | |
| 2483 | + <div class="notice notice-success is-dismissible"> | |
| 2484 | + <p><?php esc_html_e( 'Your SureForms database is up to date. New form entries will be saved as usual.', 'sureforms' ); ?></p> | |
| 2485 | + </div> | |
| 2486 | + <?php | |
| 2487 | + return; | |
| 2488 | + } | |
| 2489 | + | |
| 2490 | + if ( 'failed' === $result ) { | |
| 2491 | + ?> | |
| 2492 | + <div class="notice notice-warning is-dismissible"> | |
| 2493 | + <p><?php esc_html_e( 'SureForms could not finish updating the database. Your hosting may not allow SureForms to create database tables — please contact your hosting provider or SureForms support.', 'sureforms' ); ?></p> | |
| 2494 | + </div> | |
| 2495 | + <?php | |
| 2496 | + return; | |
| 2497 | + } | |
| 2498 | + | |
| 2499 | + if ( ! Register::is_entries_table_missing() ) { | |
| 2500 | + return; | |
| 2501 | + } | |
| 2502 | + | |
| 2503 | + $this->track_database_notice_impression(); | |
| 2504 | + ?> | |
| 2505 | + <div class="notice notice-warning"> | |
| 2506 | + <p> | |
| 2507 | + <strong><?php esc_html_e( 'SureForms — database update needed', 'sureforms' ); ?></strong> | |
| 2508 | + </p> | |
| 2509 | + <p><?php echo esc_html( $this->get_database_notice_message() ); ?></p> | |
| 2510 | + <p> | |
| 2511 | + <a href="<?php echo esc_url( $this->get_database_repair_url() ); ?>" class="button button-primary"> | |
| 2512 | + <?php esc_html_e( 'Update database', 'sureforms' ); ?> | |
| 2513 | + </a> | |
| 2514 | + </p> | |
| 2515 | + </div> | |
| 2516 | + <?php | |
| 2517 | + } | |
| 2518 | + | |
| 2519 | + /** | |
| 2520 | + * Repair the entries table, then redirect back with the outcome. | |
| 2521 | + * | |
| 2522 | + * Hooked - admin_post_srfm_repair_entries_table. | |
| 2523 | + * | |
| 2524 | + * A nonce-protected GET that changes state matches how core's own plugin | |
| 2525 | + * activate / deactivate / delete links work. | |
| 2526 | + * | |
| 2527 | + * @since 2.12.6 | |
| 2528 | + * @return void | |
| 2529 | + */ | |
| 2530 | + public function handle_database_repair() { | |
| 2531 | + if ( ! Helper::current_user_can() ) { | |
| 2532 | + wp_die( esc_html__( 'You do not have permission to update the database.', 'sureforms' ), 403 ); | |
| 2533 | + } | |
| 2534 | + | |
| 2535 | + check_admin_referer( 'srfm_repair_entries_table' ); | |
| 2536 | + | |
| 2537 | + $repaired = $this->do_database_repair(); | |
| 2538 | + $referer = wp_get_referer(); | |
| 2539 | + | |
| 2540 | + wp_safe_redirect( | |
| 2541 | + add_query_arg( | |
| 2542 | + 'srfm_db_repair', | |
| 2543 | + $repaired ? 'done' : 'failed', | |
| 2544 | + $referer ? $referer : admin_url() | |
| 2545 | + ) | |
| 2546 | + ); | |
| 2547 | + exit; | |
| 2548 | + } | |
| 2549 | + | |
| 2550 | + /** | |
| 2551 | + * Repair the entries table and record what happened. | |
| 2552 | + * | |
| 2553 | + * The single place the repair is performed and counted, shared by the | |
| 2554 | + * admin-post handler and the REST endpoint. One user action reaches exactly one | |
| 2555 | + * of those, so the click counter cannot double-count across the two surfaces. | |
| 2556 | + * | |
| 2557 | + * @since 2.12.6 | |
| 2558 | + * @return bool True when the table exists afterwards. | |
| 2559 | + */ | |
| 2560 | + public function do_database_repair() { | |
| 2561 | + // Cumulative counter, so $force = true: each new count is a new value and is | |
| 2562 | + // re-sent, while an identical repeat short-circuits inside track(). | |
| 2563 | + $attempts = Helper::get_integer_value( Helper::get_srfm_option( 'db_repair_attempts', 0 ) ) + 1; | |
| 2564 | + Helper::update_srfm_option( 'db_repair_attempts', $attempts ); | |
| 2565 | + | |
| 2566 | + // Event name is the `database_error` => `fix_now` entry in the $valid | |
| 2567 | + // allowlist in handle_notice_response(). Kept in sync by hand; that array is | |
| 2568 | + // where the team looks notice event names up. | |
| 2569 | + Analytics::events()->track( 'database_error_notice_cta', (string) $attempts, [], true ); | |
| 2570 | + | |
| 2571 | + $repaired = Register::repair_entries_table(); | |
| 2572 | + | |
| 2573 | + // The failure case is the more valuable signal: it means the host refuses to | |
| 2574 | + // let SureForms create tables, which no amount of retrying will fix. | |
| 2575 | + Analytics::events()->track( | |
| 2576 | + 'database_repair_result', | |
| 2577 | + $repaired ? 'success' : 'failed', | |
| 2578 | + [], | |
| 2579 | + true | |
| 2580 | + ); | |
| 2581 | + | |
| 2582 | + return $repaired; | |
| 2583 | + } | |
| 2584 | + | |
| 2585 | + /** | |
| 2254 | 2586 | * Admin Notice Callback if sureforms pro is out of date. |
| 2255 | 2587 | * |
| 2256 | 2588 | * Hooked - admin_notices |
| 2257 | 2589 | * |
| @@ -2346,29 +2678,52 @@ | ||
| 2346 | 2678 | if ( ! apply_filters( 'srfm_show_rating_notice', true ) ) { |
| 2347 | 2679 | return; |
| 2348 | 2680 | } |
| 2349 | 2681 | |
| 2682 | + $notice_id = 'srfm-plugin-review-notice'; | |
| 2683 | + | |
| 2350 | 2684 | Astra_Notices::add_notice( |
| 2351 | 2685 | [ |
| 2352 | - 'id' => 'srfm-plugin-review-notice', | |
| 2686 | + 'id' => $notice_id, | |
| 2353 | 2687 | 'type' => '', |
| 2354 | - 'message' => $this->build_notice_markup( | |
| 2355 | - esc_html__( 'Amazing! SureForms is powering your forms and submissions - let\'s keep growing together!', 'sureforms' ), | |
| 2356 | - esc_html__( 'If SureForms has been helpful, would you mind taking a moment to leave a 5-star review on WordPress.org?', 'sureforms' ), | |
| 2357 | - esc_url( 'https://wordpress.org/support/plugin/sureforms/reviews/' ), | |
| 2358 | - esc_html__( 'Rate SureForms', 'sureforms' ), | |
| 2359 | - esc_html__( 'Maybe later', 'sureforms' ), | |
| 2360 | - esc_html__( 'I already did', 'sureforms' ), | |
| 2361 | - WEEK_IN_SECONDS, | |
| 2362 | - true | |
| 2688 | + 'message' => self::build_srfm_notice_markup( | |
| 2689 | + __( 'Amazing! SureForms is powering your forms and submissions - let\'s keep growing together!', 'sureforms' ), | |
| 2690 | + __( 'If SureForms has been helpful, would you mind taking a moment to leave a 5-star review on WordPress.org?', 'sureforms' ), | |
| 2691 | + [ | |
| 2692 | + [ | |
| 2693 | + 'text' => __( 'Rate SureForms', 'sureforms' ), | |
| 2694 | + 'url' => esc_url( 'https://wordpress.org/support/plugin/sureforms/reviews/' ), | |
| 2695 | + 'primary' => true, | |
| 2696 | + // Leaves wp-admin, so it also dismisses on the way out. | |
| 2697 | + 'dismiss' => true, | |
| 2698 | + 'external' => true, | |
| 2699 | + ], | |
| 2700 | + [ | |
| 2701 | + 'text' => __( 'Maybe later', 'sureforms' ), | |
| 2702 | + 'url' => '#', | |
| 2703 | + 'dismiss' => true, | |
| 2704 | + 'snooze' => WEEK_IN_SECONDS, | |
| 2705 | + ], | |
| 2706 | + [ | |
| 2707 | + 'text' => __( 'I already did', 'sureforms' ), | |
| 2708 | + 'url' => '#', | |
| 2709 | + 'dismiss' => true, | |
| 2710 | + ], | |
| 2711 | + ] | |
| 2363 | 2712 | ), |
| 2713 | + 'class' => 'srfm-notice srfm-rating-notice', | |
| 2364 | 2714 | 'repeat-notice-after' => WEEK_IN_SECONDS, |
| 2365 | - 'show_if' => $this->maybe_display_rating_notice(), | |
| 2715 | + // Yields to the Thank You prompt for the same reason the Getting Started | |
| 2716 | + // notice does: a specific form to finish beats a recurring review ask, | |
| 2717 | + // and a user with three forms who then imports a template would | |
| 2718 | + // otherwise see both at once. | |
| 2719 | + 'show_if' => $this->maybe_display_rating_notice() && null === $this->get_displayable_thankyou_prompt() && ! $this->has_action_item_warnings(), | |
| 2366 | 2720 | 'display-with-other-notices' => true, |
| 2367 | 2721 | ] |
| 2368 | 2722 | ); |
| 2369 | 2723 | |
| 2370 | - add_action( 'astra_notice_after_markup_srfm-plugin-review-notice', [ $this, 'enqueue_notice_response_script' ] ); | |
| 2724 | + add_action( 'astra_notice_before_markup_' . $notice_id, [ $this, 'print_srfm_notice_styles' ] ); | |
| 2725 | + add_action( 'astra_notice_after_markup_' . $notice_id, [ $this, 'enqueue_notice_response_script' ] ); | |
| 2371 | 2726 | } |
| 2372 | 2727 | |
| 2373 | 2728 | /** |
| 2374 | 2729 | * Display a "Getting Started" admin notice for new users who haven't yet |
| @@ -2390,29 +2745,52 @@ | ||
| 2390 | 2745 | if ( ! apply_filters( 'srfm_show_getting_started_notice', true ) ) { |
| 2391 | 2746 | return; |
| 2392 | 2747 | } |
| 2393 | 2748 | |
| 2749 | + $notice_id = 'srfm-getting-started-notice'; | |
| 2750 | + | |
| 2394 | 2751 | Astra_Notices::add_notice( |
| 2395 | 2752 | [ |
| 2396 | - 'id' => 'srfm-getting-started-notice', | |
| 2753 | + 'id' => $notice_id, | |
| 2397 | 2754 | 'type' => '', |
| 2398 | - 'message' => $this->build_notice_markup( | |
| 2399 | - esc_html__( 'SureForms is ready to power your forms — explore what\'s possible!', 'sureforms' ), | |
| 2400 | - esc_html__( 'Manage your forms, track submissions, and discover features like AI Form Builder, payment integrations, and more from the SureForms dashboard.', 'sureforms' ), | |
| 2401 | - esc_url( admin_url( 'admin.php?page=sureforms_menu' ) ), | |
| 2402 | - esc_html__( 'Go to Dashboard', 'sureforms' ), | |
| 2403 | - esc_html__( 'Maybe later', 'sureforms' ), | |
| 2404 | - esc_html__( 'I already know', 'sureforms' ), | |
| 2405 | - WEEK_IN_SECONDS | |
| 2755 | + 'message' => self::build_srfm_notice_markup( | |
| 2756 | + __( 'SureForms is ready to power your forms — explore what\'s possible!', 'sureforms' ), | |
| 2757 | + __( 'Manage your forms, track submissions, and discover features like AI Form Builder, payment integrations, and more from the SureForms dashboard.', 'sureforms' ), | |
| 2758 | + [ | |
| 2759 | + [ | |
| 2760 | + 'text' => __( 'Go to Dashboard', 'sureforms' ), | |
| 2761 | + 'url' => esc_url( admin_url( 'admin.php?page=sureforms_menu' ) ), | |
| 2762 | + 'primary' => true, | |
| 2763 | + ], | |
| 2764 | + [ | |
| 2765 | + 'text' => __( 'Maybe later', 'sureforms' ), | |
| 2766 | + 'url' => '#', | |
| 2767 | + 'dismiss' => true, | |
| 2768 | + 'snooze' => WEEK_IN_SECONDS, | |
| 2769 | + ], | |
| 2770 | + [ | |
| 2771 | + 'text' => __( 'I already know', 'sureforms' ), | |
| 2772 | + 'url' => '#', | |
| 2773 | + 'dismiss' => true, | |
| 2774 | + ], | |
| 2775 | + ] | |
| 2406 | 2776 | ), |
| 2777 | + 'class' => 'srfm-notice srfm-getting-started-notice', | |
| 2407 | 2778 | 'repeat-notice-after' => WEEK_IN_SECONDS, |
| 2408 | - 'show_if' => ! $this->maybe_display_rating_notice(), | |
| 2779 | + // Yields to both of the other SureForms notices, so only one of ours is | |
| 2780 | + // ever on screen. The rating notice supersedes it once the user has real | |
| 2781 | + // usage; the Thank You prompt supersedes it because "finish this specific | |
| 2782 | + // form" is a concrete next step and this is a generic tour invitation. | |
| 2783 | + 'show_if' => ! $this->maybe_display_rating_notice() && null === $this->get_displayable_thankyou_prompt() && ! $this->has_action_item_warnings(), | |
| 2409 | 2784 | 'display-notice-after' => WEEK_IN_SECONDS, |
| 2410 | 2785 | 'display-with-other-notices' => true, |
| 2411 | 2786 | ] |
| 2412 | 2787 | ); |
| 2413 | 2788 | |
| 2414 | - add_action( 'astra_notice_after_markup_srfm-getting-started-notice', [ $this, 'enqueue_notice_response_script' ] ); | |
| 2789 | + // Same pre-markup hook the Thank You prompt uses, so both notices are painted | |
| 2790 | + // by one stylesheet instead of two that drift apart. | |
| 2791 | + add_action( 'astra_notice_before_markup_' . $notice_id, [ $this, 'print_srfm_notice_styles' ] ); | |
| 2792 | + add_action( 'astra_notice_after_markup_' . $notice_id, [ $this, 'enqueue_notice_response_script' ] ); | |
| 2415 | 2793 | } |
| 2416 | 2794 | |
| 2417 | 2795 | /** |
| 2418 | 2796 | * Enqueue the notice response analytics script. |
| @@ -2439,15 +2817,94 @@ | ||
| 2439 | 2817 | wp_localize_script( |
| 2440 | 2818 | 'srfm-notice-response', |
| 2441 | 2819 | 'srfmNoticeResponse', |
| 2442 | 2820 | [ |
| 2443 | - 'ajaxurl' => admin_url( 'admin-ajax.php' ), | |
| 2444 | - 'nonce' => wp_create_nonce( 'srfm_notice_response' ), | |
| 2821 | + 'ajaxurl' => admin_url( 'admin-ajax.php' ), | |
| 2822 | + 'nonce' => wp_create_nonce( 'srfm_notice_response' ), | |
| 2823 | + // The diagnostics are fetched when the dialog opens rather than | |
| 2824 | + // shipped with every page, so the dialog needs its own nonce. | |
| 2825 | + 'detailsNonce' => wp_create_nonce( 'srfm_action_item_details' ), | |
| 2826 | + // Carousel chrome. Built in the browser rather than printed here so | |
| 2827 | + // that with JavaScript off every notice simply stays visible, which | |
| 2828 | + // is the behaviour this replaced -- controls that cannot work must | |
| 2829 | + // not be what hides a warning. | |
| 2830 | + 'carousel' => [ | |
| 2831 | + 'previous' => __( 'Previous notice', 'sureforms' ), | |
| 2832 | + 'next' => __( 'Next notice', 'sureforms' ), | |
| 2833 | + /* translators: 1: current position, 2: total notices. */ | |
| 2834 | + 'counter' => __( '%1$d of %2$d', 'sureforms' ), | |
| 2835 | + ], | |
| 2836 | + // Details modal chrome, translated here so the script carries no | |
| 2837 | + // user-facing English of its own. | |
| 2838 | + 'details' => $this->get_details_dialog_labels(), | |
| 2839 | + // Where Contact Support goes when the fetch fails and there is no | |
| 2840 | + // category-tagged URL to use. Untagged, because at that point we do | |
| 2841 | + // not know which check sent them -- but still a way out: these | |
| 2842 | + // notices are not dismissible and Contact Support is the only action | |
| 2843 | + // that retires them. | |
| 2844 | + 'supportUrl' => $this->get_support_contact_url( '' ), | |
| 2445 | 2845 | ] |
| 2446 | 2846 | ); |
| 2447 | 2847 | } |
| 2448 | 2848 | |
| 2449 | 2849 | /** |
| 2850 | + * Serve one failure category's diagnostics, on demand. | |
| 2851 | + * | |
| 2852 | + * Hooked - wp_ajax_srfm_action_item_details. | |
| 2853 | + * | |
| 2854 | + * The report is built here rather than shipped with the page. Its content | |
| 2855 | + * comes from the client error log, and that log is filled through a public | |
| 2856 | + * REST route gated on a submit token any visitor can obtain from a form page | |
| 2857 | + * rather than on a capability -- so the text is attacker-authored, and putting | |
| 2858 | + * it in the localisation JSON and a hidden div on every admin screen exposed | |
| 2859 | + * it far beyond the one admin who opens the dialog. | |
| 2860 | + * | |
| 2861 | + * Capability first, then nonce, then the category, matching the ordering of | |
| 2862 | + * the sibling handlers in this class. | |
| 2863 | + * | |
| 2864 | + * @since 2.12.7 | |
| 2865 | + * @return void | |
| 2866 | + */ | |
| 2867 | + public function handle_action_item_details() { | |
| 2868 | + if ( ! Helper::current_user_can() ) { | |
| 2869 | + wp_send_json_error( [ 'message' => __( 'Unauthorized user.', 'sureforms' ) ], 403 ); | |
| 2870 | + return; | |
| 2871 | + } | |
| 2872 | + | |
| 2873 | + if ( ! check_ajax_referer( 'srfm_action_item_details', 'nonce', false ) ) { | |
| 2874 | + wp_send_json_error( [ 'message' => __( 'Invalid nonce.', 'sureforms' ) ], 403 ); | |
| 2875 | + return; | |
| 2876 | + } | |
| 2877 | + | |
| 2878 | + // sanitize_key() returns '' for anything non-scalar (formatting.php:2194), so | |
| 2879 | + // a category[]= in the body arrives here as the empty string and falls into | |
| 2880 | + // the refusal below rather than needing a type branch of its own. | |
| 2881 | + $category = isset( $_POST['category'] ) ? sanitize_key( wp_unslash( $_POST['category'] ) ) : ''; | |
| 2882 | + | |
| 2883 | + // The only check the category needs, and the reason there is no separate | |
| 2884 | + // allowlist above it: get_open_failures() returns nothing but keys in | |
| 2885 | + // Client_Logger::CATEGORIES, so an absent category, an unrecognised one and | |
| 2886 | + // a recognised one with nothing wrong all land here. Asking for a category | |
| 2887 | + // with no fault must not mint a report describing one. | |
| 2888 | + $open = Client_Logger::get_open_failures(); | |
| 2889 | + | |
| 2890 | + if ( ! isset( $open[ $category ] ) ) { | |
| 2891 | + wp_send_json_error( [ 'message' => __( 'Nothing to report.', 'sureforms' ) ], 404 ); | |
| 2892 | + return; | |
| 2893 | + } | |
| 2894 | + | |
| 2895 | + $form_title = Helper::get_string_value( $open[ $category ]['form_title'] ?? '' ); | |
| 2896 | + | |
| 2897 | + wp_send_json_success( | |
| 2898 | + [ | |
| 2899 | + 'details' => $this->get_support_message( $category, $form_title ) | |
| 2900 | + . "\n\n" . $this->get_support_log_block( 8000 ), | |
| 2901 | + 'support_url' => $this->get_support_contact_url( $category ), | |
| 2902 | + ] | |
| 2903 | + ); | |
| 2904 | + } | |
| 2905 | + | |
| 2906 | + /** | |
| 2450 | 2907 | * Handle the notice response AJAX request. |
| 2451 | 2908 | * |
| 2452 | 2909 | * Validates the request and records the analytics event |
| 2453 | 2910 | * for the notice button that was clicked. |
| @@ -2457,12 +2914,14 @@ | ||
| 2457 | 2914 | */ |
| 2458 | 2915 | public function handle_notice_response() { |
| 2459 | 2916 | if ( ! check_ajax_referer( 'srfm_notice_response', 'nonce', false ) ) { |
| 2460 | 2917 | wp_send_json_error( [ 'message' => __( 'Invalid nonce.', 'sureforms' ) ], 403 ); |
| 2918 | + return; | |
| 2461 | 2919 | } |
| 2462 | 2920 | |
| 2463 | 2921 | if ( ! Helper::current_user_can() ) { |
| 2464 | 2922 | wp_send_json_error( [ 'message' => __( 'Unauthorized user.', 'sureforms' ) ], 403 ); |
| 2923 | + return; | |
| 2465 | 2924 | } |
| 2466 | 2925 | |
| 2467 | 2926 | $notice_id = isset( $_POST['notice_id'] ) ? sanitize_text_field( wp_unslash( $_POST['notice_id'] ) ) : ''; |
| 2468 | 2927 | $button = isset( $_POST['button'] ) ? sanitize_text_field( wp_unslash( $_POST['button'] ) ) : ''; |
| @@ -2477,9 +2936,40 @@ | ||
| 2477 | 2936 | 'rate_sureforms' => 'rating_notice_cta', |
| 2478 | 2937 | 'maybe_later' => 'rating_notice_snooze', |
| 2479 | 2938 | 'dismissed' => 'rating_notice_dismiss', |
| 2480 | 2939 | ], |
| 2940 | + // Database maintenance notice. Keyed `database_error` for the warehouse; | |
| 2941 | + // the user-facing copy deliberately reads as a routine update, not an | |
| 2942 | + // error. `dismissed` is registered but unreachable today — a missing | |
| 2943 | + // entries table is not something we let people dismiss. | |
| 2944 | + 'database_error' => [ | |
| 2945 | + 'fix_now' => 'database_error_notice_cta', | |
| 2946 | + 'dismissed' => 'database_error_notice_dismiss', | |
| 2947 | + ], | |
| 2481 | 2948 | // The "Finish setting up" prompt (#3030): three CTAs, plus the ✕. |
| 2949 | + 'form_submission_error' => [ | |
| 2950 | + 'view_details' => 'submission_failure_notice_view', | |
| 2951 | + 'copy_details' => 'submission_failure_notice_copy', | |
| 2952 | + 'contact_support' => 'submission_failure_notice_cta', | |
| 2953 | + 'dismissed' => 'submission_failure_notice_dismiss', | |
| 2954 | + ], | |
| 2955 | + 'notification_error' => [ | |
| 2956 | + 'view_details' => 'notification_failure_notice_view', | |
| 2957 | + 'copy_details' => 'notification_failure_notice_copy', | |
| 2958 | + 'contact_support' => 'notification_failure_notice_cta', | |
| 2959 | + 'help_me_fix' => 'notification_failure_notice_guide', | |
| 2960 | + 'dismissed' => 'notification_failure_notice_dismiss', | |
| 2961 | + ], | |
| 2962 | + 'integration_error' => [ | |
| 2963 | + 'view_details' => 'integration_failure_notice_view', | |
| 2964 | + 'copy_details' => 'integration_failure_notice_copy', | |
| 2965 | + 'contact_support' => 'integration_failure_notice_cta', | |
| 2966 | + 'dismissed' => 'integration_failure_notice_dismiss', | |
| 2967 | + ], | |
| 2968 | + 'caching_plugin' => [ | |
| 2969 | + 'help_me_fix' => 'caching_plugin_notice_cta', | |
| 2970 | + 'dismissed' => 'caching_plugin_notice_dismiss', | |
| 2971 | + ], | |
| 2482 | 2972 | 'srfm-thankyou-prompt' => [ |
| 2483 | 2973 | 'edit_form' => 'thankyou_notice_edit_form', |
| 2484 | 2974 | 'set_replies' => 'thankyou_notice_set_replies', |
| 2485 | 2975 | 'edit_thankyou' => 'thankyou_notice_edit_thankyou', |
| @@ -2488,13 +2978,33 @@ | ||
| 2488 | 2978 | ]; |
| 2489 | 2979 | |
| 2490 | 2980 | if ( ! isset( $valid[ $notice_id ][ $button ] ) ) { |
| 2491 | 2981 | wp_send_json_error( [ 'message' => __( 'Invalid parameters.', 'sureforms' ) ], 400 ); |
| 2982 | + // wp_send_json_error() ends the request in production. The explicit return | |
| 2983 | + // keeps the guard a guard rather than something that only works because of | |
| 2984 | + // a side effect in a function elsewhere. | |
| 2985 | + return; | |
| 2492 | 2986 | } |
| 2493 | 2987 | |
| 2494 | - $event_name = $valid[ $notice_id ][ $button ]; | |
| 2495 | - Analytics::events()->track( $event_name, $button ); | |
| 2988 | + $this->track_notice_event( $valid[ $notice_id ][ $button ] ); | |
| 2496 | 2989 | |
| 2990 | + // Reporting the failures retires the notice until something new fails. | |
| 2991 | + // Handled here rather than in the browser so it holds for the classic | |
| 2992 | + // wp-admin notice too, which is a plain link with no JavaScript. | |
| 2993 | + $categories = [ | |
| 2994 | + 'form_submission_error' => 'submission', | |
| 2995 | + 'notification_error' => 'notification', | |
| 2996 | + 'integration_error' => 'integration', | |
| 2997 | + ]; | |
| 2998 | + | |
| 2999 | + if ( 'contact_support' === $button && isset( $categories[ $notice_id ] ) ) { | |
| 3000 | + Client_Logger::acknowledge_category( $categories[ $notice_id ] ); | |
| 3001 | + | |
| 3002 | + if ( 'form_submission_error' === $notice_id ) { | |
| 3003 | + Client_Logger::acknowledge_failures(); | |
| 3004 | + } | |
| 3005 | + } | |
| 3006 | + | |
| 2497 | 3007 | wp_send_json_success(); |
| 2498 | 3008 | } |
| 2499 | 3009 | |
| 2500 | 3010 | /** |
| @@ -2827,8 +3337,118 @@ | ||
| 2827 | 3337 | wp_add_inline_script( 'srfm-ai-dashboard-widget', $inline_script ); |
| 2828 | 3338 | } |
| 2829 | 3339 | |
| 2830 | 3340 | /** |
| 3341 | + * Count an editor visit that came from the front-end "Edit Form" pill. | |
| 3342 | + * | |
| 3343 | + * The pill is a plain link, so the click is attributed by the marker query arg | |
| 3344 | + * it carries rather than by a front-end click handler. That keeps the front end | |
| 3345 | + * script-free and adds no AJAX endpoint: the only thing on the page is still an | |
| 3346 | + * anchor. It also measures the outcome that matters — the editor actually | |
| 3347 | + * opening — instead of a click that may never land. | |
| 3348 | + * | |
| 3349 | + * Every decision here comes from server state. The query arg selects the code | |
| 3350 | + * path; what gets counted is derived from the resolved post and the current | |
| 3351 | + * user's capability on it. An absent, empty, misspelled or reused arg, a post | |
| 3352 | + * that is not a SureForms form, and a user without `edit_post` on that form all | |
| 3353 | + * fall through to no-op without an explicit branch. | |
| 3354 | + * | |
| 3355 | + * No nonce, deliberately: the pill is rendered into front-end HTML that may be | |
| 3356 | + * page-cached, so a nonce would either be baked into the cache or be stale on | |
| 3357 | + * arrival. The effect is a private usage counter for a user who can already edit | |
| 3358 | + * the form, and nothing attacker-controlled reaches the analytics payload — the | |
| 3359 | + * value sent is an integer read back from stored state. | |
| 3360 | + * | |
| 3361 | + * Because the marker is just a query arg, the invariant that bounds this is the | |
| 3362 | + * dedup transient below, not the arg: a given editor moves the counter at most | |
| 3363 | + * once per form per hour, no matter how many times the URL is requested. That is | |
| 3364 | + * also what keeps the metric honest — without it a refresh or a back-navigation | |
| 3365 | + * would count again, and each count is a read-modify-write of the whole | |
| 3366 | + * `srfm_options` row, which holds unrelated settings. | |
| 3367 | + * | |
| 3368 | + * @return void | |
| 3369 | + * @since 2.12.6 | |
| 3370 | + */ | |
| 3371 | + public function maybe_track_edit_form_button_click() { | |
| 3372 | + // is_string() before sanitize_key(): `?srfm_edit_src[]=x` satisfies isset(), | |
| 3373 | + // and wp_unslash() hands the array straight through. sanitize_key() only grew | |
| 3374 | + // its is_scalar() guard after this plugin's minimum WordPress, so on the older | |
| 3375 | + // supported versions that reaches strtolower( array ) — a TypeError on PHP 8, | |
| 3376 | + // i.e. the one input shape that ended in a fatal rather than in the no-op the | |
| 3377 | + // rest of this method guarantees. | |
| 3378 | + $arg = Generate_Form_Markup::EDIT_FORM_BUTTON_SOURCE_ARG; | |
| 3379 | + | |
| 3380 | + // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Read-only attribution marker; see docblock for why a nonce is neither possible nor needed. | |
| 3381 | + $source = isset( $_GET[ $arg ] ) && is_string( $_GET[ $arg ] ) ? sanitize_key( wp_unslash( $_GET[ $arg ] ) ) : ''; | |
| 3382 | + | |
| 3383 | + if ( 'embed' !== $source ) { | |
| 3384 | + return; | |
| 3385 | + } | |
| 3386 | + | |
| 3387 | + // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Same read-only path as above. | |
| 3388 | + $post_id = isset( $_GET['post'] ) ? absint( wp_unslash( $_GET['post'] ) ) : 0; | |
| 3389 | + | |
| 3390 | + // Resolve the post type from the stored post, never from the request. | |
| 3391 | + // | |
| 3392 | + // The capability below reads as per-post but is not: sureforms_form is | |
| 3393 | + // registered with an explicit capabilities map and no `map_meta_cap` | |
| 3394 | + // (inc/post-types.php), so core short-circuits `edit_post` to the post type's | |
| 3395 | + // `edit_post` capability — `manage_options` — without ever consulting $post_id. | |
| 3396 | + // The real gate is therefore "site administrator", which is stricter than a | |
| 3397 | + // per-form check, not weaker. Written down because a later `map_meta_cap` on | |
| 3398 | + // the CPT would silently change what this line means with no diff here. | |
| 3399 | + if ( 0 === $post_id || SRFM_FORMS_POST_TYPE !== get_post_type( $post_id ) ) { | |
| 3400 | + return; | |
| 3401 | + } | |
| 3402 | + | |
| 3403 | + if ( ! current_user_can( 'edit_post', $post_id ) ) { | |
| 3404 | + return; | |
| 3405 | + } | |
| 3406 | + | |
| 3407 | + // One count per editor per form per hour. Without this the metric measures | |
| 3408 | + // "editor loads carrying the marker" rather than pill clicks — a refresh or a | |
| 3409 | + // back-navigation re-counts — and a forged page could drive the counter, and | |
| 3410 | + // the writes behind it, without bound. | |
| 3411 | + $dedup_key = 'srfm_pill_click_' . get_current_user_id() . '_' . $post_id; | |
| 3412 | + | |
| 3413 | + if ( false !== get_transient( $dedup_key ) ) { | |
| 3414 | + return; | |
| 3415 | + } | |
| 3416 | + | |
| 3417 | + set_transient( $dedup_key, 1, HOUR_IN_SECONDS ); | |
| 3418 | + | |
| 3419 | + $count = Helper::get_integer_value( Helper::get_srfm_option( 'edit_form_button_clicks', 0 ) ) + 1; | |
| 3420 | + Helper::update_srfm_option( 'edit_form_button_clicks', $count ); | |
| 3421 | + | |
| 3422 | + // $force = true because this is a cumulative counter, not a one-time event — | |
| 3423 | + // it must re-send the latest count each cycle (bypasses one-time dedup). | |
| 3424 | + Analytics::events()->track( 'edit_form_button_clicked', (string) $count, [], true ); | |
| 3425 | + } | |
| 3426 | + | |
| 3427 | + /** | |
| 3428 | + * Let core strip the edit-attribution marker from the admin URL. | |
| 3429 | + * | |
| 3430 | + * Core's wp_admin_canonical_url() rewrites the address bar via replaceState() on | |
| 3431 | + * admin_head, which runs after load-post.php — so the marker has already been | |
| 3432 | + * counted by the time it is removed and no attribution is lost. Without this it | |
| 3433 | + * lingers in the address bar, in bookmarks, and in the Referer header sent to | |
| 3434 | + * every subresource the editor loads. | |
| 3435 | + * | |
| 3436 | + * @param array<string> $args Query args core already removes. | |
| 3437 | + * @since 2.12.6 | |
| 3438 | + * @return array<string> Args with the marker appended. | |
| 3439 | + */ | |
| 3440 | + public function add_removable_query_args( $args ) { | |
| 3441 | + if ( ! is_array( $args ) ) { | |
| 3442 | + return [ Generate_Form_Markup::EDIT_FORM_BUTTON_SOURCE_ARG ]; | |
| 3443 | + } | |
| 3444 | + | |
| 3445 | + $args[] = Generate_Form_Markup::EDIT_FORM_BUTTON_SOURCE_ARG; | |
| 3446 | + | |
| 3447 | + return $args; | |
| 3448 | + } | |
| 3449 | + | |
| 3450 | + /** | |
| 2831 | 3451 | * Track AI dashboard widget usage. |
| 2832 | 3452 | * |
| 2833 | 3453 | * @return void |
| 2834 | 3454 | * @since 2.12.1 |
| @@ -2903,8 +3523,795 @@ | ||
| 2903 | 3523 | <?php |
| 2904 | 3524 | } |
| 2905 | 3525 | |
| 2906 | 3526 | /** |
| 3527 | + * Classic dashboard notice when submissions keep failing. | |
| 3528 | + * | |
| 3529 | + * Hooked - admin_notices. | |
| 3530 | + * | |
| 3531 | + * Gated to the WP dashboard. The React notice already covers SureForms' own | |
| 3532 | + * screens, so leaving this admin-wide would stack two warnings on one page. | |
| 3533 | + * | |
| 3534 | + * Registered as [ $this, 'method' ] rather than a closure because | |
| 3535 | + * suppress_foreign_admin_notices() strips any callback it cannot attribute to | |
| 3536 | + * a SureForms class -- a closure here would be silently removed. | |
| 3537 | + * | |
| 3538 | + * @since 2.12.6 | |
| 3539 | + * @return void | |
| 3540 | + */ | |
| 3541 | + public function render_action_item_notices() { | |
| 3542 | + // Shown across wp-admin, because someone whose forms are silently failing | |
| 3543 | + // may not open the WP dashboard or SureForms for days. | |
| 3544 | + // | |
| 3545 | + // The one exclusion is SureForms' own dashboard: the Form Checks panel in | |
| 3546 | + // its sidebar already lists these, and a banner above it would say the same | |
| 3547 | + // thing twice on one screen. | |
| 3548 | + if ( Helper::validate_request_context( 'sureforms_menu', 'page' ) ) { | |
| 3549 | + return; | |
| 3550 | + } | |
| 3551 | + | |
| 3552 | + $items = $this->get_action_items(); | |
| 3553 | + | |
| 3554 | + // Only the faults reach this surface, so count those before deciding | |
| 3555 | + // whether the carousel stylesheet is worth printing. | |
| 3556 | + $rendered = 0; | |
| 3557 | + | |
| 3558 | + foreach ( $items as $item ) { | |
| 3559 | + $status = Helper::get_string_value( $item['status'] ?? '' ); | |
| 3560 | + | |
| 3561 | + if ( 'success' !== $status && '' !== $status ) { | |
| 3562 | + $rendered++; | |
| 3563 | + } | |
| 3564 | + } | |
| 3565 | + | |
| 3566 | + if ( 0 === $rendered ) { | |
| 3567 | + return; | |
| 3568 | + } | |
| 3569 | + | |
| 3570 | + $this->enqueue_notice_response_script(); | |
| 3571 | + | |
| 3572 | + foreach ( $items as $item ) { | |
| 3573 | + $status = Helper::get_string_value( $item['status'] ?? '' ); | |
| 3574 | + | |
| 3575 | + // Passing checks belong in the SureForms panel, not in wp-admin. A | |
| 3576 | + // notice that says nothing is wrong is noise on every page load. | |
| 3577 | + if ( 'success' === $status || '' === $status ) { | |
| 3578 | + continue; | |
| 3579 | + } | |
| 3580 | + | |
| 3581 | + // A fault reads as an error; advice reads as a warning. Both are shown, | |
| 3582 | + // but they are not the same kind of message and should not look alike. | |
| 3583 | + $class = 'error' === $status ? 'notice-error' : 'notice-warning'; | |
| 3584 | + ?> | |
| 3585 | + <div class="notice srfm-action-item-notice <?php echo esc_attr( $class ); ?>"> | |
| 3586 | + <?php | |
| 3587 | + /* | |
| 3588 | + * Guarded like every sibling key. A filter item carrying only | |
| 3589 | + * id/status/cta_* is a shape this surface designs for, and reading | |
| 3590 | + * these unguarded is two PHP 8 undefined-key warnings plus an | |
| 3591 | + * esc_html( null ) deprecation on 8.1+. React tolerates the absence, | |
| 3592 | + * so leaving it would keep the two renderers disagreeing. | |
| 3593 | + */ | |
| 3594 | + ?> | |
| 3595 | + <p><strong><?php echo esc_html( Helper::get_string_value( $item['title'] ?? '' ) ); ?></strong></p> | |
| 3596 | + <p><?php echo esc_html( Helper::get_string_value( $item['message'] ?? '' ) ); ?></p> | |
| 3597 | + <?php | |
| 3598 | + // Self-serve first, so the emphasis follows the order rather than the | |
| 3599 | + // identity: whichever action leads is the primary button, and an item | |
| 3600 | + // with no guide still leads with Contact Support. | |
| 3601 | + $has_guide = ! empty( $item['guide_label'] ) && ! empty( $item['guide_url'] ); | |
| 3602 | + | |
| 3603 | + // Both keys, not either. An item contributed through | |
| 3604 | + // srfm_action_items may carry only guide_* keys -- reading cta_url | |
| 3605 | + // unguarded emits two PHP 8 undefined-key warnings and renders | |
| 3606 | + // href="" -- and a label without a URL renders an anchor that is not | |
| 3607 | + // keyboard focusable. React gates on the same pair. | |
| 3608 | + $has_cta = ! empty( $item['cta_label'] ) && ! empty( $item['cta_url'] ); | |
| 3609 | + ?> | |
| 3610 | + <p> | |
| 3611 | + <?php if ( $has_guide ) { ?> | |
| 3612 | + <a | |
| 3613 | + href="<?php echo esc_url( Helper::get_string_value( $item['guide_url'] ) ); ?>" | |
| 3614 | + class="button button-primary" | |
| 3615 | + data-srfm-notice-id="<?php echo esc_attr( Helper::get_string_value( $item['id'] ) ); ?>" | |
| 3616 | + data-srfm-button="<?php echo esc_attr( Helper::get_string_value( $item['guide_action'] ?? '' ) ); ?>" | |
| 3617 | + target="_blank" | |
| 3618 | + rel="noopener noreferrer" | |
| 3619 | + > | |
| 3620 | + <?php echo esc_html( $item['guide_label'] ); ?> | |
| 3621 | + </a> | |
| 3622 | + <?php } ?> | |
| 3623 | + <?php if ( $has_cta ) { ?> | |
| 3624 | + <a | |
| 3625 | + href="<?php echo esc_url( Helper::get_string_value( $item['cta_url'] ) ); ?>" | |
| 3626 | + class="<?php echo $has_guide ? 'button' : 'button button-primary'; ?>" | |
| 3627 | + data-srfm-notice-id="<?php echo esc_attr( Helper::get_string_value( $item['id'] ) ); ?>" | |
| 3628 | + data-srfm-button="<?php echo esc_attr( Helper::get_string_value( $item['cta_action'] ?? '' ) ); ?>" | |
| 3629 | + <?php | |
| 3630 | + // With details to fetch, the click opens them here instead | |
| 3631 | + // of following the href. The href stays as the no-JS | |
| 3632 | + // path: it goes to the dashboard, where the same details | |
| 3633 | + // are readable. | |
| 3634 | + if ( ! empty( $item['has_details'] ) ) { | |
| 3635 | + printf( | |
| 3636 | + 'data-srfm-details-for="%1$s" data-srfm-category="%2$s"', | |
| 3637 | + esc_attr( Helper::get_string_value( $item['id'] ) ), | |
| 3638 | + esc_attr( Helper::get_string_value( $item['category'] ?? '' ) ) | |
| 3639 | + ); | |
| 3640 | + } elseif ( 0 !== strpos( Helper::get_string_value( $item['cta_url'] ), 'mailto:' ) ) { | |
| 3641 | + echo 'target="_blank" rel="noopener noreferrer"'; | |
| 3642 | + } | |
| 3643 | + ?> | |
| 3644 | + > | |
| 3645 | + <?php echo esc_html( $item['cta_label'] ); ?> | |
| 3646 | + </a> | |
| 3647 | + <?php } ?> | |
| 3648 | + <?php if ( ! empty( $item['dismissible'] ) ) { ?> | |
| 3649 | + <a href="<?php echo esc_url( $this->get_dismiss_action_item_url( Helper::get_string_value( $item['id'] ) ) ); ?>" class="button"> | |
| 3650 | + <?php esc_html_e( 'Dismiss', 'sureforms' ); ?> | |
| 3651 | + </a> | |
| 3652 | + <?php } ?> | |
| 3653 | + </p> | |
| 3654 | + </div> | |
| 3655 | + <?php | |
| 3656 | + } | |
| 3657 | + } | |
| 3658 | + | |
| 3659 | + /** | |
| 3660 | + * Dismiss an action item from the classic notice's link. | |
| 3661 | + * | |
| 3662 | + * Hooked - admin_post_srfm_dismiss_action_item_link. | |
| 3663 | + * | |
| 3664 | + * @since 2.12.6 | |
| 3665 | + * @return void | |
| 3666 | + */ | |
| 3667 | + public function handle_dismiss_action_item_link() { | |
| 3668 | + if ( ! Helper::current_user_can() ) { | |
| 3669 | + wp_die( esc_html__( 'You do not have permission to do this.', 'sureforms' ), 403 ); | |
| 3670 | + } | |
| 3671 | + | |
| 3672 | + check_admin_referer( 'srfm_dismiss_action_item' ); | |
| 3673 | + | |
| 3674 | + $item_id = isset( $_GET['item'] ) ? sanitize_key( wp_unslash( $_GET['item'] ) ) : ''; | |
| 3675 | + | |
| 3676 | + $this->dismiss_action_item( $item_id ); | |
| 3677 | + | |
| 3678 | + $referer = wp_get_referer(); | |
| 3679 | + | |
| 3680 | + wp_safe_redirect( $referer ? $referer : admin_url() ); | |
| 3681 | + exit; | |
| 3682 | + } | |
| 3683 | + | |
| 3684 | + /** | |
| 3685 | + * Whether a first-party warning is currently on screen. | |
| 3686 | + * | |
| 3687 | + * Asked from the show_if of the rating, Getting Started and Thank You notices, | |
| 3688 | + * all of which are gated on nothing being wrong. "Wrong" has to mean the same | |
| 3689 | + * thing here as it does to the person looking at the screen. | |
| 3690 | + * | |
| 3691 | + * It used to re-state the conditions instead of reading them, and the | |
| 3692 | + * restatement was narrower than the display: has_persistent_failures() reads | |
| 3693 | + * the `submission` counter alone, while the notices and the Form Checks panel | |
| 3694 | + * warn on any open failure in any of the three categories. So an open | |
| 3695 | + * notification or integration failure left this false, and the review ask | |
| 3696 | + * appeared directly beneath "We noticed a notification failure on Contact | |
| 3697 | + * Form". Submission was covered only incidentally, by FAULT_THRESHOLD being 1 -- | |
| 3698 | + * raise that and it would have joined them. | |
| 3699 | + * | |
| 3700 | + * Derived from get_first_party_action_items() now, which is the thing that | |
| 3701 | + * builds those warnings, so the gate cannot drift from the display again. | |
| 3702 | + * | |
| 3703 | + * Two constraints kept from the previous version. It must not call | |
| 3704 | + * get_action_items(): that records an impression as a side effect and must | |
| 3705 | + * never run from a show_if. And it reads the first-party set specifically, so | |
| 3706 | + * an item contributed through `srfm_action_items` cannot suppress notices that | |
| 3707 | + * have nothing to do with it. | |
| 3708 | + * | |
| 3709 | + * Returns false with logging disabled, which is what makes those notices | |
| 3710 | + * eligible again on a site that has turned this surface off. Intended: with the | |
| 3711 | + * surface off there is nothing being reported. | |
| 3712 | + * | |
| 3713 | + * @since 2.12.6 | |
| 3714 | + * @return bool | |
| 3715 | + */ | |
| 3716 | + public function has_action_item_warnings() { | |
| 3717 | + if ( ! Client_Logger::is_enabled() ) { | |
| 3718 | + return false; | |
| 3719 | + } | |
| 3720 | + | |
| 3721 | + foreach ( $this->get_first_party_action_items() as $item ) { | |
| 3722 | + if ( ! is_array( $item ) ) { | |
| 3723 | + continue; | |
| 3724 | + } | |
| 3725 | + | |
| 3726 | + $status = Helper::get_string_value( $item['status'] ?? '' ); | |
| 3727 | + | |
| 3728 | + // Matches the renderers: 'success' is a passing check and an empty | |
| 3729 | + // status is not a warning either, so neither suppresses anything. | |
| 3730 | + if ( 'success' !== $status && '' !== $status ) { | |
| 3731 | + return true; | |
| 3732 | + } | |
| 3733 | + } | |
| 3734 | + | |
| 3735 | + return false; | |
| 3736 | + } | |
| 3737 | + | |
| 3738 | + /** | |
| 3739 | + * Things on this site that need the owner's attention, newest concern first. | |
| 3740 | + * | |
| 3741 | + * Fed to the dashboard sidebar carousel. Each entry is self-describing so the | |
| 3742 | + * front end has no rules of its own to keep in sync -- adding a new item here | |
| 3743 | + * makes it appear with no JavaScript change. | |
| 3744 | + * | |
| 3745 | + * `dismissible` separates a fault from advice. A run of failed submissions is | |
| 3746 | + * not something to wave away, and clears itself when a submission succeeds. A | |
| 3747 | + * caching plugin being present is information, so it can be dismissed. | |
| 3748 | + * | |
| 3749 | + * @since 2.12.6 | |
| 3750 | + * @return array<int,array<string,mixed>> | |
| 3751 | + */ | |
| 3752 | + public function get_action_items() { | |
| 3753 | + if ( ! Helper::current_user_can() ) { | |
| 3754 | + return []; | |
| 3755 | + } | |
| 3756 | + | |
| 3757 | + // Memoised for the request. This runs twice on every admin page -- once | |
| 3758 | + // building the localisation payload and once in the classic renderer -- and | |
| 3759 | + // each open category reads a log excerpt. It also records an impression, so | |
| 3760 | + // running twice counted twice. Matches the $thankyou_prompt_cache and | |
| 3761 | + // $setup_card_cache pattern already in this class. | |
| 3762 | + if ( null !== self::$action_items_cache ) { | |
| 3763 | + return self::$action_items_cache; | |
| 3764 | + } | |
| 3765 | + | |
| 3766 | + // Logging off is the opt-out for this surface. Not because the counters go | |
| 3767 | + // stale -- Client_Logger::record_failure() has no enabled check, and the | |
| 3768 | + // notification and integration categories are written by direct calls in | |
| 3769 | + // inc/form-submit.php that keep counting accurately with logging off. It is | |
| 3770 | + // simply the switch a site owner has to turn these notices off, and it | |
| 3771 | + // covers our own items only: the filter below still runs, because a third | |
| 3772 | + // party's advisory has nothing to do with SureForms' logging toggle. | |
| 3773 | + $warnings = []; | |
| 3774 | + | |
| 3775 | + if ( Client_Logger::is_enabled() ) { | |
| 3776 | + $warnings = $this->get_first_party_action_items(); | |
| 3777 | + } | |
| 3778 | + | |
| 3779 | + $this->track_action_item_impressions( $warnings ); | |
| 3780 | + | |
| 3781 | + /** | |
| 3782 | + * Filter the dashboard action items. | |
| 3783 | + * | |
| 3784 | + * Each entry needs id, status ('warning' or 'success'), title, message, | |
| 3785 | + * cta_label, cta_url and dismissible. Only ids in | |
| 3786 | + * handle_dismiss_action_item()'s allowlist can actually be dismissed, so | |
| 3787 | + * adding a dismissible item here also needs a line there. | |
| 3788 | + * | |
| 3789 | + * The details dialog is not available here: it is served by | |
| 3790 | + * handle_action_item_details(), which reads SureForms' own client error log | |
| 3791 | + * and knows nothing about a third-party item. Such an item's cta_url is | |
| 3792 | + * followed as a link, which is what it does with JavaScript off anyway. | |
| 3793 | + * | |
| 3794 | + * @since 2.12.6 | |
| 3795 | + * | |
| 3796 | + * @param array<int,array<string,mixed>> $items Action items. | |
| 3797 | + */ | |
| 3798 | + $items = Helper::apply_filters_as_array( 'srfm_action_items', $warnings ); | |
| 3799 | + | |
| 3800 | + // Both URLs normalised once, here, rather than trusting each renderer to do | |
| 3801 | + // it. Two things are being fixed at once. | |
| 3802 | + // | |
| 3803 | + // The scheme: the classic notice runs esc_url() and drops anything outside | |
| 3804 | + // the allowlist, while React assigns href directly and react-dom 18 leaves | |
| 3805 | + // a javascript: URL intact -- its sanitizeURL() only warns, and the warning | |
| 3806 | + // is compiled out of the production build. esc_url_raw() with the same | |
| 3807 | + // allowlist closes both. | |
| 3808 | + // | |
| 3809 | + // The ampersands: Helper::get_sureforms_website_url() returns an esc_url()'d | |
| 3810 | + // string, so a URL with UTM parameters arrives with & in it. In an HTML | |
| 3811 | + // href the browser decodes that; React sets the property directly, so the | |
| 3812 | + // entity would be sent to the server verbatim. Decoded to one raw form here, | |
| 3813 | + // and each renderer escapes it for its own context. | |
| 3814 | + foreach ( $items as $index => $item ) { | |
| 3815 | + // A filter may hand back an object. isset() on it returns false, which | |
| 3816 | + // would slip the item past both the URL normalisation and the | |
| 3817 | + // sanitize_key() below without any sign that it had. | |
| 3818 | + if ( ! is_array( $item ) ) { | |
| 3819 | + continue; | |
| 3820 | + } | |
| 3821 | + | |
| 3822 | + foreach ( [ 'cta_url', 'guide_url' ] as $key ) { | |
| 3823 | + if ( ! isset( $item[ $key ] ) ) { | |
| 3824 | + continue; | |
| 3825 | + } | |
| 3826 | + | |
| 3827 | + $items[ $index ][ $key ] = esc_url_raw( | |
| 3828 | + wp_specialchars_decode( Helper::get_string_value( $item[ $key ] ), ENT_QUOTES ), | |
| 3829 | + [ 'http', 'https', 'mailto' ] | |
| 3830 | + ); | |
| 3831 | + } | |
| 3832 | + | |
| 3833 | + // The id ends up in a data attribute the dialog matches on with an | |
| 3834 | + // attribute selector, and in the dismiss allowlist. sanitize_key() is | |
| 3835 | + // what both dismiss paths already apply, so applying it once here means | |
| 3836 | + // the value that renders is the value they compare against -- and a | |
| 3837 | + // filter-contributed id carrying a quote cannot break the selector. | |
| 3838 | + if ( isset( $item['id'] ) ) { | |
| 3839 | + $items[ $index ]['id'] = sanitize_key( Helper::get_string_value( $item['id'] ) ); | |
| 3840 | + } | |
| 3841 | + } | |
| 3842 | + | |
| 3843 | + self::$action_items_cache = $items; | |
| 3844 | + | |
| 3845 | + return $items; | |
| 3846 | + } | |
| 3847 | + | |
| 3848 | + /** | |
| 3849 | + * Dismiss one action item. | |
| 3850 | + * | |
| 3851 | + * Hooked - wp_ajax_srfm_dismiss_action_item. | |
| 3852 | + * | |
| 3853 | + * Only items get_action_items() marks dismissible can be dismissed, so a | |
| 3854 | + * crafted request cannot silence a genuine fault. | |
| 3855 | + * | |
| 3856 | + * @since 2.12.6 | |
| 3857 | + * @return void | |
| 3858 | + */ | |
| 3859 | + public function handle_dismiss_action_item() { | |
| 3860 | + if ( ! Helper::current_user_can() ) { | |
| 3861 | + wp_send_json_error( [ 'message' => __( 'Unauthorized user.', 'sureforms' ) ], 403 ); | |
| 3862 | + return; | |
| 3863 | + } | |
| 3864 | + | |
| 3865 | + if ( ! check_ajax_referer( 'srfm_dismiss_action_item', 'nonce', false ) ) { | |
| 3866 | + wp_send_json_error( [ 'message' => __( 'Invalid nonce.', 'sureforms' ) ], 403 ); | |
| 3867 | + return; | |
| 3868 | + } | |
| 3869 | + | |
| 3870 | + $item_id = isset( $_POST['item_id'] ) ? sanitize_key( wp_unslash( $_POST['item_id'] ) ) : ''; | |
| 3871 | + | |
| 3872 | + if ( ! $this->dismiss_action_item( $item_id ) ) { | |
| 3873 | + wp_send_json_error( [ 'message' => __( 'Invalid parameters.', 'sureforms' ) ], 400 ); | |
| 3874 | + return; | |
| 3875 | + } | |
| 3876 | + | |
| 3877 | + wp_send_json_success(); | |
| 3878 | + } | |
| 3879 | + | |
| 3880 | + /** | |
| 3881 | + * The stylesheet for the notice carousel and the details dialog. | |
| 3882 | + * | |
| 3883 | + * In a stylesheet rather than inline style assignments in | |
| 3884 | + * notice-response.js, so the rules use logical properties, an RTL sheet can | |
| 3885 | + * override them, and a site can restyle the dialog without patching a script. | |
| 3886 | + * | |
| 3887 | + * Only the classic wp-admin surface needs these. The SureForms dashboard's | |
| 3888 | + * dialog is force-ui's, styled by the Tailwind build, so nothing here reaches | |
| 3889 | + * it -- the two surfaces share their strings, not their markup. | |
| 3890 | + * | |
| 3891 | + * Attached to a registered handle with no file of its own, which is the WP way | |
| 3892 | + * to ship CSS tied to one script. | |
| 3893 | + * | |
| 3894 | + * Hooked to admin_enqueue_scripts rather than called from the renderer. | |
| 3895 | + * admin_notices fires from admin-header.php after admin_print_styles has | |
| 3896 | + * flushed the head, so enqueuing there reached the page only through core's | |
| 3897 | + * late-styles pass in the footer -- and until that parsed, every stacked notice | |
| 3898 | + * rendered expanded before collapsing to one, the carousel controls overlapped | |
| 3899 | + * the notice text, and the defensive `display: none` on the hidden payload was | |
| 3900 | + * inert, which is the exact window that rule exists for. | |
| 3901 | + * | |
| 3902 | + * The buttons are painted explicitly. They carry core's `button` classes for | |
| 3903 | + * their shape and focus behaviour, and core paints those with | |
| 3904 | + * `var(--wp-admin-theme-color)` -- so without this the dialog renders in | |
| 3905 | + * whichever admin colour scheme the user picked, which on a default install is | |
| 3906 | + * blue, on a SureForms panel that is otherwise entirely brand orange. Same | |
| 3907 | + * approach and same values as print_srfm_notice_styles(). | |
| 3908 | + * | |
| 3909 | + * @since 2.12.7 | |
| 3910 | + * @return void | |
| 3911 | + */ | |
| 3912 | + public function enqueue_action_item_styles() { | |
| 3913 | + if ( wp_style_is( 'srfm-action-items', 'enqueued' ) ) { | |
| 3914 | + return; | |
| 3915 | + } | |
| 3916 | + | |
| 3917 | + if ( ! Helper::current_user_can() ) { | |
| 3918 | + return; | |
| 3919 | + } | |
| 3920 | + | |
| 3921 | + // Nothing to style unless the carousel is actually going to build. Cheap to | |
| 3922 | + // ask: get_action_items() is memoised for the request. | |
| 3923 | + // | |
| 3924 | + // Two, not one: notice-response.js bails below two cards, so these rules | |
| 3925 | + // have no consumer on a site with a single open fault. | |
| 3926 | + $notices = 0; | |
| 3927 | + | |
| 3928 | + foreach ( $this->get_action_items() as $item ) { | |
| 3929 | + $status = Helper::get_string_value( is_array( $item ) ? $item['status'] ?? '' : '' ); | |
| 3930 | + | |
| 3931 | + if ( 'success' !== $status && '' !== $status ) { | |
| 3932 | + $notices++; | |
| 3933 | + } | |
| 3934 | + } | |
| 3935 | + | |
| 3936 | + if ( $notices < 2 ) { | |
| 3937 | + return; | |
| 3938 | + } | |
| 3939 | + | |
| 3940 | + wp_register_style( 'srfm-action-items', false, [], SRFM_VER ); | |
| 3941 | + wp_enqueue_style( 'srfm-action-items' ); | |
| 3942 | + | |
| 3943 | + $css = <<<'CSS' | |
| 3944 | +.srfm-action-item-carousel { position: relative; } | |
| 3945 | +.srfm-action-item-carousel .srfm-action-item-notice { padding-inline-end: var(--srfm-carousel-reserve, 130px); } | |
| 3946 | +/* [hidden] is only a UA rule, and WordPress sets display on .notice, so a | |
| 3947 | + third-party admin sheet can otherwise put a notice the carousel has hidden back | |
| 3948 | + on screen. */ | |
| 3949 | +.srfm-action-item-carousel .srfm-action-item-notice[hidden] { display: none; } | |
| 3950 | +.srfm-action-item-carousel-nav { | |
| 3951 | + position: absolute; | |
| 3952 | + top: 8px; | |
| 3953 | + inset-inline-end: 12px; | |
| 3954 | + margin: 0; | |
| 3955 | + display: flex; | |
| 3956 | + align-items: center; | |
| 3957 | + gap: 8px; | |
| 3958 | +} | |
| 3959 | +.srfm-details-overlay { | |
| 3960 | + position: fixed; | |
| 3961 | + inset: 0; | |
| 3962 | + z-index: 999999; | |
| 3963 | + display: flex; | |
| 3964 | + align-items: center; | |
| 3965 | + justify-content: center; | |
| 3966 | + background: rgba(0, 0, 0, .5); | |
| 3967 | + padding: 16px; | |
| 3968 | +} | |
| 3969 | +.srfm-details-panel { | |
| 3970 | + background: #fff; | |
| 3971 | + border-radius: 8px; | |
| 3972 | + padding: 16px; | |
| 3973 | + width: 100%; | |
| 3974 | + max-width: 800px; | |
| 3975 | + box-shadow: 0 10px 30px rgba(0, 0, 0, .2); | |
| 3976 | +} | |
| 3977 | +.srfm-details-panel h2 { margin: 0 0 4px; font-size: 14px; } | |
| 3978 | +.srfm-details-panel .srfm-details-description { margin: 0 0 12px; color: #50575e; } | |
| 3979 | +.srfm-details-panel pre { | |
| 3980 | + margin: 0; | |
| 3981 | + max-height: 320px; | |
| 3982 | + overflow: auto; | |
| 3983 | + white-space: pre-wrap; | |
| 3984 | + word-break: break-word; | |
| 3985 | + background: #f6f7f7; | |
| 3986 | + padding: 12px; | |
| 3987 | + border-radius: 6px; | |
| 3988 | + font-size: 12px; | |
| 3989 | +} | |
| 3990 | +.srfm-details-actions { | |
| 3991 | + display: flex; | |
| 3992 | + gap: 8px; | |
| 3993 | + align-items: center; | |
| 3994 | + flex-wrap: wrap; | |
| 3995 | + justify-content: flex-end; | |
| 3996 | + margin: 12px 0 0; | |
| 3997 | +} | |
| 3998 | +.srfm-details-hint { | |
| 3999 | + margin-inline-end: auto; | |
| 4000 | + font-size: 12px; | |
| 4001 | + color: #4b5563; | |
| 4002 | +} | |
| 4003 | +/* Core paints .button with the admin colour scheme, so these say what they are | |
| 4004 | + rather than inheriting whichever scheme the user picked. */ | |
| 4005 | +.srfm-details-panel .srfm-details-close.button-link { | |
| 4006 | + color: #50575e; | |
| 4007 | + text-decoration: none; | |
| 4008 | +} | |
| 4009 | +.srfm-details-panel .srfm-details-close.button-link:hover, | |
| 4010 | +.srfm-details-panel .srfm-details-close.button-link:focus { | |
| 4011 | + color: #1e1e1e; | |
| 4012 | +} | |
| 4013 | +.srfm-details-panel .srfm-details-copy.button { | |
| 4014 | + background: #fff; | |
| 4015 | + border-color: #c3c4c7; | |
| 4016 | + color: #1e1e1e; | |
| 4017 | +} | |
| 4018 | +.srfm-details-panel .srfm-details-copy.button:hover, | |
| 4019 | +.srfm-details-panel .srfm-details-copy.button:focus { | |
| 4020 | + background: #f6f7f7; | |
| 4021 | + border-color: #8c8f94; | |
| 4022 | + color: #1e1e1e; | |
| 4023 | +} | |
| 4024 | +.srfm-details-panel .srfm-details-contact.button-primary, | |
| 4025 | +.srfm-details-panel .srfm-details-contact.button-primary:hover, | |
| 4026 | +.srfm-details-panel .srfm-details-contact.button-primary:focus { | |
| 4027 | + background: #D54407; | |
| 4028 | + border-color: #D54407; | |
| 4029 | + color: #fff; | |
| 4030 | + box-shadow: none; | |
| 4031 | + text-shadow: none; | |
| 4032 | + text-decoration: none; | |
| 4033 | +} | |
| 4034 | +.srfm-details-panel .srfm-details-contact.button-primary:hover, | |
| 4035 | +.srfm-details-panel .srfm-details-contact.button-primary:focus { | |
| 4036 | + background: #C83B00; | |
| 4037 | + border-color: #C83B00; | |
| 4038 | +} | |
| 4039 | +/* Grey rather than a dimmed orange fill. Core sets the disabled text colour with | |
| 4040 | + !important, so an orange background here leaves grey on orange at 1.31:1 -- | |
| 4041 | + and a control that cannot be used should not wear the primary colour anyway. | |
| 4042 | + This is what core gives every other disabled button, and what force-ui renders | |
| 4043 | + for the same state on the dashboard, so the two surfaces agree. */ | |
| 4044 | +.srfm-details-panel .srfm-details-contact.button-primary[aria-disabled="true"], | |
| 4045 | +.srfm-details-panel .srfm-details-contact.button-primary[aria-disabled="true"]:hover, | |
| 4046 | +.srfm-details-panel .srfm-details-contact.button-primary[aria-disabled="true"]:focus { | |
| 4047 | + background: #f6f7f7; | |
| 4048 | + border-color: #dcdcde; | |
| 4049 | + pointer-events: none; | |
| 4050 | + box-shadow: none; | |
| 4051 | +} | |
| 4052 | +.srfm-details-panel .button:focus { | |
| 4053 | + outline: 2px solid #D54407; | |
| 4054 | + outline-offset: 1px; | |
| 4055 | + box-shadow: none; | |
| 4056 | +} | |
| 4057 | +CSS; | |
| 4058 | + | |
| 4059 | + wp_add_inline_style( 'srfm-action-items', $css ); | |
| 4060 | + } | |
| 4061 | + | |
| 4062 | + /** | |
| 4063 | + * The details dialog's strings. | |
| 4064 | + * | |
| 4065 | + * One array, two consumers: the classic wp-admin dialog in | |
| 4066 | + * notice-response.js, and the dashboard's force-ui one. Declared here rather | |
| 4067 | + * than inline in each, because the same sentence written as `__()` in PHP and | |
| 4068 | + * again in JSX looks identical to translators until the first edit to either, | |
| 4069 | + * after which one surface silently reverts to English. | |
| 4070 | + * | |
| 4071 | + * @since 2.12.7 | |
| 4072 | + * @return array<string,string> | |
| 4073 | + */ | |
| 4074 | + private function get_details_dialog_labels() { | |
| 4075 | + return [ | |
| 4076 | + 'title' => __( 'Details', 'sureforms' ), | |
| 4077 | + 'description' => __( 'What we recorded about this problem. Copy it into your support request so we can start from the cause rather than a description of it.', 'sureforms' ), | |
| 4078 | + 'copy' => __( 'Copy details', 'sureforms' ), | |
| 4079 | + 'copied' => __( 'Copied', 'sureforms' ), | |
| 4080 | + 'contact' => __( 'Contact Support', 'sureforms' ), | |
| 4081 | + 'close' => __( 'Close', 'sureforms' ), | |
| 4082 | + // Shown beside the buttons rather than as a title attribute: | |
| 4083 | + // pointer-events:none suppresses the native tooltip, a title | |
| 4084 | + // never fires on keyboard focus, and screen readers commonly | |
| 4085 | + // drop it on an unavailable control -- so the sentence saying | |
| 4086 | + // why the button is inert could not be read by anyone. | |
| 4087 | + 'copyFirst' => __( 'Copy the details first, so you have them to paste.', 'sureforms' ), | |
| 4088 | + // The unlock changes the label, the icon and whether Contact | |
| 4089 | + // Support works, none of which was announced. This goes in a | |
| 4090 | + // role="status" node so it is. | |
| 4091 | + 'unlocked' => __( 'Copied. Contact Support is now available.', 'sureforms' ), | |
| 4092 | + 'copyFailed' => __( 'Your browser would not let us copy. Select the text above and copy it by hand.', 'sureforms' ), | |
| 4093 | + // The scrollable diagnostics block is focusable, so it needs a name of | |
| 4094 | + // its own. | |
| 4095 | + 'logRegion' => __( 'Recorded diagnostics', 'sureforms' ), | |
| 4096 | + // The dialog opens before its payload arrives -- see | |
| 4097 | + // handle_action_item_details() for why the report is not shipped with | |
| 4098 | + // the page. | |
| 4099 | + 'loading' => __( 'Collecting the details…', 'sureforms' ), | |
| 4100 | + 'unavailable' => __( 'We could not collect the details. Contact Support and describe what happened, and we will take it from there.', 'sureforms' ), | |
| 4101 | + ]; | |
| 4102 | + } | |
| 4103 | + | |
| 4104 | + /** | |
| 4105 | + * SureForms' own action items, before the filter. | |
| 4106 | + * | |
| 4107 | + * Split out so the Enable Logs gate in get_action_items() can sit above this | |
| 4108 | + * rather than above `srfm_action_items`. An item contributed through that | |
| 4109 | + * filter has nothing to do with SureForms' logging toggle, and was being | |
| 4110 | + * silenced by it. | |
| 4111 | + * | |
| 4112 | + * @since 2.12.7 | |
| 4113 | + * @return array<int,array<string,mixed>> | |
| 4114 | + */ | |
| 4115 | + private function get_first_party_action_items() { | |
| 4116 | + $warnings = []; | |
| 4117 | + $open = Client_Logger::get_open_failures(); | |
| 4118 | + | |
| 4119 | + // One item per category. They read differently to a site owner and must not | |
| 4120 | + // be collapsed: submissions failing means visitors cannot reach you, a | |
| 4121 | + // notification failing means you are not hearing about entries that did | |
| 4122 | + // save, an integration failing means a third party is not receiving them. | |
| 4123 | + $categories = [ | |
| 4124 | + 'submission' => [ | |
| 4125 | + 'id' => 'form_submission_error', | |
| 4126 | + /* translators: %s: form title. */ | |
| 4127 | + 'title' => __( 'We noticed a form submission failure on %s.', 'sureforms' ), | |
| 4128 | + 'generic' => __( 'We noticed a form submission failure.', 'sureforms' ), | |
| 4129 | + 'message' => __( 'Visitors may not be able to reach you, and their entries were not saved.', 'sureforms' ), | |
| 4130 | + ], | |
| 4131 | + 'notification' => [ | |
| 4132 | + 'id' => 'notification_error', | |
| 4133 | + /* translators: %s: form title. */ | |
| 4134 | + 'title' => __( 'We noticed a notification failure on %s.', 'sureforms' ), | |
| 4135 | + 'generic' => __( 'We noticed a notification failure.', 'sureforms' ), | |
| 4136 | + 'message' => __( 'The entry was saved, but we could not send the email about it. New entries may be coming in without you knowing.', 'sureforms' ), | |
| 4137 | + // Email is the one failure here a site owner can usually fix without | |
| 4138 | + // us: it is almost always SMTP not being configured. Offer the guide | |
| 4139 | + // alongside support rather than making them wait for a reply. | |
| 4140 | + 'guide' => Helper::get_sureforms_website_url( | |
| 4141 | + 'docs/troubleshooting-email-sending-in-sureforms/', | |
| 4142 | + [ | |
| 4143 | + 'utm_medium' => 'form_checks_notice', | |
| 4144 | + 'utm_content' => 'notification_error', | |
| 4145 | + ] | |
| 4146 | + ), | |
| 4147 | + ], | |
| 4148 | + 'integration' => [ | |
| 4149 | + 'id' => 'integration_error', | |
| 4150 | + /* translators: %s: form title. */ | |
| 4151 | + 'title' => __( 'We noticed an integration failure on %s.', 'sureforms' ), | |
| 4152 | + 'generic' => __( 'We noticed an integration failure.', 'sureforms' ), | |
| 4153 | + 'message' => __( 'The entry was saved, but we could not send it to a connected service.', 'sureforms' ), | |
| 4154 | + ], | |
| 4155 | + ]; | |
| 4156 | + | |
| 4157 | + foreach ( $categories as $category => $copy ) { | |
| 4158 | + if ( ! isset( $open[ $category ] ) ) { | |
| 4159 | + continue; | |
| 4160 | + } | |
| 4161 | + | |
| 4162 | + // Name the form. "A form is failing" is not actionable on a site with | |
| 4163 | + // twenty of them, and the title is the first thing anyone asks for. | |
| 4164 | + $form_title = Helper::get_string_value( $open[ $category ]['form_title'] ?? '' ); | |
| 4165 | + | |
| 4166 | + $warning = [ | |
| 4167 | + 'id' => $copy['id'], | |
| 4168 | + 'status' => 'error', | |
| 4169 | + 'title' => '' !== $form_title | |
| 4170 | + ? sprintf( $copy['title'], $form_title ) | |
| 4171 | + : $copy['generic'], | |
| 4172 | + 'message' => $copy['message'], | |
| 4173 | + // Shows what would be sent before anything is sent. Someone reporting | |
| 4174 | + // a fault on their own site is entitled to read the diagnostics and | |
| 4175 | + // the log first, and a support agent gets a cleaner paste than a | |
| 4176 | + // screenshot of a notice. | |
| 4177 | + 'cta_label' => __( 'View details', 'sureforms' ), | |
| 4178 | + // Where the classic wp-admin notice sends people, since it cannot open | |
| 4179 | + // the panel's dialog. The dashboard is where the details are readable. | |
| 4180 | + 'cta_url' => admin_url( 'admin.php?page=sureforms_menu' ), | |
| 4181 | + 'cta_action' => 'view_details', | |
| 4182 | + // Not the payload itself, only that one exists. The diagnostics are | |
| 4183 | + // fetched when the dialog opens -- see handle_action_item_details(). | |
| 4184 | + // | |
| 4185 | + // They used to ride along in the localisation JSON and in a hidden | |
| 4186 | + // div on every admin page. The content is authored by whoever | |
| 4187 | + // triggered the failure, and the client-error-log route is a public | |
| 4188 | + // endpoint gated on a submit token rather than a capability, so an | |
| 4189 | + // anonymous visitor can fill that excerpt. Broadcasting it to every | |
| 4190 | + // admin screen -- read or not -- put attacker-authored text in page | |
| 4191 | + // source site-wide and made any future escaping slip a | |
| 4192 | + // manage_options-context problem. On demand, it reaches only the | |
| 4193 | + // admin who asked for it. | |
| 4194 | + 'has_details' => true, | |
| 4195 | + // Which record to fetch. Not the payload, just the key. | |
| 4196 | + 'category' => $category, | |
| 4197 | + 'dismissible' => false, | |
| 4198 | + ]; | |
| 4199 | + | |
| 4200 | + // A second, optional action. Absent keys render nothing, so a category | |
| 4201 | + // without a guide needs no branch in either renderer, and neither does | |
| 4202 | + // an item contributed through srfm_action_items. | |
| 4203 | + if ( ! empty( $copy['guide'] ) ) { | |
| 4204 | + $warning['guide_label'] = __( 'Help Me Fix', 'sureforms' ); | |
| 4205 | + $warning['guide_url'] = $copy['guide']; | |
| 4206 | + $warning['guide_action'] = 'help_me_fix'; | |
| 4207 | + } | |
| 4208 | + | |
| 4209 | + $warnings[] = $warning; | |
| 4210 | + } | |
| 4211 | + | |
| 4212 | + $caching_plugin = Helper::get_active_caching_plugin(); | |
| 4213 | + | |
| 4214 | + if ( '' === $caching_plugin ) { | |
| 4215 | + return $warnings; | |
| 4216 | + } | |
| 4217 | + | |
| 4218 | + // Read here rather than at the top: with no caching plugin active nothing | |
| 4219 | + // consults it, and this is the only dismissible item. | |
| 4220 | + $dismissed = Helper::get_array_value( Helper::get_srfm_option( 'dismissed_action_items', [] ) ); | |
| 4221 | + | |
| 4222 | + if ( ! in_array( 'caching_plugin', $dismissed, true ) ) { | |
| 4223 | + $warnings[] = [ | |
| 4224 | + 'id' => 'caching_plugin', | |
| 4225 | + 'status' => 'warning', | |
| 4226 | + 'title' => sprintf( | |
| 4227 | + /* translators: %s: caching plugin name. */ | |
| 4228 | + __( '%s may interfere with your forms.', 'sureforms' ), | |
| 4229 | + $caching_plugin | |
| 4230 | + ), | |
| 4231 | + 'message' => __( 'Caching can show visitors an old copy of your form, or load its scripts in the wrong order.', 'sureforms' ), | |
| 4232 | + 'cta_label' => __( 'Help Me Fix', 'sureforms' ), | |
| 4233 | + 'cta_url' => Helper::get_caching_plugin_doc_url(), | |
| 4234 | + 'cta_action' => 'help_me_fix', | |
| 4235 | + 'dismissible' => true, | |
| 4236 | + ]; | |
| 4237 | + } | |
| 4238 | + | |
| 4239 | + return $warnings; | |
| 4240 | + } | |
| 4241 | + | |
| 4242 | + /** | |
| 4243 | + * Nonce-protected URL that repairs the entries table. | |
| 4244 | + * | |
| 4245 | + * Shared by both notice surfaces so there is one repair route, one nonce and one | |
| 4246 | + * place that counts the click. Private, so it stays off the public API and out of | |
| 4247 | + * the test-coverage gate. | |
| 4248 | + * | |
| 4249 | + * @since 2.12.6 | |
| 4250 | + * @return string | |
| 4251 | + */ | |
| 4252 | + private function get_database_repair_url() { | |
| 4253 | + return wp_nonce_url( | |
| 4254 | + admin_url( 'admin-post.php?action=srfm_repair_entries_table' ), | |
| 4255 | + 'srfm_repair_entries_table' | |
| 4256 | + ); | |
| 4257 | + } | |
| 4258 | + | |
| 4259 | + /** | |
| 4260 | + * The database notice body, which differs by what the repair will actually do. | |
| 4261 | + * | |
| 4262 | + * Two outcomes are possible and they are not equivalent to the person clicking: | |
| 4263 | + * when the entries table exists under a different prefix — a changed | |
| 4264 | + * `$table_prefix`, a restored dump, a security plugin that renamed tables and | |
| 4265 | + * skipped ours — the repair renames it back and every stored entry comes with | |
| 4266 | + * it. When there is nothing to adopt, the repair creates an empty table and the | |
| 4267 | + * old submissions are not recoverable from here. | |
| 4268 | + * | |
| 4269 | + * Promising the wrong one is how a maintenance prompt turns into a complaint, so | |
| 4270 | + * the copy states which is about to happen. | |
| 4271 | + * | |
| 4272 | + * @since 2.12.6 | |
| 4273 | + * @return string | |
| 4274 | + */ | |
| 4275 | + private function get_database_notice_message() { | |
| 4276 | + if ( '' !== Register::get_adoptable_entries_table() ) { | |
| 4277 | + return __( 'SureForms found your form entries stored under a different database table prefix. Reconnecting them takes a moment, and your existing entries will be kept.', 'sureforms' ); | |
| 4278 | + } | |
| 4279 | + | |
| 4280 | + return __( 'SureForms needs to update your database before it can save new form entries. This only takes a moment and will not change your forms or existing content. Entries submitted before now cannot be recovered from here.', 'sureforms' ); | |
| 4281 | + } | |
| 4282 | + | |
| 4283 | + /** | |
| 4284 | + * Count one sighting of the database notice, at most once per user per day. | |
| 4285 | + * | |
| 4286 | + * While the table is missing the notice renders on every admin page load, on two | |
| 4287 | + * surfaces. Counting each render would rewrite the autoloaded `srfm_options` blob | |
| 4288 | + * on every pageview of a site that is already broken, and one site left unfixed | |
| 4289 | + * would dominate the aggregate. Throttling to a day per user answers the question | |
| 4290 | + * that matters — how many people are seeing this — for one write. | |
| 4291 | + * | |
| 4292 | + * @since 2.12.6 | |
| 4293 | + * @return void | |
| 4294 | + */ | |
| 4295 | + private function track_database_notice_impression() { | |
| 4296 | + $user_id = get_current_user_id(); | |
| 4297 | + | |
| 4298 | + if ( ! $user_id ) { | |
| 4299 | + return; | |
| 4300 | + } | |
| 4301 | + | |
| 4302 | + $key = 'srfm_db_notice_seen_' . $user_id; | |
| 4303 | + | |
| 4304 | + if ( get_transient( $key ) ) { | |
| 4305 | + return; | |
| 4306 | + } | |
| 4307 | + | |
| 4308 | + set_transient( $key, 1, DAY_IN_SECONDS ); | |
| 4309 | + | |
| 4310 | + Analytics::events()->track( 'database_error_notice_shown', 'entries' ); | |
| 4311 | + } | |
| 4312 | + | |
| 4313 | + /** | |
| 2907 | 4314 | * Build the setup-card payload (uncached). See get_form_setup_card(). |
| 2908 | 4315 | * |
| 2909 | 4316 | * @since 2.12.4 |
| 2910 | 4317 | * @return array<string,mixed>|null Card payload, or null when there is no candidate. |
| @@ -3114,27 +4521,93 @@ | ||
| 3114 | 4521 | // per-step claim — so it is always accurate whatever the user has since |
| 3115 | 4522 | // changed, while the action buttons point to the specific things to finish. |
| 3116 | 4523 | $sentence = __( 'We’ve already created this form for you. Finish customising it so it’s ready to collect real submissions.', 'sureforms' ); |
| 3117 | 4524 | |
| 4525 | + return self::build_srfm_notice_markup( | |
| 4526 | + sprintf( | |
| 4527 | + /* translators: %s: form name. */ | |
| 4528 | + __( 'Finish setting up “%s”', 'sureforms' ), | |
| 4529 | + $form['title'] | |
| 4530 | + ), | |
| 4531 | + $sentence, | |
| 4532 | + [ | |
| 4533 | + [ | |
| 4534 | + 'text' => __( 'Edit form', 'sureforms' ), | |
| 4535 | + 'url' => $form['edit_url'], | |
| 4536 | + 'primary' => true, | |
| 4537 | + 'class' => 'srfm-ty-edit-form', | |
| 4538 | + 'external' => true, | |
| 4539 | + ], | |
| 4540 | + [ | |
| 4541 | + 'text' => __( 'Edit the Thank You message', 'sureforms' ), | |
| 4542 | + 'url' => $form['thankyou_url'], | |
| 4543 | + 'class' => 'srfm-ty-edit-thankyou', | |
| 4544 | + 'external' => true, | |
| 4545 | + ], | |
| 4546 | + [ | |
| 4547 | + 'text' => __( 'Set where replies go', 'sureforms' ), | |
| 4548 | + 'url' => $form['replies_url'], | |
| 4549 | + 'class' => 'srfm-ty-set-replies', | |
| 4550 | + 'external' => true, | |
| 4551 | + ], | |
| 4552 | + ] | |
| 4553 | + ); | |
| 4554 | + } | |
| 4555 | + | |
| 4556 | + /** | |
| 4557 | + * Build the shared SureForms admin-notice body: title, sentence, action row. | |
| 4558 | + * | |
| 4559 | + * One builder for every SureForms notice so they cannot drift into looking like | |
| 4560 | + * two different plugins. Everything is escaped here rather than by the caller — | |
| 4561 | + * the notices library runs the result through wp_kses_post(), which would strip | |
| 4562 | + * anything richer anyway. | |
| 4563 | + * | |
| 4564 | + * @param string $title Notice heading. | |
| 4565 | + * @param string $text Supporting sentence. | |
| 4566 | + * @param array<int,array<string,mixed>> $actions Action links. Each accepts | |
| 4567 | + * text, url, and optionally | |
| 4568 | + * primary, class, external, | |
| 4569 | + * dismiss and snooze (seconds). | |
| 4570 | + * @since 2.12.6 | |
| 4571 | + * @return string | |
| 4572 | + */ | |
| 4573 | + private static function build_srfm_notice_markup( $title, $text, $actions ) { | |
| 3118 | 4574 | ob_start(); |
| 3119 | 4575 | ?> |
| 3120 | - <p class="srfm-thankyou-notice__title"> | |
| 4576 | + <p class="srfm-notice__title"><?php echo esc_html( $title ); ?></p> | |
| 4577 | + <p class="srfm-notice__text"><?php echo esc_html( $text ); ?></p> | |
| 4578 | + <p class="srfm-notice__actions"> | |
| 3121 | 4579 | <?php |
| 3122 | - echo esc_html( | |
| 3123 | - sprintf( | |
| 3124 | - /* translators: %s: form name. */ | |
| 3125 | - __( 'Finish setting up “%s”', 'sureforms' ), | |
| 3126 | - $form['title'] | |
| 3127 | - ) | |
| 3128 | - ); | |
| 4580 | + foreach ( $actions as $action ) { | |
| 4581 | + if ( empty( $action['text'] ) || ! isset( $action['url'] ) ) { | |
| 4582 | + continue; | |
| 4583 | + } | |
| 4584 | + | |
| 4585 | + $classes = [ 'button' ]; | |
| 4586 | + | |
| 4587 | + if ( ! empty( $action['primary'] ) ) { | |
| 4588 | + $classes[] = 'button-primary'; | |
| 4589 | + } | |
| 4590 | + | |
| 4591 | + // astra-notice-close is what the library binds its dismiss handler to. | |
| 4592 | + if ( ! empty( $action['dismiss'] ) ) { | |
| 4593 | + $classes[] = 'astra-notice-close'; | |
| 4594 | + } | |
| 4595 | + | |
| 4596 | + if ( ! empty( $action['class'] ) ) { | |
| 4597 | + $classes[] = $action['class']; | |
| 4598 | + } | |
| 4599 | + ?> | |
| 4600 | + <a | |
| 4601 | + class="<?php echo esc_attr( implode( ' ', $classes ) ); ?>" | |
| 4602 | + href="<?php echo esc_url( $action['url'] ); ?>" | |
| 4603 | + <?php echo empty( $action['snooze'] ) ? '' : ' data-repeat-notice-after="' . esc_attr( (string) $action['snooze'] ) . '"'; ?> | |
| 4604 | + <?php echo empty( $action['external'] ) ? '' : ' target="_blank" rel="noopener noreferrer"'; ?> | |
| 4605 | + ><?php echo esc_html( $action['text'] ); ?></a> | |
| 4606 | + <?php | |
| 4607 | + } | |
| 3129 | 4608 | ?> |
| 3130 | 4609 | </p> |
| 3131 | - <p class="srfm-thankyou-notice__text"><?php echo esc_html( $sentence ); ?></p> | |
| 3132 | - <p class="srfm-thankyou-notice__actions"> | |
| 3133 | - <a class="button button-primary srfm-ty-edit-form" href="<?php echo esc_url( $form['edit_url'] ); ?>" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Edit form', 'sureforms' ); ?></a> | |
| 3134 | - <a class="button srfm-ty-edit-thankyou" href="<?php echo esc_url( $form['thankyou_url'] ); ?>" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Edit the Thank You message', 'sureforms' ); ?></a> | |
| 3135 | - <a class="button srfm-ty-set-replies" href="<?php echo esc_url( $form['replies_url'] ); ?>" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Set where replies go', 'sureforms' ); ?></a> | |
| 3136 | - </p> | |
| 3137 | 4610 | <?php |
| 3138 | 4611 | return (string) ob_get_clean(); |
| 3139 | 4612 | } |
| 3140 | 4613 | |
| @@ -3195,68 +4668,8 @@ | ||
| 3195 | 4668 | return 0 === strpos( $page, 'sureforms' ) || 0 === strpos( $page, 'srfm' ); |
| 3196 | 4669 | } |
| 3197 | 4670 | |
| 3198 | 4671 | /** |
| 3199 | - * Build the shared HTML markup for admin notices. | |
| 3200 | - * | |
| 3201 | - * @since 2.5.2 | |
| 3202 | - * | |
| 3203 | - * All text parameters must be pre-escaped by the caller (e.g. via esc_html__()). | |
| 3204 | - * URL parameters must be pre-escaped via esc_url(). | |
| 3205 | - * | |
| 3206 | - * @param string $heading The notice heading text (pre-escaped). | |
| 3207 | - * @param string $message The notice body text (pre-escaped). | |
| 3208 | - * @param string $cta_url The primary CTA URL (pre-escaped). | |
| 3209 | - * @param string $cta_text The primary CTA button text (pre-escaped). | |
| 3210 | - * @param string $snooze_text The snooze button text (pre-escaped). | |
| 3211 | - * @param string $dismiss_text The dismiss button text (pre-escaped). | |
| 3212 | - * @param int $snooze_duration Snooze duration in seconds for the data-repeat-notice-after attribute. | |
| 3213 | - * @param bool $external_cta Whether the CTA opens in a new tab and also dismisses the notice | |
| 3214 | - * via the astra-notice-close class. Default false. | |
| 3215 | - * @return string The notice HTML markup. | |
| 3216 | - */ | |
| 3217 | - private function build_notice_markup( $heading, $message, $cta_url, $cta_text, $snooze_text, $dismiss_text, $snooze_duration, $external_cta = false ) { | |
| 3218 | - $image_path = esc_url( SRFM_URL . 'admin/assets/sureforms-logo.png' ); | |
| 3219 | - $cta_class = $external_cta ? 'astra-notice-close button-primary' : 'button-primary'; | |
| 3220 | - $cta_attrs = $external_cta ? ' target="_blank" rel="noopener noreferrer"' : ''; | |
| 3221 | - | |
| 3222 | - return sprintf( | |
| 3223 | - '<div class="notice-image"> | |
| 3224 | - <img src="%1$s" class="custom-logo" alt="SureForms" itemprop="logo"> | |
| 3225 | - </div> | |
| 3226 | - <div class="notice-content"> | |
| 3227 | - <div class="notice-heading"> | |
| 3228 | - %2$s | |
| 3229 | - </div> | |
| 3230 | - %3$s<br /> | |
| 3231 | - <div class="astra-review-notice-container"> | |
| 3232 | - <a href="%4$s" class="%5$s"%6$s> | |
| 3233 | - %7$s | |
| 3234 | - </a> | |
| 3235 | - <span class="dashicons dashicons-clock" aria-hidden="true"></span> | |
| 3236 | - <a href="#" data-repeat-notice-after="%8$s" class="astra-notice-close"> | |
| 3237 | - %9$s | |
| 3238 | - </a> | |
| 3239 | - <span class="dashicons dashicons-smiley" aria-hidden="true"></span> | |
| 3240 | - <a href="#" class="astra-notice-close"> | |
| 3241 | - %10$s | |
| 3242 | - </a> | |
| 3243 | - </div> | |
| 3244 | - </div>', | |
| 3245 | - $image_path, | |
| 3246 | - $heading, | |
| 3247 | - $message, | |
| 3248 | - $cta_url, | |
| 3249 | - esc_attr( $cta_class ), | |
| 3250 | - $cta_attrs, | |
| 3251 | - $cta_text, | |
| 3252 | - $snooze_duration, | |
| 3253 | - $snooze_text, | |
| 3254 | - $dismiss_text | |
| 3255 | - ); | |
| 3256 | - } | |
| 3257 | - | |
| 3258 | - /** | |
| 3259 | 4672 | * Callback for displaying the rating notice conditionally. |
| 3260 | 4673 | * |
| 3261 | 4674 | * Returns true if the user has 3 or more published forms or 3 or more form entries. |
| 3262 | 4675 | * |
| @@ -3372,5 +4785,504 @@ | ||
| 3372 | 4785 | |
| 3373 | 4786 | return false; |
| 3374 | 4787 | } |
| 3375 | 4788 | |
| 4789 | + /** | |
| 4790 | + * Nonced URL that dismisses one action item without JavaScript. | |
| 4791 | + * | |
| 4792 | + * The classic notice cannot use the AJAX dismissal the carousel uses, and | |
| 4793 | + * WordPress's own `is-dismissible` only hides the notice for that pageview. | |
| 4794 | + * | |
| 4795 | + * @param string $item_id Item to dismiss. | |
| 4796 | + * @since 2.12.6 | |
| 4797 | + * @return string | |
| 4798 | + */ | |
| 4799 | + private function get_dismiss_action_item_url( $item_id ) { | |
| 4800 | + return wp_nonce_url( | |
| 4801 | + add_query_arg( | |
| 4802 | + [ | |
| 4803 | + 'action' => 'srfm_dismiss_action_item_link', | |
| 4804 | + 'item' => $item_id, | |
| 4805 | + ], | |
| 4806 | + admin_url( 'admin-post.php' ) | |
| 4807 | + ), | |
| 4808 | + 'srfm_dismiss_action_item' | |
| 4809 | + ); | |
| 4810 | + } | |
| 4811 | + | |
| 4812 | + /** | |
| 4813 | + * Count one sighting of each warning, at most once per user per day. | |
| 4814 | + * | |
| 4815 | + * Throttled because the classic notice renders on every admin page: counting | |
| 4816 | + * each render would measure how much wp-admin someone browses, not how many | |
| 4817 | + * sites are affected. A day per user answers the question that matters -- how | |
| 4818 | + * many people are seeing this -- for one option write. | |
| 4819 | + * | |
| 4820 | + * Counts SureForms' own items only. It runs before `srfm_action_items`, so a | |
| 4821 | + * third party's contribution is not counted here -- SureForms has no name for | |
| 4822 | + * it and no analytics key that would mean anything. | |
| 4823 | + * | |
| 4824 | + * @param array<int,array<string,mixed>> $warnings SureForms' own items. | |
| 4825 | + * @since 2.12.6 | |
| 4826 | + * @return void | |
| 4827 | + */ | |
| 4828 | + private function track_action_item_impressions( $warnings ) { | |
| 4829 | + if ( empty( $warnings ) || wp_doing_ajax() ) { | |
| 4830 | + return; | |
| 4831 | + } | |
| 4832 | + | |
| 4833 | + $user_id = get_current_user_id(); | |
| 4834 | + | |
| 4835 | + if ( ! $user_id ) { | |
| 4836 | + return; | |
| 4837 | + } | |
| 4838 | + | |
| 4839 | + $counts = Helper::get_array_value( Helper::get_srfm_option( 'action_item_impressions', [] ) ); | |
| 4840 | + $changed = false; | |
| 4841 | + | |
| 4842 | + foreach ( $warnings as $warning ) { | |
| 4843 | + $item_id = Helper::get_string_value( $warning['id'] ?? '' ); | |
| 4844 | + | |
| 4845 | + if ( '' === $item_id ) { | |
| 4846 | + continue; | |
| 4847 | + } | |
| 4848 | + | |
| 4849 | + $seen_key = 'srfm_action_item_seen_' . $item_id . '_' . $user_id; | |
| 4850 | + | |
| 4851 | + if ( get_transient( $seen_key ) ) { | |
| 4852 | + continue; | |
| 4853 | + } | |
| 4854 | + | |
| 4855 | + set_transient( $seen_key, 1, DAY_IN_SECONDS ); | |
| 4856 | + | |
| 4857 | + $counts[ $item_id ] = Helper::get_integer_value( $counts[ $item_id ] ?? 0 ) + 1; | |
| 4858 | + $changed = true; | |
| 4859 | + | |
| 4860 | + // Cumulative, so $force = true: each new count is a new value and is | |
| 4861 | + // re-sent, while an identical repeat short-circuits inside track(). | |
| 4862 | + Analytics::events()->track( | |
| 4863 | + $item_id . '_notice_shown', | |
| 4864 | + (string) $counts[ $item_id ], | |
| 4865 | + [], | |
| 4866 | + true | |
| 4867 | + ); | |
| 4868 | + } | |
| 4869 | + | |
| 4870 | + if ( $changed ) { | |
| 4871 | + Helper::update_srfm_option( 'action_item_impressions', $counts ); | |
| 4872 | + } | |
| 4873 | + } | |
| 4874 | + | |
| 4875 | + /** | |
| 4876 | + * Record one interaction with a Form Checks notice, cumulatively. | |
| 4877 | + * | |
| 4878 | + * Both the value and `$force` matter. Analytics_Events::track() returns early | |
| 4879 | + * when the event name is already in `usage_events_pushed`, so a call with | |
| 4880 | + * `$force` omitted records each name at most once per site, ever -- the report | |
| 4881 | + * could then say whether a button had ever been clicked but not how often, and | |
| 4882 | + * these events exist to answer the second question. Sending a running total | |
| 4883 | + * with `$force = true` re-sends each new value while an identical repeat still | |
| 4884 | + * short-circuits inside track(). Same reasoning as | |
| 4885 | + * track_action_item_impressions(). | |
| 4886 | + * | |
| 4887 | + * @param string $event_name Analytics key from the allowlist. | |
| 4888 | + * @since 2.12.7 | |
| 4889 | + * @return void | |
| 4890 | + */ | |
| 4891 | + private function track_notice_event( $event_name ) { | |
| 4892 | + $counts = Helper::get_array_value( Helper::get_srfm_option( 'action_item_events', [] ) ); | |
| 4893 | + | |
| 4894 | + $counts[ $event_name ] = Helper::get_integer_value( $counts[ $event_name ] ?? 0 ) + 1; | |
| 4895 | + | |
| 4896 | + Helper::update_srfm_option( 'action_item_events', $counts ); | |
| 4897 | + | |
| 4898 | + Analytics::events()->track( $event_name, (string) $counts[ $event_name ], [], true ); | |
| 4899 | + } | |
| 4900 | + | |
| 4901 | + /** | |
| 4902 | + * The contact form's address, tagged with where the click came from. | |
| 4903 | + * | |
| 4904 | + * One campaign, tagged per failure, so the report answers which check actually | |
| 4905 | + * sends people to support rather than only how many arrive. A submission | |
| 4906 | + * failure and a caching advisory are different problems and it is worth knowing | |
| 4907 | + * which one drives the tickets. | |
| 4908 | + * | |
| 4909 | + * Prefilled with what SureForms already knows -- the admin's address, which | |
| 4910 | + * failure it is, and the site host -- so the person reporting a fault does not | |
| 4911 | + * retype it. Worth knowing that the address travels in the query string, so it | |
| 4912 | + * reaches browser history and any referrer along the way; it is the site | |
| 4913 | + * owner's own address going to SureForms' own form, which is the flow this | |
| 4914 | + * button exists for. | |
| 4915 | + * | |
| 4916 | + * Built with add_query_arg rather than string concatenation, so it stays | |
| 4917 | + * correct if the constant ever gains a query string of its own. | |
| 4918 | + * | |
| 4919 | + * @param string $category One of Client_Logger::CATEGORIES, naming the failure | |
| 4920 | + * the visitor is reporting. | |
| 4921 | + * @since 2.12.7 | |
| 4922 | + * @return string | |
| 4923 | + */ | |
| 4924 | + private function get_support_contact_url( $category ) { | |
| 4925 | + // Deliberately not translated. These are matched against the options on the | |
| 4926 | + // troubleshooting form, so they are machine values, not copy -- a German | |
| 4927 | + // site sending "E-Mail-Benachrichtigungsfehler" would arrive as an | |
| 4928 | + // unrecognised subject and land in the wrong queue. | |
| 4929 | + $subjects = [ | |
| 4930 | + 'submission' => 'Form submission failure', | |
| 4931 | + 'notification' => 'Email notification failure', | |
| 4932 | + 'integration' => 'Integration failure', | |
| 4933 | + ]; | |
| 4934 | + | |
| 4935 | + $user = wp_get_current_user(); | |
| 4936 | + | |
| 4937 | + $url = add_query_arg( | |
| 4938 | + [ | |
| 4939 | + // Prefills the form, so the person reporting a fault does not retype | |
| 4940 | + // what SureForms already knows. Empty rather than absent when the | |
| 4941 | + // address is unusable, so the form still opens. | |
| 4942 | + 'mail' => is_email( $user->user_email ) ? $user->user_email : '', | |
| 4943 | + // Falls back to "Other" for a category SureForms does not define -- | |
| 4944 | + // srfm_action_items is public, so an item can carry any category or | |
| 4945 | + // none. | |
| 4946 | + 'subject' => $subjects[ $category ] ?? 'Other', | |
| 4947 | + 'site_url' => Helper::get_string_value( wp_parse_url( home_url(), PHP_URL_HOST ) ), | |
| 4948 | + 'utm_source' => 'sureforms', | |
| 4949 | + 'utm_medium' => 'form_checks', | |
| 4950 | + 'utm_campaign' => 'contact_support', | |
| 4951 | + // Which check sent them. The one part that differs per button, and | |
| 4952 | + // the reason for tagging at all. | |
| 4953 | + 'utm_content' => $category, | |
| 4954 | + ], | |
| 4955 | + self::SUPPORT_CONTACT_URL | |
| 4956 | + ); | |
| 4957 | + | |
| 4958 | + /** | |
| 4959 | + * Filter where the Contact Support action sends people. | |
| 4960 | + * | |
| 4961 | + * Replaces the `srfm_support_email_address` filter, which pointed at an | |
| 4962 | + * inbox and has no destination left to change now that the action opens a | |
| 4963 | + * form. A white-label install wants to point this at its own support page. | |
| 4964 | + * | |
| 4965 | + * @since 2.12.7 | |
| 4966 | + * | |
| 4967 | + * @param string $url Contact form URL, already UTM-tagged. | |
| 4968 | + * @param string $category The failure being reported. | |
| 4969 | + */ | |
| 4970 | + $filtered = Helper::get_string_value( apply_filters( 'srfm_support_contact_url', $url, $category ) ); | |
| 4971 | + | |
| 4972 | + // Escaped after the filter, not before: the point of escaping here is that | |
| 4973 | + // neither renderer has to trust what comes back. mailto: is allowed because | |
| 4974 | + // an inbox is a legitimate destination for a white-label support contact, | |
| 4975 | + // and get_action_items() already allows it on the sibling item URLs. | |
| 4976 | + $safe = esc_url_raw( $filtered, [ 'http', 'https', 'mailto' ] ); | |
| 4977 | + | |
| 4978 | + // Never empty. Contact Support is the only action that retires these | |
| 4979 | + // notices and they are dismissible => false, so returning '' for a filter | |
| 4980 | + // value that cannot survive escaping leaves an undismissable notice with | |
| 4981 | + // nothing on it that works. Falling back to SureForms' own form is worse | |
| 4982 | + // for a white-label than their own URL and better than a dead end, and the | |
| 4983 | + // unfiltered URL is built here rather than supplied, so it always escapes. | |
| 4984 | + return '' !== $safe ? $safe : esc_url_raw( $url, [ 'http', 'https' ] ); | |
| 4985 | + } | |
| 4986 | + | |
| 4987 | + /** | |
| 4988 | + * The log tail, formatted for pasting. | |
| 4989 | + * | |
| 4990 | + * One builder, so the text someone reads before sending is the text that gets | |
| 4991 | + * sent. They used to be built separately, which is how a "details" view drifts | |
| 4992 | + * from what it claims to show. | |
| 4993 | + * | |
| 4994 | + * The budget is a parameter because nothing here is going into a URL any more. | |
| 4995 | + * Client_Logger::get_tail()'s 1200-character default existed to fit a compose | |
| 4996 | + * URL; a clipboard and a <pre> have no such limit, so the dialog asks for more | |
| 4997 | + * and the note below describes the real constraint rather than a mail client | |
| 4998 | + * that is not in this flow. | |
| 4999 | + * | |
| 5000 | + * @param int $max_chars Characters of log to include. | |
| 5001 | + * @since 2.12.7 | |
| 5002 | + * @return string | |
| 5003 | + */ | |
| 5004 | + private function get_support_log_block( $max_chars = 1200 ) { | |
| 5005 | + $log = Client_Logger::get_tail( $max_chars ); | |
| 5006 | + $block = '---' . "\n"; | |
| 5007 | + | |
| 5008 | + if ( '' === $log['text'] ) { | |
| 5009 | + return $block . __( 'Debug log: no entries recorded.', 'sureforms' ); | |
| 5010 | + } | |
| 5011 | + | |
| 5012 | + $block .= sprintf( | |
| 5013 | + /* translators: 1: entries shown, 2: entries recorded. */ | |
| 5014 | + __( 'Debug log (most recent %1$d of %2$d entries)', 'sureforms' ), | |
| 5015 | + $log['shown'], | |
| 5016 | + $log['total'] | |
| 5017 | + ) . "\n"; | |
| 5018 | + | |
| 5019 | + // Fenced so it survives a reply and reads as data rather than prose wherever | |
| 5020 | + // Markdown is rendered. | |
| 5021 | + $block .= '```' . "\n" . $log['text'] . "\n" . '```'; | |
| 5022 | + | |
| 5023 | + if ( $log['shown'] < $log['total'] ) { | |
| 5024 | + $block .= "\n\n" . __( 'Older entries were left out to keep this excerpt readable. The full log can be downloaded from SureForms → Settings → General.', 'sureforms' ); | |
| 5025 | + } | |
| 5026 | + | |
| 5027 | + return $block; | |
| 5028 | + } | |
| 5029 | + | |
| 5030 | + /** | |
| 5031 | + * Subject and countless opening line for one kind of failure. | |
| 5032 | + * | |
| 5033 | + * Both come from here so they cannot drift apart: a subject naming one problem | |
| 5034 | + * over a body describing another is worse than either alone. The counted form | |
| 5035 | + * of the opening line lives in get_support_count_sentence(), which needs | |
| 5036 | + * `_n()`'s literals and so cannot be an array lookup. | |
| 5037 | + * | |
| 5038 | + * An unknown or absent category gets deliberately neutral wording. The | |
| 5039 | + * alternative -- defaulting to the submission copy -- states something specific | |
| 5040 | + * that may not be true, and an item contributed through srfm_action_items has no | |
| 5041 | + * category at all. | |
| 5042 | + * | |
| 5043 | + * @param string $category One of Client_Logger::CATEGORIES. | |
| 5044 | + * @since 2.12.7 | |
| 5045 | + * @return array{subject:string,anon:string} | |
| 5046 | + */ | |
| 5047 | + private function get_support_copy( $category ) { | |
| 5048 | + $copy = [ | |
| 5049 | + 'submission' => [ | |
| 5050 | + /* translators: %s: site host. */ | |
| 5051 | + 'subject' => __( 'SureForms: form submissions are failing on %s', 'sureforms' ), | |
| 5052 | + /* translators: %s: site host. */ | |
| 5053 | + 'anon' => __( 'SureForms has recorded form submissions on %s that could not be completed.', 'sureforms' ), | |
| 5054 | + ], | |
| 5055 | + 'notification' => [ | |
| 5056 | + /* translators: %s: site host. */ | |
| 5057 | + 'subject' => __( 'SureForms: notification emails are not being sent on %s', 'sureforms' ), | |
| 5058 | + /* translators: %s: site host. */ | |
| 5059 | + 'anon' => __( 'SureForms saved entries on %s but could not send the notification emails for them.', 'sureforms' ), | |
| 5060 | + ], | |
| 5061 | + 'integration' => [ | |
| 5062 | + /* translators: %s: site host. */ | |
| 5063 | + 'subject' => __( 'SureForms: an integration is not receiving entries on %s', 'sureforms' ), | |
| 5064 | + /* translators: %s: site host. */ | |
| 5065 | + 'anon' => __( 'SureForms saved entries on %s but could not pass them to a connected service.', 'sureforms' ), | |
| 5066 | + ], | |
| 5067 | + ]; | |
| 5068 | + | |
| 5069 | + if ( isset( $copy[ $category ] ) ) { | |
| 5070 | + return $copy[ $category ]; | |
| 5071 | + } | |
| 5072 | + | |
| 5073 | + return [ | |
| 5074 | + /* translators: %s: site host. */ | |
| 5075 | + 'subject' => __( 'SureForms: a problem with the forms on %s', 'sureforms' ), | |
| 5076 | + /* translators: %s: site host. */ | |
| 5077 | + 'anon' => __( 'SureForms has recorded a problem with the forms on %s.', 'sureforms' ), | |
| 5078 | + ]; | |
| 5079 | + } | |
| 5080 | + | |
| 5081 | + /** | |
| 5082 | + * The sentence that opens the support email, with the failure count in it. | |
| 5083 | + * | |
| 5084 | + * A switch with literal `_n()` calls rather than a singular/plural pair looked | |
| 5085 | + * up from an array. `_n()` has to see its two literals at extraction time to | |
| 5086 | + * emit an `msgid_plural`, and only that lets a locale supply the number of | |
| 5087 | + * forms it actually uses -- Polish and Russian need three, Arabic six, | |
| 5088 | + * Japanese one. Choosing on `1 === $count` in PHP is correct for English and | |
| 5089 | + * wrong everywhere with a different plural rule. | |
| 5090 | + * | |
| 5091 | + * @param string $category One of Client_Logger::CATEGORIES. Unknown or absent | |
| 5092 | + * gets neutral wording rather than a specific claim. | |
| 5093 | + * @param int $count Failures recorded for that category. | |
| 5094 | + * @since 2.12.7 | |
| 5095 | + * @return string | |
| 5096 | + */ | |
| 5097 | + private function get_support_count_sentence( $category, $count ) { | |
| 5098 | + switch ( $category ) { | |
| 5099 | + case 'submission': | |
| 5100 | + return sprintf( | |
| 5101 | + /* translators: %d: number of failed submissions. */ | |
| 5102 | + _n( | |
| 5103 | + 'SureForms has recorded %d form submission that could not be completed.', | |
| 5104 | + 'SureForms has recorded %d form submissions that could not be completed.', | |
| 5105 | + $count, | |
| 5106 | + 'sureforms' | |
| 5107 | + ), | |
| 5108 | + $count | |
| 5109 | + ); | |
| 5110 | + | |
| 5111 | + case 'notification': | |
| 5112 | + return sprintf( | |
| 5113 | + /* translators: %d: number of failed notifications. */ | |
| 5114 | + _n( | |
| 5115 | + 'SureForms saved %d entry but could not send the notification email for it.', | |
| 5116 | + 'SureForms saved %d entries but could not send the notification emails for them.', | |
| 5117 | + $count, | |
| 5118 | + 'sureforms' | |
| 5119 | + ), | |
| 5120 | + $count | |
| 5121 | + ); | |
| 5122 | + | |
| 5123 | + case 'integration': | |
| 5124 | + return sprintf( | |
| 5125 | + /* translators: %d: number of failed integration hand-offs. */ | |
| 5126 | + _n( | |
| 5127 | + 'SureForms saved %d entry but could not pass it to a connected service.', | |
| 5128 | + 'SureForms saved %d entries but could not pass them to a connected service.', | |
| 5129 | + $count, | |
| 5130 | + 'sureforms' | |
| 5131 | + ), | |
| 5132 | + $count | |
| 5133 | + ); | |
| 5134 | + | |
| 5135 | + default: | |
| 5136 | + return sprintf( | |
| 5137 | + /* translators: %d: number of recorded problems. */ | |
| 5138 | + _n( | |
| 5139 | + 'SureForms has recorded %d problem with the forms on this site.', | |
| 5140 | + 'SureForms has recorded %d problems with the forms on this site.', | |
| 5141 | + $count, | |
| 5142 | + 'sureforms' | |
| 5143 | + ), | |
| 5144 | + $count | |
| 5145 | + ); | |
| 5146 | + } | |
| 5147 | + } | |
| 5148 | + | |
| 5149 | + /** | |
| 5150 | + * Diagnostics block for the support report. | |
| 5151 | + * | |
| 5152 | + * Carries what support would otherwise have to ask for, so the first reply can | |
| 5153 | + * be an answer rather than a questionnaire. | |
| 5154 | + * | |
| 5155 | + * The count is the one for this category, not get_fault_streak(), which reports | |
| 5156 | + * submissions only -- so a notification failure used to quote a number from an | |
| 5157 | + * unrelated counter, often zero. | |
| 5158 | + * | |
| 5159 | + * @param string $category One of Client_Logger::CATEGORIES. | |
| 5160 | + * @param string $form_title Form the failure was recorded against, when known. | |
| 5161 | + * @since 2.12.6 | |
| 5162 | + * @return string | |
| 5163 | + */ | |
| 5164 | + private function get_support_message( $category = '', $form_title = '' ) { | |
| 5165 | + global $wp_version; | |
| 5166 | + | |
| 5167 | + $failures = Client_Logger::get_failures(); | |
| 5168 | + $count = Helper::get_integer_value( $failures[ $category ]['count'] ?? 0 ); | |
| 5169 | + $copy = $this->get_support_copy( $category ); | |
| 5170 | + | |
| 5171 | + // With nothing recorded, describe the failure without a number. The old | |
| 5172 | + // max( 1, $count ) reported "recorded 1 problem" and "Recorded failures: 1" | |
| 5173 | + // for a count nobody recorded -- a number support would then chase. | |
| 5174 | + $host = Helper::get_string_value( wp_parse_url( home_url(), PHP_URL_HOST ) ); | |
| 5175 | + | |
| 5176 | + $lines = [ | |
| 5177 | + __( 'Hello SureForms support,', 'sureforms' ), | |
| 5178 | + '', | |
| 5179 | + $count > 0 | |
| 5180 | + ? $this->get_support_count_sentence( $category, $count ) | |
| 5181 | + : sprintf( $copy['anon'], $host ), | |
| 5182 | + ]; | |
| 5183 | + | |
| 5184 | + if ( '' !== $form_title ) { | |
| 5185 | + $lines[] = ''; | |
| 5186 | + $lines[] = sprintf( | |
| 5187 | + /* translators: %s: form title. */ | |
| 5188 | + __( 'Form: %s', 'sureforms' ), | |
| 5189 | + $form_title | |
| 5190 | + ); | |
| 5191 | + } | |
| 5192 | + | |
| 5193 | + // Once: each call reads an option and a site option. | |
| 5194 | + $caching = Helper::get_active_caching_plugin(); | |
| 5195 | + | |
| 5196 | + $lines = array_merge( | |
| 5197 | + $lines, | |
| 5198 | + [ | |
| 5199 | + '', | |
| 5200 | + '---', | |
| 5201 | + __( 'Site details', 'sureforms' ), | |
| 5202 | + // Labels translated, values not. The site owner reads this on screen | |
| 5203 | + // before sending it, so the labels are copy; the values are machine | |
| 5204 | + // data -- a version, a URL, a plugin name -- and stay verbatim. The | |
| 5205 | + // debug log below is left alone entirely for the same reason. | |
| 5206 | + /* translators: %s: site address. */ | |
| 5207 | + sprintf( __( 'Site: %s', 'sureforms' ), home_url() ), | |
| 5208 | + /* translators: %s: SureForms version. */ | |
| 5209 | + sprintf( __( 'SureForms: %s', 'sureforms' ), SRFM_VER ), | |
| 5210 | + sprintf( | |
| 5211 | + /* translators: %s: SureForms Pro version, or a note that it is not active. */ | |
| 5212 | + __( 'SureForms Pro: %s', 'sureforms' ), | |
| 5213 | + Helper::has_pro() && defined( 'SRFM_PRO_VER' ) ? SRFM_PRO_VER : __( 'not active', 'sureforms' ) | |
| 5214 | + ), | |
| 5215 | + /* translators: %s: WordPress version. */ | |
| 5216 | + sprintf( __( 'WordPress: %s', 'sureforms' ), Helper::get_string_value( $wp_version ) ), | |
| 5217 | + /* translators: %s: PHP version. */ | |
| 5218 | + sprintf( __( 'PHP: %s', 'sureforms' ), PHP_VERSION ), | |
| 5219 | + sprintf( | |
| 5220 | + /* translators: %s: caching plugin name, or a note that none was detected. */ | |
| 5221 | + __( 'Caching: %s', 'sureforms' ), | |
| 5222 | + '' !== $caching ? $caching : __( 'none detected', 'sureforms' ) | |
| 5223 | + ), | |
| 5224 | + sprintf( | |
| 5225 | + /* translators: %s: number of recorded failures, or a note that none were. */ | |
| 5226 | + __( 'Recorded failures: %s', 'sureforms' ), | |
| 5227 | + $count > 0 ? Helper::get_string_value( $count ) : __( 'none recorded', 'sureforms' ) | |
| 5228 | + ), | |
| 5229 | + ] | |
| 5230 | + ); | |
| 5231 | + | |
| 5232 | + // Only when there is one. A repeat report is worth knowing about: the same | |
| 5233 | + // category having been reported before means the last answer did not hold, | |
| 5234 | + // which is a different conversation from a first report. Appended with the | |
| 5235 | + // rest of the site details rather than raised to the top, because it is | |
| 5236 | + // context for them rather than a headline. | |
| 5237 | + // | |
| 5238 | + // Survives only until the next success in that category, because | |
| 5239 | + // clear_category() unsets the whole record -- so in practice it is | |
| 5240 | + // reachable for 'integration', which has no success signal, and transient | |
| 5241 | + // for the other two. | |
| 5242 | + // | |
| 5243 | + // Stored as time(), a UTC epoch comparable with the sibling 'at', and | |
| 5244 | + // formatted here with wp_date() so it reads in the site's timezone rather | |
| 5245 | + // than the server's. | |
| 5246 | + $acked_at = Helper::get_integer_value( $failures[ $category ]['acked_at'] ?? 0 ); | |
| 5247 | + | |
| 5248 | + if ( $acked_at > 0 ) { | |
| 5249 | + $lines[] = sprintf( | |
| 5250 | + /* translators: %s: date and time of the previous report, in the site's timezone. */ | |
| 5251 | + __( 'Previously reported: %s', 'sureforms' ), | |
| 5252 | + Helper::get_string_value( wp_date( 'Y-m-d H:i T', $acked_at ) ) | |
| 5253 | + ); | |
| 5254 | + } | |
| 5255 | + | |
| 5256 | + return implode( "\n", $lines ); | |
| 5257 | + } | |
| 5258 | + | |
| 5259 | + /** | |
| 5260 | + * Record one dismissal, shared by the AJAX and no-JS entry points. | |
| 5261 | + * | |
| 5262 | + * Allowlisted, so only advisory items can be dismissed. A run of failed | |
| 5263 | + * submissions is a fault and must stay put until it actually resolves -- | |
| 5264 | + * otherwise a crafted request could silence the one message that matters. | |
| 5265 | + * | |
| 5266 | + * @param string $item_id Item to dismiss. | |
| 5267 | + * @since 2.12.6 | |
| 5268 | + * @return bool False when the id is not dismissible. | |
| 5269 | + */ | |
| 5270 | + private function dismiss_action_item( $item_id ) { | |
| 5271 | + if ( ! in_array( $item_id, [ 'caching_plugin' ], true ) ) { | |
| 5272 | + return false; | |
| 5273 | + } | |
| 5274 | + | |
| 5275 | + $dismissed = Helper::get_array_value( Helper::get_srfm_option( 'dismissed_action_items', [] ) ); | |
| 5276 | + | |
| 5277 | + if ( ! in_array( $item_id, $dismissed, true ) ) { | |
| 5278 | + $dismissed[] = $item_id; | |
| 5279 | + Helper::update_srfm_option( 'dismissed_action_items', $dismissed ); | |
| 5280 | + | |
| 5281 | + // Recorded here rather than at each caller: both the cross in the | |
| 5282 | + // dashboard panel and the no-JS link in the classic notice land here. | |
| 5283 | + $this->track_notice_event( $item_id . '_notice_dismiss' ); | |
| 5284 | + } | |
| 5285 | + | |
| 5286 | + return true; | |
| 5287 | + } | |
| 3376 | 5288 | } |
