DDMsgReader.js

// $Id$

/* This is a message reader/lister door for Synchronet.  Features include:
 * - Listing messages in the user's current message area with the ability to
 *   navigate forwards & backwards through the list (and for ANSI users, a
 *   lightbar interface will be used, or optionally can be set to use a more
 *   traditional interface for ANSI users)
 * - The user can select a message from the list to read and optionally reply to
 * - For ANSI users, reading messages is done with an enhanced user interface,
 *   with the ability to scroll up & down through the message, move to the next
 *   or previous message using the right & left arrow keys, display the message
 *   list to choose another message to read, etc.
 * - The ability to start up with the message list or reading messages in the
 *   user's current message area (AKA sub-board)
 * - Message searching
 *
 * Author: Eric Oulashin (AKA Nightfox)
 * BBS: Digital Distortion
 * BBS address: digitaldistortionbbs.com (or digdist.bbsindex.com)
 *
 * Date       Author            Description
 * 2014-09-13 Eric Oulashin     Started (based on my message lister script)
 * ... Comments trimmed ...
 * 2016-11-19 Eric Oulashin     Version 1.17 Beta 1
 *                              Looked into handling null message headers, which is
 *                              more likely now with the introduction of vote messages
 *                              in Synchronet 3.17.  Headers for vote messages will
 *                              be null.  I updated the GetMsgHdrBy* methods to
 *                              return a bogus message header if he message header
 *                              is null.  It will have the property 'isBogus'
 *                              with the value of true.  That way, the message
 *                              list won't have any weirdness on the screen, and
 *                              the user won't be able to read the message.  I'd
 *                              like to have the reader not display vote messages
 *                              at all.  I may need to use the get_all_msg_headers()
 *                              method for that.
 * 2016-11-20 Eric Oulashin     Continued working on updates for Synchronet's
 *                              voting support - Mainly filtering out voting
 *                              messages etc.
 * 2016-12-03 Eric Oulashin     Version 1.17 beta 15
 *                              Added a check in DigDistMsgReader_GetMsgIdx() to
 *                              just return -1 if msgNum is not a number.  Also,
 *                              have been continuing to work on voting & message
 *                              filtering updates.
 * 2017-08-05 Eric Oulashin     Version 1.17 beta 42
 *                              When showing tally information for messages with
 *                              upvotes & downvotes, it now shows who voted on
 *                              the message (for sysops only).
 * 2017-08-17 Eric Oulashin     Version 1.17 beta 43
 *                              Updated to support multi-answer poll voting.  Works
 *                              with Synchronet 3.17 builds from August 14, 2017 onward.
 * 2017-08-19 Eric Oulashin     Version 1.17 beta 45
 *                              Used the new Msgbase.close_poll() method in the August
 *                              19, 2017 build of Synchronet 3.17
 * 2017-09-27 Eric Oulashin     Version 1.17 beta 47
 *                              Removed this.msgbase in the DigDistMsgReader class and
 *                              updated any functions requiring it to open the
 *                              sub-board using a new MsgBase class with this.subBoardCode.
 *                              This was done to (hopefully) avoid the occasional
 *                              random crashing of Synchronet when doing things like
 *                              replying to a message, etc.
 *                              Updated to set the message number length field length dynamically,
 *                              more than 4 digits if necessary.
 * 2017-11-28 Eric Oulashin     Version 1.17 beta 48
 *                              Bug fix: When listing messages in reverse order in
 *                              lightbar mode and all messages are selected/de-selected,
 *                              the checkmarks on the screen now update properly.
 *                              Also, updated so that when listing personal email, it
 *                              will use the regular formatting colors rather than the
 *                              colors for messages to the user, since all personal
 *                              emails are to the user (the 'to user' colors for each
 *                              email might be obnoxious).
 * 2017-12-04 Eric Oulashin     Version 1.17 beta 49
 *                              Bug fixed (revealed with the 12/1/2017 Synchronet build):
 *                              When adding the 'read' message attribute to a message
 *                              to a user read in a new-message scan, it now uses a
 *                              message header without expanded fields so that it can
 *                              save properly.
 */

 // TODO: Add a command for closing a poll (only available to the user who opened the
 // poll).

/* Command-line arguments (in -arg=val format, or -arg format to enable an
   option):
   -search: A search type.  Available options:
            keyword_search: Do a keyword search in message subject/body text (current message area)
            from_name_search: 'From' name search (current message area)
            to_name_search: 'To' name search (current message area)
            to_user_search: To user search (current message area)
            new_msg_scan: New message scan (prompt for current sub-board, current
                          group, or all)
            new_msg_scan_all: New message scan (all sub-boards)
			new_msg_scan_cur_grp: New message scan (current message group only)
            new_msg_scan_cur_sub: New message scan (current sub-board only).  This
			                      can (optionally) be used with the -subBoard
								  command-line parameter, which specifies an internal
								  code for a sub-board, which may be different from
								  the user's currently selected sub-board.
			to_user_new_scan: Scan for new (unread) messages to the user (prompt
			                  for current sub-board, current group, or all)
			to_user_new_scan_all: Scan for new (unread) messages to the user
			                      (all sub-boards)
			to_user_new_scan_cur_grp: Scan for new (unread) messages to the user
			                          (current group)
            to_user_new_scan_cur_sub: Scan for new (unread) messages to the user
			                          (current sub-board)
			to_user_all_scan: Scan for all messages to the user (prompt for current
			                  sub-board, current group, or all)
            prompt: Prompt the user for one of several search/scan options to
                    choose from
        Note that if the -personalEmail option is specified (to read personal
        email), the only valid search types are keyword_search and
        from_name_search.
   -suppressSearchTypeText: Disable the search type text that would appear
                            above searches or scans (such as "New To You
                            Message Scan", etc.)
   -startMode: Startup mode.  Available options:
               list (or lister): Message list mode
               read (or reader): Message read mode
   -configFilename: Specifies the name of the configuration file to use.
                    Defaults to DDMsgReader.cfg.
   -personalEmail: Read personal email to the user.  This is a true/false value.
                   It doesn't need to explicitly have a =true or =false afterward;
                   simply including -personalEmail will enable it.  If this is specified,
				   the -chooseAreaFirst and -subBoard options will be ignored.
   -personalEmailSent: Read personal email to the user.  This is a true/false
                       value.  It doesn't need to explicitly have a =true or =false
                       afterward; simply including -personalEmailSent will enable it.
   -allPersonalEmail: Read all personal email (to/from all)
   -userNum: Specify a user number (for the personal email options)
   -chooseAreaFirst: Display the message area chooser before reading/listing
                     messages.  This is a true/false value.  It doesn't need
                     to explicitly have a =true or =false afterward; simply
                     including -chooseAreaFirst will enable it.  If -personalEmail
					 or -subBoard is specified, then this option won't have any
                     effect.
	-subBoard: The sub-board (internal code or number) to read, other than the user's
               current sub-board. If this is specified, the -chooseAreaFirst option
			   will be ignored.
	-verboseLogging: Enable logging to the system log & node log.  Currently, there
	                 isn't much that will be logged, but more log messages could be
					 added in the future.
*/

load("sbbsdefs.js");
load("text.js"); // Text string definitions (referencing text.dat)

// This script requires Synchronet version 3.15 or higher.
// Exit if the Synchronet version is below the minimum.
if (system.version_num < 31500)
{
	var message = "\1n\1h\1y\1i* Warning:\1n\1h\1w Digital Distortion Message Reader "
	             + "requires version \1g3.15\1w or\r\n"
	             + "higher of Synchronet.  This BBS is using version \1g" + system.version
	             + "\1w.  Please notify the sysop.";
	console.crlf();
	console.print(message);
	console.crlf();
	console.pause();
	exit();
}

// Reader version information
var READER_VERSION = "1.17 Beta 49";
var READER_DATE = "2017-12-04";

// Keyboard key codes for displaying on the screen
var UP_ARROW = ascii(24);
var DOWN_ARROW = ascii(25);
var LEFT_ARROW = ascii(17);
var RIGHT_ARROW = ascii(16);
// PageUp & PageDown keys - Not real key codes, but codes defined
// to be used & recognized in this script
var KEY_PAGE_UP = "\1PgUp";
var KEY_PAGE_DOWN = "\1PgDn";
// Ctrl keys for input
var CTRL_A = "\x01";
var CTRL_B = "\x02";
var CTRL_C = "\x03";
var CTRL_D = "\x04";
var CTRL_E = "\x05";
var CTRL_F = "\x06";
var CTRL_G = "\x07";
var BEEP = CTRL_G;
var CTRL_H = "\x08";
var BACKSPACE = CTRL_H;
var CTRL_I = "\x09";
var TAB = CTRL_I;
var CTRL_J = "\x0a";
var CTRL_K = "\x0b";
var CTRL_L = "\x0c";
var CTRL_M = "\x0d";
var CTRL_N = "\x0e";
var CTRL_O = "\x0f";
var CTRL_P = "\x10";
var CTRL_Q = "\x11";
var XOFF = CTRL_Q;
var CTRL_R = "\x12";
var CTRL_S = "\x13";