citadel/serv_fulltext.c

   1 /*
   2  * $Id$
   3  *
   4  * This module handles fulltext indexing of the message base.
   5  *
   6  */
   7
   8
   9 #include "sysdep.h"
  10 #include <stdlib.h>
  11 #include <unistd.h>
  12 #include <stdio.h>
  13 #include <fcntl.h>
  14 #include <signal.h>
  15 #include <pwd.h>
  16 #include <errno.h>
  17 #include <sys/types.h>
  18
  19 #if TIME_WITH_SYS_TIME
  20 # include <sys/time.h>
  21 # include <time.h>
  22 #else
  23 # if HAVE_SYS_TIME_H
  24 #  include <sys/time.h>
  25 # else
  26 #  include <time.h>
  27 # endif
  28 #endif
  29
  30 #include <sys/wait.h>
  31 #include <string.h>
  32 #include <limits.h>
  33 #include "citadel.h"
  34 #include "server.h"
  35 #include "sysdep_decls.h"
  36 #include "citserver.h"
  37 #include "support.h"
  38 #include "config.h"
  39 #include "serv_extensions.h"
  40 #include "database.h"
  41 #include "msgbase.h"
  42 #include "control.h"
  43 #include "room_ops.h"
  44 #include "tools.h"
  45 #include "serv_fulltext.h"
  46 #include "ft_wordbreaker.h"
  47
  48
  49 long ft_newhighest = 0L;
  50 long *ft_newmsgs = NULL;
  51 int ft_num_msgs = 0;
  52 int ft_num_alloc = 0;
  53
  54
  55 /*
  56  * Compare function
  57  */
  58 int longcmp(const void *rec1, const void *rec2) {
  59         long i1, i2;
  60
  61         i1 = *(const long *)rec1;
  62         i2 = *(const long *)rec2;
  63
  64         if (i1 > i2) return(1);
  65         if (i1 < i2) return(-1);
  66         return(0);
  67 }
  68
  69
  70
  71
  72 /*
  73  * Index or de-index a message.  (op == 1 to index, 0 to de-index)
  74  */
  75 void ft_index_message(long msgnum, int op) {
  76         int num_tokens = 0;
  77         int *tokens = NULL;
  78         int i, j;
  79         struct cdbdata *cdb_bucket;
  80         int num_msgs;
  81         long *msgs;
  82         char *msgtext;
  83
  84         lprintf(CTDL_DEBUG, "ft_index_message() %s msg %ld\n",
  85                 (op ? "adding" : "removing") , msgnum
  86         );
  87
  88         /* Output the message as text before indexing it, so we don't end up
  89          * indexing a bunch of encoded base64, etc.
  90          */
  91         CC->redirect_buffer = malloc(SIZ);
  92         CC->redirect_len = 0;
  93         CC->redirect_alloc = SIZ;
  94         CtdlOutputMsg(msgnum, MT_CITADEL, HEADERS_ALL, 0, 1);
  95         msgtext = CC->redirect_buffer;
  96         CC->redirect_buffer = NULL;
  97         CC->redirect_len = 0;
  98         CC->redirect_alloc = 0;
  99         lprintf(CTDL_DEBUG, "Wordbreaking message %ld...\n", msgnum);
 100         wordbreaker(msgtext, &num_tokens, &tokens);
 101         free(msgtext);
 102
 103         lprintf(CTDL_DEBUG, "Indexing message %ld...\n", msgnum);
 104         if (num_tokens > 0) {
 105                 for (i=0; i<num_tokens; ++i) {
 106
 107                         /* Add the message to the relevant token bucket */
 108
 109                         /* FIXME lock the file */
 110                         cdb_bucket = cdb_fetch(CDB_FULLTEXT, &tokens[i], sizeof(int));
 111                         if (cdb_bucket == NULL) {
 112                                 cdb_bucket = malloc(sizeof(struct cdbdata));
 113                                 cdb_bucket->len = 0;
 114                                 cdb_bucket->ptr = NULL;
 115                                 num_msgs = 0;
 116                         }
 117                         else {
 118                                 num_msgs = cdb_bucket->len / sizeof(long);
 119                         }
 120
 121                         if (op == 1) {  /* add to index */
 122                                 ++num_msgs;
 123                                 cdb_bucket->ptr = realloc(cdb_bucket->ptr, num_msgs*sizeof(long) );
 124                                 msgs = (long *) cdb_bucket->ptr;
 125                                 msgs[num_msgs - 1] = msgnum;
 126                         }
 127
 128                         if (op == 0) {  /* remove from index */
 129                                 if (num_msgs >= 1) {
 130                                 msgs = (long *) cdb_bucket->ptr;
 131                                         for (j=0; j<num_msgs; ++j) {
 132                                                 if (msgs[j] == msgnum) {
 133                                                         memmove(&msgs[j], &msgs[j+1], ((num_msgs - j - 1)*sizeof(long)));
 134                                                         --num_msgs;
 135                                                         --j;
 136                                                 }
 137                                         }
 138                                 }
 139                         }
 140
 141                         /* sort and purge dups
 142                          *
 143                          * This whole section is commented out because it's
 144                          * no longer needed -- since the tokenizer already
 145                          * does a merge/purge on the tokens it returns, and
 146                          * we're guaranteed to always be indexing a message
 147                          * with a number higher than any already in the index.
 148                          *
 149                         if ( (op == 1) && (num_msgs > 1) ) {
 150                                 msgs = (long *) cdb_bucket->ptr;
 151                                 qsort(msgs, num_msgs, sizeof(long), longcmp);
 152                                 for (j=0; j<(num_msgs-1); ++j) {
 153                                         if (msgs[j] == msgs[j+1]) {
 154                                                 memmove(&msgs[j], &msgs[j+1], ((num_msgs - j - 1)*sizeof(long)));
 155                                                 --num_msgs;
 156                                                 --j;
 157                                         }
 158                                 }
 159                         }
 160                         */
 161
 162                         cdb_store(CDB_FULLTEXT, &tokens[i], sizeof(int),
 163                                 msgs, (num_msgs*sizeof(long)) );
 164
 165                         cdb_free(cdb_bucket);
 166
 167                         /* FIXME unlock the file */
 168                 }
 169
 170                 free(tokens);
 171         }
 172 }
 173
 174
 175
 176 /*
 177  * Add a message to the list of those to be indexed.
 178  */
 179 void ft_index_msg(long msgnum, void *userdata) {
 180
 181         if ((msgnum > CitControl.MMfulltext) && (msgnum <= ft_newhighest)) {
 182                 ++ft_num_msgs;
 183                 if (ft_num_msgs > ft_num_alloc) {
 184                         ft_num_alloc += 1024;
 185                         ft_newmsgs = realloc(ft_newmsgs,
 186                                 (ft_num_alloc * sizeof(long)));
 187                 }
 188                 ft_newmsgs[ft_num_msgs - 1] = msgnum;
 189         }
 190
 191 }
 192
 193 /*
 194  * Scan a room for messages to index.
 195  */
 196 void ft_index_room(struct ctdlroom *qrbuf, void *data)
 197 {
 198         getroom(&CC->room, qrbuf->QRname);
 199         CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, ft_index_msg, NULL);
 200 }
 201
 202
 203 /*
 204  * Begin the fulltext indexing process.  (Called as an EVT_TIMER event)
 205  */
 206 void do_fulltext_indexing(void) {
 207         int i;
 208         static time_t last_index = 0L;
 209         static time_t last_progress = 0L;
 210
 211         /*
 212          * Make sure we don't run the indexer too frequently.
 213          * FIXME move the setting into config
 214          */
 215         if ( (time(NULL) - last_index) < 300L) {
 216                 return;
 217         }
 218
 219         /*
 220          * Check to see whether the fulltext index is up to date; if there
 221          * are no messages to index, don't waste any more time trying.
 222          */
 223         if (CitControl.MMfulltext >= CitControl.MMhighest) {
 224                 return;         /* nothing to do! */
 225         }
 226
 227         lprintf(CTDL_DEBUG, "do_fulltext_indexing() started\n");
 228
 229         /*
 230          * If we've switched wordbreaker modules, burn the index and start
 231          * over.  FIXME write this...
 232          */
 233         if (CitControl.fulltext_wordbreaker != FT_WORDBREAKER_ID) {
 234                 lprintf(CTDL_INFO, "(re)initializing full text index\n");
 235                 cdb_trunc(CDB_FULLTEXT);
 236                 CitControl.MMfulltext = 0L;
 237                 put_control();
 238         }
 239
 240         /*
 241          * Now go through each room and find messages to index.
 242          */
 243         ft_newhighest = CitControl.MMhighest;
 244         ForEachRoom(ft_index_room, NULL);       /* load all msg pointers */
 245
 246         if (ft_num_msgs > 0) {
 247                 qsort(ft_newmsgs, ft_num_msgs, sizeof(long), longcmp);
 248                 for (i=0; i<(ft_num_msgs-1); ++i) { /* purge dups */
 249                         if (ft_newmsgs[i] == ft_newmsgs[i+1]) {
 250                                 memmove(&ft_newmsgs[i], &ft_newmsgs[i+1],
 251                                         ((ft_num_msgs - i - 1)*sizeof(long)));
 252                                 --ft_num_msgs;
 253                                 --i;
 254                         }
 255                 }
 256
 257                 /* Here it is ... do each message! */
 258                 for (i=0; i<ft_num_msgs; ++i) {
 259                         if ((time(NULL) - last_progress) > 10) {
 260                                 lprintf(CTDL_DEBUG,
 261                                         "Indexed %d of %d messages (%d%%)\n",
 262                                                 i, ft_num_msgs,
 263                                                 ((i*100) / ft_num_msgs)
 264                                 );
 265                                 last_progress = time(NULL);
 266                         }
 267                         ft_index_message(ft_newmsgs[i], 1);
 268                 }
 269
 270                 free(ft_newmsgs);
 271                 ft_num_msgs = 0;
 272                 ft_num_alloc = 0;
 273                 ft_newmsgs = NULL;
 274         }
 275
 276         /* Save our place so we don't have to do this again */
 277         CitControl.MMfulltext = ft_newhighest;
 278         CitControl.fulltext_wordbreaker = FT_WORDBREAKER_ID;
 279         put_control();
 280         last_index = time(NULL);
 281
 282         lprintf(CTDL_DEBUG, "do_fulltext_indexing() finished\n");
 283         return;
 284 }
 285
 286
 287 /*
 288  * API call to perform searches.
 289  * (This one does the "all of these words" search.)
 290  * Caller is responsible for freeing the message list.
 291  */
 292 void ft_search(int *fts_num_msgs, long **fts_msgs, char *search_string) {
 293         int num_tokens = 0;
 294         int *tokens = NULL;
 295         int i, j;
 296         struct cdbdata *cdb_bucket;
 297         int num_msgs;
 298         long *msgs;
 299         int num_all_msgs = 0;
 300         long *all_msgs = NULL;
 301         int num_ret_msgs = 0;
 302         int num_ret_alloc = 0;
 303         long *ret_msgs = NULL;
 304
 305         wordbreaker(search_string, &num_tokens, &tokens);
 306         if (num_tokens > 0) {
 307                 for (i=0; i<num_tokens; ++i) {
 308
 309                         /* search for tokens[i] */
 310                         cdb_bucket = cdb_fetch(CDB_FULLTEXT, &tokens[i],
 311                                                                 sizeof(int));
 312                         if (cdb_bucket != NULL) {
 313                                 num_msgs = cdb_bucket->len / sizeof(long);
 314                                 msgs = (long *)cdb_bucket->ptr;
 315
 316                                 num_all_msgs += num_msgs;
 317                                 if (num_all_msgs > 0) {
 318                                         all_msgs = realloc(all_msgs,
 319                                                 num_all_msgs*sizeof(long) );
 320                                         memcpy(&all_msgs[num_all_msgs-num_msgs],
 321                                                 msgs, num_msgs*sizeof(long) );
 322                                 }
 323
 324                                 cdb_free(cdb_bucket);
 325                         }
 326
 327                 }
 328                 free(tokens);
 329                 qsort(all_msgs, num_all_msgs, sizeof(long), longcmp);
 330
 331                 /*
 332                  * At this point, if a message appears num_tokens times in the
 333                  * list, then it contains all of the search tokens.
 334                  */
 335                 if (num_all_msgs >= num_tokens)
 336                    for (j=0; j<(num_all_msgs-num_tokens+1); ++j) {
 337                         if (all_msgs[j] == all_msgs[j+num_tokens-1]) {
 338
 339                                 ++num_ret_msgs;
 340                                 if (num_ret_msgs > num_ret_alloc) {
 341                                         num_ret_alloc += 64;
 342                                         ret_msgs = realloc(ret_msgs,
 343                                                 (num_ret_alloc*sizeof(long)) );
 344                                 }
 345                                 ret_msgs[num_ret_msgs - 1] = all_msgs[j];
 346
 347                         }
 348                 }
 349
 350                 free(all_msgs);
 351         }
 352
 353         *fts_num_msgs = num_ret_msgs;
 354         *fts_msgs = ret_msgs;
 355 }
 356
 357
 358 /*
 359  * Tentative form of a search command
 360  */
 361 void cmd_srch(char *argbuf) {
 362         int num_msgs = 0;
 363         long *msgs = NULL;
 364         int i;
 365         char search_string[256];
 366
 367         if (CtdlAccessCheck(ac_logged_in)) return;
 368         extract_token(search_string, argbuf, 0, '|', sizeof search_string);
 369         ft_search(&num_msgs, &msgs, search_string);
 370
 371         cprintf("%d %d msgs match all search words:\n",
 372                 LISTING_FOLLOWS, num_msgs);
 373         if (num_msgs > 0) {
 374                 for (i=0; i<num_msgs; ++i) {
 375                         cprintf("%ld\n", msgs[i]);
 376                 }
 377         }
 378         if (msgs != NULL) free(msgs);
 379         cprintf("000\n");
 380 }
 381
 382
 383 /*****************************************************************************/
 384
 385 char *serv_fulltext_init(void)
 386 {
 387         CtdlRegisterSessionHook(do_fulltext_indexing, EVT_TIMER);
 388         CtdlRegisterProtoHook(cmd_srch, "SRCH", "Full text search");
 389         return "$Id$";
 390 }