Removed an old crufty upgrade routing -- minimum upgradable version is now 5.91
[citadel.git] / citadel / modules / network / serv_network.c
index c61d225931a36b6327205295d10d90c1eb548f86..c81f016ab7a66eeb827016668cf1c4f4dc56bdf7 100644 (file)
@@ -2,15 +2,15 @@
  * This module handles shared rooms, inter-Citadel mail, and outbound
  * mailing list processing.
  *
- * Copyright (c) 2000-2012 by the citadel.org team
+ * Copyright (c) 2000-2016 by the citadel.org team
  *
- *  This program is open source software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License, version 3.
+ * This program is open source software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License, version 3.
  *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  *
  * ** NOTE **   A word on the S_NETCONFIGS semaphore:
  * This is a fairly high-level type of critical section.  It ensures that no
@@ -18,7 +18,6 @@
  * so many things inside these, here are the rules:
  *  1. begin_critical_section(S_NETCONFIGS) *before* begin_ any others.
  *  2. Do *not* perform any I/O with the client during these sections.
- *
  */
 
 /*
@@ -87,7 +86,9 @@ extern uint32_t hashlittle( const void *key, size_t length, uint32_t initval);
 
 typedef struct __roomlists {
        RoomProcList *rplist;
-}roomlists;
+} roomlists;
+
+
 /*
  * When we do network processing, it's accomplished in two passes; one to
  * gather a list of rooms and one to actually do them.  It's ok that rplist
@@ -110,64 +111,59 @@ int network_sync_to(char *target_node, long len)
        SpoolControl sc;
        int num_spooled = 0;
 
-       /* Grab the configuration line we're looking for */
-       begin_critical_section(S_NETCONFIGS);
+       /* Load the netconfig for this room */
        pRNCFG = CtdlGetNetCfgForRoom(CCC->room.QRnumber);
-       if ((pRNCFG == NULL) ||
-           (pRNCFG->NetConfigs[ignet_push_share] == NULL))
+       if (pRNCFG == NULL) {                                   // no netconfig at all?
+               return -1;
+       }
+       if (pRNCFG->NetConfigs[ignet_push_share] == NULL)       // no ignet push shares?
        {
+               FreeRoomNetworkStruct(&pRNCFG);
                return -1;
        }
 
-       pCfgLine = pRNCFG->NetConfigs[ignet_push_share];
-       while (pCfgLine != NULL)
+       /* Search for an ignet_oush_share configuration bearing the target node's name */
+       for (pCfgLine = pRNCFG->NetConfigs[ignet_push_share]; pCfgLine != NULL; pCfgLine = pCfgLine->next)
        {
                if (!strcmp(ChrPtr(pCfgLine->Value[0]), target_node))
                        break;
-               pCfgLine = pCfgLine->next;
        }
+
+       /* If we aren't sharing with that node, bail out */
        if (pCfgLine == NULL)
        {
+               FreeRoomNetworkStruct(&pRNCFG);
                return -1;
        }
 
+       /* If we got here, we're good to go ... make up a dummy spoolconfig and roll with it */
+
+       begin_critical_section(S_NETCONFIGS);
        memset(&sc, 0, sizeof(SpoolControl));
        memset(&OneRNCFG, 0, sizeof(OneRoomNetCfg));
        sc.RNCfg = &OneRNCFG;
        sc.RNCfg->NetConfigs[ignet_push_share] = DuplicateOneGenericCfgLine(pCfgLine);
-       sc.Users[ignet_push_share] = NewStrBufPlain(NULL,
-                                                   StrLength(pCfgLine->Value[0]) +
-                                                   StrLength(pCfgLine->Value[1]) + 10);
-       StrBufAppendBuf(sc.Users[ignet_push_share], 
-                       pCfgLine->Value[0],
-                       0);
-       StrBufAppendBufPlain(sc.Users[ignet_push_share], 
-                            HKEY(","),
-                            0);
-
-       StrBufAppendBuf(sc.Users[ignet_push_share], 
-                       pCfgLine->Value[1],
-                       0);
+       sc.Users[ignet_push_share] = NewStrBufPlain(NULL, (StrLength(pCfgLine->Value[0]) + StrLength(pCfgLine->Value[1]) + 10) );
+       StrBufAppendBuf(sc.Users[ignet_push_share], pCfgLine->Value[0], 0);
+       StrBufAppendBufPlain(sc.Users[ignet_push_share], HKEY(","), 0);
+       StrBufAppendBuf(sc.Users[ignet_push_share], pCfgLine->Value[1], 0);
        CalcListID(&sc);
-
        end_critical_section(S_NETCONFIGS);
 
        sc.working_ignetcfg = CtdlLoadIgNetCfg();
        sc.the_netmap = CtdlReadNetworkMap();
 
        /* Send ALL messages */
-       num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL,
-               network_spool_msg, &sc);
+       num_spooled = CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, network_spool_msg, &sc);
 
        /* Concise cleanup because we know there's only one node in the sc */
-       DeleteGenericCfgLine(NULL/*TODO*/, &sc.RNCfg->NetConfigs[ignet_push_share]);
+       DeleteGenericCfgLine(NULL, &sc.RNCfg->NetConfigs[ignet_push_share]);
 
        DeleteHash(&sc.working_ignetcfg);
        DeleteHash(&sc.the_netmap);
        free_spoolcontrol_struct_members(&sc);
 
-       QN_syslog(LOG_NOTICE, "Synchronized %d messages to <%s>\n",
-                 num_spooled, target_node);
+       QN_syslog(LOG_NOTICE, "Synchronized %d messages to <%s>", num_spooled, target_node);
        return(num_spooled);
 }
 
@@ -188,8 +184,7 @@ void cmd_nsyn(char *argbuf) {
                cprintf("%d Spooled %d messages.\n", CIT_OK, num_spooled);
        }
        else {
-               cprintf("%d No such room/node share exists.\n",
-                       ERROR + ROOM_NOT_FOUND);
+               cprintf("%d No such room/node share exists.\n", ERROR + ROOM_NOT_FOUND);
        }
 }
 
@@ -199,11 +194,14 @@ RoomProcList *CreateRoomProcListEntry(struct ctdlroom *qrbuf, OneRoomNetCfg *One
        struct RoomProcList *ptr;
 
        ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
-       if (ptr == NULL) return NULL;
+       if (ptr == NULL) {
+               return NULL;
+       }
 
        ptr->namelen = strlen(qrbuf->QRname);
-       if (ptr->namelen > ROOMNAMELEN)
+       if (ptr->namelen > ROOMNAMELEN) {
                ptr->namelen = ROOMNAMELEN - 1;
+       }
 
        memcpy (ptr->name, qrbuf->QRname, ptr->namelen);
        ptr->name[ptr->namelen] = '\0';
@@ -229,8 +227,9 @@ void network_queue_interesting_rooms(struct ctdlroom *qrbuf, void *data, OneRoom
        struct RoomProcList *ptr;
        roomlists *RP = (roomlists*) data;
 
-       if (!HaveSpoolConfig(OneRNCfg))
+       if (!HaveSpoolConfig(OneRNCfg)) {
                return;
+       }
 
        ptr = CreateRoomProcListEntry(qrbuf, OneRNCfg);
 
@@ -244,30 +243,37 @@ void network_queue_interesting_rooms(struct ctdlroom *qrbuf, void *data, OneRoom
 /*
  * Batch up and send all outbound traffic from the current room
  */
-int network_room_handler (struct ctdlroom *qrbuf)
+int network_room_handler(struct ctdlroom *qrbuf)
 {
        struct RoomProcList *ptr;
-       OneRoomNetCfgRNCfg;
+       OneRoomNetCfg *RNCfg;
 
-       if (qrbuf->QRdefaultview == VIEW_QUEUE)
+       if (qrbuf->QRdefaultview == VIEW_QUEUE) {
                return 1;
+       }
 
        RNCfg = CtdlGetNetCfgForRoom(qrbuf->QRnumber);
-       if (RNCfg == NULL)
+       if (RNCfg == NULL) {
                return 1;
+       }
 
-       if (!HaveSpoolConfig(RNCfg))
+       if (!HaveSpoolConfig(RNCfg)) {
+               FreeRoomNetworkStruct(&RNCfg);
                return 1;
+       }
 
        ptr = CreateRoomProcListEntry(qrbuf, RNCfg);
-       if (ptr == NULL)
+       if (ptr == NULL) {
+               FreeRoomNetworkStruct(&RNCfg);
                return 1;
+       }
 
        ptr->OneRNCfg = NULL;
        begin_critical_section(S_RPLIST);
        ptr->next = rplist;
        rplist = ptr;
        end_critical_section(S_RPLIST);
+       FreeRoomNetworkStruct(&RNCfg);
        return 1;
 }
 
@@ -292,87 +298,6 @@ void destroy_network_queue_room_locked (void)
 }
 
 
-
-/*
- * Bounce a message back to the sender
- */
-void network_bounce(struct CtdlMessage *msg, char *reason)
-{
-       struct CitContext *CCC = CC;
-       char buf[SIZ];
-       char bouncesource[SIZ];
-       char recipient[SIZ];
-       recptypes *valid = NULL;
-       char force_room[ROOMNAMELEN];
-       static int serialnum = 0;
-       long len;
-
-       QNM_syslog(LOG_DEBUG, "entering network_bounce()\n");
-
-       if (msg == NULL) return;
-
-       snprintf(bouncesource, sizeof bouncesource, "%s@%s", BOUNCESOURCE, config.c_nodename);
-
-       /* 
-        * Give it a fresh message ID
-        */
-       len = snprintf(buf, sizeof(buf),
-                      "%ld.%04lx.%04x@%s",
-                      (long)time(NULL),
-                      (long)getpid(),
-                      ++serialnum,
-                      config.c_fqdn);
-
-       CM_SetField(msg, emessageId, buf, len);
-
-       /*
-        * FIXME ... right now we're just sending a bounce; we really want to
-        * include the text of the bounced message.
-        */
-       CM_SetField(msg, eMesageText, reason, strlen(reason));
-       msg->cm_format_type = 0;
-
-       /*
-        * Turn the message around
-        */
-       CM_FlushField(msg, eRecipient);
-       CM_FlushField(msg, eDestination);
-
-       len = snprintf(recipient, sizeof(recipient), "%s@%s",
-                      msg->cm_fields[eAuthor],
-                      msg->cm_fields[eNodeName]);
-
-       CM_SetField(msg, eAuthor, HKEY(BOUNCESOURCE));
-       CM_SetField(msg, eNodeName, CFG_KEY(c_nodename));
-       CM_SetField(msg, eMsgSubject, HKEY("Delivery Status Notification (Failure)"));
-
-       Netmap_AddMe(msg, HKEY("unknown_user"));
-
-       /* Now submit the message */
-       valid = validate_recipients(recipient, NULL, 0);
-       if (valid != NULL) if (valid->num_error != 0) {
-               free_recipients(valid);
-               valid = NULL;
-       }
-       if ( (valid == NULL) || (!strcasecmp(recipient, bouncesource)) ) {
-               strcpy(force_room, config.c_aideroom);
-       }
-       else {
-               strcpy(force_room, "");
-       }
-       if ( (valid == NULL) && IsEmptyStr(force_room) ) {
-               strcpy(force_room, config.c_aideroom);
-       }
-       CtdlSubmitMsg(msg, valid, force_room, 0);
-
-       /* Clean up */
-       if (valid != NULL) free_recipients(valid);
-       CM_Free(msg);
-       QNM_syslog(LOG_DEBUG, "leaving network_bounce()\n");
-}
-
-
-
 /*
  * network_do_queue()
  * 
@@ -394,10 +319,11 @@ void network_do_queue(void)
         * Run the full set of processing tasks no more frequently
         * than once every n seconds
         */
-       if ( (time(NULL) - last_run) < config.c_net_freq ) {
+       if ( (time(NULL) - last_run) < CtdlGetConfigLong("c_net_freq") )
+       {
                full_processing = 0;
-               syslog(LOG_DEBUG, "Network full processing in %ld seconds.\n",
-                      config.c_net_freq - (time(NULL)- last_run)
+               syslog(LOG_DEBUG, "Network full processing in %ld seconds.",
+                      CtdlGetConfigLong("c_net_freq") - (time(NULL)- last_run)
                );
        }
 
@@ -406,21 +332,17 @@ void network_do_queue(void)
        RL.rplist = rplist;
        rplist = NULL;
        end_critical_section(S_RPLIST);
-///TODO hm, check whether we have a config at all here?
+
+       // TODO hm, check whether we have a config at all here?
        /* Load the IGnet Configuration into memory */
        working_ignetcfg = CtdlLoadIgNetCfg();
 
        /*
         * Load the network map and filter list into memory.
         */
-       if (!server_shutting_down)
+       if (!server_shutting_down) {
                the_netmap = CtdlReadNetworkMap();
-#if 0
-       /* filterlist isn't supported anymore
-       if (!server_shutting_down)
-               load_network_filter_list();
-       */
-#endif
+       }
 
        /* 
         * Go ahead and run the queue
@@ -492,7 +414,7 @@ void network_do_queue(void)
                free(pMapStr);
        }
 
-       /* combine singe message files into one spool entry per remote node. */
+       /* combine single message files into one spool entry per remote node. */
        network_consolidate_spoolout(working_ignetcfg, the_netmap);
 
        /* shut down. */
@@ -507,17 +429,9 @@ void network_do_queue(void)
                last_run = time(NULL);
        }
        destroy_network_queue_room(RL.rplist);
-       SaveChangedConfigs();
-
 }
 
 
-
-
-
-
-
-
 void network_logout_hook(void)
 {
        CitContext *CCC = MyContext();
@@ -530,6 +444,8 @@ void network_logout_hook(void)
                CCC->net_node[0] = '\0';
        }
 }
+
+
 void network_cleanup_function(void)
 {
        struct CitContext *CCC = CC;
@@ -541,8 +457,7 @@ void network_cleanup_function(void)
 }
 
 
-int ignet_aftersave(struct CtdlMessage *msg,
-                   recptypes *recps)   /* recipients (if mail) */
+int ignet_aftersave(struct CtdlMessage *msg, recptypes *recps)
 {
        /* For IGnet mail, we have to save a new copy into the spooler for
         * each recipient, with the R and D fields set to the recipient and
@@ -574,8 +489,7 @@ int ignet_aftersave(struct CtdlMessage *msg,
                RBuf = malloc(rlen + 1);
                DBuf = malloc(rlen + 1);
                for (i=0; i<count; ++i) {
-                       extract_token(recipient, recps->recp_ignet, i,
-                                     '|', rlen + 1);
+                       extract_token(recipient, recps->recp_ignet, i, '|', rlen + 1);
 
                        rblen = extract_token(RBuf, recipient, 0, '@', rlen + 1);
                        dblen = extract_token(DBuf, recipient, 1, '@', rlen + 1);
@@ -595,7 +509,7 @@ int ignet_aftersave(struct CtdlMessage *msg,
                                if (network_fp != NULL) {
                                        rv = fwrite(smr.ser, smr.len, 1, network_fp);
                                        if (rv == -1) {
-                                               MSG_syslog(LOG_EMERG, "CtdlSubmitMsg(): Couldn't write network spool file: %s\n",
+                                               MSG_syslog(LOG_EMERG, "CtdlSubmitMsg(): Couldn't write network spool file: %s",
                                                           strerror(errno));
                                        }
                                        fclose(network_fp);
@@ -615,6 +529,7 @@ int ignet_aftersave(struct CtdlMessage *msg,
        return 0;
 }
 
+
 /*
  * Module entry point
  */
@@ -624,6 +539,7 @@ void SetNetQDebugEnabled(const int n)
        NetQDebugEnabled = n;
 }
 
+
 CTDL_MODULE_INIT(network)
 {
        if (!threading)