2 * \file extnotify_main.c
3 * @author Mathew McBride
5 * This module implements an external pager hook for when notifcation
6 * of a new email is wanted.
7 * Based on bits of serv_funambol
8 * Contact: <matt@mcbridematt.dhs.org> / <matt@comalies>
19 #include <sys/types.h>
21 #if TIME_WITH_SYS_TIME
22 # include <sys/time.h>
26 # include <sys/time.h>
35 #include <sys/socket.h>
36 #include <libcitadel.h>
39 #include "citserver.h"
48 #include "internet_addressing.h"
50 #include "clientsocket.h"
51 #include "extnotify.h"
53 #include "ctdl_module.h"
57 void ExtNotify_PutErrorMessage(NotifyContext *Ctx, StrBuf *ErrMsg)
60 if (Ctx->NotifyErrors == NULL)
61 Ctx->NotifyErrors = NewHash(1, Flathash);
63 nNext = GetCount(Ctx->NotifyErrors) + 1;
64 Put(Ctx->NotifyErrors,
74 StrBuf* GetNHBuf(int i, int allocit, StrBuf **NotifyHostList)
76 if ((NotifyHostList[i] == NULL) && (allocit != 0))
77 NotifyHostList[i] = NewStrBuf();
78 return NotifyHostList[i];
82 StrBuf** GetNotifyHosts(void)
84 char NotifyHostsBuf[SIZ];
89 const char *pchs, *pche;
90 const char *NextHost = NULL;
91 StrBuf **NotifyHostList;
94 /* See if we have any Notification Hosts configured */
95 num_notify = get_hosts(NotifyHostsBuf, "notify");
99 NotifyHostList = malloc(sizeof(StrBuf*) * 2 * (num_notify + 1));
100 memset(NotifyHostList, 0, sizeof(StrBuf*) * 2 * (num_notify + 1));
102 NotifyBuf = NewStrBufPlain(NotifyHostsBuf, -1);
103 /* get all configured notifiers's */
104 for (notify=0; notify<num_notify; notify++) {
106 Host = GetNHBuf(notify * 2, 1, NotifyHostList);
107 StrBufExtract_NextToken(Host, NotifyBuf, &NextHost, '|');
109 pche = strchr(pchs, ':');
111 CtdlLogPrintf(CTDL_ERR,
112 __FILE__": filename not found in %s.\n",
116 File = GetNHBuf(notify * 2 + 1, 1, NotifyHostList);
117 StrBufPlain(File, pchs, pche - pchs);
118 StrBufCutLeft(Host, pche - pchs + 1);
120 return NotifyHostList;
124 /*! \brief Create the notify message queue. We use the exact same room
125 * as the Funambol module.
127 * Run at server startup, creates FNBL_QUEUE_ROOM if it doesn't exist
128 * and sets as system room.
130 void create_extnotify_queue(void) {
131 struct ctdlroom qrbuf;
133 create_room(FNBL_QUEUE_ROOM, 3, "", 0, 1, 0, VIEW_MAILBOX);
136 * Make sure it's set to be a "system room" so it doesn't show up
137 * in the <K>nown rooms list for Aides.
139 if (lgetroom(&qrbuf, FNBL_QUEUE_ROOM) == 0) {
140 qrbuf.QRflags2 |= QR2_SYSTEM;
145 * \brief Run through the pager room queue
147 void do_extnotify_queue(void)
150 static int doing_queue = 0;
154 * This is a simple concurrency check to make sure only one queue run
155 * is done at a time. We could do this with a mutex, but since we
156 * don't really require extremely fine granularity here, we'll do it
157 * with a static variable instead.
159 if (doing_queue) return;
163 * Go ahead and run the queue
165 CtdlLogPrintf(CTDL_DEBUG, "serv_extnotify: processing notify queue\n");
167 memset(&Ctx, 0, sizeof(NotifyContext));
168 Ctx.NotifyHostList = GetNotifyHosts();
169 if (getroom(&CC->room, FNBL_QUEUE_ROOM) != 0) {
170 CtdlLogPrintf(CTDL_ERR, "Cannot find room <%s>\n", FNBL_QUEUE_ROOM);
173 CtdlForEachMessage(MSGS_ALL, 0L, NULL,
174 SPOOLMIME, NULL, process_notify, &Ctx);
176 while ((Ctx.NotifyHostList != NULL) && (Ctx.NotifyHostList[i] != NULL))
177 FreeStrBuf(&Ctx.NotifyHostList[i]);
179 if (Ctx.NotifyErrors != NULL)
187 It = GetNewHashPos(Ctx.NotifyErrors, 0);
188 while (GetNextHashPos(Ctx.NotifyErrors, It, &len, &Key, &vErr) &&
190 ErrMsg = (StrBuf*) vErr;
191 quickie_message("Citadel", NULL, NULL, AIDEROOM, ChrPtr(ErrMsg), FMT_FIXED,
192 "Failed to notify external service about inbound mail");
196 DeleteHash(&Ctx.NotifyErrors);
199 CtdlLogPrintf(CTDL_DEBUG, "serv_extnotify: queue run completed\n");
203 * \brief Process messages in the external notification queue
205 void process_notify(long NotifyMsgnum, void *usrdata)
211 int extPagerAllowedHttp;
212 int extPagerAllowedSystem;
216 struct CtdlMessage *msg;
218 Ctx = (NotifyContext*) usrdata;
220 msg = CtdlFetchMessage(NotifyMsgnum, 1);
221 if ( msg->cm_fields['W'] == NULL) {
225 configMsgNum = extNotify_getConfigMessage(msg->cm_fields['W']);
227 extNotify_getPrefs(configMsgNum, &configMsg[0]);
230 * 1. The user has configured paging / They have and disabled it
231 * AND 2. There is an external pager program
232 * 3. A Funambol server has been entered
235 if ((configMsgNum == -1) ||
236 ((strncasecmp(configMsg, "none", 4) == 0) &&
237 IsEmptyStr(config.c_pager_program) &&
238 IsEmptyStr(config.c_funambol_host))) {
239 CtdlLogPrintf(CTDL_DEBUG, "No external notifiers configured on system/user");
243 // Can Funambol take the message?
244 pch = strchr(configMsg, '\n');
247 fnblAllowed = strncasecmp(configMsg, HKEY(FUNAMBOL_CONFIG_TEXT));
248 extPagerAllowedHttp = strncasecmp(configMsg, HKEY(PAGER_CONFIG_HTTP));
249 extPagerAllowedSystem = strncasecmp(configMsg, HKEY(PAGER_CONFIG_SYSTEM));
250 pch = strstr(msg->cm_fields['M'], "msgid|");
252 msgnum = atol(pch + sizeof("msgid"));
253 if (fnblAllowed == 0) {
255 snprintf(remoteurl, SIZ, "http://%s@%s:%d/%s",
256 config.c_funambol_auth,
257 config.c_funambol_host,
258 config.c_funambol_port,
260 notify_http_server(remoteurl,
262 strlen(file_funambol_msg),/*GNA*/
267 } else if (extPagerAllowedHttp == 0) {
272 StrBuf *FileBuf = NewStrBuf();
277 URL = GetNHBuf(i*2, 0, Ctx->NotifyHostList);
278 if (URL==NULL) break;
279 File = GetNHBuf(i*2 + 1, 0, Ctx->NotifyHostList);
280 if (File==NULL) break;
282 if (StrLength(File)>0)
283 StrBufPrintf(FileBuf, "%s/%s",
287 FlushStrBuf(FileBuf);
288 memcpy(URLBuf, ChrPtr(URL), StrLength(URL) + 1);
290 notify_http_server(URLBuf,
299 FreeStrBuf(&FileBuf);
301 else if (extPagerAllowedSystem == 0) {
306 number = strtok(configMsg, "textmessage\n");
307 commandSiz = sizeof(config.c_pager_program) + strlen(number) + strlen(msg->cm_fields['W']) + 5;
308 command = malloc(commandSiz);
309 snprintf(command, commandSiz, "%s %s -u %s", config.c_pager_program, number, msg->cm_fields['W']);
314 CtdlFreeMessage(msg);
315 memset(configMsg, 0, sizeof(configMsg));
316 todelete[0] = NotifyMsgnum;
317 CtdlDeleteMessages(FNBL_QUEUE_ROOM, todelete, 1, "");
320 /*! \brief Checks to see what notification option the user has set
323 void extNotify_getPrefs(long configMsgNum, char *configMsg)
325 struct CtdlMessage *prefMsg;
326 // Do a simple string search to see if 'funambol' is selected as the
327 // type. This string would be at the very top of the message contents.
328 if (configMsgNum == -1) {
329 CtdlLogPrintf(CTDL_ERR, "extNotify_isAllowedByPrefs was passed a non-existant config message id\n");
332 prefMsg = CtdlFetchMessage(configMsgNum, 1);
333 strncpy(configMsg, prefMsg->cm_fields['M'], strlen(prefMsg->cm_fields['M']));
334 CtdlFreeMessage(prefMsg);
337 /*! \brief Get configuration message for pager/funambol system from the
338 * users "My Citadel Config" room
340 long extNotify_getConfigMessage(char *username) {
341 struct ctdlroom qrbuf; // scratch for room
342 struct ctdluser user; // ctdl user instance
343 char configRoomName[ROOMNAMELEN];
344 struct CtdlMessage *msg;
345 struct cdbdata *cdbfr;
346 long *msglist = NULL;
348 long confMsgNum = -1;
352 getuser(&user, username);
354 MailboxName(configRoomName, sizeof configRoomName, &user, USERCONFIGROOM);
356 getroom(&qrbuf, configRoomName);
357 /* Do something really, really stoopid here. Raid the room on ourselves,
358 * loop through the messages manually and find it. I don't want
359 * to use a CtdlForEachMessage callback here, as we would be
361 cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf.QRnumber, sizeof(long));
363 msglist = (long *) cdbfr->ptr;
364 cdbfr->ptr = NULL; /* CtdlForEachMessage() now owns this memory */
365 num_msgs = cdbfr->len / sizeof(long);
368 CtdlLogPrintf(CTDL_DEBUG, "extNotify_getConfigMessage: No config messages found\n");
369 return -1; /* No messages at all? No further action. */
371 for (a = 0; a < num_msgs; ++a) {
372 msg = CtdlFetchMessage(msglist[a], 1);
374 if ((msg->cm_fields['U'] != NULL) &&
375 (strncasecmp(msg->cm_fields['U'], PAGER_CONFIG_MESSAGE,
376 strlen(PAGER_CONFIG_MESSAGE)) == 0)) {
377 confMsgNum = msglist[a];
379 CtdlFreeMessage(msg);
386 CTDL_MODULE_INIT(extnotify)
390 create_extnotify_queue();
391 CtdlRegisterSessionHook(do_extnotify_queue, EVT_TIMER);
393 /* return our Subversion id for the Log */