]> code.citadel.org Git - citadel.git/blobdiff - citadel/serv_fulltext.c
mk_module_init.sh now tests to see if echo supports -e and -E
[citadel.git] / citadel / serv_fulltext.c
index 37bfc3cd2a7940eb24d3764bba04187f2294cf19..f6e2c672a8902f0a07be23f3a4c18b7a39e27fa9 100644 (file)
 #include <limits.h>
 #include "citadel.h"
 #include "server.h"
-#include "sysdep_decls.h"
 #include "citserver.h"
 #include "support.h"
 #include "config.h"
-#include "serv_extensions.h"
 #include "database.h"
 #include "msgbase.h"
 #include "control.h"
 #include "ft_wordbreaker.h"
 
 
+#include "ctdl_module.h"
+
+
+
 long ft_newhighest = 0L;
 long *ft_newmsgs = NULL;
 int ft_num_msgs = 0;
 int ft_num_alloc = 0;
 
 
+int ftc_num_msgs[65536];
+long *ftc_msgs[65536];
+
+
+/*
+ * Compare function
+ */
+int longcmp(const void *rec1, const void *rec2) {
+       long i1, i2;
+
+       i1 = *(const long *)rec1;
+       i2 = *(const long *)rec2;
+
+       if (i1 > i2) return(1);
+       if (i1 < i2) return(-1);
+       return(0);
+}
+
+/*
+ * Flush our index cache out to disk.
+ */
+void ft_flush_cache(void) {
+       int i;
+       time_t last_update = 0;
+
+       for (i=0; i<65536; ++i) {
+               if ((time(NULL) - last_update) >= 10) {
+                       lprintf(CTDL_INFO,
+                               "Flushing index cache to disk (%d%% complete)\n",
+                               (i * 100 / 65536)
+                       );
+                       last_update = time(NULL);
+               }
+               if (ftc_msgs[i] != NULL) {
+                       cdb_store(CDB_FULLTEXT, &i, sizeof(int), ftc_msgs[i],
+                               (ftc_num_msgs[i] * sizeof(long)));
+                       ftc_num_msgs[i] = 0;
+                       free(ftc_msgs[i]);
+                       ftc_msgs[i] = NULL;
+               }
+       }
+       lprintf(CTDL_INFO, "Flushed index cache to disk (100%% complete)\n");
+}
+
+
 /*
  * Index or de-index a message.  (op == 1 to index, 0 to de-index)
  */
 void ft_index_message(long msgnum, int op) {
-       struct CtdlMessage *msg;
        int num_tokens = 0;
        int *tokens = NULL;
-       int i;
+       int i, j;
+       struct cdbdata *cdb_bucket;
+       char *msgtext;
+       int tok;
 
-       msg = CtdlFetchMessage(msgnum, 1);
-       if (msg == NULL) return;
-
-       if (msg->cm_fields['M'] != NULL) {
-               wordbreaker(msg->cm_fields['M'], &num_tokens, &tokens);
-       }
-       CtdlFreeMessage(msg);
+       lprintf(CTDL_DEBUG, "ft_index_message() %s msg %ld\n",
+               (op ? "adding" : "removing") , msgnum
+       );
 
+       /* Output the message as text before indexing it, so we don't end up
+        * indexing a bunch of encoded base64, etc.
+        */
+       CC->redirect_buffer = malloc(SIZ);
+       CC->redirect_len = 0;
+       CC->redirect_alloc = SIZ;
+       CtdlOutputMsg(msgnum, MT_CITADEL, HEADERS_ALL, 0, 1, NULL);
+       msgtext = CC->redirect_buffer;
+       CC->redirect_buffer = NULL;
+       CC->redirect_len = 0;
+       CC->redirect_alloc = 0;
+       lprintf(CTDL_DEBUG, "Wordbreaking message %ld...\n", msgnum);
+       wordbreaker(msgtext, &num_tokens, &tokens);
+       free(msgtext);
+
+       lprintf(CTDL_DEBUG, "Indexing message %ld [%d tokens]\n", msgnum, num_tokens);
        if (num_tokens > 0) {
                for (i=0; i<num_tokens; ++i) {
-                       /* FIXME do something with this */
-                       lprintf(CTDL_DEBUG, "msg %ld, token %d\n",
-                               msgnum, tokens[i]);
+
+                       /* Add the message to the relevant token bucket */
+
+                       /* search for tokens[i] */
+                       tok = tokens[i];
+
+                       if ( (tok >= 0) && (tok <= 65535) ) {
+                               /* fetch the bucket, Liza */
+                               if (ftc_msgs[tok] == NULL) {
+                                       cdb_bucket = cdb_fetch(CDB_FULLTEXT, &tok, sizeof(int));
+                                       if (cdb_bucket != NULL) {
+                                               ftc_num_msgs[tok] = cdb_bucket->len / sizeof(long);
+                                               ftc_msgs[tok] = (long *)cdb_bucket->ptr;
+                                               cdb_bucket->ptr = NULL;
+                                               cdb_free(cdb_bucket);
+                                       }
+                                       else {
+                                               ftc_num_msgs[tok] = 0;
+                                               ftc_msgs[tok] = malloc(sizeof(long));
+                                       }
+                               }
+       
+       
+                               if (op == 1) {  /* add to index */
+                                       ++ftc_num_msgs[tok];
+                                       ftc_msgs[tok] = realloc(ftc_msgs[tok],
+                                                               ftc_num_msgs[tok]*sizeof(long));
+                                       ftc_msgs[tok][ftc_num_msgs[tok] - 1] = msgnum;
+                               }
+       
+                               if (op == 0) {  /* remove from index */
+                                       if (ftc_num_msgs[tok] >= 1) {
+                                               for (j=0; j<ftc_num_msgs[tok]; ++j) {
+                                                       if (ftc_msgs[tok][j] == msgnum) {
+                                                               memmove(&ftc_msgs[tok][j], &ftc_msgs[tok][j+1], ((ftc_num_msgs[tok] - j - 1)*sizeof(long)));
+                                                               --ftc_num_msgs[tok];
+                                                               --j;
+                                                       }
+                                               }
+                                       }
+                               }
                        }
+                       else {
+                               lprintf(CTDL_ALERT, "Invalid token %d !!\n", tok);
+                       }
+               }
+
                free(tokens);
        }
 }
@@ -104,22 +208,7 @@ void ft_index_msg(long msgnum, void *userdata) {
 void ft_index_room(struct ctdlroom *qrbuf, void *data)
 {
        getroom(&CC->room, qrbuf->QRname);
-       CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, ft_index_msg, NULL);
-}
-
-
-/*
- * Compare function
- */
-int longcmp(const void *rec1, const void *rec2) {
-       long i1, i2;
-
-       i1 = *(const long *)rec1;
-       i2 = *(const long *)rec2;
-
-       if (i1 > i2) return(1);
-       if (i1 < i2) return(-1);
-       return(0);
+       CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, ft_index_msg, NULL);
 }
 
 
@@ -128,31 +217,48 @@ int longcmp(const void *rec1, const void *rec2) {
  */
 void do_fulltext_indexing(void) {
        int i;
-
-       lprintf(CTDL_DEBUG, "do_fulltext_indexing() started\n");
+       static time_t last_index = 0L;
+       static time_t last_progress = 0L;
 
        /*
-        * Check to see whether the fulltext index is up to date; if there
-        * are no messages to index, don't waste any more time trying.
+        * Don't do this if the site doesn't have it enabled.
         */
-       lprintf(CTDL_DEBUG, "CitControl.MMhighest  = %ld\n",
-               CitControl.MMhighest);
-       lprintf(CTDL_DEBUG, "CitControl.MMfulltext = %ld\n",
-               CitControl.MMfulltext);
-       if (CitControl.MMfulltext >= CitControl.MMhighest) {
-               lprintf(CTDL_DEBUG, "Nothing to do!\n");
+       if (!config.c_enable_fulltext) {
                return;
        }
-       
+
        /*
         * Make sure we don't run the indexer too frequently.
-        * FIXME write this...
+        * FIXME move the setting into config
+        */
+       if ( (time(NULL) - last_index) < 300L) {
+               return;
+       }
+
+       /*
+        * Check to see whether the fulltext index is up to date; if there
+        * are no messages to index, don't waste any more time trying.
         */
+       if (CitControl.MMfulltext >= CitControl.MMhighest) {
+               return;         /* nothing to do! */
+       }
 
+       lprintf(CTDL_DEBUG, "do_fulltext_indexing() started\n");
+       
        /*
         * If we've switched wordbreaker modules, burn the index and start
-        * over.  FIXME write this...
+        * over.
         */
+       begin_critical_section(S_CONTROL);
+       lprintf(CTDL_DEBUG, "wb ver on disk = %d, code ver = %d\n",
+                       CitControl.fulltext_wordbreaker, FT_WORDBREAKER_ID);
+       if (CitControl.fulltext_wordbreaker != FT_WORDBREAKER_ID) {
+               lprintf(CTDL_INFO, "(re)initializing full text index\n");
+               cdb_trunc(CDB_FULLTEXT);
+               CitControl.MMfulltext = 0L;
+               put_control();
+       }
+       end_critical_section(S_CONTROL);
 
        /*
         * Now go through each room and find messages to index.
@@ -162,17 +268,41 @@ void do_fulltext_indexing(void) {
 
        if (ft_num_msgs > 0) {
                qsort(ft_newmsgs, ft_num_msgs, sizeof(long), longcmp);
-               if (i>1) for (i=0; i<(ft_num_msgs-1); ++i) { /* purge dups */
+               for (i=0; i<(ft_num_msgs-1); ++i) { /* purge dups */
                        if (ft_newmsgs[i] == ft_newmsgs[i+1]) {
                                memmove(&ft_newmsgs[i], &ft_newmsgs[i+1],
-                                       ((ft_num_msgs - i)*sizeof(long)));
+                                       ((ft_num_msgs - i - 1)*sizeof(long)));
                                --ft_num_msgs;
+                               --i;
                        }
                }
 
                /* Here it is ... do each message! */
                for (i=0; i<ft_num_msgs; ++i) {
+                       if (time(NULL) != last_progress) {
+                               lprintf(CTDL_DEBUG,
+                                       "Indexed %d of %d messages (%d%%)\n",
+                                               i, ft_num_msgs,
+                                               ((i*100) / ft_num_msgs)
+                               );
+                               last_progress = time(NULL);
+                       }
                        ft_index_message(ft_newmsgs[i], 1);
+
+                       /* Check to see if we need to quit early */
+                       if (time_to_die) {
+                               lprintf(CTDL_DEBUG, "Indexer quitting early\n");
+                               ft_newhighest = ft_newmsgs[i];
+                               break;
+                       }
+
+                       /* Check to see if we have to maybe flush to disk */
+                       if (i >= FT_MAX_CACHE) {
+                               lprintf(CTDL_DEBUG, "Time to flush.\n");
+                               ft_newhighest = ft_newmsgs[i];
+                               break;
+                       }
+
                }
 
                free(ft_newmsgs);
@@ -181,15 +311,169 @@ void do_fulltext_indexing(void) {
                ft_newmsgs = NULL;
        }
 
+       /* Save our place so we don't have to do this again */
+       ft_flush_cache();
+       begin_critical_section(S_CONTROL);
+       CitControl.MMfulltext = ft_newhighest;
+       CitControl.fulltext_wordbreaker = FT_WORDBREAKER_ID;
+       put_control();
+       end_critical_section(S_CONTROL);
+       last_index = time(NULL);
+
        lprintf(CTDL_DEBUG, "do_fulltext_indexing() finished\n");
        return;
 }
 
+/*
+ * Main loop for the indexer thread.
+ */
+void *indexer_thread(void *arg) {
+       struct CitContext indexerCC;
+
+       lprintf(CTDL_DEBUG, "indexer_thread() initializing\n");
+
+       memset(&indexerCC, 0, sizeof(struct CitContext));
+       indexerCC.internal_pgm = 1;
+       indexerCC.cs_pid = 0;
+       pthread_setspecific(MyConKey, (void *)&indexerCC );
+
+       cdb_allocate_tsd();
+
+       while (!time_to_die) {
+               do_fulltext_indexing();
+               sleep(1);
+       }
+
+       lprintf(CTDL_DEBUG, "indexer_thread() exiting\n");
+       pthread_exit(NULL);
+}
+
+
+
+/*
+ * API call to perform searches.
+ * (This one does the "all of these words" search.)
+ * Caller is responsible for freeing the message list.
+ */
+void ft_search(int *fts_num_msgs, long **fts_msgs, char *search_string) {
+       int num_tokens = 0;
+       int *tokens = NULL;
+       int i, j;
+       struct cdbdata *cdb_bucket;
+       int num_all_msgs = 0;
+       long *all_msgs = NULL;
+       int num_ret_msgs = 0;
+       int num_ret_alloc = 0;
+       long *ret_msgs = NULL;
+       int tok;
+
+       wordbreaker(search_string, &num_tokens, &tokens);
+       if (num_tokens > 0) {
+               for (i=0; i<num_tokens; ++i) {
+
+                       /* search for tokens[i] */
+                       tok = tokens[i];
+
+                       /* fetch the bucket, Liza */
+                       if (ftc_msgs[tok] == NULL) {
+                               cdb_bucket = cdb_fetch(CDB_FULLTEXT, &tok, sizeof(int));
+                               if (cdb_bucket != NULL) {
+                                       ftc_num_msgs[tok] = cdb_bucket->len / sizeof(long);
+                                       ftc_msgs[tok] = (long *)cdb_bucket->ptr;
+                                       cdb_bucket->ptr = NULL;
+                                       cdb_free(cdb_bucket);
+                               }
+                               else {
+                                       ftc_num_msgs[tok] = 0;
+                                       ftc_msgs[tok] = malloc(sizeof(long));
+                               }
+                       }
+
+                       num_all_msgs += ftc_num_msgs[tok];
+                       if (num_all_msgs > 0) {
+                               all_msgs = realloc(all_msgs, num_all_msgs*sizeof(long) );
+                               memcpy(&all_msgs[num_all_msgs-ftc_num_msgs[tok]],
+                                       ftc_msgs[tok], ftc_num_msgs[tok]*sizeof(long) );
+                       }
+
+               }
+               free(tokens);
+               qsort(all_msgs, num_all_msgs, sizeof(long), longcmp);
+
+               /*
+                * At this point, if a message appears num_tokens times in the
+                * list, then it contains all of the search tokens.
+                */
+               if (num_all_msgs >= num_tokens)
+                  for (j=0; j<(num_all_msgs-num_tokens+1); ++j) {
+                       if (all_msgs[j] == all_msgs[j+num_tokens-1]) {
+
+                               ++num_ret_msgs;
+                               if (num_ret_msgs > num_ret_alloc) {
+                                       num_ret_alloc += 64;
+                                       ret_msgs = realloc(ret_msgs,
+                                               (num_ret_alloc*sizeof(long)) );
+                               }
+                               ret_msgs[num_ret_msgs - 1] = all_msgs[j];
+
+                       }
+               }
+
+               free(all_msgs);
+       }
+
+       *fts_num_msgs = num_ret_msgs;
+       *fts_msgs = ret_msgs;
+}
+
+
+/*
+ * This search command is for diagnostic purposes and may be removed or replaced.
+ */
+void cmd_srch(char *argbuf) {
+       int num_msgs = 0;
+       long *msgs = NULL;
+       int i;
+       char search_string[256];
+
+       if (CtdlAccessCheck(ac_logged_in)) return;
+
+       if (!config.c_enable_fulltext) {
+               cprintf("%d Full text index is not enabled on this server.\n",
+                       ERROR + CMD_NOT_SUPPORTED);
+               return;
+       }
+
+       extract_token(search_string, argbuf, 0, '|', sizeof search_string);
+       ft_search(&num_msgs, &msgs, search_string);
+
+       cprintf("%d %d msgs match all search words:\n",
+               LISTING_FOLLOWS, num_msgs);
+       if (num_msgs > 0) {
+               for (i=0; i<num_msgs; ++i) {
+                       cprintf("%ld\n", msgs[i]);
+               }
+       }
+       if (msgs != NULL) free(msgs);
+       cprintf("000\n");
+}
+
+/*
+ * Zero out our index cache.
+ */
+void initialize_ft_cache(void) {
+       memset(ftc_num_msgs, 0, (65536 * sizeof(int)));
+       memset(ftc_msgs, 0, (65536 * sizeof(long *)));
+}
+
 
 /*****************************************************************************/
 
-char *serv_fulltext_init(void)
+CTDL_MODULE_INIT(fulltext)
 {
-       CtdlRegisterSessionHook(do_fulltext_indexing, EVT_TIMER);
+       initialize_ft_cache();
+       CtdlRegisterProtoHook(cmd_srch, "SRCH", "Full text search");
+
+       /* return our Subversion id for the Log */
        return "$Id$";
 }