1 // This file contains functions which implement parts of the
2 // text-mode user interface.
4 // Copyright (c) 1987-2022 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" " \n" " *** USE .<H>elp ? for additional help *** \n",
66 "The following commands are available only to Admins. A subset of these\n"
67 "commands are available to room aides when they are currently in the room\n"
68 "they are room aide for.\n"
70 " <.> <A>dmin <K>ill this room (Delete the current room)\n"
71 " <.> <A>dmin <E>dit this room (Edit the current room's parameters)\n"
72 " <.> <A>dmin <W>ho knows room (List users with access to this room)\n"
73 " <.> <A>dmin edit <U>ser (Change user's access level, password, etc.)\n"
74 " <.> <A>dmin <V>alidate new users (Process new user registrations)\n"
75 " <.> <A>dmin enter <I>nfo file (Create/change this room's banner)\n"
76 " <.> <A>dmin <R>oom <I>nvite user (Grant access to an invitation-only room)\n"
77 " <.> <A>dmin <R>oom <K>ick out user (Revoke access to an invitation-only room)\n"
78 " <.> <A>dmin <F>ile <D>elete (Delete a file from the room's directory)\n"
79 " <.> <A>dmin <F>ile <S>end over net (Transmit a file to another node)\n"
80 " <.> <A>dmin <F>ile <M>ove (Move a file to another room's directory)\n"
81 " <.> <A>dmin <M>essage edit: (Edit system banners)\n"
82 " <.> <A>dmin <P>ost (Post a message on behalf of another user)\n"
83 " <.> <A>dmin <S>ystem configuration <G>eneral (Edit global site config)\n"
84 " <.> <A>dmin <S>ystem configuration <I>nternet (Edit Internet domains)\n"
85 " <.> <A>dmin <S>ystem configuration check <M>essage base (Internal checks)\n"
86 " <.> <A>dmin <S>ystem configuration <N>etwork (Netting with other Citadels)\n"
87 " <.> <A>dmin <S>ystem configuration network <F>ilter list\n"
88 " <.> <A>dmin <T>erminate server <N>ow (Shut down Citadel server now)\n"
89 " <.> <A>dmin <T>erminate server <S>cheduled (Shut down Citadel server later)\n"
90 " <.> <A>dmin mailing <L>ist recipients (For mailing list rooms)\n"
91 " <.> <A>dmin mailing list <D>igest recipients (For mailing list rooms)\n"
92 " <.> <A>dmin <N>etwork room sharing (Replication with other Citadels)\n"
93 " \n" " In addition, the <M>ove and <D>elete commands are available at the\n" "message prompt.\n",
98 " Floors in Citadel are used to group rooms into related subject areas,\n"
99 "just as rooms are used to group messages into manageable groups.\n"
101 " You, as a user, do NOT have to use floors. If you choose not to, you suffer\n"
102 "no penalty; you will not lose access to any rooms. You may use .EC or ;C (the\n"
103 "latter is easier to use) to decide if you want to use floors. Feel free to\n"
106 " Floor options are accessed two ways. First, if you are in floor mode, the\n"
107 "<G>oto and <S>kip commands take you to the next room with new messages on the\n"
108 "current floor; if there are none left, then the system will automatically\n"
109 "switch floors (and let you know) and put you in the first room with new messages\n"
110 "on that level. (Notice that your pattern of basic use of Citadel therefore\n"
111 "doesn't really change.)\n"
113 " Direct access to floor options is via the use of a ';' command.\n"
114 "The following commands are currently available (more can be\n"
115 "added if needed):\n"
118 " This command toggles your floor mode.\n"
120 " <;G>oto FLOORNAME\n"
121 " This command causes the system to take you to the named floor.\n"
123 " <;K>nown rooms on floors\n"
124 " List all rooms on all floors. This is a very readable way to get a list of\n"
125 "all rooms on the system.\n"
127 " <;S>kip FLOORNAME\n"
128 " This command causes the system to mark all rooms on the current floor as\n"
129 "Skipped and takes you to the floor that you specify.\n"
131 " <;Z>Forget floor\n"
132 " This command causes you to forget all the rooms currently on the current\n"
133 "floor. Unfortunately, it doesn't apply to rooms that are subsequently created\n"
134 "or moved to this floor. (Sorry.)\n"
136 " Feel free to experiment, you can't hurt yourself or the system with the\n"
137 "floor stuff unless you ZForget a floor by accident.\n",
140 " New User's Introduction to the site\n"
142 " This is an introduction to the Citadel BBS concept. It is intended\n"
143 "for new users so that they can more easily become acquainted to using\n"
144 "Citadel when accessing it in the form of a text-based BBS. Of\n"
145 "course, old users might learn something new each time they read\n"
148 " Full help for the BBS commands can be obtained by typing <.H>elp SUMMARY\n"
150 " The CITADEL BBS room concept\n"
151 " ----------------------------\n"
152 " The term BBS stands for 'Bulletin Board System'. The analogy is\n"
153 "appropriate: one posts messages so that others may read them. In\n"
154 "order to organize the posts, people can post in different areas of the\n"
155 "BBS, called rooms.\n"
156 " In order to post in a certain room, you need to be 'in' that room.\n"
157 "Your current prompt is usually the room that you are in, followed the\n"
158 "greater-than-sign, such as:\n"
162 " The easiest way to traverse the room structure is with the 'Goto'\n"
163 "command, on the 'G' key. Pressing 'G' will take you to the next room\n"
164 "in the 'march list' (see below) that has new messages in it. You can\n"
165 "read these new messages with the 'N' key.\n"
166 " Once you've 'Gotoed' every room in the system (or all of the ones\n"
167 "you choose to read) you return to the 'Lobby,' the first and last room\n"
168 "in the system. If new messages get posted to rooms you've already\n"
169 "read during your session you will be brought BACK to those rooms so\n"
170 "you can read them.\n"
174 " All the room names are stored in a march list, which is just a\n"
175 "list containing all the room names. When you <G>oto or <S>kip a\n"
176 "room, you are placed in the next room in your march list THAT HAS NEW\n"
177 "MESSAGES. If you have no new messages in any of the rooms on your\n"
178 "march list, you will keep going to the Lobby>. You can choose not to\n"
179 "read certain rooms (that don't interest you) by 'Z'apping them. When\n"
180 "you <Z>ap a room, you are merely deleting it from your march list (but\n"
181 "not from anybody else's).\n"
183 " You can use the <.G>oto (note the period before the G. You can also use\n"
184 "<J>ump on some systems) to go to any room in the\n"
185 "system. You don't have to type in the complete name of a room to\n"
186 "'jump' to it; you merely need to type in enough to distinguish it from\n"
187 "the other rooms. Left-aligned matches carry a heavier weight, so if you\n"
188 "typed (for example) '.Goto TECH', you might be taken to a room called\n"
189 "'Tech Area>' even if it found a room called 'Biotech/Ethics>' first.\n"
191 " To return to a room you have previously <Z>apped, use the <.G>oto command\n"
192 "to enter it, and it will be re-inserted into your march list. In the case\n"
193 "of returning to Zapped rooms, you must type the room name in its entirety.\n"
194 "REMEMBER, rooms with no new messages will not show on your\n"
195 "march list! You must <.G>oto to a room with no new messages.\n"
196 "Incidentally, you cannot change the order of the rooms on your march list.\n"
197 "It's the same for everybody.\n"
201 " There are two special rooms on a Citadel that you should know about.\n"
203 " The first is the Lobby>. It's used for system announcements and other\n"
204 "such administrativia. You cannot <Z>ap the Lobby>. Each time you first\n"
205 "login, you will be placed in the Lobby>.\n"
207 " The second is Mail>. In Mail>, when you post a messages, you are\n"
208 "prompted to enter the screen name of the person who you want to send the\n"
209 "message to. Only the person who you send the message to can read the\n"
210 "message. NO ONE else can read it, not even the admins. Mail> is the\n"
211 "first room on the march list, and is un-<Z>appable, so you can be sure\n"
212 "that the person will get the message.\n"
216 " These people, along with the room admins, keep the site running smoothly.\n"
218 " Among the many things that admins do are: create rooms, delete\n"
219 "rooms, set access levels, invite users, check registration, grant\n"
220 "room admin status, and countless other things. They have access to the\n"
221 "Aide> room, a special room only for admins.\n"
223 " If you enter a mail message to 'Sysop' it will be placed in the\n"
224 "Aide> room so that the next admin online will read it and deal with it.\n"
225 "Admins cannot <Z>ap rooms. All the rooms are always on each admin's\n"
226 "march list. Admins can read *any* and *every* room, but they *CAN* *NOT*\n"
227 "read other users' Mail!\n"
231 " Room admins are granted special privileges in specific rooms.\n"
232 "They are *NOT* true system admins; their power extends only over the\n"
233 "rooms that they control, and they answer to the system admins.\n"
235 " A room admin's job is to keep the topic of the their room on track,\n"
236 "with nudges in the right direction now and then. A room admin can also\n"
237 "move an off topic post to another room, or delete a post, if he/she\n"
238 "feels it is necessary. \n"
240 " Currently, very few rooms have room admins. Most rooms do not need\n"
241 "their own specific room admin. Being a room admin requires a certain\n"
242 "amount of trust, due to the additional privileges granted.\n"
244 " Citadel messages\n"
245 " ----------------\n"
246 " Most of the time, the BBS code does not print a lot of messages\n"
247 "to your screen. This is a great benefit once you become familiar\n"
248 "with the system, because you do not have endless menus and screens\n"
249 "to navigate through. nevertheless, there are some messages which you\n"
250 "might see from time to time.\n"
252 " 'There were messages posted while you were entering.'\n"
254 " This is also known as 'simulposting.' When you start entering a \n"
255 "message, the system knows where you last left off. When you save\n"
256 "your message, the system checks to see if any messages were entered\n"
257 "while you were typing. This is so that you know whether you need\n"
258 "to go back and re-read the last few messages. This message may appear\n"
261 " '*** You have new mail'\n"
263 " This message is essentially the same as the above message, but can\n"
264 "appear at any time. It simply means that new mail has arrived for you while\n"
265 "you are logged in. Simply go to the Mail> room to read it.\n"
269 " The <W>ho command shows you the names of all users who are currently\n"
270 "online. It also shows you the name of the room they are currently in. If\n"
271 "they are in any type of private room, however, the room name will simply\n"
272 "display as '<private room>'. Along with this information is displayed the\n"
273 "name of the host computer the user is logged in from.\n",
276 "To send mail on this system, go to the Mail> room (using the command .G Mail)\n"
277 "and press E to enter a message. You will be prompted with:\n"
279 " Enter Recipient:\n"
281 " At this point you may enter the name of another user on the system. Private\n"
282 "mail is only readable by the sender and recipient. There is no need to delete\n"
283 "mail after it is read; it will scroll out automatically.\n"
285 " To send mail to another user on the Citadel network, simply type the\n"
286 "user's name, followed by @ and then the system name. For example,\n"
288 " Enter Recipient: Joe Schmoe @ citadrool\n"
290 " If your account is enabled for Internet mail, you can also send email to\n"
291 "anyone on the Internet here. Simply enter their address at the prompt:\n"
292 " \n" " Enter Recipient: ajc@herring.fishnet.com\n",
295 " Welcome to the network. Messages entered in a network room will appear in\n"
296 "that room on all other systems carrying it (The name of the room, however,\n" "may be different on other systems).\n",
299 " Citadel is the premier 'online community' (i.e. Bulletin Board System)\n"
300 "software. It runs on all POSIX-compliant systems, including Linux. It is an\n"
301 "advanced client/server application, and is being actively maintained.\n"
302 " \n" " For more info, visit UNCENSORED! BBS at uncensored.citadel.org\n",
305 "Extended commands are available using the period ( . ) key. To use\n"
306 "a dot command, press the . key, and then enter the first letter of\n"
307 "each word in the command. The words will appear as you enter the keys.\n"
308 "You can also backspace over partially entered commands. The following\n"
309 "commands are available:\n"
311 " <.> <H>elp: Displays help files. Type .H followed by a help file\n"
312 " name. You are now reading <.H>elp SUMMARY\n"
314 " <.> <G>oto: Jumps directly to the room you specify. You can also\n"
315 " type a partial room name, just enough to make it unique,\n"
316 " and it'll find the room you're looking for. As with the\n"
317 " regular <G>oto command, messages in the current room will\n"
318 " be marked as read.\n"
320 " <.> <S>kip, goto: This is similar to <.G>oto, except it doesn't mark\n"
321 " messages in the current room as read.\n"
323 " <.> list <Z>apped rooms Shows all rooms you've <Z>apped (forgotten)\n"
326 " Terminate (logoff) commands:\n"
328 " <.> <T>erminate and <Q>uit Log off and disconnect.\n"
329 " <.> <T>erminate and <S>tay online Log in as a different user.\n"
334 " <.> <R>ead <N>ew messages Same as <N>ew\n"
335 " <.> <R>ead <O>ld msgs reverse Same as <O>ld\n"
336 " <.> <R>ead <L>ast five msgs Same as <L>ast5\n"
337 " <.> read <L>ast: Allows you to specify how many\n"
338 " messages you wish to read.\n"
340 " <.> <R>ead <U>ser listing: Lists all users on the system if\n"
341 " you just hit enter, otherwise\n"
342 " you can specify a partial match\n"
344 " <.> <R>ead <T>extfile formatted File 'download' commands.\n"
345 " <.> <R>ead file using <X>modem \n"
346 " <.> <R>ead file using <Y>modem \n"
347 " <.> <R>ead file using <Z>modem \n"
348 " <.> <R>ead <F>ile unformatted \n"
349 " <.> <R>ead <D>irectory \n"
351 " <.> <R>ead <I>nfo file Read the room info file.\n"
352 " <.> <R>ead <B>io Read other users' 'bio' files.\n"
353 " <.> <R>ead <C>onfiguration Display your 'preferences'.\n"
354 " <.> <R>ead <S>ystem info Display system statistics.\n"
359 " <.> <E>nter <M>essage Post a message in this room.\n"
360 " <.> <E>nter message with <E>ditor Post using a full-screen editor.\n"
361 " <.> <E>nter <A>SCII message Post 'raw' (use this when 'pasting'\n"
362 " a message from your clipboard).\n"
364 " <.> <E>nter <P>assword Change your password.\n"
365 " <.> <E>nter <C>onfiguration Change your 'preferences'.\n"
366 " <.> <E>nter a new <R>oom Create a new room.\n"
367 " <.> <E>nter re<G>istration Register (name, address, etc.)\n"
368 " <.> <E>nter <B>io Enter/change your 'bio' file.\n"
370 " <.> <E>nter <T>extfile File 'upload' commands.\n"
371 " <.> <E>nter file using <X>modem \n"
372 " <.> <E>nter file using <Y>modem \n"
373 " <.> <E>nter file using <Z>modem \n"
376 " Wholist commands:\n"
378 " <.> <W>holist <L>ong Same as <W>ho is online, but displays\n"
379 " more detailed information.\n"
380 " <.> <W>holist <R>oomname Masquerade your room name (other users\n"
381 " see the name you enter rather than the\n"
382 " actual name of the room you're in)\n"
383 " <.> <W>holist <H>ostname Masquerade your host name\n"
384 " <.> <E>nter <U>sername Masquerade your user name (Admins only)\n"
385 " <.> <W>holist <S>tealth mode Enter/exit 'stealth mode' (when in stealth\n"
386 " mode you are invisible on the wholist)\n"
389 " Floor commands (if using floor mode)\n"
390 " ;<C>onfigure floor mode - turn floor mode on or off\n"
391 " ;<G>oto floor: - jump to a specific floor\n"
392 " ;<K>nown rooms - list all rooms on all floors\n"
393 " ;<S>kip to floor: - skip current floor, jump to another\n"
394 " ;<Z>ap floor - zap (forget) all rooms on this floor\n"
397 " Administrative commands: \n"
399 " <.> <A>dmin <K>ill this room \n"
400 " <.> <A>dmin <E>dit this room \n"
401 " <.> <A>dmin <W>ho knows room \n"
402 " <.> <A>dmin edit <U>ser \n"
403 " <.> <A>dmin <V>alidate new users \n"
404 " <.> <A>dmin enter <I>nfo file \n"
405 " <.> <A>dmin <R>oom <I>nvite user \n"
406 " <.> <A>dmin <R>oom <K>ick out user \n"
407 " <.> <A>dmin <F>ile <D>elete \n"
408 " <.> <A>dmin <F>ile <S>end over net \n"
409 " <.> <A>dmin <F>ile <M>ove \n"
410 " <.> <A>dmin <M>essage edit: \n"
411 " <.> <A>dmin <P>ost \n"
412 " <.> <A>dmin <S>ystem configuration \n"
413 " <.> <A>dmin <T>erminate server <N>ow\n" " <.> <A>dmin <T>erminate server <S>cheduled\n"
424 #define IFNEXPERT if ((userflags&US_EXPERT)==0)
428 char rc_exp_cmd[1024];
429 int rc_allow_attachments;
430 int rc_display_message_numbers;
431 int rc_force_mail_prompts;
432 int rc_remember_passwords;
435 int rc_prompt_control = 0;
436 time_t rc_idle_threshold = (time_t) 900;
437 char rc_url_cmd[SIZ];
438 char rc_open_cmd[SIZ];
439 char rc_gotmail_cmd[SIZ];
441 int next_lazy_cmd = 5;
443 extern int screenwidth, screenheight;
445 extern CtdlIPC *ipc_for_signal_handlers; // KLUDGE cover your eyes
446 struct citcmd *cmdlist = NULL;
449 // these variables are local to this module
450 char keepalives_enabled = KA_YES; // send NOOPs to server when idle
451 int ok_to_interrupt = 0; // print instant msgs asynchronously
452 time_t AnsiDetect; // when did we send the detect code?
453 int enable_color = 0; // nonzero for ANSI color
456 // If an interesting key has been pressed, return its value, otherwise 0
457 char was_a_key_pressed(void) {
467 retval = select(1, &rfds, NULL, NULL, &tv);
469 // Careful! Disable keepalives during keyboard polling; we're probably
470 // in the middle of a data transfer from the server, in which case
471 // sending a NOOP would throw the client protocol out of sync.
472 if ((retval > 0) && FD_ISSET(0, &rfds)) {
473 set_keepalives(KA_NO);
474 the_character = inkey();
475 set_keepalives(KA_YES);
480 return (the_character);
484 // display_instant_messages() - print instant messages if there are any
485 void display_instant_messages(void) {
493 char *listing = NULL;
494 int r; // IPC result code
496 if (instant_msgs == 0) {
504 if (IsEmptyStr(rc_exp_cmd)) {
509 while (instant_msgs != 0) {
510 r = CtdlIPCGetInstantMessage(ipc_for_signal_handlers, &listing, buf);
515 instant_msgs = extract_int(buf, 0);
516 timestamp = extract_long(buf, 1);
517 flags = extract_int(buf, 2);
518 extract_token(sender, buf, 3, '|', sizeof sender);
519 extract_token(node, buf, 4, '|', sizeof node);
520 strcpy(last_paged, sender);
522 localtime_r(×tamp, &stamp);
524 // If the message contains a Logoff Request, honor it.
530 if (!IsEmptyStr(rc_exp_cmd)) {
531 outpipe = popen(rc_exp_cmd, "w");
532 if (outpipe != NULL) {
533 // Header derived from flags
535 fprintf(outpipe, "Please log off now, as requested ");
537 fprintf(outpipe, "Broadcast message ");
539 fprintf(outpipe, "Chat request ");
541 fprintf(outpipe, "Message ");
542 // Timestamp. Can this be improved?
543 if (stamp.tm_hour == 0 || stamp.tm_hour == 12)
544 fprintf(outpipe, "at 12:%02d%cm", stamp.tm_min, stamp.tm_hour ? 'p' : 'a');
545 else if (stamp.tm_hour > 12) // pm
546 fprintf(outpipe, "at %d:%02dpm", stamp.tm_hour - 12, stamp.tm_min);
548 fprintf(outpipe, "at %d:%02dam", stamp.tm_hour, stamp.tm_min);
549 fprintf(outpipe, " from %s", sender);
550 if (strncmp(ipc_for_signal_handlers->ServInfo.nodename, node, 32))
551 fprintf(outpipe, " @%s", node);
552 fprintf(outpipe, ":\n%s\n", listing);
554 if (instant_msgs == 0)
559 // fall back to built-in instant message display
562 // Header derived from flags
564 scr_printf("Please log off now, as requested ");
566 scr_printf("Broadcast message ");
568 scr_printf("Chat request ");
570 scr_printf("Message ");
572 // Timestamp. Can this be improved?
573 if (stamp.tm_hour == 0 || stamp.tm_hour == 12) // 12am/12pm
574 scr_printf("at 12:%02d%cm", stamp.tm_min, stamp.tm_hour ? 'p' : 'a');
575 else if (stamp.tm_hour > 12) // pm
576 scr_printf("at %d:%02dpm", stamp.tm_hour - 12, stamp.tm_min);
578 scr_printf("at %d:%02dam", stamp.tm_hour, stamp.tm_min);
581 scr_printf(" from %s", sender);
583 // Remote node, if any
584 if (strncmp(ipc_for_signal_handlers->ServInfo.nodename, node, 32))
585 scr_printf(" @%s", node);
588 fmout(screenwidth, NULL, listing, NULL, 0);
592 scr_printf("\n---\n");
599 void set_keepalives(int s) {
600 keepalives_enabled = (char) s;
604 // This loop handles the "keepalive" messages sent to the server when idling.
605 static time_t idlet = 0;
606 static void really_do_keepalive(void) {
609 // This may sometimes get called before we are actually connected
610 // to the server. Don't do anything if we aren't connected. -IO
611 if (!ipc_for_signal_handlers)
614 // If full keepalives are enabled, send a NOOP to the server and
615 // wait for a response.
616 if (keepalives_enabled == KA_YES) {
617 CtdlIPCNoop(ipc_for_signal_handlers);
618 if (instant_msgs > 0) {
619 if (ok_to_interrupt == 1) {
620 scr_printf("\r%64s\r", "");
621 display_instant_messages();
622 scr_printf("%s%c ", room_name, room_prompt(room_flags));
628 // If half keepalives are enabled, send a QNOP to the server, then do nothing.
629 if (keepalives_enabled == KA_HALF) {
630 CtdlIPC_chat_send(ipc_for_signal_handlers, "QNOP");
635 // I changed this from static to not because I need to call it from
636 // screen.c, either that or make something in screen.c not static.
637 // Fix it how you like. Why all the staticness? stu
638 void do_keepalive(void) {
642 if ((now - idlet) < ((long) S_KEEPALIVE)) {
646 // Do a space-backspace to keep terminal sessions from idling out
647 scr_printf(" %c", 8);
650 really_do_keepalive();
654 // Get a character from the keyboard, with the watchdog timer in effect if necessary.
665 // This loop waits for keyboard input. If the keepalive
666 // timer expires, it sends a keepalive to the server if
667 // necessary and then waits again.
673 tv.tv_sec = S_KEEPALIVE;
676 select(1, &rfds, NULL, NULL, &tv);
677 } while (!FD_ISSET(0, &rfds));
679 // At this point, there's input, so fetch it.
680 // (There's a hole in the bucket...)
681 a = scr_getc(SCR_BLOCK);
693 // Returns 1 for yes, 0 for no
711 // Returns 1 for yes, 0 for no, arg is default value
731 // Function to read a line of text from the terminal.
733 // string Pointer to string buffer
734 // lim Maximum length
735 // noshow Echo asterisks instead of keystrokes?
736 // bs Allow backspacing out of the prompt? (returns -1 if this happens)
738 // returns: string length
739 int ctdl_getline(char *string, int lim, int noshow, int bs) {
740 int pos = strlen(string);
743 if (noshow && !IsEmptyStr(string)) {
744 int num_stars = strlen(string);
745 while (num_stars--) {
750 scr_printf("%s", string);
756 if ((ch == 8) && (pos > 0)) { // backspace
763 else if ((ch == 8) && (pos == 0) && (bs)) { // backspace out of the prompt
767 else if ((ch == 23) && (pos > 0)) { // Ctrl-W deletes a word
768 while ((pos > 0) && !isspace(string[pos])) {
774 while ((pos > 0) && !isspace(string[pos - 1])) {
782 else if (ch == 10) { // return
788 else if (isprint(ch)) { // payload characters
789 scr_putc((noshow ? '*' : ch));
797 // prompt for a string, print the existing value, and allow the user to press return to keep it...
798 // If len is negative, pass the "noshow" flag to ctdl_getline()
799 void strprompt(char *prompt, char *str, int len) {
800 display_instant_messages();
802 scr_printf("%s", prompt);
806 ctdl_getline(str, abs(len), (len < 0), 0);
811 // prompt for a yes/no, print the existing value and allow the user to press return to keep it...
812 int boolprompt(char *prompt, int prev_val) {
816 scr_printf("%s ", prompt);
819 color(BRIGHT_MAGENTA);
820 scr_printf("%s", (prev_val ? "Yes" : "No"));
824 r = (yesno_d(prev_val));
830 // like strprompt(), except for an integer (note that it RETURNS the new value!)
831 int intprompt(char *prompt, int ival, int imin, int imax) {
838 snprintf(buf, sizeof buf, "%d", i);
839 strprompt(prompt, buf, 15);
841 for (p = 0; !IsEmptyStr(&buf[p]); ++p) {
842 if ((!isdigit(buf[p]))
843 && ((buf[p] != '-') || (p != 0)))
847 scr_printf("*** Must be no less than %d.\n", imin);
849 scr_printf("*** Must be no more than %d.\n", imax);
850 } while ((i < imin) || (i > imax));
855 // prompt for a string with no existing value (clears out string buffer first)
856 // If len is negative, pass the "noshow" flag to ctdl_getline()
857 void newprompt(char *prompt, char *str, int len) {
859 color(BRIGHT_MAGENTA);
860 scr_printf("%s", prompt);
862 ctdl_getline(str, abs(len), (len < 0), 0);
867 // returns a lower case value
877 // parse the citadel.rc file
878 void load_command_set(void) {
882 struct citcmd *lastcmd = NULL;
886 // first, set up some defaults for non-required variables
887 strcpy(editor_path, "");
888 strcpy(printcmd, "");
889 strcpy(imagecmd, "");
890 strcpy(rc_username, "");
891 strcpy(rc_password, "");
894 rc_allow_attachments = 0;
895 rc_remember_passwords = 0;
896 strcpy(rc_exp_cmd, "");
897 rc_display_message_numbers = 0;
898 rc_force_mail_prompts = 0;
901 strcpy(rc_url_cmd, "");
902 strcpy(rc_open_cmd, "");
903 strcpy(rc_gotmail_cmd, "");
905 rc_encrypt = RC_DEFAULT;
908 // now try to open the citadel.rc file
910 if (getenv("HOME") != NULL) {
911 snprintf(buf, sizeof buf, "%s/.citadelrc", getenv("HOME"));
912 ccfile = fopen(buf, "r");
914 if (getenv("APPDIR") != NULL) {
915 snprintf(buf, sizeof buf, "%s/citadel.rc", getenv("APPDIR"));
916 ccfile = fopen(buf, "r");
918 if (ccfile == NULL) {
919 ccfile = fopen(file_citadel_rc, "r");
921 if (ccfile == NULL) {
922 ccfile = fopen("/usr/local/etc/citadel.rc", "r");
924 if (ccfile == NULL) {
925 ccfile = fopen("/etc/citadel.rc", "r");
927 if (ccfile == NULL) {
928 ccfile = fopen("./citadel.rc", "r");
930 if (ccfile == NULL) {
931 perror("commands: cannot open citadel.rc");
934 while (fgets(buf, sizeof buf, ccfile) != NULL) {
935 while ((!IsEmptyStr(buf)) ? (isspace(buf[strlen(buf) - 1])) : 0)
936 buf[strlen(buf) - 1] = 0;
938 if (!strncasecmp(buf, "encrypt=", 8)) {
939 if (!strcasecmp(&buf[8], "yes")) {
943 fprintf(stderr, "citadel.rc requires encryption support but citadel is not compiled with OpenSSL");
948 else if (!strcasecmp(&buf[8], "no")) {
951 else if (!strcasecmp(&buf[8], "default")) {
952 rc_encrypt = RC_DEFAULT;
957 if (!strncasecmp(buf, "editor=", 7)) {
958 strcpy(editor_path, &buf[7]);
961 if (!strncasecmp(buf, "printcmd=", 9))
962 strcpy(printcmd, &buf[9]);
964 if (!strncasecmp(buf, "imagecmd=", 9))
965 strcpy(imagecmd, &buf[9]);
967 if (!strncasecmp(buf, "expcmd=", 7))
968 strcpy(rc_exp_cmd, &buf[7]);
970 if (!strncasecmp(buf, "use_floors=", 11)) {
971 if (!strcasecmp(&buf[11], "yes"))
972 rc_floor_mode = RC_YES;
973 if (!strcasecmp(&buf[11], "no"))
974 rc_floor_mode = RC_NO;
975 if (!strcasecmp(&buf[11], "default"))
976 rc_floor_mode = RC_DEFAULT;
978 if (!strncasecmp(buf, "beep=", 5)) {
979 rc_exp_beep = atoi(&buf[5]);
981 if (!strncasecmp(buf, "allow_attachments=", 18)) {
982 rc_allow_attachments = atoi(&buf[18]);
984 if (!strncasecmp(buf, "idle_threshold=", 15)) {
985 rc_idle_threshold = atol(&buf[15]);
987 if (!strncasecmp(buf, "remember_passwords=", 19)) {
988 rc_remember_passwords = atoi(&buf[19]);
990 if (!strncasecmp(buf, "display_message_numbers=", 24)) {
991 rc_display_message_numbers = atoi(&buf[24]);
993 if (!strncasecmp(buf, "force_mail_prompts=", 19)) {
994 rc_force_mail_prompts = atoi(&buf[19]);
996 if (!strncasecmp(buf, "ansi_color=", 11)) {
997 if (!strncasecmp(&buf[11], "on", 2))
999 if (!strncasecmp(&buf[11], "auto", 4))
1000 rc_ansi_color = 2; // autodetect
1001 if (!strncasecmp(&buf[11], "user", 4))
1002 rc_ansi_color = 3; // user config
1004 if (!strncasecmp(buf, "status_line=", 12)) {
1005 if (!strncasecmp(&buf[12], "on", 2))
1006 enable_status_line = 1;
1008 if (!strncasecmp(buf, "use_background=", 15)) {
1009 if (!strncasecmp(&buf[15], "on", 2))
1010 rc_color_use_bg = 9;
1012 if (!strncasecmp(buf, "prompt_control=", 15)) {
1013 if (!strncasecmp(&buf[15], "on", 2))
1014 rc_prompt_control = 1;
1015 if (!strncasecmp(&buf[15], "user", 4))
1016 rc_prompt_control = 3; // user config
1018 if (!strncasecmp(buf, "username=", 9))
1019 strcpy(rc_username, &buf[9]);
1021 if (!strncasecmp(buf, "password=", 9))
1022 strcpy(rc_password, &buf[9]);
1024 if (!strncasecmp(buf, "urlcmd=", 7))
1025 strcpy(rc_url_cmd, &buf[7]);
1027 if (!strncasecmp(buf, "opencmd=", 7))
1028 strcpy(rc_open_cmd, &buf[8]);
1030 if (!strncasecmp(buf, "gotmailcmd=", 11))
1031 strcpy(rc_gotmail_cmd, &buf[11]);
1033 if (!strncasecmp(buf, "cmd=", 4)) {
1034 strcpy(buf, &buf[4]);
1036 cptr = (struct citcmd *) malloc(sizeof(struct citcmd));
1038 cptr->c_cmdnum = atoi(buf);
1039 for (d = strlen(buf); d >= 0; --d)
1042 strcpy(buf, &buf[b + 1]);
1044 cptr->c_axlevel = atoi(buf);
1045 for (d = strlen(buf); d >= 0; --d)
1048 strcpy(buf, &buf[b + 1]);
1050 for (a = 0; a < 5; ++a)
1051 cptr->c_keys[a][0] = 0;
1055 buf[strlen(buf) + 1] = 0;
1056 while (!IsEmptyStr(buf)) {
1058 for (d = strlen(buf); d >= 0; --d)
1061 strncpy(cptr->c_keys[a], buf, b);
1062 cptr->c_keys[a][b] = 0;
1064 strcpy(buf, &buf[b + 1]);
1071 if (cmdlist == NULL)
1074 lastcmd->next = cptr;
1082 // return the key associated with a command
1083 char keycmd(char *cmdstr) {
1086 for (a = 0; !IsEmptyStr(&cmdstr[a]); ++a)
1087 if (cmdstr[a] == '&')
1088 return (tolower(cmdstr[a + 1]));
1093 // Output the string from a key command without the ampersand
1094 // "mode" should be set to 0 for normal or 1 for <C>ommand key highlighting
1095 char *cmd_expand(char *strbuf, int mode) {
1097 static char exp[64];
1100 strcpy(exp, strbuf);
1102 for (a = 0; exp[a]; ++a) {
1103 if (strbuf[a] == '&') {
1105 // don't echo these non-mnemonic command keys
1106 int noecho = strbuf[a + 1] == '<' || strbuf[a + 1] == '>' || strbuf[a + 1] == '+' || strbuf[a + 1] == '-';
1109 strcpy(&exp[a], &exp[a + 1 + noecho]);
1113 strcpy(buf, &exp[a + 2]);
1119 if (!strncmp(&exp[a], "^r", 2)) {
1121 strcpy(&exp[a], room_name);
1122 strcat(exp, &buf[a + 2]);
1124 if (!strncmp(&exp[a], "^c", 2)) {
1126 strcpy(&exp[a + 1], &exp[a + 2]);
1134 // Comparison function to determine if entered commands match a command loaded from the config file.
1135 int cmdmatch(char *cmdbuf, struct citcmd *cptr, int ncomp) {
1145 for (a = 0; a < ncomp; ++a) {
1146 if ((tolower(cmdbuf[a]) != keycmd(cptr->c_keys[a]))
1147 || (cptr->c_axlevel > cmdax))
1154 // This function returns 1 if a given command requires a string input
1155 int requires_string(struct citcmd *cptr, int ncomp) {
1159 strcpy(buf, cptr->c_keys[ncomp - 1]);
1160 for (a = 0; !IsEmptyStr(&buf[a]); ++a) {
1168 // Input a command at the main prompt.
1169 // This function returns an integer command number. If the command prompts
1170 // for a string then it is placed in the supplied buffer.
1171 int getcmd(CtdlIPC * ipc, char *argbuf) {
1179 struct citcmd *cptr;
1181 // Starting a new command now, so set sigcaught to 0. This variable
1182 // is set to nonzero (usually NEXT_KEY or STOP_KEY) if a command has
1183 // been interrupted by a keypress.
1186 // Switch color support on or off if we're in user mode
1187 if (rc_ansi_color == 3) {
1188 if (userflags & US_COLOR)
1194 // if we're running in idiot mode, display a cute little menu
1196 scr_printf("-----------------------------------------------------------------------\n");
1197 scr_printf("Room cmds: <K>nown rooms, <G>oto next room, <.G>oto a specific room,\n");
1198 scr_printf(" <S>kip this room, <A>bandon this room, <Z>ap this room,\n");
1199 scr_printf(" <U>ngoto (move back)\n");
1200 scr_printf("Message cmds: <N>ew msgs, <F>orward read, <R>everse read, <O>ld msgs,\n");
1201 scr_printf(" <L>ast five msgs, <E>nter a message\n");
1202 scr_printf("General cmds: <?> help, <T>erminate, <C>hat, <W>ho is online\n");
1203 scr_printf("Misc: <X> toggle eXpert mode, <D>irectory\n");
1205 scr_printf(" (Type .Help SUMMARY for extended commands, <X> to hide this menu)\n");
1206 scr_printf("-----------------------------------------------------------------------\n");
1209 display_instant_messages();
1212 for (a = 0; a < 5; ++a) {
1216 // now the room prompt...
1217 ok_to_interrupt = 1;
1218 color(BRIGHT_WHITE);
1219 scr_printf("\n%s", room_name);
1221 scr_printf("%c ", room_prompt(room_flags));
1225 ok_to_interrupt = 0;
1227 // Handle the backspace key, but only if there's something to backspace over...
1228 if ((ch == 8) && (cmdpos > 0)) {
1229 back(cmdspaces[cmdpos - 1] + 1);
1234 // Spacebar invokes "lazy traversal" commands
1235 if ((ch == 32) && (cmdpos == 0)) {
1236 this_lazy_cmd = next_lazy_cmd;
1237 if (this_lazy_cmd == 13)
1239 if (this_lazy_cmd == 5)
1241 for (cptr = cmdlist; cptr != NULL; cptr = cptr->next) {
1242 if (cptr->c_cmdnum == this_lazy_cmd) {
1243 for (a = 0; a < 5; ++a)
1244 if (cptr->c_keys[a][0] != 0)
1245 scr_printf("%s ", cmd_expand(cptr->c_keys[a], 0));
1247 return (this_lazy_cmd);
1251 return (this_lazy_cmd);
1254 // Otherwise, process the command
1255 cmdbuf[cmdpos] = tolower(ch);
1257 for (cptr = cmdlist; cptr != NULL; cptr = cptr->next) {
1258 if (cmdmatch(cmdbuf, cptr, cmdpos + 1)) {
1260 scr_printf("%s", cmd_expand(cptr->c_keys[cmdpos], 0));
1261 cmdspaces[cmdpos] = strlen(cmd_expand(cptr->c_keys[cmdpos], 0));
1263 if ((cptr->c_keys[cmdpos + 1]) != 0)
1269 for (cptr = cmdlist; cptr != NULL; cptr = cptr->next) {
1270 if (cmdmatch(cmdbuf, cptr, 5)) {
1271 if (requires_string(cptr, cmdpos)) { // We found our command.
1273 ctdl_getline(argbuf, 64, 0, 0);
1279 // If this command is one that changes rooms, then the next lazy-command
1280 // (space bar) should be "read new" instead of "goto"
1281 if ((cptr->c_cmdnum == 5)
1282 || (cptr->c_cmdnum == 6)
1283 || (cptr->c_cmdnum == 47)
1284 || (cptr->c_cmdnum == 52)
1285 || (cptr->c_cmdnum == 16)
1286 || (cptr->c_cmdnum == 20)
1291 // If this command is "read new" then the next lazy-command (space bar) should be "goto"
1292 if (cptr->c_cmdnum == 13) {
1296 return (cptr->c_cmdnum);
1302 scr_printf("\rOne of ... \n");
1303 for (cptr = cmdlist; cptr != NULL; cptr = cptr->next) {
1304 if (cmdmatch(cmdbuf, cptr, cmdpos)) {
1305 for (a = 0; a < 5; ++a) {
1306 keyopt(cmd_expand(cptr->c_keys[a], 1));
1314 scr_printf("\n%s%c ", room_name, room_prompt(room_flags));
1316 for (cptr = cmdlist; cptr != NULL; cptr = cptr->next) {
1317 if ((got == 0) && (cmdmatch(cmdbuf, cptr, cmdpos))) {
1318 for (a = 0; a < cmdpos; ++a) {
1319 scr_printf("%s ", cmd_expand(cptr->c_keys[a], 0));
1330 // set tty modes. commands are:
1332 // 01- set to Citadel mode
1333 // 2 - save current settings for later restoral
1334 // 3 - restore saved settings
1335 void stty_ctdl(int cmd) {
1336 struct termios live;
1337 static struct termios saved_settings;
1338 static int last_cmd = 0;
1340 if (cmd == SB_LAST) {
1347 if ((cmd == 0) || (cmd == 1)) {
1348 tcgetattr(0, &live);
1350 // Character-by-character input instead of line mode
1351 live.c_iflag = ISTRIP | IXON | IXANY;
1352 live.c_oflag = OPOST | ONLCR;
1353 live.c_lflag = ISIG | NOFLSH;
1356 live.c_cc[VINTR] = 0;
1357 live.c_cc[VQUIT] = 0;
1358 live.c_cc[VERASE] = 8;
1359 live.c_cc[VKILL] = 24;
1360 live.c_cc[VEOF] = 1;
1361 live.c_cc[VEOL] = 255;
1362 live.c_cc[VEOL2] = 0;
1363 live.c_cc[VSTART] = 0;
1364 tcsetattr(0, TCSADRAIN, &live);
1368 tcgetattr(0, &saved_settings);
1372 tcsetattr(0, TCSADRAIN, &saved_settings);
1378 // display_help() - help text viewer
1379 void display_help(CtdlIPC * ipc, char *name) {
1381 int num_helps = sizeof(helpnames) / sizeof(char *);
1383 for (i = 0; i < num_helps; ++i) {
1384 if (!strcasecmp(name, helpnames[i])) {
1385 fmout(screenwidth, NULL, helptexts[i], NULL, 0);
1390 scr_printf("'%s' not found. Enter one of:\n", name);
1391 for (i = 0; i < num_helps; ++i) {
1392 scr_printf(" %s\n", helpnames[i]);
1397 // fmout() - Citadel text formatter and paginator
1398 int fmout(int width, // screen width to use
1399 FILE * fpin, // file to read from, or NULL to format given text
1400 char *text, // text to be formatted (when fpin is NULL
1401 FILE * fpout, // file to write to, or NULL to write to screen
1402 int subst) { // nonzero if we should use hypertext mode
1403 char *buffer = NULL; // The current message
1404 char *word = NULL; // What we are about to actually print
1405 char *e; // Pointer to position in text
1406 char old = 0; // The previous character
1407 int column = 0; // Current column
1408 size_t i; // Generic counter
1410 // Space for a single word, which can be at most screenwidth
1411 word = (char *) calloc(1, width);
1413 scr_printf("Can't alloc memory to print message: %s!\n", strerror(errno));
1417 // Read the entire message body into memory
1419 buffer = load_message_from_file(fpin);
1421 scr_printf("Can't print message: %s!\n", strerror(errno));
1430 // Run the message body
1432 // Catch characters that shouldn't be there at all
1437 if (*e == '\n') { // newline?
1439 if (*e == ' ') { // paragraph?
1441 fprintf(fpout, "\n");
1448 else if (old != ' ') { // Don't print two spaces
1450 fprintf(fpout, " ");
1461 // Or are we looking at a space?
1464 if (column >= width - 1) {
1465 // Are we in the rightmost column?
1467 fprintf(fpout, "\n");
1474 else if (!(column == 0 && old == ' ')) {
1475 // Eat only the first space on a line
1477 fprintf(fpout, " ");
1484 // ONLY eat the FIRST space on a line
1490 // Read a word, slightly messy
1493 if (!isprint(e[i]) && !isspace(e[i]))
1500 // We should never see these, but... slightly messy
1501 if (e[i] == '\t' || e[i] == '\f' || e[i] == '\v')
1504 // Break up really long words
1508 strncpy(word, e, i);
1511 // Decide where to print the word
1512 if (column + i >= width) {
1513 // Wrap to the next line
1515 fprintf(fpout, "\n");
1525 fprintf(fpout, "%s", word);
1528 scr_printf("%s", word);
1531 e += i; // Start over with the whitepsace!
1535 if (fpin) /* We allocated this, remember? */
1538 // Is this necessary? It makes the output kind of spacey.
1540 fprintf(fpout, "\n");
1550 // support ANSI color if defined
1551 void color(int colornum) {
1552 static int hold_color;
1553 static int current_color;
1555 if (colornum == COLOR_PUSH) {
1556 hold_color = current_color;
1560 if (colornum == COLOR_POP) {
1565 current_color = colornum;
1567 // When switching to dim white, actually output an 'original
1568 // pair' sequence -- this looks better on black-on-white
1569 // terminals. - Changed to ORIGINAL_PAIR as this actually
1570 // wound up looking horrible on black-on-white terminals, not
1571 // to mention transparent terminals.
1572 if (colornum == ORIGINAL_PAIR)
1573 printf("\033[0;39;49m");
1575 printf("\033[%d;3%d;4%dm", (colornum & 8) ? 1 : 0, (colornum & 7), rc_color_use_bg);
1582 void cls(int colornum) {
1584 printf("\033[4%dm\033[2J\033[H\033[0m", colornum ? colornum : rc_color_use_bg);
1589 // Detect whether ANSI color is available (answerback)
1590 void send_ansi_detect(void) {
1591 if (rc_ansi_color == 2) {
1599 void look_for_ansi(void) {
1606 if (rc_ansi_color == 0) {
1609 else if (rc_ansi_color == 1) {
1612 else if (rc_ansi_color == 2) {
1614 /* otherwise, do the auto-detect */
1619 if ((now - AnsiDetect) < 2)
1628 select(1, &rfds, NULL, NULL, &tv);
1629 if (FD_ISSET(0, &rfds)) {
1630 abuf[strlen(abuf) + 1] = 0;
1631 rv = read(0, &abuf[strlen(abuf)], 1);
1633 scr_printf("failed to read after select: %s", strerror(errno));
1637 } while (FD_ISSET(0, &rfds));
1639 for (a = 0; !IsEmptyStr(&abuf[a]); ++a) {
1640 if ((abuf[a] == 27) && (abuf[a + 1] == '[')
1641 && (abuf[a + 2] == '?')) {
1649 // Display key options (highlight hotkeys inside angle brackets)
1650 void keyopt(char *buf) {
1654 for (i = 0; !IsEmptyStr(&buf[i]); ++i) {
1655 if (buf[i] == '<') {
1656 scr_printf("%c", buf[i]);
1657 color(BRIGHT_MAGENTA);
1660 if (buf[i] == '>' && buf[i + 1] != '>') {
1663 scr_printf("%c", buf[i]);
1670 // Present a key-menu line choice type of thing
1671 char keymenu(char *menuprompt, char *menustring) {
1677 int display_prompt = 1;
1679 choices = num_tokens(menustring, '|');
1681 if (menuprompt != NULL)
1683 if ((menuprompt != NULL) && (IsEmptyStr(menuprompt)))
1687 if (display_prompt) {
1689 scr_printf("%s ", menuprompt);
1692 for (i = 0; i < choices; ++i) {
1693 extract_token(buf, menustring, i, '|', sizeof buf);
1703 if ((do_prompt) && (ch == '?')) {
1704 scr_printf("\rOne of... ");
1706 for (i = 0; i < choices; ++i) {
1707 extract_token(buf, menustring, i, '|', sizeof buf);
1716 for (i = 0; i < choices; ++i) {
1717 extract_token(buf, menustring, i, '|', sizeof buf);
1718 for (c = 1; !IsEmptyStr(&buf[c]); ++c) {
1719 if ((ch == tolower(buf[c]))
1720 && (buf[c - 1] == '<')
1721 && (buf[c + 1] == '>')) {
1722 for (a = 0; !IsEmptyStr(&buf[a]); ++a) {
1723 if ((a != (c - 1)) && (a != (c + 1))) {