Merged in feature/MAW-855-import-code-into-aws (pull request #2)

code import from pantheon

* code import from pantheon

wp/wp-content/plugins/contact-form-7-dynamic-text-extension/includes/utilities.php

@@ -50,6 +50,9 @@ add_filter('wpcf7dtx_allow_protocols', 'wpcf7dtx_allow_protocols', 10, 2);
  */
 function wpcf7dtx_sanitize($value = '', $type = 'auto', $protocols = false)
 {
+    if ($type == 'none') {
+        return $value;
+    }
     $value = is_string($value) ? $value : strval($value); // Force string value
     if (!empty($value)) {
         $type = $type == 'auto' ? wpcf7dtx_detect_value_type($value) : sanitize_text_field($type);
@@ -62,6 +65,8 @@ function wpcf7dtx_sanitize($value = '', $type = 'auto', $protocols = false)
                 return sanitize_key($value);
             case 'slug':
                 return sanitize_title($value);
+            case 'textarea':
+                return sanitize_textarea_field($value);
         }
     }
     return sanitize_text_field($value);
@@ -82,6 +87,9 @@ add_filter('wpcf7dtx_sanitize', 'wpcf7dtx_sanitize', 10, 3);
  */
 function wpcf7dtx_escape($value = '', $obfuscate = false, $type = 'auto', $protocols = false)
 {
+    if ($type == 'none') {
+        return $value;
+    }
     $value = apply_filters('wpcf7dtx_sanitize', $value, $type); // Sanitize value
     if (!empty($value)) {
         if ($obfuscate) {
@@ -91,6 +99,8 @@ function wpcf7dtx_escape($value = '', $obfuscate = false, $type = 'auto', $proto
         switch ($type) {
             case 'url':
                 return esc_url($value, apply_filters('wpcf7dtx_allow_protocols', $protocols));
+            case 'textarea':
+                return esc_textarea($value);
         }
     }
     return esc_attr($value); // Return attribute value
@@ -182,51 +192,449 @@ function wpcf7dtx_get_post_id($post_id, $context = 'dtx')
 }
 
 /**
- * Parse Content for Specified Shortcodes
+ * Get Dynamic Value
  *
- * Parse a string of content for a specific shortcode to retrieve its attributes and content
+ * @since 3.2.2
  *
- * @since 3.1.0
+ * @param string $value The form tag value.
+ * @param WPCF7_FormTag|false $tag Optional. Use to look up default value.
+ * @param string $sanitize Optional. Specify type of sanitization. Default is `auto`.
  *
- * @param string $content The content to parse
- * @param string $tag The shortcode tag
- *
- * @return array An associative array with `tag` (string) and `shortcodes` (sequential array). If shortcodes were discovered, each one has keys for `atts` (associative array) and `content` (string)
+ * @return string The dynamic output or the original value, not escaped or sanitized.
  */
-function wpcf7dtx_get_shortcode_atts($content)
+function wpcf7dtx_get_dynamic($value, $tag = false, $sanitize = 'auto')
 {
-    $return = array(
-        'tag' => '',
-        'atts' => array()
+    if ($tag !== false) {
+        $default = $tag->get_option('defaultvalue', '', true);
+        if (!$default) {
+            $default = $tag->get_default_option(strval(reset($tag->values)));
+        }
+        $value = wpcf7_get_hangover($tag->name, $default);
+    }
+    $value = apply_filters('wpcf7dtx_sanitize', $value, $sanitize);
+    if (is_string($value) && !empty($value)) {
+        // If a shortcode was passed as the value, evaluate it and use the result
+        $shortcode_tag = '[' . $value . ']';
+        $shortcode_output = do_shortcode($shortcode_tag); //Shortcode value
+        if (is_string($shortcode_output) && $shortcode_output != $shortcode_tag) {
+            return apply_filters('wpcf7dtx_sanitize', $shortcode_output, $sanitize);
+        }
+    }
+    return $value;
+}
+
+/**
+ * Get Allowed HTML for Form Field Properties
+ *
+ * @since 4.0.0
+ *
+ * @param string $type Optional. The type of input for unique properties. Default is `text`.
+ * @param array $extra Optional. A sequential array of properties to additionally include.
+ *
+ * @return array An associative array of allowed properties appropriate for use in `wp_kses()`
+ */
+function wpcf7dtx_get_allowed_field_properties($type = 'text', $extra = array())
+{
+    if (in_array($type, array('option', 'optgroup'))) {
+        return array(
+            'optgroup' => array(
+                'label' => array(),
+                'disabled' => array(),
+                'hidden' => array()
+            ),
+            'option' => array(
+                'value' => array(),
+                'selected' => array(),
+                'disabled' => array(),
+                'hidden' => array()
+            )
+        );
+    }
+    $allowed_properties = array(
+        // Global properties
+        'type' => array(),
+        'id' => array(),
+        'name' => array(),
+        'value' => array(),
+        'required' => array(),
+        'class' => array(),
+        'disabled' => array(),
+        'readonly' => array(),
+        'tabindex' => array(),
+        'size' => array(),
+        'title' => array(),
+        'autofocus' => array(),
+        // ARIA properties
+        'aria-invalid' => array(),
+        'aria-describedby' => array(),
+        // DTX properties
+        'data-dtx-value' => array(),
     );
-    //Search for shortcodes with attributes
-    if (false !== ($start = strpos($content, ' '))) {
-        $return['tag'] = substr($content, 0, $start); //Opens the start tag, assumes there are attributes because of the space
+    if (in_array($type, array('checkbox', 'radio', 'acceptance'))) {
+        // Properties exclusive to checkboxes and radio buttons
+        $allowed_properties['checked'] = array();
+        $allowed_properties['dtx-default'] = array();
+    } elseif (in_array($type, array('number', 'range'))) {
+        // Properties exclusive to number inputs
+        $allowed_properties['step'] = array();
+    } elseif ($type == 'select') {
+        // Properties exclusive to select fields
+        $allowed_properties['multiple'] = array();
+        $allowed_properties['dtx-default'] = array();
+        unset($allowed_properties['type'], $allowed_properties['value'], $allowed_properties['placeholder'], $allowed_properties['size']); // Remove invalid select attributes
+    }
+    if (!in_array($type, array('checkbox', 'radio', 'select', 'acceptance'))) {
+        // Allowed properties for all text-based inputs
+        $allowed_properties['placeholder'] = array();
+        $allowed_properties['autocomplete'] = array();
+        $allowed_properties['minlength'] = array();
+        $allowed_properties['maxlength'] = array();
+        if (in_array($type, array('number', 'range', 'date', 'datetime-local', 'time'))) {
+            // Additional properties for number and date inputs
+            $allowed_properties['min'] = array();
+            $allowed_properties['max'] = array();
+        }
+        if ($type == 'textarea') {
+            // Additional properties exclusive to textarea fields
+            $allowed_properties['cols'] = array();
+            $allowed_properties['rows'] = array();
+            unset($allowed_properties['type'], $allowed_properties['value']); // Remove invalid textarea attributes
+        } elseif (in_array($type, array('text', 'date', 'url', 'tel', 'email', 'password'))) {
+            // Additional properties exclusive to specific text fields
+            $allowed_properties['pattern'] = array();
+        }
+    }
+    if (is_array($extra) && count($extra)) {
+        foreach ($extra as $property) {
+            $allowed_properties[sanitize_title($property)] = array();
+        }
+    }
+    return $allowed_properties;
+}
 
-        //Parse for shortcode attributes: `shortcode att1='foo' att2='bar'`
-
-        //Chop only the attributes e.g. `att1="foo" att2="bar"`
-        $atts_str =  trim(str_replace($return['tag'], '', $content));
-        if (strpos($atts_str, "'") !== false) {
-            $atts = explode("' ", substr(
-                $atts_str,
-                0,
-                -1 //Clip off the last character, which is a single quote
-            ));
-            if (is_array($atts) && count($atts)) {
-                foreach ($atts as $att_str) {
-                    $pair = explode("='", $att_str);
-                    if (is_array($pair) && count($pair) > 1) {
-                        $key = sanitize_key(trim($pair[0])); //Validate & normalize the key
-                        if (!empty($key)) {
-                            $return['atts'][$key] = sanitize_text_field(html_entity_decode($pair[1]));
-                        }
+/**
+ * Returns a formatted string of HTML attributes
+ *
+ * @since 4.0.0
+ *
+ * @param array $atts Associative array of attribute name and value pairs
+ *
+ * @return string Formatted HTML attributes with keys and values both escaped
+ */
+function wpcf7dtx_format_atts($atts)
+{
+    if (is_array($atts) && count($atts)) {
+        $sanitized_atts = array();
+        static $boolean_attributes = array(
+            'checked', 'disabled', 'multiple', 'readonly', 'required', 'selected'
+        );
+        foreach ($atts as $key => $value) {
+            $key = sanitize_key(strval($key));
+            if ($key) {
+                if (in_array($key, $boolean_attributes) || is_bool($value)) {
+                    if ($value) {
+                        $sanitized_atts[$key] = $key;
                     }
+                } elseif ($value && (is_string($value) || is_numeric($value))) {
+                    $sanitized_atts[$key] = $value;
                 }
             }
         }
+        if (count($sanitized_atts)) {
+            $output = array();
+            foreach ($sanitized_atts as $key => $value) {
+                $output[] = sprintf('%s="%s"', esc_attr($key), esc_attr($value));
+            }
+            return implode(' ', $output);
+        }
     }
-    return $return;
+    return '';
+}
+
+/**
+ * Create Input Field HTML
+ *
+ * @since 4.0.0
+ *
+ * @param array $atts An associative array of input attributes.
+ *
+ * @return string HTML output of input field
+ */
+function wpcf7dtx_input_html($atts)
+{
+    return sprintf('<input %s />', wpcf7dtx_format_atts($atts));
+}
+
+/**
+ * Create Checkbox Field HTML
+ *
+ * @since 4.0.0
+ *
+ * @param array $atts An associative array of select input attributes.
+ * @param string $label_text Optional. The text to display next to the checkbox or radio button.
+ * @param bool $label_ui Optional. If true, will place input and label text inside a `<label>` element. Default is true.
+ * @param bool $reverse Optional. If true, will reverse the order to display the text label first then the button. Has no effect if label text is empty. Default is false.
+ *
+ * @return string HTML output of the checkbox or radio button or empty string on failure.
+ */
+function wpcf7dtx_checkbox_html($atts, $label_text = '', $label_ui = true, $reverse = false)
+{
+    // Default field attributes
+    $atts = array_merge(array('value' => '', 'dtx-default' => ''), array_change_key_case((array)$atts, CASE_LOWER));
+    if ($atts['value'] && $atts['dtx-default'] && $atts['value'] == $atts['dtx-default']) {
+        $atts['checked'] = 'checked';
+    }
+    $input = wpcf7dtx_input_html($atts);
+    if (!empty(trim($label_text))) {
+        $label_el = $label_ui ? 'span' : 'label'; // If not wrapping with a label element, display it next to it
+        $label_text = sprintf(
+            '<%1$s%2$s class="wpcf7-list-item-label">%3$s</%1$s>',
+            $label_el,
+            // If not wrapping with a label element and the element has an ID attribute, add a `for` attribute
+            $label_ui ? '' : (wpcf7dtx_array_has_key('id', $atts) ? ' for="' . esc_attr($atts['id']) . '"' : ''),
+            esc_html($label_text)
+        );
+        if ($reverse) {
+            $html = $label_text . $input;
+        } else {
+            $html = $input . $label_text;
+        }
+    } else {
+        $html = $input;
+    }
+    if ($label_ui) {
+        $html = '<label>' . $html . '</label>';
+    }
+    return $html;
+}
+
+/**
+ * Create Checkbox Group HTML
+ *
+ * @since 4.0.3
+ *
+ * @param array $atts An associative array of select input attributes.
+ * @param array|string $options Accepts an associative array of key/value pairs to use as the
+ * select option's value/label pairs. It also accepts an associative array of associative
+ * arrays with the keys being used as option group labels and the array values used as that
+ * group's options. It also accepts a string value of HTML already formatted as options or
+ * option groups. It also accepts a string value of a self-closing shortcode that is
+ * evaluated and its output is either options or option groups.
+ * @param bool $label_ui Optional. If true, will place input and label text inside a `<label>` element. Default is true.
+ * @param bool $reverse Optional. If true, will reverse the order to display the text label first then the button. Has no effect if label text is empty. Default is false.
+ *
+ * @return string HTML output of the checkbox or radio button or empty string on failure.
+ */
+function wpcf7dtx_checkbox_group_html($atts, $options, $label_ui = false, $reverse = false, $exclusive = false)
+{
+    $group_html = '';
+    if ($count = count($options)) {
+        // Attributes specific to HTML creation
+        $atts = array_merge(array(
+            'type' => 'checkbox',
+            'id' => '',
+            'name' => '',
+            'value' => '',
+            'dtx-default' => ''
+        ), array_change_key_case((array)$atts, CASE_LOWER));
+
+        // Loop all the options
+        $group_html = array();
+        $id_prefix = ($atts['id'] ? $atts['id'] : uniqid($atts['name'] . '_')) . '_'; // Create prefix from passed ID or Name
+        $i = 1;
+        foreach ($options as $value => $label) {
+            $my_atts = array_merge($atts, array(
+                'id' => sanitize_html_class($id_prefix . $i) // Always have unique IDs for group items
+            ));
+            $dynamic_value = '';
+            $dynamic_label = $label;
+            if ($value && $label && $value === $label) {
+                // These are identical, just handle it as one, could also be a raw shortcode
+                $dynamic_option = trim(wpcf7dtx_get_dynamic($value, false, 'none')); // Do not sanitize yet, it may have HTML
+                if (is_string($dynamic_option) && !empty($dynamic_option) && strpos($dynamic_option, '{') === 0 && strpos($dynamic_option, '}') === strlen($dynamic_option) - 1) {
+                    // If it outputs JSON, try parsing it
+                    try {
+                        $dynamic_option = json_decode($dynamic_option, true);
+                        if (is_array($dynamic_option) && count($dynamic_option)) {
+                            $group_html[] = wpcf7dtx_checkbox_group_html(
+                                $my_atts,
+                                $dynamic_option,
+                                $label_ui,
+                                $reverse,
+                                $exclusive
+                            );
+                        }
+                    } catch (Exception $e) {
+                        // Fail quietly
+                        if (WP_DEBUG && WP_DEBUG_LOG) {
+                            error_log('[Contact Form 7 - Dynamic Text Extension] Error parsing JSON value');
+                            error_log($e->getMessage());
+                        }
+                    }
+                    $i++;
+                    continue; // Continue with next iteration
+                } elseif (is_string($dynamic_option) && !empty($dynamic_option) && esc_html($dynamic_option) != $dynamic_option) {
+                    $group_html[] = force_balance_tags($dynamic_option); // If it outputs HTML, escape and use them as-is
+                    $i++;
+                    continue; // Continue with next iteration
+                } else {
+                    $dynamic_value = $dynamic_option;
+                    $dynamic_label = $dynamic_option;
+                }
+            } else {
+                // These are different, could be raw shortcodes
+                $dynamic_value = wpcf7dtx_get_dynamic($value, false);
+                $dynamic_label = wpcf7dtx_get_dynamic($label, false);
+            }
+            // This could be a single??
+            $class = array('wpcf7-list-item');
+            $class[] = sanitize_html_class('wpcf7-list-item-' . $i);
+            if ($i === 1) {
+                $class[] = 'first';
+            }
+            if ($i === $count) {
+                $class[] = 'last';
+            }
+            if ($exclusive) {
+                $class[] = 'wpcf7-exclusive-checkbox';
+            }
+            if ($dynamic_value && $atts['dtx-default'] && $dynamic_value == $atts['dtx-default']) {
+                $my_atts['checked'] = 'checked';
+            }
+            $group_html[] = sprintf(
+                '<span class="%s">%s</span>',
+                esc_attr(implode(' ', $class)),
+                wpcf7dtx_checkbox_html(
+                    // Overwrite name attribute
+                    array_merge($my_atts, array(
+                        'name' => $atts['type'] == 'radio' || $exclusive || $count === 1 ? $atts['name'] : $atts['name'] . '[]', // if there are multiple checkboxes and they aren't exclusive, names are an array
+                        'value' => $dynamic_value
+                    )),
+                    $dynamic_label,
+                    $label_ui,
+                    $reverse
+                )
+            );
+            $i++;
+        }
+        $group_html = implode('', $group_html);
+    }
+    return $group_html;
+}
+
+/**
+ * Create Textarea Field HTML
+ *
+ * @since 4.0.0
+ *
+ * @param array $atts An associative array of textarea field attributes.
+ *
+ * @return string HTML output of textarea field
+ */
+function wpcf7dtx_textarea_html($atts)
+{
+    // Attributes specific to HTML creation
+    $atts = array_merge(array('value' => ''), array_change_key_case((array)$atts, CASE_LOWER));
+    return sprintf(
+        '<textarea %s>%s</textarea>',
+        wpcf7dtx_format_atts($atts),
+        apply_filters('wpcf7dtx_escape', $atts['value'], false, 'textarea')
+    );
+}
+
+/**
+ * Create Select Field HTML
+ *
+ * @since 4.0.0
+ *
+ * @param array $atts An associative array of select input attributes.
+ * @param array|string $options Accepts an associative array of key/value pairs to use as the
+ * select option's value/label pairs. It also accepts an associative array of associative
+ * arrays with the keys being used as option group labels and the array values used as that
+ * group's options. It also accepts a string value of HTML already formatted as options or
+ * option groups. It also accepts a string value of a self-closing shortcode that is
+ * evaluated and its output is either options or option groups.
+ * @param bool $hide_blank Optional. If true, the first blank placeholder option will have the `hidden` attribute added to it. Default is false.
+ * @param bool $disable_blank Optional. If true, the first blank placeholder option will have the `disabled` attribute added to it. Default is false.
+ *
+ * @return string HTML output of select field
+ */
+function wpcf7dtx_select_html($atts, $options, $hide_blank = false, $disable_blank = false)
+{
+    // Attributes specific to HTML creation
+    $atts = array_merge(array('placeholder' => '', 'dtx-default' => ''), array_change_key_case((array)$atts, CASE_LOWER));
+    $options_html = ''; // Open options HTML
+
+    // If using a placeholder, use it as the text of the first option
+    if ($atts['placeholder']) {
+        $options_html .= sprintf(
+            '<option value=""%s%s%s>%s</option>',
+            empty($atts['dtx-default']) ? ' selected' : '',
+            $hide_blank ? ' hidden' : '',
+            $disable_blank ? ' disabled' : '',
+            apply_filters('wpcf7dtx_escape', $atts['placeholder'])
+        );
+    }
+    if (is_array($options) && count($options)) {
+        //Check if using option groups
+        if (is_array(array_values($options)[0])) {
+            foreach ($options as $group_name => $opt_group) {
+                $options_html .= sprintf('<optgroup label="%s">', esc_attr(apply_filters('wpcf7dtx_escape', wpcf7dtx_get_dynamic($group_name)))); // Open option group
+                foreach ($opt_group as $option_value => $option_label) {
+                    // Check if option values and groups are dynamic
+                    $dynamic_option_value = wpcf7dtx_get_dynamic($option_value);
+                    $options_html .= sprintf(
+                        '<option value="%1$s"%3$s>%2$s</option>',
+                        esc_attr(apply_filters('wpcf7dtx_escape', $dynamic_option_value)),
+                        esc_html(apply_filters('wpcf7dtx_escape', wpcf7dtx_get_dynamic($option_label))),
+                        $atts['dtx-default'] == $dynamic_option_value ? ' selected' : ''
+                    );
+                }
+                $options_html .= '</optgroup>'; // Close option group
+            }
+        } else {
+            $allowed_html = wpcf7dtx_get_allowed_field_properties('option');
+            foreach ($options as $option_value => $option_label) {
+                if ($option_value === $option_label) {
+                    // These are identical, just handle it as one, could also be a raw shortcode
+                    $dynamic_option = trim(wpcf7dtx_get_dynamic($option_value, false, 'none')); // Do not sanitize yet, it may have HTML
+                    if (is_string($dynamic_option) && !empty($dynamic_option) && (strpos($dynamic_option, '<option') === 0 || stripos($dynamic_option, '<optgroup') === 0)) {
+                        $options_html .= wp_kses($dynamic_option, $allowed_html); // If it outputs HTML, escape and use them as-is
+                    } elseif ($dynamic_option) {
+                        // Just output the option
+                        $dynamic_option = apply_filters('wpcf7dtx_escape', $dynamic_option);
+                        $options_html .= sprintf(
+                            '<option value="%1$s"%3$s>%2$s</option>',
+                            esc_attr($dynamic_option),
+                            esc_html($dynamic_option),
+                            $atts['dtx-default'] == $dynamic_option ? ' selected' : ''
+                        );
+                    }
+                } else {
+                    $dynamic_option_value = wpcf7dtx_get_dynamic($option_value, false);
+                    $options_html .= sprintf(
+                        '<option value="%1$s"%3$s>%2$s</option>',
+                        esc_attr(apply_filters('wpcf7dtx_escape', $dynamic_option_value)),
+                        esc_html(apply_filters('wpcf7dtx_escape', wpcf7dtx_get_dynamic($option_label))),
+                        $atts['dtx-default'] == $dynamic_option_value ? ' selected' : ''
+                    );
+                }
+            }
+        }
+    } elseif (is_string($options) && !empty($options = trim($options))) {
+        $allowed_html = wpcf7dtx_get_allowed_field_properties('option');
+        // If options were passed as a string, go ahead and use them
+        if (strpos($options, '<option') === 0 || stripos($options, '<optgroup') === 0) {
+            $options_html .= wp_kses($options, $allowed_html);
+        } else {
+            // If a shortcode was passed as the options, evaluate it and use the result
+            $shortcode_output = wpcf7dtx_get_dynamic($options);
+            if (is_string($shortcode_output) && !empty($shortcode_output) && (strpos($shortcode_output, '<option') === 0) || strpos($shortcode_output, '<optgroup') === 0) {
+                $options_html .= wp_kses($shortcode_output, $allowed_html);
+            }
+        }
+    }
+    return sprintf('<select %s>%s</select>', wpcf7dtx_format_atts($atts), $options_html);
 }
 
 /**
@@ -253,21 +661,3 @@ function wpcf7dtx_array_has_key($key, $array = array(), $default = '')
     }
     return $default;
 }
-
-if (!function_exists('array_key_first')) {
-    /**
-     * Gets the first key of an array
-     *
-     * Gets the first key of the given array without affecting the internal array pointer.
-     *
-     * @param array $array
-     * @return int|string|null
-     */
-    function array_key_first($array = array())
-    {
-        foreach ($array as $key => $value) {
-            return $key;
-        }
-        return null;
-    }
-}