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-2011 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 as
13 * published by the Free Software Foundation; either version 3 of the
14 * License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 #include "webserver.h"
33 * Data which gets passed around between the various functions in this module
37 long *msgs; /* Array of msgnums for messages we are displaying */
38 int num_msgs; /* Number of msgnums stored in 'msgs' */
39 long lastseen; /* The number of the last seen message in this room */
40 int alloc_msgs; /* Currently allocated size of array */
41 int requested_page; /* Which page number did the user request? */
42 int num_pages; /* Total number of pages in this room */
43 long start_reading_at; /* Start reading at the page containing this message */
48 * Attempt to determine the closest thing to the "last seen message number" using the
49 * results of the GTSN command
51 long bbsview_get_last_seen(void)
56 serv_getln(buf, sizeof buf);
61 comma_pos = strchr(buf, ','); /* kill first comma and everything to its right */
66 colon_pos = strchr(buf, ':'); /* kill first colon and everything to its left */
68 strcpy(buf, ++colon_pos);
78 * Entry point for message read operations.
80 int bbsview_GetParamsGetServerCall(SharedMessageStatus *Stat,
86 struct bbsview *BBS = malloc(sizeof(struct bbsview));
87 memset(BBS, 0, sizeof(struct bbsview));
90 Stat->startmsg = (-1); /* not used here */
91 Stat->sortit = 1; /* not used here */
92 Stat->num_displayed = DEFAULT_MAXMSGS; /* not used here */
93 BBS->requested_page = 0;
94 BBS->lastseen = bbsview_get_last_seen();
95 BBS->start_reading_at = 0;
97 /* By default, the requested page is the first one. */
98 if (havebstr("start_reading_at")) {
99 BBS->start_reading_at = lbstr("start_reading_at");
100 BBS->requested_page = (-4);
103 /* However, if we are asked to start with a specific message number, make sure
104 * we start on the page containing that message
107 /* Or, if a specific page was requested, make sure we go there */
108 else if (havebstr("page")) {
109 BBS->requested_page = ibstr("page");
112 /* Otherwise, if this is a "read new" operation, make sure we start on the page
113 * containing the first new message
115 else if (oper == 3) {
116 BBS->requested_page = (-3);
119 if (havebstr("maxmsgs")) {
120 Stat->maxmsgs = ibstr("maxmsgs");
122 if (Stat->maxmsgs == 0) Stat->maxmsgs = DEFAULT_MAXMSGS;
124 /* perform a "read all" call to fetch the message list -- we'll cut it down later */
125 rlid[2].cmd(cmd, len);
132 * This function is called for every message in the list.
134 int bbsview_LoadMsgFromServer(SharedMessageStatus *Stat,
136 message_summary* Msg,
140 struct bbsview *BBS = (struct bbsview *) *ViewSpecific;
142 if (BBS->alloc_msgs == 0) {
143 BBS->alloc_msgs = 1000;
144 BBS->msgs = malloc(BBS->alloc_msgs * sizeof(long));
145 memset(BBS->msgs, 0, (BBS->alloc_msgs * sizeof(long)) );
148 /* Check our buffer size */
149 if (BBS->num_msgs >= BBS->alloc_msgs) {
150 BBS->alloc_msgs *= 2;
151 BBS->msgs = realloc(BBS->msgs, (BBS->alloc_msgs * sizeof(long)));
152 memset(&BBS->msgs[BBS->num_msgs], 0, ((BBS->alloc_msgs - BBS->num_msgs) * sizeof(long)) );
155 BBS->msgs[BBS->num_msgs++] = Msg->msgnum;
161 int bbsview_sortfunc(const void *s1, const void *s2) {
168 if (l1 > l2) return(+1);
169 if (l1 < l2) return(-1);
174 int bbsview_RenderView_or_Tail(SharedMessageStatus *Stat,
178 struct bbsview *BBS = (struct bbsview *) *ViewSpecific;
184 int go_to_the_very_end = 0;
186 if (Stat->nummsgs > 0) {
187 syslog(9, "sorting %d messages\n", BBS->num_msgs);
188 qsort(BBS->msgs, (size_t)(BBS->num_msgs), sizeof(long), bbsview_sortfunc);
191 if ((BBS->num_msgs % Stat->maxmsgs) == 0) {
192 BBS->num_pages = BBS->num_msgs / Stat->maxmsgs;
195 BBS->num_pages = (BBS->num_msgs / Stat->maxmsgs) + 1;
198 /* If the requested page number is -4,
199 * it means "whichever page on which msg#xxxxx starts"
200 * Change to the page number which contains that message.
202 if (BBS->requested_page == (-4)) {
203 if (BBS->num_msgs == 0) {
204 BBS->requested_page = 0;
207 for (i=0; i<BBS->num_msgs; ++i) {
209 (BBS->msgs[i] >= BBS->start_reading_at)
210 && (BBS->requested_page == (-4))
212 BBS->requested_page = (i / Stat->maxmsgs) ;
218 /* If the requested page number is -3,
219 * it means "whichever page on which new messages start"
220 * Change that to an actual page number now.
222 if (BBS->requested_page == (-3)) {
223 if (BBS->num_msgs == 0) {
225 * The room is empty; just start at the top and leave it there.
227 BBS->requested_page = 0;
231 && (BBS->lastseen <= BBS->msgs[0])
234 * All messages are new; this is probably the user's first visit to the room,
235 * so start at the last page instead of showing ancient history.
237 BBS->requested_page = BBS->num_pages - 1;
238 go_to_the_very_end = 1;
242 * Some messages are old and some are new. Go to the start of new messages.
244 for (i=0; i<BBS->num_msgs; ++i) {
246 (BBS->msgs[i] > BBS->lastseen)
247 && ( (i == 0) || (BBS->msgs[i-1] <= BBS->lastseen) )
249 BBS->requested_page = (i / Stat->maxmsgs) ;
255 /* Still set to -3 ? If so, that probably means that there are no new messages,
256 * so we'll go to the *end* of the final page.
258 if (BBS->requested_page == (-3)) {
259 if (BBS->num_msgs == 0) {
260 BBS->requested_page = 0;
263 BBS->requested_page = BBS->num_pages - 1;
267 /* keep the requested page within bounds */
268 if (BBS->requested_page < 0) BBS->requested_page = 0;
269 if (BBS->requested_page >= BBS->num_pages) BBS->requested_page = BBS->num_pages - 1;
271 start_index = BBS->requested_page * Stat->maxmsgs;
272 if (start_index < 0) start_index = 0;
273 end_index = start_index + Stat->maxmsgs - 1;
275 for (seq = 0; seq < 3; ++seq) { /* cheap & sleazy way of rendering the page numbers twice */
277 if ( (seq == 1) && (Stat->nummsgs > 0)) {
278 /* display the selected range of messages */
280 for (i=start_index; (i<=end_index && i<BBS->num_msgs); ++i) {
282 (BBS->msgs[i] > BBS->lastseen)
283 && ( (i == 0) || (BBS->msgs[i-1] <= BBS->lastseen) )
285 /* new messages start here */
286 do_template("start_of_new_msgs");
287 if (!go_to_the_very_end) {
288 StrBufAppendPrintf(WC->trailing_javascript, "location.href=\"#newmsgs\";\n");
291 if (BBS->msgs[i] > 0L) {
292 read_message(WC->WBuf, HKEY("view_message"), BBS->msgs[i], NULL, &Mime);
295 (i == (BBS->num_msgs - 1))
296 && (BBS->msgs[i] <= BBS->lastseen)
298 /* no new messages */
299 do_template("no_new_msgs");
300 if (!go_to_the_very_end) {
301 StrBufAppendPrintf(WC->trailing_javascript, "location.href=\"#nonewmsgs\";\n");
307 else if ( (seq == 0) || (seq == 2) ) {
310 /* Display the selecto-bar with the page numbers */
312 wc_printf("<div class=\"moreprompt\">");
314 wc_printf("<a name=\"end_of_msgs\">");
316 wc_printf(_("Go to page: "));
322 last = BBS->num_pages - 1;
324 for (i=0; i<=last; ++i) {
329 || (i == BBS->requested_page)
331 ((BBS->requested_page - i) < RANGE)
332 && ((BBS->requested_page - i) > (0 - RANGE))
338 && (last - BBS->requested_page > RANGE)
340 wc_printf("... ");
342 if (i == BBS->requested_page) {
346 wc_printf("<a href=\"readfwd?page=%d\">", i);
347 wc_printf("<span class=\"moreprompt_link\">");
351 && (BBS->requested_page > (RANGE + 1))
353 wc_printf(_("First"));
357 && (last - BBS->requested_page > RANGE)
359 wc_printf(_("Last"));
362 wc_printf("%d", i + 1); /* change to one-based for display */
364 if (i == BBS->requested_page) {
368 wc_printf("</span>");
373 && (BBS->requested_page > (RANGE + 1))
375 wc_printf(" ...");
382 wc_printf("</div>\n");
386 if (go_to_the_very_end) {
387 StrBufAppendPrintf(WC->trailing_javascript, "location.href=\"#end_of_msgs\";\n");
393 int bbsview_Cleanup(void **ViewSpecific)
395 struct bbsview *BBS = (struct bbsview *) *ViewSpecific;
397 if (BBS->alloc_msgs != 0) {
408 InitModule_BBSVIEWRENDERERS
411 RegisterReadLoopHandlerset(
413 bbsview_GetParamsGetServerCall,
416 bbsview_LoadMsgFromServer,
417 bbsview_RenderView_or_Tail,