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
  96
  97 /*
  98  * When we do network processing, it's accomplished in two passes; one to
  99  * gather a list of rooms and one to actually do them.  It's ok that rplist
 100  * is global; we have a mutex that keeps it safe.
 101  */
 102 struct RoomProcList *rplist = NULL;
 103
 104
 105
 106
 107
 108
 109 /*
 110  * Check the use table.  This is a list of messages which have recently
 111  * arrived on the system.  It is maintained and queried to prevent the same
 112  * message from being entered into the database multiple times if it happens
 113  * to arrive multiple times by accident.
 114  */
 115 int network_usetable(struct CtdlMessage *msg) {
 116
 117         char msgid[SIZ];
 118         struct cdbdata *cdbut;
 119         struct UseTable ut;
 120
 121         /* Bail out if we can't generate a message ID */
 122         if (msg == NULL) {
 123                 return(0);
 124         }
 125         if (msg->cm_fields['I'] == NULL) {
 126                 return(0);
 127         }
 128         if (IsEmptyStr(msg->cm_fields['I'])) {
 129                 return(0);
 130         }
 131
 132         /* Generate the message ID */
 133         strcpy(msgid, msg->cm_fields['I']);
 134         if (haschar(msgid, '@') == 0) {
 135                 strcat(msgid, "@");
 136                 if (msg->cm_fields['N'] != NULL) {
 137                         strcat(msgid, msg->cm_fields['N']);
 138                 }
 139                 else {
 140                         return(0);
 141                 }
 142         }
 143
 144         cdbut = cdb_fetch(CDB_USETABLE, msgid, strlen(msgid));
 145         if (cdbut != NULL) {
 146                 cdb_free(cdbut);
 147                 syslog(LOG_DEBUG, "network_usetable() : we already have %s\n", msgid);
 148                 return(1);
 149         }
 150
 151         /* If we got to this point, it's unique: add it. */
 152         strcpy(ut.ut_msgid, msgid);
 153         ut.ut_timestamp = time(NULL);
 154         cdb_store(CDB_USETABLE, msgid, strlen(msgid), &ut, sizeof(struct UseTable) );
 155         return(0);
 156 }
 157
 158
 159 /*
 160  * Send the *entire* contents of the current room to one specific network node,
 161  * ignoring anything we know about which messages have already undergone
 162  * network processing.  This can be used to bring a new node into sync.
 163  */
 164 int network_sync_to(char *target_node) {
 165         SpoolControl sc;
 166         int num_spooled = 0;
 167         int found_node = 0;
 168         char buf[256];
 169         char sc_type[256];
 170         char sc_node[256];
 171         char sc_room[256];
 172         char filename[PATH_MAX];
 173         FILE *fp;
 174
 175         /* Grab the configuration line we're looking for */
 176         assoc_file_name(filename, sizeof filename, &CC->room, ctdl_netcfg_dir);
 177         begin_critical_section(S_NETCONFIGS);
 178         fp = fopen(filename, "r");
 179         if (fp == NULL) {
 180                 end_critical_section(S_NETCONFIGS);
 181                 return(-1);
 182         }
 183         while (fgets(buf, sizeof buf, fp) != NULL) {
 184                 buf[strlen(buf)-1] = 0;
 185                 extract_token(sc_type, buf, 0, '|', sizeof sc_type);
 186                 extract_token(sc_node, buf, 1, '|', sizeof sc_node);
 187                 extract_token(sc_room, buf, 2, '|', sizeof sc_room);
 188                 if ( (!strcasecmp(sc_type, "ignet_push_share"))
 189                    && (!strcasecmp(sc_node, target_node)) ) {
 190                         found_node = 1;
 191
 192                         /* Concise syntax because we don't need a full linked-list */
 193                         memset(&sc, 0, sizeof(SpoolControl));
 194                         sc.ignet_push_shares = (maplist *)
 195                                 malloc(sizeof(maplist));
 196                         sc.ignet_push_shares->next = NULL;
 197                         safestrncpy(sc.ignet_push_shares->remote_nodename,
 198                                 sc_node,
 199                                 sizeof sc.ignet_push_shares->remote_nodename);
 200                         safestrncpy(sc.ignet_push_shares->remote_roomname,
 201                                 sc_room,
 202                                 sizeof sc.ignet_push_shares->remote_roomname);
 203                 }
 204         }
 205         fclose(fp);
 206         end_critical_section(S_NETCONFIGS);
 207
 208         if (!found_node) return(-1);
 209
 210         /* Send ALL messages */
 211         num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
 212                 network_spool_msg, &sc);
 213
 214         /* Concise cleanup because we know there's only one node in the sc */
 215         free(sc.ignet_push_shares);
 216
 217         syslog(LOG_NOTICE, "Synchronized %d messages to <%s>\n",
 218                 num_spooled, target_node);
 219         return(num_spooled);
 220 }
 221
 222
 223 /*
 224  * Implements the NSYN command
 225  */
 226 void cmd_nsyn(char *argbuf) {
 227         int num_spooled;
 228         char target_node[256];
 229
 230         if (CtdlAccessCheck(ac_aide)) return;
 231
 232         extract_token(target_node, argbuf, 0, '|', sizeof target_node);
 233         num_spooled = network_sync_to(target_node);
 234         if (num_spooled >= 0) {
 235                 cprintf("%d Spooled %d messages.\n", CIT_OK, num_spooled);
 236         }
 237         else {
 238                 cprintf("%d No such room/node share exists.\n",
 239                         ERROR + ROOM_NOT_FOUND);
 240         }
 241 }
 242
 243
 244
 245 /*
 246  * Batch up and send all outbound traffic from the current room
 247  */
 248 void network_queue_room(struct ctdlroom *qrbuf, void *data) {
 249         struct RoomProcList *ptr;
 250
 251         ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
 252         if (ptr == NULL) return;
 253
 254         safestrncpy(ptr->name, qrbuf->QRname, sizeof ptr->name);
 255         begin_critical_section(S_RPLIST);
 256         ptr->next = rplist;
 257         rplist = ptr;
 258         end_critical_section(S_RPLIST);
 259 }
 260
 261 void destroy_network_queue_room(void)
 262 {
 263         struct RoomProcList *cur, *p;
 264
 265         cur = rplist;
 266         begin_critical_section(S_RPLIST);
 267         while (cur != NULL)
 268         {
 269                 p = cur->next;
 270                 free (cur);
 271                 cur = p;
 272         }
 273         rplist = NULL;
 274         end_critical_section(S_RPLIST);
 275 }
 276
 277
 278
 279
 280
 281 /*
 282  * Bounce a message back to the sender
 283  */
 284 void network_bounce(struct CtdlMessage *msg, char *reason) {
 285         char *oldpath = NULL;
 286         char buf[SIZ];
 287         char bouncesource[SIZ];
 288         char recipient[SIZ];
 289         struct recptypes *valid = NULL;
 290         char force_room[ROOMNAMELEN];
 291         static int serialnum = 0;
 292         size_t size;
 293
 294         syslog(LOG_DEBUG, "entering network_bounce()\n");
 295
 296         if (msg == NULL) return;
 297
 298         snprintf(bouncesource, sizeof bouncesource, "%s@%s", BOUNCESOURCE, config.c_nodename);
 299
 300         /*
 301          * Give it a fresh message ID
 302          */
 303         if (msg->cm_fields['I'] != NULL) {
 304                 free(msg->cm_fields['I']);
 305         }
 306         snprintf(buf, sizeof buf, "%ld.%04lx.%04x@%s",
 307                 (long)time(NULL), (long)getpid(), ++serialnum, config.c_fqdn);
 308         msg->cm_fields['I'] = strdup(buf);
 309
 310         /*
 311          * FIXME ... right now we're just sending a bounce; we really want to
 312          * include the text of the bounced message.
 313          */
 314         if (msg->cm_fields['M'] != NULL) {
 315                 free(msg->cm_fields['M']);
 316         }
 317         msg->cm_fields['M'] = strdup(reason);
 318         msg->cm_format_type = 0;
 319
 320         /*
 321          * Turn the message around
 322          */
 323         if (msg->cm_fields['R'] == NULL) {
 324                 free(msg->cm_fields['R']);
 325         }
 326
 327         if (msg->cm_fields['D'] == NULL) {
 328                 free(msg->cm_fields['D']);
 329         }
 330
 331         snprintf(recipient, sizeof recipient, "%s@%s",
 332                 msg->cm_fields['A'], msg->cm_fields['N']);
 333
 334         if (msg->cm_fields['A'] == NULL) {
 335                 free(msg->cm_fields['A']);
 336         }
 337
 338         if (msg->cm_fields['N'] == NULL) {
 339                 free(msg->cm_fields['N']);
 340         }
 341
 342         if (msg->cm_fields['U'] == NULL) {
 343                 free(msg->cm_fields['U']);
 344         }
 345
 346         msg->cm_fields['A'] = strdup(BOUNCESOURCE);
 347         msg->cm_fields['N'] = strdup(config.c_nodename);
 348         msg->cm_fields['U'] = strdup("Delivery Status Notification (Failure)");
 349
 350         /* prepend our node to the path */
 351         if (msg->cm_fields['P'] != NULL) {
 352                 oldpath = msg->cm_fields['P'];
 353                 msg->cm_fields['P'] = NULL;
 354         }
 355         else {
 356                 oldpath = strdup("unknown_user");
 357         }
 358         size = strlen(oldpath) + SIZ;
 359         msg->cm_fields['P'] = malloc(size);
 360         snprintf(msg->cm_fields['P'], size, "%s!%s", config.c_nodename, oldpath);
 361         free(oldpath);
 362
 363         /* Now submit the message */
 364         valid = validate_recipients(recipient, NULL, 0);
 365         if (valid != NULL) if (valid->num_error != 0) {
 366                 free_recipients(valid);
 367                 valid = NULL;
 368         }
 369         if ( (valid == NULL) || (!strcasecmp(recipient, bouncesource)) ) {
 370                 strcpy(force_room, config.c_aideroom);
 371         }
 372         else {
 373                 strcpy(force_room, "");
 374         }
 375         if ( (valid == NULL) && IsEmptyStr(force_room) ) {
 376                 strcpy(force_room, config.c_aideroom);
 377         }
 378         CtdlSubmitMsg(msg, valid, force_room, 0);
 379
 380         /* Clean up */
 381         if (valid != NULL) free_recipients(valid);
 382         CtdlFreeMessage(msg);
 383         syslog(LOG_DEBUG, "leaving network_bounce()\n");
 384 }
 385
 386
 387 /*
 388  * network_do_queue()
 389  *
 390  * Run through the rooms doing various types of network stuff.
 391  */
 392 void network_do_queue(void) {
 393         static int doing_queue = 0;
 394         static time_t last_run = 0L;
 395         struct RoomProcList *ptr;
 396         int full_processing = 1;
 397         char *working_ignetcfg;
 398         NetMap *the_netmap = NULL;
 399         int netmap_changed = 0;
 400
 401         /*
 402          * Run the full set of processing tasks no more frequently
 403          * than once every n seconds
 404          */
 405         if ( (time(NULL) - last_run) < config.c_net_freq ) {
 406                 full_processing = 0;
 407                 syslog(LOG_DEBUG, "Network full processing in %ld seconds.\n",
 408                         config.c_net_freq - (time(NULL)- last_run)
 409                 );
 410         }
 411
 412         /*
 413          * This is a simple concurrency check to make sure only one queue run
 414          * is done at a time.  We could do this with a mutex, but since we
 415          * don't really require extremely fine granularity here, we'll do it
 416          * with a static variable instead.
 417          */
 418         if (doing_queue) {
 419                 return;
 420         }
 421         doing_queue = 1;
 422
 423         /* Load the IGnet Configuration into memory */
 424         working_ignetcfg = load_working_ignetcfg();
 425
 426         /*
 427          * Load the network map and filter list into memory.
 428          */
 429         the_netmap = read_network_map();
 430         load_network_filter_list();
 431
 432         /*
 433          * Go ahead and run the queue
 434          */
 435         if (full_processing && !server_shutting_down) {
 436                 syslog(LOG_DEBUG, "network: loading outbound queue\n");
 437                 CtdlForEachRoom(network_queue_room, NULL);
 438         }
 439
 440         if (rplist != NULL) {
 441                 syslog(LOG_DEBUG, "network: running outbound queue\n");
 442                 while (rplist != NULL && !server_shutting_down) {
 443                         char spoolroomname[ROOMNAMELEN];
 444                         safestrncpy(spoolroomname, rplist->name, sizeof spoolroomname);
 445                         begin_critical_section(S_RPLIST);
 446
 447                         /* pop this record off the list */
 448                         ptr = rplist;
 449                         rplist = rplist->next;
 450                         free(ptr);
 451
 452                         /* invalidate any duplicate entries to prevent double processing */
 453                         for (ptr=rplist; ptr!=NULL; ptr=ptr->next) {
 454                                 if (!strcasecmp(ptr->name, spoolroomname)) {
 455                                         ptr->name[0] = 0;
 456                                 }
 457                         }
 458
 459                         end_critical_section(S_RPLIST);
 460                         if (spoolroomname[0] != 0) {
 461                                 network_spoolout_room(spoolroomname,
 462                                                       working_ignetcfg,
 463                                                       the_netmap);
 464                         }
 465                 }
 466         }
 467
 468         /* If there is anything in the inbound queue, process it */
 469         if (!server_shutting_down) {
 470                 network_do_spoolin(working_ignetcfg,
 471                                    the_netmap,
 472                                    &netmap_changed);
 473         }
 474
 475         /* Save the network map back to disk */
 476         write_network_map(the_netmap, netmap_changed);
 477
 478         /* Free the filter list in memory */
 479         free_netfilter_list();
 480
 481         network_consolidate_spoolout(working_ignetcfg, the_netmap);
 482         free(working_ignetcfg);
 483
 484         syslog(LOG_DEBUG, "network: queue run completed\n");
 485
 486         if (full_processing) {
 487                 last_run = time(NULL);
 488         }
 489
 490         doing_queue = 0;
 491 }
 492
 493
 494
 495
 496 int network_room_handler (struct ctdlroom *room)
 497 {
 498         network_queue_room(room, NULL);
 499         return 0;
 500 }
 501
 502
 503 /*
 504  * Module entry point
 505  */
 506 CTDL_MODULE_INIT(network)
 507 {
 508         if (!threading)
 509         {
 510                 CtdlRegisterProtoHook(cmd_nsyn, "NSYN", "Synchronize room to node");
 511                 CtdlRegisterRoomHook(network_room_handler);
 512                 CtdlRegisterCleanupHook(destroy_network_queue_room);
 513                 CtdlRegisterSessionHook(network_do_queue, EVT_TIMER);
 514         }
 515         return "network";
 516 }