Removed all of the SYS_ user contexts, they aren't needed anymore
[citadel.git] / citadel / euidindex.c
index 04c14b91a8982cfe542870e5b13490defcd0f690..8533caabf85a6099e7ed32463341265b27691b36 100644 (file)
-/*
- * $Id$
- *
+/* 
  * Index messages by EUID per room.
  *
+ * Copyright (c) 1987-2019 by the citadel.org team
+ *
+ * This program is open source software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  */
 
 #include "sysdep.h"
-#include <stdlib.h>
-#include <unistd.h>
 #include <stdio.h>
-#include <fcntl.h>
-
-#if TIME_WITH_SYS_TIME
-# include <sys/time.h>
-# include <time.h>
-#else
-# if HAVE_SYS_TIME_H
-#  include <sys/time.h>
-# else
-#  include <time.h>
-# endif
-#endif
-
-
-#include <ctype.h>
-#include <string.h>
-#include <limits.h>
-#include <errno.h>
-#include <stdarg.h>
-#include <sys/stat.h>
-#include "citadel.h"
-#include "server.h"
-#include "serv_extensions.h"
-#include "database.h"
-#include "msgbase.h"
-#include "support.h"
-#include "sysdep_decls.h"
+#include <libcitadel.h>
+
 #include "citserver.h"
 #include "room_ops.h"
-#include "user_ops.h"
-#include "file_ops.h"
-#include "config.h"
-#include "control.h"
-#include "tools.h"
-#include "euidindex.h"
 
+/*
+ * The structure of an euidindex record *key* is:
+ *
+ * |----room_number----|----------EUID-------------|
+ *    (sizeof long)       (actual length of euid)
+ *
+ *
+ * The structure of an euidindex record *value* is:
+ *
+ * |-----msg_number----|----room_number----|----------EUID-------------|
+ *    (sizeof long)       (sizeof long)       (actual length of euid)
+ *
+ */
 
-long locate_message_by_euid(char *euid, struct ctdlroom *qrbuf) {
+/*
+ * Return nonzero if the supplied room is one which should have
+ * an EUID index.
+ */
+int DoesThisRoomNeedEuidIndexing(struct ctdlroom *qrbuf) {
+
+       switch(qrbuf->QRdefaultview) {
+               case VIEW_BBS:          return(0);
+               case VIEW_MAILBOX:      return(0);
+               case VIEW_ADDRESSBOOK:  return(1);
+               case VIEW_DRAFTS:       return(0);
+               case VIEW_CALENDAR:     return(1);
+               case VIEW_TASKS:        return(1);
+               case VIEW_NOTES:        return(1);
+               case VIEW_WIKI:         return(1);
+               case VIEW_WIKIMD:       return(1);
+               case VIEW_BLOG:         return(1);
+       }
+       
        return(0);
 }
 
-void index_message_by_euid(char *euid, struct ctdlroom *qrbuf, long msgnum) {
+
+/*
+ * Locate a message in a given room with a given euid, and return
+ * its message number.
+ */
+long locate_message_by_euid(char *euid, struct ctdlroom *qrbuf) {
+       return CtdlLocateMessageByEuid (euid, qrbuf);
+}
+
+
+long CtdlLocateMessageByEuid(char *euid, struct ctdlroom *qrbuf) {
        char *key;
        int key_len;
+       struct cdbdata *cdb_euid;
+       long msgnum = (-1L);
 
-       lprintf(CTDL_DEBUG, "Indexing message #%ld <%s> in <%s>\n", msgnum, euid, qrbuf->QRname);
+       syslog(LOG_DEBUG, "euidindex: searching for EUID <%s> in <%s>", euid, qrbuf->QRname);
 
        key_len = strlen(euid) + sizeof(long) + 1;
        key = malloc(key_len);
        memcpy(key, &qrbuf->QRnumber, sizeof(long));
        strcpy(&key[sizeof(long)], euid);
 
-       cdb_store(CDB_EUIDINDEX, key, key_len, &msgnum, sizeof(long));
+       cdb_euid = cdb_fetch(CDB_EUIDINDEX, key, key_len);
+       free(key);
+
+       if (cdb_euid == NULL) {
+               msgnum = (-1L);
+       }
+       else {
+               /* The first (sizeof long) of the record is what we're
+                * looking for.  Throw away the rest.
+                */
+               memcpy(&msgnum, cdb_euid->ptr, sizeof(long));
+               cdb_free(cdb_euid);
+       }
+       syslog(LOG_DEBUG, "euidindex: returning msgnum = %ld", msgnum);
+       return(msgnum);
 }
 
 
+/*
+ * Store the euid index for a message, which has presumably just been
+ * stored in this room by the caller.
+ */
+void index_message_by_euid(char *euid, struct ctdlroom *qrbuf, long msgnum) {
+       char *key;
+       int key_len;
+       char *data;
+       int data_len;
+
+       syslog(LOG_DEBUG, "euidindex: indexing message #%ld <%s> in <%s>", msgnum, euid, qrbuf->QRname);
+
+       key_len = strlen(euid) + sizeof(long) + 1;
+       key = malloc(key_len);
+       memcpy(key, &qrbuf->QRnumber, sizeof(long));
+       strcpy(&key[sizeof(long)], euid);
+
+       data_len = sizeof(long) + key_len;
+       data = malloc(data_len);
+
+       memcpy(data, &msgnum, sizeof(long));
+       memcpy(&data[sizeof(long)], key, key_len);
+
+       cdb_store(CDB_EUIDINDEX, key, key_len, data, data_len);
+       free(key);
+       free(data);
+}
+
 
 /*
  * Called by rebuild_euid_index_for_room() to index one message.
  */
 void rebuild_euid_index_for_msg(long msgnum, void *userdata) {
-       struct CtdlMessage *msg;
+       struct CtdlMessage *msg = NULL;
 
-       msg = CtdlFetchMessage(msgnum, 0);
+       msg = CtdlFetchMessage(msgnum, 0, 1);
        if (msg == NULL) return;
-       if (msg->cm_fields['E'] != NULL) {
-               index_message_by_euid(msg->cm_fields['E'], &CC->room, msgnum);
+       if (!CM_IsEmpty(msg, eExclusiveID)) {
+               index_message_by_euid(msg->cm_fields[eExclusiveID], &CC->room, msgnum);
        }
-       CtdlFreeMessage(msg);
+       CM_Free(msg);
 }
 
 
@@ -86,7 +145,7 @@ void rebuild_euid_index_for_room(struct ctdlroom *qrbuf, void *data) {
        struct RoomProcList *ptr;
        struct ctdlroom qr;
 
-       /* Lazy programming here.  Call this function as a ForEachRoom backend
+       /* Lazy programming here.  Call this function as a CtdlForEachRoom backend
         * in order to queue up the room names, or call it with a null room
         * to make it do the processing.
         */
@@ -102,10 +161,15 @@ void rebuild_euid_index_for_room(struct ctdlroom *qrbuf, void *data) {
        }
 
        while (rplist != NULL) {
-               if (getroom(&qr, rplist->name) == 0) {
-                       lprintf(CTDL_DEBUG, "Rebuilding EUID index for <%s>\n", rplist->name);
-                       usergoto(rplist->name, 0, 0, NULL, NULL);
-                       CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, rebuild_euid_index_for_msg, NULL);
+               if (CtdlGetRoom(&qr, rplist->name) == 0) {
+                       if (DoesThisRoomNeedEuidIndexing(&qr)) {
+                               syslog(LOG_DEBUG,
+                                       "euidindex: rebuilding EUID index for <%s>",
+                                       rplist->name);
+                               CtdlUserGoto(rplist->name, 0, 0, NULL, NULL, NULL, NULL);
+                               CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
+                                       rebuild_euid_index_for_msg, NULL);
+                       }
                }
                ptr = rplist;
                rplist = rplist->next;
@@ -118,8 +182,55 @@ void rebuild_euid_index_for_room(struct ctdlroom *qrbuf, void *data) {
  * Globally rebuild the EUID indices in every room.
  */
 void rebuild_euid_index(void) {
-       cdb_trunc(CDB_EUIDINDEX);
+       cdb_trunc(CDB_EUIDINDEX);               /* delete the old indices */
+       CtdlForEachRoom(rebuild_euid_index_for_room, NULL);     /* enumerate rm names */
+       rebuild_euid_index_for_room(NULL, NULL);        /* and index them */
+}
+
+
+/*
+ * Server command to fetch a message number given an euid.
+ */
+void cmd_euid(char *cmdbuf) {
+       char euid[256];
+       long msgnum;
+        struct cdbdata *cdbfr;
+        long *msglist = NULL;
+        int num_msgs = 0;
+       int i;
+
+       if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
+
+       extract_token(euid, cmdbuf, 0, '|', sizeof euid);
+       msgnum = CtdlLocateMessageByEuid(euid, &CC->room);
+       if (msgnum <= 0L) {
+               cprintf("%d not found\n", ERROR + MESSAGE_NOT_FOUND);
+               return;
+       }
 
-       ForEachRoom(rebuild_euid_index_for_room, NULL);
-       rebuild_euid_index_for_room(NULL, NULL);
+        cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
+       if (cdbfr != NULL) {
+                num_msgs = cdbfr->len / sizeof(long);
+                msglist = (long *) cdbfr->ptr;
+                for (i = 0; i < num_msgs; ++i) {
+                        if (msglist[i] == msgnum) {
+                               cdb_free(cdbfr);
+                               cprintf("%d %ld\n", CIT_OK, msgnum);
+                               return;
+                       }
+               }
+                cdb_free(cdbfr);
+       }
+
+       cprintf("%d not found\n", ERROR + MESSAGE_NOT_FOUND);
+}
+
+
+CTDL_MODULE_INIT(euidindex)
+{
+       if (!threading) {
+               CtdlRegisterProtoHook(cmd_euid, "EUID", "Perform operations on Extended IDs for messages");
+       }
+       /* return our Subversion id for the Log */
+       return "euidindex";
 }