/*
* 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"
-/*
- * Array type for a blog post. The first message is the post; the rest are comments
+/*
+ * Generate a permalink for a post
+ * (Call with NULL arguments to make this function wcprintf() the permalink
+ * instead of writing it to the template)
*/
-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 */
-};
+void tmplput_blog_permalink(StrBuf *Target, WCTemplputParams *TP) {
+ char perma[SIZ];
+
+ strcpy(perma, "/readfwd?go=");
+ urlesc(&perma[strlen(perma)], sizeof(perma)-strlen(perma), (char *)ChrPtr(WC->CurRoom.name));
+ snprintf(&perma[strlen(perma)], sizeof(perma)-strlen(perma), "?p=%d", WC->bptlid);
+ if (!Target) {
+ wc_printf("%s", perma);
+ }
+ else {
+ StrBufAppendPrintf(Target, "%s", perma);
+ }
+}
/*
- * Destructor for 'struct blogpost' which does the rendering first.
- * By rendering from here, we eliminate the need for a separate iterator, although
- * we might run into trouble when we get around to displaying newest-to-oldest...
+ * Render a single blog post and (optionally) its comments
*/
-void blogpost_render_and_destroy(struct blogpost *bp) {
+void blogpost_render(struct blogpost *bp, int with_comments)
+{
const StrBuf *Mime;
- int p = 0;
int i;
- p = atoi(BSTR("p")); /* are we looking for a specific post? */
+ WC->bptlid = bp->top_level_id; /* This is used in templates; do not remove it */
- if ( ((p == 0) || (p == bp->top_level_id)) && (bp->num_msgs > 0) ) {
- /* Show the top level post */
- read_message(WC->WBuf, HKEY("view_message"), bp->msgs[0], NULL, &Mime);
+ /* 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);
+ }
- if (p == 0) {
- /* Show the number of comments */
- wc_printf("<a href=\"readfwd?p=%d?gotofirst=", bp->top_level_id);
- urlescputs(ChrPtr(WC->CurRoom.name));
- wc_printf("#comments\">%d comments</a>", bp->num_msgs - 1);
- }
- else if (bp->num_msgs < 2) {
- wc_printf("dere r no comments here!<br>\n");
- }
- else {
- wc_printf("<a name=\"comments\"></a>\n");
- wc_printf("%d comments<br>\n", bp->num_msgs - 1);
- wc_printf("<blockquote>");
- for (i=1; i<bp->num_msgs; ++i) {
- read_message(WC->WBuf, HKEY("view_message"), bp->msgs[i], NULL, &Mime);
- }
- wc_printf("</blockquote>");
+ if (with_comments) {
+ /* Show any existing comments, then offer the comment box */
+ wc_printf("<a class=\"blog_show_comments_link\" name=\"comments\"></a>\n");
+ wc_printf(_("%d comments"), bp->num_msgs - 1);
+ wc_printf(" | <a class=\"blog_permalink_link\" href=\"");
+ tmplput_blog_permalink(NULL, NULL);
+ wc_printf("\">%s</a>", _("permalink"));
+ wc_printf("</div>\n");
+ for (i=1; i<bp->num_msgs; ++i) {
+ read_message(WC->WBuf, HKEY("view_blog_comment"), bp->msgs[i], NULL, &Mime);
}
+ do_template("view_blog_comment_box");
}
-
- if (bp->alloc_msgs > 0) {
- free(bp->msgs);
+ else {
+ /* Show only the number of comments */
+ wc_printf("<a class=\"blog_show_comments_link\" href=\"readfwd?p=%d?go=", bp->top_level_id);
+ urlescputs(ChrPtr(WC->CurRoom.name));
+ wc_printf("#comments\">");
+ wc_printf(_("%d comments"), bp->num_msgs - 1);
+ wc_printf("</a> | <a class=\"blog_permalink_link\" href=\"");
+ tmplput_blog_permalink(NULL, NULL);
+ wc_printf("\">%s</a>", _("permalink"));
+ wc_printf("<hr>\n</div>\n");
}
- free(bp);
}
/*
- * Data which gets returned from a call to blogview_learn_thread_references()
+ * Destructor for "struct blogpost"
*/
-struct bltr {
- int id;
- int refs;
-};
+void blogpost_destroy(struct blogpost *bp) {
+ if (bp->alloc_msgs > 0) {
+ free(bp->msgs);
+ }
+ free(bp);
+}
/*
void **ViewSpecific,
long oper,
char *cmd,
- long len)
+ long len,
+ char *filter,
+ long flen)
{
HashList *BLOG = NewHash(1, NULL);
*ViewSpecific = BLOG;
/*
- * Given a 'struct blogpost' containing a msgnum, populate the id
- * and refs fields by fetching them from the Citadel server
+ * Given a msgnum, populate the id and refs fields of
+ * a "struct bltr" by fetching them from the Citadel server
*/
struct bltr blogview_learn_thread_references(long msgnum)
{
StrBuf *Buf;
StrBuf *r;
+ int len;
struct bltr bltr = { 0, 0 } ;
Buf = NewStrBuf();
r = NewStrBuf();
serv_printf("MSG0 %ld|1", msgnum); /* top level citadel headers only */
StrBuf_ServGetln(Buf);
if (GetServerStatus(Buf, NULL) == 1) {
- while (StrBuf_ServGetln(Buf), strcmp(ChrPtr(Buf), "000")) {
+ while (len = StrBuf_ServGetln(Buf),
+ ((len >= 0) &&
+ ((len != 3) || strcmp(ChrPtr(Buf), "000") )))
+ {
if (!strncasecmp(ChrPtr(Buf), "msgn=", 5)) {
StrBufCutLeft(Buf, 5);
- bltr.id = HashLittle(ChrPtr(Buf), StrLength(Buf));
+ bltr.id = ThreadIdHash(Buf);
}
else if (!strncasecmp(ChrPtr(Buf), "wefw=", 5)) {
StrBufCutLeft(Buf, 5); /* trim the field name */
StrBufExtract_token(r, Buf, 0, '|');
- bltr.refs = HashLittle(ChrPtr(r), StrLength(r));
+ bltr.refs = ThreadIdHash(r);
}
}
}
HashList *BLOG = (HashList *) *ViewSpecific;
struct bltr b;
struct blogpost *bp = NULL;
+ int p = 0;
b = blogview_learn_thread_references(Msg->msgnum);
- /* FIXME an optimization here -- one we ought to perform -- is to exit this
- * function immediately if the viewer is only interested in a single post and
- * that message ID is neither the id nor the refs. Actually, that might *be*
- * the way to display only a single message (with or without comments).
+ /* Stop processing if the viewer is only interested in a single post and
+ * that message ID is neither the id nor the refs.
*/
+ p = atoi(BSTR("p")); /* are we looking for a specific post? */
+ if ((p != 0) && (p != b.id) && (p != b.refs)) {
+ return 200;
+ }
+ /*
+ * Add our little bundle of blogworthy wonderfulness to the hash table
+ */
if (b.refs == 0) {
bp = malloc(sizeof(struct blogpost));
if (!bp) return(200);
memset(bp, 0, sizeof (struct blogpost));
- bp->top_level_id = b.id;
- Put(BLOG, (const char *)&b.id, sizeof(b.id), bp,
- (DeleteHashDataFunc)blogpost_render_and_destroy);
+ bp->top_level_id = b.id;
+ Put(BLOG, (const char *)&b.id, sizeof(b.id), bp, (DeleteHashDataFunc)blogpost_destroy);
}
else {
GetHash(BLOG, (const char *)&b.refs , sizeof(b.refs), (void *)&bp);
}
bp->msgs[bp->num_msgs++] = Msg->msgnum;
}
+ else {
+ syslog(LOG_DEBUG, "** comment %ld is unparented", Msg->msgnum);
+ }
return 200;
}
/*
- * Sort a list of 'struct blogpost' objects by newest-to-oldest msgnum.
+ * 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
*/
-int blogview_sortfunc(const void *s1, const void *s2) {
- long *l1 = (long *)(s1);
- long *l2 = (long *)(s2);
+static int blogview_sortfunc(const void *a, const void *b) {
+ struct blogpost * const *one = a;
+ struct blogpost * const *two = b;
- if (*l1 > *l2) return(-1);
- if (*l1 < *l2) return(+1);
+ if ( (*one)->msgs[0] > (*two)->msgs[0] ) return(-1);
+ if ( (*one)->msgs[0] < (*two)->msgs[0] ) return(+1);
return(0);
}
+/*
+ * 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)
{
- /*HashList *BLOG = (HashList *) *ViewSpecific;*/
+ HashList *BLOG = (HashList *) *ViewSpecific;
+ HashPos *it;
+ const char *Key;
+ void *Data;
+ long len;
+ int i;
+ struct blogpost **blogposts = NULL;
+ int num_blogposts = 0;
+ int num_blogposts_alloc = 0;
+ int with_comments = 0;
+ int firstp = 0;
+ int maxp = 0;
+
+ /* Comments are shown if we are only viewing a single blog post */
+ if (atoi(BSTR("p"))) with_comments = 1;
+
+ firstp = atoi(BSTR("firstp")); /* start reading at... */
+ maxp = atoi(BSTR("maxp")); /* max posts to show... */
+ if (maxp < 1) maxp = 5; /* default; move somewhere else? */
+
+ /* Iterate through the hash list and copy the data pointers into an array */
+ it = GetNewHashPos(BLOG, 0);
+ while (GetNextHashPos(BLOG, it, &len, &Key, &Data)) {
+ if (num_blogposts >= num_blogposts_alloc) {
+ if (num_blogposts_alloc == 0) {
+ num_blogposts_alloc = 100;
+ }
+ else {
+ num_blogposts_alloc *= 2;
+ }
+ blogposts = realloc(blogposts, (num_blogposts_alloc * sizeof (struct blogpost *)));
+ }
+ blogposts[num_blogposts++] = (struct blogpost *) Data;
+ }
+ DeleteHashPos(&it);
- /*
- * No code needed here -- we render during disposition.
- * Maybe this is the location where we want to handle pretty permalinks.
+ /* 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.
*/
+ if (num_blogposts > 0) {
+ int start_here = 0;
+ /* Sort newest-to-oldest */
+ qsort(blogposts, num_blogposts, sizeof(void *), blogview_sortfunc);
+
+ /* allow the user to select a starting point in the list */
+ for (i=0; i<num_blogposts; ++i) {
+ if (blogposts[i]->top_level_id == firstp) {
+ start_here = i;
+ }
+ }
+
+ /* FIXME -- allow the user (or a default setting) to select a maximum number of posts to display */
+
+ /* Now go through the list and render what we've got */
+ for (i=start_here; i<num_blogposts; ++i) {
+ if ((i > 0) && (i == start_here)) {
+ int j = i - maxp;
+ if (j < 0) j = 0;
+ wc_printf("<div class=\"newer_blog_posts\"><a href=\"readfwd?go=");
+ urlescputs(ChrPtr(WC->CurRoom.name));
+ wc_printf("?firstp=%d?maxp=%d\">", blogposts[j]->top_level_id, maxp);
+ wc_printf("%s →</a></div>\n", _("Newer posts"));
+ }
+ if (i < (start_here + maxp)) {
+ blogpost_render(blogposts[i], with_comments);
+ }
+ else if (i == (start_here + maxp)) {
+ wc_printf("<div class=\"older_blog_posts\"><a href=\"readfwd?go=");
+ urlescputs(ChrPtr(WC->CurRoom.name));
+ wc_printf("?firstp=%d?maxp=%d\">", blogposts[i]->top_level_id, maxp);
+ wc_printf("← %s</a></div>\n", _("Older posts"));
+ }
+ }
+
+ /* Done. We are only freeing the array of pointers; the data itself
+ * will be freed along with the hash list.
+ */
+ free(blogposts);
+ }
return(0);
}
VIEW_BLOG,
blogview_GetParamsGetServerCall,
NULL,
+ NULL,
NULL,
blogview_LoadMsgFromServer,
blogview_render,
blogview_Cleanup
);
+ RegisterNamespace("BLOG:PERMALINK", 0, 0, tmplput_blog_permalink, NULL, CTX_NONE);
}