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