9fa82734e8a278d52ba71bf5669164250177b36c
[citadel.git] / 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 "citadel_dirs.h"
76 #include "threads.h"
77 #include "context.h"
78 #include "ctdl_module.h"
79 #include "netspool.h"
80 #include "netmail.h"
81
82 int NetQDebugEnabled = 0;
83 struct CitContext networker_spool_CC;
84
85 /* comes from lookup3.c from libcitadel... */
86 extern uint32_t hashlittle( const void *key, size_t length, uint32_t initval);
87
88 typedef struct __roomlists {
89         RoomProcList *rplist;
90 }roomlists;
91 /*
92  * When we do network processing, it's accomplished in two passes; one to
93  * gather a list of rooms and one to actually do them.  It's ok that rplist
94  * is global; we have a mutex that keeps it safe.
95  */
96 struct RoomProcList *rplist = NULL;
97
98
99
100 /*
101  * Check the use table.  This is a list of messages which have recently
102  * arrived on the system.  It is maintained and queried to prevent the same
103  * message from being entered into the database multiple times if it happens
104  * to arrive multiple times by accident.
105  */
106 int network_usetable(struct CtdlMessage *msg)
107 {
108         StrBuf *msgid;
109         struct CitContext *CCC = CC;
110         time_t now;
111
112         /* Bail out if we can't generate a message ID */
113         if ((msg == NULL) || CM_IsEmpty(msg, emessageId))
114         {
115                 return(0);
116         }
117
118         /* Generate the message ID */
119         msgid = NewStrBufPlain(CM_KEY(msg, emessageId));
120         if (haschar(ChrPtr(msgid), '@') == 0) {
121                 StrBufAppendBufPlain(msgid, HKEY("@"), 0);
122                 if (!CM_IsEmpty(msg, eNodeName)) {
123                         StrBufAppendBufPlain(msgid, CM_KEY(msg, eNodeName), 0);
124                 }
125                 else {
126                         FreeStrBuf(&msgid);
127                         return(0);
128                 }
129         }
130         now = time(NULL);
131         if (CheckIfAlreadySeen("Networker Import",
132                                msgid,
133                                now, 0,
134                                eCheckUpdate,
135                                CCC->cs_pid, 0) != 0)
136         {
137                 FreeStrBuf(&msgid);
138                 return(1);
139         }
140         FreeStrBuf(&msgid);
141
142         return(0);
143 }
144
145
146
147 /*
148  * Send the *entire* contents of the current room to one specific network node,
149  * ignoring anything we know about which messages have already undergone
150  * network processing.  This can be used to bring a new node into sync.
151  */
152 int network_sync_to(char *target_node, long len)
153 {
154         struct CitContext *CCC = CC;
155         OneRoomNetCfg OneRNCFG;
156         OneRoomNetCfg *pRNCFG;
157         const RoomNetCfgLine *pCfgLine;
158         SpoolControl sc;
159         int num_spooled = 0;
160
161         /* Grab the configuration line we're looking for */
162         begin_critical_section(S_NETCONFIGS);
163         pRNCFG = CtdlGetNetCfgForRoom(CCC->room.QRnumber);
164         if ((pRNCFG == NULL) ||
165             (pRNCFG->NetConfigs[ignet_push_share] == NULL))
166         {
167                 return -1;
168         }
169
170         pCfgLine = pRNCFG->NetConfigs[ignet_push_share];
171         while (pCfgLine != NULL)
172         {
173                 if (!strcmp(ChrPtr(pCfgLine->Value[0]), target_node))
174                         break;
175                 pCfgLine = pCfgLine->next;
176         }
177         if (pCfgLine == NULL)
178         {
179                 return -1;
180         }
181
182         memset(&sc, 0, sizeof(SpoolControl));
183         memset(&OneRNCFG, 0, sizeof(OneRoomNetCfg));
184         sc.RNCfg = &OneRNCFG;
185         sc.RNCfg->NetConfigs[ignet_push_share] = DuplicateOneGenericCfgLine(pCfgLine);
186         sc.Users[ignet_push_share] = NewStrBufPlain(NULL,
187                                                     StrLength(pCfgLine->Value[0]) +
188                                                     StrLength(pCfgLine->Value[1]) + 10);
189         StrBufAppendBuf(sc.Users[ignet_push_share], 
190                         pCfgLine->Value[0],
191                         0);
192         StrBufAppendBufPlain(sc.Users[ignet_push_share], 
193                              HKEY(","),
194                              0);
195
196         StrBufAppendBuf(sc.Users[ignet_push_share], 
197                         pCfgLine->Value[1],
198                         0);
199         CalcListID(&sc);
200
201         end_critical_section(S_NETCONFIGS);
202
203         sc.working_ignetcfg = CtdlLoadIgNetCfg();
204         sc.the_netmap = CtdlReadNetworkMap();
205
206         /* Send ALL messages */
207         num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
208                 network_spool_msg, &sc);
209
210         /* Concise cleanup because we know there's only one node in the sc */
211         DeleteGenericCfgLine(NULL/*TODO*/, &sc.RNCfg->NetConfigs[ignet_push_share]);
212
213         DeleteHash(&sc.working_ignetcfg);
214         DeleteHash(&sc.the_netmap);
215         free_spoolcontrol_struct_members(&sc);
216
217         QN_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         long len;
229         char target_node[256];
230
231         if (CtdlAccessCheck(ac_aide)) return;
232
233         len = extract_token(target_node, argbuf, 0, '|', sizeof target_node);
234         num_spooled = network_sync_to(target_node, len);
235         if (num_spooled >= 0) {
236                 cprintf("%d Spooled %d messages.\n", CIT_OK, num_spooled);
237         }
238         else {
239                 cprintf("%d No such room/node share exists.\n",
240                         ERROR + ROOM_NOT_FOUND);
241         }
242 }
243
244 RoomProcList *CreateRoomProcListEntry(struct ctdlroom *qrbuf, OneRoomNetCfg *OneRNCFG)
245 {
246         int i;
247         struct RoomProcList *ptr;
248
249         ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
250         if (ptr == NULL) return NULL;
251
252         ptr->namelen = strlen(qrbuf->QRname);
253         if (ptr->namelen > ROOMNAMELEN)
254                 ptr->namelen = ROOMNAMELEN - 1;
255
256         memcpy (ptr->name, qrbuf->QRname, ptr->namelen);
257         ptr->name[ptr->namelen] = '\0';
258         ptr->QRNum = qrbuf->QRnumber;
259
260         for (i = 0; i < ptr->namelen; i++)
261         {
262                 ptr->lcname[i] = tolower(ptr->name[i]);
263         }
264
265         ptr->lcname[ptr->namelen] = '\0';
266         ptr->key = hashlittle(ptr->lcname, ptr->namelen, 9872345);
267         ptr->lastsent = OneRNCFG->lastsent;
268         ptr->OneRNCfg = OneRNCFG;
269         return ptr;
270 }
271
272 /*
273  * Batch up and send all outbound traffic from the current room
274  */
275 void network_queue_interesting_rooms(struct ctdlroom *qrbuf, void *data, OneRoomNetCfg *OneRNCfg)
276 {
277         struct RoomProcList *ptr;
278         roomlists *RP = (roomlists*) data;
279
280         if (!HaveSpoolConfig(OneRNCfg))
281                 return;
282
283         ptr = CreateRoomProcListEntry(qrbuf, OneRNCfg);
284
285         if (ptr != NULL)
286         {
287                 ptr->next = RP->rplist;
288                 RP->rplist = ptr;
289         }
290 }
291
292 /*
293  * Batch up and send all outbound traffic from the current room
294  */
295 int network_room_handler (struct ctdlroom *qrbuf)
296 {
297         struct RoomProcList *ptr;
298         OneRoomNetCfg* RNCfg;
299
300         if (qrbuf->QRdefaultview == VIEW_QUEUE)
301                 return 1;
302
303         RNCfg = CtdlGetNetCfgForRoom(qrbuf->QRnumber);
304         if (RNCfg == NULL)
305                 return 1;
306
307         if (!HaveSpoolConfig(RNCfg))
308                 return 1;
309
310         ptr = CreateRoomProcListEntry(qrbuf, RNCfg);
311         if (ptr == NULL)
312                 return 1;
313
314         ptr->OneRNCfg = NULL;
315         begin_critical_section(S_RPLIST);
316         ptr->next = rplist;
317         rplist = ptr;
318         end_critical_section(S_RPLIST);
319         return 1;
320 }
321
322 void destroy_network_queue_room(RoomProcList *rplist)
323 {
324         struct RoomProcList *cur, *p;
325
326         cur = rplist;
327         while (cur != NULL)
328         {
329                 p = cur->next;
330                 free (cur);
331                 cur = p;                
332         }
333 }
334
335 void destroy_network_queue_room_locked (void)
336 {
337         begin_critical_section(S_RPLIST);
338         destroy_network_queue_room(rplist);
339         end_critical_section(S_RPLIST);
340 }
341
342
343
344 /*
345  * Bounce a message back to the sender
346  */
347 void network_bounce(struct CtdlMessage *msg, char *reason)
348 {
349         struct CitContext *CCC = CC;
350         char buf[SIZ];
351         char bouncesource[SIZ];
352         char recipient[SIZ];
353         recptypes *valid = NULL;
354         char force_room[ROOMNAMELEN];
355         static int serialnum = 0;
356         long len;
357
358         QNM_syslog(LOG_DEBUG, "entering network_bounce()\n");
359
360         if (msg == NULL) return;
361
362         snprintf(bouncesource, sizeof bouncesource, "%s@%s", BOUNCESOURCE, config.c_nodename);
363
364         /* 
365          * Give it a fresh message ID
366          */
367         len = snprintf(buf, sizeof(buf),
368                        "%ld.%04lx.%04x@%s",
369                        (long)time(NULL),
370                        (long)getpid(),
371                        ++serialnum,
372                        config.c_fqdn);
373
374         CM_SetField(msg, emessageId, buf, len);
375
376         /*
377          * FIXME ... right now we're just sending a bounce; we really want to
378          * include the text of the bounced message.
379          */
380         CM_SetField(msg, eMesageText, reason, strlen(reason));
381         msg->cm_format_type = 0;
382
383         /*
384          * Turn the message around
385          */
386         CM_FlushField(msg, eRecipient);
387         CM_FlushField(msg, eDestination);
388
389         len = snprintf(recipient, sizeof(recipient), "%s@%s",
390                        msg->cm_fields[eAuthor],
391                        msg->cm_fields[eNodeName]);
392
393         CM_SetField(msg, eAuthor, HKEY(BOUNCESOURCE));
394         CM_SetField(msg, eNodeName, CFG_KEY(c_nodename));
395         CM_SetField(msg, eMsgSubject, HKEY("Delivery Status Notification (Failure)"));
396
397         Netmap_AddMe(msg, HKEY("unknown_user"));
398
399         /* Now submit the message */
400         valid = validate_recipients(recipient, NULL, 0);
401         if (valid != NULL) if (valid->num_error != 0) {
402                 free_recipients(valid);
403                 valid = NULL;
404         }
405         if ( (valid == NULL) || (!strcasecmp(recipient, bouncesource)) ) {
406                 strcpy(force_room, config.c_aideroom);
407         }
408         else {
409                 strcpy(force_room, "");
410         }
411         if ( (valid == NULL) && IsEmptyStr(force_room) ) {
412                 strcpy(force_room, config.c_aideroom);
413         }
414         CtdlSubmitMsg(msg, valid, force_room, 0);
415
416         /* Clean up */
417         if (valid != NULL) free_recipients(valid);
418         CM_Free(msg);
419         QNM_syslog(LOG_DEBUG, "leaving network_bounce()\n");
420 }
421
422
423
424 /*
425  * network_do_queue()
426  * 
427  * Run through the rooms doing various types of network stuff.
428  */
429 void network_do_queue(void)
430 {
431         struct CitContext *CCC = CC;
432         static time_t last_run = 0L;
433         int full_processing = 1;
434         HashList *working_ignetcfg;
435         HashList *the_netmap = NULL;
436         int netmap_changed = 0;
437         roomlists RL;
438         SpoolControl *sc = NULL;
439         SpoolControl *pSC;
440
441         /*
442          * Run the full set of processing tasks no more frequently
443          * than once every n seconds
444          */
445         if ( (time(NULL) - last_run) < config.c_net_freq ) {
446                 full_processing = 0;
447                 syslog(LOG_DEBUG, "Network full processing in %ld seconds.\n",
448                        config.c_net_freq - (time(NULL)- last_run)
449                 );
450         }
451
452         become_session(&networker_spool_CC);
453         begin_critical_section(S_RPLIST);
454         RL.rplist = rplist;
455         rplist = NULL;
456         end_critical_section(S_RPLIST);
457 ///TODO hm, check whether we have a config at all here?
458         /* Load the IGnet Configuration into memory */
459         working_ignetcfg = CtdlLoadIgNetCfg();
460
461         /*
462          * Load the network map and filter list into memory.
463          */
464         if (!server_shutting_down)
465                 the_netmap = CtdlReadNetworkMap();
466 #if 0
467         /* filterlist isn't supported anymore
468         if (!server_shutting_down)
469                 load_network_filter_list();
470         */
471 #endif
472
473         /* 
474          * Go ahead and run the queue
475          */
476         if (full_processing && !server_shutting_down) {
477                 QNM_syslog(LOG_DEBUG, "network: loading outbound queue");
478                 CtdlForEachNetCfgRoom(network_queue_interesting_rooms, &RL, maxRoomNetCfg);
479         }
480
481         if ((RL.rplist != NULL) && (!server_shutting_down)) {
482                 RoomProcList *ptr, *cmp;
483                 ptr = RL.rplist;
484                 QNM_syslog(LOG_DEBUG, "network: running outbound queue");
485                 while (ptr != NULL && !server_shutting_down) {
486                         
487                         cmp = ptr->next;
488                         /* filter duplicates from the list... */
489                         while (cmp != NULL) {
490                                 if ((cmp->namelen > 0) &&
491                                     (cmp->key == ptr->key) &&
492                                     (cmp->namelen == ptr->namelen) &&
493                                     (strcmp(cmp->lcname, ptr->lcname) == 0))
494                                 {
495                                         cmp->namelen = 0;
496                                 }
497                                 cmp = cmp->next;
498                         }
499
500                         if (ptr->namelen > 0) {
501                                 InspectQueuedRoom(&sc,
502                                                   ptr, 
503                                                   working_ignetcfg,
504                                                   the_netmap);
505                         }
506                         ptr = ptr->next;
507                 }
508         }
509
510
511         pSC = sc;
512         while (pSC != NULL)
513         {
514                 network_spoolout_room(pSC);
515                 pSC = pSC->next;
516         }
517
518         pSC = sc;
519         while (pSC != NULL)
520         {
521                 sc = pSC->next;
522                 free_spoolcontrol_struct(&pSC);
523                 pSC = sc;
524         }
525         /* If there is anything in the inbound queue, process it */
526         if (!server_shutting_down) {
527                 network_do_spoolin(working_ignetcfg, 
528                                    the_netmap,
529                                    &netmap_changed);
530         }
531
532         /* Free the filter list in memory */
533         free_netfilter_list();
534
535         /* Save the network map back to disk */
536         if (netmap_changed) {
537                 StrBuf *MapStr = CtdlSerializeNetworkMap(the_netmap);
538                 char *pMapStr = SmashStrBuf(&MapStr);
539                 CtdlPutSysConfig(IGNETMAP, pMapStr);
540                 free(pMapStr);
541         }
542
543         /* combine singe message files into one spool entry per remote node. */
544         network_consolidate_spoolout(working_ignetcfg, the_netmap);
545
546         /* shut down. */
547
548         DeleteHash(&the_netmap);
549
550         DeleteHash(&working_ignetcfg);
551
552         QNM_syslog(LOG_DEBUG, "network: queue run completed");
553
554         if (full_processing) {
555                 last_run = time(NULL);
556         }
557         destroy_network_queue_room(RL.rplist);
558         SaveChangedConfigs();
559
560 }
561
562
563
564
565
566
567
568
569 void network_logout_hook(void)
570 {
571         CitContext *CCC = MyContext();
572
573         /*
574          * If we were talking to a network node, we're not anymore...
575          */
576         if (!IsEmptyStr(CCC->net_node)) {
577                 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
578                 CCC->net_node[0] = '\0';
579         }
580 }
581 void network_cleanup_function(void)
582 {
583         struct CitContext *CCC = CC;
584
585         if (!IsEmptyStr(CCC->net_node)) {
586                 CtdlNetworkTalkingTo(CCC->net_node, strlen(CCC->net_node), NTT_REMOVE);
587                 CCC->net_node[0] = '\0';
588         }
589 }
590
591
592 int ignet_aftersave(struct CtdlMessage *msg,
593                     recptypes *recps)   /* recipients (if mail) */
594 {
595         /* For IGnet mail, we have to save a new copy into the spooler for
596          * each recipient, with the R and D fields set to the recipient and
597          * destination-node.  This has two ugly side effects: all other
598          * recipients end up being unlisted in this recipient's copy of the
599          * message, and it has to deliver multiple messages to the same
600          * node.  We'll revisit this again in a year or so when everyone has
601          * a network spool receiver that can handle the new style messages.
602          */
603         if ((recps != NULL) && (recps->num_ignet > 0))
604         {
605                 char *recipient;
606                 int rv = 0;
607                 struct ser_ret smr;
608                 FILE *network_fp = NULL;
609                 char submit_filename[128];
610                 static int seqnum = 1;
611                 int i;
612                 char *hold_R, *hold_D, *RBuf, *DBuf;
613                 long hrlen, hdlen, rblen, dblen, count, rlen;
614                 CitContext *CCC = MyContext();
615
616                 CM_GetAsField(msg, eRecipient, &hold_R, &hrlen);;
617                 CM_GetAsField(msg, eDestination, &hold_D, &hdlen);;
618
619                 count = num_tokens(recps->recp_ignet, '|');
620                 rlen = strlen(recps->recp_ignet);
621                 recipient = malloc(rlen + 1);
622                 RBuf = malloc(rlen + 1);
623                 DBuf = malloc(rlen + 1);
624                 for (i=0; i<count; ++i) {
625                         extract_token(recipient, recps->recp_ignet, i,
626                                       '|', rlen + 1);
627
628                         rblen = extract_token(RBuf, recipient, 0, '@', rlen + 1);
629                         dblen = extract_token(DBuf, recipient, 1, '@', rlen + 1);
630                 
631                         CM_SetAsField(msg, eRecipient, &RBuf, rblen);;
632                         CM_SetAsField(msg, eDestination, &DBuf, dblen);;
633                         CtdlSerializeMessage(&smr, msg);
634                         if (smr.len > 0) {
635                                 snprintf(submit_filename, sizeof submit_filename,
636                                          "%s/netmail.%04lx.%04x.%04x",
637                                          ctdl_netin_dir,
638                                          (long) getpid(),
639                                          CCC->cs_pid,
640                                          ++seqnum);
641
642                                 network_fp = fopen(submit_filename, "wb+");
643                                 if (network_fp != NULL) {
644                                         rv = fwrite(smr.ser, smr.len, 1, network_fp);
645                                         if (rv == -1) {
646                                                 MSG_syslog(LOG_EMERG, "CtdlSubmitMsg(): Couldn't write network spool file: %s\n",
647                                                            strerror(errno));
648                                         }
649                                         fclose(network_fp);
650                                 }
651                                 free(smr.ser);
652                         }
653                         CM_GetAsField(msg, eRecipient, &RBuf, &rblen);;
654                         CM_GetAsField(msg, eDestination, &DBuf, &dblen);;
655                 }
656                 free(RBuf);
657                 free(DBuf);
658                 free(recipient);
659                 CM_SetAsField(msg, eRecipient, &hold_R, hrlen);
660                 CM_SetAsField(msg, eDestination, &hold_D, hdlen);
661                 return 1;
662         }
663         return 0;
664 }
665
666 /*
667  * Module entry point
668  */
669
670 void SetNetQDebugEnabled(const int n)
671 {
672         NetQDebugEnabled = n;
673 }
674
675 CTDL_MODULE_INIT(network)
676 {
677         if (!threading)
678         {
679                 CtdlRegisterMessageHook(ignet_aftersave, EVT_AFTERSAVE);
680
681                 CtdlFillSystemContext(&networker_spool_CC, "CitNetSpool");
682                 CtdlRegisterDebugFlagHook(HKEY("networkqueue"), SetNetQDebugEnabled, &NetQDebugEnabled);
683                 CtdlRegisterSessionHook(network_cleanup_function, EVT_STOP, PRIO_STOP + 30);
684                 CtdlRegisterSessionHook(network_logout_hook, EVT_LOGOUT, PRIO_LOGOUT + 10);
685                 CtdlRegisterProtoHook(cmd_nsyn, "NSYN", "Synchronize room to node");
686                 CtdlRegisterRoomHook(network_room_handler);
687                 CtdlRegisterCleanupHook(destroy_network_queue_room_locked);
688                 CtdlRegisterSessionHook(network_do_queue, EVT_TIMER, PRIO_QUEUE + 10);
689         }
690         return "network";
691 }