2 * BBS View renderer module for WebCit
4 * Note: we briefly had a dynamic UI for this. I thought it was cool, but
5 * it was not received well by the user community. If you want to play
6 * with it, go get r8256 of bbsview_renderer.c and have fun.
8 * Copyright (c) 1996-2010 by the citadel.org team
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include "webserver.h"
32 * Data which gets passed around between the various functions in this module
36 long *msgs; /* Array of msgnums for messages we are displaying */
37 int num_msgs; /* Number of msgnums stored in 'msgs' */
38 long lastseen; /* The number of the last seen message in this room */
39 int alloc_msgs; /* Currently allocated size of array */
40 int requested_page; /* Which page number did the user request? */
41 int num_pages; /* Total number of pages in this room */
42 long start_reading_at; /* Start reading at the page containing this message */
47 * Attempt to determine the closest thing to the "last seen message number" using the
48 * results of the GTSN command
50 long bbsview_get_last_seen(void)
55 serv_getln(buf, sizeof buf);
58 char *comma_pos = strchr(buf, ','); /* kill first comma and everything to its right */
63 char *colon_pos = strchr(buf, ':'); /* kill first colon and everything to its left */
65 strcpy(buf, ++colon_pos);
75 * Entry point for message read operations.
77 int bbsview_GetParamsGetServerCall(SharedMessageStatus *Stat,
83 struct bbsview *BBS = malloc(sizeof(struct bbsview));
84 memset(BBS, 0, sizeof(struct bbsview));
87 Stat->startmsg = (-1); /* not used here */
88 Stat->sortit = 1; /* not used here */
89 Stat->num_displayed = DEFAULT_MAXMSGS; /* not used here */
90 BBS->requested_page = 0;
91 BBS->lastseen = bbsview_get_last_seen();
92 BBS->start_reading_at = 0;
94 /* By default, the requested page is the first one. */
95 if (havebstr("start_reading_at")) {
96 BBS->start_reading_at = lbstr("start_reading_at");
97 BBS->requested_page = (-4);
100 /* However, if we are asked to start with a specific message number, make sure
101 * we start on the page containing that message
104 /* Or, if a specific page was requested, make sure we go there */
105 else if (havebstr("page")) {
106 BBS->requested_page = ibstr("page");
109 /* Otherwise, if this is a "read new" operation, make sure we start on the page
110 * containing the first new message
112 else if (oper == 3) {
113 BBS->requested_page = (-3);
116 if (havebstr("maxmsgs")) {
117 Stat->maxmsgs = ibstr("maxmsgs");
119 if (Stat->maxmsgs == 0) Stat->maxmsgs = DEFAULT_MAXMSGS;
121 /* perform a "read all" call to fetch the message list -- we'll cut it down later */
122 rlid[2].cmd(cmd, len);
129 * This function is called for every message in the list.
131 int bbsview_LoadMsgFromServer(SharedMessageStatus *Stat,
133 message_summary* Msg,
137 struct bbsview *BBS = (struct bbsview *) *ViewSpecific;
139 if (BBS->alloc_msgs == 0) {
140 BBS->alloc_msgs = 1000;
141 BBS->msgs = malloc(BBS->alloc_msgs * sizeof(long));
142 memset(BBS->msgs, 0, (BBS->alloc_msgs * sizeof(long)) );
145 /* Check our buffer size */
146 if (BBS->num_msgs >= BBS->alloc_msgs) {
147 BBS->alloc_msgs *= 2;
148 BBS->msgs = realloc(BBS->msgs, (BBS->alloc_msgs * sizeof(long)));
149 memset(&BBS->msgs[BBS->num_msgs], 0, ((BBS->alloc_msgs - BBS->num_msgs) * sizeof(long)) );
152 BBS->msgs[BBS->num_msgs++] = Msg->msgnum;
158 int bbsview_sortfunc(const void *s1, const void *s2) {
165 if (l1 > l2) return(+1);
166 if (l1 < l2) return(-1);
171 int bbsview_RenderView_or_Tail(SharedMessageStatus *Stat,
175 struct bbsview *BBS = (struct bbsview *) *ViewSpecific;
182 wc_printf("<div class=\"fix_scrollbar_bug\">");
184 if (Stat->nummsgs > 0) {
185 lprintf(9, "sorting %d messages\n", BBS->num_msgs);
186 qsort(BBS->msgs, (size_t)(BBS->num_msgs), sizeof(long), bbsview_sortfunc);
189 if ((BBS->num_msgs % Stat->maxmsgs) == 0) {
190 BBS->num_pages = BBS->num_msgs / Stat->maxmsgs;
193 BBS->num_pages = (BBS->num_msgs / Stat->maxmsgs) + 1;
196 /* If the requested page number is "whichever page on which msg#xxxxx starts"
197 * then find the page number which contains that message.
199 if (BBS->requested_page == (-4)) {
200 if (BBS->num_msgs == 0) {
201 BBS->requested_page = 0;
204 for (i=0; i<BBS->num_msgs; ++i) {
206 (BBS->msgs[i] >= BBS->start_reading_at)
207 && (BBS->requested_page == (-4))
209 BBS->requested_page = (i / Stat->maxmsgs) ;
215 /* If the requested page number is "whichever page on which new messages start"
216 * then change that to an actual page number now.
218 if (BBS->requested_page == (-3)) {
219 if (BBS->num_msgs == 0) {
220 BBS->requested_page = 0;
223 for (i=0; i<BBS->num_msgs; ++i) {
225 (BBS->msgs[i] > BBS->lastseen)
226 && ( (i == 0) || (BBS->msgs[i-1] <= BBS->lastseen) )
228 BBS->requested_page = (i / Stat->maxmsgs) ;
234 /* Still set to -3 ? If so, that probably means that there are no new messages,
235 * so we'll go to the *end* of the final page.
237 if (BBS->requested_page == (-3)) {
238 if (BBS->num_msgs == 0) {
239 BBS->requested_page = 0;
242 BBS->requested_page = BBS->num_pages - 1;
246 /* keep the requested page within bounds */
247 if (BBS->requested_page < 0) BBS->requested_page = 0;
248 if (BBS->requested_page >= BBS->num_pages) BBS->requested_page = BBS->num_pages - 1;
250 start_index = BBS->requested_page * Stat->maxmsgs;
251 if (start_index < 0) start_index = 0;
252 end_index = start_index + Stat->maxmsgs - 1;
254 for (seq = 0; seq < 3; ++seq) { /* cheap & sleazy way of rendering the page numbers twice */
256 if ( (seq == 1) && (Stat->nummsgs > 0)) {
257 /* display the selected range of messages */
259 for (i=start_index; (i<=end_index && i<BBS->num_msgs); ++i) {
261 (BBS->msgs[i] > BBS->lastseen)
262 && ( (i == 0) || (BBS->msgs[i-1] <= BBS->lastseen) )
264 /* new messages start here */
265 do_template("start_of_new_msgs", NULL);
266 StrBufAppendPrintf(WC->trailing_javascript, "location.href=\"#newmsgs\";\n");
268 if (BBS->msgs[i] > 0L) {
269 read_message(WC->WBuf, HKEY("view_message"), BBS->msgs[i], NULL, &Mime);
272 (i == (BBS->num_msgs - 1))
273 && (BBS->msgs[i] <= BBS->lastseen)
275 /* no new messages */
276 do_template("no_new_msgs", NULL);
277 StrBufAppendPrintf(WC->trailing_javascript, "location.href=\"#nonewmsgs\";\n");
282 else if ( (seq == 0) || (seq == 2) ) {
283 /* Display the selecto-bar with the page numbers */
285 wc_printf("<div class=\"moreprompt\">");
286 wc_printf(_("Go to page: "));
289 int last = BBS->num_pages - 1;
291 for (i=0; i<=last; ++i) {
296 || (i == BBS->requested_page)
298 ((BBS->requested_page - i) < RANGE)
299 && ((BBS->requested_page - i) > (0 - RANGE))
305 && (last - BBS->requested_page > RANGE)
307 wc_printf("... ");
309 if (i == BBS->requested_page) {
313 wc_printf("<a href=\"readfwd?page=%d\">", i);
314 wc_printf("<span class=\"moreprompt_link\">");
318 && (BBS->requested_page > (RANGE + 1))
320 wc_printf(_("First"));
324 && (last - BBS->requested_page > RANGE)
326 wc_printf(_("Last"));
329 wc_printf("%d", i + 1); // change to one-based for display
331 if (i == BBS->requested_page) {
335 wc_printf("</span>");
340 && (BBS->requested_page > (RANGE + 1))
342 wc_printf(" ...");
349 wc_printf("</div>\n");
353 wc_printf("</div>\n");
358 int bbsview_Cleanup(void **ViewSpecific)
360 struct bbsview *BBS = (struct bbsview *) *ViewSpecific;
362 if (BBS->alloc_msgs != 0) {
373 InitModule_BBSVIEWRENDERERS
376 RegisterReadLoopHandlerset(
378 bbsview_GetParamsGetServerCall,
381 bbsview_LoadMsgFromServer,
382 bbsview_RenderView_or_Tail,