isset( $_GET[ self::LOCATIONS_QUERY_ARG ] ) || ! wpforms_debug() ) { return; } if ( $_GET[ self::LOCATIONS_QUERY_ARG ] === 'delete' ) { $this->delete(); } if ( $_GET[ self::LOCATIONS_QUERY_ARG ] === 'scan' ) { $this->rescan(); } // phpcs:enable WordPress.Security.NonceVerification.Recommended wp_safe_redirect( remove_query_arg( [ self::LOCATIONS_QUERY_ARG ] ) ); exit; } /** * Run scan task. * * @since 1.7.4 */ public function scan() { if ( ! $this->tasks ) { return; } // Bail out if the scan is already in progress. if ( self::SCAN_STATUS_IN_PROGRESS === (string) get_option( self::SCAN_STATUS ) ) { return; } // Mark that scan is in progress. update_option( self::SCAN_STATUS, self::SCAN_STATUS_IN_PROGRESS ); $this->log( 'Forms Locator scan action started.' ); // This part of the scan shouldn't take more than 1 second even on big sites. $post_ids = $this->search_in_posts(); $post_locations = $this->get_form_locations( $post_ids ); $widget_locations = $this->locator->search_in_widgets(); $standalone_locations = $this->search_in_standalone_forms(); $locations = array_merge( $post_locations, $widget_locations, $standalone_locations ); $form_location_metas = $this->get_form_location_metas( $locations ); /** * This part of the scan can take a while. * Saving hundreds of metas with a potentially very high number of locations could be time and memory consuming. * That is why we perform save via Action Scheduler. */ $meta_chunks = array_chunk( $form_location_metas, self::CHUNK_SIZE, true ); $count = count( $meta_chunks ); foreach ( $meta_chunks as $index => $meta_chunk ) { $this->tasks->create( self::SAVE_ACTION )->async()->params( $meta_chunk, $index, $count )->register(); } $this->log( 'Save tasks created.' ); } /** * Run immediate scan. * * @since 1.7.4 */ public function rescan() { $this->cancel(); $this->add_scan_task(); } /** * Save form locations. * * @since 1.7.4 * * @param int $meta_id Action meta id. */ public function save( $meta_id ) { $params = ( new Meta() )->get( $meta_id ); if ( ! $params ) { return; } list( $meta_chunk, $index, $count ) = $params->data; foreach ( $meta_chunk as $form_id => $meta ) { update_post_meta( $form_id, Locator::LOCATIONS_META, $meta ); } $this->log( sprintf( 'Forms Locator save action %1$d/%2$d completed.', $index + 1, $count ) ); } /** * Delete form locations. * * @since 1.7.4 */ public function delete() { global $wpdb; // phpcs:ignore WordPress.DB.DirectDatabaseQuery.NoCaching $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->postmeta WHERE meta_key = %s", Locator::LOCATIONS_META ) ); delete_option( self::SCAN_STATUS ); wp_cache_flush(); } /** * After process queue action. * Delete transient to indicate that scanning is completed. * * @since 1.7.4 */ public function after_process_queue() { if ( $this->tasks->is_scheduled( self::SAVE_ACTION ) ) { return; } // Mark that scan is finished. if ( (string) get_option( self::SCAN_STATUS ) === self::SCAN_STATUS_IN_PROGRESS ) { update_option( self::SCAN_STATUS, self::SCAN_STATUS_COMPLETED ); $this->log( 'Forms Locator scan action completed.' ); } } /** * Search form in posts. * * @since 1.7.4 * * @return int[] */ private function search_in_posts() { global $wpdb; $post_statuses = wpforms_wpdb_prepare_in( $this->locator->get_post_statuses() ); $post_types = wpforms_wpdb_prepare_in( $this->locator->get_post_types() ); // phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.InterpolatedNotPrepared $ids = $wpdb->get_col( "SELECT p.ID FROM (SELECT ID FROM $wpdb->posts WHERE post_status IN ( $post_statuses ) AND post_type IN ( $post_types ) ) AS ids INNER JOIN $wpdb->posts as p ON ids.ID = p.ID WHERE p.post_content REGEXP '\\\[wpforms|wpforms/form-selector'" ); // phpcs:enable WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.InterpolatedNotPrepared return array_map( 'intval', $ids ); } /** * Filters the SELECT clause of the query. * Get a minimal set of fields from the post record. * * @since 1.7.4 * * @param string $fields The SELECT clause of the query. * @param WP_Query $query The WP_Query instance (passed by reference). * * @return string * * @noinspection PhpUnusedParameterInspection */ public function posts_fields_filter( $fields, $query ) { global $wpdb; $fields_arr = [ 'ID', 'post_title', 'post_status', 'post_type', 'post_content', 'post_name' ]; $fields_arr = array_map( static function ( $field ) use ( $wpdb ) { return "$wpdb->posts." . $field; }, $fields_arr ); return implode( ', ', $fields_arr ); } /** * Get form locations. * * @since 1.7.4 * * @param int[] $post_ids Post IDs. * * @return array */ private function get_form_locations( $post_ids ) { // phpcs:ignore WPForms.PHP.HooksMethod.InvalidPlaceForAddingHooks /** * Block caching here, as caching produces unneeded db requests in * update_object_term_cache() and update_postmeta_cache(). */ $query_args = [ 'post_type' => $this->locator->get_post_types(), 'post_status' => $this->locator->get_post_statuses(), 'post__in' => $post_ids, 'no_found_rows' => true, 'posts_per_page' => - 1, 'cache_results' => false, ]; // Get form locations by chunks to prevent out of memory issue. $post_id_chunks = array_chunk( $post_ids, self::CHUNK_SIZE ); $locations = []; add_filter( 'posts_fields', [ $this, 'posts_fields_filter' ], 10, 2 ); foreach ( $post_id_chunks as $post_id_chunk ) { $query_args['post__in'] = $post_id_chunk; $query = new WP_Query( $query_args ); $locations = $this->get_form_locations_from_posts( $query->posts, $locations ); } remove_filter( 'posts_fields', [ $this, 'posts_fields_filter' ] ); return $locations; } /** * Get locations from posts. * * @since 1.7.4 * * @param WP_Post[] $posts Posts. * @param array $locations Locations. * * @return array */ private function get_form_locations_from_posts( $posts, $locations = [] ) { $home_url = home_url(); foreach ( $posts as $post ) { $form_ids = $this->locator->get_form_ids( $post->post_content ); if ( ! $form_ids ) { continue; } $url = get_permalink( $post ); $url = ( $url === false || is_wp_error( $url ) ) ? '' : $url; $url = str_replace( $home_url, '', $url ); foreach ( $form_ids as $form_id ) { $locations[] = [ 'type' => $post->post_type, 'title' => $post->post_title, 'form_id' => $form_id, 'id' => $post->ID, 'status' => $post->post_status, 'url' => $url, ]; } } return $locations; } /** * Search in standalone forms. * * @since 1.8.7 * * @return array */ private function search_in_standalone_forms(): array { global $wpdb; $location_types = []; foreach ( Locator::STANDALONE_LOCATION_TYPES as $location_type ) { $location_types[] = '"' . $location_type . '_enable":"1"'; } $regexp = implode( '|', $location_types ); $post_statuses = wpforms_wpdb_prepare_in( $this->locator->get_post_statuses() ); // phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.InterpolatedNotPrepared $standalone_forms = $wpdb->get_results( "SELECT ID, post_content, post_status FROM $wpdb->posts WHERE post_status IN ( $post_statuses ) AND post_type = 'wpforms' AND post_content REGEXP '$regexp';" ); // phpcs:enable WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.InterpolatedNotPrepared $locations = []; foreach ( $standalone_forms as $standalone_form ) { $form_data = json_decode( $standalone_form->post_content, true ); $locations[] = $this->locator->build_standalone_location( (int) $standalone_form->ID, $form_data, $standalone_form->post_status ); } return $locations; } /** * Get form location metas. * * @param array $locations Locations. * * @since 1.7.4 * * @return array */ private function get_form_location_metas( $locations ) { $metas = []; foreach ( $locations as $location ) { if ( empty( $location['form_id'] ) ) { continue; } $metas[ $location['form_id'] ][] = $location; } return $metas; } /** * Log message to WPForms logger and standard debug.log file. * * @since 1.7.4 * * @param string $message The error message that should be logged. * * @noinspection ForgottenDebugOutputInspection * @noinspection PhpUndefinedConstantInspection */ private function log( $message ) { if ( defined( 'WPFORMS_DEBUG' ) && WPFORMS_DEBUG ) { // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log error_log( $message ); wpforms_log( 'Forms Locator', $message, [ 'type' => 'log' ] ); } } }