Use strbuf in template token handler
[citadel.git] / webcit / blogview_renderer.c
index 438e3d49eeac94569cce3ed390c6ed3f64de2955..9432181e75d93746d53364cd486e1de0a692c27d 100644 (file)
@@ -1,37 +1,29 @@
 /* 
  * Blog view renderer module for WebCit
  *
- * Copyright (c) 1996-2011 by the citadel.org team
+ * Copyright (c) 1996-2012 by the citadel.org team
  *
  * This program is open source 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.
+ * 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
- */
-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 */
-};
+typedef struct __BLOG {
+       HashList *BLOG;
+       long p;
+       int gotonext;
+       StrBuf *Charset;
+       StrBuf *Buf;
+} BLOG;
 
 
 /*
@@ -40,85 +32,67 @@ struct blogpost {
  * instead of writing it to the template)
  */
 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);
-       }
+       StrBuf *buf = NewStrBufPlain(HKEY("/readfwd?go="));
+       StrBufUrlescAppend(buf, WC->CurRoom.name, 0);
+       StrBufAppendPrintf(buf, "?p=%d", WC->bptlid);
+       StrBufAppendTemplate(Target, TP, buf, 0);
+       FreeStrBuf(&buf);
 }
 
 
 /*
- * 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;
+       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 */
+       /* 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?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 href=\"");
-                       tmplput_blog_permalink(NULL, NULL);
-                       wc_printf("\">%s</a>", _("permalink"));
-                       wc_printf("<br><br><br>\n");
-               }
-               else if (bp->num_msgs < 2) {
-                       wc_printf(_("%d comments"), 0);
-               }
-               else {
-                       wc_printf("<a name=\"comments\"></a>\n");
-                       wc_printf(_("%d comments"), bp->num_msgs - 1);
-                       wc_printf(" | <a href=\"");
-                       tmplput_blog_permalink(NULL, NULL);
-                       wc_printf("\">%s</a>", _("permalink"));
-                       wc_printf("<br>\n");
-                       for (i=1; i<bp->num_msgs; ++i) {
-                               read_message(WC->WBuf, HKEY("view_blog_comment"), bp->msgs[i], NULL, &Mime);
-                       }
-               }
        }
 
-
-       if (bp->alloc_msgs > 0) {
-               free(bp->msgs);
+       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");
        }
 
-       /* offer the comment box */
-       if (p == bp->top_level_id) {
-               do_template("blog_comment_box");
+       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(" %d %s", bp->unread_oments, _("new"));
+               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);
+}
 
 
 /*
@@ -128,10 +102,19 @@ int blogview_GetParamsGetServerCall(SharedMessageStatus *Stat,
                                   void **ViewSpecific, 
                                   long oper, 
                                   char *cmd, 
-                                  long len)
+                                   long len,
+                                   char *filter,
+                                   long flen)
 {
-       HashList *BLOG = NewHash(1, NULL);
-       *ViewSpecific = BLOG;
+       BLOG *BL = (BLOG*) malloc(sizeof(BLOG)); 
+       BL->BLOG = NewHash(1, lFlathash);
+       
+       /* are we looking for a specific post? */
+       BL->p = lbstr("p");
+       BL->gotonext = havebstr("gotonext");
+       BL->Charset = NewStrBuf();
+       BL->Buf = NewStrBuf();
+       *ViewSpecific = BL;
 
        Stat->startmsg = (-1);                                  /* not used here */
        Stat->sortit = 1;                                       /* not used here */
@@ -140,47 +123,12 @@ int blogview_GetParamsGetServerCall(SharedMessageStatus *Stat,
        
        /* perform a "read all" call to fetch the message list -- we'll cut it down later */
        rlid[2].cmd(cmd, len);
-       
+       if (BL->gotonext)
+               Stat->load_seen = 1;
        return 200;
 }
 
 
-/*
- * Given a 'struct blogpost' containing a msgnum, populate the id
- * and refs fields 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 (len = StrBuf_ServGetln(Buf), 
-                      ((len >= 0) && 
-                       ((len != 3) || strcmp(ChrPtr(Buf), "000") )))
-               {
-                       if (!strncasecmp(ChrPtr(Buf), "msgn=", 5)) {
-                               StrBufCutLeft(Buf, 5);
-                               bltr.id = abs(HashLittle(ChrPtr(Buf), StrLength(Buf)));
-                       }
-                       else if (!strncasecmp(ChrPtr(Buf), "wefw=", 5)) {
-                               StrBufCutLeft(Buf, 5);          /* trim the field name */
-                               StrBufExtract_token(r, Buf, 0, '|');
-                               bltr.refs = abs(HashLittle(ChrPtr(r), StrLength(r)));
-                       }
-               }
-       }
-       FreeStrBuf(&Buf);
-       FreeStrBuf(&r);
-       return(bltr);
-}
-
-
 /*
  * This function is called for every message in the list.
  */
@@ -190,28 +138,39 @@ int blogview_LoadMsgFromServer(SharedMessageStatus *Stat,
                              int is_new, 
                              int i)
 {
-       HashList *BLOG = (HashList *) *ViewSpecific;
-       struct bltr b;
+       BLOG *BL = (BLOG*) *ViewSpecific;
        struct blogpost *bp = NULL;
 
-       b = blogview_learn_thread_references(Msg->msgnum);
+       ReadOneMessageSummary(Msg, BL->Charset, BL->Buf);
 
-       /* 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.
         */
+       if ((BL->p != 0) &&
+           (BL->p != Msg->reply_inreplyto_hash) &&
+           (BL->p != Msg->reply_references_hash)) {
+               return 200;
+       }
 
-       if (b.refs == 0) {
+       /*
+        * Add our little bundle of blogworthy wonderfulness to the hash table
+        */
+       if (Msg->reply_references_hash == 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 = Msg->reply_inreplyto_hash;
+               Put(BL->BLOG,
+                   (const char *)&Msg->reply_inreplyto_hash,
+                   sizeof(Msg->reply_inreplyto_hash),
+                   bp,
+                   (DeleteHashDataFunc)blogpost_destroy);
        }
        else {
-               GetHash(BLOG, (const char *)&b.refs , sizeof(b.refs), (void *)&bp);
+               GetHash(BL->BLOG,
+                       (const char *)&Msg->reply_references_hash,
+                       sizeof(Msg->reply_references_hash),
+                       (void *)&bp);
        }
 
        /*
@@ -232,6 +191,12 @@ int blogview_LoadMsgFromServer(SharedMessageStatus *Stat,
                                ((bp->alloc_msgs - bp->num_msgs) * sizeof(long)) );
                }
                bp->msgs[bp->num_msgs++] = Msg->msgnum;
+               if ((Msg->Flags & MSGFLAG_READ) != 0) {
+                       bp->unread_oments++;
+               }
+       }
+       else {
+               syslog(LOG_DEBUG, "** comment %ld is unparented", Msg->msgnum);
        }
 
        return 200;
@@ -239,26 +204,129 @@ int blogview_LoadMsgFromServer(SharedMessageStatus *Stat,
 
 
 /*
- * 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; */
+       BLOG *BL = (BLOG*) *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 */
+       with_comments = (BL->p != 0);
+
+       firstp = ibstr("firstp");   /* start reading at... */
+       maxp   = ibstr("maxp");     /* max posts to show... */
+       if (maxp < 1) maxp = 5;     /* default; move somewhere else? */
+
+       it = GetNewHashPos(BL->BLOG, 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.
+                */
+               struct blogpost *unread_bp = NULL;
+               int unread_count = 0;
+               while (GetNextHashPos(BL->BLOG, it, &len, &Key, &Data)) {
+                       struct blogpost *one_bp = (struct blogpost *) Data;
+                       if (one_bp->unread_oments > 0) {
+                               unread_bp = one_bp;
+                               unread_count++;
+                       }
+               }
+               if (unread_count == 1) {
+                       blogpost_render(unread_bp, 1);
 
-       /*
-        * No code needed here -- we render during disposition.
-        * Maybe this is the location where we want to handle pretty permalinks.
+                       DeleteHashPos(&it);
+                       return 0;
+               }
+
+               RewindHashPos(BL->BLOG, it, 0);
+       }
+
+       /* Iterate through the hash list and copy the data pointers into an array */
+       while (GetNextHashPos(BL->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);
+
+       /* 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);
 }
@@ -266,14 +334,17 @@ int blogview_render(SharedMessageStatus *Stat, void **ViewSpecific, long oper)
 
 int blogview_Cleanup(void **ViewSpecific)
 {
-       HashList *BLOG = (HashList *) *ViewSpecific;
-
-       DeleteHash(&BLOG);
+       BLOG *BL = (BLOG*) *ViewSpecific;
 
+       FreeStrBuf(&BL->Buf);
+       FreeStrBuf(&BL->Charset);
+       DeleteHash(&BL->BLOG);
+       free(BL);
        wDumpContent(1);
        return 0;
 }
 
+
 void 
 InitModule_BLOGVIEWRENDERERS
 (void)
@@ -282,10 +353,11 @@ InitModule_BLOGVIEWRENDERERS
                VIEW_BLOG,
                blogview_GetParamsGetServerCall,
                NULL,
+               NULL,
                NULL, 
                blogview_LoadMsgFromServer,
                blogview_render,
                blogview_Cleanup
        );
-       RegisterNamespace("BLOG:PERMALINK", 0, 0, tmplput_blog_permalink, NULL, CTX_NONE);
+       RegisterNamespace("BLOG:PERMALINK", 0, 1, tmplput_blog_permalink, NULL, CTX_NONE);
 }