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-2011 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 as published by
   9  *  the Free Software Foundation; either version 3 of the License, or
  10  *  (at your option) any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  *  You should have received a copy of the GNU General Public License
  18  *  along with this program; if not, write to the Free Software
  19  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  *
  21  * ** NOTE **   A word on the S_NETCONFIGS semaphore:
  22  * This is a fairly high-level type of critical section.  It ensures that no
  23  * two threads work on the netconfigs files at the same time.  Since we do
  24  * so many things inside these, here are the rules:
  25  *  1. begin_critical_section(S_NETCONFIGS) *before* begin_ any others.
  26  *  2. Do *not* perform any I/O with the client during these sections.
  27  *
  28  */
  29
  30 /*
  31  * Duration of time (in seconds) after which pending list subscribe/unsubscribe
  32  * requests that have not been confirmed will be deleted.
  33  */
  34 #define EXP     259200  /* three days */
  35
  36 #include "sysdep.h"
  37 #include <stdlib.h>
  38 #include <unistd.h>
  39 #include <stdio.h>
  40 #include <fcntl.h>
  41 #include <ctype.h>
  42 #include <signal.h>
  43 #include <pwd.h>
  44 #include <errno.h>
  45 #include <sys/stat.h>
  46 #include <sys/types.h>
  47 #include <dirent.h>
  48 #if TIME_WITH_SYS_TIME
  49 # include <sys/time.h>
  50 # include <time.h>
  51 #else
  52 # if HAVE_SYS_TIME_H
  53 #  include <sys/time.h>
  54 # else
  55 #  include <time.h>
  56 # endif
  57 #endif
  58 #ifdef HAVE_SYSCALL_H
  59 # include <syscall.h>
  60 #else
  61 # if HAVE_SYS_SYSCALL_H
  62 #  include <sys/syscall.h>
  63 # endif
  64 #endif
  65
  66 #include <sys/wait.h>
  67 #include <string.h>
  68 #include <limits.h>
  69 #include <libcitadel.h>
  70 #include "citadel.h"
  71 #include "server.h"
  72 #include "citserver.h"
  73 #include "support.h"
  74 #include "config.h"
  75 #include "user_ops.h"
  76 #include "database.h"
  77 #include "msgbase.h"
  78 #include "internet_addressing.h"
  79 #include "serv_network.h"
  80 #include "clientsocket.h"
  81 #include "file_ops.h"
  82 #include "citadel_dirs.h"
  83 #include "threads.h"
  84
  85 #ifndef HAVE_SNPRINTF
  86 #include "snprintf.h"
  87 #endif
  88
  89 #include "context.h"
  90 #include "netconfig.h"
  91 #include "netspool.h"
  92 #include "netmail.h"
  93 #include "ctdl_module.h"
  94
  95 /* comes from lookup3.c from libcitadel... */
  96 extern uint32_t hashlittle( const void *key, size_t length, uint32_t initval);
  97
  98 typedef struct __roomlists {
  99         RoomProcList *rplist;
 100         HashList *RoomsInterestedIn;
 101 }roomlists;
 102 /*
 103  * When we do network processing, it's accomplished in two passes; one to
 104  * gather a list of rooms and one to actually do them.  It's ok that rplist
 105  * is global; we have a mutex that keeps it safe.
 106  */
 107 struct RoomProcList *rplist = NULL;
 108
 109 int GetNetworkedRoomNumbers(const char *DirName, HashList *DirList)
 110 {
 111         DIR *filedir = NULL;
 112         struct dirent *d;
 113         struct dirent *filedir_entry;
 114         long RoomNR;
 115         long Count = 0;
 116
 117         filedir = opendir (DirName);
 118         if (filedir == NULL) {
 119                 return 0;
 120         }
 121
 122         d = (struct dirent *)malloc(offsetof(struct dirent, d_name) + PATH_MAX + 1);
 123         if (d == NULL) {
 124                 return 0;
 125         }
 126
 127         while ((readdir_r(filedir, d, &filedir_entry) == 0) &&
 128                (filedir_entry != NULL))
 129         {
 130                 RoomNR = atol(filedir_entry->d_name);
 131                 if (RoomNR != 0) {
 132                         Count++;
 133                         Put(DirList, LKEY(RoomNR), &Count, reference_free_handler);
 134                 }
 135         }
 136         free(d);
 137         closedir(filedir);
 138         return Count;
 139 }
 140
 141
 142
 143
 144 /*
 145  * Check the use table.  This is a list of messages which have recently
 146  * arrived on the system.  It is maintained and queried to prevent the same
 147  * message from being entered into the database multiple times if it happens
 148  * to arrive multiple times by accident.
 149  */
 150 int network_usetable(struct CtdlMessage *msg) {
 151
 152         char msgid[SIZ];
 153         struct cdbdata *cdbut;
 154         struct UseTable ut;
 155
 156         /* Bail out if we can't generate a message ID */
 157         if (msg == NULL) {
 158                 return(0);
 159         }
 160         if (msg->cm_fields['I'] == NULL) {
 161                 return(0);
 162         }
 163         if (IsEmptyStr(msg->cm_fields['I'])) {
 164                 return(0);
 165         }
 166
 167         /* Generate the message ID */
 168         strcpy(msgid, msg->cm_fields['I']);
 169         if (haschar(msgid, '@') == 0) {
 170                 strcat(msgid, "@");
 171                 if (msg->cm_fields['N'] != NULL) {
 172                         strcat(msgid, msg->cm_fields['N']);
 173                 }
 174                 else {
 175                         return(0);
 176                 }
 177         }
 178
 179         cdbut = cdb_fetch(CDB_USETABLE, msgid, strlen(msgid));
 180         if (cdbut != NULL) {
 181                 cdb_free(cdbut);
 182                 syslog(LOG_DEBUG, "network_usetable() : we already have %s\n", msgid);
 183                 return(1);
 184         }
 185
 186         /* If we got to this point, it's unique: add it. */
 187         strcpy(ut.ut_msgid, msgid);
 188         ut.ut_timestamp = time(NULL);
 189         cdb_store(CDB_USETABLE, msgid, strlen(msgid), &ut, sizeof(struct UseTable) );
 190         return(0);
 191 }
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202 /*
 203  * Send the *entire* contents of the current room to one specific network node,
 204  * ignoring anything we know about which messages have already undergone
 205  * network processing.  This can be used to bring a new node into sync.
 206  */
 207 int network_sync_to(char *target_node) {
 208         SpoolControl sc;
 209         int num_spooled = 0;
 210         int found_node = 0;
 211         char buf[256];
 212         char sc_type[256];
 213         char sc_node[256];
 214         char sc_room[256];
 215         char filename[PATH_MAX];
 216         FILE *fp;
 217
 218         /* Grab the configuration line we're looking for */
 219         assoc_file_name(filename, sizeof filename, &CC->room, ctdl_netcfg_dir);
 220         begin_critical_section(S_NETCONFIGS);
 221         fp = fopen(filename, "r");
 222         if (fp == NULL) {
 223                 end_critical_section(S_NETCONFIGS);
 224                 return(-1);
 225         }
 226         while (fgets(buf, sizeof buf, fp) != NULL) {
 227                 buf[strlen(buf)-1] = 0;
 228                 extract_token(sc_type, buf, 0, '|', sizeof sc_type);
 229                 extract_token(sc_node, buf, 1, '|', sizeof sc_node);
 230                 extract_token(sc_room, buf, 2, '|', sizeof sc_room);
 231                 if ( (!strcasecmp(sc_type, "ignet_push_share"))
 232                    && (!strcasecmp(sc_node, target_node)) ) {
 233                         found_node = 1;
 234
 235                         /* Concise syntax because we don't need a full linked-list */
 236                         memset(&sc, 0, sizeof(SpoolControl));
 237                         sc.ignet_push_shares = (maplist *)
 238                                 malloc(sizeof(maplist));
 239                         sc.ignet_push_shares->next = NULL;
 240                         safestrncpy(sc.ignet_push_shares->remote_nodename,
 241                                 sc_node,
 242                                 sizeof sc.ignet_push_shares->remote_nodename);
 243                         safestrncpy(sc.ignet_push_shares->remote_roomname,
 244                                 sc_room,
 245                                 sizeof sc.ignet_push_shares->remote_roomname);
 246                 }
 247         }
 248         fclose(fp);
 249         end_critical_section(S_NETCONFIGS);
 250
 251         if (!found_node) return(-1);
 252
 253         /* Send ALL messages */
 254         num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
 255                 network_spool_msg, &sc);
 256
 257         /* Concise cleanup because we know there's only one node in the sc */
 258         free(sc.ignet_push_shares);
 259
 260         syslog(LOG_NOTICE, "Synchronized %d messages to <%s>\n",
 261                 num_spooled, target_node);
 262         return(num_spooled);
 263 }
 264
 265
 266 /*
 267  * Implements the NSYN command
 268  */
 269 void cmd_nsyn(char *argbuf) {
 270         int num_spooled;
 271         char target_node[256];
 272
 273         if (CtdlAccessCheck(ac_aide)) return;
 274
 275         extract_token(target_node, argbuf, 0, '|', sizeof target_node);
 276         num_spooled = network_sync_to(target_node);
 277         if (num_spooled >= 0) {
 278                 cprintf("%d Spooled %d messages.\n", CIT_OK, num_spooled);
 279         }
 280         else {
 281                 cprintf("%d No such room/node share exists.\n",
 282                         ERROR + ROOM_NOT_FOUND);
 283         }
 284 }
 285
 286
 287
 288 /*
 289  * Batch up and send all outbound traffic from the current room
 290  */
 291 void network_queue_interesting_rooms(struct ctdlroom *qrbuf, void *data) {
 292         int i;
 293         struct RoomProcList *ptr;
 294         long QRNum = qrbuf->QRnumber;
 295         void *v;
 296         roomlists *RP = (roomlists*) data;
 297
 298         if (!GetHash(RP->RoomsInterestedIn, LKEY(QRNum), &v))
 299                 return;
 300
 301         ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
 302         if (ptr == NULL) return;
 303
 304         ptr->namelen = strlen(qrbuf->QRname);
 305         if (ptr->namelen > ROOMNAMELEN)
 306                 ptr->namelen = ROOMNAMELEN - 1;
 307
 308         memcpy (ptr->name, qrbuf->QRname, ptr->namelen);
 309         ptr->name[ptr->namelen] = '\0';
 310         ptr->QRNum = qrbuf->QRnumber;
 311
 312         for (i = 0; i < ptr->namelen; i++)
 313         {
 314                 ptr->lcname[i] = tolower(ptr->name[i]);
 315         }
 316
 317         ptr->lcname[ptr->namelen] = '\0';
 318         ptr->key = hashlittle(ptr->lcname, ptr->namelen, 9872345);
 319         ptr->next = RP->rplist;
 320         RP->rplist = ptr;
 321 }
 322
 323 /*
 324  * Batch up and send all outbound traffic from the current room
 325  */
 326 void network_queue_room(struct ctdlroom *qrbuf, void *data) {
 327         int i;
 328         struct RoomProcList *ptr;
 329
 330         if (qrbuf->QRdefaultview == VIEW_QUEUE)
 331                 return;
 332         ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
 333         if (ptr == NULL) return;
 334
 335         ptr->namelen = strlen(qrbuf->QRname);
 336         if (ptr->namelen > ROOMNAMELEN)
 337                 ptr->namelen = ROOMNAMELEN - 1;
 338
 339         memcpy (ptr->name, qrbuf->QRname, ptr->namelen);
 340         ptr->name[ptr->namelen] = '\0';
 341         ptr->QRNum = qrbuf->QRnumber;
 342
 343         for (i = 0; i < ptr->namelen; i++)
 344         {
 345                 ptr->lcname[i] = tolower(ptr->name[i]);
 346         }
 347         ptr->lcname[ptr->namelen] = '\0';
 348         ptr->key = hashlittle(ptr->lcname, ptr->namelen, 9872345);
 349
 350         begin_critical_section(S_RPLIST);
 351         ptr->next = rplist;
 352         rplist = ptr;
 353         end_critical_section(S_RPLIST);
 354 }
 355
 356 void destroy_network_queue_room(RoomProcList *rplist)
 357 {
 358         struct RoomProcList *cur, *p;
 359
 360         cur = rplist;
 361         while (cur != NULL)
 362         {
 363                 p = cur->next;
 364                 free (cur);
 365                 cur = p;
 366         }
 367 }
 368
 369 void destroy_network_queue_room_locked (void)
 370 {
 371         begin_critical_section(S_RPLIST);
 372         destroy_network_queue_room(rplist);
 373         end_critical_section(S_RPLIST);
 374 }
 375
 376
 377
 378 /*
 379  * Bounce a message back to the sender
 380  */
 381 void network_bounce(struct CtdlMessage *msg, char *reason) {
 382         char *oldpath = NULL;
 383         char buf[SIZ];
 384         char bouncesource[SIZ];
 385         char recipient[SIZ];
 386         struct recptypes *valid = NULL;
 387         char force_room[ROOMNAMELEN];
 388         static int serialnum = 0;
 389         size_t size;
 390
 391         syslog(LOG_DEBUG, "entering network_bounce()\n");
 392
 393         if (msg == NULL) return;
 394
 395         snprintf(bouncesource, sizeof bouncesource, "%s@%s", BOUNCESOURCE, config.c_nodename);
 396
 397         /*
 398          * Give it a fresh message ID
 399          */
 400         if (msg->cm_fields['I'] != NULL) {
 401                 free(msg->cm_fields['I']);
 402         }
 403         snprintf(buf, sizeof buf, "%ld.%04lx.%04x@%s",
 404                 (long)time(NULL), (long)getpid(), ++serialnum, config.c_fqdn);
 405         msg->cm_fields['I'] = strdup(buf);
 406
 407         /*
 408          * FIXME ... right now we're just sending a bounce; we really want to
 409          * include the text of the bounced message.
 410          */
 411         if (msg->cm_fields['M'] != NULL) {
 412                 free(msg->cm_fields['M']);
 413         }
 414         msg->cm_fields['M'] = strdup(reason);
 415         msg->cm_format_type = 0;
 416
 417         /*
 418          * Turn the message around
 419          */
 420         if (msg->cm_fields['R'] == NULL) {
 421                 free(msg->cm_fields['R']);
 422         }
 423
 424         if (msg->cm_fields['D'] == NULL) {
 425                 free(msg->cm_fields['D']);
 426         }
 427
 428         snprintf(recipient, sizeof recipient, "%s@%s",
 429                 msg->cm_fields['A'], msg->cm_fields['N']);
 430
 431         if (msg->cm_fields['A'] == NULL) {
 432                 free(msg->cm_fields['A']);
 433         }
 434
 435         if (msg->cm_fields['N'] == NULL) {
 436                 free(msg->cm_fields['N']);
 437         }
 438
 439         if (msg->cm_fields['U'] == NULL) {
 440                 free(msg->cm_fields['U']);
 441         }
 442
 443         msg->cm_fields['A'] = strdup(BOUNCESOURCE);
 444         msg->cm_fields['N'] = strdup(config.c_nodename);
 445         msg->cm_fields['U'] = strdup("Delivery Status Notification (Failure)");
 446
 447         /* prepend our node to the path */
 448         if (msg->cm_fields['P'] != NULL) {
 449                 oldpath = msg->cm_fields['P'];
 450                 msg->cm_fields['P'] = NULL;
 451         }
 452         else {
 453                 oldpath = strdup("unknown_user");
 454         }
 455         size = strlen(oldpath) + SIZ;
 456         msg->cm_fields['P'] = malloc(size);
 457         snprintf(msg->cm_fields['P'], size, "%s!%s", config.c_nodename, oldpath);
 458         free(oldpath);
 459
 460         /* Now submit the message */
 461         valid = validate_recipients(recipient, NULL, 0);
 462         if (valid != NULL) if (valid->num_error != 0) {
 463                 free_recipients(valid);
 464                 valid = NULL;
 465         }
 466         if ( (valid == NULL) || (!strcasecmp(recipient, bouncesource)) ) {
 467                 strcpy(force_room, config.c_aideroom);
 468         }
 469         else {
 470                 strcpy(force_room, "");
 471         }
 472         if ( (valid == NULL) && IsEmptyStr(force_room) ) {
 473                 strcpy(force_room, config.c_aideroom);
 474         }
 475         CtdlSubmitMsg(msg, valid, force_room, 0);
 476
 477         /* Clean up */
 478         if (valid != NULL) free_recipients(valid);
 479         CtdlFreeMessage(msg);
 480         syslog(LOG_DEBUG, "leaving network_bounce()\n");
 481 }
 482
 483
 484
 485
 486
 487
 488
 489 /*
 490  * network_do_queue()
 491  *
 492  * Run through the rooms doing various types of network stuff.
 493  */
 494 void network_do_queue(void) {
 495         static int doing_queue = 0;
 496         static time_t last_run = 0L;
 497         int full_processing = 1;
 498         char *working_ignetcfg;
 499         NetMap *the_netmap = NULL;
 500         int netmap_changed = 0;
 501         roomlists RL;
 502
 503         /*
 504          * Run the full set of processing tasks no more frequently
 505          * than once every n seconds
 506          */
 507         if ( (time(NULL) - last_run) < config.c_net_freq ) {
 508                 full_processing = 0;
 509                 syslog(LOG_DEBUG, "Network full processing in %ld seconds.\n",
 510                         config.c_net_freq - (time(NULL)- last_run)
 511                 );
 512         }
 513
 514         /*
 515          * This is a simple concurrency check to make sure only one queue run
 516          * is done at a time.  We could do this with a mutex, but since we
 517          * don't really require extremely fine granularity here, we'll do it
 518          * with a static variable instead.
 519          */
 520         if (doing_queue) {
 521                 return;
 522         }
 523         doing_queue = 1;
 524
 525         begin_critical_section(S_RPLIST);
 526         RL.rplist = rplist;
 527         rplist = NULL;
 528         end_critical_section(S_RPLIST);
 529
 530         RL.RoomsInterestedIn = NewHash(1, lFlathash);
 531         if (full_processing &&
 532             (GetNetworkedRoomNumbers(ctdl_netcfg_dir, RL.RoomsInterestedIn)==0))
 533         {
 534                 doing_queue = 0;
 535                 DeleteHash(&RL.RoomsInterestedIn);
 536                 if (RL.rplist == NULL)
 537                         return;
 538         }
 539         /* Load the IGnet Configuration into memory */
 540         working_ignetcfg = load_working_ignetcfg();
 541
 542         /*
 543          * Load the network map and filter list into memory.
 544          */
 545         if (!server_shutting_down)
 546                 the_netmap = read_network_map();
 547         if (!server_shutting_down)
 548                 load_network_filter_list();
 549
 550         /*
 551          * Go ahead and run the queue
 552          */
 553         if (full_processing && !server_shutting_down) {
 554                 syslog(LOG_DEBUG, "network: loading outbound queue\n");
 555                 CtdlForEachRoom(network_queue_interesting_rooms, &RL);
 556         }
 557
 558         if ((RL.rplist != NULL) && (!server_shutting_down)) {
 559                 RoomProcList *ptr, *cmp;
 560                 ptr = RL.rplist;
 561                 syslog(LOG_DEBUG, "network: running outbound queue\n");
 562                 while (ptr != NULL && !server_shutting_down) {
 563
 564                         cmp = ptr->next;
 565
 566                         while (cmp != NULL) {
 567                                 if ((cmp->namelen > 0) &&
 568                                     (cmp->key == ptr->key) &&
 569                                     (cmp->namelen == ptr->namelen) &&
 570                                     (strcmp(cmp->lcname, ptr->lcname) == 0))
 571                                 {
 572                                         cmp->namelen = 0;
 573                                 }
 574                                 cmp = cmp->next;
 575                         }
 576
 577                         if (ptr->namelen > 0) {
 578                                 network_spoolout_room(ptr,
 579                                                       working_ignetcfg,
 580                                                       the_netmap);
 581                         }
 582                         ptr = ptr->next;
 583                 }
 584         }
 585
 586         /* If there is anything in the inbound queue, process it */
 587         if (!server_shutting_down) {
 588                 network_do_spoolin(working_ignetcfg,
 589                                    &the_netmap,
 590                                    &netmap_changed);
 591         }
 592
 593         /* Save the network map back to disk */
 594         write_network_map(the_netmap, netmap_changed);
 595
 596         /* Free the filter list in memory */
 597         free_netfilter_list();
 598
 599         network_consolidate_spoolout(working_ignetcfg, the_netmap);
 600         free(working_ignetcfg);
 601
 602         syslog(LOG_DEBUG, "network: queue run completed\n");
 603
 604         if (full_processing) {
 605                 last_run = time(NULL);
 606         }
 607         DeleteHash(&RL.RoomsInterestedIn);
 608         destroy_network_queue_room(RL.rplist);
 609         doing_queue = 0;
 610 }
 611
 612
 613
 614
 615 int network_room_handler (struct ctdlroom *room)
 616 {
 617         network_queue_room(room, NULL);
 618         return 0;
 619 }
 620
 621
 622 /*
 623  * Module entry point
 624  */
 625 CTDL_MODULE_INIT(network)
 626 {
 627         if (!threading)
 628         {
 629                 CtdlRegisterProtoHook(cmd_nsyn, "NSYN", "Synchronize room to node");
 630                 CtdlRegisterRoomHook(network_room_handler);
 631                 CtdlRegisterCleanupHook(destroy_network_queue_room_locked);
 632                 CtdlRegisterSessionHook(network_do_queue, EVT_TIMER);
 633         }
 634         return "network";
 635 }