7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
27 * Database independant search index updater
31 class SearchUpdate
implements DeferrableUpdate
{
32 /** @var int Page id being updated */
35 /** @var Title Title we're updating */
38 /** @var Content|bool Content of the page (not text) */
44 * @param int $id Page id to update
45 * @param Title|string $title Title of page to update
46 * @param Content|string|bool $c Content of the page to update. Default: false.
47 * If a Content object, text will be gotten from it. String is for back-compat.
48 * Passing false tells the backend to just update the title, not the content
50 public function __construct( $id, $title, $c = false ) {
51 if ( is_string( $title ) ) {
52 $nt = Title
::newFromText( $title );
59 // is_string() check is back-compat for ApprovedRevs
60 if ( is_string( $c ) ) {
61 $this->content
= new TextContent( $c );
63 $this->content
= $c ?
: false;
67 wfDebug( "SearchUpdate object created with invalid title '$title'\n" );
72 * Perform actual update for the entry
74 public function doUpdate() {
75 global $wgDisableSearchUpdate;
77 if ( $wgDisableSearchUpdate ||
!$this->id
) {
82 $page = WikiPage
::newFromID( $this->id
, WikiPage
::READ_LATEST
);
84 foreach ( SearchEngine
::getSearchTypes() as $type ) {
85 $search = SearchEngine
::create( $type );
86 $indexTitle = $this->indexTitle( $search );
87 if ( !$search->supports( 'search-update' ) ) {
91 $normalTitle = $search->normalizeText( $indexTitle );
93 if ( $page === null ) {
94 $search->delete( $this->id
, $normalTitle );
96 } elseif ( $this->content
=== false ) {
97 $search->updateTitle( $this->id
, $normalTitle );
101 $text = $search->getTextFromContent( $this->title
, $this->content
);
102 if ( !$search->textAlreadyUpdatedForIndex() ) {
103 $text = self
::updateText( $text );
106 # Perform the actual update
107 $search->update( $this->id
, $normalTitle, $search->normalizeText( $text ) );
113 * Clean text for indexing. Only really suitable for indexing in databases.
114 * If you're using a real search engine, you'll probably want to override
115 * this behavior and do something nicer with the original wikitext.
116 * @param string $text
119 public static function updateText( $text ) {
122 # Language-specific strip/conversion
123 $text = $wgContLang->normalizeForSearch( $text );
124 $lc = SearchEngine
::legalSearchChars() . '&#;';
126 $text = preg_replace( "/<\\/?\\s*[A-Za-z][^>]*?>/",
127 ' ', $wgContLang->lc( " " . $text . " " ) ); # Strip HTML markup
128 $text = preg_replace( "/(^|\\n)==\\s*([^\\n]+)\\s*==(\\s)/sD",
129 "\\1\\2 \\2 \\2\\3", $text ); # Emphasize headings
131 # Strip external URLs
132 $uc = "A-Za-z0-9_\\/:.,~%\\-+&;#?!=()@\\x80-\\xFF";
133 $protos = "http|https|ftp|mailto|news|gopher";
134 $pat = "/(^|[^\\[])({$protos}):[{$uc}]+([^{$uc}]|$)/";
135 $text = preg_replace( $pat, "\\1 \\3", $text );
137 $p1 = "/([^\\[])\\[({$protos}):[{$uc}]+]/";
138 $p2 = "/([^\\[])\\[({$protos}):[{$uc}]+\\s+([^\\]]+)]/";
139 $text = preg_replace( $p1, "\\1 ", $text );
140 $text = preg_replace( $p2, "\\1 \\3 ", $text );
142 # Internal image links
143 $pat2 = "/\\[\\[image:([{$uc}]+)\\.(gif|png|jpg|jpeg)([^{$uc}])/i";
144 $text = preg_replace( $pat2, " \\1 \\3", $text );
146 $text = preg_replace( "/([^{$lc}])([{$lc}]+)]]([a-z]+)/",
147 "\\1\\2 \\2\\3", $text ); # Handle [[game]]s
149 # Strip all remaining non-search characters
150 $text = preg_replace( "/[^{$lc}]+/", " ", $text );
154 # $text = preg_replace( "/([{$lc}]+)'s /", "\\1 \\1's ", $text );
155 # $text = preg_replace( "/([{$lc}]+)s' /", "\\1s ", $text );
157 # These tail-anchored regexps are insanely slow. The worst case comes
158 # when Japanese or Chinese text (ie, no word spacing) is written on
159 # a wiki configured for Western UTF-8 mode. The Unicode characters are
160 # expanded to hex codes and the "words" are very long paragraph-length
161 # monstrosities. On a large page the above regexps may take over 20
162 # seconds *each* on a 1GHz-level processor.
164 # Following are reversed versions which are consistently fast
165 # (about 3 milliseconds on 1GHz-level processor).
167 $text = strrev( preg_replace( "/ s'([{$lc}]+)/", " s'\\1 \\1", strrev( $text ) ) );
168 $text = strrev( preg_replace( "/ 's([{$lc}]+)/", " s\\1", strrev( $text ) ) );
170 # Strip wiki '' and '''
171 $text = preg_replace( "/''[']*/", " ", $text );
177 * Get a string representation of a title suitable for
178 * including in a search index
180 * @param SearchEngine $search
181 * @return string A stripped-down title string ready for the search index
183 private function indexTitle( SearchEngine
$search ) {
186 $ns = $this->title
->getNamespace();
187 $title = $this->title
->getText();
189 $lc = $search->legalSearchChars() . '&#;';
190 $t = $wgContLang->normalizeForSearch( $title );
191 $t = preg_replace( "/[^{$lc}]+/", ' ', $t );
192 $t = $wgContLang->lc( $t );
195 $t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
196 $t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
198 $t = preg_replace( "/\\s+/", ' ', $t );
200 if ( $ns == NS_FILE
) {
201 $t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );