/*
- * $Id: $
+ * Display the outbound SMTP queue
*/
-/**
- * \defgroup SMTPqueue Display the outbound SMTP queue
- * \ingroup CitadelConfig
- */
-/*@{*/
+
#include "webcit.h"
+CtxType CTX_MAILQITEM = CTX_NONE;
+CtxType CTX_MAILQ_RCPT = CTX_NONE;
+HashList *QItemHandlers = NULL;
+
+
+
+typedef struct _mailq_entry {
+ StrBuf *Recipient;
+ StrBuf *StatusMessage;
+ int Status;
+ /**<
+ * 0 = No delivery has yet been attempted
+ * 2 = Delivery was successful
+ * 3 = Transient error like connection problem. Try next remote if available.
+ * 4 = A transient error was experienced ... try again later
+ * 5 = Delivery to this address failed permanently. The error message
+ * should be placed in the fourth field so that a bounce message may
+ * be generated.
+ */
-/**
- * \brief display one message in the queue
+ int n;
+ int Active;
+}MailQEntry;
+
+typedef struct queueitem {
+ long MessageID;
+ long QueMsgID;
+ long Submitted;
+ int FailNow;
+ HashList *MailQEntries;
+/* copy of the currently parsed item in the MailQEntries list;
+ * if null add a new one.
*/
-void display_queue_msg(long msgnum)
-{
- char buf[1024];
- char keyword[32];
- int in_body = 0;
- int is_delivery_list = 0;
- time_t submitted = 0;
- time_t attempted = 0;
- time_t last_attempt = 0;
- int number_of_attempts = 0;
- char sender[256];
- char recipients[65536];
- char thisrecp[256];
- char thisdsn[256];
-
- strcpy(sender, "");
- strcpy(recipients, "");
-
- serv_printf("MSG2 %ld", msgnum);
- serv_getln(buf, sizeof buf);
- if (buf[0] != '1') return;
-
- while (serv_getln(buf, sizeof buf), strcmp(buf, "000")) {
-
- if (strlen(buf) > 0) {
- if (buf[strlen(buf)-1] == 13) {
- buf[strlen(buf)-1] = 0;
- }
- }
+ MailQEntry *Current;
+ time_t ReattemptWhen;
+ time_t Retry;
- if ( (strlen(buf) == 0) && (in_body == 0) ) {
- in_body = 1;
- }
+ long ActiveDeliveries;
+ StrBuf *EnvelopeFrom;
+ StrBuf *BounceTo;
+ StrBuf *SenderRoom;
+ ParsedURL *URL;
+ ParsedURL *FallBackHost;
+} OneQueItem;
- if ( (!in_body)
- && (!strncasecmp(buf, "Content-type: application/x-citadel-delivery-list", 49))
- ) {
- is_delivery_list = 1;
- }
- if ( (in_body) && (!is_delivery_list) ) {
- while (serv_getln(buf, sizeof buf), strcmp(buf, "000")) {
- /* Not a delivery list; flush and return quietly. */
- }
- return;
- }
-
- if ( (in_body) && (is_delivery_list) ) {
- extract_token(keyword, buf, 0, '|', sizeof keyword);
+typedef void (*QItemHandler)(OneQueItem *Item, StrBuf *Line, const char **Pos);
- if (!strcasecmp(keyword, "submitted")) {
- submitted = extract_long(buf, 1);
- }
+typedef struct __QItemHandlerStruct {
+ QItemHandler H;
+} QItemHandlerStruct;
- if (!strcasecmp(keyword, "attempted")) {
- attempted = extract_long(buf, 1);
- ++number_of_attempts;
- if (attempted > last_attempt) {
- last_attempt = attempted;
- }
- }
-
- if (!strcasecmp(keyword, "bounceto")) {
- extract_token(sender, buf, 1, '|', sizeof sender);
- }
+void RegisterQItemHandler(const char *Key, long Len, QItemHandler H)
+{
+ QItemHandlerStruct *HS = (QItemHandlerStruct*)malloc(sizeof(QItemHandlerStruct));
+ HS->H = H;
+ Put(QItemHandlers, Key, Len, HS, NULL);
+}
- if (!strcasecmp(keyword, "remote")) {
- extract_token(thisrecp, buf, 1, '|', sizeof thisrecp);
- extract_token(thisdsn, buf, 3, '|', sizeof thisdsn);
-
- if (strlen(recipients) + strlen(thisrecp) + strlen(thisdsn) + 100
- < sizeof recipients) {
- if (strlen(recipients) > 0) {
- strcat(recipients, "<br />");
- }
- stresc(&recipients[strlen(recipients)], thisrecp, 1, 1);
- strcat(recipients, "<br /> <i>");
- stresc(&recipients[strlen(recipients)], thisdsn, 1, 1);
- strcat(recipients, "</i>");
- }
+void FreeMailQEntry(void *qv)
+{
+ MailQEntry *Q = qv;
+ FreeStrBuf(&Q->Recipient);
+ FreeStrBuf(&Q->StatusMessage);
+ free(Q);
+}
+void FreeQueItem(OneQueItem **Item)
+{
+ DeleteHash(&(*Item)->MailQEntries);
+ FreeStrBuf(&(*Item)->EnvelopeFrom);
+ FreeStrBuf(&(*Item)->BounceTo);
+ FreeStrBuf(&(*Item)->SenderRoom);
+ FreeURL(&(*Item)->URL);
+ free(*Item);
+ Item = NULL;
+}
+void HFreeQueItem(void *Item)
+{
+ FreeQueItem((OneQueItem**)&Item);
+}
- }
+OneQueItem *DeserializeQueueItem(StrBuf *RawQItem, long QueMsgID)
+{
+ OneQueItem *Item;
+ const char *pLine = NULL;
+ StrBuf *Line;
+ StrBuf *Token;
+
+ Item = (OneQueItem*)malloc(sizeof(OneQueItem));
+ memset(Item, 0, sizeof(OneQueItem));
+ Item->Retry = 0;
+ Item->MessageID = -1;
+ Item->QueMsgID = QueMsgID;
+
+ Token = NewStrBuf();
+ Line = NewStrBufPlain(NULL, 128);
+ while (pLine != StrBufNOTNULL) {
+ const char *pItemPart = NULL;
+ void *vHandler;
+
+ StrBufExtract_NextToken(Line, RawQItem, &pLine, '\n');
+ if (StrLength(Line) == 0) continue;
+ StrBufExtract_NextToken(Token, Line, &pItemPart, '|');
+ if (GetHash(QItemHandlers, SKEY(Token), &vHandler))
+ {
+ QItemHandlerStruct *HS;
+ HS = (QItemHandlerStruct*) vHandler;
+ HS->H(Item, Line, &pItemPart);
}
-
}
+ FreeStrBuf(&Line);
+ FreeStrBuf(&Token);
+/*
+ Put(ActiveQItems,
+ LKEY(Item->MessageID),
+ Item,
+ HFreeQueItem);
+*/
+
+ return Item;
+}
+
+void tmplput_MailQID(StrBuf *Target, WCTemplputParams *TP)
+{
+ OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
+ StrBufAppendPrintf(Target, "%ld", Item->QueMsgID);;
+}
+void tmplput_MailQPayloadID(StrBuf *Target, WCTemplputParams *TP)
+{
+ OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
+ StrBufAppendPrintf(Target, "%ld", Item->MessageID);
+}
+void tmplput_MailQBounceTo(StrBuf *Target, WCTemplputParams *TP)
+{
+ OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
+ StrBufAppendTemplate(Target, TP, Item->BounceTo, 0);
+}
+void tmplput_MailQAttempted(StrBuf *Target, WCTemplputParams *TP)
+{
+ char datebuf[64];
+ OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
+ webcit_fmt_date(datebuf, 64, Item->ReattemptWhen, DATEFMT_BRIEF);
+ StrBufAppendBufPlain(Target, datebuf, -1, 0);
+}
+void tmplput_MailQSubmitted(StrBuf *Target, WCTemplputParams *TP)
+{
+ char datebuf[64];
+ OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
+ webcit_fmt_date(datebuf, 64, Item->Submitted, DATEFMT_BRIEF);
+ StrBufAppendBufPlain(Target, datebuf, -1, 0);
+}
+void tmplput_MailQEnvelopeFrom(StrBuf *Target, WCTemplputParams *TP)
+{
+ OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
+ StrBufAppendTemplate(Target, TP, Item->EnvelopeFrom, 0);
+}
+void tmplput_MailQSourceRoom(StrBuf *Target, WCTemplputParams *TP)
+{
+ OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
+ StrBufAppendTemplate(Target, TP, Item->SenderRoom, 0);
+}
- wprintf("<tr><td>");
- wprintf("%ld", msgnum);
+int Conditional_MailQ_HaveSourceRoom(StrBuf *Target, WCTemplputParams *TP)
+{
+ OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
+ return StrLength(Item->SenderRoom) > 0;
+}
- wprintf("</td><td>");
- if (submitted > 0) {
- fmt_date(buf, submitted, 1);
- wprintf("%s", buf);
- }
- else {
- wprintf(" ");
- }
+void tmplput_MailQRetry(StrBuf *Target, WCTemplputParams *TP)
+{
+ char datebuf[64];
+ OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
- wprintf("</td><td>");
- if (last_attempt > 0) {
- fmt_date(buf, last_attempt, 1);
- wprintf("%s", buf);
+ if (Item->Retry == 0) {
+ StrBufAppendBufPlain(Target, _("First Attempt pending"), -1, 0);
}
else {
- wprintf(" ");
+ webcit_fmt_date(datebuf, sizeof(datebuf), Item->Retry, DATEFMT_BRIEF);
+ StrBufAppendBufPlain(Target, datebuf, -1, 0);
}
+}
- wprintf("</td><td>");
- escputs(sender);
-
- wprintf("</td><td>");
- wprintf("%s", recipients);
- wprintf("</td></tr>\n");
+void tmplput_MailQRCPT(StrBuf *Target, WCTemplputParams *TP)
+{
+ MailQEntry *Entry = (MailQEntry*) CTX(CTX_MAILQ_RCPT);
+ StrBufAppendTemplate(Target, TP, Entry->Recipient, 0);
+}
+void tmplput_MailQRCPTStatus(StrBuf *Target, WCTemplputParams *TP)
+{
+ MailQEntry *Entry = (MailQEntry*) CTX(CTX_MAILQ_RCPT);
+ StrBufAppendPrintf(Target, "%ld", Entry->Status);
+}
+void tmplput_MailQStatusMsg(StrBuf *Target, WCTemplputParams *TP)
+{
+ MailQEntry *Entry = (MailQEntry*) CTX(CTX_MAILQ_RCPT);
+ StrBufAppendTemplate(Target, TP, Entry->StatusMessage, 0);
+}
+HashList *iterate_get_Recipients(StrBuf *Target, WCTemplputParams *TP)
+{
+ OneQueItem *Item = (OneQueItem*) CTX(CTX_MAILQITEM);
+ return Item->MailQEntries;
}
-/**
- * \brief display the outbound SMTP queue
- */
-void display_smtpqueue(void)
+void NewMailQEntry(OneQueItem *Item)
{
- int i;
- int num_msgs;
+ Item->Current = (MailQEntry*) malloc(sizeof(MailQEntry));
+ memset(Item->Current, 0, sizeof(MailQEntry));
+
+ if (Item->MailQEntries == NULL)
+ Item->MailQEntries = NewHash(1, Flathash);
+ Item->Current->StatusMessage = NewStrBuf();
+ Item->Current->n = GetCount(Item->MailQEntries);
+ Put(Item->MailQEntries,
+ IKEY(Item->Current->n),
+ Item->Current,
+ FreeMailQEntry);
+}
- output_headers(1, 1, 2, 0, 0, 0);
- wprintf("<div id=\"banner\">\n");
- wprintf("<TABLE WIDTH=100%% BORDER=0 BGCOLOR=\"#444455\"><TR><TD>");
- wprintf("<SPAN CLASS=\"titlebar\">");
- wprintf(_("View the outbound SMTP queue"));
- wprintf("</SPAN>\n");
- wprintf("</TD></TR></TABLE>\n");
- wprintf("</div>\n<div id=\"content\">\n");
+void QItem_Handle_MsgID(OneQueItem *Item, StrBuf *Line, const char **Pos)
+{
+ Item->MessageID = StrBufExtractNext_long(Line, Pos, '|');
+}
- wprintf("<div class=\"fix_scrollbar_bug\">"
- "<table border=0 width=100%% bgcolor=\"#FFFFFF\">"
- "<tr><td valign=top>\n");
+void QItem_Handle_EnvelopeFrom(OneQueItem *Item, StrBuf *Line, const char **Pos)
+{
+ if (Item->EnvelopeFrom == NULL)
+ Item->EnvelopeFrom = NewStrBufPlain(NULL, StrLength(Line));
+ StrBufExtract_NextToken(Item->EnvelopeFrom, Line, Pos, '|');
+}
+void QItem_Handle_BounceTo(OneQueItem *Item, StrBuf *Line, const char **Pos)
+{
+ if (Item->BounceTo == NULL)
+ Item->BounceTo = NewStrBufPlain(NULL, StrLength(Line));
+ StrBufExtract_NextToken(Item->BounceTo, Line, Pos, '|');
+}
- /* Check to see if we can go to the __CitadelSMTPspoolout__ room.
- * If not, we don't have access to the queue.
- */
- gotoroom("__CitadelSMTPspoolout__");
- if (!strcasecmp(WC->wc_roomname, "__CitadelSMTPspoolout__")) {
-
- num_msgs = load_msg_ptrs("MSGS ALL", 0);
- if (num_msgs > 0) {
- wprintf("<table class=\"mailbox_summary\" rules=rows "
- "cellpadding=2 style=\"width:100%%;-moz-user-select:none;\">"
- );
-
- wprintf("<tr><td><b><i>");
- wprintf(_("Message ID"));
- wprintf("</i></b></td><td><b><i>");
- wprintf(_("Date/time submitted"));
- wprintf("</i></b></td><td><b><i>");
- wprintf(_("Last attempt"));
- wprintf("</i></b></td><td><b><i>");
- wprintf(_("Sender"));
- wprintf("</i></b></td><td><b><i>");
- wprintf(_("Recipients"));
- wprintf("</i></b></td></tr>\n");
-
- for (i=0; i<num_msgs; ++i) {
- display_queue_msg(WC->msgarr[i]);
+void QItem_Handle_SenderRoom(OneQueItem *Item, StrBuf *Line, const char **Pos)
+{
+ if (Item->SenderRoom == NULL)
+ Item->SenderRoom = NewStrBufPlain(NULL, StrLength(Line));
+ StrBufExtract_NextToken(Item->SenderRoom, Line, Pos, '|');
+}
+
+void QItem_Handle_Recipient(OneQueItem *Item, StrBuf *Line, const char **Pos)
+{
+ const char *pch;
+ if (Item->Current == NULL)
+ NewMailQEntry(Item);
+ if (Item->Current->Recipient == NULL)
+ Item->Current->Recipient=NewStrBufPlain(NULL, StrLength(Line));
+ StrBufExtract_NextToken(Item->Current->Recipient, Line, Pos, '|');
+ Item->Current->Status = StrBufExtractNext_int(Line, Pos, '|');
+ StrBufExtract_NextToken(Item->Current->StatusMessage, Line, Pos, '|');
+
+ pch = ChrPtr(Item->Current->StatusMessage);
+ while ((pch != NULL) && (*pch != '\0')) {
+ pch = strchr(pch, ';');
+ if (pch != NULL) {
+ pch ++;
+ if (*pch == ' ') {
+ StrBufPeek(Item->Current->StatusMessage,
+ pch, -1, '\n');
}
+ }
+ }
+ Item->Current = NULL; // TODO: is this always right?
+}
- wprintf("</table>");
- }
- else {
- wprintf("<br /><br /><div align=\"center\">");
- wprintf(_("The queue is empty."));
- wprintf("</div><br /><br />");
- }
+void QItem_Handle_retry(OneQueItem *Item, StrBuf *Line, const char **Pos)
+{
+ Item->Retry = StrBufExtractNext_int(Line, Pos, '|');
+}
+
+
+void QItem_Handle_Submitted(OneQueItem *Item, StrBuf *Line, const char **Pos)
+{
+ Item->Submitted = atol(*Pos);
+
+}
+
+void QItem_Handle_Attempted(OneQueItem *Item, StrBuf *Line, const char **Pos)
+{
+ Item->ReattemptWhen = StrBufExtractNext_int(Line, Pos, '|');
+}
+
+
+
+
+void render_QUEUE(StrBuf *Target, WCTemplputParams *TP, StrBuf *FoundCharset)
+{
+ wc_mime_attachment *Mime = CTX(CTX_MIME_ATACH);
+ WCTemplputParams SubTP;
+ OneQueItem* Context;
+
+ Context = DeserializeQueueItem(Mime->Data, Mime->msgnum);
+ StackContext(TP, &SubTP, Context, CTX_MAILQITEM, 0, TP->Tokens);
+ {
+ DoTemplate(HKEY("view_mailq_message"), NULL, &SubTP);
+ }
+ UnStackContext(&SubTP);
+
+ FreeQueItem (&Context);
+}
+
+void
+ServerShutdownModule_SMTP_QUEUE
+(void)
+{
+ DeleteHash(&QItemHandlers);
+}
+void
+ServerStartModule_SMTP_QUEUE
+(void)
+{
+ QItemHandlers = NewHash(0, NULL);
+}
+
+int qview_PrintPageHeader(SharedMessageStatus *Stat, void **ViewSpecific)
+{
+ if (yesbstr("ListOnly"))
+ output_headers(1, 0, 0, 0, 0, 0);
+ else
+ output_headers(1, 1, 1, 0, 0, 0);
+ return 0;
+}
+
+int qview_GetParamsGetServerCall(SharedMessageStatus *Stat,
+ void **ViewSpecific,
+ long oper,
+ char *cmd,
+ long len,
+ char *filter,
+ long flen)
+{
+ if (!WC->is_aide)
+ {
+ DoTemplate(HKEY("aide_required"), NULL, NULL);
+ end_burst();
+
+ return 300;
}
else {
- wprintf("<br /><br /><div align=\"center\">");
- wprintf(_("You do not have permission to view this resource."));
- wprintf("</div><br /><br />");
+ snprintf(cmd, len, "MSGS ALL|0|1");
+ snprintf(filter, flen, "SUBJ|QMSG");
+ if (yesbstr("ListOnly"))
+ DoTemplate(HKEY("view_mailq_table"), NULL, NULL);
+ else
+ DoTemplate(HKEY("view_mailq_header"), NULL, NULL);
+ return 200;
}
+}
- wprintf("</td></tr></table></div>\n");
- wDumpContent(1);
+/*
+ * Display task view
+ */
+int qview_LoadMsgFromServer(SharedMessageStatus *Stat,
+ void **ViewSpecific,
+ message_summary* Msg,
+ int is_new,
+ int i)
+{
+ wcsession *WCC = WC;
+ const StrBuf *Mime;
+
+ /* Not (yet?) needed here? calview *c = (calview *) *ViewSpecific; */
+ read_message(WCC->WBuf, HKEY("view_mailq_message_bearer"), Msg->msgnum, NULL, &Mime, NULL);
+ return 0;
}
+int qview_RenderView_or_Tail(SharedMessageStatus *Stat,
+ void **ViewSpecific,
+ long oper)
+{
+ wcsession *WCC = WC;
+ WCTemplputParams SubTP;
+
+ memset(&SubTP, 0, sizeof(WCTemplputParams));
+ if (yesbstr("ListOnly"))
+ DoTemplate(HKEY("view_mailq_footer_listonly"),NULL, &SubTP);
+ else
+ {
+ if (GetCount(WCC->summ) == 0)
+ DoTemplate(HKEY("view_mailq_footer_empty"),NULL, &SubTP);
+ else
+ DoTemplate(HKEY("view_mailq_footer"),NULL, &SubTP);
+ }
+
+ return 0;
+}
+int qview_Cleanup(void **ViewSpecific)
+{
+
+ wDumpContent(yesbstr("ListOnly")?0:1);
+ return 0;
+}
+void
+InitModule_SMTP_QUEUE
+(void)
+{
+ RegisterCTX(CTX_MAILQITEM);
+ RegisterCTX(CTX_MAILQ_RCPT);
+
+ RegisterQItemHandler(HKEY("msgid"), QItem_Handle_MsgID);
+ RegisterQItemHandler(HKEY("envelope_from"), QItem_Handle_EnvelopeFrom);
+ RegisterQItemHandler(HKEY("retry"), QItem_Handle_retry);
+ RegisterQItemHandler(HKEY("attempted"), QItem_Handle_Attempted);
+ RegisterQItemHandler(HKEY("remote"), QItem_Handle_Recipient);
+ RegisterQItemHandler(HKEY("bounceto"), QItem_Handle_BounceTo);
+ RegisterQItemHandler(HKEY("source_room"), QItem_Handle_SenderRoom);
+ RegisterQItemHandler(HKEY("submitted"), QItem_Handle_Submitted);
+ RegisterMimeRenderer(HKEY("application/x-citadel-delivery-list"), render_QUEUE, 1, 9000);
+ RegisterNamespace("MAILQ:ID", 0, 0, tmplput_MailQID, NULL, CTX_MAILQITEM);
+ RegisterNamespace("MAILQ:PAYLOAD:ID", 0, 0, tmplput_MailQPayloadID, NULL, CTX_MAILQITEM);
+ RegisterNamespace("MAILQ:BOUNCETO", 0, 1, tmplput_MailQBounceTo, NULL, CTX_MAILQITEM);
+ RegisterNamespace("MAILQ:ATTEMPTED", 0, 0, tmplput_MailQAttempted, NULL, CTX_MAILQITEM);
+ RegisterNamespace("MAILQ:SUBMITTED", 0, 0, tmplput_MailQSubmitted, NULL, CTX_MAILQITEM);
+ RegisterNamespace("MAILQ:ENVELOPEFROM", 0, 1, tmplput_MailQEnvelopeFrom, NULL, CTX_MAILQITEM);
+ RegisterNamespace("MAILQ:SRCROOM", 0, 1, tmplput_MailQSourceRoom, NULL, CTX_MAILQITEM);
+ RegisterConditional("COND:MAILQ:HAVESRCROOM", 0, Conditional_MailQ_HaveSourceRoom, CTX_MAILQITEM);
+ RegisterNamespace("MAILQ:RETRY", 0, 0, tmplput_MailQRetry, NULL, CTX_MAILQITEM);
+
+ RegisterNamespace("MAILQ:RCPT:ADDR", 0, 1, tmplput_MailQRCPT, NULL, CTX_MAILQ_RCPT);
+ RegisterNamespace("MAILQ:RCPT:STATUS", 0, 0, tmplput_MailQRCPTStatus, NULL, CTX_MAILQ_RCPT);
+ RegisterNamespace("MAILQ:RCPT:STATUSMSG", 0, 1, tmplput_MailQStatusMsg, NULL, CTX_MAILQ_RCPT);
+
+ RegisterIterator("MAILQ:RCPT", 0, NULL, iterate_get_Recipients,
+ NULL, NULL, CTX_MAILQ_RCPT, CTX_MAILQITEM, IT_NOFLAG);
+
+
+ RegisterReadLoopHandlerset(
+ VIEW_QUEUE,
+ qview_GetParamsGetServerCall,
+ qview_PrintPageHeader,
+ NULL, /* TODO: is this right? */
+ NULL,
+ qview_LoadMsgFromServer,
+ qview_RenderView_or_Tail,
+ qview_Cleanup,
+ NULL);
-/*@}*/
+}
projects / citadel.git / blobdiff