4 * This module handles fulltext indexing of the message base.
17 #include <sys/types.h>
19 #if TIME_WITH_SYS_TIME
20 # include <sys/time.h>
24 # include <sys/time.h>
35 #include "citserver.h"
43 #include "serv_fulltext.h"
44 #include "ft_wordbreaker.h"
47 #include "ctdl_module.h"
51 long ft_newhighest = 0L;
52 long *ft_newmsgs = NULL;
57 int ftc_num_msgs[65536];
58 long *ftc_msgs[65536];
64 int longcmp(const void *rec1, const void *rec2) {
67 i1 = *(const long *)rec1;
68 i2 = *(const long *)rec2;
70 if (i1 > i2) return(1);
71 if (i1 < i2) return(-1);
76 * Flush our index cache out to disk.
78 void ft_flush_cache(void) {
80 time_t last_update = 0;
82 for (i=0; i<65536; ++i) {
83 if ((time(NULL) - last_update) >= 10) {
85 "Flushing index cache to disk (%d%% complete)\n",
88 last_update = time(NULL);
90 if (ftc_msgs[i] != NULL) {
91 cdb_store(CDB_FULLTEXT, &i, sizeof(int), ftc_msgs[i],
92 (ftc_num_msgs[i] * sizeof(long)));
98 lprintf(CTDL_INFO, "Flushed index cache to disk (100%% complete)\n");
103 * Index or de-index a message. (op == 1 to index, 0 to de-index)
105 void ft_index_message(long msgnum, int op) {
109 struct cdbdata *cdb_bucket;
113 lprintf(CTDL_DEBUG, "ft_index_message() %s msg %ld\n",
114 (op ? "adding" : "removing") , msgnum
117 /* Output the message as text before indexing it, so we don't end up
118 * indexing a bunch of encoded base64, etc.
120 CC->redirect_buffer = malloc(SIZ);
121 CC->redirect_len = 0;
122 CC->redirect_alloc = SIZ;
123 CtdlOutputMsg(msgnum, MT_CITADEL, HEADERS_ALL, 0, 1, NULL);
124 msgtext = CC->redirect_buffer;
125 CC->redirect_buffer = NULL;
126 CC->redirect_len = 0;
127 CC->redirect_alloc = 0;
128 lprintf(CTDL_DEBUG, "Wordbreaking message %ld...\n", msgnum);
129 wordbreaker(msgtext, &num_tokens, &tokens);
132 lprintf(CTDL_DEBUG, "Indexing message %ld [%d tokens]\n", msgnum, num_tokens);
133 if (num_tokens > 0) {
134 for (i=0; i<num_tokens; ++i) {
136 /* Add the message to the relevant token bucket */
138 /* search for tokens[i] */
141 if ( (tok >= 0) && (tok <= 65535) ) {
142 /* fetch the bucket, Liza */
143 if (ftc_msgs[tok] == NULL) {
144 cdb_bucket = cdb_fetch(CDB_FULLTEXT, &tok, sizeof(int));
145 if (cdb_bucket != NULL) {
146 ftc_num_msgs[tok] = cdb_bucket->len / sizeof(long);
147 ftc_msgs[tok] = (long *)cdb_bucket->ptr;
148 cdb_bucket->ptr = NULL;
149 cdb_free(cdb_bucket);
152 ftc_num_msgs[tok] = 0;
153 ftc_msgs[tok] = malloc(sizeof(long));
158 if (op == 1) { /* add to index */
160 ftc_msgs[tok] = realloc(ftc_msgs[tok],
161 ftc_num_msgs[tok]*sizeof(long));
162 ftc_msgs[tok][ftc_num_msgs[tok] - 1] = msgnum;
165 if (op == 0) { /* remove from index */
166 if (ftc_num_msgs[tok] >= 1) {
167 for (j=0; j<ftc_num_msgs[tok]; ++j) {
168 if (ftc_msgs[tok][j] == msgnum) {
169 memmove(&ftc_msgs[tok][j], &ftc_msgs[tok][j+1], ((ftc_num_msgs[tok] - j - 1)*sizeof(long)));
178 lprintf(CTDL_ALERT, "Invalid token %d !!\n", tok);
189 * Add a message to the list of those to be indexed.
191 void ft_index_msg(long msgnum, void *userdata) {
193 if ((msgnum > CitControl.MMfulltext) && (msgnum <= ft_newhighest)) {
195 if (ft_num_msgs > ft_num_alloc) {
196 ft_num_alloc += 1024;
197 ft_newmsgs = realloc(ft_newmsgs,
198 (ft_num_alloc * sizeof(long)));
200 ft_newmsgs[ft_num_msgs - 1] = msgnum;
206 * Scan a room for messages to index.
208 void ft_index_room(struct ctdlroom *qrbuf, void *data)
210 getroom(&CC->room, qrbuf->QRname);
211 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, ft_index_msg, NULL);
216 * Begin the fulltext indexing process. (Called as an EVT_TIMER event)
218 void do_fulltext_indexing(void) {
220 static time_t last_index = 0L;
221 static time_t last_progress = 0L;
224 * Don't do this if the site doesn't have it enabled.
226 if (!config.c_enable_fulltext) {
231 * Make sure we don't run the indexer too frequently.
232 * FIXME move the setting into config
234 if ( (time(NULL) - last_index) < 300L) {
239 * Check to see whether the fulltext index is up to date; if there
240 * are no messages to index, don't waste any more time trying.
242 if (CitControl.MMfulltext >= CitControl.MMhighest) {
243 return; /* nothing to do! */
246 lprintf(CTDL_DEBUG, "do_fulltext_indexing() started\n");
249 * If we've switched wordbreaker modules, burn the index and start
252 begin_critical_section(S_CONTROL);
253 lprintf(CTDL_DEBUG, "wb ver on disk = %d, code ver = %d\n",
254 CitControl.fulltext_wordbreaker, FT_WORDBREAKER_ID);
255 if (CitControl.fulltext_wordbreaker != FT_WORDBREAKER_ID) {
256 lprintf(CTDL_INFO, "(re)initializing full text index\n");
257 cdb_trunc(CDB_FULLTEXT);
258 CitControl.MMfulltext = 0L;
261 end_critical_section(S_CONTROL);
264 * Now go through each room and find messages to index.
266 ft_newhighest = CitControl.MMhighest;
267 ForEachRoom(ft_index_room, NULL); /* load all msg pointers */
269 if (ft_num_msgs > 0) {
270 qsort(ft_newmsgs, ft_num_msgs, sizeof(long), longcmp);
271 for (i=0; i<(ft_num_msgs-1); ++i) { /* purge dups */
272 if (ft_newmsgs[i] == ft_newmsgs[i+1]) {
273 memmove(&ft_newmsgs[i], &ft_newmsgs[i+1],
274 ((ft_num_msgs - i - 1)*sizeof(long)));
280 /* Here it is ... do each message! */
281 for (i=0; i<ft_num_msgs; ++i) {
282 if (time(NULL) != last_progress) {
284 "Indexed %d of %d messages (%d%%)\n",
286 ((i*100) / ft_num_msgs)
288 last_progress = time(NULL);
290 ft_index_message(ft_newmsgs[i], 1);
292 /* Check to see if we need to quit early */
294 lprintf(CTDL_DEBUG, "Indexer quitting early\n");
295 ft_newhighest = ft_newmsgs[i];
299 /* Check to see if we have to maybe flush to disk */
300 if (i >= FT_MAX_CACHE) {
301 lprintf(CTDL_DEBUG, "Time to flush.\n");
302 ft_newhighest = ft_newmsgs[i];
314 /* Save our place so we don't have to do this again */
316 begin_critical_section(S_CONTROL);
317 CitControl.MMfulltext = ft_newhighest;
318 CitControl.fulltext_wordbreaker = FT_WORDBREAKER_ID;
320 end_critical_section(S_CONTROL);
321 last_index = time(NULL);
323 lprintf(CTDL_DEBUG, "do_fulltext_indexing() finished\n");
328 * Main loop for the indexer thread.
330 void *indexer_thread(void *arg) {
331 struct CitContext indexerCC;
333 lprintf(CTDL_DEBUG, "indexer_thread() initializing\n");
335 memset(&indexerCC, 0, sizeof(struct CitContext));
336 indexerCC.internal_pgm = 1;
337 indexerCC.cs_pid = 0;
338 pthread_setspecific(MyConKey, (void *)&indexerCC );
342 while (!time_to_die) {
343 do_fulltext_indexing();
347 lprintf(CTDL_DEBUG, "indexer_thread() exiting\n");
354 * API call to perform searches.
355 * (This one does the "all of these words" search.)
356 * Caller is responsible for freeing the message list.
358 void ft_search(int *fts_num_msgs, long **fts_msgs, char *search_string) {
362 struct cdbdata *cdb_bucket;
363 int num_all_msgs = 0;
364 long *all_msgs = NULL;
365 int num_ret_msgs = 0;
366 int num_ret_alloc = 0;
367 long *ret_msgs = NULL;
370 wordbreaker(search_string, &num_tokens, &tokens);
371 if (num_tokens > 0) {
372 for (i=0; i<num_tokens; ++i) {
374 /* search for tokens[i] */
377 /* fetch the bucket, Liza */
378 if (ftc_msgs[tok] == NULL) {
379 cdb_bucket = cdb_fetch(CDB_FULLTEXT, &tok, sizeof(int));
380 if (cdb_bucket != NULL) {
381 ftc_num_msgs[tok] = cdb_bucket->len / sizeof(long);
382 ftc_msgs[tok] = (long *)cdb_bucket->ptr;
383 cdb_bucket->ptr = NULL;
384 cdb_free(cdb_bucket);
387 ftc_num_msgs[tok] = 0;
388 ftc_msgs[tok] = malloc(sizeof(long));
392 num_all_msgs += ftc_num_msgs[tok];
393 if (num_all_msgs > 0) {
394 all_msgs = realloc(all_msgs, num_all_msgs*sizeof(long) );
395 memcpy(&all_msgs[num_all_msgs-ftc_num_msgs[tok]],
396 ftc_msgs[tok], ftc_num_msgs[tok]*sizeof(long) );
401 qsort(all_msgs, num_all_msgs, sizeof(long), longcmp);
404 * At this point, if a message appears num_tokens times in the
405 * list, then it contains all of the search tokens.
407 if (num_all_msgs >= num_tokens)
408 for (j=0; j<(num_all_msgs-num_tokens+1); ++j) {
409 if (all_msgs[j] == all_msgs[j+num_tokens-1]) {
412 if (num_ret_msgs > num_ret_alloc) {
414 ret_msgs = realloc(ret_msgs,
415 (num_ret_alloc*sizeof(long)) );
417 ret_msgs[num_ret_msgs - 1] = all_msgs[j];
425 *fts_num_msgs = num_ret_msgs;
426 *fts_msgs = ret_msgs;
431 * This search command is for diagnostic purposes and may be removed or replaced.
433 void cmd_srch(char *argbuf) {
437 char search_string[256];
439 if (CtdlAccessCheck(ac_logged_in)) return;
441 if (!config.c_enable_fulltext) {
442 cprintf("%d Full text index is not enabled on this server.\n",
443 ERROR + CMD_NOT_SUPPORTED);
447 extract_token(search_string, argbuf, 0, '|', sizeof search_string);
448 ft_search(&num_msgs, &msgs, search_string);
450 cprintf("%d %d msgs match all search words:\n",
451 LISTING_FOLLOWS, num_msgs);
453 for (i=0; i<num_msgs; ++i) {
454 cprintf("%ld\n", msgs[i]);
457 if (msgs != NULL) free(msgs);
462 * Zero out our index cache.
464 void initialize_ft_cache(void) {
465 memset(ftc_num_msgs, 0, (65536 * sizeof(int)));
466 memset(ftc_msgs, 0, (65536 * sizeof(long *)));
470 void ft_delete_remove(char *room, long msgnum)
474 /* Remove from fulltext index */
475 if (config.c_enable_fulltext) {
476 ft_index_message(msgnum, 0);
480 /*****************************************************************************/
482 CTDL_MODULE_INIT(fulltext)
484 initialize_ft_cache();
485 CtdlRegisterProtoHook(cmd_srch, "SRCH", "Full text search");
486 CtdlRegisterDeleteHook(ft_delete_remove);
487 CtdlRegisterSearchFuncHook(ft_search, "fulltext");
488 CtdlRegisterMaintenanceThread ("indexer", indexer_thread);
490 /* return our Subversion id for the Log */