get_col( $wpdb->prepare( "SELECT DISTINCT source_id FROM ( SELECT CAST(pm.meta_value AS UNSIGNED) AS source_id FROM {$wpdb->postmeta} pm INNER JOIN {$wpdb->posts} p ON p.ID = pm.post_id WHERE pm.meta_key = %s AND p.post_type = %s AND p.post_status IN ({$placeholders}) AND pm.meta_value != '0' AND pm.meta_value != '' UNION SELECT p.post_parent AS source_id FROM {$wpdb->posts} p LEFT JOIN {$wpdb->postmeta} pm ON pm.post_id = p.ID AND pm.meta_key = %s LEFT JOIN {$wpdb->posts} parent_post ON parent_post.ID = p.post_parent WHERE p.post_type = %s AND p.post_status IN ({$placeholders}) AND p.post_parent > 0 AND pm.meta_id IS NULL AND (parent_post.post_type IS NULL OR parent_post.post_type != %s) ) AS combined_sources", array_merge( array( $meta_key, $post_type ), $statuses, array( $meta_key, $post_type ), $statuses, array( Contact_Form::POST_TYPE ) ) ) ); // phpcs:enable $source_ids = array_map( 'intval', $source_ids ); wp_cache_set( self::SOURCE_IDS_CACHE_KEY, $source_ids, self::CACHE_GROUP, HOUR_IN_SECONDS ); return $source_ids; } /** * Returns the JOIN and WHERE SQL fragments for filtering feedback posts by source post ID. * * Matches feedback with the _feedback_source_post_id meta set, or falls back * to post_parent for old feedback that doesn't have the meta yet. * * @since 7.19.0 * * @param int $source_id The source post ID to filter by. * @return array{join: string, where: string} SQL fragments. */ public static function get_source_filter_sql( $source_id ) { global $wpdb; $meta_key = esc_sql( self::SOURCE_META_KEY ); $source_id = (int) $source_id; return array( 'join' => " LEFT JOIN {$wpdb->postmeta} AS source_meta ON ({$wpdb->posts}.ID = source_meta.post_id AND source_meta.meta_key = '{$meta_key}')", 'where' => $wpdb->prepare( "(source_meta.meta_value = %s OR (source_meta.meta_id IS NULL AND {$wpdb->posts}.post_parent = %d))", (string) $source_id, $source_id ), ); } /** * Invalidates the source post IDs cache when a feedback post is deleted. * * @param int $post_id The deleted post ID. * @param \WP_Post $post The deleted post object. */ public static function invalidate_source_ids_cache_on_delete( $post_id, $post ) { if ( $post->post_type === self::POST_TYPE ) { wp_cache_delete( self::SOURCE_IDS_CACHE_KEY, self::CACHE_GROUP ); } } /** * Backfills the source post ID meta from the feedback object's resolved source. * * For old feedback parented to a jetpack_form that doesn't have * _feedback_source_post_id set yet, this writes the meta so future * queries can filter by source without the post_parent fallback. * * @param int $post_id The feedback post ID. * @param Feedback $feedback The feedback object (already has source resolved from parsed content). */ public static function maybe_backfill_source_meta( $post_id, $feedback ) { $existing = get_post_meta( $post_id, self::SOURCE_META_KEY, true ); if ( $existing ) { return; } $source_id = $feedback->get_entry_id(); if ( is_numeric( $source_id ) && (int) $source_id > 0 ) { $meta_added = add_post_meta( $post_id, self::SOURCE_META_KEY, (int) $source_id, true ); if ( $meta_added ) { wp_cache_delete( self::SOURCE_IDS_CACHE_KEY, self::CACHE_GROUP ); } } } /** * The form field values. * * @var array */ protected $fields = array(); /** * Static cache for feedback fields. * * This is used to avoid recomputing the feedback fields for the same post ID. * * @var array */ private static $feedback_fields = array(); /** * Does the response have files attached to it? * * @var bool */ protected $has_file = false; /** * The status of the feedback entry. * * @var string */ protected $status = 'publish'; // Default status is 'publish' or other statuses as needed. /** * The IP address of the user who submitted the feedback. * * This is only available on form submissions, and might not be available when retrieving existing feedback posts in case the site admin decides to not store the IP address. * * @var string|null */ protected $ip_address = null; /** * The user agent of the user who submitted the feedback. * * This is only available on form submissions, and might not be available when retrieving existing feedback posts. * * @var string|null */ protected $user_agent = null; /** * The country code derived from the IP address. * * This is derived from the IP address and stored for easier display. * * @var string|null */ protected $country_code = null; /** * The form fill duration in seconds. * * Tracks how long the user spent filling out the form (from first interaction to submission). * * @var int|null */ protected $form_fill_duration = null; /** * The subject of the feedback entry. * * @var string */ protected $subject = ''; /** * Feedback ID of the feedback entry. * * Marked as legacy because it is not used in the new feedback system. * * @var string */ protected $legacy_feedback_id = ''; /** * The title of the feedback entry. * * Marked as legacy because it is not used in the new feedback system. * * @var string */ protected $legacy_feedback_title = ''; /** * The time of the feedback entry. * * This is used to store the title of the feedback entry. * * @var string */ protected $feedback_time = ''; /** * The Feedback_Author of the feedback entry. * * @var Feedback_Author */ protected $author_data; /** * The comment content of the feedback entry. * * @var string */ protected $comment_content = ''; /** * Whether the user has given consent for data processing. * * @var bool */ protected $has_consent = false; /** * Whether this response was loaded from structured feedback data. * * @var bool */ protected $uses_structured_fields = false; /** * Whether the feedback entry is unread. * * @var bool */ protected $is_unread = true; /** * The post ID of the feedback entry. * * @var int|null */ protected $post_id = null; /** * The entry object of the post that the feedback was submitted from. * * This is used to store the entry object of the post that the feedback was submitted from. * * @var Feedback_Source */ protected $source; /** * The notification recipients of the feedback entry. * * @var array */ protected $notification_recipients = array(); /** * The jetpack_form post ID associated with this feedback, when available. * * @var int|null */ protected $form_id = null; /** * The logged-in user who submitted the feedback, if any. * * @var array|null Array with 'display_name' and 'id' keys, or null if not logged in. */ protected $logged_in_user = null; /** * Create a response object from a feedback post ID. * * @param int $feedback_post_id The ID of the feedback post. * @return static|null */ public static function get( $feedback_post_id ) { $feedback_post = get_post( $feedback_post_id ); if ( ! $feedback_post || self::POST_TYPE !== $feedback_post->post_type ) { return null; } if ( isset( self::$feedback_fields[ $feedback_post->ID ] ) ) { return self::$feedback_fields[ $feedback_post->ID ]; } $instance = new self(); $instance->load_from_post( $feedback_post ); self::$feedback_fields[ $feedback_post->ID ] = $instance; return $instance; } /** * Clear the internal cache of feedback objects. * * Useful for testing or when feedback data needs to be reloaded fresh. * * @since 6.10.0 */ public static function clear_cache() { self::$feedback_fields = array(); } /** * Create a Feedback object from a feedback post. * * @param WP_Post $feedback_post The feedback post object. */ private function load_from_post( WP_Post $feedback_post ) { $parsed_content = $this->parse_content( $feedback_post->post_content, $feedback_post->post_mime_type ); $this->post_id = $feedback_post->ID; $this->status = $feedback_post->post_status; $this->legacy_feedback_id = $feedback_post->post_name; $this->feedback_time = $feedback_post->post_date; $this->is_unread = $feedback_post->comment_status === self::STATUS_UNREAD; $this->fields = $parsed_content['fields'] ?? array(); // Check if post_parent is a jetpack_form post $potential_form_id = $feedback_post->post_parent; if ( $potential_form_id > 0 ) { $parent_post = get_post( $potential_form_id ); if ( $parent_post && $parent_post->post_type === 'jetpack_form' ) { // New data: post_parent is form ID $this->form_id = $potential_form_id; } } // Determine the source ID for this feedback. // Prefer the explicit source_id from parsed content when available, // otherwise fall back to the legacy behavior where post_parent was // used as the source post ID, but only when no explicit form_id exists. $source_id = 0; if ( isset( $parsed_content['source_id'] ) && null !== $parsed_content['source_id'] ) { $source_id = (int) $parsed_content['source_id']; } elseif ( $feedback_post->post_parent && ! $this->form_id ) { $source_id = (int) $feedback_post->post_parent; } $this->source = new Feedback_Source( $source_id, $parsed_content['entry_title'] ?? '', $parsed_content['entry_page'] ?? 1, $parsed_content['source_type'] ?? 'single', $parsed_content['request_url'] ?? '', ! empty( $parsed_content['is_test'] ) ); $this->ip_address = $parsed_content['ip'] ?? $this->get_first_field_of_type( 'ip' ); $this->country_code = $parsed_content['country_code'] ?? null; $this->user_agent = $parsed_content['user_agent'] ?? null; $this->form_fill_duration = $parsed_content['form_fill_duration'] ?? null; $this->subject = $parsed_content['subject'] ?? $this->get_first_field_of_type( 'subject' ); $this->notification_recipients = $parsed_content['notification_recipients'] ?? array(); $this->logged_in_user = $parsed_content['logged_in_user'] ?? null; $this->author_data = new Feedback_Author( $this->get_first_field_of_type( 'name', 'pre_comment_author_name' ), $this->get_first_field_of_type( 'email', 'pre_comment_author_email' ), $this->get_first_field_of_type( 'url', 'pre_comment_author_url' ), $this->get_field_value_by_form_field_id( 'first-name' ), $this->get_field_value_by_form_field_id( 'last-name' ) ); $this->comment_content = $this->get_first_field_of_type( 'textarea' ); $this->has_consent = (bool) $this->get_first_field_of_type( 'consent' ); $this->legacy_feedback_title = $feedback_post->post_title ? $feedback_post->post_title : $this->get_author() . ' - ' . $feedback_post->post_date; } /** * Create a response object from a form submission. * * @param array $post_data Typically $_POST. * @param Contact_Form $form The form object. * @param WP_Post|null $current_post The current post object, if available. * @param int $current_page_number The current page number associated with the current post object entry. * * @return static */ public static function from_submission( $post_data, $form, $current_post = null, $current_page_number = 1 ) { $instance = new self(); $instance->load_from_submission( $post_data, $form, $current_post, $current_page_number ); return $instance; } /** * Set the source of the feedback entry. * * @param Feedback_Source $source The source object. */ public function set_source( $source ) { $this->source = $source; } /** * Load from Form Submission. * * @param array $post_data The $_POST received during the form submission. * @param Contact_Form $form The form object. * @param WP_Post|null $current_post The current post object, if available. * @param int $current_page_number The current page number associated with the current post object entry. */ private function load_from_submission( $post_data, $form, $current_post = null, $current_page_number = 1 ) { // Drop the answers to fields conditional logic hid, once, before anything reads them. // // get_computed_fields() already skips hidden fields for the stored response, but the // comment content, the consent flag, the author details and the notification // recipients all read $post_data directly and were still seeing them. Stripping here // is what makes "a hidden field was never answered" true for every consumer instead // of just the one. $post_data = self::without_hidden_answers( $post_data, $form ); $this->source = Feedback_Source::from_submission( $current_post, $current_page_number ); // Use the form's ref attribute as the authoritative form ID. // The ref is set server-side (from the JWT or shortcode attributes) and cannot be tampered with. $form_id_attribute = $form->get_attribute( 'ref' ); $form_id_attribute = is_numeric( $form_id_attribute ) ? absint( $form_id_attribute ) : 0; $this->form_id = $form_id_attribute > 0 ? $form_id_attribute : null; // If post_data is provided, use it to populate fields. $this->fields = $this->get_computed_fields( $post_data, $form ); $this->ip_address = Contact_Form_Plugin::get_ip_address(); $this->country_code = $this->get_country_code_from_ip( $this->ip_address ); $this->user_agent = isset( $_SERVER['HTTP_USER_AGENT'] ) ? filter_var( wp_unslash( $_SERVER['HTTP_USER_AGENT'] ) ) : null; $this->form_fill_duration = $this->get_computed_form_fill_duration( $post_data ); $this->subject = $this->get_computed_subject( $post_data, $form ); $this->author_data = Feedback_Author::from_submission( $post_data, $form ); $this->comment_content = $this->get_computed_comment_content( $post_data, $form ); $this->has_consent = $this->get_computed_consent( $post_data, $form ); $this->notification_recipients = $this->get_computed_notification_recipients( $post_data, $form ); $this->feedback_time = current_time( 'mysql' ); $this->legacy_feedback_title = "{$this->get_author()} - {$this->feedback_time}"; $this->legacy_feedback_id = md5( $this->legacy_feedback_title ); // Capture logged-in user info at submission time. if ( is_user_logged_in() ) { $current_user = wp_get_current_user(); $this->logged_in_user = array( 'display_name' => $current_user->display_name, 'username' => $current_user->user_login, 'id' => $current_user->ID, ); } } /** * Remove submitted values belonging to fields conditional logic resolved as hidden. * * The form owns the resolution and caches it, so this asks rather than resolving again -- * a second resolution over a different value source is exactly what let validation and * storage disagree about a prefilled consent field. * * @param array $post_data The post data from the form submission. * @param Contact_Form $form The form object. * @return array The post data, less any hidden field's answer. */ private static function without_hidden_answers( $post_data, $form ) { if ( ! is_array( $post_data ) ) { return $post_data; } // Empty when the feature is off, so this is a no-op then. foreach ( $form->get_resolved_field_visibility() as $field_id => $is_visible ) { if ( false === $is_visible ) { unset( $post_data[ $field_id ] ); } } return $post_data; } /** * Get a sanitized value from the post data. * * @param string $key The key to look for in the post data. * @param array $post_data The post data array, typically $_POST. * @param string|null $type The type of the field, if applicable (e.g., 'file'). * * @return string|array The sanitized value, or an empty string if the key is not found. */ private function get_field_value( $key, $post_data, $type = null ) { if ( $type === 'file' ) { if ( isset( $post_data[ $key ] ) ) { return self::process_file_field_value( $post_data[ $key ] ); } return array( 'files' => array() ); } if ( $type === 'image-select' ) { if ( isset( $post_data[ $key ] ) ) { return self::process_image_select_field_value( $post_data[ $key ] ); } return array( 'type' => 'image-select', 'choices' => array(), ); } if ( isset( $post_data[ $key ] ) ) { if ( is_array( $post_data[ $key ] ) ) { return array_map( array( self::class, 'sanitize_text_value' ), wp_unslash( $post_data[ $key ] ) ); } else { return self::sanitize_text_value( wp_unslash( $post_data[ $key ] ) ); } } return ''; } /** * Sanitize a submitted text value. * * @param mixed $value The unslashed submitted value. * * @return string The sanitized value. */ private static function sanitize_text_value( $value ) { // Encoding first keeps tag-like text as typed instead of letting strip_tags() drop it. return sanitize_textarea_field( self::encode_special_chars( $value ) ); } /** * HTML-encode `<`, `>` and `&` in a string, or in each string of a nested array. * * Encoding `&` as well keeps the result reversible: a literally-typed `<` becomes * `&lt;`, distinct from an encoded `<` (`<`), so decode_special_chars() restores it. * * @param mixed $value The value to encode. * * @return mixed The value, with the same shape. */ public static function encode_special_chars( $value ) { if ( is_array( $value ) ) { return array_map( array( self::class, 'encode_special_chars' ), $value ); } // ENT_SUBSTITUTE keeps a value with invalid UTF-8 from becoming ''; this runs before // sanitize_textarea_field(), which is what would otherwise have scrubbed those bytes. return is_string( $value ) ? htmlspecialchars( $value, ENT_NOQUOTES | ENT_SUBSTITUTE, 'UTF-8' ) : $value; } /** * Reverse encode_special_chars() for a value that is about to be shown as text. * * @param mixed $value The stored value. * * @return mixed The value, with the same shape. */ public static function decode_special_chars( $value ) { if ( is_array( $value ) ) { return array_map( array( self::class, 'decode_special_chars' ), $value ); } return is_string( $value ) ? htmlspecialchars_decode( $value, ENT_NOQUOTES ) : $value; } /** * Process the file field value. * * @param array $raw_data The raw post data from the file field. * * @return array The processed file data. */ public static function process_file_field_value( $raw_data ) { $file_data_array = is_array( $raw_data ) ? array_map( function ( $json_str ) { /* * The entries come straight from $_POST, so any of them may be an array: a request * carrying `field[1][x]=y` reaches here with a nested array where a JSON string is * expected, and stripslashes() raises an uncaught TypeError on PHP 8. Nothing above * this catches it, so an anonymous visitor could crash the submission with a 500. * * Contact_Form_Field::validate() sanitizes its own copy — which turns a nested array * into '' — but that copy is not the one read here. */ if ( ! is_string( $json_str ) ) { return array( 'file_id' => '', 'name' => '', 'size' => 0, 'type' => '', ); } $decoded = json_decode( stripslashes( $json_str ), true ); return array( 'file_id' => isset( $decoded['file_id'] ) ? sanitize_text_field( $decoded['file_id'] ) : '', 'name' => isset( $decoded['name'] ) ? self::encode_special_chars( sanitize_text_field( $decoded['name'] ) ) : '', 'size' => isset( $decoded['size'] ) ? absint( $decoded['size'] ) : 0, 'type' => isset( $decoded['type'] ) ? self::encode_special_chars( sanitize_text_field( $decoded['type'] ) ) : '', ); }, $raw_data ) : array(); if ( empty( $file_data_array ) ) { return array( 'files' => array(), ); } return array( 'files' => $file_data_array, ); } /** * Process the image select field value. * * @param array $raw_data The raw post data from the image select field. * * @return array The processed image select data. */ public static function process_image_select_field_value( $raw_data ) { $value = array( 'type' => 'image-select', 'choices' => array(), ); $selection_data_array = is_array( $raw_data ) ? array_map( function ( $json_str ) { return is_string( $json_str ) ? json_decode( stripslashes( $json_str ), true ) : null; }, $raw_data ) : array( is_string( $raw_data ) ? json_decode( stripslashes( $raw_data ), true ) : null ); if ( ! empty( $selection_data_array ) ) { $value['choices'] = self::encode_special_chars( $selection_data_array ); } return $value; } /** * Process a radio field value to detect and extract "Other" option metadata. * * This method checks if a radio field value matches the "Other" pattern and combines * it with the corresponding text input value if present. * * @param string $value The raw field value from the submission. * @param object $field The field object from the form. * @param string $field_id The field ID. * @param array $post_data The POST data from the submission. * * @return array An array with 'value' and 'meta' keys. */ private function process_radio_field_value( $value, $field, $field_id, $post_data ) { $meta = array(); $allow_other = $field->get_attribute( 'allowother' ); if ( ! $allow_other || ! is_string( $value ) ) { return array( 'value' => $value, 'meta' => $meta, ); } $options_data = $field->get_attribute( 'optionsdata' ); $other_label = null; if ( ! empty( $options_data ) && is_array( $options_data ) ) { foreach ( $options_data as $option ) { if ( ! empty( $option['isOther'] ) ) { $other_label = Contact_Form_Plugin::strip_tags( $option['label'] ); break; } } } if ( empty( $other_label ) ) { return array( 'value' => $value, 'meta' => $meta, ); } if ( $value === $other_label ) { $other_text_key = $field_id . '-other-text'; $custom_text = ''; if ( isset( $post_data[ $other_text_key ] ) ) { $custom_text = self::sanitize_text_value( wp_unslash( $post_data[ $other_text_key ] ) ); } $meta['is_other_option'] = true; $meta['other_label'] = $other_label; $meta['other_user_value'] = $custom_text; if ( ! empty( $custom_text ) ) { $value = $other_label . ': ' . $custom_text; } } return array( 'value' => $value, 'meta' => $meta, ); } /** * Get the computed fields from the post data. * * @param string $label The label of the field to look for. * @param string $context The context in which the value is being rendered (default is 'default'). * * @return string The Value of the field. */ public function get_field_value_by_label( $label, $context = 'default' ) { // This method is used to get the value of a field by its label. foreach ( $this->fields as $field ) { if ( $field->get_label( $context ) === $label ) { return $field->get_render_value( $context ); } } return ''; } /** * Get the value of the field based on the first type found. * * @param string $type The type of the field to look for. * @param string|null $filter Optional filter to apply to the value. * @param string $context The context in which the value is being rendered (default is 'default'). * * @return string The value of the first field of the specified type, or an empty string if not found. */ private function get_first_field_of_type( $type, $filter = null, $context = 'default' ) { // This method is used to get the first field of a specific type. foreach ( $this->fields as $field ) { if ( $field->get_type() === $type ) { if ( $filter ) { return Contact_Form_Plugin::strip_tags( stripslashes( /** This filter is already documented in core/wp-includes/comment-functions.php */ \apply_filters( $filter, addslashes( $field->get_render_value( $context ) ) ) ) ); } return $field->get_render_value( $context ); } } return ''; } /** * Get all the fields of the response. */ public function get_fields() { return $this->fields; } /** * Check whether this feedback contains at least one field of a given type. * * @param string $type Field type to check for (e.g. 'consent', 'email', 'textarea'). * @return bool True if a field of the given type exists; false otherwise. */ public function has_field_type( $type ) { foreach ( $this->fields as $field ) { if ( $field->get_type() === $type ) { return true; } } return false; } /** * Whether this response uses structured feedback fields. * * @return bool */ public function uses_structured_fields() { return $this->uses_structured_fields; } /** * Get the values related to where the form was submitted from. * * @return array An array of entry values. */ public function get_entry_values() { // This is a convenience method to get the entry values in a simple array format. $entry_values = array( 'email_marketing_consent' => (string) $this->has_consent ? 'yes' : 'no', 'entry_title' => $this->source->get_title(), 'entry_permalink' => $this->source->get_permalink(), 'feedback_id' => $this->legacy_feedback_id, ); if ( $this->source->get_page_number() > 1 ) { $entry_values['entry_page'] = $this->source->get_page_number(); } return $entry_values; } /** * Get all values of the response. * * @param string $context The context in which the values are being retrieved. * * @return array An array of all values, including fields and entry values. */ public function get_all_values( $context = 'default' ) { // This is a legacy method to maintain compatibility with older code. return array_merge( $this->get_compiled_fields( $context, 'key-value' ), $this->get_entry_values() ); } /** * Get the jetpack_form post ID associated with this feedback. * * @return int|null The form ID, or null if not submitted via reusable form. */ public function get_form_id() { return $this->form_id; } /** * Get extra values. * This is a legacy method to maintain compatibility with older code. * * @param string $context The context in which the values are being retrieved. * * @return array An array of extra values, including entry values */ public function get_legacy_extra_values( $context = 'default' ) { $count = 1; $_extra_fields = array(); $special_fields = array(); $non_extra_fields = array( 'email', 'name', 'url', 'subject', 'textarea', 'ip' ); // Create a map of special fields to check against their values. foreach ( $this->fields as $field ) { if ( in_array( $field->get_type(), $non_extra_fields, true ) ) { $value = $field->get_render_value( $context ); if ( is_array( $value ) ) { $value = reset( $value ); } if ( $value ) { $special_fields[ $value ] = true; } } } foreach ( $this->fields as $field ) { if ( $field->compile_field( 'default' ) ) { continue; } $render_value = $field->get_render_value(); if ( is_array( $render_value ) ) { $render_value = reset( $render_value ); } if ( $field->get_type() === 'basic' && $render_value && isset( $special_fields[ $render_value ] ) ) { ++$count; continue; // Skip fields that are already present in the non-extra fields. } $_extra_fields[] = $field; ++$count; // Increment count to ensure unique keys for extra values. } $extra_values = array(); $extra_fields_count = $count; $is_present = array(); // Used to store the value only once. foreach ( $_extra_fields as $field ) { if ( ! in_array( $field->get_type(), $non_extra_fields, true ) || isset( $is_present[ $field->get_type() ] ) ) { $extra_values[ $extra_fields_count . '_' . $field->get_label() ] = $field->get_render_value( $context ); ++$extra_fields_count; // Increment count to ensure unique keys for extra values. } else { $is_present[ $field->get_type() ] = true; } } return $extra_values; } /** * Get all values of the response. * * @return array An array of all values, including fields and entry values. */ public function get_all_legacy_values() { return array( '_feedback_author' => $this->get_author(), '_feedback_author_email' => $this->get_author_email(), '_feedback_author_url' => $this->get_author_url(), '_feedback_subject' => $this->get_subject(), '_feedback_ip' => $this->get_ip_address(), '_feedback_all_fields' => $this->get_all_values(), ); } /** * Return the compiled fields for the given context. * * @param string $context The context in which the fields are compiled. * @param string $array_shape The shape of the array to return. Can be 'all', 'value', 'label', or 'key-value'. * * @return array An array of compiled fields with labels and values. */ public function get_compiled_fields( $context = 'default', $array_shape = 'all' ) { $compiled_fields = array(); $count_field_labels = array(); foreach ( $this->fields as $field ) { if ( $field->compile_field( $context ) ) { continue; // Skip fields that are not meant to be rendered. } // Don't show the hidden fields in the user context. if ( in_array( $context, array( 'web', 'ajax' ), true ) ) { if ( $field->is_of_type( 'hidden' ) ) { continue; } } $label = $field->get_label( $context ); if ( ! isset( $count_field_labels[ $label ] ) ) { $count_field_labels[ $label ] = 1; } else { ++$count_field_labels[ $label ]; } // Compile the field based on the requested shape. switch ( $array_shape ) { case 'default': case 'all': $compiled_fields[ $field->get_key() ] = array( 'label' => $label, 'value' => $field->get_render_value( $context ), ); break; case 'label|value': $compiled_fields[] = array( 'label' => $label, 'value' => $field->get_render_value( $context ), ); break; case 'value': $compiled_fields[] = $field->get_render_value( $context ); break; case 'label': $compiled_fields[] = $label; break; case 'key-value': $compiled_fields[ $field->get_key() ] = $field->get_render_value( $context ); break; case 'label-value': $compiled_fields[ $field->get_label( $context, $count_field_labels[ $label ] ) ] = $field->get_render_value( $context ); break; case 'id-value': $compiled_fields[ $field->get_form_field_id() ] = $field->get_render_value( $context ); break; case 'collection': $compiled_fields[] = array( 'label' => $label, 'value' => $field->get_render_value( $context ), 'type' => $field->get_type(), 'id' => $field->get_form_field_id(), 'key' => $field->get_key(), 'meta' => $field->get_meta(), ); break; } } return $compiled_fields; } /** * Get the feedback ID of the response. * Which is the same as the post name for feedback entries. * Please note that this is not the same as the feedback post ID. * * @return string */ public function get_feedback_id() { return $this->legacy_feedback_id; } /** * Get the feedback title of the response. * * This is mostly used for legacy reasons. * * @return string */ public function get_title() { return $this->legacy_feedback_title; } /** * Get the time of the feedback entry. * * @return string */ public function get_time() { return $this->feedback_time; } /** * Get the askimet vars that are used to check for spam. * * These are the variables that are sent to Akismet to check if the feedback is spam or not. * * @return array */ public function get_akismet_vars() { $akismet_vars = array( 'comment_author' => $this->author_data->get_name(), 'comment_author_email' => $this->author_data->get_email(), 'comment_author_url' => $this->author_data->get_url(), 'contact_form_subject' => $this->get_subject(), 'comment_author_ip' => $this->get_ip_address(), 'comment_content' => empty( $this->get_comment_content() ) ? null : $this->get_comment_content(), 'permalink' => $this->get_entry_permalink(), ); foreach ( $this->fields as $field ) { // Skip any fields that are just a choice from a pre-defined list. They wouldn't have any value // from a spam-filtering point of view. if ( in_array( $field->get_type(), array( 'select', 'checkbox', 'checkbox-multiple', 'radio', 'file', 'image-select' ), true ) ) { continue; } // Normalize the label into a slug. $field_slug = trim( // Strip all leading/trailing dashes. preg_replace( // Normalize everything to a-z0-9_- '/[^a-z0-9_]+/', '-', strtolower( $field->get_label() ) // Lowercase ), '-' ); $field_value = $field->get_render_value( 'akismet' ); // Skip any values that are already in the array we're sending. if ( $field_value && in_array( $field_value, $akismet_vars, true ) ) { continue; } $akismet_vars[ 'contact_form_field_' . $field_slug ] = $field_value; } return $akismet_vars; } /** * Get the author name of the feedback entry. * If the author is not provided we will use the email instead. * * @return string */ public function get_author() { return $this->author_data->get_display_name(); } /** * Get the author name of a feedback entry. * * @return string */ public function get_author_name() { return $this->author_data->get_name(); } /** * Get the author's first name of a feedback entry. * * @return string */ public function get_author_first_name() { return $this->author_data->get_first_name(); } /** * Get the author's last name of a feedback entry. * * @return string */ public function get_author_last_name() { return $this->author_data->get_last_name(); } /** * Get the author email of a feedback entry. * * @return string */ public function get_author_email() { return $this->author_data->get_email(); } /** * Get the author's gravatar URL. * * This is a convenience method to get the author's gravatar URL. * * @return string */ public function get_author_avatar() { return $this->author_data->get_avatar_url(); } /** * Get the author url of a feedback entry. * * @return string */ public function get_author_url() { return $this->author_data->get_url(); } /** * Get the comment content of a feedback entry. * * @return string */ public function get_comment_content() { return $this->comment_content; } /** * Get the IP address of the submitted feedback request. * * @return string|null */ public function get_ip_address() { return $this->ip_address; } /** * Get the user agent of the submitted feedback request. * * @return string|null */ public function get_user_agent() { return $this->user_agent; } /** * Get the country code derived from the IP address. * * @return string|null */ public function get_country_code() { return $this->country_code; } /** * Get the form fill duration in seconds. * * Represents the time from first user interaction to form submission. * * @return int|null */ public function get_form_fill_duration() { return $this->form_fill_duration; } /** * Get the emoji flag for the country. * * @return string The emoji flag for the country code, or empty string if unavailable. */ public function get_country_flag() { return self::country_code_to_emoji_flag( $this->country_code ); } /** * Get country code from IP address. * * This method uses a filter to allow custom implementations of GeoIP lookup. * The filter should return a country code (e.g., 'US', 'GB', 'DE') or null. * * @param string|null $ip_address The IP address. * @return string|null The country code or null if unavailable. */ private function get_country_code_from_ip( $ip_address ) { if ( ! $ip_address ) { return null; } // This filter allows site owners to disable IP address storage entirely as well as GeoIP lookups. // This filter is documented in src/contact-form/class-contact-form-plugin.php if ( apply_filters( 'jetpack_contact_form_forget_ip_address', false ) ) { return null; } /** * Filter to get country code from IP address. * * @since $$NEXT_VERSION$$ * * @param string|null $country The country code (e.g., 'US', 'GB', 'DE') or null. * @param string $ip_address The IP address to look up. * @param string $context The context for the geolocation request. */ $country = apply_filters( 'jetpack_get_country_from_ip', null, $ip_address, 'form-response' ); if ( is_string( $country ) ) { return strtoupper( $country ); } $headers = array( 'MM_COUNTRY_CODE', 'GEOIP_COUNTRY_CODE', 'HTTP_CF_IPCOUNTRY', 'HTTP_X_COUNTRY_CODE', 'HTTP_X_APPENGINE_COUNTRY', 'HTTP_X_FORWARDED_FOR_COUNTRY', 'HTTP_CLOUDFRONT_VIEWER_COUNTRY', ); // Check for headers from the server. foreach ( $headers as $header ) { if ( isset( $_SERVER[ $header ] ) ) { $country = sanitize_text_field( wp_unslash( $_SERVER[ $header ] ) ); if ( ! empty( $country ) ) { return strtoupper( $country ); } } } if ( function_exists( 'geoip_country_code_by_name' ) ) { $country = geoip_country_code_by_name( $ip_address ); if ( ! empty( $country ) ) { return strtoupper( $country ); } } $country = self::geolocate_via_api( $ip_address ); if ( ! empty( $country ) ) { return strtoupper( $country ); } return null; } /** * Use APIs to Geolocate the IP address. * * @param string $ip_address IP address. * @return string */ private static function geolocate_via_api( $ip_address ) { $country_code = \get_transient( 'geoip_' . $ip_address ); if ( false === $country_code ) { $response = Client::wpcom_json_api_request_as_blog( '/ip-to-geo/' . $ip_address, '2', array( 'method' => 'GET' ), null, 'wpcom' ); if ( ! is_wp_error( $response ) && ! empty( $response['body'] ) ) { $data = json_decode( $response['body'] ); $country_code = $data->country_short ?? ''; $country_code = \sanitize_text_field( $country_code ); // Share the transient with woocommerce to avoid multiple lookups. \set_transient( 'geoip_' . $ip_address, $country_code, DAY_IN_SECONDS ); } } return $country_code; } /** * Get the browser information from the user agent. * * Returns a formatted string like "Chrome (Desktop)" or "Safari (Mobile)". * * @return string|null Browser information or null if user agent is not available. */ public function get_browser() { if ( empty( $this->user_agent ) ) { return null; } // Use Jetpack Device Detection to parse the user agent. $ua_info = new User_Agent_Info( $this->user_agent ); // Get browser name. $browser_name = $ua_info->get_browser_display_name(); if ( $browser_name === User_Agent_Info::OTHER ) { return __( 'Unknown browser', 'jetpack-forms' ); } // Determine platform type (Mobile, Tablet, or Desktop). $platform_type = 'Desktop'; if ( $ua_info->is_tablet() ) { $platform_type = 'Tablet'; } elseif ( $ua_info->get_platform() ) { // If there's a mobile platform detected (not false), it's mobile. $platform_type = 'Mobile'; } return sprintf( '%s (%s)', $browser_name, $platform_type ); } /** * Get the logged-in user information who submitted the feedback. * * @return array|null Array with 'display_name' and 'id' keys, or null if not logged in. */ public function get_logged_in_user() { return $this->logged_in_user; } /** * Get the email subject. * * @return string */ public function get_subject() { return $this->subject; } /** * Gets the notification recipients of the feedback entry. * * @return array */ public function get_notification_recipients() { return $this->notification_recipients; } /** * Gets the value of the consent field. * * @return bool */ public function has_consent() { return $this->has_consent; } /** * Gets the value of the consent field. * * @return bool */ public function has_file() { return $this->has_file; } /** * Check if the feedback is unread. * * @return bool */ public function is_unread() { return $this->is_unread; } /** * Mark the feedback as read. * * @return bool True on success, false on failure. */ public function mark_as_read() { if ( ! $this->post_id ) { return false; } $updated = wp_update_post( array( 'ID' => $this->post_id, 'comment_status' => self::STATUS_READ, ) ); if ( ! is_wp_error( $updated ) && $updated ) { $this->is_unread = false; return true; } return false; } /** * Mark the feedback as unread. * * @return bool True on success, false on failure. */ public function mark_as_unread() { if ( ! $this->post_id ) { return false; } $updated = wp_update_post( array( 'ID' => $this->post_id, 'comment_status' => self::STATUS_UNREAD, ) ); if ( ! is_wp_error( $updated ) && $updated ) { $this->is_unread = true; return true; } return false; } /** * Get the count of unread feedback entries. * * @return int */ public static function get_unread_count() { $query = new \WP_Query( array( 'post_type' => self::POST_TYPE, 'post_status' => 'publish', 'comment_status' => self::STATUS_UNREAD, 'posts_per_page' => -1, 'fields' => 'ids', ) ); return (int) $query->found_posts; } /** * Get the uploaded files from the feedback entry. * * @return array */ public function get_files() { $files = array(); foreach ( $this->fields as $field ) { if ( $field->get_type() === 'file' ) { $field_value = $field->get_value(); if ( ! empty( $field_value['files'] ) && is_array( $field_value['files'] ) ) { $field_value['files'] = array_filter( $field_value['files'], function ( $file ) { if ( empty( $file['file_id'] ) ) { return false; } if ( empty( $file['name'] ) ) { return false; } if ( empty( $file['size'] ) ) { return false; } if ( empty( $file['type'] ) ) { return false; } return true; } ); $files = array_merge( $files, $field_value['files'] ); } } } return $files; } /** * Get the feedback status. For example 'publish', 'spam' or 'trash'. * * @return string */ public function get_status() { return $this->status; } /** * Sets the status of the feedback. * * @param string $status The status to set for the feedback entry. * @return void */ public function set_status( $status ) { $this->status = $status; } /** * Get the entry ID of the post that the feedback was submitted from. * * This is the post ID of the post or page that the feedback was submitted from. * * @return int|string */ public function get_entry_id() { return $this->source->get_id(); } /** * Get the entry title of the post that the feedback was submitted from. * * This is the title of the post or page that the feedback was submitted from. * * @return string */ public function get_entry_title() { return $this->source->get_title(); } /** * Get the permalink of the post or page that the feedback was submitted from. * This includes the page number if the feedback was submitted from a paginated form. * * @return string */ public function get_entry_permalink() { return $this->source->get_permalink(); } /** * Get the editor URL where the user can edit the form. * * @return string */ public function get_edit_form_url() { if ( ! empty( $this->form_id ) ) { return \get_edit_post_link( (int) $this->form_id, 'url' ); } return $this->source->get_edit_form_url(); } /** * Get the short permalink of a post. * * @return string */ public function get_entry_short_permalink() { return $this->source->get_relative_permalink(); } /** * Whether this feedback was submitted from a form preview (test submission). * * @return bool */ public function is_test() { return $this->source->is_test(); } /** * Flag this feedback as a test submission from form preview. * * @return void */ public function mark_as_test() { $this->source->set_is_test( true ); } /** * Save the feedback entry to the database. * * @return int */ public function save() { $post_id = wp_insert_post( array( 'post_type' => self::POST_TYPE, 'post_status' => $this->status, 'post_title' => $this->legacy_feedback_title, 'post_date' => $this->feedback_time, 'post_name' => $this->legacy_feedback_id, 'post_content' => $this->serialize(), // In V3 we started to addslashes. 'post_mime_type' => 'v3', // a way to help us identify what version of the data this is. 'post_parent' => $this->form_id ?? $this->source->get_id(), 'comment_status' => self::STATUS_UNREAD, // New feedback is unread by default. ) ); // Store source post ID as meta for queryable source filtering. $source_id = $this->source->get_id(); if ( is_numeric( $post_id ) && (int) $post_id > 0 && is_numeric( $source_id ) && (int) $source_id > 0 ) { add_post_meta( $post_id, self::SOURCE_META_KEY, (int) $source_id, true ); wp_cache_delete( self::SOURCE_IDS_CACHE_KEY, self::CACHE_GROUP ); } // Flag test submissions with a post meta so the REST collection can // filter them via meta_query without unpacking the serialized source. if ( is_numeric( $post_id ) && (int) $post_id > 0 && $this->source->is_test() ) { add_post_meta( $post_id, self::IS_TEST_META_KEY, 1, true ); } // If this feedback does not have a jetpack_form parent, // it's a classic form — mark the state accordingly. if ( empty( $this->form_id ) ) { Forms_Dashboard::mark_classic_form_detected(); } $feedback_post = get_post( $post_id ); return $feedback_post ?? 0; } /** * Serialize the fields to JSON format. * * @return string */ public function serialize() { $fields_to_serialize = array_merge( array( 'subject' => $this->subject, 'ip' => $this->ip_address, 'country_code' => $this->country_code, 'user_agent' => $this->user_agent, 'form_fill_duration' => $this->form_fill_duration, 'notification_recipients' => $this->notification_recipients, 'logged_in_user' => $this->logged_in_user, ), $this->source->serialize() ); $fields_to_serialize['fields'] = array(); foreach ( $this->fields as $field ) { $fields_to_serialize['fields'][] = $field->serialize(); } // Check if the IP and country_code should be included. if ( apply_filters( 'jetpack_contact_form_forget_ip_address', false, $this->ip_address ) ) { $fields_to_serialize['ip'] = null; $fields_to_serialize['country_code'] = null; } /* * JSON_HEX_TAG escapes every `<` and `>` as a \u003C / \u003E sequence, * which is what keeps this payload intact on the way into the database. * It is load-bearing here, not cosmetic - do not drop it. * * This payload is written to `post_content`, and any submitter without * `unfiltered_html` - every logged-out visitor, and every non-super-admin * on a multisite - has `wp_filter_post_kses` attached to `content_save_pre`. * A bare `<` anywhere in the payload (a field label, a submitted value, or * the source page title) then reads as the start of a tag, and core's * `wp_pre_kses_less_than()` runs esc_html() over everything from that `<` to * the end of the string. The quotes inside it become `"`, so * `json_decode()` can no longer read the payload and the entire response * comes back empty. * * `json_decode()` resolves the escaped sequences natively, so no decode step * is needed and payloads written before this flag was added still parse. * * This deliberately diverges from Jetpack.Functions.JsonEncodeFlags, which * recommends JSON_UNESCAPED_SLASHES alone for database-field writes. That * guidance assumes the write is not KSES-filtered; this one is. */ return addslashes( wp_json_encode( $fields_to_serialize, JSON_UNESCAPED_SLASHES | JSON_HEX_TAG ) ); } /** * Helper function to parse the post content. * * @param string $post_content The post content to parse. * @param string|null $version The version of the content format. * @return array Parsed fields. */ private function parse_content( $post_content = '', $version = null ) { if ( $version === 'v3' ) { $this->uses_structured_fields = true; return $this->parse_content_v3( $post_content ); } if ( $version === 'v2' ) { $this->uses_structured_fields = true; return $this->parse_content_v2( $post_content ); } // Some feedback posts store JSON content without a version marker // (empty post_mime_type). Parse those as the current (v3) format instead // of falling through to the legacy plain-text parser. if ( self::is_json( $post_content ) ) { $decoded_content = json_decode( $post_content, true ); if ( $decoded_content === null ) { // Content may be slash-escaped as stored by WordPress; retry, // mirroring the fallback used by the v2/v3 parsers. $decoded_content = json_decode( stripslashes( trim( $post_content ) ), true ); } if ( isset( $decoded_content['fields'] ) && is_array( $decoded_content['fields'] ) ) { $this->uses_structured_fields = true; return $this->parse_content_v3( $post_content ); } } return $this->parse_legacy_content( $post_content ); } /** * Check whether a string looks like and decodes as valid JSON. * * Accepts slash-escaped JSON (as WordPress may store it), mirroring the * stripslashes fallback used by the v2/v3 parsers. * * @param string $string The string to test. * @return bool True if the string is a JSON object or array. */ private static function is_json( $string ) { if ( ! is_string( $string ) || $string === '' ) { return false; } $string = trim( $string ); if ( ! str_starts_with( $string, '{' ) && ! str_starts_with( $string, '[' ) ) { return false; } $decoded = json_decode( $string ); if ( $decoded !== null && json_last_error() === JSON_ERROR_NONE ) { return true; } $decoded = json_decode( stripslashes( $string ) ); return $decoded !== null && json_last_error() === JSON_ERROR_NONE; } /** * Parse the content in the v2 format. * * V2 Format was a short lived format that accidently contains slash escaped unicode characters. * * @param string $post_content The post content to parse. * * @return array Parsed fields. */ private function parse_content_v2( $post_content = '' ) { $decoded_content = json_decode( $post_content, true ); if ( $decoded_content === null ) { // If JSON decoding still fails, try with stripslashes and trim as a fallback // This is a workaround for some cases where the JSON data is not properly formatted $decoded_content = json_decode( stripslashes( trim( $post_content ) ), true ); } if ( $decoded_content === null ) { // Final fallback: attempt to fix malformed JSON with unescaped quotes // Apply stripslashes first, then fix remaining issues $stripped_content = stripslashes( trim( $post_content ) ); $fixed_content = self::fix_malformed_json( $stripped_content ); $decoded_content = json_decode( $fixed_content, true ); } if ( $decoded_content === null ) { return array(); } $fields = array(); foreach ( $decoded_content['fields'] as $field ) { $feedback_field = Feedback_Field::from_serialized_v2( $field ); if ( $feedback_field instanceof Feedback_Field ) { $fields[ $feedback_field->get_key() ] = $feedback_field; if ( ! $this->has_file && $feedback_field->has_file() ) { $this->has_file = true; } } } $decoded_content['fields'] = $fields; return $decoded_content; } /** * Parse the content in the v3 format. * * @param string $post_content The post content to parse. * * @return array Parsed fields. */ private function parse_content_v3( $post_content = '' ) { $decoded_content = json_decode( $post_content, true ); if ( $decoded_content === null ) { // If JSON decoding fails, try to decode the second try with stripslashes and trim. // This is a workaround for some cases where the JSON data is not properly formatted. $decoded_content = json_decode( stripslashes( trim( $post_content ) ), true ); } if ( $decoded_content === null ) { return array(); } $fields = array(); foreach ( $decoded_content['fields'] as $field ) { $feedback_field = Feedback_Field::from_serialized( $field ); if ( $feedback_field instanceof Feedback_Field ) { $fields[ $feedback_field->get_key() ] = $feedback_field; if ( ! $this->has_file && $feedback_field->has_file() ) { $this->has_file = true; } } } $decoded_content['fields'] = $fields; return $decoded_content; } /** * Parse the legacy content format. * * @param string $post_content The post content to parse. * * @return array Parsed fields. */ private function parse_legacy_content( $post_content = '' ) { $content_parts = $this->split_legacy_content( $post_content ); $comment_content = $content_parts['comment_content']; $field_content = $content_parts['field_content']; $all_values = $this->extract_legacy_values( $field_content ); $lines = $this->extract_legacy_lines( $field_content ); $decoded_fields = array(); $decoded_fields['fields'] = array(); // Process lines for specific field types $this->process_legacy_lines( $lines, $decoded_fields ); // Process all other values $this->process_legacy_values( $all_values, $decoded_fields ); // Add comment content field $this->add_comment_content_field( $comment_content, $decoded_fields ); return $decoded_fields; } /** * Attempt to fix malformed JSON by escaping unescaped quotes in string values. * * This method handles cases where JSON contains unescaped quotes within string values, * which causes json_decode to fail. * * @param string $json malformed JSON string. * @return string The JSON string with escaped quotes. */ public static function fix_malformed_json( $json ) { $find = array(); $replace = array(); // Start of JSON object $find[] = '{\"'; $replace[] = '{"'; // Key-value separator $find[] = '\":\"'; $replace[] = '":"'; $find[] = '\\\"'; $replace[] = '\"'; $find[] = '\":[\"'; $replace[] = '":["'; $find[] = '\"],'; $replace[] = '"],'; $find[] = ',[\"'; $replace[] = ',["'; $find[] = '\",\"'; $replace[] = '","'; $find[] = ',\"'; $replace[] = ',"'; $find[] = '\", \"'; $replace[] = '", "'; $find[] = '\"],\"'; $replace[] = '"],"'; $find[] = '\"],"'; $replace[] = '"],"'; $find[] = '\":[]'; $replace[] = '":[]'; $find[] = '\"]}'; $replace[] = '"]}'; $find[] = '\":['; $replace[] = '":['; $find[] = '\":{'; $replace[] = '":{'; $find[] = '\":true'; $replace[] = '":true'; $find[] = '\":false'; $replace[] = '":false'; $find[] = '\":null'; $replace[] = '":null'; for ( $i = 0; $i <= 9; $i++ ) { $find[] = '\":' . $i; $replace[] = '":' . $i; $find[] = '\",' . $i; $replace[] = '",' . $i; } $find[] = '\",true'; $replace[] = '",true'; $find[] = '\",false'; $replace[] = '",false'; $find[] = '\",null'; $replace[] = '",null'; $find[] = "\'"; $replace[] = "'"; // End of Json object $find[] = '\"}'; $replace[] = '"}'; // Remove any slashes that are there to start a new string. return str_replace( $find, $replace, addslashes( $json ) ); } /** * Split legacy content into comment and field sections. * * @param string $post_content The post content to parse. * @return array Array with 'comment_content' and 'field_content' keys. */ private function split_legacy_content( $post_content ) { $content = explode( '', $post_content ); $comment_content = ''; $field_content = ''; if ( count( $content ) > 1 ) { $comment_content = $content[0]; $field_content = str_ireplace( array( '
', ')

' ), '', $content[1] ); } return array( 'comment_content' => $comment_content, 'field_content' => $field_content, ); } /** * Extract values from legacy field content. * * @param string $field_content The field content to parse. * @return array Extracted values. */ private function extract_legacy_values( $field_content ) { $all_values = array(); if ( str_contains( $field_content, 'JSON_DATA' ) ) { $all_values = $this->parse_json_data( $field_content ); } else { $all_values = $this->parse_array_format( $field_content ); } // Ensure all_values is always an array if ( ! is_array( $all_values ) ) { $all_values = array(); } return $all_values; } /** * Extract lines from legacy field content. * * @param string $field_content The field content to parse. * @return array Filtered lines. */ private function extract_legacy_lines( $field_content ) { if ( str_contains( $field_content, 'JSON_DATA' ) ) { $chunks = explode( "\nJSON_DATA", $field_content ); return array_filter( explode( "\n", $chunks[0] ) ); } else { return array_filter( explode( "\n", $field_content ) ); } } /** * Parse JSON data from field content. * * @param string $field_content The field content containing JSON data. * @return array Parsed JSON data. */ private function parse_json_data( $field_content ) { $chunks = explode( "\nJSON_DATA", $field_content ); if ( ! isset( $chunks[1] ) ) { // Try with 'JSON_DATA' without the newline as a fallback. $chunks = explode( 'JSON_DATA', $field_content ); if ( ! isset( $chunks[1] ) ) { // If JSON_DATA is still not found, return an empty array. return array(); } } $json_data = $chunks[1]; $all_values = json_decode( $json_data, true ); if ( $all_values === null ) { // Fallback for improperly formatted JSON $all_values = json_decode( stripslashes( trim( $json_data ) ), true ); } return $all_values === null ? array() : $all_values; } /** * Parse array format from field content. * * @param string $field_content The field content in array format. * @return array Parsed array data. */ private function parse_array_format( $field_content ) { $fields_array = preg_replace( '/.*Array\s\( (.*)\)/msx', '$1', $field_content ); // Parse key-value pairs formatted as [Key] => Value preg_match_all( '/^\s*\[([^\]]+)\] =\>\; (.*)(?=^\s*(\[[^\]]+\] =\>\;)|\z)/msU', $fields_array, $matches ); if ( count( $matches ) > 1 ) { return array_combine( array_map( 'trim', $matches[1] ), array_map( 'trim', $matches[2] ) ); } return array(); } /** * Process legacy lines into field objects. * * We do this so that we can extract specific fields but we don't display the values in the UI. * * @param array $lines The lines to process. * @param array &$decoded_fields Reference to the decoded fields array. */ private function process_legacy_lines( $lines, &$decoded_fields ) { $var_map = array( 'AUTHOR' => array( 'type' => 'name', 'label' => 'Author', ), 'AUTHOR EMAIL' => array( 'type' => 'email', 'label' => 'Email', ), 'AUTHOR URL' => array( 'type' => 'url', 'label' => 'Url', ), 'SUBJECT' => array( 'type' => 'subject', 'label' => 'Subject', ), 'IP' => array( 'type' => 'ip', 'label' => 'IP', ), ); foreach ( $lines as $line ) { $line_parts = explode( ': ', $line, 2 ); if ( count( $line_parts ) !== 2 ) { continue; } list( $key, $value ) = $line_parts; if ( ! empty( $key ) && isset( $var_map[ $key ] ) ) { $map_to_field = $var_map[ $key ]; $value = Contact_Form_Plugin::strip_tags( trim( $value ) ); $decoded_fields['fields'][ $key ] = new Feedback_Field( $key, $map_to_field['label'], $value, $map_to_field['type'], array( 'render' => false ) ); } } } /** * Check if the field is a legacy file upload. * * @param array $field The field to check. * * @return bool True if it's a legacy file upload, false otherwise. */ private function is_legacy_file_upload( $field ) { return ( is_array( $field ) && ! empty( $field['field_id'] ) && isset( $field['files'] ) && is_array( $field['files'] ) ); } /** * Process legacy values into field objects. * * @param array $all_values The values to process. * @param array &$decoded_fields Reference to the decoded fields array. */ private function process_legacy_values( $all_values, &$decoded_fields ) { $non_user_fields = array( 'email_marketing_consent', 'entry_title', 'entry_permalink', 'entry_page', 'feedback_id', ); foreach ( $all_values as $key => $value ) { $key = wp_strip_all_tags( $key ); $label = self::extract_label_from_key( $key ); if ( in_array( $key, $non_user_fields, true ) ) { if ( $key === 'email_marketing_consent' ) { $decoded_fields['fields'][ $key ] = new Feedback_Field( $key, $label, $value, 'consent', array( 'render' => false ) ); continue; } $decoded_fields[ $key ] = $value; continue; } // check for file upload data and then set it as a file type field. if ( $this->is_legacy_file_upload( $value ) ) { // If the value is a file upload, we need to handle it differently. $decoded_fields['fields'][ $key ] = new Feedback_Field( $key, $label, $value, 'file' ); $this->has_file = ! empty( $value['files'] ); // Set has_file to true if any file upload is found. } else { $decoded_fields['fields'][ $key ] = new Feedback_Field( $key, $label, $value ); } } } /** * Add comment content as a field. * * @param string $comment_content The comment content. * @param array &$decoded_fields Reference to the decoded fields array. */ private function add_comment_content_field( $comment_content, &$decoded_fields ) { $decoded_fields['fields']['comment_content'] = new Feedback_Field( 'comment_content', 'Comment Content', trim( Contact_Form_Plugin::strip_tags( $comment_content ) ), 'textarea', array( 'render' => false ) ); } /** * Extract the label from a key that might be in the format "1_label". * * @param string $key The key to extract the label from. * @return string The extracted label. */ private static function extract_label_from_key( $key ) { // Check if the key starts with a number followed by underscore and has content after underscore if ( preg_match( '/^\d+_(.+)$/', $key, $matches ) ) { return $matches[1]; } // If the key is just a number followed by underscore (like "2_"), return empty string if ( preg_match( '/^\d+_$/', $key ) ) { return ''; } // If the key doesn't start with a number followed by underscore, return the key as is return $key; } /** * Get field-specific metadata based on the field type. * * @param Contact_Form_Field $field The field object. * @param string $type The field type. * @return array Metadata array for the field. */ public static function get_field_meta( $field, $type ) { $meta = array(); if ( $type === 'rating' ) { $icon_style = $field->get_attribute( 'iconstyle' ); $max = $field->get_attribute( 'max' ); $meta['iconStyle'] = ! empty( $icon_style ) ? $icon_style : 'stars'; $meta['maxRating'] = is_numeric( $max ) && (int) $max > 0 ? (int) $max : 5; } return $meta; } /** * Get all the fields of the response, computed from the post data. * * @param array $post_data The post data from the form submission. * @param Contact_Form $form The form object. * @return array An array of Feedback_Field objects. */ private function get_computed_fields( $post_data, $form ) { $fields = array(); $field_ids = $form->get_field_ids(); // Collect renderable fields and their submitted values up front so conditional logic // rules (which may reference any sibling field) can be evaluated in the loop below. $renderable = array(); $form_values = array(); foreach ( $field_ids['all'] as $field_id ) { $field = $form->fields[ $field_id ]; $type = $field->get_attribute( 'type' ); if ( ! $field->is_field_renderable( $type ) ) { continue; } $value = $this->get_field_value( $field_id, $post_data, $type ); $form_values[ $field_id ] = $value; $renderable[ $field_id ] = array( 'field' => $field, 'type' => $type, 'value' => $value, ); } // Ask the form, rather than resolving a second time. // // Storage used to run its own resolve_visibility() over a different value source and a // different field set than validation did, and the two disagreed. Validation reads // get_computed_field_value() -- POST, then GET, then the field's default, then the // logged-in user -- while this loop reads POST only; and it skips anything // is_field_renderable() rejects, so a rule whose subject is an option-less select was // evaluated during validation and ignored here. // // Unchecking a consent field prefilled from a query argument hit both: the browser // posts nothing, validation fell back to the query argument and read it checked, // storage read '' and read it unchecked. The dependent field was required-validated // and then had its answer dropped -- the silently discarded answer this feature is // supposed to make impossible. // // Returns an empty array when conditional logic does not apply, so there is nothing extra to guard. $visibility = $form->get_resolved_field_visibility(); $i = 1; foreach ( $renderable as $field_id => $entry ) { $field = $entry['field']; $type = $entry['type']; $value = $entry['value']; if ( isset( $visibility[ $field_id ] ) && false === $visibility[ $field_id ] ) { continue; } $label = wp_strip_all_tags( $field->get_attribute( 'label' ) ); $key = $i . '_' . $label; $meta = self::get_field_meta( $field, $type ); // Process radio fields to detect and extract "Other" option metadata if ( $type === 'radio' ) { $processed = $this->process_radio_field_value( $value, $field, $field_id, $post_data ); $value = $processed['value']; $meta = array_merge( $meta, $processed['meta'] ); } $fields[ $key ] = new Feedback_Field( $key, $label, $value, $type, $meta, $field_id ); if ( ! $this->has_file && $fields[ $key ]->has_file() ) { $this->has_file = true; } ++$i; } return $fields; } /** * Gets the computed subject. * * @param array $post_data The post data from the form submission. * @param Contact_Form $form The form object. * @return string */ private function get_computed_subject( $post_data, $form ) { $contact_form_subject = $form->get_attribute( 'subject' ); $field_ids = $form->get_field_ids(); if ( isset( $field_ids['subject'] ) ) { $value = $this->get_field_value( $field_ids['subject'], $post_data ); if ( ! empty( $value ) ) { $contact_form_subject = $value; } } return apply_filters( 'contact_form_subject', $contact_form_subject, $this->get_all_values() ); } /** * Gets the computed comment content. * * @param array $post_data The post data from the form submission. * @param Contact_Form $form The form object. * @return string */ private function get_computed_comment_content( $post_data, $form ) { $field_ids = $form->get_field_ids(); if ( isset( $field_ids['textarea'] ) ) { $value = $this->get_field_value( $field_ids['textarea'], $post_data ); if ( is_string( $value ) ) { return trim( Contact_Form_Plugin::strip_tags( stripslashes( $value ) ) ); } } return ''; } /** * Gets the computed consent. * * @param array $post_data The post data from the form submission. * @param Contact_Form $form The form object. * @return bool */ private function get_computed_consent( $post_data, $form ) { $field_ids = $form->get_field_ids(); if ( isset( $field_ids['email_marketing_consent_field'] ) && $field_ids['email_marketing_consent_field'] !== null ) { return (bool) $this->get_field_value( $field_ids['email_marketing_consent_field'], $post_data ); } return false; } /** * Gets the computed form fill duration, in seconds. * * The value is supplied by the view script as a hidden field, so it is submitter-controlled * and cannot be trusted. Anything that is not a plain sequence of digits is treated as * unknown and stored as null, rather than being coerced into a number that would read as a * real measurement: `absint()` alone would turn "abc" into 0 (indistinguishable from a * genuine sub-second fill), "-1" into 1, and a value past PHP_INT_MAX into a float, which * would contradict the integer type the REST schema advertises. * * The value is left empty when the submitter never interacted with the form, or ran without * JavaScript, which is also an unknown duration. * * @since 7.24.0 * * @param array $post_data The post data from the form submission. * @return int|null */ private function get_computed_form_fill_duration( $post_data ) { if ( ! isset( $post_data[ self::FORM_FILL_DURATION_FIELD ] ) ) { return null; } $raw = $post_data[ self::FORM_FILL_DURATION_FIELD ]; // is_scalar() has to come first so an array-shaped POST does not blow up on the cast. if ( ! is_scalar( $raw ) || ! ctype_digit( (string) $raw ) ) { return null; } // Clamp so an abandoned tab left open for days cannot skew aggregates. return min( (int) $raw, DAY_IN_SECONDS ); } /** * Gets the computed notification recipients. * * @since 6.10.0 * * @param array $post_data The post data from the form submission. * @param Contact_Form $form The form object. * @return array */ private function get_computed_notification_recipients( $post_data, $form ) { $notification_recipients = $form->get_attribute( 'notificationRecipients' ); return $this->validate_notification_recipients( $notification_recipients ); } /** * Validates notification recipients have proper capabilities. * * Ensures each user ID corresponds to a real user with edit_posts or edit_pages capability. * Filters out invalid or unauthorized user IDs. * * @since 6.10.0 * * @param array $recipients Array of user IDs. * @return array Array of validated user IDs. */ private function validate_notification_recipients( $recipients ) { if ( ! is_array( $recipients ) ) { return array(); } $valid_recipients = array(); foreach ( $recipients as $user_id ) { $user = get_userdata( $user_id ); // Only allow users with edit_posts or edit_pages capability if ( $user && ( $user->has_cap( 'edit_posts' ) || $user->has_cap( 'edit_pages' ) ) ) { $valid_recipients[] = $user_id; } } return $valid_recipients; } /** * Get a field by its original form ID. * * @since 5.5.0 * * @param string $id Original form field ID. * @return Feedback_Field|null */ public function get_field_by_form_field_id( $id ) { if ( ! is_string( $id ) || $id === '' ) { return null; } foreach ( $this->fields as $field ) { if ( $field->get_form_field_id() === $id ) { return $field; } } return null; } /** * Get a field render value by its original form ID. * * @since 5.5.0 * * @param string $id Original form field ID. * @param string $context Render context. * @return string */ public function get_field_value_by_form_field_id( $id, $context = 'default' ) { $field = $this->get_field_by_form_field_id( $id ); if ( ! $field ) { return ''; } return (string) $field->get_render_value( $context ); } }