GravityFormsExtensions.php

<?php

namespace P4\MasterTheme;

use GFAPI;
use GFCommon;
use DOMDocument;
use Timber\Timber;

/**
 * Class P4\MasterTheme\GravityFormsExtensions
 * The Gravity form plugin extension, use to add custom functionality like Planet4 form type.
 */
class GravityFormsExtensions
{
    public const DEFAULT_GF_TYPE = 'Other';

    public const P4_GF_TYPES = [
        [
            'label' => 'Other',
            'value' => 'Other',
        ],
        [
            'label' => 'Petition',
            'value' => 'Petition Signup',
        ],
        [
            'label' => 'Email Signup',
            'value' => 'Newsletter Signup',
        ],
        [
            'label' => 'Quiz/Poll',
            'value' => 'Quiz or Poll',
        ],
        [
            'label' => 'Email-to-target',
            'value' => 'Email to Target',
        ],
        [
            'label' => 'Contact',
            'value' => 'Contact',
        ],
        [
            'label' => 'Survey',
            'value' => 'Survey',
        ],
        [
            'label' => 'Feedback',
            'value' => 'Feedback',
        ],
        [
            'label' => 'Donation',
            'value' => 'Donation',
        ],
    ];

    public const P4_SHARE_BUTTONS = [
        [
            'label' => 'WhatsApp',
            'name' => 'whatsapp',
            'default_value' => 1,
        ],
        [
            'label' => 'Facebook',
            'name' => 'facebook',
            'default_value' => 1,
        ],
        [
            'label' => 'Twitter',
            'name' => 'twitter',
            'default_value' => 1,
        ],
        [
            'label' => 'Email',
            'name' => 'email',
            'default_value' => 1,
        ],
        [
            'label' => 'Native share (mobile only)',
            'name' => 'native',
            'default_value' => 1,
        ],
    ];

    public array $current_entry = [];

    /**
     * The constructor.
     */
    public function __construct()
    {
        $this->hooks();
    }

    /**
     * Class hooks.
     */
    private function hooks(): void
    {
        add_filter('gform_form_settings_fields', [ $this, 'p4_gf_form_settings' ], 5, 2);
        add_filter('gform_secure_file_download_url', [ $this, 'p4_gf_file_download_url' ], 10, 1);
        add_action('gform_after_save_form', [ $this, 'p4_gf_custom_initial_settings' ], 10, 2);
        add_filter('gform_confirmation_settings_fields', [ $this, 'p4_gf_confirmation_settings' ], 10, 3);
        add_filter('gform_confirmation', [ $this, 'p4_gf_custom_confirmation' ], 10, 3);
        add_filter('gform_field_css_class', [ $this, 'p4_gf_custom_field_class' ], 10, 3);
        add_filter('gform_form_args', [ $this, 'p4_gf_enforce_ajax' ], 10, 3);
        add_action('gform_after_save_form', [ $this, 'p4_gf_clear_page_caches' ], 10, 2);
        // Suppress the redirect in forms to use custom redirect handling.
        add_filter('gform_suppress_confirmation_redirect', '__return_true');
        add_filter('gform_confirmation', [ $this, 'p4_gf_custom_confirmation_redirect' ], 11, 3);
        add_filter('gform_pre_render', [ $this, 'p4_client_side_gravityforms_prefill' ], 10, 1);
        add_filter('gform_form_post_get_meta', [$this, 'p4_gf_enable_default_meta_settings'], 10, 1);
        add_filter('gform_hubspot_form_object_pre_save_feed', [$this, 'p4_gf_hb_form_object_pre_save_feed'], 10, 1);

        add_action('gform_stripe_fulfillment', [ $this, 'record_fulfillment_entry' ], 10, 2);
    }

    /**
     * Save resulting entry after Stripe successful submission.
     *
     * @param mixed $session
     * @param array $entry
     * phpcs:disable SlevomatCodingStandard.Functions.UnusedParameter -- add_action callback
     */
    public function record_fulfillment_entry($session, array $entry): void
    {
        $this->current_entry = $entry;
    }
    // phpcs:enable SlevomatCodingStandard.Functions.UnusedParameter

    /**
     * Add form setting to Gravity Forms to set the form type.
     *
     * @param array $fields The form settings fields.
     *
     * @return array The new fields array.
     */
    public function p4_gf_form_settings(array $fields): array
    {

        if (! array_key_exists('p4_options', $fields)) {
            $new_fields['p4_options'] = [
                'title' => __('Planet 4 Options', 'planet4-master-theme-backend'),
            ];

            // Add new field to beginning of the $fields array.
            $fields = array_merge($new_fields, $fields);
        }

        $fields['p4_options']['fields'][] = [
            'type' => 'select',
            'name' => 'p4_gf_type',
            'label' => __('Form Type', 'planet4-master-theme-backend'),
            'tooltip' => __(
                'Please select a form type below so you can track and analyze each form type separately',
                'planet4-master-theme-backend'
            ),
            'required' => true,
            'default_value ' => self::DEFAULT_GF_TYPE,
            'choices' => self::P4_GF_TYPES,
        ];

        return $fields;
    }

    /**
     * Update Gravity form file path before output.
     *
     * @param string $file_path The file path of the download file.
     *
     * @return string The new file path.
     */
    public function p4_gf_file_download_url(string $file_path): string
    {
        if (strpos($file_path, '/gravity_forms/') !== false) {
            // The default gravity form uploaded files path gives error.
            // eg. https://www.greenpeace.org/static/planet4-test-titan-stateless-develop/gravity_forms/8-23c5dc88bb5af48eb293c4c780a5ed0a/2022/09/e26f3fe9-2022_08_gravity_forms_3-1b36ac6eddacf20087d29746b297b384_2022_08_99ef18e1-predator.jpg
            // By updating a part[/year/month/] of file path('/gravity_forms/' => '/2022/09/gravity_forms/')
            // fix the issue.

            // Extract year and month from file path.
            $year_month = array_slice(explode('/', $file_path), -3, 2);

            // Update the gravity form file download path with year and month.
            return str_replace('/gravity_forms/', '/' . implode('/', $year_month) . '/gravity_forms/', $file_path);
        }

        return $file_path;
    }

    /**
     * Update initial settings for Gravity Forms (sub-label and description placement).
     *
     * @param array $form The form settings.
     * @param bool  $is_new Whether the form is newly created or not.
     */
    public function p4_gf_custom_initial_settings(array $form, bool $is_new): void
    {
        if (!$is_new) {
            return;
        }

        // Update sub-label and description placement initial settings.
        $form['subLabelPlacement'] = 'above';
        $form['descriptionPlacement'] = 'above';

        // Make form active immediately.
        $form['is_active'] = '1';

        GFAPI::update_form($form);

        // Default analytics feed meta.
        $feed_meta = [
            "feedName" => "Google Analytics",
            "gaeventgoalid_thickbox" => "",
            "gaeventgoal_thickbox" => "Submission: " . $form['title'],
            "gaeventcategory_thickbox" => "",
            "gaeventaction_thickbox" => "",
            "gaeventlabel_thickbox" => "{form_title} ID: {form_id}",
            "gaeventgoalid" => "",
            "gaeventgoal" => "Submission: " . $form['title'],
            "gaeventcategory" => "",
            "gaeventaction" => "",
            "gaeventlabel" => "{form_title} ID: {form_id}",
            "gaeventvalue" => "",
            "feed_condition_conditional_logic_object" => [],
            "feed_condition_conditional_logic" => "0",
            "select_goal" => "",
            "feed_event_category" => "",
            "feed_event_action" => "",
            "feed_event_label" => "",
            "conditionalLogic" => "",
        ];

        GFAPI::add_feed($form_id = $form['id'], $feed_meta, $addon_slug = 'gravityformsgoogleanalytics');
    }

    /**
     * Add confirmation settings to Gravity Forms: the ability to add share buttons.
     *
     * @param array $fields The general confirmation settings fields.
     *
     * @return array The new fields array.
     */
    public function p4_gf_confirmation_settings(array $fields): array
    {
        echo '
			<style>
				.hidden {
					display: none !important;
				}
			</style>
		';

        // This bit of code is to hide the "Share Buttons" section
        // if editors select "Page" or "Redirect" as confirmation message.
        // phpcs:disable Generic.Files.LineLength.MaxExceeded
        echo '
			<script>
				addEventListener("DOMContentLoaded", () => {
					const confirmationTypeCheckboxes = [...document.querySelectorAll("input[name=\"_gform_setting_type\"]")];
					const textTypeCheckbox = confirmationTypeCheckboxes.find(input => input.value === "message");
					const shareButtonsSettings = document.querySelector("#gform-settings-section-share-buttons");

					const onChange = checkbox => {
						if (checkbox.value === "message" && checkbox.checked) {
							shareButtonsSettings.classList.remove("hidden");
						} else {
							shareButtonsSettings.classList.add("hidden");
						}
					}

					confirmationTypeCheckboxes.forEach(input => input.addEventListener("change", event => onChange(event.currentTarget)));

					onChange(textTypeCheckbox);
				});
			</script>
		';
        // phpcs:enable Generic.Files.LineLength.MaxExceeded

        if (! array_key_exists('p4_share_buttons', $fields)) {
            $share_buttons['p4_share_buttons'] = [
                'title' => __('Share buttons', 'planet4-master-theme-backend'),
            ];

            // Add new field to end of the $fields array.
            $fields = array_merge($fields, $share_buttons);
        }

        $fields['p4_share_buttons']['fields'][] = [
            'type' => 'checkbox',
            'name' => 'p4_gf_share_platforms',
            'label' => __('Show share buttons below message', 'planet4-master-theme-backend'),
            'choices' => self::P4_SHARE_BUTTONS,
        ];

        $fields['p4_share_buttons']['fields'][] = [
            'type' => 'text',
            'name' => 'p4_gf_share_text_override',
            'label' => __('Share text', 'planet4-master-theme-backend'),
            'tooltip' => __('This is the text that will be shared when a user clicks a share button (if the platform supports share text)', 'planet4-master-theme-backend'), // phpcs:ignore Generic.Files.LineLength.MaxExceeded
        ];

        $fields['p4_share_buttons']['fields'][] = [
            'type' => 'text',
            'name' => 'p4_gf_share_url_override',
            'label' => __('Override share URL', 'planet4-master-theme-backend'),
            'tooltip' => __('By default, share buttons will share the URL of the page that the form was submitted on. Use this field to override with a different URL.', 'planet4-master-theme-backend'), // phpcs:ignore Generic.Files.LineLength.MaxExceeded
        ];

        return $fields;
    }

    /**
     *
     * Return custom confirmation message for Gravity Forms.
     *
     * @param string|array $confirmation The default confirmation message.
     * @param mixed        $form         The form properties.
     * @param mixed        $entry        The current entry.
     *
     * @return string|array The custom confirmation message.
     */
    public function p4_gf_custom_confirmation($confirmation, $form, $entry)
    {
        // If the $confirmation object is an array, it means that it's a redirect page so we can directly use it.
        if (is_array($confirmation)) {
            return $confirmation;
        }

        $context = Timber::get_context();
        $post = Timber::query_post(false, Post::class);

        $current_confirmation = $form['confirmation'];

        $userEmail = '';
        // Search user email field from $entry object.
        foreach ($entry as $key => $value) {
            if (is_numeric($key) && filter_var($value, FILTER_VALIDATE_EMAIL)) {
                $userEmail = $value;
                break;
            }
        }

        $script = '<script type="text/javascript">
                        window.dataLayer = window.dataLayer || [];
                        window.dataLayer.push({
                            "event": "formSubmission",
                            "formID": "' . $form['id'] . '",
                            "formPlugin": "Gravity Form",
                            "gGoal":  "' . ($form['p4_gf_type'] ?? self::DEFAULT_GF_TYPE) . '",
                            "formTitle": "' . $form['title'] . '",
                            "userEmail": "' . $userEmail . '"
                        });
                        // Disable GFTrackEvent (GFTrackEvent belongs to Gravity Forms Google Analytics Add-On)
                        window.parent.gfgaTagManagerEventSent = true;
                        // Entry: ' . json_encode($entry) . '
                   </script>';
        // Append a datalayer event script to $confirmation html.
        $confirmation .= $script;

        if (rgget('gf_stripe_success')) {
            $confirmation .= $this->p4_gf_stripe_custom_success_event($entry);
        }

        $confirmation_fields = [
            'confirmation' => $confirmation,
            'share_platforms' => [
                'facebook' => $current_confirmation['facebook'] ?? true,
                'twitter' => $current_confirmation['twitter'] ?? true,
                'whatsapp' => $current_confirmation['whatsapp'] ?? true,
                'native' => $current_confirmation['native'] ?? true,
                'email' => $current_confirmation['email'] ?? true,
            ],
            'post' => $post,
            'social_accounts' => $post->get_social_accounts($context['footer_social_menu'] ?: []),
            'utm_medium' => 'gf-share',
        ];

        if (
            isset($current_confirmation['p4_gf_share_text_override'])
            && $current_confirmation['p4_gf_share_text_override']
        ) {
            $confirmation_fields['share_text'] = $current_confirmation['p4_gf_share_text_override'];
        }

        if (
            isset($current_confirmation['p4_gf_share_url_override'])
            && $current_confirmation['p4_gf_share_url_override']
        ) {
            $confirmation_fields['share_url'] = $current_confirmation['p4_gf_share_url_override'];
        }

        return Timber::compile([ 'gravity_forms_confirmation.twig' ], $confirmation_fields);
    }

    /**
     * Add event for GA4 on successful stripe event
     *
     * @param mixed $entry The successful entry.
     *
     * @return string Event script
     */
    public function p4_gf_stripe_custom_success_event($entry): string
    {
        $allowed = ['Paid', 'Active', 'Approved', 'Processing', 'Pending'];

        // GF sometimes returns a Processing entry with data missing
        // while the entry has been successfully retrieved in a previous step.
        // We manually update the entry in that case.
        if (
            (empty($entry['payment_status']) || $entry['payment_status'] === 'Processing')
            && !empty($this->current_entry)
        ) {
            $entry = $this->current_entry;
        }

        if (
            !isset($entry['payment_status'])
            || !in_array($entry['payment_status'], $allowed)
        ) {
            return '';
        }

        $tType = [
            '1' => 'one_time_donation',
            '2' => 'recurring_donation',
        ];

        $event = [
            'event' => 'purchase',
            'ecommerce' => [
                'currency' => $entry['currency'],
                'value' => $entry['payment_amount'],
                'transaction_id' => $entry['transaction_id'],
                'items' => [
                    [
                        'item_id' => $entry['transaction_type'] ?? null,
                        'item_name' => $tType[$entry['transaction_type']] ?? null,
                    ],
                ],
            ],
        ];

        return "<script>// Ecommerce GA4
            window.dataLayer = window.dataLayer || []
            dataLayer.push(" . wp_json_encode($event) . ");
        </script>";
    }

    /**
     *
     * Add CSS classes to some Gravity Forms fields: checkboxes and radio buttons.
     *
     * @param string $classes The existing field classes.
     * @param object $field The field.
     *
     * @return string The updated field classes.
     */
    public function p4_gf_custom_field_class(string $classes, object $field): string
    {
        if ('checkbox' === $field->type || 'radio' === $field->type || 'consent' === $field->type) {
            $classes .= ' custom-control';
        }
        return $classes;
    }

    /**
    *
    * Enforces Ajax submission on all forms.
    *
    * @param array $form_args form arguments when adding it to a page/post.
    *
    * @return array The updated form arguments.
    */
    public function p4_gf_enforce_ajax(array $form_args): array
    {
        $form_args['ajax'] = true;

        return $form_args;
    }

    /**
     * Purges the caches of pages that contain a form.
     *
     * @param array $form The form to look for when purging page caches
     * @param bool $is_new Form is new
     *
     */
    public function p4_gf_clear_page_caches(array $form, bool $is_new = false): void
    {
        if ($is_new) {
            return;
        }

        /**
         * Filter hook to change post types that are cleared from cache if they contain a form that has changed
         *
         * @param array $post_types Array of post types to consider for cache clearing after form update
         */
        $post_types = apply_filters('planet4_form_cache_purge_post_types', [ 'page', 'post', 'campaign', 'p4_action' ]);

        // Get IDs of posts that contain the forms
        $posts_to_clear = $this->get_posts_by_gf_id($form['id'], $post_types);

        // Get IDs of reusable blocks that contain the forms
        $reusable_blocks = $this->get_posts_by_gf_id($form['id'], [ 'wp_block' ]);

        foreach ($reusable_blocks as $block_id) {
            // Find posts that contain the reusable blocks
            $args = [
                's' => '<!-- wp:block {"ref":' . $block_id . '}',
                "numberposts" => - 1,
                'post_type' => $post_types,
                'post_status' => [ 'publish', 'private' ],
            ];

            $posts = get_posts($args);

            foreach ($posts as $post) {
                $posts_to_clear[] = $post->ID;
            }
        }

        $posts_to_clear = array_unique($posts_to_clear);

        foreach ($posts_to_clear as $post_id) {
            // Updating the post triggers clearing the cache without making any changes to the post itself.
            wp_update_post([
                'ID' => $post_id,
            ], false, true);
        }
    }

    /**
     * Client side dynamic population of form fields
     *
     * @param array $form The different form fields present
     *
     * @return mixed
     */
    public function p4_client_side_gravityforms_prefill(array $form): array
    {
        $supported_field_types = ['GF_Field_Hidden'];

        $gf_fronted_populate = [];

        foreach ($form['fields'] as $field) {
            if (!$field->allowsPrepopulate || !in_array(get_class($field), $supported_field_types)) {
                continue;
            }

            // The object doesn't contain the id attribute of the html field in the frontend.
            // Workaround: Render the field and grab the ID from the resulting HTML.
            $dom = new DOMDocument();
            $dom->loadHTML($field->get_field_input($form));

            $dom_field = $dom->getElementsByTagName('input');

            $field_id = $dom_field[0]->getAttribute('id');

            $gf_fronted_populate[] = [
                'parameter' => $field->inputName,
                'fieldId' => $field_id,
                'fieldType' => get_class($field),
            ];
        }

        $gf_fronted_config['populate'] = $gf_fronted_populate;

        $theme_dir = get_template_directory_uri();
        $gf_client_side_file = $theme_dir . '/assets/build/gravityforms-client-side.js';

        wp_enqueue_script(
            'p4-gf-client-side',
            $gf_client_side_file,
            array(),
            file_exists($gf_client_side_file) ? filemtime($gf_client_side_file) : false,
            true
        );

        wp_localize_script('p4-gf-client-side', 'p4GfClientSideConfig', $gf_fronted_config);

        return $form;
    }

    /**
     * Find all posts that contain a form.
     *
     * @param int $form_id The ID of the form to look for
     * @param array $post_types Post types that are searched
     *
     */
    private function get_posts_by_gf_id(int $form_id, array $post_types = [ 'post', 'page' ]): array
    {
        $args = [
            's' => '<!-- wp:gravityforms/form ',
            "numberposts" => - 1,
            'post_type' => $post_types,
            'post_status' => [ 'publish', 'private' ],
        ];

        $posts = get_posts($args);

        $post_ids = [];

        foreach ($posts as $post) {
            $blocks = parse_blocks(get_the_content(null, null, $post));

            $gf_blocks = $this->find_nested_blocks('gravityforms/form', $blocks);

            foreach ($gf_blocks as $gf_block) {
                if (intval($gf_block['attrs']['formId']) === $form_id) {
                    $post_ids[] = $post->ID;

                    break;
                }
            }
        }

        return $post_ids;
    }

    /**
     * Recursively search blocks array for block with $block_name and return as flat array.
     *
     * @param string $block_name Block name to find
     * @param array $blocks Blocks to search for nested blocks
     *
     */
    private function find_nested_blocks(string $block_name, array $blocks): array
    {
        $matching_blocks = [];

        foreach ($blocks as $block) {
            if (isset($block['blockName']) && $block['blockName'] === $block_name) {
                $matching_blocks[] = $block;
            }

            if (!is_array($block['innerBlocks'])) {
                continue;
            }

            $inner_blocks = $this->find_nested_blocks($block_name, $block['innerBlocks']);

            if (count($inner_blocks) <= 0) {
                continue;
            }

            $matching_blocks = array_merge($matching_blocks, $inner_blocks);
        }

        return $matching_blocks;
    }

    /**
     * Redirect using Javascript after form submission instead of sending a header.
     * Makes it possible to send tag manager events before redirecting.
     *
     * @param string|array $confirmation The default confirmation message.
     * @param mixed        $form         The form properties.
     * @param mixed        $entry        The current entry.
     *
     * @return string|array The custom confirmation message.
     */
    public function p4_gf_custom_confirmation_redirect($confirmation, $form, $entry)
    {
        GFCommon::log_debug(__METHOD__ . '(): running.');
        if (isset($confirmation['redirect'])) {
            $url = esc_url_raw($confirmation['redirect']);
            GFCommon::log_debug(__METHOD__ . '(): Redirect to URL: ' . $url);

            $html = sprintf(
                // translators: %s = Redirection url variable.
                __(
                    'Thank you! Please <a href="%s">click here</a> if you are not redirected within a few seconds.',
                    'planet4-master-theme'
                ),
                $url,
            );

            $userEmail = '';
            // Search user email field from $entry object.
            foreach ($entry as $key => $value) {
                if (is_numeric($key) && filter_var($value, FILTER_VALIDATE_EMAIL)) {
                    $userEmail = $value;
                    break;
                }
            }

            // Get the tag manager data layer ID from master theme settings
            $options = get_option('planet4_options');
            $gtm_id = $options['google_tag_manager_identifier'];

            $script = '<script type="text/javascript">

                if (window["google_tag_value"]) {
                    window.dataLayer = window.dataLayer || [];
                    dataLayer.push({
                        "event": "formSubmission",
                        "formID": "' . $form['id'] . '",
                        "formPlugin": "Gravity Form",
                        "gGoal":  "' . ($form['p4_gf_type'] ?? self::DEFAULT_GF_TYPE) . '",
                        "formTitle": "' . $form['title'] . '",
                        "userEmail": "' . $userEmail . '",
                        "eventCallback" : function(id) {
                            // There might be multiple gtm containers, make sure we only redirect for our main container
                            if ( id == "' . $gtm_id . '") {
                                window.top.location.href = "' . $url . '";
                            }
                        },
                        "eventTimeout" : 2000
                    });
                } else {
                    // Redirect latest after two seconds.
                    // This is a failsafe in case the request to tag manager is blocked.
                    setTimeout(function() {
                        window.top.location.href = "' . $url . '";
                    }, 2000);
                }
                </script>';

            $confirmation = '<p>' . $html . '</p>' . $script;
        }

        return $confirmation;
    }

    /**
     * Enable default meta parameters for Gravity forms.
     *
     * @param array $meta Associative array containing all form properties.
     *
    */
    public function p4_gf_enable_default_meta_settings(array $meta): array
    {
        $meta['personalData']['preventIP'] = true;
        $meta['personalData']['retention']['policy'] = 'delete';
        $meta['personalData']['retention']['retain_entries_days'] = 90;
        $meta['personalData']['exportingAndErasing']['enabled'] = true;
        return $meta;
    }

    /**
     * Changes to the lifecycle stage in forms
     * Changing how the lifecycle stage for CRM records is handled in forms.
     * Instead of being a form field, the lifecycle stage will be included in the
     * form settings in a new selectedExternalOptions field.
     * More info: https://developers.hubspot.com/changelog/changes-to-the-lifecycle-stage-in-forms
     *
     * phpcs:disable SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingAnyTypeHint
     * @param mixed $hs_form hubspot form.
     *
     * @return mixed $hs_form hubspot form.
    */
    public function p4_gf_hb_form_object_pre_save_feed($hs_form)
    {
        if (! empty($hs_form['selectedExternalOptions'])) {
            $lifecyclestage_id = '';
            foreach ($hs_form['selectedExternalOptions'] as $key => $external_option) {
                if (rgar($external_option, 'propertyName') !== 'lifecyclestage') {
                    continue;
                }

                if (rgar($external_option, 'objectTypeId') === '0-1') {
                    $lifecyclestage_id = rgar($external_option, 'id');
                    continue;
                }

                if (rgar($external_option, 'objectTypeId') === '0-2') {
                    $lifecyclestage_id = '';
                    break;
                }
            }

            if (! empty($lifecyclestage_id)) {
                $hs_form['selectedExternalOptions'][] = array(
                    'referenceType' => 'PIPELINE_STAGE',
                    'objectTypeId' => '0-2',
                    'propertyName' => 'lifecyclestage',
                    'id' => $lifecyclestage_id,
                );
            }
        }

        return $hs_form;
    }
}