+
/*
* Blog view renderer module for WebCit
*
- * Copyright (c) 1996-2010 by the citadel.org team
+ * Copyright (c) 1996-2012 by the citadel.org team
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * (at your option) any later version.
+ * This program is open source software. You can redistribute it and/or
+ * modify it under the terms of the GNU General Public License, version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include "webcit.h"
#include "webserver.h"
-#include "groupdav.h"
+#include "dav.h"
-/*
- * Data which gets passed around between the various functions in this module
- *
- */
+CtxType CTX_BLOGPOST = CTX_NONE;
-struct blogpost {
- long msgnum;
- StrBuf *id;
- StrBuf *refs;
-};
+typedef struct __BLOG {
+ HashList *BLOGPOSTS;
+ long p;
+ int gotonext;
+ long firstp;
+ long maxp;
+ StrBuf *Charset;
+ StrBuf *Buf;
+ const StrBuf *FilterTag;
+} BLOG;
-struct blogview {
- struct blogpost *msgs; /* Array of msgnums for messages we are displaying */
+/*
+ * Array type for a blog post. The first message is the post; the rest are comments
+ */
+typedef struct _blogpost {
+ int top_level_id;
+ long *msgs; /* Array of msgnums for messages we are displaying */
int num_msgs; /* Number of msgnums stored in 'msgs' */
int alloc_msgs; /* Currently allocated size of array */
-};
+ int unread_oments;
+} blogpost;
/*
- * Entry point for message read operations.
+ * XML sitemap generator -- go through the message list for a Blog room
*/
-int blogview_GetParamsGetServerCall(SharedMessageStatus *Stat,
- void **ViewSpecific,
- long oper,
- char *cmd,
- long len)
-{
- struct blogview *BLOG = malloc(sizeof(struct blogview));
- memset(BLOG, 0, sizeof(struct blogview));
- *ViewSpecific = BLOG;
-
- Stat->startmsg = (-1); /* not used here */
- Stat->sortit = 1; /* not used here */
- Stat->num_displayed = DEFAULT_MAXMSGS; /* not used here */
- if (Stat->maxmsgs == 0) Stat->maxmsgs = DEFAULT_MAXMSGS;
-
- /* perform a "read all" call to fetch the message list -- we'll cut it down later */
- rlid[2].cmd(cmd, len);
-
- return 200;
+void sitemap_do_blog(void) {
+ wcsession *WCC = WC;
+ blogpost oneBP;
+ int num_msgs = 0;
+ int i;
+ SharedMessageStatus Stat;
+ message_summary *Msg = NULL;
+ StrBuf *Buf = NewStrBuf();
+ StrBuf *FoundCharset = NewStrBuf();
+ WCTemplputParams SubTP;
+
+ memset(&Stat, 0, sizeof Stat);
+ memset(&oneBP, 0, sizeof(blogpost));
+ memset(&SubTP, 0, sizeof(WCTemplputParams));
+ StackContext(NULL, &SubTP, &oneBP, CTX_BLOGPOST, 0, NULL);
+
+ Stat.maxload = INT_MAX;
+ Stat.lowest_found = (-1);
+ Stat.highest_found = (-1);
+ num_msgs = load_msg_ptrs("MSGS ALL", NULL, NULL, &Stat, NULL, NULL, NULL, NULL, 0);
+ if (num_msgs < 1)
+ return;
+
+ for (i = 0; i < num_msgs; ++i) {
+ Msg = GetMessagePtrAt(i, WCC->summ);
+ if (Msg != NULL) {
+ ReadOneMessageSummary(Msg, FoundCharset, Buf);
+ /* Show only top level posts, not comments */
+ if ((Msg->reply_inreplyto_hash != 0) && (Msg->reply_references_hash == 0)) {
+ oneBP.top_level_id = Msg->reply_inreplyto_hash;
+ DoTemplate(HKEY("view_blog_sitemap"), WCC->WBuf, &SubTP);
+ }
+ }
+ }
+ UnStackContext(&SubTP);
+ FreeStrBuf(&Buf);
+ FreeStrBuf(&FoundCharset);
}
+
/*
- * This function is called for every message in the list.
+ * Generate a permalink for a post
+ * (Call with NULL arguments to make this function wcprintf() the permalink
+ * instead of writing it to the template)
+ */
+void tmplput_blog_toplevel_id(StrBuf * Target, WCTemplputParams * TP) {
+ blogpost *bp = (blogpost *) CTX(CTX_BLOGPOST);
+ char buf[SIZ];
+ snprintf(buf, SIZ, "%d", bp->top_level_id);
+ StrBufAppendTemplateStr(Target, TP, buf, 0);
+}
+
+void tmplput_blog_comment_count(StrBuf * Target, WCTemplputParams * TP) {
+ blogpost *bp = (blogpost *) CTX(CTX_BLOGPOST);
+ char buf[SIZ];
+ snprintf(buf, SIZ, "%d", bp->num_msgs - 1);
+ StrBufAppendTemplateStr(Target, TP, buf, 0);
+}
+void tmplput_blog_comment_unread_count(StrBuf * Target, WCTemplputParams * TP) {
+ blogpost *bp = (blogpost *) CTX(CTX_BLOGPOST);
+ char buf[SIZ];
+ snprintf(buf, SIZ, "%d", bp->unread_oments);
+ StrBufAppendTemplateStr(Target, TP, buf, 0);
+}
+
+
+
+/*
+ * Render a single blog post and (optionally) its comments
*/
-int blogview_LoadMsgFromServer(SharedMessageStatus *Stat,
- void **ViewSpecific,
- message_summary* Msg,
- int is_new,
- int i)
-{
- struct blogview *BLOG = (struct blogview *) *ViewSpecific;
-
- if (BLOG->alloc_msgs == 0) {
- BLOG->alloc_msgs = 1000;
- BLOG->msgs = malloc(BLOG->alloc_msgs * sizeof(struct blogpost));
- memset(BLOG->msgs, 0, (BLOG->alloc_msgs * sizeof(struct blogpost)) );
+void blogpost_render(blogpost * bp, int with_comments, WCTemplputParams * TP) {
+ wcsession *WCC = WC;
+ WCTemplputParams SubTP;
+ const StrBuf *Mime;
+ int i;
+
+ memset(&SubTP, 0, sizeof(WCTemplputParams));
+ StackContext(TP, &SubTP, bp, CTX_BLOGPOST, 0, NULL);
+
+ /* Always show the top level post, unless we somehow ended up with an empty list */
+ if (bp->num_msgs > 0) {
+ read_message(WC->WBuf, HKEY("view_blog_post"), bp->msgs[0], NULL, &Mime, TP);
}
- /* Check our buffer size */
- if (BLOG->num_msgs >= BLOG->alloc_msgs) {
- BLOG->alloc_msgs *= 2;
- BLOG->msgs = realloc(BLOG->msgs, (BLOG->alloc_msgs * sizeof(long)));
- memset(&BLOG->msgs[BLOG->num_msgs], 0, ((BLOG->alloc_msgs - BLOG->num_msgs) * sizeof(long)) );
+ if (with_comments) {
+ /* Show any existing comments, then offer the comment box */
+ DoTemplate(HKEY("view_blog_show_commentlink"), WCC->WBuf, &SubTP);
+
+ for (i = 1; i < bp->num_msgs; ++i) {
+ read_message(WC->WBuf, HKEY("view_blog_comment"), bp->msgs[i], NULL, &Mime, &SubTP);
+ }
+ DoTemplate(HKEY("view_blog_comment_box"), WCC->WBuf, &SubTP);
}
- BLOG->msgs[BLOG->num_msgs++].msgnum = Msg->msgnum;
- BLOG->msgs[BLOG->num_msgs].id = NULL;
- BLOG->msgs[BLOG->num_msgs].refs = NULL;
+ else {
+ /* Show only the number of comments */
+ DoTemplate(HKEY("view_blog_show_no_comments"), WCC->WBuf, &SubTP);
+ }
+ UnStackContext(&SubTP);
+}
- return 200;
+
+/*
+ * Destructor for "blogpost"
+ */
+void blogpost_destroy(blogpost * bp) {
+ if (bp->alloc_msgs > 0) {
+ free(bp->msgs);
+ }
+ free(bp);
}
/*
- * People expect blogs to be sorted newest-to-oldest
+ * Entry point for message read operations.
*/
-int blogview_sortfunc(const void *s1, const void *s2) {
- struct blogpost *l1 = (struct blogpost *)(s1);
- struct blogpost *l2 = (struct blogpost *)(s2);
+int blogview_GetParamsGetServerCall(SharedMessageStatus * Stat,
+ void **ViewSpecific, long oper, char *cmd, long len, char *filter, long flen) {
+ BLOG *BL = (BLOG *) malloc(sizeof(BLOG));
+ BL->BLOGPOSTS = NewHash(1, lFlathash);
+
+ /* are we looking for a specific post? */
+ BL->p = lbstr("p");
+ BL->gotonext = havebstr("gotonext");
+ BL->Charset = NewStrBuf();
+ BL->Buf = NewStrBuf();
+ BL->FilterTag = sbstr("FilterTag");
+ BL->firstp = lbstr("firstp"); /* start reading at... */
+ BL->maxp = lbstr("maxp"); /* max posts to show... */
+ if (BL->maxp < 1)
+ BL->maxp = 5; /* default; move somewhere else? */
+ putlbstr("maxp", BL->maxp);
+ *ViewSpecific = BL;
+
+ Stat->startmsg = (-1); /* not used here */
+ Stat->sortit = 1; /* not used here */
+ Stat->num_displayed = DEFAULT_MAXMSGS; /* not used here */
+ if (Stat->maxmsgs == 0)
+ Stat->maxmsgs = DEFAULT_MAXMSGS;
+
+ /* perform a "read all" call to fetch the message list -- we'll cut it down later */
+ snprintf(cmd, len, "MSGS ALL||2|8\n");
- if (l1->msgnum > l2->msgnum) return(-1);
- if (l1->msgnum < l2->msgnum) return(+1);
- return(0);
+ if (BL->gotonext)
+ Stat->load_seen = 1;
+ return 200;
}
+int blogview_IdentifyBlogposts(StrBuf * Line,
+ const char **pos, message_summary * Msg, StrBuf * ConversionBuffer, void **ViewSpecific) {
+ BLOG *BL = (BLOG *) * ViewSpecific;
+ blogpost *bp = NULL;
+
+ /* Stop processing if the viewer is only interested in a single post and
+ * that message ID is neither the id nor the refs.
+ */
+ if ((BL->p != 0) && (BL->p != Msg->reply_inreplyto_hash) && (BL->p != Msg->reply_references_hash)) {
+ return 0;
+ }
+
+ if ((Msg->reply_references_hash == 0) &&
+ (BL->FilterTag != NULL) && (strstr(ChrPtr(Msg->EnvTo), ChrPtr(BL->FilterTag)) == NULL)) {
+ /* filtering for tags, blogpost doesn't fit. */
+ return 0;
+ }
+
+ /*
+ * build up a hashtable of the blogposts.
+ */
+ if (Msg->reply_references_hash == 0) {
+ bp = malloc(sizeof(blogpost));
+
+ if (bp == NULL)
+ return 0;
+
+ memset(bp, 0, sizeof(blogpost));
+
+ bp->top_level_id = Msg->reply_inreplyto_hash;
+ bp->alloc_msgs = 1000;
+ bp->msgs = malloc(bp->alloc_msgs * sizeof(long));
+ memset(bp->msgs, 0, (bp->alloc_msgs * sizeof(long)));
+
+ /* the first one is the blogpost itself, all subequent are comments. */
+ bp->msgs[0] = Msg->msgnum;
+ bp->num_msgs = 1;
+
+ Put(BL->BLOGPOSTS, LKEY(Msg->reply_inreplyto_hash), bp, (DeleteHashDataFunc) blogpost_destroy);
+ }
+ /*
+ * Comments will be handled on the next iteration.
+ */
+
+ return 1;
+}
+
/*
- * Given a 'struct blogpost' containing a msgnum, populate the id
- * and refs fields by fetching them from the Citadel server
+ * This function is called for every message in the list.
*/
-void blogview_learn_thread_references(struct blogpost *bp)
-{
- StrBuf *Buf;
- Buf = NewStrBuf();
- serv_printf("MSG0 %ld|1", bp->msgnum); /* top level citadel headers only */
- StrBuf_ServGetln(Buf);
- if (GetServerStatus(Buf, NULL) == 1) {
- while (StrBuf_ServGetln(Buf), strcmp(ChrPtr(Buf), "000")) {
- if (!strncasecmp(ChrPtr(Buf), "msgn=", 5)) {
- bp->id = NewStrBufDup(Buf);
- StrBufCutLeft(bp->id, 5);
+int blogview_LoadMsgFromServer(SharedMessageStatus * Stat, void **ViewSpecific, message_summary * Msg, int is_new, int i) {
+ blogpost *bp = NULL;
+ BLOG *BL = (BLOG *) * ViewSpecific;
+
+ if (Msg->reply_references_hash != 0) {
+ /*
+ * this is a comment. try to assign it to a blogpost.
+ */
+ GetHash(BL->BLOGPOSTS, LKEY(Msg->reply_references_hash), (void *) &bp);
+
+ /*
+ * Now we have a 'blogpost' to which we can add the comment. It's either the
+ * blog post itself or a comment attached to it; either way, the code is the same from
+ * this point onward.
+ */
+ if (bp != NULL) {
+ if (bp->num_msgs >= bp->alloc_msgs) {
+ bp->alloc_msgs *= 2;
+ bp->msgs = realloc(bp->msgs, (bp->alloc_msgs * sizeof(long)));
+ memset(&bp->msgs[bp->num_msgs], 0, ((bp->alloc_msgs - bp->num_msgs) * sizeof(long)));
}
- else if (!strncasecmp(ChrPtr(Buf), "wefw=", 5)) {
- bp->refs = NewStrBufDup(Buf);
- StrBufCutLeft(bp->refs, 5);
+ bp->msgs[bp->num_msgs++] = Msg->msgnum;
+ if ((Msg->Flags & MSGFLAG_READ) != 0) {
+ bp->unread_oments++;
}
}
+ else {
+ /*
+ * Ok, this comment probably belongs to one of the blogposts
+ * we ruled out by filters. don't load it.
+ */
+ return 200;
+ }
}
- FreeStrBuf(&Buf);
+ return 200;
}
+/*
+ * Sort a list of 'struct blogpost' pointers by newest-to-oldest msgnum.
+ * With big thanks to whoever wrote http://www.c.happycodings.com/Sorting_Searching/code14.html
+ */
+static int blogview_sortfunc(const void *a, const void *b) {
+ blogpost const *one = GetSearchPayload(a);
+ blogpost const *two = GetSearchPayload(b);
+
+ if (one->msgs[0] > two->msgs[0])
+ return (-1);
+ if (one->msgs[0] < two->msgs[0])
+ return (+1);
+ return (0);
+}
-int blogview_render(SharedMessageStatus *Stat, void **ViewSpecific, long oper)
-{
- struct blogview *BLOG = (struct blogview *) *ViewSpecific;
- int i;
+/*
+ * All blogpost entries are now in the hash list.
+ * Sort them, select the desired range, and render what we want to see.
+ */
+int blogview_render(SharedMessageStatus * Stat, void **ViewSpecific, long oper) {
+ wcsession *WCC = WC;
+ BLOG *BL = (BLOG *) * ViewSpecific;
+ HashPos *it;
+ const char *Key;
+ blogpost *thisBlogpost;
+ void *Data;
+ long len;
+ int num_blogposts = 0;
+ int with_comments = 0;
+ WCTemplputParams SubTP;
+ WCTemplputParams StopSubTP;
+ blogpost oneBP;
+ long firstPOffset = 0;
+ int count = 0;
+ int totalCount = 0;
+ StrBuf *PrevNext = NULL;
+
+ num_blogposts = GetCount(BL->BLOGPOSTS);
+ if (num_blogposts == 0) {
+ /* Nothing to do... */
+ return 0;
+ }
+ memset(&SubTP, 0, sizeof(WCTemplputParams));
+ memset(&StopSubTP, 0, sizeof(WCTemplputParams));
+ memset(&oneBP, 0, sizeof(blogpost));
+
+ /* Comments are shown if we are only viewing a single blog post */
+ with_comments = (BL->p != 0);
+
+ it = GetNewHashPos(BL->BLOGPOSTS, 0);
+
+ if ((BL->gotonext) && (BL->p == 0)) {
+ /* did we come here via gotonext? lets find out whether
+ * this blog has just one blogpost with new comments just display
+ * this one.
+ */
+ blogpost *unread_bp = NULL;
+ int unread_count = 0;
+ while (GetNextHashPos(BL->BLOGPOSTS, it, &len, &Key, &Data)) {
+ blogpost *one_bp = (blogpost *) Data;
+ if (one_bp->unread_oments > 0) {
+ unread_bp = one_bp;
+ unread_count++;
+ }
+ }
+ if (unread_count == 1) {
+ blogpost_render(unread_bp, 1, NULL); /// TODO other than null?
- if (Stat->nummsgs > 0) {
- lprintf(9, "sorting %d messages\n", BLOG->num_msgs);
- qsort(BLOG->msgs, (size_t)(BLOG->num_msgs), sizeof(struct blogpost), blogview_sortfunc);
+ DeleteHashPos(&it);
+ return 0;
+ }
}
- for (i=0; (i<BLOG->num_msgs); ++i) {
- if (BLOG->msgs[i].msgnum > 0L) {
- blogview_learn_thread_references(&BLOG->msgs[i]);
- wc_printf("Message %d, #%ld, id '%s', refs '%s'<br>\n",
- i,
- BLOG->msgs[i].msgnum,
- ChrPtr(BLOG->msgs[i].id),
- ChrPtr(BLOG->msgs[i].refs)
- );
+ /* Now we have our array. It is ONLY an array of pointers. The objects to
+ * which they point are still owned by the hash list.
+ */
+
+ /* get it into the right sort of order - blogposts may have been edited */
+ SortByPayload(BL->BLOGPOSTS, blogview_sortfunc);
+
+ /* Find the start post to display: */
+ if (BL->firstp != 0) {
+ /* Translate the firstpost id into an offset */
+ RewindHashPos(BL->BLOGPOSTS, it, 0);
+ while (GetNextHashPos(BL->BLOGPOSTS, it, &len, &Key, &Data)) {
+ thisBlogpost = (blogpost *) Data;
+ if (thisBlogpost->top_level_id == BL->firstp) {
+ firstPOffset = count;
+ break;
+ }
+ count++;
}
}
- return(0);
-}
+ if ((num_blogposts > BL->maxp) || (firstPOffset != 0)) {
+ PrevNext = NewStrBuf();
+ if (firstPOffset > 0) {
+ const char *k;
+ long len;
+ long posPrev = 0;
+ /* we now need to go up to maxp items back */
+ if (firstPOffset > BL->maxp) {
+ posPrev = firstPOffset - BL->maxp;
+ }
+ GetHashAt(BL->BLOGPOSTS, posPrev, &len, &k, &Data);
+ thisBlogpost = (blogpost *) Data;
+ StackContext(NULL, &SubTP, thisBlogpost, CTX_BLOGPOST, 0, NULL);
+ DoTemplate(HKEY("view_blog_newer_posts"), PrevNext, &SubTP);
+ }
+ if (firstPOffset + BL->maxp <= num_blogposts) {
+ const char *k;
+ long len;
+ long posNext = firstPOffset + BL->maxp;
+ GetHashAt(BL->BLOGPOSTS, posNext, &len, &k, &Data);
+ thisBlogpost = (blogpost *) Data;
+ StackContext(NULL, &SubTP, thisBlogpost, CTX_BLOGPOST, 0, NULL);
+ DoTemplate(HKEY("view_blog_older_posts"), PrevNext, &SubTP);
+ }
+ }
+ StrBufAppendBuf(WCC->WBuf, PrevNext, 0);
+ count = totalCount = 0;
+ RewindHashPos(BL->BLOGPOSTS, it, 0);
-int blogview_Cleanup(void **ViewSpecific)
-{
- struct blogview *BLOG = (struct blogview *) *ViewSpecific;
- int i;
+ /* FIXME -- allow the user (or a default setting) to select a maximum number of posts to display */
+ while (GetNextHashPos(BL->BLOGPOSTS, it, &len, &Key, &Data)) {
+ thisBlogpost = (blogpost *) Data;
- if (BLOG->alloc_msgs != 0) {
- for (i=0; i<BLOG->num_msgs; ++i) {
- FreeStrBuf(&BLOG->msgs[i].id);
- FreeStrBuf(&BLOG->msgs[i].refs);
+ /* allow the user to select a starting point in the list */
+ if (totalCount < firstPOffset) {
+ /* skip all till we found the first valid: */
+ totalCount++;
+ continue;
}
- free(BLOG->msgs);
+ if (count >= BL->maxp) {
+ /* enough is enough. */
+ break;
+ }
+ StackContext(NULL, &SubTP, thisBlogpost, CTX_BLOGPOST, 0, NULL);
+ blogpost_render(thisBlogpost, with_comments, &SubTP);
+ UnStackContext(&SubTP);
+ count++;
+ totalCount++;
}
- free(BLOG);
+ StrBufAppendBuf(WCC->WBuf, PrevNext, 0);
+ FreeStrBuf(&PrevNext);
+ DeleteHashPos(&it);
+
+ return (0);
+}
+
+
+int blogview_Cleanup(void **ViewSpecific) {
+ BLOG *BL = (BLOG *) * ViewSpecific;
+ FreeStrBuf(&BL->Buf);
+ FreeStrBuf(&BL->Charset);
+ DeleteHash(&BL->BLOGPOSTS);
+ free(BL);
wDumpContent(1);
return 0;
}
-void
-InitModule_BLOGVIEWRENDERERS
-(void)
-{
- RegisterReadLoopHandlerset(
- VIEW_BLOG,
- blogview_GetParamsGetServerCall,
- NULL,
- NULL,
- blogview_LoadMsgFromServer,
- blogview_render,
- blogview_Cleanup
- );
+void InitModule_BLOGVIEWRENDERERS(void) {
+ const char *browseListFields[] = {
+ "msgn",
+ "nvto",
+ "wefw",
+ NULL
+ };
+ RegisterCTX(CTX_BLOGPOST);
+
+ RegisterReadLoopHandlerset(VIEW_BLOG,
+ blogview_GetParamsGetServerCall,
+ NULL,
+ NULL,
+ blogview_IdentifyBlogposts,
+ blogview_LoadMsgFromServer, blogview_render, blogview_Cleanup, browseListFields);
+
+ RegisterNamespace("BLOG:TOPLEVEL:MSGID", 0, 0, tmplput_blog_toplevel_id, NULL, CTX_BLOGPOST);
+ RegisterNamespace("BLOG:COMMENTS:COUNT", 0, 0, tmplput_blog_comment_count, NULL, CTX_BLOGPOST);
+ RegisterNamespace("BLOG:COMMENTS:UNREAD:COUNT", 0, 0, tmplput_blog_comment_unread_count, NULL, CTX_BLOGPOST);
}
projects / citadel.git / blobdiff