citadel/server/modules/autocompletion/serv_autocompletion.c

   1 // Autocompletion of email recipients, etc.
   2 //
   3 // Copyright (c) 1987-2023 by the citadel.org team
   4 //
   5 // This program is open source software.  Use, duplication, or disclosure
   6 // are subject to the terms of the GNU General Public License version 3.
   7
   8 #include "../../ctdl_module.h"
   9 #include "serv_autocompletion.h"
  10 #include "../../config.h"
  11 #include "../../room_ops.h"
  12 #include "../fulltext/serv_fulltext.h"
  13
  14
  15 // Convert a structured name into a friendly name.  Caller must free the
  16 // returned pointer.
  17 char *n_to_fn(char *value) {
  18         char *nnn = NULL;
  19         int i;
  20
  21         nnn = malloc(strlen(value) + 10);
  22         strcpy(nnn, "");
  23         extract_token(&nnn[strlen(nnn)] , value, 3, ';', 999);
  24         strcat(nnn, " ");
  25         extract_token(&nnn[strlen(nnn)] , value, 1, ';', 999);
  26         strcat(nnn, " ");
  27         extract_token(&nnn[strlen(nnn)] , value, 2, ';', 999);
  28         strcat(nnn, " ");
  29         extract_token(&nnn[strlen(nnn)] , value, 0, ';', 999);
  30         strcat(nnn, " ");
  31         extract_token(&nnn[strlen(nnn)] , value, 4, ';', 999);
  32         strcat(nnn, " ");
  33         for (i=0; i<strlen(nnn); ++i) {
  34                 if (!strncmp(&nnn[i], "  ", 2)) strcpy(&nnn[i], &nnn[i+1]);
  35         }
  36         string_trim(nnn);
  37         return(nnn);
  38 }
  39
  40
  41 // Back end for cmd_auto()
  42 void hunt_for_autocomplete(long msgnum, char *search_string) {
  43         struct CtdlMessage *msg;
  44         struct vCard *v;
  45         char *value = NULL;
  46         char *value2 = NULL;
  47         int i = 0;
  48         char *nnn = NULL;
  49
  50         msg = CtdlFetchMessage(msgnum, 1);
  51         if (msg == NULL) return;
  52
  53         v = vcard_load(msg->cm_fields[eMesageText]);
  54         CM_Free(msg);
  55
  56         // Try to match from a friendly name (the "fn" field).  If there is
  57         // a match, return the entry in the form of:
  58         //     Display Name <user@domain.org>
  59         value = vcard_get_prop(v, "fn", 0, 0, 0);
  60         if (value != NULL) if (bmstrcasestr(value, search_string)) {
  61                 value2 = vcard_get_prop(v, "email", 1, 0, 0);
  62                 if (value2 == NULL) value2 = "";
  63                 cprintf("%s <%s>\n", value, value2);
  64                 vcard_free(v);
  65                 return;
  66         }
  67
  68         // Try to match from a structured name (the "n" field).  If there is
  69         // a match, return the entry in the form of:
  70         //     Display Name <user@domain.org>
  71         value = vcard_get_prop(v, "n", 0, 0, 0);
  72         if (value != NULL) if (bmstrcasestr(value, search_string)) {
  73
  74                 value2 = vcard_get_prop(v, "email", 1, 0, 0);
  75                 if (value2 == NULL) value2 = "";
  76                 nnn = n_to_fn(value);
  77                 cprintf("%s <%s>\n", nnn, value2);
  78                 free(nnn);
  79                 vcard_free(v);
  80                 return;
  81         }
  82
  83         // Try a partial match on all listed email addresses.
  84         i = 0;
  85         while (value = vcard_get_prop(v, "email", 1, i++, 0), value != NULL) {
  86                 if (bmstrcasestr(value, search_string)) {
  87                         if (vcard_get_prop(v, "fn", 0, 0, 0)) {
  88                                 cprintf("%s <%s>\n", vcard_get_prop(v, "fn", 0, 0, 0), value);
  89                         }
  90                         else if (vcard_get_prop(v, "n", 0, 0, 0)) {
  91                                 nnn = n_to_fn(vcard_get_prop(v, "n", 0, 0, 0));
  92                                 cprintf("%s <%s>\n", nnn, value);
  93                                 free(nnn);
  94                         }
  95                         else {
  96                                 cprintf("%s\n", value);
  97                         }
  98                         vcard_free(v);
  99                         return;
 100                 }
 101         }
 102
 103         vcard_free(v);
 104 }
 105
 106
 107 // Attempt to autocomplete an address based on a partial...
 108 void cmd_auto(char *argbuf) {
 109         char hold_rm[ROOMNAMELEN];
 110         char search_string[256];
 111         long *msglist = NULL;
 112         int num_msgs = 0;
 113         int r = 0;
 114         int i = 0;
 115         int j = 0;
 116         int search_match = 0;
 117         char *rooms_to_try[] = { USERCONTACTSROOM, ADDRESS_BOOK_ROOM };
 118         Array *fts = NULL;
 119
 120         if (CtdlAccessCheck(ac_logged_in)) return;
 121         extract_token(search_string, argbuf, 0, '|', sizeof search_string);
 122         if (IsEmptyStr(search_string)) {
 123                 cprintf("%d You supplied an empty partial.\n", ERROR + ILLEGAL_VALUE);
 124                 return;
 125         }
 126
 127         strcpy(hold_rm, CC->room.QRname);                        // save where we were so we can go back
 128         cprintf("%d try these:\n", LISTING_FOLLOWS);
 129
 130         // Gather up message pointers in rooms containing vCards
 131         for (r=0; r < (sizeof(rooms_to_try) / sizeof(char *)); ++r) {
 132                 if (CtdlGetRoom(&CC->room, rooms_to_try[r]) == 0) {
 133                         num_msgs = CtdlFetchMsgList(CC->room.QRnumber, &msglist);
 134
 135                         // Search-reduce the results if we have the full text index available
 136                         if (CtdlGetConfigInt("c_enable_fulltext")) {
 137                                 fts = CtdlFullTextSearch(search_string);
 138                                 if (fts) {
 139                                         for (i=0; i<num_msgs; ++i) {
 140                                                 search_match = 0;
 141                                                 for (j=0; j<array_len(fts); ++j) {
 142                                                         long smsgnum;
 143                                                         memcpy(&smsgnum, array_get_element_at(fts, j), sizeof(long));
 144                                                         if (msglist[i] == smsgnum) {
 145                                                                 search_match = 1;
 146                                                                 j = array_len(fts) + 1; // end the search
 147                                                         }
 148                                                 }
 149                                                 if (!search_match) {
 150                                                         msglist[i] = 0;                 // invalidate this result
 151                                                 }
 152                                         }
 153                                         array_free(fts);
 154                                 }
 155                                 else {
 156                                         // If no results, invalidate the whole list
 157                                         free(msglist);
 158                                         msglist = NULL;
 159                                         num_msgs = 0;
 160                                 }
 161                         }
 162
 163                         // Now output the ones that look interesting
 164                         if (num_msgs > 0) for (i=0; i<num_msgs; ++i) {
 165                                 if (msglist[i] != 0) {
 166                                         hunt_for_autocomplete(msglist[i], search_string);
 167                                 }
 168                         }
 169                 }
 170         }
 171
 172         cprintf("000\n");
 173         if (strcmp(CC->room.QRname, hold_rm)) {
 174                 CtdlGetRoom(&CC->room, hold_rm);                                        // return to saved room
 175         }
 176
 177         if (msglist) {
 178                 free(msglist);
 179         }
 180
 181 }
 182
 183
 184 // Initialization function, called from modules_init.c
 185 char *ctdl_module_init_autocompletion(void) {
 186         if (!threading) {
 187                 CtdlRegisterProtoHook(cmd_auto, "AUTO", "Do recipient autocompletion");
 188         }
 189         // return our module name for the log
 190         return "autocompletion";
 191 }