citadel/modules/network/serv_network.c

   1 /*
   2  * This module handles shared rooms, inter-Citadel mail, and outbound
   3  * mailing list processing.
   4  *
   5  * Copyright (c) 2000-2016 by the citadel.org team
   6  *
   7  * This program is open source software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License, version 3.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * ** NOTE **   A word on the S_NETCONFIGS semaphore:
  16  * This is a fairly high-level type of critical section.  It ensures that no
  17  * two threads work on the netconfigs files at the same time.  Since we do
  18  * so many things inside these, here are the rules:
  19  *  1. begin_critical_section(S_NETCONFIGS) *before* begin_ any others.
  20  *  2. Do *not* perform any I/O with the client during these sections.
  21  */
  22
  23 /*
  24  * Duration of time (in seconds) after which pending list subscribe/unsubscribe
  25  * requests that have not been confirmed will be deleted.
  26  */
  27 #define EXP     259200  /* three days */
  28
  29 #include "sysdep.h"
  30 #include <stdlib.h>
  31 #include <unistd.h>
  32 #include <stdio.h>
  33 #include <fcntl.h>
  34 #include <ctype.h>
  35 #include <signal.h>
  36 #include <pwd.h>
  37 #include <errno.h>
  38 #include <sys/stat.h>
  39 #include <sys/types.h>
  40 #include <dirent.h>
  41 #if TIME_WITH_SYS_TIME
  42 # include <sys/time.h>
  43 # include <time.h>
  44 #else
  45 # if HAVE_SYS_TIME_H
  46 #  include <sys/time.h>
  47 # else
  48 #  include <time.h>
  49 # endif
  50 #endif
  51 #ifdef HAVE_SYSCALL_H
  52 # include <syscall.h>
  53 #else
  54 # if HAVE_SYS_SYSCALL_H
  55 #  include <sys/syscall.h>
  56 # endif
  57 #endif
  58
  59 #include <sys/wait.h>
  60 #include <string.h>
  61 #include <limits.h>
  62 #include <libcitadel.h>
  63 #include "citadel.h"
  64 #include "server.h"
  65 #include "citserver.h"
  66 #include "support.h"
  67 #include "config.h"
  68 #include "user_ops.h"
  69 #include "database.h"
  70 #include "msgbase.h"
  71 #include "internet_addressing.h"
  72 #include "serv_network.h"
  73 #include "clientsocket.h"
  74 #include "citadel_dirs.h"
  75 #include "threads.h"
  76 #include "context.h"
  77 #include "ctdl_module.h"
  78 #include "netspool.h"
  79 #include "netmail.h"
  80
  81 int NetQDebugEnabled = 0;
  82 struct CitContext networker_spool_CC;
  83
  84 /* comes from lookup3.c from libcitadel... */
  85 extern uint32_t hashlittle( const void *key, size_t length, uint32_t initval);
  86
  87 typedef struct __roomlists {
  88         RoomProcList *rplist;
  89 } roomlists;
  90
  91
  92 /*
  93  * When we do network processing, it's accomplished in two passes; one to
  94  * gather a list of rooms and one to actually do them.  It's ok that rplist
  95  * is global; we have a mutex that keeps it safe.
  96  */
  97 struct RoomProcList *rplist = NULL;
  98
  99
 100 /*
 101  * Send the *entire* contents of the current room to one specific network node,
 102  * ignoring anything we know about which messages have already undergone
 103  * network processing.  This can be used to bring a new node into sync.
 104  */
 105 int network_sync_to(char *target_node, long len)
 106 {
 107         struct CitContext *CCC = CC;
 108         OneRoomNetCfg OneRNCFG;
 109         OneRoomNetCfg *pRNCFG;
 110         const RoomNetCfgLine *pCfgLine;
 111         SpoolControl sc;
 112         int num_spooled = 0;
 113
 114         /* Load the netconfig for this room */
 115         pRNCFG = CtdlGetNetCfgForRoom(CCC->room.QRnumber);
 116         if (pRNCFG == NULL) {                                   // no netconfig at all?
 117                 return -1;
 118         }
 119         if (pRNCFG->NetConfigs[ignet_push_share] == NULL)       // no ignet push shares?
 120         {
 121                 FreeRoomNetworkStruct(&pRNCFG);
 122                 return -1;
 123         }
 124
 125         /* Search for an ignet_oush_share configuration bearing the target node's name */
 126         for (pCfgLine = pRNCFG->NetConfigs[ignet_push_share]; pCfgLine != NULL; pCfgLine = pCfgLine->next)
 127         {
 128                 if (!strcmp(ChrPtr(pCfgLine->Value[0]), target_node))
 129                         break;
 130         }
 131
 132         /* If we aren't sharing with that node, bail out */
 133         if (pCfgLine == NULL)
 134         {
 135                 FreeRoomNetworkStruct(&pRNCFG);
 136                 return -1;
 137         }
 138
 139         /* If we got here, we're good to go ... make up a dummy spoolconfig and roll with it */
 140
 141         begin_critical_section(S_NETCONFIGS);
 142         memset(&sc, 0, sizeof(SpoolControl));
 143         memset(&OneRNCFG, 0, sizeof(OneRoomNetCfg));
 144         sc.RNCfg = &OneRNCFG;
 145         sc.RNCfg->NetConfigs[ignet_push_share] = DuplicateOneGenericCfgLine(pCfgLine);
 146         sc.Users[ignet_push_share] = NewStrBufPlain(NULL, (StrLength(pCfgLine->Value[0]) + StrLength(pCfgLine->Value[1]) + 10) );
 147         StrBufAppendBuf(sc.Users[ignet_push_share], pCfgLine->Value[0], 0);
 148         StrBufAppendBufPlain(sc.Users[ignet_push_share], HKEY(","), 0);
 149         StrBufAppendBuf(sc.Users[ignet_push_share], pCfgLine->Value[1], 0);
 150         CalcListID(&sc);
 151         end_critical_section(S_NETCONFIGS);
 152
 153         sc.working_ignetcfg = CtdlLoadIgNetCfg();
 154         sc.the_netmap = CtdlReadNetworkMap();
 155
 156         /* Send ALL messages */
 157         num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, network_spool_msg, &sc);
 158
 159         /* Concise cleanup because we know there's only one node in the sc */
 160         DeleteGenericCfgLine(NULL, &sc.RNCfg->NetConfigs[ignet_push_share]);
 161
 162         DeleteHash(&sc.working_ignetcfg);
 163         DeleteHash(&sc.the_netmap);
 164         free_spoolcontrol_struct_members(&sc);
 165
 166         QN_syslog(LOG_NOTICE, "Synchronized %d messages to <%s>", num_spooled, target_node);
 167         return(num_spooled);
 168 }
 169
 170
 171 /*
 172  * Implements the NSYN command
 173  */
 174 void cmd_nsyn(char *argbuf) {
 175         int num_spooled;
 176         long len;
 177         char target_node[256];
 178
 179         if (CtdlAccessCheck(ac_aide)) return;
 180
 181         len = extract_token(target_node, argbuf, 0, '|', sizeof target_node);
 182         num_spooled = network_sync_to(target_node, len);
 183         if (num_spooled >= 0) {
 184                 cprintf("%d Spooled %d messages.\n", CIT_OK, num_spooled);
 185         }
 186         else {
 187                 cprintf("%d No such room/node share exists.\n", ERROR + ROOM_NOT_FOUND);
 188         }
 189 }
 190
 191 RoomProcList *CreateRoomProcListEntry(struct ctdlroom *qrbuf, OneRoomNetCfg *OneRNCFG)
 192 {
 193         int i;
 194         struct RoomProcList *ptr;
 195
 196         ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
 197         if (ptr == NULL) return NULL;
 198
 199         ptr->namelen = strlen(qrbuf->QRname);
 200         if (ptr->namelen > ROOMNAMELEN)
 201                 ptr->namelen = ROOMNAMELEN - 1;
 202
 203         memcpy (ptr->name, qrbuf->QRname, ptr->namelen);
 204         ptr->name[ptr->namelen] = '\0';
 205         ptr->QRNum = qrbuf->QRnumber;
 206
 207         for (i = 0; i < ptr->namelen; i++)
 208         {
 209                 ptr->lcname[i] = tolower(ptr->name[i]);
 210         }
 211
 212         ptr->lcname[ptr->namelen] = '\0';
 213         ptr->key = hashlittle(ptr->lcname, ptr->namelen, 9872345);
 214         ptr->lastsent = OneRNCFG->lastsent;
 215         ptr->OneRNCfg = OneRNCFG;
 216         return ptr;
 217 }
 218
 219 /*
 220  * Batch up and send all outbound traffic from the current room
 221  */
 222 void network_queue_interesting_rooms(struct ctdlroom *qrbuf, void *data, OneRoomNetCfg *OneRNCfg)
 223 {
 224         struct RoomProcList *ptr;
 225         roomlists *RP = (roomlists*) data;
 226
 227         if (!HaveSpoolConfig(OneRNCfg)) {
 228                 return;
 229         }
 230
 231         ptr = CreateRoomProcListEntry(qrbuf, OneRNCfg);
 232
 233         if (ptr != NULL)
 234         {
 235                 ptr->next = RP->rplist;
 236                 RP->rplist = ptr;
 237         }
 238 }
 239
 240 /*
 241  * Batch up and send all outbound traffic from the current room
 242  */
 243 int network_room_handler(struct ctdlroom *qrbuf)
 244 {
 245         struct RoomProcList *ptr;
 246         OneRoomNetCfg *RNCfg;
 247
 248         if (qrbuf->QRdefaultview == VIEW_QUEUE) {
 249                 return 1;
 250         }
 251
 252         RNCfg = CtdlGetNetCfgForRoom(qrbuf->QRnumber);
 253         if (RNCfg == NULL) {
 254                 return 1;
 255         }
 256
 257         if (!HaveSpoolConfig(RNCfg)) {
 258                 FreeRoomNetworkStruct(&RNCfg);
 259                 return 1;
 260         }
 261
 262         ptr = CreateRoomProcListEntry(qrbuf, RNCfg);
 263         if (ptr == NULL) {
 264                 FreeRoomNetworkStruct(&RNCfg);
 265                 return 1;
 266         }
 267
 268         ptr->OneRNCfg = NULL;
 269         begin_critical_section(S_RPLIST);
 270         ptr->next = rplist;
 271         rplist = ptr;
 272         end_critical_section(S_RPLIST);
 273         FreeRoomNetworkStruct(&RNCfg);
 274         return 1;
 275 }
 276
 277 void destroy_network_queue_room(RoomProcList *rplist)
 278 {
 279         struct RoomProcList *cur, *p;
 280
 281         cur = rplist;
 282         while (cur != NULL)
 283         {
 284                 p = cur->next;
 285                 free (cur);
 286                 cur = p;
 287         }
 288 }
 289
 290 void destroy_network_queue_room_locked (void)
 291 {
 292         begin_critical_section(S_RPLIST);
 293         destroy_network_queue_room(rplist);
 294         end_critical_section(S_RPLIST);
 295 }
 296
 297
 298 /*
 299  * network_do_queue()
 300  *
 301  * Run through the rooms doing various types of network stuff.
 302  */
 303 void network_do_queue(void)
 304 {
 305         struct CitContext *CCC = CC;
 306         static time_t last_run = 0L;
 307         int full_processing = 1;
 308         HashList *working_ignetcfg;
 309         HashList *the_netmap = NULL;
 310         int netmap_changed = 0;
 311         roomlists RL;
 312         SpoolControl *sc = NULL;
 313         SpoolControl *pSC;
 314
 315         /*
 316          * Run the full set of processing tasks no more frequently
 317          * than once every n seconds
 318          */
 319         if ( (time(NULL) - last_run) < CtdlGetConfigLong("c_net_freq") )
 320         {
 321                 full_processing = 0;
 322                 syslog(LOG_DEBUG, "Network full processing in %ld seconds.",
 323                        CtdlGetConfigLong("c_net_freq") - (time(NULL)- last_run)
 324                 );
 325         }
 326
 327         become_session(&networker_spool_CC);
 328         begin_critical_section(S_RPLIST);
 329         RL.rplist = rplist;
 330         rplist = NULL;
 331         end_critical_section(S_RPLIST);
 332
 333         // TODO hm, check whether we have a config at all here?
 334         /* Load the IGnet Configuration into memory */
 335         working_ignetcfg = CtdlLoadIgNetCfg();
 336
 337         /*
 338          * Load the network map and filter list into memory.
 339          */
 340         if (!server_shutting_down) {
 341                 the_netmap = CtdlReadNetworkMap();
 342         }
 343
 344         /*
 345          * Go ahead and run the queue
 346          */
 347         if (full_processing && !server_shutting_down) {
 348                 QNM_syslog(LOG_DEBUG, "network: loading outbound queue");
 349                 CtdlForEachNetCfgRoom(network_queue_interesting_rooms, &RL, maxRoomNetCfg);
 350         }
 351
 352         if ((RL.rplist != NULL) && (!server_shutting_down)) {
 353                 RoomProcList *ptr, *cmp;
 354                 ptr = RL.rplist;
 355                 QNM_syslog(LOG_DEBUG, "network: running outbound queue");
 356                 while (ptr != NULL && !server_shutting_down) {
 357
 358                         cmp = ptr->next;
 359                         /* filter duplicates from the list... */
 360                         while (cmp != NULL) {
 361                                 if ((cmp->namelen > 0) &&
 362                                     (cmp->key == ptr->key) &&
 363                                     (cmp->namelen == ptr->namelen) &&
 364                                     (strcmp(cmp->lcname, ptr->lcname) == 0))
 365                                 {
 366                                         cmp->namelen = 0;
 367                                 }
 368                                 cmp = cmp->next;
 369                         }
 370
 371                         if (ptr->namelen > 0) {
 372                                 InspectQueuedRoom(&sc,
 373                                                   ptr,
 374                                                   working_ignetcfg,
 375                                                   the_netmap);
 376                         }
 377                         ptr = ptr->next;
 378                 }
 379         }
 380
 381
 382         pSC = sc;
 383         while (pSC != NULL)
 384         {
 385                 network_spoolout_room(pSC);
 386                 pSC = pSC->next;
 387         }
 388
 389         pSC = sc;
 390         while (pSC != NULL)
 391         {
 392                 sc = pSC->next;
 393                 free_spoolcontrol_struct(&pSC);
 394                 pSC = sc;
 395         }
 396         /* If there is anything in the inbound queue, process it */
 397         if (!server_shutting_down) {
 398                 network_do_spoolin(working_ignetcfg,
 399                                    the_netmap,
 400                                    &netmap_changed);
 401         }
 402
 403         /* Free the filter list in memory */
 404         free_netfilter_list();
 405
 406         /* Save the network map back to disk */
 407         if (netmap_changed) {
 408                 StrBuf *MapStr = CtdlSerializeNetworkMap(the_netmap);
 409                 char *pMapStr = SmashStrBuf(&MapStr);
 410                 CtdlPutSysConfig(IGNETMAP, pMapStr);
 411                 free(pMapStr);
 412         }
 413
 414         /* combine singe message files into one spool entry per remote node. */
 415         network_consolidate_spoolout(working_ignetcfg, the_netmap);
 416
 417         /* shut down. */
 418
 419         DeleteHash(&the_netmap);
 420
 421         DeleteHash(&working_ignetcfg);
 422
 423         QNM_syslog(LOG_DEBUG, "network: queue run completed");
 424
 425         if (full_processing) {
 426                 last_run = time(NULL);
 427         }
 428         destroy_network_queue_room(RL.rplist);
 429         // SaveChangedConfigs();        // FIXME FOOFOO SAVE CHANGED THIS AACACACACCKK
 430
 431 }
 432
 433
 434 void network_logout_hook(void)
 435 {
 436         CitContext *CCC = MyContext();
 437
 438         /*
 439          * If we were talking to a network node, we're not anymore...
 440          */
 441         if (!IsEmptyStr(CCC->net_node)) {
 442                 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
 443                 CCC->net_node[0] = '\0';
 444         }
 445 }
 446
 447
 448 void network_cleanup_function(void)
 449 {
 450         struct CitContext *CCC = CC;
 451
 452         if (!IsEmptyStr(CCC->net_node)) {
 453                 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
 454                 CCC->net_node[0] = '\0';
 455         }
 456 }
 457
 458
 459 int ignet_aftersave(struct CtdlMessage *msg, recptypes *recps)
 460 {
 461         /* For IGnet mail, we have to save a new copy into the spooler for
 462          * each recipient, with the R and D fields set to the recipient and
 463          * destination-node.  This has two ugly side effects: all other
 464          * recipients end up being unlisted in this recipient's copy of the
 465          * message, and it has to deliver multiple messages to the same
 466          * node.  We'll revisit this again in a year or so when everyone has
 467          * a network spool receiver that can handle the new style messages.
 468          */
 469         if ((recps != NULL) && (recps->num_ignet > 0))
 470         {
 471                 char *recipient;
 472                 int rv = 0;
 473                 struct ser_ret smr;
 474                 FILE *network_fp = NULL;
 475                 char submit_filename[128];
 476                 static int seqnum = 1;
 477                 int i;
 478                 char *hold_R, *hold_D, *RBuf, *DBuf;
 479                 long hrlen, hdlen, rblen, dblen, count, rlen;
 480                 CitContext *CCC = MyContext();
 481
 482                 CM_GetAsField(msg, eRecipient, &hold_R, &hrlen);;
 483                 CM_GetAsField(msg, eDestination, &hold_D, &hdlen);;
 484
 485                 count = num_tokens(recps->recp_ignet, '|');
 486                 rlen = strlen(recps->recp_ignet);
 487                 recipient = malloc(rlen + 1);
 488                 RBuf = malloc(rlen + 1);
 489                 DBuf = malloc(rlen + 1);
 490                 for (i=0; i<count; ++i) {
 491                         extract_token(recipient, recps->recp_ignet, i, '|', rlen + 1);
 492
 493                         rblen = extract_token(RBuf, recipient, 0, '@', rlen + 1);
 494                         dblen = extract_token(DBuf, recipient, 1, '@', rlen + 1);
 495
 496                         CM_SetAsField(msg, eRecipient, &RBuf, rblen);;
 497                         CM_SetAsField(msg, eDestination, &DBuf, dblen);;
 498                         CtdlSerializeMessage(&smr, msg);
 499                         if (smr.len > 0) {
 500                                 snprintf(submit_filename, sizeof submit_filename,
 501                                          "%s/netmail.%04lx.%04x.%04x",
 502                                          ctdl_netin_dir,
 503                                          (long) getpid(),
 504                                          CCC->cs_pid,
 505                                          ++seqnum);
 506
 507                                 network_fp = fopen(submit_filename, "wb+");
 508                                 if (network_fp != NULL) {
 509                                         rv = fwrite(smr.ser, smr.len, 1, network_fp);
 510                                         if (rv == -1) {
 511                                                 MSG_syslog(LOG_EMERG, "CtdlSubmitMsg(): Couldn't write network spool file: %s",
 512                                                            strerror(errno));
 513                                         }
 514                                         fclose(network_fp);
 515                                 }
 516                                 free(smr.ser);
 517                         }
 518                         CM_GetAsField(msg, eRecipient, &RBuf, &rblen);;
 519                         CM_GetAsField(msg, eDestination, &DBuf, &dblen);;
 520                 }
 521                 free(RBuf);
 522                 free(DBuf);
 523                 free(recipient);
 524                 CM_SetAsField(msg, eRecipient, &hold_R, hrlen);
 525                 CM_SetAsField(msg, eDestination, &hold_D, hdlen);
 526                 return 1;
 527         }
 528         return 0;
 529 }
 530
 531
 532 /*
 533  * Module entry point
 534  */
 535
 536 void SetNetQDebugEnabled(const int n)
 537 {
 538         NetQDebugEnabled = n;
 539 }
 540
 541
 542 CTDL_MODULE_INIT(network)
 543 {
 544         if (!threading)
 545         {
 546                 CtdlRegisterMessageHook(ignet_aftersave, EVT_AFTERSAVE);
 547
 548                 CtdlFillSystemContext(&networker_spool_CC, "CitNetSpool");
 549                 CtdlRegisterDebugFlagHook(HKEY("networkqueue"), SetNetQDebugEnabled, &NetQDebugEnabled);
 550                 CtdlRegisterSessionHook(network_cleanup_function, EVT_STOP, PRIO_STOP + 30);
 551                 CtdlRegisterSessionHook(network_logout_hook, EVT_LOGOUT, PRIO_LOGOUT + 10);
 552                 CtdlRegisterProtoHook(cmd_nsyn, "NSYN", "Synchronize room to node");
 553                 CtdlRegisterRoomHook(network_room_handler);
 554                 CtdlRegisterCleanupHook(destroy_network_queue_room_locked);
 555                 CtdlRegisterSessionHook(network_do_queue, EVT_TIMER, PRIO_QUEUE + 10);
 556         }
 557         return "network";
 558 }