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-2012 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 /*
  25  * Duration of time (in seconds) after which pending list subscribe/unsubscribe
  26  * requests that have not been confirmed will be deleted.
  27  */
  28 #define EXP     259200  /* three days */
  29
  30 #include "sysdep.h"
  31 #include <stdlib.h>
  32 #include <unistd.h>
  33 #include <stdio.h>
  34 #include <fcntl.h>
  35 #include <ctype.h>
  36 #include <signal.h>
  37 #include <pwd.h>
  38 #include <errno.h>
  39 #include <sys/stat.h>
  40 #include <sys/types.h>
  41 #include <dirent.h>
  42 #if TIME_WITH_SYS_TIME
  43 # include <sys/time.h>
  44 # include <time.h>
  45 #else
  46 # if HAVE_SYS_TIME_H
  47 #  include <sys/time.h>
  48 # else
  49 #  include <time.h>
  50 # endif
  51 #endif
  52 #ifdef HAVE_SYSCALL_H
  53 # include <syscall.h>
  54 #else
  55 # if HAVE_SYS_SYSCALL_H
  56 #  include <sys/syscall.h>
  57 # endif
  58 #endif
  59
  60 #include <sys/wait.h>
  61 #include <string.h>
  62 #include <limits.h>
  63 #include <libcitadel.h>
  64 #include "citadel.h"
  65 #include "server.h"
  66 #include "citserver.h"
  67 #include "support.h"
  68 #include "config.h"
  69 #include "user_ops.h"
  70 #include "database.h"
  71 #include "msgbase.h"
  72 #include "internet_addressing.h"
  73 #include "serv_network.h"
  74 #include "clientsocket.h"
  75 #include "file_ops.h"
  76 #include "citadel_dirs.h"
  77 #include "threads.h"
  78 #include "context.h"
  79 #include "ctdl_module.h"
  80 #include "netspool.h"
  81 #include "netmail.h"
  82
  83 int NetQDebugEnabled = 0;
  84 struct CitContext networker_spool_CC;
  85
  86 /* comes from lookup3.c from libcitadel... */
  87 extern uint32_t hashlittle( const void *key, size_t length, uint32_t initval);
  88
  89 typedef struct __roomlists {
  90         RoomProcList *rplist;
  91 }roomlists;
  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 /*
 102  * Check the use table.  This is a list of messages which have recently
 103  * arrived on the system.  It is maintained and queried to prevent the same
 104  * message from being entered into the database multiple times if it happens
 105  * to arrive multiple times by accident.
 106  */
 107 int network_usetable(struct CtdlMessage *msg)
 108 {
 109         struct CitContext *CCC = CC;
 110         char msgid[SIZ];
 111         struct cdbdata *cdbut;
 112         struct UseTable ut;
 113
 114         /* Bail out if we can't generate a message ID */
 115         if (msg == NULL) {
 116                 return(0);
 117         }
 118         if (msg->cm_fields['I'] == NULL) {
 119                 return(0);
 120         }
 121         if (IsEmptyStr(msg->cm_fields['I'])) {
 122                 return(0);
 123         }
 124
 125         /* Generate the message ID */
 126         strcpy(msgid, msg->cm_fields['I']);
 127         if (haschar(msgid, '@') == 0) {
 128                 strcat(msgid, "@");
 129                 if (msg->cm_fields['N'] != NULL) {
 130                         strcat(msgid, msg->cm_fields['N']);
 131                 }
 132                 else {
 133                         return(0);
 134                 }
 135         }
 136
 137         cdbut = cdb_fetch(CDB_USETABLE, msgid, strlen(msgid));
 138         if (cdbut != NULL) {
 139                 cdb_free(cdbut);
 140                 QN_syslog(LOG_DEBUG, "network_usetable() : we already have %s\n", msgid);
 141                 return(1);
 142         }
 143
 144         /* If we got to this point, it's unique: add it. */
 145         strcpy(ut.ut_msgid, msgid);
 146         ut.ut_timestamp = time(NULL);
 147         cdb_store(CDB_USETABLE, msgid, strlen(msgid), &ut, sizeof(struct UseTable) );
 148         return(0);
 149 }
 150
 151
 152
 153 /*
 154  * Send the *entire* contents of the current room to one specific network node,
 155  * ignoring anything we know about which messages have already undergone
 156  * network processing.  This can be used to bring a new node into sync.
 157  */
 158 int network_sync_to(char *target_node, long len)
 159 {
 160         struct CitContext *CCC = CC;
 161         OneRoomNetCfg OneRNCFG;
 162         OneRoomNetCfg *pRNCFG;
 163         const RoomNetCfgLine *pCfgLine;
 164         SpoolControl sc;
 165         int num_spooled = 0;
 166
 167         /* Grab the configuration line we're looking for */
 168         begin_critical_section(S_NETCONFIGS);
 169         pRNCFG = CtdlGetNetCfgForRoom(CCC->room.QRnumber);
 170         if ((pRNCFG == NULL) ||
 171             (pRNCFG->NetConfigs[ignet_push_share] == NULL))
 172         {
 173                 return -1;
 174         }
 175
 176         pCfgLine = pRNCFG->NetConfigs[ignet_push_share];
 177         while (pCfgLine != NULL)
 178         {
 179                 if (strcmp(ChrPtr(pCfgLine->Value[0]), target_node))
 180                         break;
 181                 pCfgLine = pCfgLine->next;
 182         }
 183         if (pCfgLine == NULL)
 184         {
 185                 return -1;
 186         }
 187         memset(&sc, 0, sizeof(SpoolControl));
 188         memset(&OneRNCFG, 0, sizeof(OneRoomNetCfg));
 189         sc.RNCfg = &OneRNCFG;
 190         sc.RNCfg->NetConfigs[ignet_push_share] = DuplicateOneGenericCfgLine(pCfgLine);
 191
 192         end_critical_section(S_NETCONFIGS);
 193
 194         sc.working_ignetcfg = CtdlLoadIgNetCfg();
 195         sc.the_netmap = CtdlReadNetworkMap();
 196
 197         CalcListID(&sc);
 198
 199         /* Send ALL messages */
 200         num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
 201                 network_spool_msg, &sc);
 202
 203         /* Concise cleanup because we know there's only one node in the sc */
 204         DeleteGenericCfgLine(NULL/*TODO*/, &sc.RNCfg->NetConfigs[ignet_push_share]);
 205
 206         DeleteHash(&sc.working_ignetcfg);
 207         DeleteHash(&sc.the_netmap);
 208
 209         QN_syslog(LOG_NOTICE, "Synchronized %d messages to <%s>\n",
 210                   num_spooled, target_node);
 211         return(num_spooled);
 212 }
 213
 214
 215 /*
 216  * Implements the NSYN command
 217  */
 218 void cmd_nsyn(char *argbuf) {
 219         int num_spooled;
 220         long len;
 221         char target_node[256];
 222
 223         if (CtdlAccessCheck(ac_aide)) return;
 224
 225         len = extract_token(target_node, argbuf, 0, '|', sizeof target_node);
 226         num_spooled = network_sync_to(target_node, len);
 227         if (num_spooled >= 0) {
 228                 cprintf("%d Spooled %d messages.\n", CIT_OK, num_spooled);
 229         }
 230         else {
 231                 cprintf("%d No such room/node share exists.\n",
 232                         ERROR + ROOM_NOT_FOUND);
 233         }
 234 }
 235
 236 RoomProcList *CreateRoomProcListEntry(struct ctdlroom *qrbuf, OneRoomNetCfg *OneRNCFG)
 237 {
 238         int i;
 239         struct RoomProcList *ptr;
 240
 241         ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
 242         if (ptr == NULL) return NULL;
 243
 244         ptr->namelen = strlen(qrbuf->QRname);
 245         if (ptr->namelen > ROOMNAMELEN)
 246                 ptr->namelen = ROOMNAMELEN - 1;
 247
 248         memcpy (ptr->name, qrbuf->QRname, ptr->namelen);
 249         ptr->name[ptr->namelen] = '\0';
 250         ptr->QRNum = qrbuf->QRnumber;
 251
 252         for (i = 0; i < ptr->namelen; i++)
 253         {
 254                 ptr->lcname[i] = tolower(ptr->name[i]);
 255         }
 256
 257         ptr->lcname[ptr->namelen] = '\0';
 258         ptr->key = hashlittle(ptr->lcname, ptr->namelen, 9872345);
 259         ptr->lastsent = OneRNCFG->lastsent;
 260         ptr->OneRNCfg = OneRNCFG;
 261         return ptr;
 262 }
 263
 264 /*
 265  * Batch up and send all outbound traffic from the current room
 266  */
 267 void network_queue_interesting_rooms(struct ctdlroom *qrbuf, void *data, OneRoomNetCfg *OneRNCfg)
 268 {
 269         struct RoomProcList *ptr;
 270         roomlists *RP = (roomlists*) data;
 271
 272         if (!HaveSpoolConfig(OneRNCfg))
 273                 return;
 274
 275         ptr = CreateRoomProcListEntry(qrbuf, OneRNCfg);
 276
 277         if (ptr != NULL)
 278         {
 279                 ptr->next = RP->rplist;
 280                 RP->rplist = ptr;
 281         }
 282 }
 283
 284 /*
 285  * Batch up and send all outbound traffic from the current room
 286  */
 287 int network_room_handler (struct ctdlroom *qrbuf)
 288 {
 289         struct RoomProcList *ptr;
 290         OneRoomNetCfg* RNCfg;
 291
 292         if (qrbuf->QRdefaultview == VIEW_QUEUE)
 293                 return 1;
 294
 295         RNCfg = CtdlGetNetCfgForRoom(qrbuf->QRnumber);
 296         if (RNCfg == NULL)
 297                 return 1;
 298
 299         if (!HaveSpoolConfig(RNCfg))
 300                 return 1;
 301
 302         ptr = CreateRoomProcListEntry(qrbuf, RNCfg);
 303         if (ptr == NULL)
 304                 return 1;
 305
 306         ptr->OneRNCfg = NULL;
 307         begin_critical_section(S_RPLIST);
 308         ptr->next = rplist;
 309         rplist = ptr;
 310         end_critical_section(S_RPLIST);
 311         return 1;
 312 }
 313
 314 void destroy_network_queue_room(RoomProcList *rplist)
 315 {
 316         struct RoomProcList *cur, *p;
 317
 318         cur = rplist;
 319         while (cur != NULL)
 320         {
 321                 p = cur->next;
 322                 free (cur);
 323                 cur = p;
 324         }
 325 }
 326
 327 void destroy_network_queue_room_locked (void)
 328 {
 329         begin_critical_section(S_RPLIST);
 330         destroy_network_queue_room(rplist);
 331         end_critical_section(S_RPLIST);
 332 }
 333
 334
 335
 336 /*
 337  * Bounce a message back to the sender
 338  */
 339 void network_bounce(struct CtdlMessage *msg, char *reason)
 340 {
 341         struct CitContext *CCC = CC;
 342         char *oldpath = NULL;
 343         char buf[SIZ];
 344         char bouncesource[SIZ];
 345         char recipient[SIZ];
 346         struct recptypes *valid = NULL;
 347         char force_room[ROOMNAMELEN];
 348         static int serialnum = 0;
 349         size_t size;
 350
 351         QNM_syslog(LOG_DEBUG, "entering network_bounce()\n");
 352
 353         if (msg == NULL) return;
 354
 355         snprintf(bouncesource, sizeof bouncesource, "%s@%s", BOUNCESOURCE, config.c_nodename);
 356
 357         /*
 358          * Give it a fresh message ID
 359          */
 360         if (msg->cm_fields['I'] != NULL) {
 361                 free(msg->cm_fields['I']);
 362         }
 363         snprintf(buf, sizeof buf, "%ld.%04lx.%04x@%s",
 364                 (long)time(NULL), (long)getpid(), ++serialnum, config.c_fqdn);
 365         msg->cm_fields['I'] = strdup(buf);
 366
 367         /*
 368          * FIXME ... right now we're just sending a bounce; we really want to
 369          * include the text of the bounced message.
 370          */
 371         if (msg->cm_fields['M'] != NULL) {
 372                 free(msg->cm_fields['M']);
 373         }
 374         msg->cm_fields['M'] = strdup(reason);
 375         msg->cm_format_type = 0;
 376
 377         /*
 378          * Turn the message around
 379          */
 380         if (msg->cm_fields['R'] == NULL) {
 381                 free(msg->cm_fields['R']);
 382         }
 383
 384         if (msg->cm_fields['D'] == NULL) {
 385                 free(msg->cm_fields['D']);
 386         }
 387
 388         snprintf(recipient, sizeof recipient, "%s@%s",
 389                 msg->cm_fields['A'], msg->cm_fields['N']);
 390
 391         if (msg->cm_fields['A'] == NULL) {
 392                 free(msg->cm_fields['A']);
 393         }
 394
 395         if (msg->cm_fields['N'] == NULL) {
 396                 free(msg->cm_fields['N']);
 397         }
 398
 399         if (msg->cm_fields['U'] == NULL) {
 400                 free(msg->cm_fields['U']);
 401         }
 402
 403         msg->cm_fields['A'] = strdup(BOUNCESOURCE);
 404         msg->cm_fields['N'] = strdup(config.c_nodename);
 405         msg->cm_fields['U'] = strdup("Delivery Status Notification (Failure)");
 406
 407         /* prepend our node to the path */
 408         if (msg->cm_fields['P'] != NULL) {
 409                 oldpath = msg->cm_fields['P'];
 410                 msg->cm_fields['P'] = NULL;
 411         }
 412         else {
 413                 oldpath = strdup("unknown_user");
 414         }
 415         size = strlen(oldpath) + SIZ;
 416         msg->cm_fields['P'] = malloc(size);
 417         snprintf(msg->cm_fields['P'], size, "%s!%s", config.c_nodename, oldpath);
 418         free(oldpath);
 419
 420         /* Now submit the message */
 421         valid = validate_recipients(recipient, NULL, 0);
 422         if (valid != NULL) if (valid->num_error != 0) {
 423                 free_recipients(valid);
 424                 valid = NULL;
 425         }
 426         if ( (valid == NULL) || (!strcasecmp(recipient, bouncesource)) ) {
 427                 strcpy(force_room, config.c_aideroom);
 428         }
 429         else {
 430                 strcpy(force_room, "");
 431         }
 432         if ( (valid == NULL) && IsEmptyStr(force_room) ) {
 433                 strcpy(force_room, config.c_aideroom);
 434         }
 435         CtdlSubmitMsg(msg, valid, force_room, 0);
 436
 437         /* Clean up */
 438         if (valid != NULL) free_recipients(valid);
 439         CtdlFreeMessage(msg);
 440         QNM_syslog(LOG_DEBUG, "leaving network_bounce()\n");
 441 }
 442
 443
 444 void free_network_spoolout_room(SpoolControl *sc)
 445 {
 446         if (sc != NULL)
 447         {
 448                 int i;
 449                 for (i = subpending; i < maxRoomNetCfg; i++)
 450                         FreeStrBuf(&sc->Users[i]);
 451                 free(sc);
 452         }
 453 }
 454
 455
 456
 457
 458 /*
 459  * network_do_queue()
 460  *
 461  * Run through the rooms doing various types of network stuff.
 462  */
 463 void network_do_queue(void)
 464 {
 465         struct CitContext *CCC = CC;
 466         static time_t last_run = 0L;
 467         int full_processing = 1;
 468         HashList *working_ignetcfg;
 469         HashList *the_netmap = NULL;
 470         int netmap_changed = 0;
 471         roomlists RL;
 472         SpoolControl *sc = NULL;
 473         SpoolControl *pSC;
 474
 475         /*
 476          * Run the full set of processing tasks no more frequently
 477          * than once every n seconds
 478          */
 479         if ( (time(NULL) - last_run) < config.c_net_freq ) {
 480                 full_processing = 0;
 481                 syslog(LOG_DEBUG, "Network full processing in %ld seconds.\n",
 482                        config.c_net_freq - (time(NULL)- last_run)
 483                 );
 484         }
 485
 486         become_session(&networker_spool_CC);
 487         begin_critical_section(S_RPLIST);
 488         RL.rplist = rplist;
 489         rplist = NULL;
 490         end_critical_section(S_RPLIST);
 491 ///TODO hm, check whether we have a config at all here?
 492         /* Load the IGnet Configuration into memory */
 493         working_ignetcfg = CtdlLoadIgNetCfg();
 494
 495         /*
 496          * Load the network map and filter list into memory.
 497          */
 498         if (!server_shutting_down)
 499                 the_netmap = CtdlReadNetworkMap();
 500 #if 0
 501         /* filterlist isn't supported anymore
 502         if (!server_shutting_down)
 503                 load_network_filter_list();
 504         */
 505 #endif
 506
 507         /*
 508          * Go ahead and run the queue
 509          */
 510         if (full_processing && !server_shutting_down) {
 511                 QNM_syslog(LOG_DEBUG, "network: loading outbound queue");
 512                 CtdlForEachNetCfgRoom(network_queue_interesting_rooms, &RL, maxRoomNetCfg);
 513         }
 514
 515         if ((RL.rplist != NULL) && (!server_shutting_down)) {
 516                 RoomProcList *ptr, *cmp;
 517                 ptr = RL.rplist;
 518                 QNM_syslog(LOG_DEBUG, "network: running outbound queue");
 519                 while (ptr != NULL && !server_shutting_down) {
 520
 521                         cmp = ptr->next;
 522                         /* filter duplicates from the list... */
 523                         while (cmp != NULL) {
 524                                 if ((cmp->namelen > 0) &&
 525                                     (cmp->key == ptr->key) &&
 526                                     (cmp->namelen == ptr->namelen) &&
 527                                     (strcmp(cmp->lcname, ptr->lcname) == 0))
 528                                 {
 529                                         cmp->namelen = 0;
 530                                 }
 531                                 cmp = cmp->next;
 532                         }
 533
 534                         if (ptr->namelen > 0) {
 535                                 InspectQueuedRoom(&sc,
 536                                                   ptr,
 537                                                   working_ignetcfg,
 538                                                   the_netmap);
 539                         }
 540                         ptr = ptr->next;
 541                 }
 542         }
 543
 544
 545         pSC = sc;
 546         while (pSC != NULL)
 547         {
 548                 network_spoolout_room(pSC);
 549                 pSC = pSC->next;
 550         }
 551
 552         pSC = sc;
 553         while (pSC != NULL)
 554         {
 555                 sc = pSC->next;
 556                 free_network_spoolout_room(pSC);
 557                 pSC = sc;
 558         }
 559         /* If there is anything in the inbound queue, process it */
 560         if (!server_shutting_down) {
 561                 network_do_spoolin(working_ignetcfg,
 562                                    the_netmap,
 563                                    &netmap_changed);
 564         }
 565
 566         /* Free the filter list in memory */
 567         free_netfilter_list();
 568
 569         /* Save the network map back to disk */
 570         if (netmap_changed) {
 571                 StrBuf *MapStr = CtdlSerializeNetworkMap(the_netmap);
 572                 char *pMapStr = SmashStrBuf(&MapStr);
 573                 CtdlPutSysConfig(IGNETMAP, pMapStr);
 574                 free(pMapStr);
 575         }
 576
 577         /* combine singe message files into one spool entry per remote node. */
 578         network_consolidate_spoolout(working_ignetcfg, the_netmap);
 579
 580         /* shut down. */
 581
 582         DeleteHash(&the_netmap);
 583
 584         DeleteHash(&working_ignetcfg);
 585
 586         QNM_syslog(LOG_DEBUG, "network: queue run completed");
 587
 588         if (full_processing) {
 589                 last_run = time(NULL);
 590         }
 591         destroy_network_queue_room(RL.rplist);
 592         SaveChangedConfigs();
 593
 594 }
 595
 596
 597
 598
 599
 600
 601
 602
 603 void network_logout_hook(void)
 604 {
 605         CitContext *CCC = MyContext();
 606
 607         /*
 608          * If we were talking to a network node, we're not anymore...
 609          */
 610         if (!IsEmptyStr(CCC->net_node)) {
 611                 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
 612                 CCC->net_node[0] = '\0';
 613         }
 614 }
 615 void network_cleanup_function(void)
 616 {
 617         struct CitContext *CCC = CC;
 618
 619         if (!IsEmptyStr(CCC->net_node)) {
 620                 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
 621                 CCC->net_node[0] = '\0';
 622         }
 623 }
 624
 625
 626 /*
 627  * Module entry point
 628  */
 629
 630 void SetNetQDebugEnabled(const int n)
 631 {
 632         NetQDebugEnabled = n;
 633 }
 634
 635 CTDL_MODULE_INIT(network)
 636 {
 637         if (!threading)
 638         {
 639                 CtdlFillSystemContext(&networker_spool_CC, "CitNetSpool");
 640                 CtdlRegisterDebugFlagHook(HKEY("networkqueue"), SetNetQDebugEnabled, &NetQDebugEnabled);
 641                 CtdlRegisterSessionHook(network_cleanup_function, EVT_STOP, PRIO_STOP + 30);
 642                 CtdlRegisterSessionHook(network_logout_hook, EVT_LOGOUT, PRIO_LOGOUT + 10);
 643                 CtdlRegisterProtoHook(cmd_nsyn, "NSYN", "Synchronize room to node");
 644                 CtdlRegisterRoomHook(network_room_handler);
 645                 CtdlRegisterCleanupHook(destroy_network_queue_room_locked);
 646                 CtdlRegisterSessionHook(network_do_queue, EVT_TIMER, PRIO_QUEUE + 10);
 647         }
 648         return "network";
 649 }