* add webcit database message ID to the notification template.
[citadel.git] / citadel / modules / extnotify / extnotify_main.c
1 /*
2  * \file extnotify_main.c
3  * @author Mathew McBride
4  *
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>
9  */
10
11 #include "sysdep.h"
12 #include <stdlib.h>
13 #include <unistd.h>
14 #include <stdio.h>
15 #include <fcntl.h>
16 #include <signal.h>
17 #include <pwd.h>
18 #include <errno.h>
19 #include <sys/types.h>
20
21 #if TIME_WITH_SYS_TIME
22 # include <sys/time.h>
23 # include <time.h>
24 #else
25 # if HAVE_SYS_TIME_H
26 #  include <sys/time.h>
27 # else
28 #  include <time.h>
29 # endif
30 #endif
31
32 #include <sys/wait.h>
33 #include <string.h>
34 #include <limits.h>
35 #include <sys/socket.h>
36 #include <libcitadel.h>
37 #include "citadel.h"
38 #include "server.h"
39 #include "citserver.h"
40 #include "support.h"
41 #include "config.h"
42 #include "control.h"
43 #include "room_ops.h"
44 #include "user_ops.h"
45 #include "policy.h"
46 #include "database.h"
47 #include "msgbase.h"
48 #include "internet_addressing.h"
49 #include "domain.h"
50 #include "clientsocket.h"
51 #include "extnotify.h"
52
53 #include "ctdl_module.h"
54
55 /*! \brief Create the notify message queue. We use the exact same room
56  *                      as the Funambol module.
57  *
58  *      Run at server startup, creates FNBL_QUEUE_ROOM if it doesn't exist
59  *      and sets as system room.
60  */
61 void create_extnotify_queue(void) {
62     struct ctdlroom qrbuf;
63     
64     create_room(FNBL_QUEUE_ROOM, 3, "", 0, 1, 0, VIEW_MAILBOX);
65     
66     /*
67      * Make sure it's set to be a "system room" so it doesn't show up
68      * in the <K>nown rooms list for Aides.
69      */
70     if (lgetroom(&qrbuf, FNBL_QUEUE_ROOM) == 0) {
71         qrbuf.QRflags2 |= QR2_SYSTEM;
72         lputroom(&qrbuf);
73     }
74 }
75 /*!
76  * \brief Run through the pager room queue
77  */
78 void do_extnotify_queue(void) {
79     static int doing_queue = 0;
80     
81     /*
82      * This is a simple concurrency check to make sure only one queue run
83      * is done at a time.  We could do this with a mutex, but since we
84      * don't really require extremely fine granularity here, we'll do it
85      * with a static variable instead.
86      */
87     if (doing_queue) return;
88     doing_queue = 1;
89     
90     /*
91      * Go ahead and run the queue
92      */
93     CtdlLogPrintf(CTDL_DEBUG, "serv_extnotify: processing notify queue\n");
94     
95     if (getroom(&CC->room, FNBL_QUEUE_ROOM) != 0) {
96         CtdlLogPrintf(CTDL_ERR, "Cannot find room <%s>\n", FNBL_QUEUE_ROOM);
97         return;
98     }
99     CtdlForEachMessage(MSGS_ALL, 0L, NULL,
100             SPOOLMIME, NULL, process_notify, NULL);
101     
102     CtdlLogPrintf(CTDL_DEBUG, "serv_extnotify: queue run completed\n");
103     doing_queue = 0;
104 }
105 /*!
106  * \brief Process messages in the external notification queue
107  */
108 void process_notify(long msgnum, void *usrdata) {
109     struct CtdlMessage *msg;
110     msg = CtdlFetchMessage(msgnum, 1);
111     if ( msg->cm_fields['W'] == NULL) {
112         goto nuke;
113     }
114     
115     long configMsgNum = extNotify_getConfigMessage(msg->cm_fields['W']);
116     char configMsg[SIZ];
117     
118     extNotify_getPrefs(configMsgNum, &configMsg[0]);
119     
120     /* Check to see if:
121      * 1. The user has configured paging / They have and disabled it
122      * AND 2. There is an external pager program
123      * 3. A Funambol server has been entered
124      *
125      */
126     if ((configMsgNum == -1) || 
127         ((strncasecmp(configMsg, "none", 4) == 0) &&
128          IsEmptyStr(config.c_pager_program) && 
129          IsEmptyStr(config.c_funambol_host))) {
130         CtdlLogPrintf(CTDL_DEBUG, "No external notifiers configured on system/user");
131         goto nuke;
132     }
133     // Can Funambol take the message?
134     int fnblAllowed = strncasecmp(configMsg, FUNAMBOL_CONFIG_TEXT, strlen(FUNAMBOL_CONFIG_TEXT));
135     int extPagerAllowed = strncasecmp(configMsg, PAGER_CONFIG_TEXT, strlen(PAGER_CONFIG_TEXT)); 
136     if (fnblAllowed == 0) {
137             notify_funambol_server(msg->cm_fields['W'], 
138                                    msg->cm_fields['I'],
139                                    msgnum);
140     } else if (extPagerAllowed == 0) {
141             char *number = strtok(configMsg, "textmessage\n");
142             int commandSiz = sizeof(config.c_pager_program) + strlen(number) + strlen(msg->cm_fields['W']) + 5;
143             char *command = malloc(commandSiz);
144             snprintf(command, commandSiz, "%s %s -u %s", config.c_pager_program, number, msg->cm_fields['W']);
145             system(command);
146             free(command);
147     }
148 nuke:
149     CtdlFreeMessage(msg);
150     memset(configMsg, 0, sizeof(configMsg));
151     long todelete[1];
152     todelete[0] = msgnum;
153     CtdlDeleteMessages(FNBL_QUEUE_ROOM, todelete, 1, "");
154 }
155
156 /*! \brief Checks to see what notification option the user has set
157  *
158  */
159 void extNotify_getPrefs(long configMsgNum, char *configMsg) {
160     // Do a simple string search to see if 'funambol' is selected as the
161     // type. This string would be at the very top of the message contents.
162     if (configMsgNum == -1) {
163         CtdlLogPrintf(CTDL_ERR, "extNotify_isAllowedByPrefs was passed a non-existant config message id\n");
164         return;
165     }
166     struct CtdlMessage *prefMsg;
167     prefMsg = CtdlFetchMessage(configMsgNum, 1);
168     strncpy(configMsg, prefMsg->cm_fields['M'], strlen(prefMsg->cm_fields['M']));
169     CtdlFreeMessage(prefMsg);
170 }
171 /*! \brief Get configuration message for pager/funambol system from the
172  *                      users "My Citadel Config" room
173  */
174 long extNotify_getConfigMessage(char *username) {
175     struct ctdlroom qrbuf; // scratch for room
176     struct ctdluser user; // ctdl user instance
177     char configRoomName[ROOMNAMELEN];
178     struct CtdlMessage *msg;
179     struct cdbdata *cdbfr;
180     long *msglist = NULL;
181     int num_msgs = 0;
182     long confMsgNum = -1;
183     // Get the user
184     getuser(&user, username);
185     
186     MailboxName(configRoomName, sizeof configRoomName, &user, USERCONFIGROOM);
187     // Fill qrbuf
188     getroom(&qrbuf, configRoomName);
189     /* Do something really, really stoopid here. Raid the room on ourselves,
190      * loop through the messages manually and find it. I don't want
191      * to use a CtdlForEachMessage callback here, as we would be
192      * already in one */
193     cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf.QRnumber, sizeof(long));
194     if (cdbfr != NULL) {
195         msglist = (long *) cdbfr->ptr;
196         cdbfr->ptr = NULL;      /* CtdlForEachMessage() now owns this memory */
197         num_msgs = cdbfr->len / sizeof(long);
198         cdb_free(cdbfr);
199     } else {
200         CtdlLogPrintf(CTDL_DEBUG, "extNotify_getConfigMessage: No config messages found\n");
201         return -1;      /* No messages at all?  No further action. */
202     }
203     int a;
204     for (a = 0; a < num_msgs; ++a) {
205         msg = CtdlFetchMessage(msglist[a], 1);
206         if (msg != NULL) {
207             if (msg->cm_fields['U'] != NULL && strncasecmp(msg->cm_fields['U'], PAGER_CONFIG_MESSAGE,
208                     strlen(PAGER_CONFIG_MESSAGE)) == 0) {
209                 confMsgNum = msglist[a];
210             }
211             CtdlFreeMessage(msg);
212         }
213     }
214     return confMsgNum;
215     
216 }
217 CTDL_MODULE_INIT(extnotify)
218 {
219         if (!threading)
220         {
221                 create_extnotify_queue();
222                 CtdlRegisterSessionHook(do_extnotify_queue, EVT_TIMER);
223         }
224         /* return our Subversion id for the Log */
225         return "$Id$";
226 }