1 // This file contains functions which implement parts of the
2 // text-mode user interface.
4 // Copyright (c) 1987-2021 by the citadel.org team
6 // This program is open source software. Use, duplication, and/or
7 // disclosure are subject to the GNU General Purpose License version 3.
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 #include "textclient.h"
17 // The help "files" are now just an embedded set of Very Long Strings. helpnames[] is
18 // an array of "file names" and helptexts[] is the "content".
34 " Citadel Help Menu\n"
36 " ? Help. (Typing a '?' will give you a menu almost anywhere)\n"
37 " A Abandon this room where you stopped reading, goto next room.\n"
38 " C Chat (multiuser chat, where available)\n"
39 " D Prints directory, if there is one in the current room.\n"
40 " E Enter a message.\n"
41 " F Read all messages in the room, forward.\n"
42 " G Goto next room which has UNREAD messages.\n"
43 " H Help. Same as '?'\n"
44 " I Reads the Information file for this room.\n"
45 " K List of Known rooms.\n"
46 " L Reads the last five messages in the room.\n"
47 " N Reads all new messages in the room.\n"
48 " O Reads all old messages, backwards.\n"
49 " P Page another user (send an instant message)\n"
50 " R Reads all messages in the room, in reverse order.\n"
51 " S Skips current room without making its messages old.\n"
52 " T Terminate (logout)\n"
53 " U Ungoto (returns to the last room you were in)\n"
54 " W Displays who is currently logged in.\n"
55 " X Toggle eXpert mode (menus and help blurbs on/off)\n"
56 " Z Zap (forget) room. (Removes the room from your list)\n"
57 " + - Goto next, previous room on current floor.\n"
58 " > < Goto next, previous floor.\n"
60 " In addition, there are dot commands. You hit the . (dot), then press the\n"
61 "first letter of each word of the command. As you hit the letters, the words\n"
62 "pop onto your screen. Exceptions: after you hit .Help or .Goto, the remainder\n"
63 "of the command is a help file name or room name.\n"
65 " *** USE .<H>elp ? for additional help *** \n",
68 "The following commands are available only to Admins. A subset of these\n"
69 "commands are available to room aides when they are currently in the room\n"
70 "they are room aide for.\n"
72 " <.> <A>dmin <K>ill this room (Delete the current room)\n"
73 " <.> <A>dmin <E>dit this room (Edit the current room's parameters)\n"
74 " <.> <A>dmin <W>ho knows room (List users with access to this room)\n"
75 " <.> <A>dmin edit <U>ser (Change user's access level, password, etc.)\n"
76 " <.> <A>dmin <V>alidate new users (Process new user registrations)\n"
77 " <.> <A>dmin enter <I>nfo file (Create/change this room's banner)\n"
78 " <.> <A>dmin <R>oom <I>nvite user (Grant access to an invitation-only room)\n"
79 " <.> <A>dmin <R>oom <K>ick out user (Revoke access to an invitation-only room)\n"
80 " <.> <A>dmin <F>ile <D>elete (Delete a file from the room's directory)\n"
81 " <.> <A>dmin <F>ile <S>end over net (Transmit a file to another node)\n"
82 " <.> <A>dmin <F>ile <M>ove (Move a file to another room's directory)\n"
83 " <.> <A>dmin <M>essage edit: (Edit system banners)\n"
84 " <.> <A>dmin <P>ost (Post a message on behalf of another user)\n"
85 " <.> <A>dmin <S>ystem configuration <G>eneral (Edit global site config)\n"
86 " <.> <A>dmin <S>ystem configuration <I>nternet (Edit Internet domains)\n"
87 " <.> <A>dmin <S>ystem configuration check <M>essage base (Internal checks)\n"
88 " <.> <A>dmin <S>ystem configuration <N>etwork (Netting with other Citadels)\n"
89 " <.> <A>dmin <S>ystem configuration network <F>ilter list\n"
90 " <.> <A>dmin <T>erminate server <N>ow (Shut down Citadel server now)\n"
91 " <.> <A>dmin <T>erminate server <S>cheduled (Shut down Citadel server later)\n"
92 " <.> <A>dmin mailing <L>ist recipients (For mailing list rooms)\n"
93 " <.> <A>dmin mailing list <D>igest recipients (For mailing list rooms)\n"
94 " <.> <A>dmin <N>etwork room sharing (Replication with other Citadels)\n"
95 " \n" " In addition, the <M>ove and <D>elete commands are available at the\n" "message prompt.\n",
100 " Floors in Citadel are used to group rooms into related subject areas,\n"
101 "just as rooms are used to group messages into manageable groups.\n"
103 " You, as a user, do NOT have to use floors. If you choose not to, you suffer\n"
104 "no penalty; you will not lose access to any rooms. You may use .EC or ;C (the\n"
105 "latter is easier to use) to decide if you want to use floors. Feel free to\n"
108 " Floor options are accessed two ways. First, if you are in floor mode, the\n"
109 "<G>oto and <S>kip commands take you to the next room with new messages on the\n"
110 "current floor; if there are none left, then the system will automatically\n"
111 "switch floors (and let you know) and put you in the first room with new messages\n"
112 "on that level. (Notice that your pattern of basic use of Citadel therefore\n"
113 "doesn't really change.)\n"
115 " Direct access to floor options is via the use of a ';' command.\n"
116 "The following commands are currently available (more can be\n"
117 "added if needed):\n"
120 " This command toggles your floor mode.\n"
122 " <;G>oto FLOORNAME\n"
123 " This command causes the system to take you to the named floor.\n"
125 " <;K>nown rooms on floors\n"
126 " List all rooms on all floors. This is a very readable way to get a list of\n"
127 "all rooms on the system.\n"
129 " <;S>kip FLOORNAME\n"
130 " This command causes the system to mark all rooms on the current floor as\n"
131 "Skipped and takes you to the floor that you specify.\n"
133 " <;Z>Forget floor\n"
134 " This command causes you to forget all the rooms currently on the current\n"
135 "floor. Unfortunately, it doesn't apply to rooms that are subsequently created\n"
136 "or moved to this floor. (Sorry.)\n"
138 " Feel free to experiment, you can't hurt yourself or the system with the\n"
139 "floor stuff unless you ZForget a floor by accident.\n",
142 " New User's Introduction to the site\n"
144 " This is an introduction to the Citadel BBS concept. It is intended\n"
145 "for new users so that they can more easily become acquainted to using\n"
146 "Citadel when accessing it in the form of a text-based BBS. Of\n"
147 "course, old users might learn something new each time they read\n"
150 " Full help for the BBS commands can be obtained by typing <.H>elp SUMMARY\n"
152 " The CITADEL BBS room concept\n"
153 " ----------------------------\n"
154 " The term BBS stands for 'Bulletin Board System'. The analogy is\n"
155 "appropriate: one posts messages so that others may read them. In\n"
156 "order to organize the posts, people can post in different areas of the\n"
157 "BBS, called rooms.\n"
158 " In order to post in a certain room, you need to be 'in' that room.\n"
159 "Your current prompt is usually the room that you are in, followed the\n"
160 "greater-than-sign, such as:\n"
164 " The easiest way to traverse the room structure is with the 'Goto'\n"
165 "command, on the 'G' key. Pressing 'G' will take you to the next room\n"
166 "in the 'march list' (see below) that has new messages in it. You can\n"
167 "read these new messages with the 'N' key.\n"
168 " Once you've 'Gotoed' every room in the system (or all of the ones\n"
169 "you choose to read) you return to the 'Lobby,' the first and last room\n"
170 "in the system. If new messages get posted to rooms you've already\n"
171 "read during your session you will be brought BACK to those rooms so\n"
172 "you can read them.\n"
176 " All the room names are stored in a march list, which is just a\n"
177 "list containing all the room names. When you <G>oto or <S>kip a\n"
178 "room, you are placed in the next room in your march list THAT HAS NEW\n"
179 "MESSAGES. If you have no new messages in any of the rooms on your\n"
180 "march list, you will keep going to the Lobby>. You can choose not to\n"
181 "read certain rooms (that don't interest you) by 'Z'apping them. When\n"
182 "you <Z>ap a room, you are merely deleting it from your march list (but\n"
183 "not from anybody else's).\n"
185 " You can use the <.G>oto (note the period before the G. You can also use\n"
186 "<J>ump on some systems) to go to any room in the\n"
187 "system. You don't have to type in the complete name of a room to\n"
188 "'jump' to it; you merely need to type in enough to distinguish it from\n"
189 "the other rooms. Left-aligned matches carry a heavier weight, so if you\n"
190 "typed (for example) '.Goto TECH', you might be taken to a room called\n"
191 "'Tech Area>' even if it found a room called 'Biotech/Ethics>' first.\n"
193 " To return to a room you have previously <Z>apped, use the <.G>oto command\n"
194 "to enter it, and it will be re-inserted into your march list. In the case\n"
195 "of returning to Zapped rooms, you must type the room name in its entirety.\n"
196 "REMEMBER, rooms with no new messages will not show on your\n"
197 "march list! You must <.G>oto to a room with no new messages.\n"
198 "Incidentally, you cannot change the order of the rooms on your march list.\n"
199 "It's the same for everybody.\n"
203 " There are two special rooms on a Citadel that you should know about.\n"
205 " The first is the Lobby>. It's used for system announcements and other\n"
206 "such administrativia. You cannot <Z>ap the Lobby>. Each time you first\n"
207 "login, you will be placed in the Lobby>.\n"
209 " The second is Mail>. In Mail>, when you post a messages, you are\n"
210 "prompted to enter the screen name of the person who you want to send the\n"
211 "message to. Only the person who you send the message to can read the\n"
212 "message. NO ONE else can read it, not even the admins. Mail> is the\n"
213 "first room on the march list, and is un-<Z>appable, so you can be sure\n"
214 "that the person will get the message.\n"
218 " These people, along with the room admins, keep the site running smoothly.\n"
220 " Among the many things that admins do are: create rooms, delete\n"
221 "rooms, set access levels, invite users, check registration, grant\n"
222 "room admin status, and countless other things. They have access to the\n"
223 "Aide> room, a special room only for admins.\n"
225 " If you enter a mail message to 'Sysop' it will be placed in the\n"
226 "Aide> room so that the next admin online will read it and deal with it.\n"
227 "Admins cannot <Z>ap rooms. All the rooms are always on each admin's\n"
228 "march list. Admins can read *any* and *every* room, but they *CAN* *NOT*\n"
229 "read other users' Mail!\n"
233 " Room admins are granted special privileges in specific rooms.\n"
234 "They are *NOT* true system admins; their power extends only over the\n"
235 "rooms that they control, and they answer to the system admins.\n"
237 " A room admin's job is to keep the topic of the their room on track,\n"
238 "with nudges in the right direction now and then. A room admin can also\n"
239 "move an off topic post to another room, or delete a post, if he/she\n"
240 "feels it is necessary. \n"
242 " Currently, very few rooms have room admins. Most rooms do not need\n"
243 "their own specific room admin. Being a room admin requires a certain\n"
244 "amount of trust, due to the additional privileges granted.\n"
246 " Citadel messages\n"
247 " ----------------\n"
248 " Most of the time, the BBS code does not print a lot of messages\n"
249 "to your screen. This is a great benefit once you become familiar\n"
250 "with the system, because you do not have endless menus and screens\n"
251 "to navigate through. nevertheless, there are some messages which you\n"
252 "might see from time to time.\n"
254 " 'There were messages posted while you were entering.'\n"
256 " This is also known as 'simulposting.' When you start entering a \n"
257 "message, the system knows where you last left off. When you save\n"
258 "your message, the system checks to see if any messages were entered\n"
259 "while you were typing. This is so that you know whether you need\n"
260 "to go back and re-read the last few messages. This message may appear\n"
263 " '*** You have new mail'\n"
265 " This message is essentially the same as the above message, but can\n"
266 "appear at any time. It simply means that new mail has arrived for you while\n"
267 "you are logged in. Simply go to the Mail> room to read it.\n"
271 " The <W>ho command shows you the names of all users who are currently\n"
272 "online. It also shows you the name of the room they are currently in. If\n"
273 "they are in any type of private room, however, the room name will simply\n"
274 "display as '<private room>'. Along with this information is displayed the\n"
275 "name of the host computer the user is logged in from.\n",
278 "To send mail on this system, go to the Mail> room (using the command .G Mail)\n"
279 "and press E to enter a message. You will be prompted with:\n"
281 " Enter Recipient:\n"
283 " At this point you may enter the name of another user on the system. Private\n"
284 "mail is only readable by the sender and recipient. There is no need to delete\n"
285 "mail after it is read; it will scroll out automatically.\n"
287 " To send mail to another user on the Citadel network, simply type the\n"
288 "user's name, followed by @ and then the system name. For example,\n"
290 " Enter Recipient: Joe Schmoe @ citadrool\n"
292 " If your account is enabled for Internet mail, you can also send email to\n"
293 "anyone on the Internet here. Simply enter their address at the prompt:\n"
294 " \n" " Enter Recipient: ajc@herring.fishnet.com\n",
297 " Welcome to the network. Messages entered in a network room will appear in\n"
298 "that room on all other systems carrying it (The name of the room, however,\n" "may be different on other systems).\n",
301 " Citadel is the premier 'online community' (i.e. Bulletin Board System)\n"
302 "software. It runs on all POSIX-compliant systems, including Linux. It is an\n"
303 "advanced client/server application, and is being actively maintained.\n"
304 " \n" " For more info, visit UNCENSORED! BBS at uncensored.citadel.org\n",
307 "Extended commands are available using the period ( . ) key. To use\n"
308 "a dot command, press the . key, and then enter the first letter of\n"
309 "each word in the command. The words will appear as you enter the keys.\n"
310 "You can also backspace over partially entered commands. The following\n"
311 "commands are available:\n"
313 " <.> <H>elp: Displays help files. Type .H followed by a help file\n"
314 " name. You are now reading <.H>elp SUMMARY\n"
316 " <.> <G>oto: Jumps directly to the room you specify. You can also\n"
317 " type a partial room name, just enough to make it unique,\n"
318 " and it'll find the room you're looking for. As with the\n"
319 " regular <G>oto command, messages in the current room will\n"
320 " be marked as read.\n"
322 " <.> <S>kip, goto: This is similar to <.G>oto, except it doesn't mark\n"
323 " messages in the current room as read.\n"
325 " <.> list <Z>apped rooms Shows all rooms you've <Z>apped (forgotten)\n"
328 " Terminate (logoff) commands:\n"
330 " <.> <T>erminate and <Q>uit Log off and disconnect.\n"
331 " <.> <T>erminate and <S>tay online Log in as a different user.\n"
336 " <.> <R>ead <N>ew messages Same as <N>ew\n"
337 " <.> <R>ead <O>ld msgs reverse Same as <O>ld\n"
338 " <.> <R>ead <L>ast five msgs Same as <L>ast5\n"
339 " <.> read <L>ast: Allows you to specify how many\n"
340 " messages you wish to read.\n"
342 " <.> <R>ead <U>ser listing: Lists all users on the system if\n"
343 " you just hit enter, otherwise\n"
344 " you can specify a partial match\n"
346 " <.> <R>ead <T>extfile formatted File 'download' commands.\n"
347 " <.> <R>ead file using <X>modem \n"
348 " <.> <R>ead file using <Y>modem \n"
349 " <.> <R>ead file using <Z>modem \n"
350 " <.> <R>ead <F>ile unformatted \n"
351 " <.> <R>ead <D>irectory \n"
353 " <.> <R>ead <I>nfo file Read the room info file.\n"
354 " <.> <R>ead <B>io Read other users' 'bio' files.\n"
355 " <.> <R>ead <C>onfiguration Display your 'preferences'.\n"
356 " <.> <R>ead <S>ystem info Display system statistics.\n"
361 " <.> <E>nter <M>essage Post a message in this room.\n"
362 " <.> <E>nter message with <E>ditor Post using a full-screen editor.\n"
363 " <.> <E>nter <A>SCII message Post 'raw' (use this when 'pasting'\n"
364 " a message from your clipboard).\n"
366 " <.> <E>nter <P>assword Change your password.\n"
367 " <.> <E>nter <C>onfiguration Change your 'preferences'.\n"
368 " <.> <E>nter a new <R>oom Create a new room.\n"
369 " <.> <E>nter re<G>istration Register (name, address, etc.)\n"
370 " <.> <E>nter <B>io Enter/change your 'bio' file.\n"
372 " <.> <E>nter <T>extfile File 'upload' commands.\n"
373 " <.> <E>nter file using <X>modem \n"
374 " <.> <E>nter file using <Y>modem \n"
375 " <.> <E>nter file using <Z>modem \n"
378 " Wholist commands:\n"
380 " <.> <W>holist <L>ong Same as <W>ho is online, but displays\n"
381 " more detailed information.\n"
382 " <.> <W>holist <R>oomname Masquerade your room name (other users\n"
383 " see the name you enter rather than the\n"
384 " actual name of the room you're in)\n"
385 " <.> <W>holist <H>ostname Masquerade your host name\n"
386 " <.> <E>nter <U>sername Masquerade your user name (Admins only)\n"
387 " <.> <W>holist <S>tealth mode Enter/exit 'stealth mode' (when in stealth\n"
388 " mode you are invisible on the wholist)\n"
391 " Floor commands (if using floor mode)\n"
392 " ;<C>onfigure floor mode - turn floor mode on or off\n"
393 " ;<G>oto floor: - jump to a specific floor\n"
394 " ;<K>nown rooms - list all rooms on all floors\n"
395 " ;<S>kip to floor: - skip current floor, jump to another\n"
396 " ;<Z>ap floor - zap (forget) all rooms on this floor\n"
399 " Administrative commands: \n"
401 " <.> <A>dmin <K>ill this room \n"
402 " <.> <A>dmin <E>dit this room \n"
403 " <.> <A>dmin <W>ho knows room \n"
404 " <.> <A>dmin edit <U>ser \n"
405 " <.> <A>dmin <V>alidate new users \n"
406 " <.> <A>dmin enter <I>nfo file \n"
407 " <.> <A>dmin <R>oom <I>nvite user \n"
408 " <.> <A>dmin <R>oom <K>ick out user \n"
409 " <.> <A>dmin <F>ile <D>elete \n"
410 " <.> <A>dmin <F>ile <S>end over net \n"
411 " <.> <A>dmin <F>ile <M>ove \n"
412 " <.> <A>dmin <M>essage edit: \n"
413 " <.> <A>dmin <P>ost \n"
414 " <.> <A>dmin <S>ystem configuration \n"
415 " <.> <A>dmin <T>erminate server <N>ow\n" " <.> <A>dmin <T>erminate server <S>cheduled\n"
426 #define IFNEXPERT if ((userflags&US_EXPERT)==0)
430 char rc_exp_cmd[1024];
431 int rc_allow_attachments;
432 int rc_display_message_numbers;
433 int rc_force_mail_prompts;
434 int rc_remember_passwords;
437 int rc_prompt_control = 0;
438 time_t rc_idle_threshold = (time_t) 900;
439 char rc_url_cmd[SIZ];
440 char rc_open_cmd[SIZ];
441 char rc_gotmail_cmd[SIZ];
443 int next_lazy_cmd = 5;
445 extern int screenwidth, screenheight;
447 extern CtdlIPC *ipc_for_signal_handlers; // KLUDGE cover your eyes
448 struct citcmd *cmdlist = NULL;
451 // these variables are local to this module
452 char keepalives_enabled = KA_YES; // send NOOPs to server when idle
453 int ok_to_interrupt = 0; // print instant msgs asynchronously
454 time_t AnsiDetect; // when did we send the detect code?
455 int enable_color = 0; // nonzero for ANSI color
458 // If an interesting key has been pressed, return its value, otherwise 0
459 char was_a_key_pressed(void) {
469 retval = select(1, &rfds, NULL, NULL, &tv);
471 // Careful! Disable keepalives during keyboard polling; we're probably
472 // in the middle of a data transfer from the server, in which case
473 // sending a NOOP would throw the client protocol out of sync.
474 if ((retval > 0) && FD_ISSET(0, &rfds)) {
475 set_keepalives(KA_NO);
476 the_character = inkey();
477 set_keepalives(KA_YES);
482 return (the_character);
486 // display_instant_messages() - print instant messages if there are any
487 void display_instant_messages(void) {
495 char *listing = NULL;
496 int r; // IPC result code
498 if (instant_msgs == 0) {
506 if (IsEmptyStr(rc_exp_cmd)) {
511 while (instant_msgs != 0) {
512 r = CtdlIPCGetInstantMessage(ipc_for_signal_handlers, &listing, buf);
517 instant_msgs = extract_int(buf, 0);
518 timestamp = extract_long(buf, 1);
519 flags = extract_int(buf, 2);
520 extract_token(sender, buf, 3, '|', sizeof sender);
521 extract_token(node, buf, 4, '|', sizeof node);
522 strcpy(last_paged, sender);
524 localtime_r(×tamp, &stamp);
526 // If the message contains a Logoff Request, honor it.
532 if (!IsEmptyStr(rc_exp_cmd)) {
533 outpipe = popen(rc_exp_cmd, "w");
534 if (outpipe != NULL) {
535 // Header derived from flags
537 fprintf(outpipe, "Please log off now, as requested ");
539 fprintf(outpipe, "Broadcast message ");
541 fprintf(outpipe, "Chat request ");
543 fprintf(outpipe, "Message ");
544 // Timestamp. Can this be improved?
545 if (stamp.tm_hour == 0 || stamp.tm_hour == 12)
546 fprintf(outpipe, "at 12:%02d%cm", stamp.tm_min, stamp.tm_hour ? 'p' : 'a');
547 else if (stamp.tm_hour > 12) // pm
548 fprintf(outpipe, "at %d:%02dpm", stamp.tm_hour - 12, stamp.tm_min);
550 fprintf(outpipe, "at %d:%02dam", stamp.tm_hour, stamp.tm_min);
551 fprintf(outpipe, " from %s", sender);
552 if (strncmp(ipc_for_signal_handlers->ServInfo.nodename, node, 32))
553 fprintf(outpipe, " @%s", node);
554 fprintf(outpipe, ":\n%s\n", listing);
556 if (instant_msgs == 0)
561 // fall back to built-in instant message display
564 // Header derived from flags
566 scr_printf("Please log off now, as requested ");
568 scr_printf("Broadcast message ");
570 scr_printf("Chat request ");
572 scr_printf("Message ");
574 // Timestamp. Can this be improved?
575 if (stamp.tm_hour == 0 || stamp.tm_hour == 12) // 12am/12pm
576 scr_printf("at 12:%02d%cm", stamp.tm_min, stamp.tm_hour ? 'p' : 'a');
577 else if (stamp.tm_hour > 12) // pm
578 scr_printf("at %d:%02dpm", stamp.tm_hour - 12, stamp.tm_min);
580 scr_printf("at %d:%02dam", stamp.tm_hour, stamp.tm_min);
583 scr_printf(" from %s", sender);
585 // Remote node, if any
586 if (strncmp(ipc_for_signal_handlers->ServInfo.nodename, node, 32))
587 scr_printf(" @%s", node);
590 fmout(screenwidth, NULL, listing, NULL, 0);
594 scr_printf("\n---\n");
601 void set_keepalives(int s) {
602 keepalives_enabled = (char) s;
606 // This loop handles the "keepalive" messages sent to the server when idling.
607 static time_t idlet = 0;
608 static void really_do_keepalive(void) {
611 // This may sometimes get called before we are actually connected
612 // to the server. Don't do anything if we aren't connected. -IO
613 if (!ipc_for_signal_handlers)
616 // If full keepalives are enabled, send a NOOP to the server and
617 // wait for a response.
618 if (keepalives_enabled == KA_YES) {
619 CtdlIPCNoop(ipc_for_signal_handlers);
620 if (instant_msgs > 0) {
621 if (ok_to_interrupt == 1) {
622 scr_printf("\r%64s\r", "");
623 display_instant_messages();
624 scr_printf("%s%c ", room_name, room_prompt(room_flags));
630 // If half keepalives are enabled, send a QNOP to the server, then do nothing.
631 if (keepalives_enabled == KA_HALF) {
632 CtdlIPC_chat_send(ipc_for_signal_handlers, "QNOP");
637 // I changed this from static to not because I need to call it from
638 // screen.c, either that or make something in screen.c not static.
639 // Fix it how you like. Why all the staticness? stu
640 void do_keepalive(void) {
644 if ((now - idlet) < ((long) S_KEEPALIVE)) {
648 // Do a space-backspace to keep terminal sessions from idling out
649 scr_printf(" %c", 8);
652 really_do_keepalive();
656 // Get a character from the keyboard, with the watchdog timer in effect if necessary.
667 // This loop waits for keyboard input. If the keepalive
668 // timer expires, it sends a keepalive to the server if
669 // necessary and then waits again.
675 tv.tv_sec = S_KEEPALIVE;
678 select(1, &rfds, NULL, NULL, &tv);
679 } while (!FD_ISSET(0, &rfds));
681 // At this point, there's input, so fetch it.
682 // (There's a hole in the bucket...)
683 a = scr_getc(SCR_BLOCK);
695 // Returns 1 for yes, 0 for no
713 // Returns 1 for yes, 0 for no, arg is default value
734 * Function to read a line of text from the terminal.
736 * string Pointer to string buffer
738 * noshow Echo asterisks instead of keystrokes?
739 * bs Allow backspacing out of the prompt? (returns -1 if this happens)
741 * returns: string length
743 int ctdl_getline(char *string, int lim, int noshow, int bs)
745 int pos = strlen(string);
748 if (noshow && !IsEmptyStr(string)) {
749 int num_stars = strlen(string);
750 while (num_stars--) {
754 scr_printf("%s", string);
760 if ((ch == 8) && (pos > 0)) { /* backspace */
767 else if ((ch == 8) && (pos == 0) && (bs)) { /* backspace out of the prompt */
771 else if ((ch == 23) && (pos > 0)) { /* Ctrl-W deletes a word */
772 while ((pos > 0) && !isspace(string[pos])) {
778 while ((pos > 0) && !isspace(string[pos - 1])) {
786 else if (ch == 10) { /* return */
792 else if (isprint(ch)) { /* payload characters */
793 scr_putc((noshow ? '*' : ch));
802 * newprompt() prompt for a string, print the existing value, and
803 * allow the user to press return to keep it...
804 * If len is negative, pass the "noshow" flag to ctdl_getline()
806 void strprompt(char *prompt, char *str, int len)
808 display_instant_messages();
810 scr_printf("%s", prompt);
814 ctdl_getline(str, abs(len), (len < 0), 0);
819 * boolprompt() - prompt for a yes/no, print the existing value and
820 * allow the user to press return to keep it...
822 int boolprompt(char *prompt, int prev_val)
827 scr_printf("%s ", prompt);
830 color(BRIGHT_MAGENTA);
831 scr_printf("%s", (prev_val ? "Yes" : "No"));
835 r = (yesno_d(prev_val));
841 * intprompt() - like strprompt(), except for an integer
842 * (note that it RETURNS the new value!)
844 int intprompt(char *prompt, int ival, int imin, int imax)
852 snprintf(buf, sizeof buf, "%d", i);
853 strprompt(prompt, buf, 15);
855 for (p = 0; !IsEmptyStr(&buf[p]); ++p) {
856 if ((!isdigit(buf[p]))
857 && ((buf[p] != '-') || (p != 0)))
861 scr_printf("*** Must be no less than %d.\n", imin);
863 scr_printf("*** Must be no more than %d.\n", imax);
864 } while ((i < imin) || (i > imax));
869 * newprompt() prompt for a string with no existing value
870 * (clears out string buffer first)
871 * If len is negative, pass the "noshow" flag to ctdl_getline()
873 void newprompt(char *prompt, char *str, int len)
876 color(BRIGHT_MAGENTA);
877 scr_printf("%s", prompt);
879 ctdl_getline(str, abs(len), (len < 0), 0);
885 { /* returns a lower case value */
894 * parse the citadel.rc file
896 void load_command_set(void)
901 struct citcmd *lastcmd = NULL;
905 /* first, set up some defaults for non-required variables */
907 strcpy(editor_path, "");
908 strcpy(printcmd, "");
909 strcpy(imagecmd, "");
910 strcpy(rc_username, "");
911 strcpy(rc_password, "");
914 rc_allow_attachments = 0;
915 rc_remember_passwords = 0;
916 strcpy(rc_exp_cmd, "");
917 rc_display_message_numbers = 0;
918 rc_force_mail_prompts = 0;
921 strcpy(rc_url_cmd, "");
922 strcpy(rc_open_cmd, "");
923 strcpy(rc_gotmail_cmd, "");
925 rc_encrypt = RC_DEFAULT;
928 /* now try to open the citadel.rc file */
931 if (getenv("HOME") != NULL) {
932 snprintf(buf, sizeof buf, "%s/.citadelrc", getenv("HOME"));
933 ccfile = fopen(buf, "r");
935 if (getenv("APPDIR") != NULL) {
936 snprintf(buf, sizeof buf, "%s/citadel.rc", getenv("APPDIR"));
937 ccfile = fopen(buf, "r");
939 if (ccfile == NULL) {
940 ccfile = fopen(file_citadel_rc, "r");
942 if (ccfile == NULL) {
943 ccfile = fopen("/usr/local/etc/citadel.rc", "r");
945 if (ccfile == NULL) {
946 ccfile = fopen("/etc/citadel.rc", "r");
948 if (ccfile == NULL) {
949 ccfile = fopen("./citadel.rc", "r");
951 if (ccfile == NULL) {
952 perror("commands: cannot open citadel.rc");
955 while (fgets(buf, sizeof buf, ccfile) != NULL) {
956 while ((!IsEmptyStr(buf)) ? (isspace(buf[strlen(buf) - 1])) : 0)
957 buf[strlen(buf) - 1] = 0;
959 if (!strncasecmp(buf, "encrypt=", 8)) {
960 if (!strcasecmp(&buf[8], "yes")) {
964 fprintf(stderr, "citadel.rc requires encryption support but citadel is not compiled with OpenSSL");
969 else if (!strcasecmp(&buf[8], "no")) {
971 } else if (!strcasecmp(&buf[8], "default")) {
972 rc_encrypt = RC_DEFAULT;
977 if (!strncasecmp(buf, "editor=", 7)) {
978 strcpy(editor_path, &buf[7]);
981 if (!strncasecmp(buf, "printcmd=", 9))
982 strcpy(printcmd, &buf[9]);
984 if (!strncasecmp(buf, "imagecmd=", 9))
985 strcpy(imagecmd, &buf[9]);
987 if (!strncasecmp(buf, "expcmd=", 7))
988 strcpy(rc_exp_cmd, &buf[7]);
990 if (!strncasecmp(buf, "use_floors=", 11)) {
991 if (!strcasecmp(&buf[11], "yes"))
992 rc_floor_mode = RC_YES;
993 if (!strcasecmp(&buf[11], "no"))
994 rc_floor_mode = RC_NO;
995 if (!strcasecmp(&buf[11], "default"))
996 rc_floor_mode = RC_DEFAULT;
998 if (!strncasecmp(buf, "beep=", 5)) {
999 rc_exp_beep = atoi(&buf[5]);
1001 if (!strncasecmp(buf, "allow_attachments=", 18)) {
1002 rc_allow_attachments = atoi(&buf[18]);
1004 if (!strncasecmp(buf, "idle_threshold=", 15)) {
1005 rc_idle_threshold = atol(&buf[15]);
1007 if (!strncasecmp(buf, "remember_passwords=", 19)) {
1008 rc_remember_passwords = atoi(&buf[19]);
1010 if (!strncasecmp(buf, "display_message_numbers=", 24)) {
1011 rc_display_message_numbers = atoi(&buf[24]);
1013 if (!strncasecmp(buf, "force_mail_prompts=", 19)) {
1014 rc_force_mail_prompts = atoi(&buf[19]);
1016 if (!strncasecmp(buf, "ansi_color=", 11)) {
1017 if (!strncasecmp(&buf[11], "on", 2))
1019 if (!strncasecmp(&buf[11], "auto", 4))
1020 rc_ansi_color = 2; /* autodetect */
1021 if (!strncasecmp(&buf[11], "user", 4))
1022 rc_ansi_color = 3; /* user config */
1024 if (!strncasecmp(buf, "status_line=", 12)) {
1025 if (!strncasecmp(&buf[12], "on", 2))
1026 enable_status_line = 1;
1028 if (!strncasecmp(buf, "use_background=", 15)) {
1029 if (!strncasecmp(&buf[15], "on", 2))
1030 rc_color_use_bg = 9;
1032 if (!strncasecmp(buf, "prompt_control=", 15)) {
1033 if (!strncasecmp(&buf[15], "on", 2))
1034 rc_prompt_control = 1;
1035 if (!strncasecmp(&buf[15], "user", 4))
1036 rc_prompt_control = 3; /* user config */
1038 if (!strncasecmp(buf, "username=", 9))
1039 strcpy(rc_username, &buf[9]);
1041 if (!strncasecmp(buf, "password=", 9))
1042 strcpy(rc_password, &buf[9]);
1044 if (!strncasecmp(buf, "urlcmd=", 7))
1045 strcpy(rc_url_cmd, &buf[7]);
1047 if (!strncasecmp(buf, "opencmd=", 7))
1048 strcpy(rc_open_cmd, &buf[8]);
1050 if (!strncasecmp(buf, "gotmailcmd=", 11))
1051 strcpy(rc_gotmail_cmd, &buf[11]);
1053 if (!strncasecmp(buf, "cmd=", 4)) {
1054 strcpy(buf, &buf[4]);
1056 cptr = (struct citcmd *) malloc(sizeof(struct citcmd));
1058 cptr->c_cmdnum = atoi(buf);
1059 for (d = strlen(buf); d >= 0; --d)
1062 strcpy(buf, &buf[b + 1]);
1064 cptr->c_axlevel = atoi(buf);
1065 for (d = strlen(buf); d >= 0; --d)
1068 strcpy(buf, &buf[b + 1]);
1070 for (a = 0; a < 5; ++a)
1071 cptr->c_keys[a][0] = 0;
1075 buf[strlen(buf) + 1] = 0;
1076 while (!IsEmptyStr(buf)) {
1078 for (d = strlen(buf); d >= 0; --d)
1081 strncpy(cptr->c_keys[a], buf, b);
1082 cptr->c_keys[a][b] = 0;
1084 strcpy(buf, &buf[b + 1]);
1091 if (cmdlist == NULL)
1094 lastcmd->next = cptr;
1104 * return the key associated with a command
1106 char keycmd(char *cmdstr)
1110 for (a = 0; !IsEmptyStr(&cmdstr[a]); ++a)
1111 if (cmdstr[a] == '&')
1112 return (tolower(cmdstr[a + 1]));
1118 * Output the string from a key command without the ampersand
1119 * "mode" should be set to 0 for normal or 1 for <C>ommand key highlighting
1121 char *cmd_expand(char *strbuf, int mode)
1124 static char exp[64];
1127 strcpy(exp, strbuf);
1129 for (a = 0; exp[a]; ++a) {
1130 if (strbuf[a] == '&') {
1132 /* dont echo these non mnemonic command keys */
1133 int noecho = strbuf[a + 1] == '<' || strbuf[a + 1] == '>' || strbuf[a + 1] == '+' || strbuf[a + 1] == '-';
1136 strcpy(&exp[a], &exp[a + 1 + noecho]);
1140 strcpy(buf, &exp[a + 2]);
1146 if (!strncmp(&exp[a], "^r", 2)) {
1148 strcpy(&exp[a], room_name);
1149 strcat(exp, &buf[a + 2]);
1151 if (!strncmp(&exp[a], "^c", 2)) {
1153 strcpy(&exp[a + 1], &exp[a + 2]);
1163 * Comparison function to determine if entered commands match a
1164 * command loaded from the config file.
1166 int cmdmatch(char *cmdbuf, struct citcmd *cptr, int ncomp)
1177 for (a = 0; a < ncomp; ++a) {
1178 if ((tolower(cmdbuf[a]) != keycmd(cptr->c_keys[a]))
1179 || (cptr->c_axlevel > cmdax))
1187 * This function returns 1 if a given command requires a string input
1189 int requires_string(struct citcmd *cptr, int ncomp)
1194 strcpy(buf, cptr->c_keys[ncomp - 1]);
1195 for (a = 0; !IsEmptyStr(&buf[a]); ++a) {
1204 * Input a command at the main prompt.
1205 * This function returns an integer command number. If the command prompts
1206 * for a string then it is placed in the supplied buffer.
1208 int getcmd(CtdlIPC * ipc, char *argbuf)
1217 struct citcmd *cptr;
1220 * Starting a new command now, so set sigcaught to 0. This variable
1221 * is set to nonzero (usually NEXT_KEY or STOP_KEY) if a command has
1222 * been interrupted by a keypress.
1226 /* Switch color support on or off if we're in user mode */
1227 if (rc_ansi_color == 3) {
1228 if (userflags & US_COLOR)
1233 /* if we're running in idiot mode, display a cute little menu */
1236 scr_printf("-----------------------------------------------------------------------\n");
1237 scr_printf("Room cmds: <K>nown rooms, <G>oto next room, <.G>oto a specific room,\n");
1238 scr_printf(" <S>kip this room, <A>bandon this room, <Z>ap this room,\n");
1239 scr_printf(" <U>ngoto (move back)\n");
1240 scr_printf("Message cmds: <N>ew msgs, <F>orward read, <R>everse read, <O>ld msgs,\n");
1241 scr_printf(" <L>ast five msgs, <E>nter a message\n");
1242 scr_printf("General cmds: <?> help, <T>erminate, <C>hat, <W>ho is online\n");
1243 scr_printf("Misc: <X> toggle eXpert mode, <D>irectory\n");
1245 scr_printf(" (Type .Help SUMMARY for extended commands, <X> to hide this menu)\n");
1246 scr_printf("-----------------------------------------------------------------------\n");
1249 display_instant_messages();
1252 for (a = 0; a < 5; ++a)
1254 /* now the room prompt... */
1255 ok_to_interrupt = 1;
1256 color(BRIGHT_WHITE);
1257 scr_printf("\n%s", room_name);
1259 scr_printf("%c ", room_prompt(room_flags));
1263 ok_to_interrupt = 0;
1265 /* Handle the backspace key, but only if there's something
1266 * to backspace over...
1268 if ((ch == 8) && (cmdpos > 0)) {
1269 back(cmdspaces[cmdpos - 1] + 1);
1273 /* Spacebar invokes "lazy traversal" commands */
1274 if ((ch == 32) && (cmdpos == 0)) {
1275 this_lazy_cmd = next_lazy_cmd;
1276 if (this_lazy_cmd == 13)
1278 if (this_lazy_cmd == 5)
1280 for (cptr = cmdlist; cptr != NULL; cptr = cptr->next) {
1281 if (cptr->c_cmdnum == this_lazy_cmd) {
1282 for (a = 0; a < 5; ++a)
1283 if (cptr->c_keys[a][0] != 0)
1284 scr_printf("%s ", cmd_expand(cptr->c_keys[a], 0));
1286 return (this_lazy_cmd);
1290 return (this_lazy_cmd);
1292 /* Otherwise, process the command */
1293 cmdbuf[cmdpos] = tolower(ch);
1295 for (cptr = cmdlist; cptr != NULL; cptr = cptr->next) {
1296 if (cmdmatch(cmdbuf, cptr, cmdpos + 1)) {
1298 scr_printf("%s", cmd_expand(cptr->c_keys[cmdpos], 0));
1299 cmdspaces[cmdpos] = strlen(cmd_expand(cptr->c_keys[cmdpos], 0));
1301 if ((cptr->c_keys[cmdpos + 1]) != 0)
1307 for (cptr = cmdlist; cptr != NULL; cptr = cptr->next) {
1308 if (cmdmatch(cmdbuf, cptr, 5)) {
1309 /* We've found our command. */
1310 if (requires_string(cptr, cmdpos)) {
1312 ctdl_getline(argbuf, 64, 0, 0);
1317 /* If this command is one that changes rooms,
1318 * then the next lazy-command (space bar)
1319 * should be "read new" instead of "goto"
1321 if ((cptr->c_cmdnum == 5)
1322 || (cptr->c_cmdnum == 6)
1323 || (cptr->c_cmdnum == 47)
1324 || (cptr->c_cmdnum == 52)
1325 || (cptr->c_cmdnum == 16)
1326 || (cptr->c_cmdnum == 20))
1329 /* If this command is "read new"
1330 * then the next lazy-command (space bar)
1333 if (cptr->c_cmdnum == 13)
1336 return (cptr->c_cmdnum);
1342 scr_printf("\rOne of ... \n");
1343 for (cptr = cmdlist; cptr != NULL; cptr = cptr->next) {
1344 if (cmdmatch(cmdbuf, cptr, cmdpos)) {
1345 for (a = 0; a < 5; ++a) {
1346 keyopt(cmd_expand(cptr->c_keys[a], 1));
1354 scr_printf("\n%s%c ", room_name, room_prompt(room_flags));
1356 for (cptr = cmdlist; cptr != NULL; cptr = cptr->next) {
1357 if ((got == 0) && (cmdmatch(cmdbuf, cptr, cmdpos))) {
1358 for (a = 0; a < cmdpos; ++a) {
1359 scr_printf("%s ", cmd_expand(cptr->c_keys[a], 0));
1371 * set tty modes. commands are:
1373 * 01- set to Citadel mode
1374 * 2 - save current settings for later restoral
1375 * 3 - restore saved settings
1377 void stty_ctdl(int cmd) { /* SysV version of stty_ctdl() */
1378 struct termios live;
1379 static struct termios saved_settings;
1380 static int last_cmd = 0;
1387 if ((cmd == 0) || (cmd == 1)) {
1388 tcgetattr(0, &live);
1389 live.c_iflag = ISTRIP | IXON | IXANY;
1390 live.c_oflag = OPOST | ONLCR;
1391 live.c_lflag = ISIG | NOFLSH;
1393 live.c_cc[VINTR] = 0;
1394 live.c_cc[VQUIT] = 0;
1396 /* do we even need this stuff anymore? */
1397 /* live.c_line=0; */
1398 live.c_cc[VERASE] = 8;
1399 live.c_cc[VKILL] = 24;
1400 live.c_cc[VEOF] = 1;
1401 live.c_cc[VEOL] = 255;
1402 live.c_cc[VEOL2] = 0;
1403 live.c_cc[VSTART] = 0;
1404 tcsetattr(0, TCSADRAIN, &live);
1407 tcgetattr(0, &saved_settings);
1410 tcsetattr(0, TCSADRAIN, &saved_settings);
1417 * display_help() - help text viewer
1419 void display_help(CtdlIPC * ipc, char *name) {
1421 int num_helps = sizeof(helpnames) / sizeof(char *);
1423 for (i = 0; i < num_helps; ++i) {
1424 if (!strcasecmp(name, helpnames[i])) {
1425 fmout(screenwidth, NULL, helptexts[i], NULL, 0);
1430 scr_printf("'%s' not found. Enter one of:\n", name);
1431 for (i = 0; i < num_helps; ++i) {
1432 scr_printf(" %s\n", helpnames[i]);
1438 * fmout() - Citadel text formatter and paginator
1440 int fmout(int width, /* screen width to use */
1441 FILE * fpin, /* file to read from, or NULL to format given text */
1442 char *text, /* text to be formatted (when fpin is NULL */
1443 FILE * fpout, /* file to write to, or NULL to write to screen */
1444 int subst) { /* nonzero if we should use hypertext mode */
1445 char *buffer = NULL; /* The current message */
1446 char *word = NULL; /* What we are about to actually print */
1447 char *e; /* Pointer to position in text */
1448 char old = 0; /* The previous character */
1449 int column = 0; /* Current column */
1450 size_t i; /* Generic counter */
1452 /* Space for a single word, which can be at most screenwidth */
1453 word = (char *) calloc(1, width);
1455 scr_printf("Can't alloc memory to print message: %s!\n", strerror(errno));
1459 /* Read the entire message body into memory */
1461 buffer = load_message_from_file(fpin);
1463 scr_printf("Can't print message: %s!\n", strerror(errno));
1471 /* Run the message body */
1473 /* Catch characters that shouldn't be there at all */
1478 /* First, are we looking at a newline? */
1481 if (*e == ' ') { /* Paragraph */
1483 fprintf(fpout, "\n");
1488 } else if (old != ' ') { /* Don't print two spaces */
1490 fprintf(fpout, " ");
1500 /* Are we looking at a nonprintable?
1501 * (This section is now commented out because we could be displaying
1502 * a character set like UTF-8 or ISO-8859-1.)
1503 if ( (*e < 32) || (*e > 126) ) {
1508 /* Or are we looking at a space? */
1511 if (column >= width - 1) {
1512 /* Are we in the rightmost column? */
1514 fprintf(fpout, "\n");
1519 } else if (!(column == 0 && old == ' ')) {
1520 /* Eat only the first space on a line */
1522 fprintf(fpout, " ");
1528 /* ONLY eat the FIRST space on a line */
1534 /* Read a word, slightly messy */
1537 if (!isprint(e[i]) && !isspace(e[i]))
1544 /* We should never see these, but... slightly messy */
1545 if (e[i] == '\t' || e[i] == '\f' || e[i] == '\v')
1548 /* Break up really long words */
1552 strncpy(word, e, i);
1555 /* Decide where to print the word */
1556 if (column + i >= width) {
1557 /* Wrap to the next line */
1559 fprintf(fpout, "\n");
1566 /* Print the word */
1568 fprintf(fpout, "%s", word);
1570 scr_printf("%s", word);
1573 e += i; /* Start over with the whitepsace! */
1577 if (fpin) /* We allocated this, remember? */
1580 /* Is this necessary? It makes the output kind of spacey. */
1582 fprintf(fpout, "\n");
1592 * support ANSI color if defined
1594 void color(int colornum) {
1595 static int hold_color;
1596 static int current_color;
1598 if (colornum == COLOR_PUSH) {
1599 hold_color = current_color;
1603 if (colornum == COLOR_POP) {
1608 current_color = colornum;
1610 /* When switching to dim white, actually output an 'original
1611 * pair' sequence -- this looks better on black-on-white
1612 * terminals. - Changed to ORIGINAL_PAIR as this actually
1613 * wound up looking horrible on black-on-white terminals, not
1614 * to mention transparent terminals.
1616 if (colornum == ORIGINAL_PAIR)
1617 printf("\033[0;39;49m");
1619 printf("\033[%d;3%d;4%dm", (colornum & 8) ? 1 : 0, (colornum & 7), rc_color_use_bg);
1624 void cls(int colornum) {
1626 printf("\033[4%dm\033[2J\033[H\033[0m", colornum ? colornum : rc_color_use_bg);
1632 * Detect whether ANSI color is available (answerback)
1634 void send_ansi_detect(void) {
1635 if (rc_ansi_color == 2) {
1643 void look_for_ansi(void) {
1650 if (rc_ansi_color == 0) {
1652 } else if (rc_ansi_color == 1) {
1654 } else if (rc_ansi_color == 2) {
1656 /* otherwise, do the auto-detect */
1661 if ((now - AnsiDetect) < 2)
1670 select(1, &rfds, NULL, NULL, &tv);
1671 if (FD_ISSET(0, &rfds)) {
1672 abuf[strlen(abuf) + 1] = 0;
1673 rv = read(0, &abuf[strlen(abuf)], 1);
1675 scr_printf("failed to read after select: %s", strerror(errno));
1679 } while (FD_ISSET(0, &rfds));
1681 for (a = 0; !IsEmptyStr(&abuf[a]); ++a) {
1682 if ((abuf[a] == 27) && (abuf[a + 1] == '[')
1683 && (abuf[a + 2] == '?')) {
1692 * Display key options (highlight hotkeys inside angle brackets)
1694 void keyopt(char *buf) {
1698 for (i = 0; !IsEmptyStr(&buf[i]); ++i) {
1699 if (buf[i] == '<') {
1700 scr_printf("%c", buf[i]);
1701 color(BRIGHT_MAGENTA);
1703 if (buf[i] == '>' && buf[i + 1] != '>') {
1706 scr_printf("%c", buf[i]);
1714 * Present a key-menu line choice type of thing
1716 char keymenu(char *menuprompt, char *menustring) {
1722 int display_prompt = 1;
1724 choices = num_tokens(menustring, '|');
1726 if (menuprompt != NULL)
1728 if ((menuprompt != NULL) && (IsEmptyStr(menuprompt)))
1732 if (display_prompt) {
1734 scr_printf("%s ", menuprompt);
1736 for (i = 0; i < choices; ++i) {
1737 extract_token(buf, menustring, i, '|', sizeof buf);
1747 if ((do_prompt) && (ch == '?')) {
1748 scr_printf("\rOne of... ");
1750 for (i = 0; i < choices; ++i) {
1751 extract_token(buf, menustring, i, '|', sizeof buf);
1760 for (i = 0; i < choices; ++i) {
1761 extract_token(buf, menustring, i, '|', sizeof buf);
1762 for (c = 1; !IsEmptyStr(&buf[c]); ++c) {
1763 if ((ch == tolower(buf[c]))
1764 && (buf[c - 1] == '<')
1765 && (buf[c + 1] == '>')) {
1766 for (a = 0; !IsEmptyStr(&buf[a]); ++a) {
1767 if ((a != (c - 1)) && (a != (c + 1))) {