RSSClient: make debug log runtime configurable
[citadel.git] / citadel / modules / rssclient / serv_rssclient.c
index 9f27b307f19033acb762a5b1edfdd36ad68b15b1..638300feb439abdbee4bb7cb42afa3fbcd825f82 100644 (file)
@@ -1,21 +1,15 @@
 /*
  * Bring external RSS feeds into rooms.
  *
- * Copyright (c) 2007-2010 by the citadel.org team
+ * Copyright (c) 2007-2012 by the citadel.org team
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * (at your option) any later version.
+ * 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
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
  * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
 #include <stdlib.h>
@@ -27,9 +21,9 @@
 # include <time.h>
 #else
 # if HAVE_SYS_TIME_H
-#  include <sys/time.h>
+#include <sys/time.h>
 # else
-#  include <time.h>
+#include <time.h>
 # endif
 #endif
 
@@ -69,11 +63,35 @@ HashList *RSSQueueRooms = NULL; /* rss_room_counter */
 HashList *RSSFetchUrls = NULL; /*->rss_aggregator;->RefCount access locked*/
 
 eNextState RSSAggregator_Terminate(AsyncIO *IO);
+eNextState RSSAggregator_TerminateDB(AsyncIO *IO);
 eNextState RSSAggregator_ShutdownAbort(AsyncIO *IO);
 struct CitContext rss_CC;
 
 struct rssnetcfg *rnclist = NULL;
+int RSSClientDebugEnabled = 0;
+#define N ((rss_aggregator*)IO->Data)->QRnumber
+
+#define DBGLOG(LEVEL) if ((LEVEL != LOG_DEBUG) || (RSSClientDebugEnabled != 0))
+
+#define EVRSSC_syslog(LEVEL, FORMAT, ...)                              \
+       DBGLOG(LEVEL) syslog(LEVEL,                                     \
+                            "IO[%ld]CC[%d][%ld]RSS" FORMAT,            \
+                            IO->ID, CCID, N, __VA_ARGS__)
+
+#define EVRSSCM_syslog(LEVEL, FORMAT)                                  \
+       DBGLOG(LEVEL) syslog(LEVEL,                                     \
+                            "IO[%ld]CC[%d][%ld]RSS" FORMAT,            \
+                            IO->ID, CCID, N)
 
+#define EVRSSQ_syslog(LEVEL, FORMAT, ...)                              \
+       DBGLOG(LEVEL) syslog(LEVEL, "RSS" FORMAT,                       \
+                            __VA_ARGS__)
+#define EVRSSQM_syslog(LEVEL, FORMAT)                  \
+       DBGLOG(LEVEL) syslog(LEVEL, "RSS" FORMAT)
+
+#define EVRSSCSM_syslog(LEVEL, FORMAT)                                 \
+       DBGLOG(LEVEL) syslog(LEVEL, "IO[%ld][%ld]RSS" FORMAT,           \
+                            IO->ID, N)
 
 void DeleteRoomReference(long QRnumber)
 {
@@ -99,19 +117,19 @@ void DeleteRoomReference(long QRnumber)
        DeleteHashPos(&At);
 }
 
-void UnlinkRooms(rss_aggregator *Cfg)
+void UnlinkRooms(rss_aggregator *RSSAggr)
 {
-       DeleteRoomReference(Cfg->QRnumber);
-       if (Cfg->OtherQRnumbers != NULL)
+       DeleteRoomReference(RSSAggr->QRnumber);
+       if (RSSAggr->OtherQRnumbers != NULL)
        {
                long HKLen;
                const char *HK;
                HashPos *At;
                void *vData;
 
-               At = GetNewHashPos(Cfg->OtherQRnumbers, 0);
+               At = GetNewHashPos(RSSAggr->OtherQRnumbers, 0);
                while (! server_shutting_down &&
-                      GetNextHashPos(Cfg->OtherQRnumbers,
+                      GetNextHashPos(RSSAggr->OtherQRnumbers,
                                      At,
                                      &HKLen, &HK,
                                      &vData) &&
@@ -125,27 +143,28 @@ void UnlinkRooms(rss_aggregator *Cfg)
        }
 }
 
-void UnlinkRSSAggregator(rss_aggregator *Cfg)
+void UnlinkRSSAggregator(rss_aggregator *RSSAggr)
 {
        HashPos *At;
 
-       UnlinkRooms(Cfg);
+       pthread_mutex_lock(&RSSQueueMutex);
+       UnlinkRooms(RSSAggr);
 
        At = GetNewHashPos(RSSFetchUrls, 0);
-       if (GetHashPosFromKey(RSSFetchUrls, SKEY(Cfg->Url), At))
+       if (GetHashPosFromKey(RSSFetchUrls, SKEY(RSSAggr->Url), At))
        {
                DeleteEntryFromHash(RSSFetchUrls, At);
        }
        DeleteHashPos(&At);
        last_run = time(NULL);
+       pthread_mutex_unlock(&RSSQueueMutex);
 }
 
-
 void DeleteRssCfg(void *vptr)
 {
        rss_aggregator *RSSAggr = (rss_aggregator *)vptr;
        AsyncIO *IO = &RSSAggr->IO;
-       EVM_syslog(LOG_DEBUG, "RSS: destroying\n");
+       EVRSSCM_syslog(LOG_DEBUG, "RSS: destroying\n");
 
        FreeStrBuf(&RSSAggr->Url);
        FreeStrBuf(&RSSAggr->rooms);
@@ -174,12 +193,24 @@ eNextState RSSAggregator_Terminate(AsyncIO *IO)
 {
        rss_aggregator *RSSAggr = (rss_aggregator *)IO->Data;
 
-       EVM_syslog(LOG_DEBUG, "RSS: Terminating.\n");
+       EVRSSCM_syslog(LOG_DEBUG, "RSS: Terminating.\n");
+
+
+       UnlinkRSSAggregator(RSSAggr);
+       return eAbort;
+}
+
+eNextState RSSAggregator_TerminateDB(AsyncIO *IO)
+{
+       rss_aggregator *RSSAggr = (rss_aggregator *)IO->Data;
+
+       EVRSSCM_syslog(LOG_DEBUG, "RSS: Terminating.\n");
 
 
        UnlinkRSSAggregator(RSSAggr);
        return eAbort;
 }
+
 eNextState RSSAggregator_ShutdownAbort(AsyncIO *IO)
 {
        const char *pUrl;
@@ -189,7 +220,7 @@ eNextState RSSAggregator_ShutdownAbort(AsyncIO *IO)
        if (pUrl == NULL)
                pUrl = "";
 
-       EV_syslog(LOG_DEBUG, "RSS: Aborting by shutdown: %s.\n", pUrl);
+       EVRSSC_syslog(LOG_DEBUG, "RSS: Aborting by shutdown: %s.\n", pUrl);
 
 
        UnlinkRSSAggregator(RSSAggr);
@@ -208,7 +239,8 @@ eNextState RSSSaveMessage(AsyncIO *IO)
        const char *Key;
        rss_aggregator *RSSAggr = (rss_aggregator *) IO->Data;
 
-       RSSAggr->ThisMsg->Msg.cm_fields['M'] = SmashStrBuf(&RSSAggr->ThisMsg->Message);
+       RSSAggr->ThisMsg->Msg.cm_fields['M'] =
+               SmashStrBuf(&RSSAggr->ThisMsg->Message);
 
        CtdlSubmitMsg(&RSSAggr->ThisMsg->Msg, &RSSAggr->recp, NULL, 0);
 
@@ -243,7 +275,7 @@ eNextState RSS_FetchNetworkUsetableEntry(AsyncIO *IO)
 #ifndef DEBUG_RSS
        if (cdbut != NULL) {
                /* Item has already been seen */
-               EV_syslog(LOG_DEBUG,
+               EVRSSC_syslog(LOG_DEBUG,
                          "%s has already been seen\n",
                          ChrPtr(Ctx->ThisMsg->MsgGUID));
                cdb_free(cdbut);
@@ -271,45 +303,45 @@ eNextState RSS_FetchNetworkUsetableEntry(AsyncIO *IO)
        }
 }
 
-
-
 /*
  * Begin a feed parse
  */
-int rss_do_fetching(rss_aggregator *Cfg)
+int rss_do_fetching(rss_aggregator *RSSAggr)
 {
+       AsyncIO         *IO = &RSSAggr->IO;
        rss_item *ri;
        time_t now;
 
        now = time(NULL);
 
-       if ((Cfg->next_poll != 0) && (now < Cfg->next_poll))
+       if ((RSSAggr->next_poll != 0) && (now < RSSAggr->next_poll))
                return 0;
 
        ri = (rss_item*) malloc(sizeof(rss_item));
        memset(ri, 0, sizeof(rss_item));
-       Cfg->Item = ri;
+       RSSAggr->Item = ri;
 
-       if (! InitcURLIOStruct(&Cfg->IO,
-                              Cfg,
+       if (! InitcURLIOStruct(&RSSAggr->IO,
+                              RSSAggr,
                               "Citadel RSS Client",
                               RSSAggregator_ParseReply,
                               RSSAggregator_Terminate,
+                              RSSAggregator_TerminateDB,
                               RSSAggregator_ShutdownAbort))
        {
-               syslog(LOG_ALERT, "Unable to initialize libcurl.\n");
+               EVRSSCM_syslog(LOG_ALERT, "Unable to initialize libcurl.\n");
                return 0;
        }
 
-       safestrncpy(((CitContext*)Cfg->IO.CitContext)->cs_host,
-                   ChrPtr(Cfg->Url),
-                   sizeof(((CitContext*)Cfg->IO.CitContext)->cs_host));
+       safestrncpy(((CitContext*)RSSAggr->IO.CitContext)->cs_host,
+                   ChrPtr(RSSAggr->Url),
+                   sizeof(((CitContext*)RSSAggr->IO.CitContext)->cs_host));
 
-       syslog(LOG_DEBUG, "Fetching RSS feed <%s>\n", ChrPtr(Cfg->Url));
-       ParseURL(&Cfg->IO.ConnectMe, Cfg->Url, 80);
-       CurlPrepareURL(Cfg->IO.ConnectMe);
+       EVRSSC_syslog(LOG_DEBUG, "Fetching RSS feed <%s>\n", ChrPtr(RSSAggr->Url));
+       ParseURL(&RSSAggr->IO.ConnectMe, RSSAggr->Url, 80);
+       CurlPrepareURL(RSSAggr->IO.ConnectMe);
 
-       QueueCurlContext(&Cfg->IO);
+       QueueCurlContext(&RSSAggr->IO);
        return 1;
 }
 
@@ -324,7 +356,7 @@ void rssclient_scan_room(struct ctdlroom *qrbuf, void *data)
        rss_room_counter *Count = NULL;
        struct stat statbuf;
        char filename[PATH_MAX];
-       int  fd;
+       int fd;
        int Done;
        rss_aggregator *RSSAggr = NULL;
        rss_aggregator *use_this_RSSAggr = NULL;
@@ -335,10 +367,10 @@ void rssclient_scan_room(struct ctdlroom *qrbuf, void *data)
        pthread_mutex_lock(&RSSQueueMutex);
        if (GetHash(RSSQueueRooms, LKEY(qrbuf->QRnumber), &vptr))
        {
-               syslog(LOG_DEBUG,
-                      "rssclient: [%ld] %s already in progress.\n",
-                      qrbuf->QRnumber,
-                      qrbuf->QRname);
+               EVRSSQ_syslog(LOG_DEBUG,
+                             "rssclient: [%ld] %s already in progress.\n",
+                             qrbuf->QRnumber,
+                             qrbuf->QRname);
                pthread_mutex_unlock(&RSSQueueMutex);
                return;
        }
@@ -362,10 +394,10 @@ void rssclient_scan_room(struct ctdlroom *qrbuf, void *data)
                return;
 
        if (fstat(fd, &statbuf) == -1) {
-               syslog(LOG_DEBUG,
-                      "ERROR: could not stat configfile '%s' - %s\n",
-                      filename,
-                      strerror(errno));
+               EVRSSQ_syslog(LOG_DEBUG,
+                             "ERROR: could not stat configfile '%s' - %s\n",
+                             filename,
+                             strerror(errno));
                return;
        }
 
@@ -377,8 +409,8 @@ void rssclient_scan_room(struct ctdlroom *qrbuf, void *data)
        if (StrBufReadBLOB(CfgData, &fd, 1, statbuf.st_size, &Err) < 0) {
                close(fd);
                FreeStrBuf(&CfgData);
-               syslog(LOG_DEBUG, "ERROR: reading config '%s' - %s<br>\n",
-                       filename, strerror(errno));
+               EVRSSQ_syslog(LOG_ERR, "ERROR: reading config '%s' - %s<br>\n",
+                             filename, strerror(errno));
                return;
        }
        close(fd);
@@ -391,71 +423,89 @@ void rssclient_scan_room(struct ctdlroom *qrbuf, void *data)
        Done = 0;
        while (!Done)
        {
-           Done = StrBufSipLine(Line, CfgData, &CfgPtr) == 0;
-           if (StrLength(Line) > 0)
-           {
-               lPtr = NULL;
-               StrBufExtract_NextToken(CfgType, Line, &lPtr, '|');
-               if (!strcasecmp("rssclient", ChrPtr(CfgType)))
+               Done = StrBufSipLine(Line, CfgData, &CfgPtr) == 0;
+               if (StrLength(Line) > 0)
                {
-                   if (Count == NULL)
-                   {
-                       Count = malloc(sizeof(rss_room_counter));
-                       Count->count = 0;
-                   }
-                   Count->count ++;
-                   RSSAggr = (rss_aggregator *) malloc(sizeof(rss_aggregator));
-                   memset (RSSAggr, 0, sizeof(rss_aggregator));
-                   RSSAggr->roomlist_parts = 1;
-                   RSSAggr->Url = NewStrBuf();
-                   StrBufExtract_NextToken(RSSAggr->Url, Line, &lPtr, '|');
-
-                   pthread_mutex_lock(&RSSQueueMutex);
-                   GetHash(RSSFetchUrls, SKEY(RSSAggr->Url), &vptr);
-                   use_this_RSSAggr = (rss_aggregator *)vptr;
-                   if (use_this_RSSAggr != NULL)
-                   {
-                           long *QRnumber;
-                           StrBufAppendBufPlain(use_this_RSSAggr->rooms,
-                                                qrbuf->QRname,
-                                                -1, 0);
-                           if (use_this_RSSAggr->roomlist_parts == 1)
-                           {
-                                   use_this_RSSAggr->OtherQRnumbers =
-                                           NewHash(1, lFlathash);
-                           }
-                           QRnumber = (long*)malloc(sizeof(long));
-                           *QRnumber = qrbuf->QRnumber;
-                           Put(use_this_RSSAggr->OtherQRnumbers,
-                               LKEY(qrbuf->QRnumber),
-                               QRnumber,
-                               NULL);
-                           use_this_RSSAggr->roomlist_parts++;
-
-                           pthread_mutex_unlock(&RSSQueueMutex);
-
-                           FreeStrBuf(&RSSAggr->Url);
-                           free(RSSAggr);
-                           RSSAggr = NULL;
-                           continue;
-                   }
-                   pthread_mutex_unlock(&RSSQueueMutex);
-
-                   RSSAggr->ItemType = RSS_UNSET;
-
-                   RSSAggr->rooms = NewStrBufPlain(qrbuf->QRname, -1);
-
-                   pthread_mutex_lock(&RSSQueueMutex);
-                   Put(RSSFetchUrls, SKEY(RSSAggr->Url), RSSAggr, DeleteRssCfg);
-                   pthread_mutex_unlock(&RSSQueueMutex);
+                       lPtr = NULL;
+                       StrBufExtract_NextToken(CfgType, Line, &lPtr, '|');
+                       if (!strcasecmp("rssclient", ChrPtr(CfgType)))
+                       {
+                               if (Count == NULL)
+                               {
+                                       Count = malloc(
+                                               sizeof(rss_room_counter));
+                                       Count->count = 0;
+                               }
+                               Count->count ++;
+                               RSSAggr = (rss_aggregator *) malloc(
+                                       sizeof(rss_aggregator));
+
+                               memset (RSSAggr, 0, sizeof(rss_aggregator));
+                               RSSAggr->QRnumber = qrbuf->QRnumber;
+                               RSSAggr->roomlist_parts = 1;
+                               RSSAggr->Url = NewStrBuf();
+
+                               StrBufExtract_NextToken(RSSAggr->Url,
+                                                       Line,
+                                                       &lPtr,
+                                                       '|');
+
+                               pthread_mutex_lock(&RSSQueueMutex);
+                               GetHash(RSSFetchUrls,
+                                       SKEY(RSSAggr->Url),
+                                       &vptr);
+
+                               use_this_RSSAggr = (rss_aggregator *)vptr;
+                               if (use_this_RSSAggr != NULL)
+                               {
+                                       long *QRnumber;
+                                       StrBufAppendBufPlain(
+                                               use_this_RSSAggr->rooms,
+                                               qrbuf->QRname,
+                                               -1, 0);
+                                       if (use_this_RSSAggr->roomlist_parts==1)
+                                       {
+                                               use_this_RSSAggr->OtherQRnumbers
+                                                       = NewHash(1, lFlathash);
+                                       }
+                                       QRnumber = (long*)malloc(sizeof(long));
+                                       *QRnumber = qrbuf->QRnumber;
+                                       Put(use_this_RSSAggr->OtherQRnumbers,
+                                           LKEY(qrbuf->QRnumber),
+                                           QRnumber,
+                                           NULL);
+                                       use_this_RSSAggr->roomlist_parts++;
+
+                                       pthread_mutex_unlock(&RSSQueueMutex);
+
+                                       FreeStrBuf(&RSSAggr->Url);
+                                       free(RSSAggr);
+                                       RSSAggr = NULL;
+                                       continue;
+                               }
+                               pthread_mutex_unlock(&RSSQueueMutex);
+
+                               RSSAggr->ItemType = RSS_UNSET;
+
+                               RSSAggr->rooms = NewStrBufPlain(
+                                       qrbuf->QRname, -1);
+
+                               pthread_mutex_lock(&RSSQueueMutex);
+
+                               Put(RSSFetchUrls,
+                                   SKEY(RSSAggr->Url),
+                                   RSSAggr,
+                                   DeleteRssCfg);
+
+                               pthread_mutex_unlock(&RSSQueueMutex);
+                       }
                }
-           }
        }
        if (Count != NULL)
        {
                Count->QRnumber = qrbuf->QRnumber;
                pthread_mutex_lock(&RSSQueueMutex);
-               syslog(LOG_DEBUG, "rssclient: [%ld] %s now starting.\n", 
+               EVRSSQ_syslog(LOG_DEBUG, "client: [%ld] %s now starting.\n",
                              qrbuf->QRnumber, qrbuf->QRname);
                Put(RSSQueueRooms, LKEY(qrbuf->QRnumber), Count, NULL);
                pthread_mutex_unlock(&RSSQueueMutex);
@@ -469,31 +519,43 @@ void rssclient_scan_room(struct ctdlroom *qrbuf, void *data)
  * Scan for rooms that have RSS client requests configured
  */
 void rssclient_scan(void) {
-       static int doing_rssclient = 0;
+       int RSSRoomCount, RSSCount;
        rss_aggregator *rptr = NULL;
        void *vrptr = NULL;
-       HashPos  *it;
+       HashPos *it;
        long len;
        const char *Key;
+       time_t now = time(NULL);
 
        /* Run no more than once every 15 minutes. */
-       if ((time(NULL) - last_run) < 900) {
+       if ((now - last_run) < 900) {
+               EVRSSQ_syslog(LOG_DEBUG,
+                             "Client: polling interval not yet reached; last run was %ldm%lds ago",
+                             ((now - last_run) / 60),
+                             ((now - last_run) % 60)
+               );
                return;
        }
 
        /*
         * This is a simple concurrency check to make sure only one rssclient
-        * run is done at a time.  We could do this with a mutex, but since we
-        * don't really require extremely fine granularity here, we'll do it
-        * with a static variable instead.
+        * run is done at a time.
         */
-       if (doing_rssclient) return;
-       doing_rssclient = 1;
-       if ((GetCount(RSSQueueRooms) > 0) || (GetCount(RSSFetchUrls) > 0))
+       pthread_mutex_lock(&RSSQueueMutex);
+       RSSCount = GetCount(RSSFetchUrls);
+       RSSRoomCount = GetCount(RSSQueueRooms);
+       pthread_mutex_unlock(&RSSQueueMutex);
+
+       if ((RSSRoomCount > 0) || (RSSCount > 0)) {
+               EVRSSQ_syslog(LOG_DEBUG,
+                             "rssclient: concurrency check failed; %d rooms and %d url's are queued",
+                             RSSRoomCount, RSSCount
+                       );
                return;
+       }
 
        become_session(&rss_CC);
-       syslog(LOG_DEBUG, "rssclient started\n");
+       EVRSSQM_syslog(LOG_DEBUG, "rssclient started\n");
        CtdlForEachRoom(rssclient_scan_room, NULL);
 
        pthread_mutex_lock(&RSSQueueMutex);
@@ -509,8 +571,7 @@ void rssclient_scan(void) {
        DeleteHashPos(&it);
        pthread_mutex_unlock(&RSSQueueMutex);
 
-       syslog(LOG_DEBUG, "rssclient ended\n");
-       doing_rssclient = 0;
+       EVRSSQM_syslog(LOG_DEBUG, "rssclient ended\n");
        return;
 }
 
@@ -521,6 +582,10 @@ void rss_cleanup(void)
        DeleteHash(&RSSQueueRooms);
 }
 
+void LogDebugEnableRSSClient(void)
+{
+       RSSClientDebugEnabled = 1;
+}
 
 CTDL_MODULE_INIT(rssclient)
 {
@@ -532,7 +597,8 @@ CTDL_MODULE_INIT(rssclient)
                RSSFetchUrls = NewHash(1, NULL);
                syslog(LOG_INFO, "%s\n", curl_version());
                CtdlRegisterSessionHook(rssclient_scan, EVT_TIMER);
-               CtdlRegisterCleanupHook(rss_cleanup);
+               CtdlRegisterEVCleanupHook(rss_cleanup);
+               CtdlRegisterDebugFlagHook(HKEY("rssclient"), LogDebugEnableRSSClient);
        }
        return "rssclient";
 }