Fixed relevance score issues

Fixes #124

- Relevance score was always 0
- Relevance query returned more than 1 result.

Author: ajaydsouza

better-search.php

@@ -13,7 +13,7 @@
  * Plugin Name: Better Search
  * Plugin URI:  https://webberzone.com/plugins/better-search/
  * Description: Replace the default WordPress search with a contextual search. Search results are sorted by relevancy ensuring a better visitor search experience.
- * Version:     4.1.1
+ * Version:     4.1.2-beta1
  * Author:      WebberZone
  * Author URI:  https://webberzone.com/
  * Text Domain: better-search

includes/class-better-search-core-query.php

@@ -126,6 +126,14 @@ class Better_Search_Core_Query extends \WP_Query {
 	 */
 	public $match_sql = '';
 
+	/**
+	 * Holds the array of post scores.
+	 *
+	 * @since 4.1.2
+	 * @var array
+	 */
+	public $post_scores = array();
+
 	/**
 	 * Main constructor.
 	 *
@@ -165,7 +173,7 @@ public function hooks() {
 		add_filter( 'posts_groupby', array( $this, 'posts_groupby' ), 10, 2 );
 		add_filter( 'posts_clauses', array( $this, 'posts_clauses' ), 10, 2 );
 		add_filter( 'posts_request', array( $this, 'posts_request' ), 10, 2 );
-		add_filter( 'better_search_query_posts_request', array( $this, 'set_topscore' ), 999, 2 );
+		add_filter( 'better_search_query_posts_request', array( $this, 'set_topscore' ), PHP_INT_MAX, 2 );
 		add_filter( 'posts_pre_query', array( $this, 'posts_pre_query' ), 10, 2 );
 		add_filter( 'the_posts', array( $this, 'the_posts' ), 10, 2 );
 	}
@@ -1138,6 +1146,14 @@ public function the_posts( $posts, $query ) {
 			return $posts;
 		}
 
+		// Store scores in the query object for template access.
+		$query->post_scores = array();
+		foreach ( $posts as $post ) {
+			if ( isset( $post->score ) ) {
+				$query->post_scores[ $post->ID ] = floatval( $post->score );
+			}
+		}
+
 		// Support caching to speed up retrieval.
 		if ( ! empty( $posts ) && ! empty( $this->query_args['cache'] ) && ! $this->in_cache && ! ( $query->is_preview() || is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) ) {
 
@@ -1230,7 +1246,7 @@ public function set_topscore( $request, $query ) {
 
 		// Take $request. Check if there is a LIMIT clause. If so, make sure it's limited to a single entry only. If there is no LIMIT then add it to extract a single entry only. Also, check if there is an ORDER BY clause. If so, make sure it's ordered by the score column. If there is no ORDER BY clause then add one.
 		if ( strpos( $request, 'LIMIT' ) !== false ) {
-			$score_query = preg_replace( '/LIMIT\s+\\d+(,\\d+)?/', 'LIMIT 1', $request );
+			$score_query = preg_replace( '/LIMIT\s+(?:\d+\s*,\s*)?\d+/', 'LIMIT 1', $request );
 		} else {
 			$score_query = $request . ' LIMIT 1';
 		}
@@ -1253,8 +1269,9 @@ public function set_topscore( $request, $query ) {
 			$score_query = $score_query . ' ORDER BY score DESC';
 		}
 
-		$this->topscore = (float) $wpdb->get_var( $score_query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching
+		$topscore = $wpdb->get_results( $score_query ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching
 
+		$this->topscore  = ! empty( $topscore ) ? (float) wp_list_pluck( $topscore, 'score' )[0] : 0;
 		$query->topscore = $this->topscore;
 
 		if ( ! empty( $this->query_args['cache'] ) ) {

includes/class-better-search-query.php

@@ -41,7 +41,7 @@ public function __construct( $args = array() ) {
 			add_filter( 'posts_groupby', array( $core_query, 'posts_groupby' ), 10, 2 );
 			add_filter( 'posts_clauses', array( $core_query, 'posts_clauses' ), 10, 2 );
 			add_filter( 'posts_request', array( $core_query, 'posts_request' ), 10, 2 );
-			add_filter( 'better_search_query_posts_request', array( $core_query, 'set_topscore' ), 10, 2 );
+			add_filter( 'better_search_query_posts_request', array( $core_query, 'set_topscore' ), PHP_INT_MAX, 2 );
 			add_filter( 'posts_pre_query', array( $core_query, 'posts_pre_query' ), 10, 2 );
 			add_filter( 'the_posts', array( $core_query, 'the_posts' ), 10, 2 );
 
@@ -58,7 +58,7 @@ public function __construct( $args = array() ) {
 			remove_filter( 'posts_groupby', array( $core_query, 'posts_groupby' ) );
 			remove_filter( 'posts_clauses', array( $core_query, 'posts_clauses' ) );
 			remove_filter( 'posts_request', array( $core_query, 'posts_request' ) );
-			remove_filter( 'better_search_query_posts_request', array( $core_query, 'set_topscore' ) );
+			remove_filter( 'better_search_query_posts_request', array( $core_query, 'set_topscore' ), PHP_INT_MAX );
 			remove_filter( 'posts_pre_query', array( $core_query, 'posts_pre_query' ) );
 			remove_filter( 'the_posts', array( $core_query, 'the_posts' ) );
 		}

includes/class-main.php

@@ -8,9 +8,11 @@
 namespace WebberZone\Better_Search;
 
 use WebberZone\Better_Search\Admin\Activator;
+
 if ( ! defined( 'WPINC' ) ) {
 	exit;
 }
+
 /**
  * Main plugin class.
  *
@@ -117,6 +119,7 @@ public static function get_instance() {
 			self::$instance = new self();
 			self::$instance->init();
 		}
+
 		return self::$instance;
 	}
 
@@ -142,10 +145,19 @@ private function init() {
 		$this->display          = new Frontend\Display();
 		$this->live_search      = new Frontend\Live_Search();
 		$this->template_handler = new Frontend\Template_Handler();
+
 		$this->hooks();
+
 		if ( ! function_exists( 'bsearch_freemius' ) ) {
 			require_once __DIR__ . '/load-freemius.php';
 		}
+
+		if ( bsearch_freemius()->is__premium_only() ) {
+			if ( bsearch_freemius()->can_use_premium_code() ) {
+				$this->pro = new Pro\Pro();
+			}
+		}
+
 		if ( is_admin() ) {
 			$this->admin = new Admin\Admin();
 			if ( is_multisite() ) {
@@ -182,8 +194,8 @@ public function initiate_plugin() {
 	 * @since 3.3.0
 	 */
 	public function register_widgets() {
-		register_widget( '\\WebberZone\\Better_Search\\Frontend\\Widgets\\Search_Box' );
-		register_widget( '\\WebberZone\\Better_Search\\Frontend\\Widgets\\Search_Heatmap' );
+		register_widget( '\WebberZone\Better_Search\Frontend\Widgets\Search_Box' );
+		register_widget( '\WebberZone\Better_Search\Frontend\Widgets\Search_Heatmap' );
 	}
 
 	/**
@@ -199,20 +211,25 @@ public function activated_plugin( $plugin, $network_wide ) {
 		if ( ! in_array( $plugin, array( 'better-search/better-search.php', 'better-search-pro/better-search.php' ), true ) ) {
 			return;
 		}
+
 		Activator::activation_hook( $network_wide );
+
 		$plugin_to_deactivate  = 'better-search/better-search.php';
 		$deactivated_notice_id = '1';
+
 		// If we just activated the free version, deactivate the pro version.
 		if ( $plugin === $plugin_to_deactivate ) {
 			$plugin_to_deactivate  = 'better-search-pro/better-search.php';
 			$deactivated_notice_id = '2';
 		}
+
 		if ( is_multisite() && is_network_admin() ) {
 			$active_plugins = (array) get_site_option( 'active_sitewide_plugins', array() );
 			$active_plugins = array_keys( $active_plugins );
 		} else {
 			$active_plugins = (array) get_option( 'active_plugins', array() );
 		}
+
 		foreach ( $active_plugins as $plugin_basename ) {
 			if ( $plugin_to_deactivate === $plugin_basename ) {
 				set_transient( 'bsearch_deactivated_notice_id', $deactivated_notice_id, 1 * HOUR_IN_SECONDS );
@@ -232,10 +249,12 @@ public function plugin_deactivated_notice() {
 		if ( ! in_array( $deactivated_notice_id, array( 1, 2 ), true ) ) {
 			return;
 		}
+
 		$message = __( "Better Search and Better Search Pro should not be active at the same time. We've automatically deactivated Better Search.", 'better-search' );
 		if ( 2 === $deactivated_notice_id ) {
 			$message = __( "Better Search and Better Search Pro should not be active at the same time. We've automatically deactivated Better Search Pro.", 'better-search' );
 		}
+
 		?>
 			<div class="updated" style="border-left: 4px solid #ffba00;">
 				<p>
@@ -245,6 +264,7 @@ public function plugin_deactivated_notice() {
 				</p>
 			</div>
 			<?php
+
 			delete_transient( 'bsearch_deactivated_notice_id' );
 	}
 
@@ -260,37 +280,12 @@ public static function pro_upgrade_banner( $donate = true ) {
 			?>
 				<div id="pro-upgrade-banner">
 					<div class="inside">
-						<p><a href="https://webberzone.com/plugins/better-search/pro/" target="_blank"><img src="
-						<?php
-						echo esc_url( BETTER_SEARCH_PLUGIN_URL . 'includes/admin/images/better-search-pro-banner.png' );
-						?>
-			" alt="
-			<?php
-			esc_html_e( 'Better Search Pro - Coming soon. Sign up to find out more', 'better-search' );
-			?>
-			" width="300" height="300" style="max-width: 100%;" /></a></p>
-
-						<?php
-						if ( $donate ) {
-							?>
-											
-							<p style="text-align:center;">
-							<?php
-							esc_html_e( 'OR' );
-							?>
-				</p>
-							<p><a href="https://wzn.io/donate-bs" target="_blank"><img src="
-							<?php
-							echo esc_url( BETTER_SEARCH_PLUGIN_URL . 'includes/admin/images/support.webp' );
-							?>
-				" alt="
-							<?php
-							esc_html_e( 'Support the development - Send us a donation today.', 'better-search' );
-							?>
-				" width="300" height="169" style="max-width: 100%;" /></a></p>
-							<?php
-						}
-						?>
+						<p><a href="https://webberzone.com/plugins/better-search/pro/" target="_blank"><img src="<?php echo esc_url( BETTER_SEARCH_PLUGIN_URL . 'includes/admin/images/better-search-pro-banner.png' ); ?>" alt="<?php esc_html_e( 'Better Search Pro - Coming soon. Sign up to find out more', 'better-search' ); ?>" width="300" height="300" style="max-width: 100%;" /></a></p>
+
+						<?php if ( $donate ) : ?>							
+							<p style="text-align:center;"><?php esc_html_e( 'OR' ); ?></p>
+							<p><a href="https://wzn.io/donate-bs" target="_blank"><img src="<?php echo esc_url( BETTER_SEARCH_PLUGIN_URL . 'includes/admin/images/support.webp' ); ?>" alt="<?php esc_html_e( 'Support the development - Send us a donation today.', 'better-search' ); ?>" width="300" height="169" style="max-width: 100%;" /></a></p>
+						<?php endif; ?>
 					</div>
 				</div>
 			<?php

includes/general-template.php

@@ -548,6 +548,28 @@ function the_bsearch_score( $args = array() ) {
 	echo apply_filters( 'the_bsearch_score', get_bsearch_score( $args ), $args ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
 }
 
+/**
+ * Get the relevance score for a post.
+ *
+ * @since 4.1.2
+ *
+ * @param int $post_id Post ID. Default is current post.
+ * @return float Post score or 0 if not available.
+ */
+function bsearch_get_post_score( $post_id = 0 ) {
+	global $wp_query;
+
+	if ( ! $post_id ) {
+		$post_id = get_the_ID();
+	}
+
+	if ( isset( $wp_query->post_scores ) && isset( $wp_query->post_scores[ $post_id ] ) ) {
+		return floatval( $wp_query->post_scores[ $post_id ] );
+	}
+
+	return 0;
+}
+
 /**
  * Retrieve the relevance score for the post in the search results.
  *

includes/load-freemius.php

@@ -1,50 +1,48 @@
 <?php
+
 /**
  * Loads Freemius SDK.
  *
  * @package WebberZone\Better_Search
  */
-
 namespace WebberZone\Better_Search;
 
-if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+if ( !defined( 'ABSPATH' ) ) {
+    exit;
 }
 /**
  * Initialize Freemius SDK.
  */
 function bsearch_freemius() {
-	global $bsearch_freemius;
-	if ( ! isset( $bsearch_freemius ) ) {
-		if ( ! defined( 'WP_FS__PRODUCT_17020_MULTISITE' ) ) {
-			define( 'WP_FS__PRODUCT_17020_MULTISITE', true );
-		}
-		// Include Freemius SDK.
-		require_once plugin_dir_path( __DIR__ ) . 'freemius/start.php';
-		$bsearch_freemius = \fs_dynamic_init(
-			array(
-				'id'             => '17020',
-				'slug'           => 'better-search',
-				'premium_slug'   => 'better-search-pro',
-				'type'           => 'plugin',
-				'public_key'     => 'pk_40525301bca835d9836ec4d946693',
-				'is_premium'     => false,
-				'premium_suffix' => 'Pro',
-				'has_addons'     => false,
-				'has_paid_plans' => true,
-				'menu'           => array(
-					'slug'    => 'bsearch_dashboard',
-					'contact' => false,
-					'support' => false,
-					'network' => true,
-				),
-				'is_live'        => true,
-			)
-		);
-	}
-	$bsearch_freemius->add_filter( 'plugin_icon', __NAMESPACE__ . '\\bsearch_freemius_get_plugin_icon' );
-	$bsearch_freemius->add_filter( 'after_uninstall', __NAMESPACE__ . '\\bsearch_freemius_uninstall' );
-	return $bsearch_freemius;
+    global $bsearch_freemius;
+    if ( !isset( $bsearch_freemius ) ) {
+        if ( !defined( 'WP_FS__PRODUCT_17020_MULTISITE' ) ) {
+            define( 'WP_FS__PRODUCT_17020_MULTISITE', true );
+        }
+        // Include Freemius SDK.
+        require_once plugin_dir_path( __DIR__ ) . 'freemius/start.php';
+        $bsearch_freemius = \fs_dynamic_init( array(
+            'id'             => '17020',
+            'slug'           => 'better-search',
+            'premium_slug'   => 'better-search-pro',
+            'type'           => 'plugin',
+            'public_key'     => 'pk_40525301bca835d9836ec4d946693',
+            'is_premium'     => true,
+            'premium_suffix' => 'Pro',
+            'has_addons'     => false,
+            'has_paid_plans' => true,
+            'menu'           => array(
+                'slug'    => 'bsearch_dashboard',
+                'contact' => false,
+                'support' => false,
+                'network' => true,
+            ),
+            'is_live'        => true,
+        ) );
+    }
+    $bsearch_freemius->add_filter( 'plugin_icon', __NAMESPACE__ . '\\bsearch_freemius_get_plugin_icon' );
+    $bsearch_freemius->add_filter( 'after_uninstall', __NAMESPACE__ . '\\bsearch_freemius_uninstall' );
+    return $bsearch_freemius;
 }
 
 /**
@@ -53,17 +51,20 @@ function bsearch_freemius() {
  * @return string
  */
 function bsearch_freemius_get_plugin_icon() {
-	return __DIR__ . '/admin/images/bsearch-icon.png';
+    return __DIR__ . '/admin/images/bsearch-icon.png';
 }
 
 /**
  * Uninstall the plugin.
  */
 function bsearch_freemius_uninstall() {
-	require_once dirname( __DIR__ ) . '/uninstaller.php';
+    require_once dirname( __DIR__ ) . '/uninstaller.php';
+    if ( bsearch_freemius()->can_use_premium_code__premium_only() ) {
+        \WebberZone\Better_Search\Pro\Pro::uninstall_pro();
+    }
 }
 
 // Init Freemius.
 bsearch_freemius();
 // Signal that SDK was initiated.
-do_action( 'bsearch_freemius_loaded' );
+do_action( 'bsearch_freemius_loaded' );

includes/util/class-helpers.php

@@ -452,7 +452,6 @@ public static function highlight( $input, $keys ) {
 	 * @return string Score converted to percentage
 	 */
 	public static function score2percent( $score, $topscore ) {
-
 		$output = '';
 
 		if ( $score > 0 && $topscore > 0 ) {