2 * This module handles fulltext indexing of the message base.
3 * Copyright (c) 2005-2017 by the citadel.org team
5 * This program is open source software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as published
7 * by the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include <sys/types.h>
30 #if TIME_WITH_SYS_TIME
31 # include <sys/time.h>
35 # include <sys/time.h>
44 #include <libcitadel.h>
47 #include "citserver.h"
53 #include "serv_fulltext.h"
54 #include "ft_wordbreaker.h"
58 #include "ctdl_module.h"
60 long ft_newhighest = 0L;
61 long *ft_newmsgs = NULL;
65 int ftc_num_msgs[65536];
66 long *ftc_msgs[65536];
72 int longcmp(const void *rec1, const void *rec2) {
75 i1 = *(const long *)rec1;
76 i2 = *(const long *)rec2;
78 if (i1 > i2) return(1);
79 if (i1 < i2) return(-1);
84 * Flush our index cache out to disk.
86 void ft_flush_cache(void) {
88 time_t last_update = 0;
90 for (i=0; i<65536; ++i) {
91 if ((time(NULL) - last_update) >= 10) {
93 "fulltext: flushing index cache to disk (%d%% complete)",
96 last_update = time(NULL);
98 if (ftc_msgs[i] != NULL) {
99 cdb_store(CDB_FULLTEXT, &i, sizeof(int), ftc_msgs[i],
100 (ftc_num_msgs[i] * sizeof(long)));
106 syslog(LOG_INFO, "fulltext: flushed index cache to disk (100%% complete)");
111 * Index or de-index a message. (op == 1 to index, 0 to de-index)
113 void ft_index_message(long msgnum, int op) {
117 struct cdbdata *cdb_bucket;
121 struct CtdlMessage *msg = NULL;
123 msg = CtdlFetchMessage(msgnum, 1, 1);
125 syslog(LOG_ERR, "fulltext: ft_index_message() could not load msg %ld", msgnum);
129 if (!CM_IsEmpty(msg, eSuppressIdx)) {
130 syslog(LOG_DEBUG, "fulltext: ft_index_message() excluded msg %ld", msgnum);
135 syslog(LOG_DEBUG, "fulltext: ft_index_message() %s msg %ld", (op ? "adding" : "removing") , msgnum);
137 /* Output the message as text before indexing it, so we don't end up
138 * indexing a bunch of encoded base64, etc.
140 CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
141 CtdlOutputPreLoadedMsg(msg, MT_CITADEL, HEADERS_ALL, 0, 1, 0);
143 msgtext = CC->redirect_buffer;
144 CC->redirect_buffer = NULL;
145 if (msgtext != NULL) {
146 syslog(LOG_DEBUG, "fulltext: wordbreaking message %ld (%d bytes)", msgnum, StrLength(msgtext));
148 txt = SmashStrBuf(&msgtext);
149 wordbreaker(txt, &num_tokens, &tokens);
152 syslog(LOG_DEBUG, "fulltext: indexing message %ld [%d tokens]", msgnum, num_tokens);
153 if (num_tokens > 0) {
154 for (i=0; i<num_tokens; ++i) {
156 /* Add the message to the relevant token bucket */
158 /* search for tokens[i] */
161 if ( (tok >= 0) && (tok <= 65535) ) {
162 /* fetch the bucket, Liza */
163 if (ftc_msgs[tok] == NULL) {
164 cdb_bucket = cdb_fetch(CDB_FULLTEXT, &tok, sizeof(int));
165 if (cdb_bucket != NULL) {
166 ftc_num_msgs[tok] = cdb_bucket->len / sizeof(long);
167 ftc_msgs[tok] = (long *)cdb_bucket->ptr;
168 cdb_bucket->ptr = NULL;
169 cdb_free(cdb_bucket);
172 ftc_num_msgs[tok] = 0;
173 ftc_msgs[tok] = malloc(sizeof(long));
178 if (op == 1) { /* add to index */
180 ftc_msgs[tok] = realloc(ftc_msgs[tok],
181 ftc_num_msgs[tok]*sizeof(long));
182 ftc_msgs[tok][ftc_num_msgs[tok] - 1] = msgnum;
185 if (op == 0) { /* remove from index */
186 if (ftc_num_msgs[tok] >= 1) {
187 for (j=0; j<ftc_num_msgs[tok]; ++j) {
188 if (ftc_msgs[tok][j] == msgnum) {
189 memmove(&ftc_msgs[tok][j], &ftc_msgs[tok][j+1], ((ftc_num_msgs[tok] - j - 1)*sizeof(long)));
198 syslog(LOG_ALERT, "fulltext: invalid token %d !!", tok);
209 * Add a message to the list of those to be indexed.
211 void ft_index_msg(long msgnum, void *userdata) {
213 if ((msgnum > CtdlGetConfigLong("MMfulltext")) && (msgnum <= ft_newhighest)) {
215 if (ft_num_msgs > ft_num_alloc) {
216 ft_num_alloc += 1024;
217 ft_newmsgs = realloc(ft_newmsgs,
218 (ft_num_alloc * sizeof(long)));
220 ft_newmsgs[ft_num_msgs - 1] = msgnum;
226 * Scan a room for messages to index.
228 void ft_index_room(struct ctdlroom *qrbuf, void *data)
230 if (server_shutting_down)
233 CtdlGetRoom(&CC->room, qrbuf->QRname);
234 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, ft_index_msg, NULL);
239 * Begin the fulltext indexing process.
241 void do_fulltext_indexing(void) {
243 static time_t last_index = 0L;
244 static time_t last_progress = 0L;
245 static int is_running = 0;
246 if (is_running) return; /* Concurrency check - only one can run */
250 * Don't do this if the site doesn't have it enabled.
252 if (!CtdlGetConfigInt("c_enable_fulltext")) {
257 * Make sure we don't run the indexer too frequently.
258 * FIXME move the setting into config
259 time_t now = time(NULL);
260 if ( (now - last_index) < 300L) {
262 "fulltext: indexing interval not yet reached; last run was %ldm%lds ago",
263 ((now - last_index) / 60),
264 ((now - last_index) % 60)
271 * Silently return if our fulltext index is up to date with new messages.
274 (CtdlGetConfigLong("MMfulltext") >= CtdlGetConfigLong("MMhighest"))
275 && (CtdlGetConfigInt("MM_fulltext_wordbreaker") == FT_WORDBREAKER_ID)
277 return; /* nothing to do! */
281 * If we've switched wordbreaker modules, burn the index and start
284 begin_critical_section(S_CONTROL);
285 if (CtdlGetConfigInt("MM_fulltext_wordbreaker") != FT_WORDBREAKER_ID) {
286 syslog(LOG_DEBUG, "fulltext: wb ver on disk = %d, code ver = %d",
287 CtdlGetConfigInt("MM_fulltext_wordbreaker"), FT_WORDBREAKER_ID
289 syslog(LOG_INFO, "fulltext: (re)initializing index");
290 cdb_trunc(CDB_FULLTEXT);
291 CtdlSetConfigLong("MMfulltext", 0);
293 end_critical_section(S_CONTROL);
296 * Now go through each room and find messages to index.
298 ft_newhighest = CtdlGetConfigLong("MMhighest");
299 CtdlForEachRoom(ft_index_room, NULL); /* load all msg pointers */
301 if (ft_num_msgs > 0) {
302 qsort(ft_newmsgs, ft_num_msgs, sizeof(long), longcmp);
303 for (i=0; i<(ft_num_msgs-1); ++i) { /* purge dups */
304 if (ft_newmsgs[i] == ft_newmsgs[i+1]) {
305 memmove(&ft_newmsgs[i], &ft_newmsgs[i+1],
306 ((ft_num_msgs - i - 1)*sizeof(long)));
312 /* Here it is ... do each message! */
313 for (i=0; i<ft_num_msgs; ++i) {
314 if (time(NULL) != last_progress) {
316 "fulltext: indexed %d of %d messages (%d%%)",
318 ((i*100) / ft_num_msgs)
320 last_progress = time(NULL);
322 ft_index_message(ft_newmsgs[i], 1);
324 /* Check to see if we need to quit early */
325 if (server_shutting_down) {
326 syslog(LOG_DEBUG, "fulltext: indexer quitting early");
327 ft_newhighest = ft_newmsgs[i];
331 /* Check to see if we have to maybe flush to disk */
332 if (i >= FT_MAX_CACHE) {
333 syslog(LOG_DEBUG, "fulltext: time to flush.");
334 ft_newhighest = ft_newmsgs[i];
346 if (server_shutting_down) {
351 /* Save our place so we don't have to do this again */
353 begin_critical_section(S_CONTROL);
354 CtdlSetConfigLong("MMfulltext", ft_newhighest);
355 CtdlSetConfigInt("MM_fulltext_wordbreaker", FT_WORDBREAKER_ID);
356 end_critical_section(S_CONTROL);
357 last_index = time(NULL);
359 syslog(LOG_DEBUG, "fulltext: indexing finished");
367 * API call to perform searches.
368 * (This one does the "all of these words" search.)
369 * Caller is responsible for freeing the message list.
371 void ft_search(int *fts_num_msgs, long **fts_msgs, const char *search_string) {
375 struct cdbdata *cdb_bucket;
376 int num_all_msgs = 0;
377 long *all_msgs = NULL;
378 int num_ret_msgs = 0;
379 int num_ret_alloc = 0;
380 long *ret_msgs = NULL;
383 wordbreaker(search_string, &num_tokens, &tokens);
384 if (num_tokens > 0) {
385 for (i=0; i<num_tokens; ++i) {
387 /* search for tokens[i] */
390 /* fetch the bucket, Liza */
391 if (ftc_msgs[tok] == NULL) {
392 cdb_bucket = cdb_fetch(CDB_FULLTEXT, &tok, sizeof(int));
393 if (cdb_bucket != NULL) {
394 ftc_num_msgs[tok] = cdb_bucket->len / sizeof(long);
395 ftc_msgs[tok] = (long *)cdb_bucket->ptr;
396 cdb_bucket->ptr = NULL;
397 cdb_free(cdb_bucket);
400 ftc_num_msgs[tok] = 0;
401 ftc_msgs[tok] = malloc(sizeof(long));
405 num_all_msgs += ftc_num_msgs[tok];
406 if (num_all_msgs > 0) {
407 all_msgs = realloc(all_msgs, num_all_msgs*sizeof(long) );
408 memcpy(&all_msgs[num_all_msgs-ftc_num_msgs[tok]],
409 ftc_msgs[tok], ftc_num_msgs[tok]*sizeof(long) );
414 if (all_msgs != NULL) {
415 qsort(all_msgs, num_all_msgs, sizeof(long), longcmp);
418 * At this point, if a message appears num_tokens times in the
419 * list, then it contains all of the search tokens.
421 if (num_all_msgs >= num_tokens)
422 for (j=0; j<(num_all_msgs-num_tokens+1); ++j) {
423 if (all_msgs[j] == all_msgs[j+num_tokens-1]) {
426 if (num_ret_msgs > num_ret_alloc) {
428 ret_msgs = realloc(ret_msgs,
429 (num_ret_alloc*sizeof(long)) );
431 ret_msgs[num_ret_msgs - 1] = all_msgs[j];
439 *fts_num_msgs = num_ret_msgs;
440 *fts_msgs = ret_msgs;
445 * This search command is for diagnostic purposes and may be removed or replaced.
447 void cmd_srch(char *argbuf) {
451 char search_string[256];
453 if (CtdlAccessCheck(ac_logged_in)) return;
455 if (!CtdlGetConfigInt("c_enable_fulltext")) {
456 cprintf("%d Full text index is not enabled on this server.\n",
457 ERROR + CMD_NOT_SUPPORTED);
461 extract_token(search_string, argbuf, 0, '|', sizeof search_string);
462 ft_search(&num_msgs, &msgs, search_string);
464 cprintf("%d %d msgs match all search words:\n",
465 LISTING_FOLLOWS, num_msgs);
467 for (i=0; i<num_msgs; ++i) {
468 cprintf("%ld\n", msgs[i]);
471 if (msgs != NULL) free(msgs);
476 * Zero out our index cache.
478 void initialize_ft_cache(void) {
479 memset(ftc_num_msgs, 0, (65536 * sizeof(int)));
480 memset(ftc_msgs, 0, (65536 * sizeof(long *)));
484 void ft_delete_remove(char *room, long msgnum)
488 /* Remove from fulltext index */
489 if (CtdlGetConfigInt("c_enable_fulltext")) {
490 ft_index_message(msgnum, 0);
494 /*****************************************************************************/
496 CTDL_MODULE_INIT(fulltext)
500 initialize_ft_cache();
501 initialize_noise_words();
502 CtdlRegisterProtoHook(cmd_srch, "SRCH", "Full text search");
503 CtdlRegisterDeleteHook(ft_delete_remove);
504 CtdlRegisterSearchFuncHook(ft_search, "fulltext");
505 CtdlRegisterCleanupHook(noise_word_cleanup);
506 CtdlRegisterSessionHook(do_fulltext_indexing, EVT_TIMER, PRIO_CLEANUP + 300);
508 /* return our module name for the log */