' . implode( '
', $compiled_form ) . '
'; } @@ -842,13 +850,17 @@ public static function success_message( $feedback_id, $form ) { * Returns a compiled form with labels and values in a form of an array * of lines. * - * @param int $feedback_id - the feedback ID. - * @param Contact_Form $form - the form. + * @param int $feedback_id - the feedback ID. + * @param Contact_Form|null $form - the contact form object. This parameter is deprecated and no longer used. * * @return array $lines */ - public static function get_compiled_form( $feedback_id, $form ) { - $compiled_form = self::get_raw_compiled_form_data( $feedback_id, $form ); + public static function get_compiled_form( $feedback_id, $form = null ) { + if ( $form ) { + // you are doing it wrong, the $form parameter is deprecated and no longer used + _deprecated_argument( __METHOD__, '$$next-version$$', 'The $form parameter is deprecated and no longer used.' ); + } + $compiled_form = self::get_raw_compiled_form_data( $feedback_id ); foreach ( $compiled_form as $field_index => $data ) { $safe_display_value = self::escape_and_sanitize_field_value( $data['value'] ); @@ -882,138 +894,35 @@ public static function get_compiled_form( $feedback_id, $form ) { /** * Returns the JSON data for the form submission. * - * @param int $feedback_id - the feedback ID. - * @param Contact_Form $form - the form. + * @param int $feedback_id - the feedback ID. + * @param Contact_Form|null $form - the contact form object. This parameter is deprecated and no longer used. * * @return array $json_data */ - public static function get_json_data( $feedback_id, $form ) { - $raw_data = self::get_raw_compiled_form_data( $feedback_id, $form ); - $json_data = array(); - - // Handle file upload field (new structure with field_id and files array) - foreach ( $raw_data as $field_data ) { - $value = $field_data['value']; - $label = $field_data['label']; - - if ( self::is_file_upload_field( $value ) ) { - $files = $value['files']; - - if ( empty( $files ) ) { - continue; - } - - foreach ( $files as $file ) { - if ( ! empty( $file['file_id'] ) ) { - $file_name = isset( $file['name'] ) ? $file['name'] : __( 'Attached file', 'jetpack-forms' ); - $file_size = isset( $file['size'] ) ? size_format( $file['size'] ) : ''; - - $json_data[] = array( - 'label' => $label, - 'value' => array( - 'name' => $file_name, - 'size' => $file_size, - ), - ); - } - } - } else { - $json_data[] = array( - 'label' => $label, - 'value' => $value, - ); - } + public static function get_json_data( $feedback_id, $form = null ) { + if ( $form ) { + // you are doing it wrong, the $form parameter is deprecated and no longer used + _deprecated_argument( __METHOD__, '$$next-version$$', 'The $form parameter is deprecated and no longer used.' ); } - - return $json_data; + $response = Feedback::get( $feedback_id ); + return $response->get_compiled_fields( 'ajax', 'label|value' ); } /** * Retrieves raw compiled form data. * - * @param int $feedback_id - the feedback ID. - * @param Contact_Form $form - the form. + * @param int $feedback_id - the feedback ID. + * @param Contact_Form|null $form - the contact form object. This parameter is deprecated and no longer used. * * @return array $raw_data Associative array where keys are field_index and values are arrays with 'label' and 'value'. */ - private static function get_raw_compiled_form_data( $feedback_id, $form ) { - $feedback = get_post( $feedback_id ); - $field_ids = $form->get_field_ids(); - $content_fields = Contact_Form_Plugin::parse_fields_from_content( $feedback_id ); - - // Maps field_ids to post_meta keys - $field_value_map = array( - 'name' => 'author', - 'email' => 'author_email', - 'url' => 'author_url', - 'subject' => 'subject', - 'textarea' => false, // not a post_meta key. This is stored in post_content - ); - - $raw_data = array(); - - // "Standard" field allowed list. - foreach ( $field_value_map as $type => $meta_key ) { - if ( isset( $field_ids[ $type ] ) ) { - $field = $form->fields[ $field_ids[ $type ] ]; - $value = null; - - if ( $meta_key ) { - if ( isset( $content_fields[ "_feedback_{$meta_key}" ] ) ) { - if ( 'name' === $type ) { - // If a form contains both email and name fields but the user doesn't provide a name, we don't need to show the name field - // in the success message after submision. We have this specific check because in the above case the `author` field gets - // a fallback value of the provided email and is used in the backend in various places. - if ( isset( $content_fields['_feedback_author_email'] ) && $content_fields['_feedback_author'] === $content_fields['_feedback_author_email'] ) { - continue; - } - } - $value = $content_fields[ "_feedback_{$meta_key}" ]; - } - } else { - // The feedback content is stored as the first "half" of post_content - $current_value = ( is_object( $feedback ) && is_a( $feedback, '\WP_Post' ) ) ? - $feedback->post_content : ''; - list( $current_value ) = explode( '', $current_value ); - $value = trim( $current_value ); - } - - $field_index = array_search( $field_ids[ $type ], $field_ids['all'], true ); - $field_label = $field->get_attribute( 'label' ); - - $raw_data[ $field_index ] = array( - 'label' => $field_label, - 'value' => $value, - ); - } - } - - // "Non-standard" fields - if ( $field_ids['extra'] ) { - // array indexed by field label (not field id) - $extra_fields = get_post_meta( $feedback_id, '_feedback_extra_fields', true ); - /** - * Only get data for the compiled form if `$extra_fields` is a valid and non-empty array. - */ - if ( is_array( $extra_fields ) && ! empty( $extra_fields ) ) { - - $extra_field_keys = array_keys( $extra_fields ); - - $i = 0; - foreach ( $field_ids['extra'] as $field_id ) { - $field = $form->fields[ $field_id ]; - $field_index = array_search( $field_id, $field_ids['all'], true ); - $field_label = $field->get_attribute( 'label' ); - $value = isset( $extra_field_keys[ $i ] ) && isset( $extra_fields[ $extra_field_keys[ $i ] ] ) ? $extra_fields[ $extra_field_keys[ $i ] ] : ''; - $raw_data[ $field_index ] = array( - 'label' => $field_label, - 'value' => $value, - ); - ++$i; - } - } + private static function get_raw_compiled_form_data( $feedback_id, $form = null ) { + if ( $form ) { + // you are doing it wring, the $form parameter is deprecated and no longer used. + _deprecated_argument( __METHOD__, '$$next-version$$', 'The $form parameter is deprecated and no longer used.' ); } - return $raw_data; + $response = Feedback::get( $feedback_id ); + return $response->get_compiled_fields(); } /** @@ -1026,7 +935,7 @@ private static function get_raw_compiled_form_data( $feedback_id, $form ) { * @return array $lines */ public static function get_compiled_form_for_email( $feedback_id, $form ) { - $compiled_form = self::get_raw_compiled_form_data( $feedback_id, $form ); + $compiled_form = self::get_raw_compiled_form_data( $feedback_id ); /** * This filter allows a site owner to customize the response to be emailed, by adding their own HTML around it for example. @@ -1415,7 +1324,8 @@ public function get_field_ids() { ); // Initialize marketing consent - $field_ids['email_marketing_consent'] = null; + $field_ids['email_marketing_consent'] = null; + $field_ids['email_marketing_consent_field'] = null; foreach ( $this->fields as $id => $field ) { $type = $field->get_attribute( 'type' ); @@ -1448,6 +1358,7 @@ public function get_field_ids() { case 'consent': // Set email marketing consent for the first Consent type field if ( null === $field_ids['email_marketing_consent'] ) { + $field_ids['email_marketing_consent_field'] = $id; if ( $field->value ) { $field_ids['email_marketing_consent'] = true; } else { @@ -2149,7 +2060,7 @@ public function process_submission() { echo wp_json_encode( array( 'success' => true, - 'data' => self::get_json_data( $post_id, $this ), + 'data' => self::get_json_data( $post_id ), 'refreshArgs' => $refresh_args, ) ); diff --git a/projects/packages/forms/src/contact-form/class-feedback-author.php b/projects/packages/forms/src/contact-form/class-feedback-author.php new file mode 100644 index 0000000000000..25d0614fd5721 --- /dev/null +++ b/projects/packages/forms/src/contact-form/class-feedback-author.php @@ -0,0 +1,148 @@ +name = $name; + $this->email = $email; + $this->url = $url; + } + + /** + * Create a Feedback_Author instance from the submission data. + * + * @param array $post_data The post data from the form submission. + * @param Contact_Form $form The form object. + * @return Feedback_Author The Feedback_Author instance. + */ + public static function from_submission( $post_data, $form ) { + return new self( + self::get_computed_author_info( $post_data, 'name', 'pre_comment_author_name', $form ), + self::get_computed_author_info( $post_data, 'email', 'pre_comment_author_email', $form ), + self::get_computed_author_info( $post_data, 'url', 'pre_comment_author_url', $form ) + ); + } + + /** + * Gets the computed author. + * + * @param array $post_data The post data from the form submission. + * @param string $type The type of author information to retrieve (e.g., 'name', 'email', 'url'). + * @param string $filter Optional filter to apply to the value. + * @param Contact_Form $form The form object. + * + * @return string Filter value for the author information. + */ + private static function get_computed_author_info( $post_data, $type, $filter, $form ) { + $field_ids = $form->get_field_ids(); + if ( isset( $field_ids[ $type ] ) ) { + $key = $field_ids[ $type ]; + $value = isset( $post_data[ $key ] ) ? sanitize_text_field( wp_unslash( $post_data[ $key ] ) ) : ''; + if ( is_string( $value ) ) { + return Contact_Form_Plugin::strip_tags( + stripslashes( + /** + * + * Listed to help search find the filters. + * apply_filters( ''pre_comment_author_name', $value ) + * apply_filters( ''pre_comment_author_email', $value ) + * apply_filters( ''pre_comment_author_url', $value ) + */ + apply_filters( $filter, addslashes( $value ) ) + ) + ); + + } + } + return ''; + } + + /** + * Get the display name of the author. + * + * If the name is not set, it will return the email. + * + * @return string The display name of the author. + */ + public function get_display_name(): string { + return empty( $this->name ) ? $this->email : $this->name; + } + + /** + * Get the avatar URL of the author. + * + * If the email is not set, it will return an empty string. + * + * @return string The avatar URL of the author. + */ + public function get_avatar_url(): string { + return ! empty( $this->email ) ? get_avatar_url( $this->email ) : ''; + } + + /** + * Get the name of the author. + * + * @return string The name of the author. + */ + public function get_name() { + return $this->name; + } + + /** + * Get the email of the author. + * + * @return string The email of the author. + */ + public function get_email() { + return $this->email; + } + + /** + * Get the URL of the author. + * + * @return string The URL of the author. + */ + public function get_url() { + return $this->url; + } +} diff --git a/projects/packages/forms/src/contact-form/class-feedback-entry.php b/projects/packages/forms/src/contact-form/class-feedback-entry.php new file mode 100644 index 0000000000000..e7d2b7b0a1d47 --- /dev/null +++ b/projects/packages/forms/src/contact-form/class-feedback-entry.php @@ -0,0 +1,151 @@ +id = $id > 0 ? (int) $id : 0; + $this->title = $title; + $this->page_number = $page_number; + $this->permalink = ''; + + if ( $id <= 0 ) { + return; + } + + $entry_post = get_post( $id ); + + if ( $entry_post && $entry_post->post_status === 'publish' ) { + $this->permalink = get_permalink( $entry_post ); + $this->title = get_the_title( $entry_post ); + } + } + + /** + * Creates a Feedback_Entry instance from a submission. + * + * @param \WP_Post|null $current_post The current post object. + * @param int $current_page_number The current page number, default is 1. + * @return Feedback_Entry Returns an instance of Feedback_Entry. + */ + public static function from_submission( $current_post, int $current_page_number = 1 ) { + $id = isset( $current_post->ID ) ? (int) $current_post->ID : 0; + + if ( ! $current_post instanceof \WP_Post || $id === 0 ) { + return new self( 0, '', $current_page_number ); + } + + $title = $current_post->post_title ?? ''; + + return new self( $id, $title, $current_page_number ); + } + + /** + * Get the permalink of the feedback entry. + * + * @return string The permalink of the feedback entry. + */ + public function get_permalink() { + if ( $this->page_number > 1 && ! empty( $this->permalink ) ) { + return add_query_arg( 'page', $this->page_number, $this->permalink ); + } + return $this->permalink; + } + + /** + * Get the relative permalink of the feedback entry. + * + * @return string The relative permalink of the feedback entry. + */ + public function get_relative_permalink() { + if ( ! empty( $this->permalink ) ) { + return wp_make_link_relative( $this->get_permalink() ); + } + return ''; + } + + /** + * Get the page number of the feedback entry. + * + * @return int The page number of the feedback entry. + */ + public function get_page_number() { + return $this->page_number; + } + /** + * Get the title of the feedback entry. + * + * @return string The title of the feedback entry. + */ + public function get_title() { + return $this->title; + } + /** + * Get the post id of the feedback entry. + * + * @return int The ID of the feedback entry. + */ + public function get_id() { + return $this->id; + } + + /** + * Get the page number of the enrty title. + * + * @return array + */ + public function serialize() { + return array( + 'entry_title' => $this->title, + 'entry_page' => $this->page_number, + ); + } +} diff --git a/projects/packages/forms/src/contact-form/class-feedback-field.php b/projects/packages/forms/src/contact-form/class-feedback-field.php new file mode 100644 index 0000000000000..f78f700f77aab --- /dev/null +++ b/projects/packages/forms/src/contact-form/class-feedback-field.php @@ -0,0 +1,285 @@ +key = $key; + $this->label = mb_convert_encoding( $label, 'UTF-8', 'HTML-ENTITIES' ); + $this->value = $value; + $this->type = $type; + $this->meta = $meta; + } + + /** + * Get the value of the field. + * + * @return string + */ + public function get_key() { + return $this->key; + } + + /** + * Get the label of the field. + * + * @return string + */ + public function get_label() { + return $this->label; + } + + /** + * Get the value of the field. + * + * @return mixed + */ + public function get_value() { + return $this->value; + } + + /** + * Get the value of the field for rendering. + * + * @param string $context The context in which the value is being rendered (default is 'default'). + * + * @return string + */ + public function get_render_value( $context = 'default' ) { + switch ( $context ) { + case 'api': + return $this->get_render_api_value(); + case 'default': + default: + return $this->get_render_default_value(); + } + } + + /** + * Get the default value of the field for rendering. + * + * @return string + */ + private function get_render_default_value() { + if ( $this->is_of_type( 'file' ) ) { + $files = array(); + foreach ( $this->value['files'] as &$file ) { + if ( ! isset( $file['size'] ) || ! isset( $file['file_id'] ) ) { + // this shouldn't happen, todo: log this + continue; + } + $file_name = $file['name'] ?? __( 'Attached file', 'jetpack-forms' ); + $file_size = isset( $file['size'] ) ? size_format( $file['size'] ) : ''; + $files[] = $file_name . ' (' . $file_size . ')'; + } + return implode( ', ', $files ); + } + + if ( is_array( $this->value ) ) { + return implode( ', ', $this->value ); + } + + return $this->value; + } + + /** + * Get the value of the field for the API. + * + * @return string + */ + private function get_render_api_value() { + + if ( $this->is_of_type( 'file' ) ) { + $files = array(); + foreach ( $this->value['files'] as &$file ) { + if ( ! isset( $file['size'] ) || ! isset( $file['file_id'] ) ) { + // this shouldn't happen, todo: log this + continue; + } + $file_id = absint( $file['file_id'] ); + $file['file_id'] = $file_id; + $file['size'] = size_format( $file['size'] ); + $file['url'] = apply_filters( 'jetpack_unauth_file_download_url', '', $file_id ); + $file['is_previewable'] = $this->is_previewable_file( $file ); + $files[] = $file; + } + $this->value['files'] = $files; + return $this->value; + } + + if ( is_array( $this->value ) ) { + // If the value is an array, we can return it as a JSON string. + return implode( ', ', $this->value ); + } + // This method is deprecated, use render_value instead. + return $this->value; + } + /** + * Check if the field is of a specific type. + * + * @param string $type The type to check against. + * + * @return bool True if the field is of the specified type, false otherwise. + */ + public function is_of_type( $type ) { + return $this->type === $type; + } + + /** + * Check if the field should be compiled. + * + * @return bool + */ + public function compile_field() { + return $this->get_meta_key_value( 'render' ) === false; + } + + /** + * Get the type of the field. + * + * @return string + */ + public function get_type() { + return $this->type; + } + + /** + * Get the meta array of the field. + * + * @return array + */ + public function get_meta() { + return $this->meta; + } + + /** + * Get a specific meta value by key. + * + * @param string $meta_key The key of the meta to retrieve. + * + * @return mixed|null Returns the value of the meta key if it exists, null otherwise. + */ + public function get_meta_key_value( $meta_key ) { + if ( isset( $this->meta[ $meta_key ] ) ) { + return $this->meta[ $meta_key ]; + } + return null; + } + + /** + * Get the serialized representation of the field. + * + * @return array + */ + public function serialize() { + return array( + 'key' => $this->get_key(), + 'label' => $this->get_label(), + 'value' => $this->get_value(), + 'type' => $this->get_type(), + 'meta' => $this->get_meta(), + ); + } + /** + * Create a Feedback_Field object from serialized data. + * + * @param array $data The serialized data. + * + * @return Feedback_Field|null Returns a Feedback_Field object or null if the data is invalid. + */ + public static function from_serialized( $data ) { + if ( ! is_array( $data ) || ! isset( $data['key'] ) || ! isset( $data['value'] ) || ! isset( $data['label'] ) ) { + return null; + } + + return new self( + $data['key'], + $data['label'], + $data['value'], + $data['type'] ?? 'basic', + $data['meta'] ?? array() + ); + } + + /** + * Check if the field has a file + * + * @return bool + */ + public function has_file() { + if ( $this->is_of_type( 'file' ) ) { + return count( $this->value['files'] ) > 0; + } + + return false; + } + + /** + * Checks if the file is previewable based on its type or extension. + * + * @param array $file File data. + * @return bool True if the file is previewable, false otherwise. + */ + private function is_previewable_file( $file ) { + $file_type = strtolower( pathinfo( $file['name'], PATHINFO_EXTENSION ) ); + // Check if the file is previewable based on its type or extension. + // Note: This is a simplified check and does not match if the file is allowed to be uploaded by the server. + $previewable_types = array( 'jpg', 'jpeg', 'png', 'gif', 'webp' ); + return in_array( $file_type, $previewable_types, true ); + } +} diff --git a/projects/packages/forms/src/contact-form/class-feedback.php b/projects/packages/forms/src/contact-form/class-feedback.php new file mode 100644 index 0000000000000..999d47eaf475e --- /dev/null +++ b/projects/packages/forms/src/contact-form/class-feedback.php @@ -0,0 +1,1030 @@ +post_type ) { + return null; + } + + $instance = new self(); + $instance->load_from_post( $feedback_post ); + return $instance; + } + + /** + * 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->status = $feedback_post->post_status; + $this->legacy_feedback_id = $feedback_post->post_name; + $this->feedback_time = $feedback_post->post_date; + + $this->fields = $parsed_content['fields'] ?? array(); + + $this->entry = new Feedback_Entry( + $feedback_post->post_parent, + $parsed_content['entry_title'] ?? '', + $parsed_content['entry_page'] ?? 1 + ); + + $this->ip_address = $parsed_content['ip'] ?? $this->get_first_field_of_type( 'ip' ); + $this->subject = $parsed_content['subject'] ?? $this->get_first_field_of_type( 'subject' ); + + $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->comment_content = $this->get_first_field_of_type( 'textarea' ); + $this->has_consent = ( $this->get_first_field_of_type( 'consent' ) === 'Yes' ); + + $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; + } + + /** + * 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 ) { + + $this->entry = Feedback_Entry::from_submission( $current_post, $current_page_number ); + // 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->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->feedback_time = current_time( 'mysql' ); + $this->legacy_feedback_title = "{$this->get_author()} - {$this->feedback_time}"; + $this->legacy_feedback_id = md5( $this->legacy_feedback_title ); + } + + /** + * 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. + * + * @return string|array The sanitized value, or an empty string if the key is not found. + */ + private function get_field_value( $key, $post_data ) { + if ( isset( $post_data[ $key ] ) ) { + if ( is_array( $post_data[ $key ] ) ) { + return array_map( 'sanitize_text_field', wp_unslash( $post_data[ $key ] ) ); + } else { + return sanitize_text_field( wp_unslash( $post_data[ $key ] ) ); + } + } + return ''; + } + + /** + * 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() === $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; + } + + /** + * Get the values related to where the form was submitted from. + * + * @return array An array of entry values. + */ + private 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, + 'entry_title' => $this->entry->get_title(), + 'entry_permalink' => $this->entry->get_permalink(), + 'feedback_id' => $this->legacy_feedback_id, + ); + + if ( $this->entry->get_page_number() > 1 ) { + $entry_values['entry_page'] = $this->entry->get_page_number(); + } + return $entry_values; + } + + /** + * Get all values of the response. + * + * @return array An array of all values, including fields and entry values. + */ + public function get_all_values() { + // This is a legacy method to maintain compatibility with older code. + return array_merge( $this->get_compiled_fields( 'default', 'key-value' ), $this->get_entry_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(); + foreach ( $this->fields as $field ) { + if ( $field->compile_field( $context ) ) { + continue; // Skip fields that are not meant to be rendered. + } + + // Compile the field based on the requested shape. + switch ( $array_shape ) { + case 'all': + $compiled_fields[ $field->get_key() ] = array( + 'label' => $field->get_label( $context ), + 'value' => $field->get_render_value( $context ), + ); + break; + case 'label|value': + $compiled_fields[] = array( + 'label' => $field->get_label( $context ), + 'value' => $field->get_render_value( $context ), + ); + break; + case 'value': + $compiled_fields[] = $field->get_render_value( $context ); + break; + case 'label': + $compiled_fields[] = $field->get_label( $context ); + break; + case 'key-value': + $compiled_fields[ $field->get_key() ] = $field->get_render_value( $context ); + 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(), + ); + + 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' ), 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 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 email subject. + * + * @return string + */ + public function get_subject() { + return $this->subject; + } + + /** + * 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; + } + + /** + * 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|null + */ + public function get_entry_id() { + return $this->entry->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->entry->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->entry->get_permalink(); + } + /** + * Get the short permalink of a post. + * + * @return string + */ + public function get_entry_short_permalink() { + return $this->entry->get_relative_permalink(); + } + /** + * 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(), + 'post_mime_type' => 'v2', // a way to help us identify what version of the data this is. + 'post_parent' => $this->entry->get_id(), + ) + ); + + $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, + ), + $this->entry->serialize() + ); + + $fields_to_serialize['fields'] = array(); + foreach ( $this->fields as $field ) { + $fields_to_serialize['fields'][] = $field->serialize(); + } + + // Check if the IP should be included. + if ( apply_filters( 'jetpack_contact_form_forget_ip_address', false, $this->ip_address ) ) { + $fields_to_serialize['ip'] = null; + } + + return wp_json_encode( $fields_to_serialize ); + } + + /** + * 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 === 'v2' ) { + return $this->parse_content_v2( $post_content ); + } + return $this->parse_legacy_content( $post_content ); + } + + /** + * Parse the content in the v2 format. + * + * @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 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 ) { + $fields[ $field['key'] ] = Feedback_Field::from_serialized( $field ); + if ( ! $this->has_file && $fields[ $field['key'] ]->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; + } + + /** + * 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( 'This is a test with emphasis and links.
'; + $result = Contact_Form_Plugin::strip_tags( $input ); + + // wp_kses_post should preserve these tags - let's just verify we get a non-empty string with HTML + $this->assertNotEquals( '', $result ); + $this->assertStringContainsString( 'This is a', $result ); + $this->assertStringContainsString( 'test', $result ); + } + + /** + * Test that strip_tags removes dangerous HTML tags. + */ + public function test_strip_tags_removes_dangerous_html() { + $input = 'Hello world'; + $result = Contact_Form_Plugin::strip_tags( $input ); + + // These dangerous tags should be removed, but content might remain + $this->assertStringNotContainsString( '