use an Enum for the cm_fields vector instead of nameless chars
[citadel.git] / citadel / journaling.c
1 /*
2  * Message journaling functions.
3  */
4
5 #include "sysdep.h"
6 #include <stdlib.h>
7 #include <unistd.h>
8 #include <stdio.h>
9 #include <fcntl.h>
10
11 #if TIME_WITH_SYS_TIME
12 # include <sys/time.h>
13 # include <time.h>
14 #else
15 # if HAVE_SYS_TIME_H
16 #  include <sys/time.h>
17 # else
18 #  include <time.h>
19 # endif
20 #endif
21
22
23 #include <ctype.h>
24 #include <string.h>
25 #include <limits.h>
26 #include <errno.h>
27 #include <stdarg.h>
28 #include <sys/stat.h>
29 #include <libcitadel.h>
30 #include "citadel.h"
31 #include "server.h"
32 #include "database.h"
33 #include "msgbase.h"
34 #include "support.h"
35 #include "sysdep_decls.h"
36 #include "citserver.h"
37 #include "room_ops.h"
38 #include "user_ops.h"
39 #include "file_ops.h"
40 #include "config.h"
41 #include "control.h"
42 #include "genstamp.h"
43 #include "internet_addressing.h"
44 #include "serv_vcard.h"                 /* Needed for vcard_getuser and extract_inet_email_addrs */
45 #include "journaling.h"
46
47 #include "ctdl_module.h"
48 #include "threads.h"
49
50 struct jnlq *jnlq = NULL;       /* journal queue */
51
52 /*
53  * Hand off a copy of a message to be journalized.
54  */
55 void JournalBackgroundSubmit(struct CtdlMessage *msg,
56                         StrBuf *saved_rfc822_version,
57                         struct recptypes *recps) {
58
59         struct jnlq *jptr = NULL;
60
61         /* Avoid double journaling! */
62         if (msg->cm_fields[eJournal] != NULL) {
63                 FreeStrBuf(&saved_rfc822_version);
64                 return;
65         }
66
67         jptr = (struct jnlq *)malloc(sizeof(struct jnlq));
68         if (jptr == NULL) {
69                 FreeStrBuf(&saved_rfc822_version);
70                 return;
71         }
72         memset(jptr, 0, sizeof(struct jnlq));
73         if (recps != NULL) memcpy(&jptr->recps, recps, sizeof(struct recptypes));
74         if (msg->cm_fields[eAuthor] != NULL) jptr->from = strdup(msg->cm_fields[eAuthor]);
75         if (msg->cm_fields[eNodeName] != NULL) jptr->node = strdup(msg->cm_fields[eNodeName]);
76         if (msg->cm_fields[erFc822Addr] != NULL) jptr->rfca = strdup(msg->cm_fields[erFc822Addr]);
77         if (msg->cm_fields[eMsgSubject] != NULL) jptr->subj = strdup(msg->cm_fields[eMsgSubject]);
78         if (msg->cm_fields[emessageId] != NULL) jptr->msgn = strdup(msg->cm_fields[emessageId]);
79         jptr->rfc822 = SmashStrBuf(&saved_rfc822_version);
80
81         /* Add to the queue */
82         begin_critical_section(S_JOURNAL_QUEUE);
83         jptr->next = jnlq;
84         jnlq = jptr;
85         end_critical_section(S_JOURNAL_QUEUE);
86 }
87
88
89 /*
90  * Convert a local user name to an internet email address for the journal
91  */
92  
93 /*
94  * TODODRW: change this into a CtdlModuleDo type function that returns alternative address info
95  * for this local user. Something like CtdlModuleGoGetAddr(char *localuser, int type, char *alt_addr, size_t alt_addr_len)
96  * where type can be ADDR_EMAIL, ADDR_FIDO, ADDR_UUCP, ADDR_WEB, ADDR_POSTAL etc etc.
97  * This then begs the question of what should be returned. Is it wise to return a single char* using a comma as a
98  * delimiter? Or would it be better to return a linked list of some kind?
99  */
100 void local_to_inetemail(char *inetemail, char *localuser, size_t inetemail_len) {
101         struct ctdluser us;
102         struct vCard *v;
103
104         strcpy(inetemail, "");
105         if (CtdlGetUser(&us, localuser) != 0) {
106                 return;
107         }
108
109         v = vcard_get_user(&us);
110         if (v == NULL) {
111                 return;
112         }
113
114         extract_inet_email_addrs(inetemail, inetemail_len, NULL, 0, v, 1);
115         vcard_free(v);
116 }
117
118
119 /*
120  * Called by JournalRunQueue() to send an individual message.
121  */
122 void JournalRunQueueMsg(struct jnlq *jmsg) {
123
124         struct CtdlMessage *journal_msg = NULL;
125         struct recptypes *journal_recps = NULL;
126         char *message_text = NULL;
127         char mime_boundary[256];
128         char recipient[256];
129         char inetemail[256];
130         static int seq = 0;
131         int i;
132
133         if (jmsg == NULL)
134                 return;
135         journal_recps = validate_recipients(config.c_journal_dest, NULL, 0);
136         if (journal_recps != NULL) {
137
138                 if (  (journal_recps->num_local > 0)
139                    || (journal_recps->num_internet > 0)
140                    || (journal_recps->num_ignet > 0)
141                    || (journal_recps->num_room > 0)
142                 ) {
143
144                         /*
145                          * Construct journal message.
146                          * Note that we are transferring ownership of some of the memory here.
147                          */
148                         journal_msg = malloc(sizeof(struct CtdlMessage));
149                         memset(journal_msg, 0, sizeof(struct CtdlMessage));
150                         journal_msg->cm_magic = CTDLMESSAGE_MAGIC;
151                         journal_msg->cm_anon_type = MES_NORMAL;
152                         journal_msg->cm_format_type = FMT_RFC822;
153                         journal_msg->cm_fields[eJournal] = strdup("is journal");
154                         journal_msg->cm_fields[eAuthor] = jmsg->from;
155                         journal_msg->cm_fields[eNodeName] = jmsg->node;
156                         journal_msg->cm_fields[erFc822Addr] = jmsg->rfca;
157                         journal_msg->cm_fields[eMsgSubject] = jmsg->subj;
158
159                         sprintf(mime_boundary, "--Citadel-Journal-%08lx-%04x--", time(NULL), ++seq);
160                         message_text = malloc(strlen(jmsg->rfc822) + sizeof(struct recptypes) + 1024);
161
162                         /*
163                          * Here is where we begin to compose the journalized message.
164                          * NOTE: the superfluous "Content-Identifer: ExJournalReport" header was
165                          *       requested by a paying customer, and yes, it is intentionally
166                          *       spelled wrong.  Do NOT remove or change it.
167                          */
168                         sprintf(message_text,
169                                 "Content-type: multipart/mixed; boundary=\"%s\"\r\n"
170                                 "Content-Identifer: ExJournalReport\r\n"
171                                 "MIME-Version: 1.0\r\n"
172                                 "\n"
173                                 "--%s\r\n"
174                                 "Content-type: text/plain\r\n"
175                                 "\r\n"
176                                 "Sender: %s "
177                         ,
178                                 mime_boundary,
179                                 mime_boundary,
180                                 ( journal_msg->cm_fields[eAuthor] ? journal_msg->cm_fields[eAuthor] : "(null)" )
181                         );
182
183                         if (journal_msg->cm_fields[erFc822Addr]) {
184                                 sprintf(&message_text[strlen(message_text)], "<%s>",
185                                         journal_msg->cm_fields[erFc822Addr]);
186                         }
187                         else if (journal_msg->cm_fields[eNodeName]) {
188                                 sprintf(&message_text[strlen(message_text)], "@ %s",
189                                         journal_msg->cm_fields[eNodeName]);
190                         }
191
192                         sprintf(&message_text[strlen(message_text)],
193                                 "\r\n"
194                                 "Message-ID: <%s>\r\n"
195                                 "Recipients:\r\n"
196                         ,
197                                 jmsg->msgn
198                         );
199
200                         if (jmsg->recps.num_local > 0) {
201                                 for (i=0; i<jmsg->recps.num_local; ++i) {
202                                         extract_token(recipient, jmsg->recps.recp_local,
203                                                         i, '|', sizeof recipient);
204                                         local_to_inetemail(inetemail, recipient, sizeof inetemail);
205                                         sprintf(&message_text[strlen(message_text)],
206                                                 "       %s <%s>\r\n", recipient, inetemail);
207                                 }
208                         }
209
210                         if (jmsg->recps.num_ignet > 0) {
211                                 for (i=0; i<jmsg->recps.num_ignet; ++i) {
212                                         extract_token(recipient, jmsg->recps.recp_ignet,
213                                                         i, '|', sizeof recipient);
214                                         sprintf(&message_text[strlen(message_text)],
215                                                 "       %s\r\n", recipient);
216                                 }
217                         }
218
219                         if (jmsg->recps.num_internet > 0) {
220                                 for (i=0; i<jmsg->recps.num_internet; ++i) {
221                                         extract_token(recipient, jmsg->recps.recp_internet,
222                                                         i, '|', sizeof recipient);
223                                         sprintf(&message_text[strlen(message_text)],
224                                                 "       %s\r\n", recipient);
225                                 }
226                         }
227
228                         sprintf(&message_text[strlen(message_text)],
229                                 "\r\n"
230                                 "--%s\r\n"
231                                 "Content-type: message/rfc822\r\n"
232                                 "\r\n"
233                                 "%s"
234                                 "--%s--\r\n"
235                         ,
236                                 mime_boundary,
237                                 jmsg->rfc822,
238                                 mime_boundary
239                         );
240
241                         journal_msg->cm_fields[eMesageText] = message_text;
242                         free(jmsg->rfc822);
243                         free(jmsg->msgn);
244                         
245                         /* Submit journal message */
246                         CtdlSubmitMsg(journal_msg, journal_recps, "", 0);
247                         CtdlFreeMessage(journal_msg);
248                 }
249
250                 free_recipients(journal_recps);
251         }
252
253         /* We are responsible for freeing this memory. */
254         free(jmsg);
255 }
256
257
258 /*
259  * Run the queue.
260  */
261 void JournalRunQueue(void) {
262         struct jnlq *jptr = NULL;
263
264         while (jnlq != NULL) {
265                 begin_critical_section(S_JOURNAL_QUEUE);
266                 if (jnlq != NULL) {
267                         jptr = jnlq;
268                         jnlq = jnlq->next;
269                 }
270                 end_critical_section(S_JOURNAL_QUEUE);
271                 JournalRunQueueMsg(jptr);
272         }
273 }
274
275