Point out the missing parts of the blog view render code in comments

[citadel.git] / webcit / blogview_renderer.c

diff --git a/webcit/blogview_renderer.c b/webcit/blogview_renderer.c
index 4b286eb5db515f66e205da384e1f130d488058d0..ad287361e59a19e75134255d22c74e01c7a60da5 100644 (file)
--- a/webcit/blogview_renderer.c
+++ b/webcit/blogview_renderer.c
@@ -5,7 +5,7 @@
  *
  * 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
+ * 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,
@@ -181,8 +181,7 @@ int blogview_LoadMsgFromServer(SharedMessageStatus *Stat,
 
        /* 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).
+        * that message ID is neither the id nor the refs.
         */
 
        if (b.refs == 0) {
@@ -221,7 +220,7 @@ 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
  */
 static int blogview_sortfunc(const void *a, const void *b) { 
@@ -236,7 +235,7 @@ static int blogview_sortfunc(const void *a, const void *b) {
 
 /*
  * All blogpost entries are now in the hash list.
- * Sort them, (FIXME cull by date range if needed,) and render what we want to see.
+ * Sort them, select the desired range, and render what we want to see.
  */
 int blogview_render(SharedMessageStatus *Stat, void **ViewSpecific, long oper)
 {
@@ -250,30 +249,44 @@ int blogview_render(SharedMessageStatus *Stat, void **ViewSpecific, long oper)
        int num_blogposts = 0;
        int num_blogposts_alloc = 0;
 
+       /* 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;
-                               blogposts = malloc((num_blogposts_alloc * sizeof (struct blogpost *)));
                        }
                        else {
                                num_blogposts_alloc *= 2;
-                               blogposts = realloc(blogposts, (num_blogposts_alloc * sizeof (struct blogpost *)));
                        }
+                       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) {
+
+               /* Sort newest-to-oldest */
                qsort(blogposts, num_blogposts, sizeof(void *), blogview_sortfunc);
 
-               /* FIXME this is where we handle date ranges etc */
+               /* FIXME -- allow the user to select a starting point in the list */
+
+               /* 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=0; i<num_blogposts; ++i) {
                        blogpost_render(blogposts[i]);
                }
+
+               /* Done.  We are only freeing the array of pointers; the data itself
+                * will be freed along with the hash list.
+                */
                free(blogposts);
        }