2 * Display the outbound SMTP queue
6 CtxType CTX_MAILQITEM = CTX_NONE;
7 CtxType CTX_MAILQ_RCPT = CTX_NONE;
8 HashList *QItemHandlers = NULL;
12 typedef struct _mailq_entry {
14 StrBuf *StatusMessage;
17 * 0 = No delivery has yet been attempted
18 * 2 = Delivery was successful
19 * 3 = Transient error like connection problem. Try next remote if available.
20 * 4 = A transient error was experienced ... try again later
21 * 5 = Delivery to this address failed permanently. The error message
22 * should be placed in the fourth field so that a bounce message may
30 typedef struct queueitem {
35 HashList *MailQEntries;
36 /* copy of the currently parsed item in the MailQEntries list;
37 * if null add a new one.
43 long ActiveDeliveries;
48 ParsedURL *FallBackHost;
52 typedef void (*QItemHandler)(OneQueItem *Item, StrBuf *Line, const char **Pos);
54 typedef struct __QItemHandlerStruct {
58 void RegisterQItemHandler(const char *Key, long Len, QItemHandler H)
60 QItemHandlerStruct *HS = (QItemHandlerStruct*)malloc(sizeof(QItemHandlerStruct));
62 Put(QItemHandlers, Key, Len, HS, NULL);
65 void FreeMailQEntry(void *qv)
68 FreeStrBuf(&Q->Recipient);
69 FreeStrBuf(&Q->StatusMessage);
72 void FreeQueItem(OneQueItem **Item)
74 DeleteHash(&(*Item)->MailQEntries);
75 FreeStrBuf(&(*Item)->EnvelopeFrom);
76 FreeStrBuf(&(*Item)->BounceTo);
77 FreeStrBuf(&(*Item)->SenderRoom);
78 FreeURL(&(*Item)->URL);
82 void HFreeQueItem(void *Item)
84 FreeQueItem((OneQueItem**)&Item);
88 OneQueItem *DeserializeQueueItem(StrBuf *RawQItem, long QueMsgID)
91 const char *pLine = NULL;
95 Item = (OneQueItem*)malloc(sizeof(OneQueItem));
96 memset(Item, 0, sizeof(OneQueItem));
99 Item->QueMsgID = QueMsgID;
102 Line = NewStrBufPlain(NULL, 128);
103 while (pLine != StrBufNOTNULL) {
104 const char *pItemPart = NULL;
107 StrBufExtract_NextToken(Line, RawQItem, &pLine, '\n');
108 if (StrLength(Line) == 0) continue;
109 StrBufExtract_NextToken(Token, Line, &pItemPart, '|');
110 if (GetHash(QItemHandlers, SKEY(Token), &vHandler))
112 QItemHandlerStruct *HS;
113 HS = (QItemHandlerStruct*) vHandler;
114 HS->H(Item, Line, &pItemPart);
121 LKEY(Item->MessageID),
129 void tmplput_MailQID(StrBuf *Target, WCTemplputParams *TP)
131 OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
132 StrBufAppendPrintf(Target, "%ld", Item->QueMsgID);;
134 void tmplput_MailQPayloadID(StrBuf *Target, WCTemplputParams *TP)
136 OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
137 StrBufAppendPrintf(Target, "%ld", Item->MessageID);
139 void tmplput_MailQBounceTo(StrBuf *Target, WCTemplputParams *TP)
141 OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
142 StrBufAppendTemplate(Target, TP, Item->BounceTo, 0);
144 void tmplput_MailQAttempted(StrBuf *Target, WCTemplputParams *TP)
147 OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
148 webcit_fmt_date(datebuf, 64, Item->ReattemptWhen, DATEFMT_BRIEF);
149 StrBufAppendBufPlain(Target, datebuf, -1, 0);
151 void tmplput_MailQSubmitted(StrBuf *Target, WCTemplputParams *TP)
154 OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
155 webcit_fmt_date(datebuf, 64, Item->Submitted, DATEFMT_BRIEF);
156 StrBufAppendBufPlain(Target, datebuf, -1, 0);
158 void tmplput_MailQEnvelopeFrom(StrBuf *Target, WCTemplputParams *TP)
160 OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
161 StrBufAppendTemplate(Target, TP, Item->EnvelopeFrom, 0);
163 void tmplput_MailQSourceRoom(StrBuf *Target, WCTemplputParams *TP)
165 OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
166 StrBufAppendTemplate(Target, TP, Item->SenderRoom, 0);
169 int Conditional_MailQ_HaveSourceRoom(StrBuf *Target, WCTemplputParams *TP)
171 OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
172 return StrLength(Item->SenderRoom) > 0;
175 void tmplput_MailQRetry(StrBuf *Target, WCTemplputParams *TP)
178 OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
180 if (Item->Retry == 0) {
181 StrBufAppendBufPlain(Target, _("First Attempt pending"), -1, 0);
184 webcit_fmt_date(datebuf, sizeof(datebuf), Item->Retry, DATEFMT_BRIEF);
185 StrBufAppendBufPlain(Target, datebuf, -1, 0);
189 void tmplput_MailQRCPT(StrBuf *Target, WCTemplputParams *TP)
191 MailQEntry *Entry = (MailQEntry*) CTX(CTX_MAILQ_RCPT);
192 StrBufAppendTemplate(Target, TP, Entry->Recipient, 0);
194 void tmplput_MailQRCPTStatus(StrBuf *Target, WCTemplputParams *TP)
196 MailQEntry *Entry = (MailQEntry*) CTX(CTX_MAILQ_RCPT);
197 StrBufAppendPrintf(Target, "%ld", Entry->Status);
199 void tmplput_MailQStatusMsg(StrBuf *Target, WCTemplputParams *TP)
201 MailQEntry *Entry = (MailQEntry*) CTX(CTX_MAILQ_RCPT);
202 StrBufAppendTemplate(Target, TP, Entry->StatusMessage, 0);
205 HashList *iterate_get_Recipients(StrBuf *Target, WCTemplputParams *TP)
207 OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
208 return Item->MailQEntries;
212 void NewMailQEntry(OneQueItem *Item)
214 Item->Current = (MailQEntry*) malloc(sizeof(MailQEntry));
215 memset(Item->Current, 0, sizeof(MailQEntry));
217 if (Item->MailQEntries == NULL)
218 Item->MailQEntries = NewHash(1, Flathash);
219 Item->Current->StatusMessage = NewStrBuf();
220 Item->Current->n = GetCount(Item->MailQEntries);
221 Put(Item->MailQEntries,
222 IKEY(Item->Current->n),
227 void QItem_Handle_MsgID(OneQueItem *Item, StrBuf *Line, const char **Pos)
229 Item->MessageID = StrBufExtractNext_long(Line, Pos, '|');
232 void QItem_Handle_EnvelopeFrom(OneQueItem *Item, StrBuf *Line, const char **Pos)
234 if (Item->EnvelopeFrom == NULL)
235 Item->EnvelopeFrom = NewStrBufPlain(NULL, StrLength(Line));
236 StrBufExtract_NextToken(Item->EnvelopeFrom, Line, Pos, '|');
239 void QItem_Handle_BounceTo(OneQueItem *Item, StrBuf *Line, const char **Pos)
241 if (Item->BounceTo == NULL)
242 Item->BounceTo = NewStrBufPlain(NULL, StrLength(Line));
243 StrBufExtract_NextToken(Item->BounceTo, Line, Pos, '|');
246 void QItem_Handle_SenderRoom(OneQueItem *Item, StrBuf *Line, const char **Pos)
248 if (Item->SenderRoom == NULL)
249 Item->SenderRoom = NewStrBufPlain(NULL, StrLength(Line));
250 StrBufExtract_NextToken(Item->SenderRoom, Line, Pos, '|');
253 void QItem_Handle_Recipient(OneQueItem *Item, StrBuf *Line, const char **Pos)
256 if (Item->Current == NULL)
258 if (Item->Current->Recipient == NULL)
259 Item->Current->Recipient=NewStrBufPlain(NULL, StrLength(Line));
260 StrBufExtract_NextToken(Item->Current->Recipient, Line, Pos, '|');
261 Item->Current->Status = StrBufExtractNext_int(Line, Pos, '|');
262 StrBufExtract_NextToken(Item->Current->StatusMessage, Line, Pos, '|');
264 pch = ChrPtr(Item->Current->StatusMessage);
265 while ((pch != NULL) && (*pch != '\0')) {
266 pch = strchr(pch, ';');
270 StrBufPeek(Item->Current->StatusMessage,
275 Item->Current = NULL; // TODO: is this always right?
279 void QItem_Handle_retry(OneQueItem *Item, StrBuf *Line, const char **Pos)
281 Item->Retry = StrBufExtractNext_int(Line, Pos, '|');
285 void QItem_Handle_Submitted(OneQueItem *Item, StrBuf *Line, const char **Pos)
287 Item->Submitted = atol(*Pos);
291 void QItem_Handle_Attempted(OneQueItem *Item, StrBuf *Line, const char **Pos)
293 Item->ReattemptWhen = StrBufExtractNext_int(Line, Pos, '|');
303 void render_QUEUE(wc_mime_attachment *Mime, StrBuf *RawData, StrBuf *FoundCharset)
305 WCTemplputParams SubTP;
307 memset(&SubTP, 0, sizeof(WCTemplputParams));
308 SubTP.Filter.ContextType = CTX_MAILQITEM;
309 SubTP.Context = DeserializeQueueItem(Mime->Data, Mime->msgnum);
310 DoTemplate(HKEY("view_mailq_message"),NULL, &SubTP);
311 FreeQueItem ((OneQueItem**)&SubTP.Context);
315 ServerShutdownModule_SMTP_QUEUE
318 DeleteHash(&QItemHandlers);
321 ServerStartModule_SMTP_QUEUE
324 QItemHandlers = NewHash(0, NULL);
327 int qview_PrintPageHeader(SharedMessageStatus *Stat, void **ViewSpecific)
329 if (yesbstr("ListOnly"))
330 output_headers(1, 0, 0, 0, 0, 0);
332 output_headers(1, 1, 1, 0, 0, 0);
336 int qview_GetParamsGetServerCall(SharedMessageStatus *Stat,
346 DoTemplate(HKEY("aide_required"), NULL, NULL);
352 snprintf(cmd, len, "MSGS ALL|0|1");
353 snprintf(filter, flen, "SUBJ|QMSG");
354 if (yesbstr("ListOnly"))
355 DoTemplate(HKEY("view_mailq_table"), NULL, NULL);
357 DoTemplate(HKEY("view_mailq_header"), NULL, NULL);
365 int qview_LoadMsgFromServer(SharedMessageStatus *Stat,
367 message_summary* Msg,
374 /* Not (yet?) needed here? calview *c = (calview *) *ViewSpecific; */
375 read_message(WCC->WBuf, HKEY("view_mailq_message_bearer"), Msg->msgnum, NULL, &Mime);
381 int qview_RenderView_or_Tail(SharedMessageStatus *Stat,
386 WCTemplputParams SubTP;
388 if (yesbstr("ListOnly"))
389 DoTemplate(HKEY("view_mailq_footer_listonly"),NULL, &SubTP);
392 if (GetCount(WCC->summ) == 0)
393 DoTemplate(HKEY("view_mailq_footer_empty"),NULL, &SubTP);
395 DoTemplate(HKEY("view_mailq_footer"),NULL, &SubTP);
400 int qview_Cleanup(void **ViewSpecific)
403 wDumpContent(yesbstr("ListOnly")?0:1);
408 InitModule_SMTP_QUEUE
411 RegisterCTX(CTX_MAILQITEM);
412 RegisterCTX(CTX_MAILQ_RCPT);
414 RegisterQItemHandler(HKEY("msgid"), QItem_Handle_MsgID);
415 RegisterQItemHandler(HKEY("envelope_from"), QItem_Handle_EnvelopeFrom);
416 RegisterQItemHandler(HKEY("retry"), QItem_Handle_retry);
417 RegisterQItemHandler(HKEY("attempted"), QItem_Handle_Attempted);
418 RegisterQItemHandler(HKEY("remote"), QItem_Handle_Recipient);
419 RegisterQItemHandler(HKEY("bounceto"), QItem_Handle_BounceTo);
420 RegisterQItemHandler(HKEY("source_room"), QItem_Handle_SenderRoom);
421 RegisterQItemHandler(HKEY("submitted"), QItem_Handle_Submitted);
422 RegisterMimeRenderer(HKEY("application/x-citadel-delivery-list"), render_QUEUE, 1, 9000);
423 RegisterNamespace("MAILQ:ID", 0, 0, tmplput_MailQID, NULL, CTX_MAILQITEM);
424 RegisterNamespace("MAILQ:PAYLOAD:ID", 0, 0, tmplput_MailQPayloadID, NULL, CTX_MAILQITEM);
425 RegisterNamespace("MAILQ:BOUNCETO", 0, 1, tmplput_MailQBounceTo, NULL, CTX_MAILQITEM);
426 RegisterNamespace("MAILQ:ATTEMPTED", 0, 0, tmplput_MailQAttempted, NULL, CTX_MAILQITEM);
427 RegisterNamespace("MAILQ:SUBMITTED", 0, 0, tmplput_MailQSubmitted, NULL, CTX_MAILQITEM);
428 RegisterNamespace("MAILQ:ENVELOPEFROM", 0, 1, tmplput_MailQEnvelopeFrom, NULL, CTX_MAILQITEM);
429 RegisterNamespace("MAILQ:SRCROOM", 0, 1, tmplput_MailQSourceRoom, NULL, CTX_MAILQITEM);
430 RegisterConditional(HKEY("COND:MAILQ:HAVESRCROOM"), 0, Conditional_MailQ_HaveSourceRoom, CTX_MAILQITEM);
431 RegisterNamespace("MAILQ:RETRY", 0, 0, tmplput_MailQRetry, NULL, CTX_MAILQITEM);
433 RegisterNamespace("MAILQ:RCPT:ADDR", 0, 1, tmplput_MailQRCPT, NULL, CTX_MAILQ_RCPT);
434 RegisterNamespace("MAILQ:RCPT:STATUS", 0, 0, tmplput_MailQRCPTStatus, NULL, CTX_MAILQ_RCPT);
435 RegisterNamespace("MAILQ:RCPT:STATUSMSG", 0, 1, tmplput_MailQStatusMsg, NULL, CTX_MAILQ_RCPT);
437 RegisterIterator("MAILQ:RCPT", 0, NULL, iterate_get_Recipients,
438 NULL, NULL, CTX_MAILQ_RCPT, CTX_MAILQITEM, IT_NOFLAG);
441 RegisterReadLoopHandlerset(
443 qview_GetParamsGetServerCall,
444 qview_PrintPageHeader,
445 NULL, /* TODO: is this right? */
447 qview_LoadMsgFromServer,
448 qview_RenderView_or_Tail,