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  * Index or de-index a message.  (op == 1 to index, 0 to de-index)
  57  */
  58 void ft_index_message(long msgnum, int op) {
  59         struct CtdlMessage *msg;
  60         int num_tokens = 0;
  61         int *tokens = NULL;
  62         int i;
  63         struct cdbdata *cdb_bucket;
  64         int num_msgs;
  65         long *msgs;
  66
  67         msg = CtdlFetchMessage(msgnum, 1);
  68         if (msg == NULL) return;
  69
  70         if (msg->cm_fields['M'] != NULL) {
  71                 wordbreaker(msg->cm_fields['M'], &num_tokens, &tokens);
  72         }
  73         CtdlFreeMessage(msg);
  74
  75         if (num_tokens > 0) {
  76                 for (i=0; i<num_tokens; ++i) {
  77
  78                         /* Add the message to the relevant token bucket */
  79
  80                         /* FIXME do "if op=1" ... */
  81
  82                         /* FIXME lock the file */
  83                         cdb_bucket = cdb_fetch(CDB_FULLTEXT, &tokens[i], sizeof(int));
  84                         if (cdb_bucket == NULL) {
  85                                 cdb_bucket = malloc(sizeof(struct cdbdata));
  86                                 cdb_bucket->len = 0;
  87                                 cdb_bucket->ptr = malloc(sizeof(long));
  88                         }
  89                         num_msgs = cdb_bucket->len / sizeof(long);
  90
  91                         ++num_msgs;
  92                         cdb_bucket->ptr = realloc(cdb_bucket->ptr, num_msgs*sizeof(long) );
  93                         msgs = (long *) cdb_bucket->ptr;
  94                         msgs[num_msgs - 1] = msgnum;
  95
  96                         cdb_store(CDB_FULLTEXT, &tokens[i], sizeof(int),
  97                                 cdb_bucket->ptr, num_msgs*sizeof(long) );
  98
  99                         cdb_free(cdb_bucket);
 100
 101                         /* FIXME unlock the file */
 102                 }
 103
 104                 free(tokens);
 105         }
 106 }
 107
 108
 109
 110 /*
 111  * Add a message to the list of those to be indexed.
 112  */
 113 void ft_index_msg(long msgnum, void *userdata) {
 114
 115         if ((msgnum > CitControl.MMfulltext) && (msgnum <= ft_newhighest)) {
 116                 ++ft_num_msgs;
 117                 if (ft_num_msgs > ft_num_alloc) {
 118                         ft_num_alloc += 1024;
 119                         ft_newmsgs = realloc(ft_newmsgs,
 120                                 (ft_num_alloc * sizeof(long)));
 121                 }
 122                 ft_newmsgs[ft_num_msgs - 1] = msgnum;
 123         }
 124
 125 }
 126
 127 /*
 128  * Scan a room for messages to index.
 129  */
 130 void ft_index_room(struct ctdlroom *qrbuf, void *data)
 131 {
 132         getroom(&CC->room, qrbuf->QRname);
 133         CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, ft_index_msg, NULL);
 134 }
 135
 136
 137 /*
 138  * Compare function
 139  */
 140 int longcmp(const void *rec1, const void *rec2) {
 141         long i1, i2;
 142
 143         i1 = *(const long *)rec1;
 144         i2 = *(const long *)rec2;
 145
 146         if (i1 > i2) return(1);
 147         if (i1 < i2) return(-1);
 148         return(0);
 149 }
 150
 151
 152 /*
 153  * Begin the fulltext indexing process.  (Called as an EVT_TIMER event)
 154  */
 155 void do_fulltext_indexing(void) {
 156         int i;
 157         static time_t last_index = 0L;
 158
 159         /*
 160          * Make sure we don't run the indexer too frequently.
 161          * FIXME move the setting into config
 162          */
 163         if ( (time(NULL) - last_index) < 300L) {
 164                 return;
 165         }
 166
 167         /*
 168          * Check to see whether the fulltext index is up to date; if there
 169          * are no messages to index, don't waste any more time trying.
 170          */
 171         lprintf(CTDL_DEBUG, "CitControl.MMhighest  = %ld\n",
 172                 CitControl.MMhighest);
 173         lprintf(CTDL_DEBUG, "CitControl.MMfulltext = %ld\n",
 174                 CitControl.MMfulltext);
 175         if (CitControl.MMfulltext >= CitControl.MMhighest) {
 176                 /* nothing to do! */
 177                 return;
 178         }
 179
 180         lprintf(CTDL_DEBUG, "do_fulltext_indexing() started\n");
 181
 182         /*
 183          * If we've switched wordbreaker modules, burn the index and start
 184          * over.  FIXME write this...
 185          */
 186         if (CitControl.fulltext_wordbreaker != FT_WORDBREAKER_ID) {
 187                 lprintf(CTDL_INFO, "(re)initializing full text index\n");
 188                 cdb_trunc(CDB_FULLTEXT);
 189                 CitControl.MMfulltext = 0L;
 190                 put_control();
 191         }
 192
 193         /*
 194          * Now go through each room and find messages to index.
 195          */
 196         ft_newhighest = CitControl.MMhighest;
 197         ForEachRoom(ft_index_room, NULL);       /* load all msg pointers */
 198
 199         if (ft_num_msgs > 0) {
 200                 qsort(ft_newmsgs, ft_num_msgs, sizeof(long), longcmp);
 201                 if (i>1) for (i=0; i<(ft_num_msgs-1); ++i) { /* purge dups */
 202                         if (ft_newmsgs[i] == ft_newmsgs[i+1]) {
 203                                 memmove(&ft_newmsgs[i], &ft_newmsgs[i+1],
 204                                         ((ft_num_msgs - i)*sizeof(long)));
 205                                 --ft_num_msgs;
 206                         }
 207                 }
 208
 209                 /* Here it is ... do each message! */
 210                 for (i=0; i<ft_num_msgs; ++i) {
 211                         ft_index_message(ft_newmsgs[i], 1);
 212                 }
 213
 214                 free(ft_newmsgs);
 215                 ft_num_msgs = 0;
 216                 ft_num_alloc = 0;
 217                 ft_newmsgs = NULL;
 218         }
 219
 220         /* Save our place so we don't have to do this again */
 221         CitControl.MMfulltext = ft_newhighest;
 222         CitControl.fulltext_wordbreaker = FT_WORDBREAKER_ID;
 223         put_control();
 224         last_index = time(NULL);
 225
 226         lprintf(CTDL_DEBUG, "do_fulltext_indexing() finished\n");
 227         return;
 228 }
 229
 230
 231 /*
 232  * Tentative form of our search command
 233  */
 234 void cmd_srch(char *argbuf) {
 235         char search_string[256];
 236         int num_tokens = 0;
 237         int *tokens = NULL;
 238         int i;
 239
 240         if (CtdlAccessCheck(ac_logged_in)) return;
 241         extract_token(search_string, argbuf, 0, '|', sizeof search_string);
 242         wordbreaker(search_string, &num_tokens, &tokens);
 243
 244         cprintf("%d msgs matching search words:\n", LISTING_FOLLOWS);
 245         if (num_tokens > 0) {
 246                 for (i=0; i<num_tokens; ++i) {
 247
 248                         cprintf("FIXME search for token %d\n", tokens[i]);
 249
 250                 }
 251                 free(tokens);
 252         }
 253         cprintf("000\n");
 254 }
 255
 256
 257 /*****************************************************************************/
 258
 259 char *serv_fulltext_init(void)
 260 {
 261         CtdlRegisterSessionHook(do_fulltext_indexing, EVT_TIMER);
 262         CtdlRegisterProtoHook(cmd_srch, "SRCH", "Full text search");
 263         return "$Id$";
 264 }