Changed 'free software' to 'open source' to piss off Richard Stallman
[citadel.git] / webcit / blogview_renderer.c
index dc376b6655192f06c963588d513fe446716807d3..5da977ba3cf7152d9fe73b63e4e491bbd7fd79d2 100644 (file)
@@ -3,10 +3,10 @@
  *
  * Copyright (c) 1996-2010 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 as
+ * published by the Free Software Foundation; either version 3 of the
+ * License, or (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  *
  * 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
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
 #include "webcit.h"
 #include "webserver.h"
 #include "groupdav.h"
 
-/*
- * Data which gets passed around between the various functions in this module
- *
+
+/* 
+ * Array type for a blog post.  The first message is the post; the rest are comments
  */
-struct blogview {
+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 */
 };
 
 
+/*
+ * 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...
+ */
+void blogpost_render_and_destroy(struct blogpost *bp) {
+       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;
+
+       if ( ((p == 0) || (p == bp->top_level_id)) && (bp->num_msgs > 0) ) {
+               /* Show the top level post */
+               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\">");
+                       wc_printf(_("%d comments"), bp->num_msgs - 1);
+                       wc_printf("</a>");
+               }
+               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("<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);
+       }
+       free(bp);
+}
+
+
+/*
+ * Data which gets returned from a call to blogview_learn_thread_references()
+ */
+struct bltr {
+       int id;
+       int refs;
+};
+
+
 /*
  * Entry point for message read operations.
  */
@@ -42,8 +98,7 @@ int blogview_GetParamsGetServerCall(SharedMessageStatus *Stat,
                                   char *cmd, 
                                   long len)
 {
-       struct blogview *BLOG = malloc(sizeof(struct blogview));
-       memset(BLOG, 0, sizeof(struct blogview));
+       HashList *BLOG = NewHash(1, NULL);
        *ViewSpecific = BLOG;
 
        Stat->startmsg = (-1);                                  /* not used here */
@@ -58,6 +113,38 @@ int blogview_GetParamsGetServerCall(SharedMessageStatus *Stat,
 }
 
 
+/*
+ * 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;
+       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")) {
+                       if (!strncasecmp(ChrPtr(Buf), "msgn=", 5)) {
+                               StrBufCutLeft(Buf, 5);
+                               bltr.id = 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 = HashLittle(ChrPtr(r), StrLength(r));
+                       }
+               }
+       }
+       FreeStrBuf(&Buf);
+       FreeStrBuf(&r);
+       return(bltr);
+}
+
+
 /*
  * This function is called for every message in the list.
  */
@@ -67,72 +154,75 @@ int blogview_LoadMsgFromServer(SharedMessageStatus *Stat,
                              int is_new, 
                              int i)
 {
-       struct blogview *BLOG = (struct blogview *) *ViewSpecific;
+       HashList *BLOG = (HashList *) *ViewSpecific;
+       struct bltr b;
+       struct blogpost *bp = NULL;
 
-       if (BLOG->alloc_msgs == 0) {
-               BLOG->alloc_msgs = 1000;
-               BLOG->msgs = malloc(BLOG->alloc_msgs * sizeof(long));
-               memset(BLOG->msgs, 0, (BLOG->alloc_msgs * sizeof(long)) );
-       }
+       b = blogview_learn_thread_references(Msg->msgnum);
 
-       /* 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)) );
+       /* 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).
+        */
+
+       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);
+       }
+       else {
+               GetHash(BLOG, (const char *)&b.refs , sizeof(b.refs), (void *)&bp);
        }
 
-       BLOG->msgs[BLOG->num_msgs++] = Msg->msgnum;
+       /*
+        * Now we have a 'struct blogpost' to which we can add a message.  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->alloc_msgs == 0) {
+                       bp->alloc_msgs = 1000;
+                       bp->msgs = malloc(bp->alloc_msgs * sizeof(long));
+                       memset(bp->msgs, 0, (bp->alloc_msgs * sizeof(long)) );
+               }
+               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)) );
+               }
+               bp->msgs[bp->num_msgs++] = Msg->msgnum;
+       }
 
        return 200;
 }
 
 
 /*
- * People expect blogs to be sorted newest-to-oldest
+ * Sort a list of 'struct blogpost' objects by newest-to-oldest msgnum.
  */
 int blogview_sortfunc(const void *s1, const void *s2) {
-       long l1;
-       long l2;
+       long *l1 = (long *)(s1);
+       long *l2 = (long *)(s2);
 
-       l1 = *(long *)(s1);
-       l2 = *(long *)(s2);
-
-       if (l1 > l2) return(-1);
-       if (l1 < l2) return(+1);
+       if (*l1 > *l2) return(-1);
+       if (*l1 < *l2) return(+1);
        return(0);
 }
 
 
-int blogview_render(SharedMessageStatus *Stat, 
-                              void **ViewSpecific, 
-                              long oper)
+int blogview_render(SharedMessageStatus *Stat, void **ViewSpecific, long oper)
 {
-       struct blogview *BLOG = (struct blogview *) *ViewSpecific;
-       int i;
-
-       if (Stat->nummsgs > 0) {
-               lprintf(9, "sorting %d messages\n", BLOG->num_msgs);
-               qsort(BLOG->msgs, (size_t)(BLOG->num_msgs), sizeof(long), blogview_sortfunc);
-       }
+       /*HashList *BLOG = (HashList *) *ViewSpecific;*/
 
-       for (i=0; (i<BLOG->num_msgs); ++i) {
-               if (BLOG->msgs[i] > 0L) {
-                       wc_printf("<p>Message %d %ld</p>\n", i, BLOG->msgs[i]);
-
-                       /* maybe put some of this into its own function later */
-                       StrBuf *Buf;
-                       Buf = NewStrBuf();
-                       serv_printf("MSG0 %ld|1", BLOG->msgs[i]);       /* top level citadel headers only */
-                       StrBuf_ServGetln(Buf);
-                       if (GetServerStatus(Buf, NULL) == 1) {
-                               while (StrBuf_ServGetln(Buf), strcmp(ChrPtr(Buf), "000")) {
-                                       wc_printf("%s<br>\n", ChrPtr(Buf));
-                               }
-                       }
-                       FreeStrBuf(&Buf);
-               }
-       }
+       /*
+        * No code needed here -- we render during disposition.
+        * Maybe this is the location where we want to handle pretty permalinks.
+        */
 
        return(0);
 }
@@ -140,17 +230,29 @@ int blogview_render(SharedMessageStatus *Stat,
 
 int blogview_Cleanup(void **ViewSpecific)
 {
-       struct blogview *BLOG = (struct blogview *) *ViewSpecific;
+       HashList *BLOG = (HashList *) *ViewSpecific;
 
-       if (BLOG->alloc_msgs != 0) {
-               free(BLOG->msgs);
-       }
-       free(BLOG);
+       DeleteHash(&BLOG);
 
        wDumpContent(1);
        return 0;
 }
 
+/*
+ * Generate a permalink for a post
+ */
+void tmplput_blog_permalink(StrBuf *Target, WCTemplputParams *TP) {
+       char perma[SIZ];
+       char encoded_perma[SIZ];
+       
+       strcpy(perma, "/readfwd?gotofirst=");
+       urlesc(&perma[strlen(perma)], sizeof(perma)-strlen(perma), ChrPtr(WC->CurRoom.name));
+       snprintf(&perma[strlen(perma)], sizeof(perma)-strlen(perma), "?p=%d", WC->bptlid);
+
+       CtdlEncodeBase64(encoded_perma, perma, strlen(perma), 0);
+       StrBufAppendPrintf(Target, "/B64%s", encoded_perma);
+}
+
 
 void 
 InitModule_BLOGVIEWRENDERERS
@@ -165,4 +267,5 @@ InitModule_BLOGVIEWRENDERERS
                blogview_render,
                blogview_Cleanup
        );
+       RegisterNamespace("BLOG:PERMALINK", 0, 0, tmplput_blog_permalink, NULL, CTX_NONE);
 }