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 commit dcf99fe61379b78436c387ea3f89ebfd4ffaf635 of
7 * bbsview_renderer.c and have fun.
9 * Copyright (c) 1996-2012 by the citadel.org team
11 * This program is open source software. You can redistribute it and/or
12 * modify it under the terms of the GNU General Public License, version 3.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
23 #include "webserver.h"
27 * Data which gets passed around between the various functions in this module
31 long *msgs; /* Array of msgnums for messages we are displaying */
32 int num_msgs; /* Number of msgnums stored in 'msgs' */
33 long lastseen; /* The number of the last seen message in this room */
34 int alloc_msgs; /* Currently allocated size of array */
35 int requested_page; /* Which page number did the user request? */
36 int num_pages; /* Total number of pages in this room */
37 long start_reading_at; /* Start reading at the page containing this message */
42 * Attempt to determine the closest thing to the "last seen message number" using the
43 * results of the GTSN command
45 long bbsview_get_last_seen(void)
50 serv_getln(buf, sizeof buf);
55 comma_pos = strchr(buf, ','); /* kill first comma and everything to its right */
60 colon_pos = strchr(buf, ':'); /* kill first colon and everything to its left */
62 strcpy(buf, ++colon_pos);
72 * Entry point for message read operations.
74 int bbsview_GetParamsGetServerCall(SharedMessageStatus *Stat,
82 struct bbsview *BBS = malloc(sizeof(struct bbsview));
83 memset(BBS, 0, sizeof(struct bbsview));
86 Stat->startmsg = (-1); /* not used here */
87 Stat->sortit = 1; /* not used here */
88 Stat->num_displayed = DEFAULT_MAXMSGS; /* not used here */
89 BBS->requested_page = 0;
90 BBS->lastseen = bbsview_get_last_seen();
91 BBS->start_reading_at = 0;
93 /* By default, the requested page is the first one. */
94 if (havebstr("start_reading_at")) {
95 BBS->start_reading_at = lbstr("start_reading_at");
96 BBS->requested_page = (-4);
99 /* However, if we are asked to start with a specific message number, make sure
100 * we start on the page containing that message
103 /* Or, if a specific page was requested, make sure we go there */
104 else if (havebstr("page")) {
105 BBS->requested_page = ibstr("page");
108 /* Otherwise, if this is a "read new" operation, make sure we start on the page
109 * containing the first new message
111 else if (oper == 3) {
112 BBS->requested_page = (-3);
115 if (havebstr("maxmsgs")) {
116 Stat->maxmsgs = ibstr("maxmsgs");
118 if (Stat->maxmsgs == 0) Stat->maxmsgs = DEFAULT_MAXMSGS;
120 /* perform a "read all" call to fetch the message list -- we'll cut it down later */
121 rlid[2].cmd(cmd, len);
128 * This function is called for every message in the list.
130 int bbsview_LoadMsgFromServer(SharedMessageStatus *Stat,
132 message_summary* Msg,
136 struct bbsview *BBS = (struct bbsview *) *ViewSpecific;
138 if (BBS->alloc_msgs == 0) {
139 BBS->alloc_msgs = 1000;
140 BBS->msgs = malloc(BBS->alloc_msgs * sizeof(long));
141 memset(BBS->msgs, 0, (BBS->alloc_msgs * sizeof(long)) );
144 /* Check our buffer size */
145 if (BBS->num_msgs >= BBS->alloc_msgs) {
146 BBS->alloc_msgs *= 2;
147 BBS->msgs = realloc(BBS->msgs, (BBS->alloc_msgs * sizeof(long)));
148 memset(&BBS->msgs[BBS->num_msgs], 0, ((BBS->alloc_msgs - BBS->num_msgs) * sizeof(long)) );
151 BBS->msgs[BBS->num_msgs++] = Msg->msgnum;
157 int bbsview_sortfunc(const void *s1, const void *s2) {
164 if (l1 > l2) return(+1);
165 if (l1 < l2) return(-1);
170 int bbsview_RenderView_or_Tail(SharedMessageStatus *Stat,
174 struct bbsview *BBS = (struct bbsview *) *ViewSpecific;
180 int go_to_the_very_end = 0;
182 if (Stat->nummsgs > 0) {
183 syslog(LOG_DEBUG, "sorting %d messages\n", BBS->num_msgs);
184 qsort(BBS->msgs, (size_t)(BBS->num_msgs), sizeof(long), bbsview_sortfunc);
187 if ((BBS->num_msgs % Stat->maxmsgs) == 0) {
188 BBS->num_pages = BBS->num_msgs / Stat->maxmsgs;
191 BBS->num_pages = (BBS->num_msgs / Stat->maxmsgs) + 1;
194 /* If the requested page number is -4,
195 * it means "whichever page on which msg#xxxxx starts"
196 * Change to the page number which contains that message.
198 if (BBS->requested_page == (-4)) {
199 if (BBS->num_msgs == 0) {
200 BBS->requested_page = 0;
203 for (i=0; i<BBS->num_msgs; ++i) {
205 (BBS->msgs[i] >= BBS->start_reading_at)
206 && (BBS->requested_page == (-4))
208 BBS->requested_page = (i / Stat->maxmsgs) ;
214 /* If the requested page number is -3,
215 * it means "whichever page on which new messages start"
216 * Change that to an actual page number now.
218 if (BBS->requested_page == (-3)) {
219 if (BBS->num_msgs == 0) {
221 * The room is empty; just start at the top and leave it there.
223 BBS->requested_page = 0;
227 && (BBS->lastseen <= BBS->msgs[0])
230 * All messages are new; this is probably the user's first visit to the room,
231 * so start at the last page instead of showing ancient history.
233 BBS->requested_page = BBS->num_pages - 1;
234 go_to_the_very_end = 1;
238 * Some messages are old and some are new. Go to the start of new messages.
240 for (i=0; i<BBS->num_msgs; ++i) {
242 (BBS->msgs[i] > BBS->lastseen)
243 && ( (i == 0) || (BBS->msgs[i-1] <= BBS->lastseen) )
245 BBS->requested_page = (i / Stat->maxmsgs) ;
251 /* Still set to -3 ? If so, that probably means that there are no new messages,
252 * so we'll go to the *end* of the final page.
254 if (BBS->requested_page == (-3)) {
255 if (BBS->num_msgs == 0) {
256 BBS->requested_page = 0;
259 BBS->requested_page = BBS->num_pages - 1;
263 /* keep the requested page within bounds */
264 if (BBS->requested_page < 0) BBS->requested_page = 0;
265 if (BBS->requested_page >= BBS->num_pages) BBS->requested_page = BBS->num_pages - 1;
267 start_index = BBS->requested_page * Stat->maxmsgs;
268 if (start_index < 0) start_index = 0;
269 end_index = start_index + Stat->maxmsgs - 1;
271 for (seq = 0; seq < 3; ++seq) { /* cheap & sleazy way of rendering the page numbers twice */
273 if ( (seq == 1) && (Stat->nummsgs > 0)) {
274 /* display the selected range of messages */
276 for (i=start_index; (i<=end_index && i<BBS->num_msgs); ++i) {
278 (BBS->msgs[i] > BBS->lastseen)
279 && ( (i == 0) || (BBS->msgs[i-1] <= BBS->lastseen) )
281 /* new messages start here */
282 do_template("start_of_new_msgs");
283 if (!go_to_the_very_end) {
284 StrBufAppendPrintf(WC->trailing_javascript, "location.href=\"#newmsgs\";\n");
287 if (BBS->msgs[i] > 0L) {
288 read_message(WC->WBuf, HKEY("view_message"), BBS->msgs[i], NULL, &Mime, NULL);
291 (i == (BBS->num_msgs - 1))
292 && (BBS->msgs[i] <= BBS->lastseen)
294 /* no new messages */
295 do_template("no_new_msgs");
296 if (!go_to_the_very_end) {
297 StrBufAppendPrintf(WC->trailing_javascript, "location.href=\"#nonewmsgs\";\n");
303 else if ( (seq == 0) || (seq == 2) ) {
306 /* Display the selecto-bar with the page numbers */
308 wc_printf("<div class=\"moreprompt\">");
310 wc_printf("<a name=\"end_of_msgs\">");
312 wc_printf(_("Go to page: "));
318 last = BBS->num_pages - 1;
320 for (i=0; i<=last; ++i) {
325 || (i == BBS->requested_page)
327 ((BBS->requested_page - i) < RANGE)
328 && ((BBS->requested_page - i) > (0 - RANGE))
334 && (last - BBS->requested_page > RANGE)
336 wc_printf("... ");
338 if (i == BBS->requested_page) {
342 wc_printf("<a href=\"readfwd?go=");
343 urlescputs(ChrPtr(WC->CurRoom.name));
344 wc_printf("?start_reading_at=%ld\">",
345 BBS->msgs[i*Stat->maxmsgs]
347 /* wc_printf("?page=%d\">", i); */
348 wc_printf("<span class=\"moreprompt_link\">");
352 && (BBS->requested_page > (RANGE + 1))
354 wc_printf(_("First"));
358 && (last - BBS->requested_page > RANGE)
360 wc_printf(_("Last"));
363 wc_printf("%d", i + 1); /* change to one-based for display */
365 if (i == BBS->requested_page) {
369 wc_printf("</span>");
374 && (BBS->requested_page > (RANGE + 1))
376 wc_printf(" ...");
383 wc_printf("</div>\n");
387 if (go_to_the_very_end) {
388 StrBufAppendPrintf(WC->trailing_javascript, "location.href=\"#end_of_msgs\";\n");
394 int bbsview_Cleanup(void **ViewSpecific)
396 struct bbsview *BBS = (struct bbsview *) *ViewSpecific;
398 if (BBS->alloc_msgs != 0) {
409 InitModule_BBSVIEWRENDERERS
412 RegisterReadLoopHandlerset(
414 bbsview_GetParamsGetServerCall,
418 bbsview_LoadMsgFromServer,
419 bbsview_RenderView_or_Tail,