webcit/blogview_renderer.c

   1 /*
   2  * Blog view renderer module for WebCit
   3  *
   4  * Copyright (c) 1996-2010 by the citadel.org team
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #include "webcit.h"
  22 #include "webserver.h"
  23 #include "groupdav.h"
  24
  25
  26 /*
  27  * Array type for a blog post.  The first message is the post; the rest are comments
  28  */
  29 struct blogpost {
  30         int top_level_id;
  31         long *msgs;             /* Array of msgnums for messages we are displaying */
  32         int num_msgs;           /* Number of msgnums stored in 'msgs' */
  33         int alloc_msgs;         /* Currently allocated size of array */
  34 };
  35
  36
  37 /*
  38  * Destructor for 'struct blogpost' which does the rendering first.
  39  * By rendering from here, we eliminate the need for a separate iterator, although
  40  * we might run into trouble when we get around to displaying newest-to-oldest...
  41  */
  42 void blogpost_render_and_destroy(struct blogpost *bp) {
  43         const StrBuf *Mime;
  44         int p = 0;
  45         int i;
  46
  47         p = atoi(BSTR("p"));    /* are we looking for a specific post? */
  48
  49         if ( ((p == 0) || (p == bp->top_level_id)) && (bp->num_msgs > 0) ) {
  50                 /* Show the top level post */
  51                 read_message(WC->WBuf, HKEY("view_message"), bp->msgs[0], NULL, &Mime);
  52
  53                 if (p == 0) {
  54                         /* Show the number of comments */
  55                         wc_printf("<a href=\"readfwd?p=%d?gotofirst=", bp->top_level_id);
  56                         urlescputs(ChrPtr(WC->CurRoom.name));
  57                         wc_printf("#comments\">");
  58                         wc_printf(_("%d comments"), bp->num_msgs - 1);
  59                         wc_printf("</a>");
  60                 }
  61                 else if (bp->num_msgs < 2) {
  62                         wc_printf(_("%d comments"), 0);
  63                 }
  64                 else {
  65                         wc_printf("<a name=\"comments\"></a>\n");
  66                         wc_printf(_("%d comments"), bp->num_msgs - 1);
  67                         wc_printf("<br>\n");
  68                         wc_printf("<blockquote>");
  69                         for (i=1; i<bp->num_msgs; ++i) {
  70                                 read_message(WC->WBuf, HKEY("view_message"), bp->msgs[i], NULL, &Mime);
  71                         }
  72                         wc_printf("</blockquote>");
  73                 }
  74         }
  75
  76
  77         if (bp->alloc_msgs > 0) {
  78                 free(bp->msgs);
  79         }
  80         free(bp);
  81 }
  82
  83
  84 /*
  85  * Data which gets returned from a call to blogview_learn_thread_references()
  86  */
  87 struct bltr {
  88         int id;
  89         int refs;
  90 };
  91
  92
  93 /*
  94  * Entry point for message read operations.
  95  */
  96 int blogview_GetParamsGetServerCall(SharedMessageStatus *Stat,
  97                                    void **ViewSpecific,
  98                                    long oper,
  99                                    char *cmd,
 100                                    long len)
 101 {
 102         HashList *BLOG = NewHash(1, NULL);
 103         *ViewSpecific = BLOG;
 104
 105         Stat->startmsg = (-1);                                  /* not used here */
 106         Stat->sortit = 1;                                       /* not used here */
 107         Stat->num_displayed = DEFAULT_MAXMSGS;                  /* not used here */
 108         if (Stat->maxmsgs == 0) Stat->maxmsgs = DEFAULT_MAXMSGS;
 109
 110         /* perform a "read all" call to fetch the message list -- we'll cut it down later */
 111         rlid[2].cmd(cmd, len);
 112
 113         return 200;
 114 }
 115
 116
 117 /*
 118  * Given a 'struct blogpost' containing a msgnum, populate the id
 119  * and refs fields by fetching them from the Citadel server
 120  */
 121 struct bltr blogview_learn_thread_references(long msgnum)
 122 {
 123         StrBuf *Buf;
 124         StrBuf *r;
 125         struct bltr bltr = { 0, 0 } ;
 126         Buf = NewStrBuf();
 127         r = NewStrBuf();
 128         serv_printf("MSG0 %ld|1", msgnum);              /* top level citadel headers only */
 129         StrBuf_ServGetln(Buf);
 130         if (GetServerStatus(Buf, NULL) == 1) {
 131                 while (StrBuf_ServGetln(Buf), strcmp(ChrPtr(Buf), "000")) {
 132                         if (!strncasecmp(ChrPtr(Buf), "msgn=", 5)) {
 133                                 StrBufCutLeft(Buf, 5);
 134                                 bltr.id = HashLittle(ChrPtr(Buf), StrLength(Buf));
 135                         }
 136                         else if (!strncasecmp(ChrPtr(Buf), "wefw=", 5)) {
 137                                 StrBufCutLeft(Buf, 5);          /* trim the field name */
 138                                 StrBufExtract_token(r, Buf, 0, '|');
 139                                 bltr.refs = HashLittle(ChrPtr(r), StrLength(r));
 140                         }
 141                 }
 142         }
 143         FreeStrBuf(&Buf);
 144         FreeStrBuf(&r);
 145         return(bltr);
 146 }
 147
 148
 149 /*
 150  * This function is called for every message in the list.
 151  */
 152 int blogview_LoadMsgFromServer(SharedMessageStatus *Stat,
 153                               void **ViewSpecific,
 154                               message_summary* Msg,
 155                               int is_new,
 156                               int i)
 157 {
 158         HashList *BLOG = (HashList *) *ViewSpecific;
 159         struct bltr b;
 160         struct blogpost *bp = NULL;
 161
 162         b = blogview_learn_thread_references(Msg->msgnum);
 163
 164         /* FIXME an optimization here -- one we ought to perform -- is to exit this
 165          * function immediately if the viewer is only interested in a single post and
 166          * that message ID is neither the id nor the refs.  Actually, that might *be*
 167          * the way to display only a single message (with or without comments).
 168          */
 169
 170         if (b.refs == 0) {
 171                 bp = malloc(sizeof(struct blogpost));
 172                 if (!bp) return(200);
 173                 memset(bp, 0, sizeof (struct blogpost));
 174                 bp->top_level_id = b.id;
 175                 Put(BLOG, (const char *)&b.id, sizeof(b.id), bp,
 176                                         (DeleteHashDataFunc)blogpost_render_and_destroy);
 177         }
 178         else {
 179                 GetHash(BLOG, (const char *)&b.refs , sizeof(b.refs), (void *)&bp);
 180         }
 181
 182         /*
 183          * Now we have a 'struct blogpost' to which we can add a message.  It's either the
 184          * blog post itself or a comment attached to it; either way, the code is the same from
 185          * this point onward.
 186          */
 187         if (bp != NULL) {
 188                 if (bp->alloc_msgs == 0) {
 189                         bp->alloc_msgs = 1000;
 190                         bp->msgs = malloc(bp->alloc_msgs * sizeof(long));
 191                         memset(bp->msgs, 0, (bp->alloc_msgs * sizeof(long)) );
 192                 }
 193                 if (bp->num_msgs >= bp->alloc_msgs) {
 194                         bp->alloc_msgs *= 2;
 195                         bp->msgs = realloc(bp->msgs, (bp->alloc_msgs * sizeof(long)));
 196                         memset(&bp->msgs[bp->num_msgs], 0,
 197                                 ((bp->alloc_msgs - bp->num_msgs) * sizeof(long)) );
 198                 }
 199                 bp->msgs[bp->num_msgs++] = Msg->msgnum;
 200         }
 201
 202         return 200;
 203 }
 204
 205
 206 /*
 207  * Sort a list of 'struct blogpost' objects by newest-to-oldest msgnum.
 208  */
 209 int blogview_sortfunc(const void *s1, const void *s2) {
 210         long *l1 = (long *)(s1);
 211         long *l2 = (long *)(s2);
 212
 213         if (*l1 > *l2) return(-1);
 214         if (*l1 < *l2) return(+1);
 215         return(0);
 216 }
 217
 218
 219 int blogview_render(SharedMessageStatus *Stat, void **ViewSpecific, long oper)
 220 {
 221         /*HashList *BLOG = (HashList *) *ViewSpecific;*/
 222
 223         /*
 224          * No code needed here -- we render during disposition.
 225          * Maybe this is the location where we want to handle pretty permalinks.
 226          */
 227
 228         return(0);
 229 }
 230
 231
 232 int blogview_Cleanup(void **ViewSpecific)
 233 {
 234         HashList *BLOG = (HashList *) *ViewSpecific;
 235
 236         DeleteHash(&BLOG);
 237
 238         wDumpContent(1);
 239         return 0;
 240 }
 241
 242
 243 void
 244 InitModule_BLOGVIEWRENDERERS
 245 (void)
 246 {
 247         RegisterReadLoopHandlerset(
 248                 VIEW_BLOG,
 249                 blogview_GetParamsGetServerCall,
 250                 NULL,
 251                 NULL,
 252                 blogview_LoadMsgFromServer,
 253                 blogview_render,
 254                 blogview_Cleanup
 255         );
 256 }