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-2010 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;
185 if (Stat->nummsgs > 0) {
186 syslog(9, "sorting %d messages\n", BBS->num_msgs);
187 qsort(BBS->msgs, (size_t)(BBS->num_msgs), sizeof(long), bbsview_sortfunc);
190 if ((BBS->num_msgs % Stat->maxmsgs) == 0) {
191 BBS->num_pages = BBS->num_msgs / Stat->maxmsgs;
194 BBS->num_pages = (BBS->num_msgs / Stat->maxmsgs) + 1;
197 /* If the requested page number is -4,
198 * it means "whichever page on which msg#xxxxx starts"
199 * Change to the page number which contains that message.
201 if (BBS->requested_page == (-4)) {
202 if (BBS->num_msgs == 0) {
203 BBS->requested_page = 0;
206 for (i=0; i<BBS->num_msgs; ++i) {
208 (BBS->msgs[i] >= BBS->start_reading_at)
209 && (BBS->requested_page == (-4))
211 BBS->requested_page = (i / Stat->maxmsgs) ;
217 /* If the requested page number is -3,
218 * it means "whichever page on which new messages start"
219 * Change that to an actual page number now.
221 if (BBS->requested_page == (-3)) {
222 if (BBS->num_msgs == 0) {
223 BBS->requested_page = 0;
226 for (i=0; i<BBS->num_msgs; ++i) {
228 (BBS->msgs[i] > BBS->lastseen)
229 && ( (i == 0) || (BBS->msgs[i-1] <= BBS->lastseen) )
231 BBS->requested_page = (i / Stat->maxmsgs) ;
237 /* Still set to -3 ? If so, that probably means that there are no new messages,
238 * so we'll go to the *end* of the final page.
240 if (BBS->requested_page == (-3)) {
241 if (BBS->num_msgs == 0) {
242 BBS->requested_page = 0;
245 BBS->requested_page = BBS->num_pages - 1;
249 /* keep the requested page within bounds */
250 if (BBS->requested_page < 0) BBS->requested_page = 0;
251 if (BBS->requested_page >= BBS->num_pages) BBS->requested_page = BBS->num_pages - 1;
253 start_index = BBS->requested_page * Stat->maxmsgs;
254 if (start_index < 0) start_index = 0;
255 end_index = start_index + Stat->maxmsgs - 1;
257 for (seq = 0; seq < 3; ++seq) { /* cheap & sleazy way of rendering the page numbers twice */
259 if ( (seq == 1) && (Stat->nummsgs > 0)) {
260 /* display the selected range of messages */
262 for (i=start_index; (i<=end_index && i<BBS->num_msgs); ++i) {
264 (BBS->msgs[i] > BBS->lastseen)
265 && ( (i == 0) || (BBS->msgs[i-1] <= BBS->lastseen) )
267 /* new messages start here */
268 do_template("start_of_new_msgs", NULL);
269 StrBufAppendPrintf(WC->trailing_javascript, "location.href=\"#newmsgs\";\n");
271 if (BBS->msgs[i] > 0L) {
272 read_message(WC->WBuf, HKEY("view_message"), BBS->msgs[i], NULL, &Mime);
275 (i == (BBS->num_msgs - 1))
276 && (BBS->msgs[i] <= BBS->lastseen)
278 /* no new messages */
279 do_template("no_new_msgs", NULL);
280 StrBufAppendPrintf(WC->trailing_javascript, "location.href=\"#nonewmsgs\";\n");
285 else if ( (seq == 0) || (seq == 2) ) {
288 /* Display the selecto-bar with the page numbers */
290 wc_printf("<div class=\"moreprompt\">");
291 wc_printf(_("Go to page: "));
294 last = BBS->num_pages - 1;
296 for (i=0; i<=last; ++i) {
301 || (i == BBS->requested_page)
303 ((BBS->requested_page - i) < RANGE)
304 && ((BBS->requested_page - i) > (0 - RANGE))
310 && (last - BBS->requested_page > RANGE)
312 wc_printf("... ");
314 if (i == BBS->requested_page) {
318 wc_printf("<a href=\"readfwd?page=%d\">", i);
319 wc_printf("<span class=\"moreprompt_link\">");
323 && (BBS->requested_page > (RANGE + 1))
325 wc_printf(_("First"));
329 && (last - BBS->requested_page > RANGE)
331 wc_printf(_("Last"));
334 wc_printf("%d", i + 1); // change to one-based for display
336 if (i == BBS->requested_page) {
340 wc_printf("</span>");
345 && (BBS->requested_page > (RANGE + 1))
347 wc_printf(" ...");
354 wc_printf("</div>\n");
362 int bbsview_Cleanup(void **ViewSpecific)
364 struct bbsview *BBS = (struct bbsview *) *ViewSpecific;
366 if (BBS->alloc_msgs != 0) {
377 InitModule_BBSVIEWRENDERERS
380 RegisterReadLoopHandlerset(
382 bbsview_GetParamsGetServerCall,
385 bbsview_LoadMsgFromServer,
386 bbsview_RenderView_or_Tail,