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         /* Send ALL messages */
 198         num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
 199                 network_spool_msg, &sc);
 200
 201         /* Concise cleanup because we know there's only one node in the sc */
 202         DeleteGenericCfgLine(NULL/*TODO*/, &sc.RNCfg->NetConfigs[ignet_push_share]);
 203
 204         DeleteHash(&sc.working_ignetcfg);
 205         DeleteHash(&sc.the_netmap);
 206
 207         QN_syslog(LOG_NOTICE, "Synchronized %d messages to <%s>\n",
 208                   num_spooled, target_node);
 209         return(num_spooled);
 210 }
 211
 212
 213 /*
 214  * Implements the NSYN command
 215  */
 216 void cmd_nsyn(char *argbuf) {
 217         int num_spooled;
 218         long len;
 219         char target_node[256];
 220
 221         if (CtdlAccessCheck(ac_aide)) return;
 222
 223         len = extract_token(target_node, argbuf, 0, '|', sizeof target_node);
 224         num_spooled = network_sync_to(target_node, len);
 225         if (num_spooled >= 0) {
 226                 cprintf("%d Spooled %d messages.\n", CIT_OK, num_spooled);
 227         }
 228         else {
 229                 cprintf("%d No such room/node share exists.\n",
 230                         ERROR + ROOM_NOT_FOUND);
 231         }
 232 }
 233
 234 RoomProcList *CreateRoomProcListEntry(struct ctdlroom *qrbuf, OneRoomNetCfg *OneRNCFG)
 235 {
 236         int i;
 237         struct RoomProcList *ptr;
 238
 239         ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
 240         if (ptr == NULL) return NULL;
 241
 242         ptr->namelen = strlen(qrbuf->QRname);
 243         if (ptr->namelen > ROOMNAMELEN)
 244                 ptr->namelen = ROOMNAMELEN - 1;
 245
 246         memcpy (ptr->name, qrbuf->QRname, ptr->namelen);
 247         ptr->name[ptr->namelen] = '\0';
 248         ptr->QRNum = qrbuf->QRnumber;
 249
 250         for (i = 0; i < ptr->namelen; i++)
 251         {
 252                 ptr->lcname[i] = tolower(ptr->name[i]);
 253         }
 254
 255         ptr->lcname[ptr->namelen] = '\0';
 256         ptr->key = hashlittle(ptr->lcname, ptr->namelen, 9872345);
 257         ptr->lastsent = OneRNCFG->lastsent;
 258         ptr->OneRNCfg = OneRNCFG;
 259         return ptr;
 260 }
 261
 262 /*
 263  * Batch up and send all outbound traffic from the current room
 264  */
 265 void network_queue_interesting_rooms(struct ctdlroom *qrbuf, void *data, OneRoomNetCfg *OneRNCfg)
 266 {
 267         struct RoomProcList *ptr;
 268         roomlists *RP = (roomlists*) data;
 269
 270         if (!HaveSpoolConfig(OneRNCfg))
 271                 return;
 272
 273         ptr = CreateRoomProcListEntry(qrbuf, OneRNCfg);
 274
 275         if (ptr != NULL)
 276         {
 277                 ptr->next = RP->rplist;
 278                 RP->rplist = ptr;
 279         }
 280 }
 281
 282 /*
 283  * Batch up and send all outbound traffic from the current room
 284  */
 285 int network_room_handler (struct ctdlroom *qrbuf)
 286 {
 287         struct RoomProcList *ptr;
 288         OneRoomNetCfg* RNCfg;
 289
 290         if (qrbuf->QRdefaultview == VIEW_QUEUE)
 291                 return 1;
 292
 293         RNCfg = CtdlGetNetCfgForRoom(qrbuf->QRnumber);
 294         if (RNCfg == NULL)
 295                 return 1;
 296
 297         if (!HaveSpoolConfig(RNCfg))
 298                 return 1;
 299
 300         ptr = CreateRoomProcListEntry(qrbuf, RNCfg);
 301         if (ptr == NULL)
 302                 return 1;
 303
 304         ptr->OneRNCfg = NULL;
 305         begin_critical_section(S_RPLIST);
 306         ptr->next = rplist;
 307         rplist = ptr;
 308         end_critical_section(S_RPLIST);
 309         return 1;
 310 }
 311
 312 void destroy_network_queue_room(RoomProcList *rplist)
 313 {
 314         struct RoomProcList *cur, *p;
 315
 316         cur = rplist;
 317         while (cur != NULL)
 318         {
 319                 p = cur->next;
 320                 free (cur);
 321                 cur = p;
 322         }
 323 }
 324
 325 void destroy_network_queue_room_locked (void)
 326 {
 327         begin_critical_section(S_RPLIST);
 328         destroy_network_queue_room(rplist);
 329         end_critical_section(S_RPLIST);
 330 }
 331
 332
 333
 334 /*
 335  * Bounce a message back to the sender
 336  */
 337 void network_bounce(struct CtdlMessage *msg, char *reason)
 338 {
 339         struct CitContext *CCC = CC;
 340         char *oldpath = NULL;
 341         char buf[SIZ];
 342         char bouncesource[SIZ];
 343         char recipient[SIZ];
 344         struct recptypes *valid = NULL;
 345         char force_room[ROOMNAMELEN];
 346         static int serialnum = 0;
 347         size_t size;
 348
 349         QNM_syslog(LOG_DEBUG, "entering network_bounce()\n");
 350
 351         if (msg == NULL) return;
 352
 353         snprintf(bouncesource, sizeof bouncesource, "%s@%s", BOUNCESOURCE, config.c_nodename);
 354
 355         /*
 356          * Give it a fresh message ID
 357          */
 358         if (msg->cm_fields['I'] != NULL) {
 359                 free(msg->cm_fields['I']);
 360         }
 361         snprintf(buf, sizeof buf, "%ld.%04lx.%04x@%s",
 362                 (long)time(NULL), (long)getpid(), ++serialnum, config.c_fqdn);
 363         msg->cm_fields['I'] = strdup(buf);
 364
 365         /*
 366          * FIXME ... right now we're just sending a bounce; we really want to
 367          * include the text of the bounced message.
 368          */
 369         if (msg->cm_fields['M'] != NULL) {
 370                 free(msg->cm_fields['M']);
 371         }
 372         msg->cm_fields['M'] = strdup(reason);
 373         msg->cm_format_type = 0;
 374
 375         /*
 376          * Turn the message around
 377          */
 378         if (msg->cm_fields['R'] == NULL) {
 379                 free(msg->cm_fields['R']);
 380         }
 381
 382         if (msg->cm_fields['D'] == NULL) {
 383                 free(msg->cm_fields['D']);
 384         }
 385
 386         snprintf(recipient, sizeof recipient, "%s@%s",
 387                 msg->cm_fields['A'], msg->cm_fields['N']);
 388
 389         if (msg->cm_fields['A'] == NULL) {
 390                 free(msg->cm_fields['A']);
 391         }
 392
 393         if (msg->cm_fields['N'] == NULL) {
 394                 free(msg->cm_fields['N']);
 395         }
 396
 397         if (msg->cm_fields['U'] == NULL) {
 398                 free(msg->cm_fields['U']);
 399         }
 400
 401         msg->cm_fields['A'] = strdup(BOUNCESOURCE);
 402         msg->cm_fields['N'] = strdup(config.c_nodename);
 403         msg->cm_fields['U'] = strdup("Delivery Status Notification (Failure)");
 404
 405         /* prepend our node to the path */
 406         if (msg->cm_fields['P'] != NULL) {
 407                 oldpath = msg->cm_fields['P'];
 408                 msg->cm_fields['P'] = NULL;
 409         }
 410         else {
 411                 oldpath = strdup("unknown_user");
 412         }
 413         size = strlen(oldpath) + SIZ;
 414         msg->cm_fields['P'] = malloc(size);
 415         snprintf(msg->cm_fields['P'], size, "%s!%s", config.c_nodename, oldpath);
 416         free(oldpath);
 417
 418         /* Now submit the message */
 419         valid = validate_recipients(recipient, NULL, 0);
 420         if (valid != NULL) if (valid->num_error != 0) {
 421                 free_recipients(valid);
 422                 valid = NULL;
 423         }
 424         if ( (valid == NULL) || (!strcasecmp(recipient, bouncesource)) ) {
 425                 strcpy(force_room, config.c_aideroom);
 426         }
 427         else {
 428                 strcpy(force_room, "");
 429         }
 430         if ( (valid == NULL) && IsEmptyStr(force_room) ) {
 431                 strcpy(force_room, config.c_aideroom);
 432         }
 433         CtdlSubmitMsg(msg, valid, force_room, 0);
 434
 435         /* Clean up */
 436         if (valid != NULL) free_recipients(valid);
 437         CtdlFreeMessage(msg);
 438         QNM_syslog(LOG_DEBUG, "leaving network_bounce()\n");
 439 }
 440
 441
 442 void free_network_spoolout_room(SpoolControl *sc)
 443 {
 444         if (sc != NULL)
 445         {
 446                 int i;
 447                 for (i = subpending; i < maxRoomNetCfg; i++)
 448                         FreeStrBuf(&sc->Users[i]);
 449                 free(sc);
 450         }
 451 }
 452
 453
 454
 455
 456 /*
 457  * network_do_queue()
 458  *
 459  * Run through the rooms doing various types of network stuff.
 460  */
 461 void network_do_queue(void)
 462 {
 463         struct CitContext *CCC = CC;
 464         static time_t last_run = 0L;
 465         int full_processing = 1;
 466         HashList *working_ignetcfg;
 467         HashList *the_netmap = NULL;
 468         int netmap_changed = 0;
 469         roomlists RL;
 470         SpoolControl *sc = NULL;
 471         SpoolControl *pSC;
 472
 473         /*
 474          * Run the full set of processing tasks no more frequently
 475          * than once every n seconds
 476          */
 477         if ( (time(NULL) - last_run) < config.c_net_freq ) {
 478                 full_processing = 0;
 479                 syslog(LOG_DEBUG, "Network full processing in %ld seconds.\n",
 480                        config.c_net_freq - (time(NULL)- last_run)
 481                 );
 482         }
 483
 484         become_session(&networker_spool_CC);
 485         begin_critical_section(S_RPLIST);
 486         RL.rplist = rplist;
 487         rplist = NULL;
 488         end_critical_section(S_RPLIST);
 489 ///TODO hm, check whether we have a config at all here?
 490         /* Load the IGnet Configuration into memory */
 491         working_ignetcfg = CtdlLoadIgNetCfg();
 492
 493         /*
 494          * Load the network map and filter list into memory.
 495          */
 496         if (!server_shutting_down)
 497                 the_netmap = CtdlReadNetworkMap();
 498 #if 0
 499         /* filterlist isn't supported anymore
 500         if (!server_shutting_down)
 501                 load_network_filter_list();
 502         */
 503 #endif
 504
 505         /*
 506          * Go ahead and run the queue
 507          */
 508         if (full_processing && !server_shutting_down) {
 509                 QNM_syslog(LOG_DEBUG, "network: loading outbound queue");
 510                 CtdlForEachNetCfgRoom(network_queue_interesting_rooms, &RL, maxRoomNetCfg);
 511         }
 512
 513         if ((RL.rplist != NULL) && (!server_shutting_down)) {
 514                 RoomProcList *ptr, *cmp;
 515                 ptr = RL.rplist;
 516                 QNM_syslog(LOG_DEBUG, "network: running outbound queue");
 517                 while (ptr != NULL && !server_shutting_down) {
 518
 519                         cmp = ptr->next;
 520                         /* filter duplicates from the list... */
 521                         while (cmp != NULL) {
 522                                 if ((cmp->namelen > 0) &&
 523                                     (cmp->key == ptr->key) &&
 524                                     (cmp->namelen == ptr->namelen) &&
 525                                     (strcmp(cmp->lcname, ptr->lcname) == 0))
 526                                 {
 527                                         cmp->namelen = 0;
 528                                 }
 529                                 cmp = cmp->next;
 530                         }
 531
 532                         if (ptr->namelen > 0) {
 533                                 InspectQueuedRoom(&sc,
 534                                                   ptr,
 535                                                   working_ignetcfg,
 536                                                   the_netmap);
 537                         }
 538                         ptr = ptr->next;
 539                 }
 540         }
 541
 542
 543         pSC = sc;
 544         while (pSC != NULL)
 545         {
 546                 network_spoolout_room(pSC);
 547                 pSC = pSC->next;
 548         }
 549
 550         pSC = sc;
 551         while (pSC != NULL)
 552         {
 553                 sc = pSC->next;
 554                 free_network_spoolout_room(pSC);
 555                 pSC = sc;
 556         }
 557         /* If there is anything in the inbound queue, process it */
 558         if (!server_shutting_down) {
 559                 network_do_spoolin(working_ignetcfg,
 560                                    the_netmap,
 561                                    &netmap_changed);
 562         }
 563
 564         /* Free the filter list in memory */
 565         free_netfilter_list();
 566
 567         /* Save the network map back to disk */
 568         if (netmap_changed) {
 569                 StrBuf *MapStr = CtdlSerializeNetworkMap(the_netmap);
 570                 char *pMapStr = SmashStrBuf(&MapStr);
 571                 CtdlPutSysConfig(IGNETMAP, pMapStr);
 572                 free(pMapStr);
 573         }
 574
 575         /* combine singe message files into one spool entry per remote node. */
 576         network_consolidate_spoolout(working_ignetcfg, the_netmap);
 577
 578         /* shut down. */
 579
 580         DeleteHash(&the_netmap);
 581
 582         DeleteHash(&working_ignetcfg);
 583
 584         QNM_syslog(LOG_DEBUG, "network: queue run completed");
 585
 586         if (full_processing) {
 587                 last_run = time(NULL);
 588         }
 589         destroy_network_queue_room(RL.rplist);
 590         SaveChangedConfigs();
 591
 592 }
 593
 594
 595
 596
 597
 598
 599
 600
 601 void network_logout_hook(void)
 602 {
 603         CitContext *CCC = MyContext();
 604
 605         /*
 606          * If we were talking to a network node, we're not anymore...
 607          */
 608         if (!IsEmptyStr(CCC->net_node)) {
 609                 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
 610                 CCC->net_node[0] = '\0';
 611         }
 612 }
 613 void network_cleanup_function(void)
 614 {
 615         struct CitContext *CCC = CC;
 616
 617         if (!IsEmptyStr(CCC->net_node)) {
 618                 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
 619                 CCC->net_node[0] = '\0';
 620         }
 621 }
 622
 623
 624 /*
 625  * Module entry point
 626  */
 627
 628 void SetNetQDebugEnabled(const int n)
 629 {
 630         NetQDebugEnabled = n;
 631 }
 632
 633 CTDL_MODULE_INIT(network)
 634 {
 635         if (!threading)
 636         {
 637                 CtdlFillSystemContext(&networker_spool_CC, "CitNetSpool");
 638                 CtdlRegisterDebugFlagHook(HKEY("networkqueue"), SetNetQDebugEnabled, &NetQDebugEnabled);
 639                 CtdlRegisterSessionHook(network_cleanup_function, EVT_STOP, PRIO_STOP + 30);
 640                 CtdlRegisterSessionHook(network_logout_hook, EVT_LOGOUT, PRIO_LOGOUT + 10);
 641                 CtdlRegisterProtoHook(cmd_nsyn, "NSYN", "Synchronize room to node");
 642                 CtdlRegisterRoomHook(network_room_handler);
 643                 CtdlRegisterCleanupHook(destroy_network_queue_room_locked);
 644                 CtdlRegisterSessionHook(network_do_queue, EVT_TIMER, PRIO_QUEUE + 10);
 645         }
 646         return "network";
 647 }