citadel/server/modules/fulltext/serv_fulltext.c

   1 // This module handles fulltext indexing of the message base.
   2 //
   3 // Copyright (c) 2005-2023 by the citadel.org team
   4 //
   5 // This program is open source software.  Use, duplication, or disclosure
   6 // is subject to the terms of the GNU General Public License, version 3.
   7
   8 #include "../../sysdep.h"
   9 #include <stdlib.h>
  10 #include <unistd.h>
  11 #include <stdio.h>
  12 #include <fcntl.h>
  13 #include <signal.h>
  14 #include <pwd.h>
  15 #include <errno.h>
  16 #include <sys/types.h>
  17 #include <time.h>
  18 #include <sys/wait.h>
  19 #include <string.h>
  20 #include <limits.h>
  21 #include <libcitadel.h>
  22 #include "../../citadel_defs.h"
  23 #include "../../server.h"
  24 #include "../../citserver.h"
  25 #include "../../support.h"
  26 #include "../../config.h"
  27 #include "../../room_ops.h"
  28 #include "../../database.h"
  29 #include "../../msgbase.h"
  30 #include "../../control.h"
  31 #include "serv_fulltext.h"
  32 #include "ft_wordbreaker.h"
  33 #include "../../threads.h"
  34 #include "../../context.h"
  35 #include "../../ctdl_module.h"
  36
  37 // These can be global variables because only one indexer runs at a time.
  38 Array *messages_to_be_indexed = NULL;
  39 long highest_msg_already_indexed = 0;
  40 long highest_msg_to_be_indexed = 0;
  41
  42
  43 // Compare function
  44 int longcmp(const void *rec1, const void *rec2) {
  45         long i1, i2;
  46
  47         i1 = *(const long *)rec1;
  48         i2 = *(const long *)rec2;
  49
  50         if (i1 > i2) return(1);
  51         if (i1 < i2) return(-1);
  52         return(0);
  53 }
  54
  55
  56 // Index or de-index a message.  (op == 1 to index, 0 to de-index)
  57 void ft_index_message(long msgnum, int op) {
  58         int i, j;
  59         Array *tokens_in_this_message = NULL;
  60         struct cdbdata cdb_bucket;
  61         StrBuf *msgtext;
  62         char *txt;
  63         int tok;
  64         struct CtdlMessage *msg = NULL;
  65
  66         if (msgnum == 0) return;
  67
  68         msg = CtdlFetchMessage(msgnum, 1);
  69         if (msg == NULL) {
  70                 // This is not necessarily an error condition; it could simply mean that the message was
  71                 // deleted before it could be indexed.  This happens often when the load tester is running.
  72                 syslog(LOG_ERR, "fulltext: ft_index_message() could not load msg %ld", msgnum);
  73                 return;
  74         }
  75
  76         if (!CM_IsEmpty(msg, eSuppressIdx)) {
  77                 syslog(LOG_DEBUG, "fulltext: ft_index_message() excluded msg %ld", msgnum);
  78                 CM_Free(msg);
  79                 return;
  80         }
  81
  82         syslog(LOG_DEBUG, "fulltext: ft_index_message() %s msg %ld", (op ? "adding" : "removing") , msgnum);
  83
  84         // Output the message as text before indexing it, so we don't end up indexing a bunch of encoded base64, etc.
  85         CC->redirect_buffer = NewStrBufPlain(NULL, SIZ);
  86         CtdlOutputPreLoadedMsg(msg, MT_CITADEL, HEADERS_ALL, 0, 1, 0);
  87         CM_Free(msg);
  88         msgtext = CC->redirect_buffer;
  89         CC->redirect_buffer = NULL;
  90         if (msgtext != NULL) {
  91                 syslog(LOG_DEBUG, "fulltext: wordbreaking message %ld (%d bytes)", msgnum, StrLength(msgtext));
  92         }
  93         txt = SmashStrBuf(&msgtext);
  94         tokens_in_this_message = wordbreaker(txt);
  95         free(txt);
  96
  97         syslog(LOG_DEBUG, "fulltext: %sindexing message %ld [%d tokens]",
  98                 (op ? "" : "de"),
  99                 msgnum,
 100                 array_len(tokens_in_this_message)
 101         );
 102
 103         if (array_len(tokens_in_this_message) > 0) {
 104                 begin_critical_section(S_INDEXER);
 105                 cdb_begin_transaction();
 106                 for (i=0; i<array_len(tokens_in_this_message); ++i) {
 107
 108                         // Identify the bucket which we will be modifying
 109                         memcpy(&tok, array_get_element_at(tokens_in_this_message, i), sizeof(int));
 110
 111                         // fetch the bucket
 112                         cdb_bucket = cdb_fetch(CDB_FULLTEXT, &tok, sizeof(int));
 113                         long *newbucket = malloc(cdb_bucket.len + sizeof(long));
 114                         int nmsgs = cdb_bucket.len / sizeof(long);
 115
 116                         if (op == 1) {                                          // indexing, add this message to the bucket
 117                                 memcpy(&newbucket[0], cdb_bucket.ptr, cdb_bucket.len);
 118                                 int already_there = 0;
 119                                 for (j=0; j<nmsgs; ++j) {
 120                                         if (newbucket[j] == msgnum) {
 121                                                 already_there = 1;
 122                                         }
 123                                 }
 124                                 if (already_there == 0) {
 125                                         memcpy(&newbucket[nmsgs++], &msgnum, sizeof(long));
 126                                 }
 127                         }
 128
 129                         else if (op == 0) {                                     // deindexing, remove this message from the bucket
 130                                 memcpy(newbucket, cdb_bucket.ptr, cdb_bucket.len);
 131                                 for (j=0; j<nmsgs; ++j) {
 132                                         if ((newbucket[j] == msgnum) || (newbucket[j] == 0)) {
 133                                                 memcpy(&newbucket[j], &newbucket[j+1], ((nmsgs-j)*sizeof(long)));
 134                                                 --j;
 135                                                 --nmsgs;
 136                                         }
 137                                 }
 138                         }
 139
 140                         // Then write it back to disk
 141                         cdb_store(CDB_FULLTEXT, &tok, sizeof(int), newbucket, (nmsgs*sizeof(long)));
 142                         free(newbucket);
 143
 144                         if (server_shutting_down) break;
 145                 }
 146                 cdb_end_transaction();
 147                 end_critical_section(S_INDEXER);
 148                 CtdlSetConfigLong("MMfulltext", msgnum);
 149         }
 150         array_free(tokens_in_this_message);
 151 }
 152
 153
 154 // Scan a room for messages to index.
 155 void ft_index_room(struct ctdlroom *qrbuf, void *data) {
 156         if (server_shutting_down) {
 157                 return;
 158         }
 159
 160         int num_msgs = 0;
 161         long *msglist;
 162         int i;
 163
 164         // 2023aug30 ajc - old code did another CtdlGetRoom() here.  Not only is that redundant,
 165         // but for some reason it also made Berkeley DB deadlock after a while.  I don't know why.
 166
 167         // qrbuf is already populated.  fetch the list of messages in this room.
 168         num_msgs = CtdlFetchMsgList(qrbuf->QRnumber, &msglist);
 169
 170         // Identify messages which have NOT yet been seen by the indexer.
 171         if (msglist != NULL) {
 172                 for (i=0; i<num_msgs; ++i) {
 173                         if (
 174                                 (msglist[i] > 0)
 175                                 && (msglist[i] > highest_msg_already_indexed)
 176                                 && (msglist[i] <= highest_msg_to_be_indexed)
 177                            ) {
 178                                 array_append(messages_to_be_indexed, &msglist[i]);
 179                         }
 180                 }
 181                 free(msglist);
 182         }
 183 }
 184
 185
 186 // Begin the fulltext indexing process.
 187 void do_fulltext_indexing(void) {
 188         int i;
 189         static time_t last_progress = 0L;
 190         static int is_running = 0;
 191
 192         if (is_running) return;         // Concurrency check - only one can run
 193         is_running = 1;
 194
 195         // Don't do this if the site doesn't have it enabled.
 196         if (!CtdlGetConfigInt("c_enable_fulltext")) {
 197                 is_running = 0;
 198                 return;
 199         }
 200         // If we've switched wordbreaker modules, burn the index and start over.
 201         begin_critical_section(S_CONTROL);
 202         if (CtdlGetConfigInt("MM_fulltext_wordbreaker") != FT_WORDBREAKER_ID) {
 203                 syslog(LOG_DEBUG, "fulltext: wb ver on disk = %d, code ver = %d",
 204                         CtdlGetConfigInt("MM_fulltext_wordbreaker"), FT_WORDBREAKER_ID
 205                 );
 206                 syslog(LOG_INFO, "fulltext: (re)initializing index");
 207                 cdb_trunc(CDB_FULLTEXT);
 208                 CtdlSetConfigLong("MMfulltext", 0);
 209         }
 210         end_critical_section(S_CONTROL);
 211
 212         // Silently return if our fulltext index is up to date with new messages.
 213         if ((CtdlGetConfigLong("MMfulltext") >= CtdlGetConfigLong("MMhighest"))) {
 214                 is_running = 0;
 215                 return;         // nothing to do!
 216         }
 217
 218         highest_msg_already_indexed = CtdlGetConfigLong("MMfulltext");
 219         highest_msg_to_be_indexed = CtdlGetConfigLong("MMhighest");
 220         syslog(LOG_DEBUG, "fulltext: indexing started. msgs %ld--%ld", highest_msg_already_indexed, highest_msg_to_be_indexed);
 221
 222         messages_to_be_indexed = array_new(sizeof(long));
 223
 224         // Now go through each room and find messages to index.
 225         CtdlForEachRoom(ft_index_room, NULL);                           // load all msg pointers
 226         array_sort(messages_to_be_indexed, longcmp);                    // sort them
 227
 228         // Here it is ... do each message!
 229         long msgnum = 0;
 230         long prev_msgnum = 0;
 231         time_t started_indexing_at = time(NULL);
 232         int yielded = 0;
 233         for (i=0; ((i<array_len(messages_to_be_indexed)) && (yielded == 0)); ++i) {
 234                 memcpy(&msgnum, array_get_element_at(messages_to_be_indexed, i), sizeof(long));
 235
 236                 if (msgnum != prev_msgnum) {                            // careful to avoid dupes
 237                         ft_index_message(msgnum, 1);
 238                 }
 239                 prev_msgnum = msgnum;
 240
 241                 // If we run too long, yield the thread so the server can do other things.  We'll be back.
 242                 if (time(NULL) - started_indexing_at >= MAXIMUM_INDEXER_RUN_TIME) {
 243                         yielded = 1;
 244                 }
 245         }
 246
 247         array_free(messages_to_be_indexed);
 248         CtdlSetConfigInt("MM_fulltext_wordbreaker", FT_WORDBREAKER_ID);
 249         syslog(LOG_DEBUG, "fulltext: indexer has run for %ld seconds; yielded=%d", time(NULL) - started_indexing_at, yielded);
 250
 251         // This keeps the indexer from starting up over and over if the highest message in the list was deleted
 252         // before we had a chance to index it.
 253         if (!yielded) {
 254                 CtdlSetConfigLong("MMfulltext", highest_msg_to_be_indexed);
 255         }
 256
 257         is_running = 0;
 258         return;
 259 }
 260
 261
 262 // API call to perform searches.
 263 // (This one does the "all of these words" search.)
 264 // Caller is responsible for freeing the message list.
 265 Array *CtdlFullTextSearch(const char *search_string) {
 266         int i, j, tok;
 267         struct cdbdata cdb_bucket;
 268         long msgnum, smsgnum;
 269         int count;
 270
 271         Array *r = array_new(sizeof(long));
 272         if (!r) return(NULL);
 273         Array *t = wordbreaker(search_string);
 274
 275         if ((t != NULL) && (array_len(t) > 0)) {
 276                 for (i=0; i<array_len(t); ++i) {
 277                         memcpy(&tok, array_get_element_at(t, i), sizeof(int));
 278                         cdb_bucket = cdb_fetch(CDB_FULLTEXT, &tok, sizeof(int));
 279                         if (cdb_bucket.ptr != NULL) {
 280                                 for (j=0; j<(cdb_bucket.len / sizeof(long)); ++j) {
 281                                         memcpy(&msgnum, cdb_bucket.ptr + (j*sizeof(long)), sizeof(long));
 282                                         array_append(r, &msgnum);
 283                                 }
 284                         }
 285                 }
 286         }
 287
 288         // We need to return any message containing ALL of the tokens.
 289         // If a message number appears in the array `n` times, where `n` is the number of search words,
 290         // that means it matched all search words.
 291         array_sort(r, longcmp);
 292         for (i=0; i<array_len(r); ++i) {
 293                 memcpy(&msgnum, array_get_element_at(r, i), sizeof(long));
 294                 count = 1;
 295                 for (j=i+1; j<array_len(r); ++j) {
 296                         memcpy(&smsgnum, array_get_element_at(r, j), sizeof(long));
 297                         if (msgnum == smsgnum) {
 298                                 ++count;
 299                                 array_delete_element_at(r, j);
 300                                 --j;
 301                         }
 302                 }
 303                 if (count != array_len(t)) {
 304                         array_delete_element_at(r, i);
 305                         --i;
 306                 }
 307         }
 308
 309         array_free(t);
 310         return(r);
 311 }
 312
 313
 314 // This search command is for diagnostic purposes and may be removed or replaced.
 315 void cmd_srch(char *argbuf) {
 316         int i;
 317         char search_string[SIZ];
 318         Array *matches = NULL;
 319         long msgnum;
 320
 321         if (CtdlAccessCheck(ac_logged_in)) return;
 322
 323         if (!CtdlGetConfigInt("c_enable_fulltext")) {
 324                 cprintf("%d Full text index is not enabled on this server.\n", ERROR + CMD_NOT_SUPPORTED);
 325                 return;
 326         }
 327
 328         extract_token(search_string, argbuf, 0, '|', sizeof search_string);
 329         matches = CtdlFullTextSearch(search_string);
 330
 331         cprintf("%d %d msgs match all search words:\n", LISTING_FOLLOWS, array_len(matches));
 332         if ((matches != NULL) && (array_len(matches) > 0)) {
 333                 for (i=0; i<array_len(matches); ++i) {
 334                         memcpy(&msgnum, array_get_element_at(matches, i), sizeof(long));
 335                         cprintf("%ld\n", msgnum);
 336                 }
 337         }
 338         if (matches != NULL) {
 339                 array_free(matches);
 340         }
 341         cprintf("000\n");
 342 }
 343
 344
 345 void ft_delete_remove(char *room, long msgnum) {
 346         if (room) return;
 347
 348         // Remove from fulltext index
 349         if (CtdlGetConfigInt("c_enable_fulltext")) {
 350                 ft_index_message(msgnum, 0);
 351         }
 352 }
 353
 354
 355 // Initialization function, called from modules_init.c
 356 char *ctdl_module_init_fulltext(void) {
 357         if (!threading) {
 358                 CtdlRegisterProtoHook(cmd_srch, "SRCH", "Full text search");
 359                 CtdlRegisterDeleteHook(ft_delete_remove);
 360                 CtdlRegisterSessionHook(do_fulltext_indexing, EVT_HOUSE, PRIO_CLEANUP + 300);
 361         }
 362         // return our module name for the log
 363         return "fulltext";
 364 }