X-Git-Url: https://git.cyclocoop.org/admin/?a=blobdiff_plain;f=includes%2Fsearch%2FSearchEngine.php;h=b2bacdafc751838b70850ca90baf4cf785a73d67;hb=55420abd95c411b0f350dc325257b571a905e85e;hp=0f65711bf64ce6250dfc9568b8dff23db4ee31de;hpb=478a58f63101f2b47d18a618296b5e7970fa3f24;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/search/SearchEngine.php b/includes/search/SearchEngine.php
index 0f65711bf6..b2bacdafc7 100644
--- a/includes/search/SearchEngine.php
+++ b/includes/search/SearchEngine.php
@@ -69,12 +69,27 @@ abstract class SearchEngine {
 	/**
 	 * Perform a full text search query and return a result set.
 	 * If full text searches are not supported or disabled, return null.
-	 * STUB
+	 *
+	 * As of 1.32 overriding this function is deprecated. It will
+	 * be converted to final in 1.34. Override self::doSearchText().
+	 *
+	 * @param string $term Raw search term
+	 * @return SearchResultSet|Status|null
+	 */
+	public function searchText( $term ) {
+		return $this->maybePaginate( function () use ( $term ) {
+			return $this->doSearchText( $term );
+		} );
+	}
+
+	/**
+	 * Perform a full text search query and return a result set.
 	 *
 	 * @param string $term Raw search term
 	 * @return SearchResultSet|Status|null
+	 * @since 1.32
 	 */
-	function searchText( $term ) {
+	protected function doSearchText( $term ) {
 		return null;
 	}
 
@@ -85,11 +100,25 @@ abstract class SearchEngine {
 	 * The results returned by this methods are only sugegstions and
 	 * may not end up being shown to the user.
 	 *
+	 * As of 1.32 overriding this function is deprecated. It will
+	 * be converted to final in 1.34. Override self::doSearchArchiveTitle().
+	 *
 	 * @param string $term Raw search term
 	 * @return Status<Title[]>
 	 * @since 1.29
 	 */
-	function searchArchiveTitle( $term ) {
+	public function searchArchiveTitle( $term ) {
+		return $this->doSearchArchiveTitle( $term );
+	}
+
+	/**
+	 * Perform a title search in the article archive.
+	 *
+	 * @param string $term Raw search term
+	 * @return Status<Title[]>
+	 * @since 1.32
+	 */
+	protected function doSearchArchiveTitle( $term ) {
 		return Status::newGood( [] );
 	}
 
@@ -98,13 +127,63 @@ abstract class SearchEngine {
 	 * If title searches are not supported or disabled, return null.
 	 * STUB
 	 *
+	 * As of 1.32 overriding this function is deprecated. It will
+	 * be converted to final in 1.34. Override self::doSearchTitle().
+	 *
 	 * @param string $term Raw search term
 	 * @return SearchResultSet|null
 	 */
-	function searchTitle( $term ) {
+	public function searchTitle( $term ) {
+		return $this->maybePaginate( function () use ( $term ) {
+			return $this->doSearchTitle( $term );
+		} );
+	}
+
+	/**
+	 * Perform a title-only search query and return a result set.
+	 *
+	 * @param string $term Raw search term
+	 * @return SearchResultSet|null
+	 * @since 1.32
+	 */
+	protected function doSearchTitle( $term ) {
 		return null;
 	}
 
+	/**
+	 * Performs an overfetch and shrink operation to determine if
+	 * the next page is available for search engines that do not
+	 * explicitly implement their own pagination.
+	 *
+	 * @param Closure $fn Takes no arguments
+	 * @return SearchResultSet|Status<SearchResultSet>|null Result of calling $fn
+	 */
+	private function maybePaginate( Closure $fn ) {
+		if ( $this instanceof PaginatingSearchEngine ) {
+			return $fn();
+		}
+		$this->limit++;
+		try {
+			$resultSetOrStatus = $fn();
+		} finally {
+			$this->limit--;
+		}
+
+		$resultSet = null;
+		if ( $resultSetOrStatus instanceof SearchResultSet ) {
+			$resultSet = $resultSetOrStatus;
+		} elseif ( $resultSetOrStatus instanceof Status &&
+			$resultSetOrStatus->getValue() instanceof SearchResultSet
+		) {
+			$resultSet = $resultSetOrStatus->getValue();
+		}
+		if ( $resultSet ) {
+			$resultSet->shrink( $this->limit );
+		}
+
+		return $resultSetOrStatus;
+	}
+
 	/**
 	 * @since 1.18
 	 * @param string $feature
@@ -482,6 +561,22 @@ abstract class SearchEngine {
 		return $search;
 	}
 
+	/**
+	 * Perform an overfetch of completion search results. This allows
+	 * determining if another page of results is available.
+	 *
+	 * @param string $search
+	 * @return SearchSuggestionSet
+	 */
+	protected function completionSearchBackendOverfetch( $search ) {
+		$this->limit++;
+		try {
+			return $this->completionSearchBackend( $search );
+		} finally {
+			$this->limit--;
+		}
+	}
+
 	/**
 	 * Perform a completion search.
 	 * Does not resolve namespaces and does not check variants.
@@ -519,7 +614,8 @@ abstract class SearchEngine {
 			return SearchSuggestionSet::emptySuggestionSet(); // Return empty result
 		}
 		$search = $this->normalizeNamespaces( $search );
-		return $this->processCompletionResults( $search, $this->completionSearchBackend( $search ) );
+		$suggestions = $this->completionSearchBackendOverfetch( $search );
+		return $this->processCompletionResults( $search, $suggestions );
 	}
 
 	/**
@@ -533,8 +629,8 @@ abstract class SearchEngine {
 		}
 		$search = $this->normalizeNamespaces( $search );
 
-		$results = $this->completionSearchBackend( $search );
-		$fallbackLimit = $this->limit - $results->getSize();
+		$results = $this->completionSearchBackendOverfetch( $search );
+		$fallbackLimit = 1 + $this->limit - $results->getSize();
 		if ( $fallbackLimit > 0 ) {
 			global $wgContLang;
 
@@ -573,15 +669,26 @@ abstract class SearchEngine {
 	 * @return SearchSuggestionSet
 	 */
 	protected function processCompletionResults( $search, SearchSuggestionSet $suggestions ) {
+		// We over-fetched to determine pagination. Shrink back down if we have extra results
+		// and mark if pagination is possible
+		$suggestions->shrink( $this->limit );
+
 		$search = trim( $search );
 		// preload the titles with LinkBatch
-		$titles = $suggestions->map( function ( SearchSuggestion $sugg ) {
+		$lb = new LinkBatch( $suggestions->map( function ( SearchSuggestion $sugg ) {
 			return $sugg->getSuggestedTitle();
-		} );
-		$lb = new LinkBatch( $titles );
+		} ) );
 		$lb->setCaller( __METHOD__ );
 		$lb->execute();
 
+		$diff = $suggestions->filter( function ( SearchSuggestion $sugg ) {
+			return $sugg->getSuggestedTitle()->isKnown();
+		} );
+		if ( $diff > 0 ) {
+			MediaWikiServices::getInstance()->getStatsdDataFactory()
+				->updateCount( 'search.completion.missing', $diff );
+		}
+
 		$results = $suggestions->map( function ( SearchSuggestion $sugg ) {
 			return $sugg->getSuggestedTitle()->getPrefixedText();
 		} );
@@ -789,7 +896,6 @@ abstract class SearchEngine {
 		$setAugmentors = [];
 		$rowAugmentors = [];
 		Hooks::run( "SearchResultsAugment", [ &$setAugmentors, &$rowAugmentors ] );
-
 		if ( !$setAugmentors && !$rowAugmentors ) {
 			// We're done here
 			return;