Extension:SphinxSearch

Description
As MediaWiki-based site administrators, one of the most common complaints we receive is that the default search engine is far from excellent. In our day and age where Google sets the standard for search engine capabilities, users aren't happy with a basic search engine. They need, or should I say demand a faster, easier, better engine.

The Sphinx Search Engine seems to promise exactly that; a full text search engine that is both flexible and fast. This extension incorporates the Sphinx engine into MediaWiki to provide a better alternative for searching. The extension can be installed in one of two modes:
 * 1) Provide an additional Special Page for searching using Sphinx. This method is excellent for providing a method for evaluating the performance of the extension while still maintaining the default search engine.
 * 2) Completely replace the built in search engine with the sphinx search engine.

This extension is very similar in nature to Extension:LuceneSearch and Extension:Hyper Estraier. The main difference is obviously the search engine backend. SphinxSearch extension also adds some additional features like "Did You Mean" suggestions for misspelled searches. This functionality is fundamentally different from Extension:DidYouMean which only suggests alternate article names for existing articles. Also, SphinxSearch can be easily evaluated before rolling it out as a complete replacement search engine.

Compatibility
This extension has been shown to work / not work with the following MediaWiki versions. Please add more successes and failures to this list
 * 1.6.? -- Fails - The guy who tested old version of Mediawiki - (Pessoft)
 * 1.8.? -- Fails - The guy who uses old version of Mediawiki - (125.17.142.146)
 * 1.9.3 - Works - (Gri6507)
 * 1.10 - Works - (Svemir)
 * 1.11 - Works - (125.17.142.146, Svemir)
 * 1.12 - Works on W2k3 and IIS - (80.152.175.189)

The extension has been shown to work / not work with the following Sphinx versions. Please add more successes and failures to this list
 * 0.9.6rc1 - Does not work - (125.17.142.146)
 * 0.9.7 - Works - (Gri6507)
 * 0.9.8svn - Works - (Svemir)
 * 0.9.8svn-r1112 (Jan 28, 2008 snapshot) - Does not work for 130.234.189.190, but it works for Svemir
 * 0.9.8-rc2 r1234 - Works - (Gmoyle)
 * 0.9.8-rc2 r1234 - Works on W2k3 and IIS - (80.152.175.189)

The extension has been shown to work / not work with the following languages. Main problem may be that it cannot separate the words and the phrases.
 * English - Works - all version - (Alpha3)
 * Chinese - workes on win2003 wamp 1.7.3 - all version - (Alpha3)
 * Please see this post in Sphinx forums and let us know if it works for a Chinese wiki so we can update the documentation.


 * German - Works on W2k3 and IIS - (80.152.175.189)

Step 1 - Install Sphinx
Download Sphinx Search Engine. Follow the installation instructions. You only need to do the actual installation, which means you do not need to do the "Quick Sphinx usage tour". You can verify your installation by following the rest of the steps here. Note: if installing on a Windows server, you do not need to compile anything; just download the Win32 release binaries.

Step 2 - Configure Sphinx
Download and extract the extension to a temporary directory. Copy the sphinx.conf file from this download to some directory (we will refer to this file as "/path/to/sphinx.conf" below.) This directory should not be web-accessible, so you should not use the extensions folder. Make sure to adjust all values to suit your setup:
 * Set correct database, username, and password for your MediaWiki database
 * Update table names in SQL queries if your MediaWiki installation uses a prefix (backslash line breaks may need to be removed if the indexer step below fails)
 * Update the file paths (/var/data/sphinx/..., /var/log/sphinx/...) and create folders as necessary
 * If your wiki is very large, you may want to consider specifying a query range in the conf file.
 * If your wiki is not in English, you will need to change (or remove) the morphology attribute.

Note: To give credit where credit is due, we must thank the author of this excellent article for providing an excellent starting point on configuring this file.

Step 3 - Run Sphinx Indexer
Run the sphinx indexer to prepare for searching: Once again, make sure to replace the paths to match your installation. This process is actually pretty fast, but clearly depends on how large your wiki is. Just be patient and watch the screen for updates.

Step 4 - Test Out Sphinx
When the indexer is finished, test that sphinx searching is actually working: You will see the result stats immediately (Sphinx is FAST.) Note that the article data you see at this point comes from the sql_query_info in sphinx.conf file. In the extension we can get to the actual article content because we have text old_id available as an extra attribute. It would be slow to fetch article content on the command line (we would have to join page, revision, and text tables,) so we just fetch page_title and page_namespace at this point.

Step 5 - Start Sphinx Daemon
In order to speed up the searching capability for the wiki, we must run the sphinx in daemon mode. Add the following to whatever sever startup script you have access (i.e. /etc/rc.local): Note: without the daemon running, searching will not work. That is why it is critical to make sure the daemon process is started every time the server is restarted.

Step 6 - Configure Incremental Updates
To keep the index for the search engine up to date, the indexer must be scheduled to run at a regular interval. On most UNIX systems edit your crontab file by running the command: crontab -e Add this line to set up a cron job for the full index - for example once every night: 0 3 * * * /path/to/sphinx/installation/indexer --config /path/to/sphinx.conf wiki_main --rotate >/dev/null 2>&1 Add this line to set up a more frequent cron to update the smaller index regularly: 0 9,15,22 * * * /path/to/sphinx/installation/indexer --config /path/to/sphinx.conf wiki_incremental --rotate >/dev/null 2>&1 As before, make sure to adjust the paths to suit your configuration. Note that --rotate option is needed if searchd deamon is already running, so that the indexer does not modify the index file while it is being used. It creates a new file and copies it over the existing one when it is done.

Step 7 - Extension Preparation
Copy the Sphinx API file, sphinxapi.php to the extensions directory. This file is part of the sphinx source code, under the api/ directory. Note: if you installed Sphinx from a Win32 binary release, it may not have come with a copy of sphinxapi.php. You must download either the source code package or an API update package. Just use your favorite uncompress utility (i.e. WinZip) and extract only the sphinxapi.php to the extensions directory; the other files can be ignored.

Step 8 - Extension Preparation
Download ExtensionFunctions.php from SVN and copy it to your extensions directory.

Step 9 - Extension Installation
Copy SphinxSearch.php and SphinxSearch_body.php from the temporary directory you extracted the code to in to your extensions directory.

Step 10 - Extension Installation
Add the following text to your LocalSettings.php

Options
For the most part, the extension's default options do not need any modification. However, if tweaking is needed/desired, there are a number of configuration options that could be configured from LocalSettings.php or from SphinxSearch.php directly. Those are:
 * $wgSphinxSearch_host - the hostname on which sphinxd is running (default to localhost)
 * $wgSphinxSearch_port - the port number on which sphinxd is running (default to 3312)
 * $wgSphinxSearch_mode - the Sphinx search mode. The default mode is the most intuitive. See Sphinx documentation for other valid options.
 * $wgSphinxSearch_matches - the number of search hits to display per result page.
 * $wgSphinxSearch_weights - the way Sphinx orders the results. The default is pretty good. See Sphinx documentation for other valid options.
 * $wgSphinxSearch_groupby, $wgSphinxSearch_groupsort - define how to group the results. See Sphinx documentation for other valid options.
 * $wgSphinxSearch_sortby - set matches sorting mode (default to SPH_SORT_RELEVANCE). See Sphinx documentation for other valid options.

When setting these options in LocalSettings.php, make sure to do so after the call to require_once for this extension.

Mode Of Operation
By default, this extension will run so as not to overwrite the built-in search engine, but instead provide a new Special Page called Search Wiki Using Sphinx. This allows the users to evaluate this extension by directory comparing the search results of the built-in search vs. Sphinx search.

If the performance is deemed acceptable to replace the built-in search engine, this extension can easily be configured to act as the default search engine. To do so, modify SphinxSearch.php to uncomment the lines containing Now, the standard search method will use Sphinx by default. Note: when used in this way, the extension preserves the functionality of the Go and Search buttons.

Did You Mean
When performing a search and the search query is misspelled, the search results could be greatly impaired. Without knowing about the misspelling, it may take the user a while to figure out why their search results are not very good. That is why this extension has an optional "Did You Mean" support. When enabled, this feature will suggest a properly spelled search query for the user in case of a spelling mistake. Also, since many wikis utilize their own jargon, in order to make the "Did You Mean" suggestions more reasonable, this extension can optionally utilize a personalized dictionary.

The spell checking capability is provided via one of two methods. The Did You Mean feature is turned off because it requires the presence of a spell checker and some configuration. In order to enable this functionality edit the SphinxSearch.php to uncomment the line containing This will automatically pick whichever method for interactive with the spellchecker utility is more efficient. If your wiki server does not have Pspell support, then specify the path to the Aspell executable by editing the line containing If for whatever reason the Aspell dictionary files on the server are not in the default location, you can specify the proper path to the dictionary files by setting If using a personalized dictionary, edit the line containing to point to where you'd like to keep the dictionary file.
 * 1) Aspell - a command line program for performing spell checking
 * 2) Pspell - PHP native interface to aspell

Remember to copy SphinxSearch_PersonalDict.php and SphinxSearch_spell.php from the tarball to the extensions folder

When the Did You Mean feature is enabled and is configured to use a personal dictionary file, then the next step is to add contents to this dictionary. SphinxSearch will create a new restricted access special page called Wiki-specific Sphinx search spellcheck dictionary. This page is only accessible by users with DELETE permissions (typically PowerUser and SysOp groups). These users can utilize this page to view the words already in the dictionary, add words into the dictionary, and remove words from the dictionary.

Known issues
''Note: This patch has been applied and committed to CVS, and the download package at SourceForge has also been updated. You only need to do this if you downloaded the extension before May 9, 2008. Thanks to User:The_rooker for the patch.''

There is currently a problem when using an empty personal dictionary file (e.g. if it was created using " "), because the language read from it stays empty then, practically disabling the "Did you mean?" feature.

Until this is changed in the current source, you can apply this patch on "SphinxSearch_PersonalDict.php":


 * Download the above patch from sourceforge and save it in the same folder where you put SphinxSearch extension.
 * Extract it:
 * Apply the patch:

Stop Words
When modifying the sphinx.conf file (see ), there is an option for specifying a file containing search stop words. Stop words are those common words like 'a' and 'the' that appear commonly in text and should really be ignored from searching. A somewhat complete list of English stop words can be found here. Simply copy those words into a text file, and modify your sphinx.conf to point to that file with

ToDo

 * Due to the way the weights are calculated, it is hard to get title matches to always appear first. That can be solved by internally running the search twice, first time with @page_title attribute, second time with @old_text.
 * Sort the results in SPH_SORT_EXTENDED mode by @relevance and by number of times the page has been viewed (available from wiki database). The idea behind this is that given two pages that have the same relevance to the search, if one has been viewed more times, there is probably a reason for that.
 * try to parse the wiki text around the matching words and display in HTML instead of wiki format. This could be difficult because
 * the search matches could be inside wiki text that actually gets rendered as HTML that does not contain the same matches
 * the the sphinx method of pulling out text near the matched word may produce results that are not in valid wiki format (i.e. drop the leading [[, or the trailing ''' ).
 * Easier install of the extension. Perhaps a script?

Completed ToDos

 * We use SPH_MATCH_EXTENDED for better relevance weights, but we process the search term to make it assume an OR instead of an AND on multiple. This will be replaced with an option on the search form.
 * Add the "did you mean" functionality to the search results. (This is in CVS already, some more tweaking required)
 * Add "Case INsenSItive" search -- Not sure how this can be done as the text is a binary field and mySQL doesn't allow case insensitive search on those fields without changing the field structure (which could potentially be dangerous though it did work for me for experimental purpose)
 * Sphinx searching is by default case insensitive. This is a feature of Sphinx and does not affect how the information is stored in MySQL. --Gri6507 13:34, 19 October 2007 (UTC)

Revisions

 * v0.6 beta - April 12, 2008
 * category filtering and AJAX-based sub-category filtering
 * various bug fixes
 * compatibility with Sphinx 0.9.8


 * v0.5.3 - October 27, 2007
 * case insensitive Did You Mean suggestions
 * allow for custom ASpell dictionary locations
 * support for editing the Personal Dictionary via special page.


 * v0.5.1 - October 25, 2007
 * fixed a bug where search results with long strings without spaces forced the user to use the horizontal scroll bar.


 * v0.5.0 - October 20, 2007
 * added google-like "Did You Mean" support for misspelled queries
 * fixed a bug for Internet Explorer users where pressing enter in the search form did not act like clicking the Go button
 * have an option to match any or match all terms
 * added the Before and After hooks around the search results


 * v0.4.3 - October 15, 2007
 * when sphinx is not the default search engine, viewing pages 2 and up of the results now actually uses sphinx.


 * v0.4.2 - October 12. 2007
 * when sphinx is not the default search engine, the special page search actually uses sphinx now.


 * v0.4.1 - October 11, 2007
 * made it optional to replace the default search with Sphinx completely. By default, Sphinx search becomes just another special page.
 * fixed a bug when search would crash if a matching article was deleted after last indexer run.


 * v0.3 - October 5, 2007
 * numerous updates and improvements by Svemir Brkic


 * v0.1 - September 24, 2007
 * initial release (RFC)