Newer
Older
/* This is a script that lets the user choose a message area,
* with either a lightbar or traditional user interface.
*
* Date Author Description
* ... Trimmed comments ...
* 2019-08-22 Eric Oulashin Version 1.18
* Added message area searching.
* Also, improved the time to display sub-boards
* with the latest message date & time.
* 2019-08-24 Eric Oulashin Version 1.19
* Fixed a bug with 'Next' search when returning from
* sub-board choosing.
* 2020-04-19 Eric Oulashin Version 1.20
* For lightbar mode, it now uses DDLightbarMenu
* instead of using internal lightbar code.
Eric Oulashin
committed
* 2020-11-01 Eric Oulashin Version 1.21 Beta
* Working on sub-board collapsing
* 2022-01-15 Eric Oulashin Version 1.21
* Finished sub-board collapsing (finally) and releasing
* this version.
* 2022-02-12 Eric Oulashin Version 1.22
* Updated the version to match the file area chooser
Eric Oulashin
committed
* 2022-03-18 Eric Oulashin Version 1.23
* For sub-board collapsing, if there's only one sub-group,
* then it won't be collapsed.
* Also fixed an issue: Using Q to quit out of the 2nd level
* (sub-board/sub-group) for lightbar mode no longer quits
* out of the chooser altogether.
* 2022-05-17 Eric Oulashin Version 1.24
* Fix for search error reporting (probably due to
* mistaken copy & paste in an earlier commit)
Eric Oulashin
committed
* 2022-06-06 Eric Oulashin Version 1.25
* Fix for miscolored digit(s) in # messages column in
* the sub-board list when using the lightbar menu
* 2022-06-11 Eric Oulashin Version 1.26
* Updated to try to prevent the error "this.subBoardListPrintfInfo[pGrpIdx] is undefined"
* when only choosing a sub-board within the user's current message group.
Eric Oulashin
committed
* 2022-07-23 Eric Oulashin Version 1.29
* Re-arranged the help text for lightbar mode to be more consistent with my message reader.
*/
Eric Oulashin
committed
// TODO: In the area list, the 10,000ths digit (for # posts) is in a different color)
Eric Oulashin
committed
// TODO: Passing "false" as the first command-line argument no longer works.
// That should allow choosing a sub-board within the user's current message
// group.
/* Command-line arguments:
1 (argv[0]): Boolean - Whether or not to choose a message group first (default). If
false, the user will only be able to choose a different sub-board within
their current message group.
2 (argv[1]): Boolean - Whether or not to run the area chooser (if false,
then this file will just provide the DDMsgAreaChooser class).
*/
Eric Oulashin
committed
if (typeof(require) === "function")
{
require("sbbsdefs.js", "K_NOCRLF");
require("dd_lightbar_menu.js", "DDLightbarMenu");
}
else
{
load("sbbsdefs.js");
load("dd_lightbar_menu.js");
}
// This script requires Synchronet version 3.14 or higher.
// Exit if the Synchronet version is below the minimum.
if (system.version_num < 31400)
{
var message = "\1n\1h\1y\1i* Warning:\1n\1h\1w Digital Distortion Message Area Chooser "
+ "requires version \1g3.14\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();
}
// Version & date variables
Eric Oulashin
committed
var DD_MSG_AREA_CHOOSER_VERSION = "1.29";
var DD_MSG_AREA_CHOOSER_VER_DATE = "2022-07-23";
// Keyboard input key codes
var CTRL_H = "\x08";
var CTRL_M = "\x0d";
var KEY_ENTER = CTRL_M;
var BACKSPACE = CTRL_H;
var CTRL_F = "\x06";
var KEY_ESC = ascii(27);
// PageUp & PageDown keys - Synchronet 3.17 as of about December 18, 2017
// use CTRL-P and CTRL-N for PageUp and PageDown, respectively. sbbsdefs.js
// defines them as KEY_PAGEUP and KEY_PAGEDN; I've used slightly different names
// in this script so that this script will work with Synchronet systems before
// and after the update containing those key definitions.
var KEY_PAGE_UP = "\x10"; // Ctrl-P
var KEY_PAGE_DOWN = "\x0e"; // Ctrl-N
// Ensure KEY_PAGE_UP and KEY_PAGE_DOWN are set to what's defined in sbbs.js
// for KEY_PAGEUP and KEY_PAGEDN in case they change
if (typeof(KEY_PAGEUP) === "string")
KEY_PAGE_UP = KEY_PAGEUP;
if (typeof(KEY_PAGEDN) === "string")
KEY_PAGE_DOWN = KEY_PAGEDN;
// Key codes for display
var UP_ARROW = ascii(24);
var DOWN_ARROW = ascii(25);
// Misc. defines
var ERROR_WAIT_MS = 1500;
var SEARCH_TIMEOUT_MS = 10000;
// Determine the script's startup directory.
// This code is a trick that was created by Deuce, suggested by Rob Swindell
// as a way to detect which directory the script was executed in. I've
// shortened the code a little.
var gStartupPath = '.';
try { throw dig.dist(dist); } catch(e) { gStartupPath = e.fileName; }
gStartupPath = backslash(gStartupPath.replace(/[\/\\][^\/\\]*$/,''));
// gIsSysop stores whether or not the user is a sysop.
var gIsSysop = user.compare_ars("SYSOP"); // Whether or not the user is a sysop
// 1st command-line argument: Whether or not to choose a message group first (if
// false, then only choose a sub-board within the user's current group). This
// can be true or false.
Eric Oulashin
committed
var gChooseMsgGrpOnStartup = true;
if (typeof(argv[0]) == "boolean")
Eric Oulashin
committed
gChooseMsgGrpOnStartup = argv[0];
else if (typeof(argv[0]) == "string")
Eric Oulashin
committed
gChooseMsgGrpOnStartup = (argv[0].toLowerCase() == "true");
Eric Oulashin
committed
// When using the number of messages in a sub-board, whether or not to count the
// number of readable messages (which can be slow). If false, will just look at the number
// of all messages in the sub-board.
var gUseNumReadableMessagesForMsgCount = false;
// 2nd command-line argument: Determine whether or not to execute the message listing
// code (true/false)
var executeThisScript = true;
if (typeof(argv[1]) == "boolean")
executeThisScript = argv[1];
else if (typeof(argv[1]) == "string")
executeThisScript = (argv[1].toLowerCase() == "true");
// If executeThisScript is true, then create a DDMsgAreaChooser object and use
// it to let the user choose a message area.
if (executeThisScript)
{
var msgAreaChooser = new DDMsgAreaChooser();
Eric Oulashin
committed
// If we are to let the user choose a sub-board within
// their current group (and not choose a message group
// first), then we need to capture the chosen sub-board
// here just in case, and change the user's message area
// here. Otherwise, if choosing the message group first,
// SelectMsgArea() will change the user's sub-board.
var msgGroupIdx = (gChooseMsgGrpOnStartup ? 0/*null*/ : +bbs.curgrp);
if (!gChooseMsgGrpOnStartup)
msgAreaChooser.BuildSubBoardPrintfInfoForGrp(msgGroupIdx);
Eric Oulashin
committed
var chosenIdx = msgAreaChooser.SelectMsgArea(gChooseMsgGrpOnStartup, msgGroupIdx);
if (!gChooseMsgGrpOnStartup && (typeof(chosenIdx) === "number"))
bbs.cursub_code = msg_area.grp_list[bbs.curgrp].sub_list[chosenIdx].code;
}
// End of script execution
///////////////////////////////////////////////////////////////////////////////////
// DDMsgAreaChooser class stuff
function DDMsgAreaChooser()
{
// this.colors will be an associative array of colors (indexed by their
// usage) used for the message group/sub-board lists.
// Colors for the file & message area lists
this.colors = {
areaNum: "\1n\1w\1h",
desc: "\1n\1c",
numItems: "\1b\1h",
header: "\1n\1y\1h",
subBoardHeader: "\1n\1g",
areaMark: "\1g\1h",
latestDate: "\1n\1g",
latestTime: "\1n\1m",
// Highlighted colors (for lightbar mode)
bkgHighlight: "\1" + "4", // Blue background
areaNumHighlight: "\1w\1h",
descHighlight: "\1c",
dateHighlight: "\1w\1h",
timeHighlight: "\1w\1h",
numItemsHighlight: "\1w\1h",
// Lightbar help line colors
lightbarHelpLineBkg: "\1" + "7",
lightbarHelpLineGeneral: "\1b",
lightbarHelpLineHotkey: "\1r",
lightbarHelpLineParen: "\1m"
};
// showImportDates is a boolean to specify whether or not to display the
// message import dates. If false, the message written dates will be
// displayed instead.
this.showImportDates = true;
// useLightbarInterface specifies whether or not to use the lightbar
// interface. The lightbar interface will still only be used if the
// user's terminal supports ANSI.
this.useLightbarInterface = true;
// Filename base of a header to display above the area list
this.areaChooserHdrFilenameBase = "msgAreaChgHeader";
this.areaChooserHdrMaxLines = 5;
// Whether or not to show the latest message date/time in the
// sub-board list
this.showDatesInSubBoardList = true;
Eric Oulashin
committed
// Whether or not to enable sub-board collapsing. For
// example, for sub-board in a group starting with
// common text and a separator (specified below), the
// common text will be the only one displayed, and when
// the user selects it, a 3rd tier with the sub-board
// after the separator will be shown
this.useSubCollapsing = true;
// The separator character to use for sub-board collapsing
this.subCollapseSeparator = ":";
// If userSubCollapsing is true, then group_list will be populated
// with some information from Synchronet's msg_area.grp_list,
// including a dir_list for each group. The dir_list arrays
// could have one that was collapsed from multiple sub-board
// set up in the BBS - The dir_list within that one would then
// contain multiple sub-board split based on the dir collapse
// separator.
this.group_list = [];
// Set the function pointers for the object
this.ReadConfigFile = DDMsgAreaChooser_ReadConfigFile;
this.WriteKeyHelpLine = DDMsgAreaChooser_writeKeyHelpLine;
this.WriteGrpListHdrLine = DDMsgAreaChooser_writeGrpListTopHdrLine;
this.WriteSubBrdListHdr1Line = DMsgAreaChooser_writeSubBrdListHdr1Line;
Eric Oulashin
committed
this.SelectMsgArea = DDMsgAreaChooser_SelectMsgArea;
this.SelectMsgArea_Lightbar = DDMsgAreaChooser_SelectMsgArea_Lightbar;
this.CreateLightbarMsgGrpMenu = DDMsgAreaChooser_CreateLightbarMsgGrpMenu;
this.CreateLightbarSubBoardMenu = DDMsgAreaChooser_CreateLightbarSubBoardMenu;
Eric Oulashin
committed
this.SelectMsgArea_Traditional = DDMsgAreaChooser_SelectMsgArea_Traditional;
this.SelectSubBoard_Traditional = DDMsgAreaChooser_SelectSubBoard_Traditional;
this.SelectSubSubWithinSub_Traditional = DDMsgAreaChooser_SelectSubSubWithinSub_Traditional;
this.ListMsgGrps = DDMsgAreaChooser_ListMsgGrps_Traditional;
this.ListSubBoardsInMsgGroup = DDMsgAreaChooser_ListSubBoardsInMsgGroup_Traditional;
this.CurrentSubBoardIsInSubSubsForSub = DDMsgAreaChooser_CurrentSubBoardIsInSubSubsForSub;
this.GetSubBoardInfo = DDMsgAreaChooser_GetSubBoardInfo;
// Lightbar-specific functions
this.WriteMsgGroupLine = DDMsgAreaChooser_writeMsgGroupLine;
this.GetMsgSubBrdLine = DDMsgAreaChooser_GetMsgSubBrdLine;
// Help screen
this.ShowHelpScreen = DDMsgAreaChooser_showHelpScreen;
// Function to build the sub-board printf information for a message
// group
Eric Oulashin
committed
this.BuildSubBoardPrintfInfoForGrp = DDMsgAreaChooser_BuildSubBoardPrintfInfoForGrp;
this.DisplayAreaChgHdr = DDMsgAreaChooser_DisplayAreaChgHdr;
Eric Oulashin
committed
this.DisplayListHdrLines = DDMsgAreaChooser_DisplayListHdrLines;
this.WriteLightbarKeyHelpErrorMsg = DDMsgAreaChooser_WriteLightbarKeyHelpErrorMsg;
Eric Oulashin
committed
this.SetUpGrpListWithCollapsedSubBoards = DDMsgAreaChooser_SetUpGrpListWithCollapsedSubBoards;
this.FindMsgGrpIdxFromText = DDMsgAreaChooser_FindMsgGrpIdxFromText;
this.FindSubBoardIdxFromText = DDMsgAreaChooser_FindSubBoardIdxFromText;
this.GetSubNameLenAndNumMsgsLen = DDMsgAreaChooser_GetSubNameLenAndNumMsgsLen;
// Read the settings from the config file.
this.ReadConfigFile();
// These variables store default lengths of the various columns displayed in
// the message group/sub-board lists.
// Sub-board info field lengths
this.areaNumLen = 4;
this.numItemsLen = 4;
this.dateLen = 10; // i.e., YYYY-MM-DD
this.timeLen = 8; // i.e., HH:MM:SS
// Sub-board name length - This should be 47 for an 80-column display.
this.subBoardNameLen = console.screen_columns - this.areaNumLen - this.numItemsLen - 5;
if (this.showDatesInSubBoardList)
this.subBoardNameLen -= (this.dateLen + this.timeLen + 2);
// Message group description length (67 chars on an 80-column screen)
this.msgGrpDescLen = console.screen_columns - this.areaNumLen - this.numItemsLen - 5;
// printf strings for various things
// Message group information (printf strings)
this.msgGrpListPrintfStr = "\1n " + this.colors.areaNum + "%" + this.areaNumLen
+ "d " + this.colors.desc + "%-"
+ this.msgGrpDescLen + "s " + this.colors.numItems
+ "%" + this.numItemsLen + "d";
this.msgGrpListHilightPrintfStr = "\1n" + this.colors.bkgHighlight + " "
+ "\1n" + this.colors.bkgHighlight
+ this.colors.areaNumHighlight + "%" + this.areaNumLen
+ "d \1n" + this.colors.bkgHighlight
+ this.colors.descHighlight + "%-"
+ this.msgGrpDescLen + "s \1n" + this.colors.bkgHighlight
+ this.colors.numItemsHighlight + "%" + this.numItemsLen
+ "d";
// Message group list header (printf string)
this.msgGrpListHdrPrintfStr = this.colors.header + "%6s %-"
+ +(this.msgGrpDescLen-8) + "s %-12s";
// Sub-board information header (printf string)
this.subBoardListHdrPrintfStr = this.colors.header + " %5s %-"
+ +(this.subBoardNameLen-3) + "s %-7s";
if (this.showDatesInSubBoardList)
this.subBoardListHdrPrintfStr += " %-19s";
// Lightbar mode key help line
this.lightbarKeyHelpText = "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + UP_ARROW
Eric Oulashin
committed
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + ", "
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + DOWN_ARROW
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + ", "
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + "PgUp"
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + "/"
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + "Dn"
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + ", "
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + "HOME"
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + ", "
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + "END"
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + ", "
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + "F"
+ "\1n" + this.colors.lightbarHelpLineParen
+ this.colors.lightbarHelpLineBkg + ")"
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + "irst pg, "
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + "L"
+ "\1n" + this.colors.lightbarHelpLineParen
+ this.colors.lightbarHelpLineBkg + ")"
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + "ast pg, "
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + "#"
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + ", "
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + "CTRL-F"
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + ", "
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + "/"
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + ", "
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + "N"
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + ", "
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + "Q"
+ "\1n" + this.colors.lightbarHelpLineParen
+ this.colors.lightbarHelpLineBkg + ")"
+ "\1n" + this.colors.lightbarHelpLineGeneral
+ this.colors.lightbarHelpLineBkg + "uit, "
+ "\1n" + this.colors.lightbarHelpLineHotkey
+ this.colors.lightbarHelpLineBkg + "?";
// Pad the lightbar key help text on either side to center it on the screen
// (but leave off the last character to avoid screen drawing issues)
var helpTextLen = console.strlen(this.lightbarKeyHelpText);
var helpTextStartCol = (console.screen_columns/2) - (helpTextLen/2);
this.lightbarKeyHelpText = "\1n" + this.colors.lightbarHelpLineBkg
+ format("%" + +(helpTextStartCol) + "s", "")
+ this.lightbarKeyHelpText + "\1n"
+ this.colors.lightbarHelpLineBkg;
var numTrailingChars = console.screen_columns - (helpTextStartCol+helpTextLen) - 1;
this.lightbarKeyHelpText += format("%" + +(numTrailingChars) + "s", "") + "\1n";
// this.subBoardListPrintfInfo will be an array of printf strings
// for the sub-boards in the message groups. The index is the
// message group index. The sub-board printf information is created
// on the fly the first time the user lists sub-boards for a message
// group.
Eric Oulashin
committed
this.subBoardListPrintfInfo = [];
// areaChangeHdrLines is an array of text lines to use as a header to display
// above the message area changer lists.
this.areaChangeHdrLines = loadTextFileIntoArray(this.areaChooserHdrFilenameBase, this.areaChooserHdrMaxLines);
}
// For the DDMsgAreaChooser class: Writes the line of key help at the bottom
// row of the screen.
function DDMsgAreaChooser_writeKeyHelpLine()
{
console.gotoxy(1, console.screen_rows);
console.print(this.lightbarKeyHelpText);
}
// For the DDMsgAreaChooser class: Outputs the header line to appear above
// the list of message groups.
//
// Parameters:
// pNumPages: The number of pages. This is optional; if this is
// not passed, then it won't be used.
// pPageNum: The page number. This is optional; if this is not passed,
// then it won't be used.
function DDMsgAreaChooser_writeGrpListTopHdrLine(pNumPages, pPageNum)
{
var descStr = "Description";
Eric Oulashin
committed
if ((typeof(pPageNum) === "number") && (typeof(pNumPages) === "number"))
descStr += " (Page " + pPageNum + " of " + pNumPages + ")";
Eric Oulashin
committed
else if ((typeof(pPageNum) === "number") && (typeof(pNumPages) !== "number"))
descStr += " (Page " + pPageNum + ")";
Eric Oulashin
committed
else if ((typeof(pPageNum) !== "number") && (typeof(pNumPages) === "number"))
descStr += " (" + pNumPages + (pNumPages == 1 ? " page)" : " pages)");
printf(this.msgGrpListHdrPrintfStr, "Group#", descStr, "# Sub-Boards");
console.cleartoeol("\1n");
}
// For the DDMsgAreaChooser class: Outputs the first header line to appear
// above the sub-board list for a message group.
//
// Parameters:
// pGrpIndex: The index of the message group (assumed to be valid)
Eric Oulashin
committed
// pSubIndex: Optional - The index of a sub-board within the message group (if using sub-board
// collapsing, we might want to append the sub-board name to the description)
// pNumPages: The number of pages. This is optional; if this is
// not passed, then it won't be used.
// pPageNum: The page number. This is optional; if this is not passed,
// then it won't be used.
Eric Oulashin
committed
function DMsgAreaChooser_writeSubBrdListHdr1Line(pGrpIndex, pSubIndex, pNumPages, pPageNum)
{
Eric Oulashin
committed
var descLen = 25;
var descFormatStr = "\1n" + this.colors.subBoardHeader + "Sub-boards of \1h%-" + descLen + "s \1n"
+ this.colors.subBoardHeader;
Eric Oulashin
committed
if ((typeof(pPageNum) === "number") && (typeof(pNumPages) === "number"))
descFormatStr += "(Page " + pPageNum + " of " + pNumPages + ")";
Eric Oulashin
committed
else if ((typeof(pPageNum) === "number") && (typeof(pNumPages) !== "number"))
descFormatStr += "(Page " + pPageNum + ")";
Eric Oulashin
committed
else if ((typeof(pPageNum) !== "number") && (typeof(pNumPages) === "number"))
descFormatStr += "(" + pNumPages + (pNumPages == 1 ? " page)" : " pages)");
Eric Oulashin
committed
// If using sub-board collapsing, then build the description as needed. Otherwise,
// just use the sub-board description.
var desc = "";
if (this.useSubCollapsing)
{
// Ensure this.group_list is set up
this.SetUpGrpListWithCollapsedSubBoards();
// The description should be the library's description. Also, if pSubIdx
// is a number, then append the directory description to the description.
desc = this.group_list[pGrpIndex].description;
if ((typeof(pSubIndex) === "number") && (this.group_list[pGrpIndex].sub_list[pSubIndex].sub_subboard_list.length > 0))
desc += this.subCollapseSeparator + " " + this.group_list[pGrpIndex].sub_list[pSubIndex].description;
}
else
desc = msg_area.grp_list[pGrpIndex].description;
printf(descFormatStr, desc.substr(0, descLen));
console.cleartoeol("\1n");
}
// For the DDMsgAreaChooser class: Lets the user choose a message group and
// sub-board via numeric input, using a lightbar interface (if enabled and
// if the user's terminal uses ANSI) or a traditional user interface.
//
// Parameters:
// pChooseGroup: Boolean - Whether or not to choose the message group. If false,
// then this will allow choosing a sub-board within the user's
// current message group. This is optional; defaults to true.
Eric Oulashin
committed
// pGrpIdx: The group index (can be null) - This is for the lightbar
// interface logic; the traditional interface doesn't use this
// for SelectMsgArea().
function DDMsgAreaChooser_SelectMsgArea(pChooseGroup, pGrpIdx)
{
Eric Oulashin
committed
// If sub-board collapsing is enabled, then set up
// this.group_list.
if (this.useSubCollapsing)
this.SetUpGrpListWithCollapsedSubBoards();
if (this.useLightbarInterface && console.term_supports(USER_ANSI))
Eric Oulashin
committed
return this.SelectMsgArea_Lightbar(pChooseGroup ? 1 : 2, pGrpIdx);
else
Eric Oulashin
committed
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
return this.SelectMsgArea_Traditional(pChooseGroup ? 1 : 2, pGrpIdx);
}
// For the DDMsgAreaChooser class: Displays the header & header lines above the list.
//
// Parameters:
// pScreenRow: The row on the screen to write the lines at. If no cursor movements are desired, this can be null.
// pChooseGroup: Boolean - Whether or not the user is choosing a message group
// pGrpIdx: The index of the message group being used
// pNumPages: Optional - The number of pages of items
// pPageNum: Optional - The current page number for the items
function DDMsgAreaChooser_DisplayListHdrLines(pScreenRow, pChooseGroup, pGrpIdx, pNumPages, pPageNum)
{
this.DisplayAreaChgHdr(1);
if (typeof(pScreenRow) === "number")
console.gotoxy(1, pScreenRow);
if (pChooseGroup)
this.WriteGrpListHdrLine(pNumPages, pPageNum);
else
{
// For the number of items in the sub-board list, use the text "Posts" or "Items", depending
// on whether sub-board collapsing is enabled and there are sub-subboard for the given group
// & sub-board index
var numItemsText = "Posts";
if (this.useSubCollapsing)
{
for (var subIdx in this.group_list[pGrpIdx].sub_list)
{
if (typeof(this.group_list[pGrpIdx].sub_list[subIdx].sub_subboard_list) !== "undefined" && this.group_list[pGrpIdx].sub_list[subIdx].sub_subboard_list.length > 0)
{
numItemsText = "Items";
break;
}
}
}
// Write the list header lines
this.WriteSubBrdListHdr1Line(pGrpIdx);
if (typeof(pScreenRow) === "number")
console.gotoxy(1, pScreenRow+2);
if (this.showDatesInSubBoardList)
printf(this.subBoardListHdrPrintfStr, "Sub #", "Name", "# " + numItemsText, "Latest date & time");
else
printf(this.subBoardListHdrPrintfStr, "Sub #", "Name", "# " + numItemsText);
}
}
// For the DDMsgAreaChooser class: Lets the user choose a message group and
// sub-board via numeric input, using a lightbar user interface.
//
// Parameters:
Eric Oulashin
committed
// pLevel: The file heirarchy level:
// 1: Message groups
// 2: Sub-boards within message groups
// 3: "Sub-subboards" within sub-boards (if sub-board name collapsing is enabled)
// This is optional and defaults to 1.
// pGrpIdx: Optional - The group index, if choosing a sub-board
Eric Oulashin
committed
function DDMsgAreaChooser_SelectMsgArea_Lightbar(pLevel, pGrpIdx, pSubIdx)
{
// If there are no message groups or sub-boards, then don't let the user
// choose one.
if (msg_area.grp_list.length == 0)
{
console.clear("\1n");
console.print("\1y\1hThere are no message groups.\r\n\1p");
return;
}
Eric Oulashin
committed
var level = (typeof(pLevel) === "number" ? pLevel : 1);
if ((level < 1) || (level > 3))
return;
else if (level == 1)
{
Eric Oulashin
committed
if (typeof(pGrpIdx) !== "number")
return;
if (msg_area.grp_list[pGrpIdx].sub_list.length == 0)
{
console.clear("\1n");
console.print("\1y\1hThere are no sub-boards in " + msg_area.grp_list[pGrpIdx].description + ".\r\n\1p");
return;
}
}
Eric Oulashin
committed
// 2: Choose a sub-board within a message group
// 3: Choose a sub-subboard within a sub-board, for sub-board name collapsing
else if ((level == 2) || (level == 3))
{
Eric Oulashin
committed
if (typeof(pGrpIdx) !== "number")
return;
if (msg_area.grp_list[pGrpIdx].sub_list.length == 0)
{
Eric Oulashin
committed
console.clear("\1n");
console.print("\1y\1hThere are no sub-boards in " + file_area.lib_list[pLibIdx].description + ".\r\n\1p");
return;
}
}
Eric Oulashin
committed
var chooseGroup = (pLevel == 1);
// Clear the screen, write the header, help line, and list header(s)
console.clear("\1n");
Eric Oulashin
committed
this.DisplayListHdrLines(this.areaChangeHdrLines.length, chooseGroup, pGrpIdx);
this.WriteKeyHelpLine();
// Create the menu and do the user input loop
Eric Oulashin
committed
var msgAreaMenu = (chooseGroup ? this.CreateLightbarMsgGrpMenu() : this.CreateLightbarSubBoardMenu(pLevel, pGrpIdx, pSubIdx));
var drawMenu = true;
var lastSearchText = "";
var lastSearchFoundIdx = -1;
var chosenIdx = -1;
var continueOn = true;
// Let the user choose a group, and also respond to other user choices
while (continueOn)
{
chosenIdx = -1;
var returnedMenuIdx = msgAreaMenu.GetVal(drawMenu);
drawMenu = true;
Eric Oulashin
committed
var lastUserInputUpper = (typeof(msgAreaMenu.lastUserInput) === "string" ? msgAreaMenu.lastUserInput.toUpperCase() : "");
if (typeof(returnedMenuIdx) === "number")
chosenIdx = returnedMenuIdx;
// If userChoice is not a number, then it should be null in this case,
// and the user would have pressed one of the additional quit keys set
// up for the menu. So look at the menu's lastUserInput and do the
// appropriate thing.
else if ((lastUserInputUpper == "Q") || (lastUserInputUpper == KEY_ESC)) // Quit
continueOn = false;
else if ((lastUserInputUpper == "/") || (lastUserInputUpper == CTRL_F)) // Start of find
{
console.gotoxy(1, console.screen_rows);
console.cleartoeol("\1n");
console.gotoxy(1, console.screen_rows);
var promptText = "Search: ";
console.print(promptText);
var searchText = getStrWithTimeout(K_UPPER|K_NOCRLF|K_GETSTR|K_NOSPIN|K_LINE, console.screen_columns - promptText.length - 1, SEARCH_TIMEOUT_MS);
lastSearchText = searchText;
// If the user entered text, then do the search, and if found,
// found, go to the page and select the item indicated by the
// search.
if (searchText.length > 0)
{
var oldLastSearchFoundIdx = lastSearchFoundIdx;
var oldSelectedItemIdx = msgAreaMenu.selectedItemIdx;
var idx = -1;
if (chooseGroup)
Eric Oulashin
committed
idx = this.FindMsgGrpIdxFromText(searchText, msgAreaMenu.selectedItemIdx);
else
Eric Oulashin
committed
idx = this.FindSubBoardIdxFromText(pGrpIdx, (pLevel == 3 ? pSubIdx : null), searchText, msgAreaMenu.selectedItemIdx+1);
lastSearchFoundIdx = idx;
if (idx > -1)
{
// Set the currently selected item in the menu, and ensure it's
// visible on the page
msgAreaMenu.selectedItemIdx = idx;
if (msgAreaMenu.selectedItemIdx >= msgAreaMenu.topItemIdx+msgAreaMenu.GetNumItemsPerPage())
msgAreaMenu.topItemIdx = msgAreaMenu.selectedItemIdx - msgAreaMenu.GetNumItemsPerPage() + 1;
else if (msgAreaMenu.selectedItemIdx < msgAreaMenu.topItemIdx)
msgAreaMenu.topItemIdx = msgAreaMenu.selectedItemIdx;
else
{
// If the current index and the last index are both on the same page on the
// menu, then have the menu only redraw those items.
msgAreaMenu.nextDrawOnlyItems = [msgAreaMenu.selectedItemIdx, oldLastSearchFoundIdx, oldSelectedItemIdx];
}
}
else
{
if (chooseGroup)
Eric Oulashin
committed
idx = this.FindMsgGrpIdxFromText(searchText, 0);
else
Eric Oulashin
committed
idx = this.FindSubBoardIdxFromText(pGrpIdx, (pLevel == 3 ? pSubIdx : null), searchText, 0);
lastSearchFoundIdx = idx;
if (idx > -1)
{
// Set the currently selected item in the menu, and ensure it's
// visible on the page
msgAreaMenu.selectedItemIdx = idx;
if (msgAreaMenu.selectedItemIdx >= msgAreaMenu.topItemIdx+msgAreaMenu.GetNumItemsPerPage())
msgAreaMenu.topItemIdx = msgAreaMenu.selectedItemIdx - msgAreaMenu.GetNumItemsPerPage() + 1;
else if (msgAreaMenu.selectedItemIdx < msgAreaMenu.topItemIdx)
msgAreaMenu.topItemIdx = msgAreaMenu.selectedItemIdx;
else
{
// The current index and the last index are both on the same page on the
// menu, so have the menu only redraw those items.
msgAreaMenu.nextDrawOnlyItems = [msgAreaMenu.selectedItemIdx, oldLastSearchFoundIdx, oldSelectedItemIdx];
}
}
else
{
this.WriteLightbarKeyHelpErrorMsg("Not found");
drawMenu = false;
}
}
}
else
drawMenu = false;
this.WriteKeyHelpLine();
}
else if (lastUserInputUpper == "N") // Next search result (requires an existing search term)
{
// This works but seems a little strange sometimes.
// - Should this always start from the selected index?
// - If it wraps around to one of the items on the first page,
// should it always set the top index to 0?
if ((lastSearchText.length > 0) && (lastSearchFoundIdx > -1))
{
var oldLastSearchFoundIdx = lastSearchFoundIdx;
var oldSelectedItemIdx = msgAreaMenu.selectedItemIdx;
// Do the search, and if found, go to the page and select the item
// indicated by the search.
var idx = 0;
if (chooseGroup)
Eric Oulashin
committed
idx = this.FindMsgGrpIdxFromText(searchText, lastSearchFoundIdx+1);
else
Eric Oulashin
committed
idx = this.FindSubBoardIdxFromText(pGrpIdx, (pLevel == 3 ? pSubIdx : null), searchText, lastSearchFoundIdx+1);
if (idx > -1)
{
lastSearchFoundIdx = idx;
// Set the currently selected item in the menu, and ensure it's
// visible on the page
msgAreaMenu.selectedItemIdx = idx;
if (msgAreaMenu.selectedItemIdx >= msgAreaMenu.topItemIdx+msgAreaMenu.GetNumItemsPerPage())
{
msgAreaMenu.topItemIdx = msgAreaMenu.selectedItemIdx - msgAreaMenu.GetNumItemsPerPage() + 1;
if (msgAreaMenu.topItemIdx < 0)
msgAreaMenu.topItemIdx = 0;
}
else if (msgAreaMenu.selectedItemIdx < msgAreaMenu.topItemIdx)
msgAreaMenu.topItemIdx = msgAreaMenu.selectedItemIdx;
else
{
// The current index and the last index are both on the same page on the
// menu, so have the menu only redraw those items.
msgAreaMenu.nextDrawOnlyItems = [msgAreaMenu.selectedItemIdx, oldLastSearchFoundIdx, oldSelectedItemIdx];
}
}
else
{
if (chooseGroup)
Eric Oulashin
committed
idx = this.FindMsgGrpIdxFromText(searchText, 0);
else
Eric Oulashin
committed
idx = this.FindSubBoardIdxFromText(pGrpIdx, (pLevel == 3 ? pSubIdx : null), searchText, 0);
lastSearchFoundIdx = idx;
if (idx > -1)
{
// Set the currently selected item in the menu, and ensure it's
// visible on the page
msgAreaMenu.selectedItemIdx = idx;
if (msgAreaMenu.selectedItemIdx >= msgAreaMenu.topItemIdx+msgAreaMenu.GetNumItemsPerPage())
{
msgAreaMenu.topItemIdx = msgAreaMenu.selectedItemIdx - msgAreaMenu.GetNumItemsPerPage() + 1;
if (msgAreaMenu.topItemIdx < 0)
msgAreaMenu.topItemIdx = 0;
}
else if (msgAreaMenu.selectedItemIdx < msgAreaMenu.topItemIdx)
msgAreaMenu.topItemIdx = msgAreaMenu.selectedItemIdx;
else
{
// The current index and the last index are both on the same page on the
// menu, so have the menu only redraw those items.
msgAreaMenu.nextDrawOnlyItems = [msgAreaMenu.selectedItemIdx, oldLastSearchFoundIdx, oldSelectedItemIdx];
}
}
else
{
this.WriteLightbarKeyHelpErrorMsg("Not found");
drawMenu = false;
this.WriteKeyHelpLine();
}
}
}
else
{
this.WriteLightbarKeyHelpErrorMsg("There is no previous search", true);
drawMenu = false;
this.WriteKeyHelpLine();
}
}
else if (lastUserInputUpper == "?") // Show help
{
this.ShowHelpScreen(true, true);
console.pause();
// Refresh the screen
console.clear("\1n");
this.DisplayAreaChgHdr(1);
Eric Oulashin
committed
this.DisplayListHdrLines(this.areaChangeHdrLines.length, chooseGroup, pGrpIdx);
this.WriteKeyHelpLine();
}
// If the user entered a numeric digit, then treat it as
// the start of the message group number.
if (lastUserInputUpper.match(/[0-9]/))
{
// Put the user's input back in the input buffer to
// be used for getting the rest of the message number.
console.ungetstr(lastUserInputUpper);
// Move the cursor to the bottom of the screen and
// prompt the user for the message number.
console.gotoxy(1, console.screen_rows);
console.clearline("\1n");
console.print("\1cChoose group #: \1h");
var userInput = console.getnum(msg_area.grp_list.length);
if (userInput > 0)
chosenIdx = userInput - 1;
else
{
// The user didn't make a selection. So, we need to refresh
// the screen due to everything being moved up one line.
Eric Oulashin
committed
this.DisplayListHdrLines(this.areaChangeHdrLines.length, chooseGroup, pGrpIdx);
this.WriteKeyHelpLine();
}
}
Eric Oulashin
committed
// If a group/sub-board/sub-subboard was chosen, then deal with it.
if (chosenIdx > -1)
{
// If choosing a message group, then let the user choose a
// sub-board within the group. Otherwise, return the user's
// chosen sub-board.
if (chooseGroup)
{
// Show a "Loading..." text in case there are many sub-boards in
// the chosen message group
console.crlf();
console.print("\1nLoading...");
console.line_counter = 0; // To prevent a pause before the message list comes up
// Ensure that the sub-board printf information is created for
// the chosen message group.
this.BuildSubBoardPrintfInfoForGrp(chosenIdx);
Eric Oulashin
committed
var defaultSubIdx = chosenIdx == bbs.curgrp ? bbs.cursub : 0;
var subCodeBackup = bbs.cursub_code;
var chosenSubBoardIdx = this.SelectMsgArea_Lightbar(2, chosenIdx, defaultSubIdx);
if (typeof(chosenSubBoardIdx) === "number" && chosenSubBoardIdx > -1)
{
// Set the current sub-board
Eric Oulashin
committed
if (this.useSubCollapsing)
bbs.cursub_code = this.group_list[chosenIdx].sub_list[chosenSubBoardIdx].code;
else
bbs.cursub_code = msg_area.grp_list[chosenIdx].sub_list[chosenSubBoardIdx].code;
continueOn = false;
}
else
{
Eric Oulashin
committed
// A message sub-board was not chosen, so we'll have to re-draw
// the header and key help line
Eric Oulashin
committed
this.DisplayListHdrLines(this.areaChangeHdrLines.length, chooseGroup, pGrpIdx);
Eric Oulashin
committed
this.WriteKeyHelpLine();
}
}
Eric Oulashin
committed
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
else if (level == 2) // Choosing a sub-board
{
if (this.useSubCollapsing)
{
// Ensure this.group_list is set up
this.SetUpGrpListWithCollapsedSubBoards();
// If the current file directory has subdirectories,
// let the user choose one
// pGrpIdx is the group index, and chosenIdx is the sub-board index
if ((typeof(this.group_list[pGrpIdx].sub_list[chosenIdx].sub_subboard_list) !== "undefined") && (this.group_list[pGrpIdx].sub_list[chosenIdx].sub_subboard_list.length > 0))
{
var chosenSubSubBoardIdx = this.SelectMsgArea_Lightbar(3, pGrpIdx, chosenIdx);
if (chosenSubSubBoardIdx > -1)
{
// Set the current message sub-board
bbs.cursub_code = this.group_list[pGrpIdx].sub_list[chosenIdx].sub_subboard_list[chosenSubSubBoardIdx].code;
continueOn = false;
}
else
{
// A file directory was not chosen, so we'll have to re-draw
// the header and list of message groups.
// TODO:
//this.DisplayListHdrLines(level, pLibIdx);
//this.WriteKeyHelpLine();
}
}
else // No subdirectories - Return the chosen index
return chosenIdx;
}
else
return chosenIdx; // Return the chosen file directory index
}
else if (level == 3)
return chosenIdx; // Return the chosen subdirectory index
}
}
}
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
// For the DDMsgAreaChooser class: Creates the DDLightbarMenu for use with
// choosing a message group in lightbar mode.
//
// Return value: A DDLightbarMenu object for choosing a message group
function DDMsgAreaChooser_CreateLightbarMsgGrpMenu()
{
// Start & end indexes for the various items in each mssage group list row
// Selected mark, group#, description, # sub-boards
var msgGrpListIdxes = {
markCharStart: 0,
markCharEnd: 1,
grpNumStart: 1,
grpNumEnd: 2 + (+this.areaNumLen)
};
msgGrpListIdxes.descStart = msgGrpListIdxes.grpNumEnd;
msgGrpListIdxes.descEnd = msgGrpListIdxes.descStart + +this.msgGrpDescLen;
msgGrpListIdxes.numItemsStart = msgGrpListIdxes.descEnd;
// Set numItemsEnd to -1 to let the whole rest of the lines be colored
msgGrpListIdxes.numItemsEnd = -1;
var listStartRow = this.areaChangeHdrLines.length + 2;
var msgGrpMenuHeight = console.screen_rows - listStartRow;
var msgGrpMenu = new DDLightbarMenu(1, listStartRow, console.screen_columns, msgGrpMenuHeight);
msgGrpMenu.scrollbarEnabled = true;
msgGrpMenu.borderEnabled = false;
msgGrpMenu.SetColors({
itemColor: [{start: msgGrpListIdxes.markCharStart, end: msgGrpListIdxes.markCharEnd, attrs: this.colors.areaMark},
{start: msgGrpListIdxes.grpNumStart, end: msgGrpListIdxes.grpNumEnd, attrs: this.colors.areaNum},
{start: msgGrpListIdxes.descStart, end: msgGrpListIdxes.descEnd, attrs: this.colors.desc},
{start: msgGrpListIdxes.numItemsStart, end: msgGrpListIdxes.numItemsEnd, attrs: this.colors.numItems}],
selectedItemColor: [{start: msgGrpListIdxes.markCharStart, end: msgGrpListIdxes.markCharEnd, attrs: this.colors.areaMark + this.colors.bkgHighlight},
{start: msgGrpListIdxes.grpNumStart, end: msgGrpListIdxes.grpNumEnd, attrs: this.colors.areaNumHighlight + this.colors.bkgHighlight},
{start: msgGrpListIdxes.descStart, end: msgGrpListIdxes.descEnd, attrs: this.colors.descHighlight + this.colors.bkgHighlight},
{start: msgGrpListIdxes.numItemsStart, end: msgGrpListIdxes.numItemsEnd, attrs: this.colors.numItemsHighlight + this.colors.bkgHighlight}]
});
msgGrpMenu.multiSelect = false;
msgGrpMenu.ampersandHotkeysInItems = false;
msgGrpMenu.wrapNavigation = false;
// Add additional keypresses for quitting the menu's input loop so we can
// respond to these keys
msgGrpMenu.AddAdditionalQuitKeys("nNqQ ?0123456789/" + CTRL_F);
// Change the menu's NumItems() and GetItem() function to reference
// the message list in this object rather than add the menu items
// to the menu
msgGrpMenu.areaChooser = this; // Add this object to the menu object
msgGrpMenu.NumItems = function() {
return msg_area.grp_list.length;
};
msgGrpMenu.GetItem = function(pGrpIndex) {
var menuItemObj = this.MakeItemWithRetval(-1);
if ((pGrpIndex >= 0) && (pGrpIndex < msg_area.grp_list.length))
{
Eric Oulashin
committed
var showAreaMark = false;
if (this.areaChooser.useSubCollapsing)
{
//this.group_list[pGrpIndex].sub_list[pSubIndex]
showAreaMark = ((typeof(bbs.curgrp) === "number") && (pGrpIndex == msg_area.sub[bbs.cursub_code].grp_index));
}
else
{
showAreaMark = ((typeof(bbs.curgrp) === "number") && (pGrpIndex == msg_area.sub[bbs.cursub_code].grp_index));
}
menuItemObj.text = (showAreaMark ? "*" : " ");
menuItemObj.text += format(this.areaChooser.msgGrpListPrintfStr, +(pGrpIndex+1),
msg_area.grp_list[pGrpIndex].description.substr(0, this.areaChooser.msgGrpDescLen),
msg_area.grp_list[pGrpIndex].sub_list.length);
menuItemObj.text = strip_ctrl(menuItemObj.text);
menuItemObj.retval = pGrpIndex;
}
return menuItemObj;
};
// Set the currently selected item to the current group
msgGrpMenu.selectedItemIdx = msg_area.sub[bbs.cursub_code].grp_index;
if (msgGrpMenu.selectedItemIdx >= msgGrpMenu.topItemIdx+msgGrpMenu.GetNumItemsPerPage())
msgGrpMenu.topItemIdx = msgGrpMenu.selectedItemIdx - msgGrpMenu.GetNumItemsPerPage() + 1;
return msgGrpMenu;
}
// For the DDMsgAreaChooser class: Creates the DDLightbarMenu for use with
// choosing a sub-board in lightbar mode.
//
// Parameters:
Eric Oulashin
committed
// pLevel: The level of menu (1=Group, 2=Sub-board, 3=Sub board within sub-board if sub-board name collapsing is enabled)
// pGrpIdx: The index of the message group
Eric Oulashin
committed
// pSubIdx: The sub-board index (for sub-board name collapsing)
//
// Return value: A DDLightbarMenu object for choosing a sub-board within
// the given message group
Eric Oulashin
committed
function DDMsgAreaChooser_CreateLightbarSubBoardMenu(pLevel, pGrpIdx, pSubIdx)
{
// Start & end indexes for the various items in each mssage group list row
// Selected mark, group#, description, # sub-boards
var lengthsObj = this.GetSubNameLenAndNumMsgsLen(pGrpIdx);
var subBoardListIdxes = {
markCharStart: 0,
markCharEnd: 1,
subNumStart: 1,
subNumEnd: 3 + (+this.areaNumLen)
};
subBoardListIdxes.descStart = subBoardListIdxes.subNumEnd;
subBoardListIdxes.descEnd = subBoardListIdxes.descStart + lengthsObj.nameLen + 1;
subBoardListIdxes.numItemsStart = subBoardListIdxes.descEnd;
subBoardListIdxes.numItemsEnd = subBoardListIdxes.numItemsStart + lengthsObj.numMsgsLen + 1;
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
subBoardListIdxes.dateStart = subBoardListIdxes.numItemsEnd;
subBoardListIdxes.dateEnd = subBoardListIdxes.dateStart + +this.dateLen + 1;
subBoardListIdxes.timeStart = subBoardListIdxes.dateEnd;
// Set timeEnd to -1 to let the whole rest of the lines be colored
subBoardListIdxes.timeEnd = -1;
var listStartRow = this.areaChangeHdrLines.length + 3; // or + 2?
var subBoardMenuHeight = console.screen_rows - listStartRow;
var subBoardMenu = new DDLightbarMenu(1, listStartRow, console.screen_columns, subBoardMenuHeight);
subBoardMenu.scrollbarEnabled = true;
subBoardMenu.borderEnabled = false;
subBoardMenu.SetColors({
itemColor: [{start: subBoardListIdxes.markCharStart, end: subBoardListIdxes.markCharEnd, attrs: this.colors.areaMark},
{start: subBoardListIdxes.subNumStart, end: subBoardListIdxes.subNumEnd, attrs: this.colors.areaNum},
{start: subBoardListIdxes.descStart, end: subBoardListIdxes.descEnd, attrs: this.colors.desc},
{start: subBoardListIdxes.numItemsStart, end: subBoardListIdxes.numItemsEnd, attrs: this.colors.numItems},
{start: subBoardListIdxes.dateStart, end: subBoardListIdxes.dateEnd, attrs: this.colors.latestDate},
{start: subBoardListIdxes.timeStart, end: subBoardListIdxes.timeEnd, attrs: this.colors.latestTime}],
selectedItemColor: [{start: subBoardListIdxes.markCharStart, end: subBoardListIdxes.markCharEnd, attrs: this.colors.areaMark + this.colors.bkgHighlight},
{start: subBoardListIdxes.subNumStart, end: subBoardListIdxes.subNumEnd, attrs: this.colors.areaNumHighlight + this.colors.bkgHighlight},
{start: subBoardListIdxes.descStart, end: subBoardListIdxes.descEnd, attrs: this.colors.descHighlight + this.colors.bkgHighlight},
{start: subBoardListIdxes.numItemsStart, end: subBoardListIdxes.numItemsEnd, attrs: this.colors.numItemsHighlight + this.colors.bkgHighlight},
{start: subBoardListIdxes.dateStart, end: subBoardListIdxes.dateEnd, attrs: this.colors.dateHighlight + this.colors.bkgHighlight},
{start: subBoardListIdxes.timeStart, end: subBoardListIdxes.timeEnd, attrs: this.colors.timeHighlight + this.colors.bkgHighlight}]
});
subBoardMenu.multiSelect = false;
subBoardMenu.ampersandHotkeysInItems = false;
subBoardMenu.wrapNavigation = false;
// Add additional keypresses for quitting the menu's input loop so we can
// respond to these keys
subBoardMenu.AddAdditionalQuitKeys("nNqQ ?0123456789/" + CTRL_F);
// Change the menu's NumItems() and GetItem() function to reference
// the message list in this object rather than add the menu items
// to the menu
subBoardMenu.areaChooser = this; // Add this object to the menu object
subBoardMenu.grpIdx = pGrpIdx;
Eric Oulashin
committed
if (this.useSubCollapsing)
{
if (pLevel == 2)
{
Eric Oulashin
committed
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
subBoardMenu.NumItems = function() {
return this.areaChooser.group_list[this.grpIdx].sub_list.length;
};
subBoardMenu.GetItem = function(pSubIdx) {
var menuItemObj = this.MakeItemWithRetval(-1);
var subIdxValid = true;
/*
if (this.areaChooser.useSubCollapsing)
showSubBoardMark = this.areaChooser.CurrentSubBoardIsInSubSubsForSub(this.grpIdx, +pSubIdx);
*/
if ((pSubIdx >= 0) && (pSubIdx < this.areaChooser.group_list[this.grpIdx].sub_list.length))
{
var showSubBoardMark = false;
if ((typeof(bbs.cursub_code) == "string") && (bbs.cursub_code != ""))
{
showSubBoardMark = this.areaChooser.CurrentSubBoardIsInSubSubsForSub(this.grpIdx, +pSubIdx);
/*
if (this.areaChooser.useSubCollapsing)
showSubBoardMark = this.areaChooser.CurrentSubBoardIsInSubSubsForSub(this.grpIdx, +pSubIdx);
else
showSubBoardMark = ((this.grpIdx == msg_area.sub[bbs.cursub_code].grp_index) && (pSubIdx == msg_area.sub[bbs.cursub_code].index));
*/
}
// Set the sub-board description. And if it has sub-subboards,
// then append some text indicating so.
var subDesc = this.areaChooser.group_list[this.grpIdx].sub_list[pSubIdx].description;
var numItems = 0;
var lastMsgPostTimestamp = 0;
var subSubBoardListExists = false;
if (Array.isArray(this.areaChooser.group_list[this.grpIdx].sub_list[pSubIdx].sub_subboard_list) && this.areaChooser.group_list[this.grpIdx].sub_list[pSubIdx].sub_subboard_list.length > 0)
{
subSubBoardListExists = true;
subDesc += " <subsubs>";
numItems = this.areaChooser.group_list[this.grpIdx].sub_list[pSubIdx].sub_subboard_list.length;
}
// Get information from the messagebase
var msgBase = new MsgBase(this.areaChooser.group_list[this.grpIdx].sub_list[pSubIdx].code);
if (msgBase.open())
{
if (this.areaChooser.showDatesInSubBoardList)
{
var latestMsgHdr = getLatestMsgHdrWithMsgbase(msgBase, 100); // One of the last 100 messages should be readable
if (latestMsgHdr != null)
lastMsgPostTimestamp = latestMsgHdr.when_written_time; // when_imported_time
}
if (!subSubBoardListExists)
{
// There is no sub-subboard list, so this is just a regular sub-board.
// Get the number of readable messages in the sub-board.
// TODO: This can take a long time
Eric Oulashin
committed
if (gUseNumReadableMessagesForMsgCount)
{
numItems = numReadableMsgs(msgBase, this.areaChooser.group_list[this.grpIdx].sub_list[pSubIdx].code);
}
Eric Oulashin
committed
// Fast but could be inaccurate due to counting deleted messages,
// vote responses, etc..
Eric Oulashin
committed
else
{
numItems = msgBase.total_msgs;
}
Eric Oulashin
committed
}
msgBase.close();
}
Eric Oulashin
committed
menuItemObj.text = (showSubBoardMark ? "*" : " ");
if (this.areaChooser.showDatesInSubBoardList)
{
menuItemObj.text += format(this.areaChooser.subBoardListPrintfInfo[this.grpIdx].printfStr, +(pSubIdx+1),
subDesc.substr(0, this.areaChooser.descFieldLen), numItems,
strftime("%Y-%m-%d", lastMsgPostTimestamp),
strftime("%H:%M:%S", lastMsgPostTimestamp));
}
else
{
menuItemObj.text += format(this.areaChooser.subBoardListPrintfInfo[this.grpIdx].printfStr, +(pSubIdx+1),
subDesc.substr(0, this.areaChooser.descFieldLen), numItems);
}
menuItemObj.text = strip_ctrl(menuItemObj.text);
menuItemObj.retval = pSubIdx;
}
Eric Oulashin
committed
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
return menuItemObj;
};
}
else if (pLevel == 3)
{
subBoardMenu.subIdx = pSubIdx;
subBoardMenu.NumItems = function() {
return this.areaChooser.group_list[this.grpIdx].sub_list[this.subIdx].sub_subboard_list.length;
};
subBoardMenu.GetItem = function(pSubSubIdx) {
var menuItemObj = this.MakeItemWithRetval(-1);
if ((pSubSubIdx >= 0) && (pSubSubIdx < this.areaChooser.group_list[this.grpIdx].sub_list[this.subIdx].sub_subboard_list.length))
{
var showSubBoardMark = false;
if ((typeof(bbs.cursub_code) == "string") && (bbs.cursub_code != ""))
showSubBoardMark = this.areaChooser.CurrentSubBoardIsInSubSubsForSub(this.grpIdx, +(this.subIdx));
menuItemObj.text = (showSubBoardMark ? "*" : " ");
var subdirDesc = this.areaChooser.group_list[this.grpIdx].sub_list[this.subIdx].sub_subboard_list[pSubSubIdx].description;
var subdirDirIdx = this.areaChooser.group_list[this.grpIdx].sub_list[this.subIdx].sub_subboard_list[pSubSubIdx].index;
var subCode = this.areaChooser.group_list[this.grpIdx].sub_list[this.subIdx].sub_subboard_list[pSubSubIdx].code;
menuItemObj.text = strip_ctrl(this.areaChooser.GetMsgSubBrdLine(this.grpIdx, msg_area.sub[subCode].index, false));
menuItemObj.retval = pSubSubIdx;
}
return menuItemObj;
}
}
}
else
{
Eric Oulashin
committed
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
subBoardMenu.NumItems = function() {
return msg_area.grp_list[this.grpIdx].sub_list.length;
};
subBoardMenu.GetItem = function(pSubIdx) {
var menuItemObj = this.MakeItemWithRetval(-1);
if ((pSubIdx >= 0) && (pSubIdx < msg_area.grp_list[this.grpIdx].sub_list.length))
{
var showSubBoardMark = false;
if ((typeof(bbs.cursub_code) == "string") && (bbs.cursub_code != ""))
showSubBoardMark = ((this.grpIdx == msg_area.sub[bbs.cursub_code].grp_index) && (pSubIdx == msg_area.sub[bbs.cursub_code].index));
menuItemObj.text = strip_ctrl(this.areaChooser.GetMsgSubBrdLine(this.grpIdx, pSubIdx, false));
menuItemObj.retval = pSubIdx;
}
return menuItemObj;
};
// Set the currently selected item. If the current sub-board is in this list,
// then set the selected item to that; otherwise, the selected item should be
// the first sub-board.
if (msg_area.sub[bbs.cursub_code].grp_index == pGrpIdx)
{
subBoardMenu.selectedItemIdx = msg_area.sub[bbs.cursub_code].index;
if (subBoardMenu.selectedItemIdx >= subBoardMenu.topItemIdx+subBoardMenu.GetNumItemsPerPage())
subBoardMenu.topItemIdx = subBoardMenu.selectedItemIdx - subBoardMenu.GetNumItemsPerPage() + 1;
}
else
{
subBoardMenu.selectedItemIdx = 0;
subBoardMenu.topItemIdx = 0;
}
}
return subBoardMenu;
}
// For the DDMsgAreaChooser class: Lets the user choose a message group and
// sub-board via numeric input, using a traditional user interface.
//
// Parameters:
// pChooseGroup: Boolean - Whether or not to choose the message group. If false,
// then this will allow choosing a sub-board within the user's
// current message group. This is optional; defaults to true.
Eric Oulashin
committed
function DDMsgAreaChooser_SelectMsgArea_Traditional(pChooseGroup)
{
// If there are no message groups, then don't let the user
// choose one.
if (msg_area.grp_list.length == 0)
{
console.clear("\1n");
console.print("\1y\1hThere are no message groups.\r\n\1p");
return;
}
var chooseGroup = (typeof(pChooseGroup) == "boolean" ? pChooseGroup : true);
if (chooseGroup)
{
// Show the message groups & sub-boards and let the user choose one.
var selectedGrp = 0; // The user's selected message group
var selectedSubBoard = 0; // The user's selected sub-board
var usersCurrentIdxVals = getGrpAndSubIdxesFromCode(bbs.cursub_code, true);
var grpSearchText = "";
var continueChoosingMsgArea = true;
while (continueChoosingMsgArea)
{
// Clear the BBS command string to make sure there are no extra
// commands in there that could cause weird things to happen.
bbs.command_str = "";
console.clear("\1n");
this.DisplayAreaChgHdr(1);
if (this.areaChangeHdrLines.length > 0)
console.crlf();
this.ListMsgGrps(grpSearchText);
console.crlf();
console.print("\1n\1b\1h \1n\1cWhich, \1hQ\1n\1cuit, \1hCTRL-F\1n\1c, \1h/\1n\1c, or [\1h" + +(usersCurrentIdxVals.grpIdx+1) + "\1n\1c]: \1h");
// Accept Q (quit), / or CTRL_F (Search) or a file library number
selectedGrp = console.getkeys("Q/" + CTRL_F, msg_area.grp_list.length);
// If the user just pressed enter (selectedGrp would be blank),
// default to the current group.
if (selectedGrp.toString() == "")
selectedGrp = usersCurrentIdxVals.grpIdx + 1;
if (selectedGrp.toString() == "Q")
continueChoosingMsgArea = false;
else if ((selectedGrp.toString() == "/") || (selectedGrp.toString() == CTRL_F))
{
console.crlf();
var searchPromptText = "\1n\1c\1hSearch\1g: \1n";
console.print(searchPromptText);
var searchText = console.getstr("", console.screen_columns-strip_ctrl(searchPromptText).length-1, K_UPPER|K_NOCRLF|K_GETSTR|K_NOSPIN|K_LINE);
if (searchText.length > 0)
grpSearchText = searchText;
}
else
{
grpSearchText = "";
// If the user specified a message group number, then
// set it and let the user choose a sub-board within
// the group.
if (selectedGrp > 0)
{
// Set the default sub-board #: The current sub-board, or if the
// user chose a different group, then this should be set
// to the first sub-board.
var defaultSubBoard = usersCurrentIdxVals.subIdx + 1;
if (selectedGrp-1 != usersCurrentIdxVals.grpIdx)
defaultSubBoard = 1;
console.clear("\1n");
var selectSubRetVal = this.SelectSubBoard_Traditional(selectedGrp-1, defaultSubBoard-1);
// If the user chose a directory, then set the user's
// message sub-board and quit the message group loop.
if (selectSubRetVal.subBoardCode != "")
{
continueChoosingMsgArea = false;
bbs.cursub_code = selectSubRetVal.subBoardCode;
}
}
}
}
}
else
{
// Don't choose a group, just a sub-board within the user's current group.
var idxVals = getGrpAndSubIdxesFromCode(bbs.cursub_code, true);
var selectSubRetVal = this.SelectSubBoard_Traditional(idxVals.grpIdx, idxVals.subIdx);
// If the user chose a directory, then set the user's sub-board.
if (selectSubRetVal.subBoardCode != "")
bbs.cursub_code = selectSubRetVal.subBoardCode;
}
}
// For the DDMsgAreaChooser class: Allows the user to select a sub-board with the
// traditional user interface.
//
// Parameters:
// pGrpIdx: The index of the message group to choose a sub-board for
// pDefaultSubBoardIdx: The index of the default sub-board
//
// Return value: An object containing the following values:
// subBoardChosen: Boolean - Whether or not a sub-board was chosen.
// subBoardIndex: Numeric - The sub-board that was chosen (if any).
// Will be -1 if none chosen.
// subBoardCode: The internal code of the chosen sub-board (or "" if none chosen)
Eric Oulashin
committed
function DDMsgAreaChooser_SelectSubBoard_Traditional(pGrpIdx, pDefaultSubBoardIdx)
{
var retObj = {
subBoardChosen: false,
subBoardIndex: 1,
subBoardCode: ""
}
var searchText = "";
var defaultSubBoardIdx = pDefaultSubBoardIdx;
var continueOn = false;
do
{
this.DisplayAreaChgHdr(1);
if (this.areaChangeHdrLines.length > 0)
console.crlf();
Eric Oulashin
committed
this.ListSubBoardsInMsgGroup(pGrpIdx, null, defaultSubBoardIdx, searchText);
console.crlf();
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
if (defaultSubBoardIdx >= 0)
console.print("\1n\1b\1h \1n\1cWhich, \1hQ\1n\1cuit, \1hCTRL-F\1n\1c, \1h/\1n\1c, or [\1h" + +(defaultSubBoardIdx+1) + "\1n\1c]: \1h");
else
console.print("\1n\1b\1h \1n\1cWhich, \1hQ\1n\1cuit, \1hCTRL-F\1n\1c, \1h/\1n\1c: \1h");
// Accept Q (quit) or a sub-board number
var selectedSubBoard = console.getkeys("Q/" + CTRL_F, msg_area.grp_list[pGrpIdx].sub_list.length);
// If the user just pressed enter (selectedSubBoard would be blank),
// default the selected directory.
var selectedSubBoardStr = selectedSubBoard.toString();
if (selectedSubBoardStr == "")
{
if (defaultSubBoardIdx >= 0)
{
selectedSubBoard = defaultSubBoardIdx + 1; // Make this 1-based
continueOn = false;
}
}
else if ((selectedSubBoardStr == "/") || (selectedSubBoardStr == CTRL_F))
{
// Search
console.crlf();
var searchPromptText = "\1n\1c\1hSearch\1g: \1n";
console.print(searchPromptText);
searchText = console.getstr("", console.screen_columns-strip_ctrl(searchPromptText).length-1, K_UPPER|K_NOCRLF|K_GETSTR|K_NOSPIN|K_LINE);
console.print("\1n");
console.crlf();
if (searchText.length > 0)
defaultSubBoardIdx = -1;
else
defaultSubBoardIdx = pDefaultSubBoardIdx;
continueOn = true;
}
else if (selectedSubBoardStr == "Q")
continueOn = false;
// If a sub-board was chosen, then select it.
if (selectedSubBoard > 0)
{
Eric Oulashin
committed
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
var selectedSubIdx = selectedSubBoard - 1;
// If using sub-board name collapsing and the selected sub-board has sub-subboards, then
// let the user choose a sub-subboard within the sub-board. Otherwise, just select the
// current sub-board.
if (this.useSubCollapsing && this.group_list[pGrpIdx].sub_list[selectedSubIdx].sub_subboard_list.length > 0)
{
var subSubRetObj = this.SelectSubSubWithinSub_Traditional(pGrpIdx, selectedSubIdx);
if (subSubRetObj.areaSelected)
{
retObj.subBoardChosen = true;
retObj.subBoardIndex = subSubRetObj.subIndex;
retObj.subBoardCode = subSubRetObj.subCode;
continueOn = false;
}
else // An area wasn't chosen
{
continueOn = true;
console.clear("\1n");
}
}
else
{
retObj.subBoardChosen = true;
retObj.subBoardIndex = selectedSubIdx;
retObj.subBoardCode = msg_area.grp_list[pGrpIdx].sub_list[selectedSubIdx].code;
continueOn = false;
}
}
} while (continueOn);
return retObj;
}
// For the DDMsgAreaChooser class: Lets the user select a sub-subbboard within a
// message sub-board - Traditional user interface. This is meant for sub-board
// name collapsing, at the 3rd level.
//
// Parameters:
// pGrpIdx: The message group index
// pSubIdx: The index of the sub-board within the message group
//
// Return value: An object containing the following properties:
// areaSelected: Boolean - Whether or not the user chose a sub-subboard.
// subIndex: The index of the sub-board in Synchronet's sub_list array in the group
// subCode: The internal code of the sub-board chosen, if chose. If not chosen,
// this will be an empty string.
function DDMsgAreaChooser_SelectSubSubWithinSub_Traditional(pGrpIdx, pSubIdx)
{
var retObj = {
areaSelected: false,
subIndex: -1,
subCode: ""
};
if (!this.useSubCollapsing || this.group_list.length == 0)
return retObj;
if ((pGrpIdx < 0) || (pGrpIdx >= this.group_list.length))
return retObj;
if ((pSubIdx < 0) || (pSubIdx >= this.group_list[pGrpIdx].sub_list.length))
{
console.clear("\1n");
console.print("\1y\1hThere are no sub-boards in this message group.\r\n\1p");
return retObj;
}
if (this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list.length == 0)
{
console.clear("\1n");
console.print("\1y\1hThere are no sub-subboards in this sub-board.\r\n\1p");
return retObj;
}
// Gets the default sub-subdirectory number (1-based)
function getDefaultSubSubNum(pGrpList, pGrpIdx, pSubIdx)
{
var subSubNum = 0; // Will be 1-based
for (var subSubIdx = 0; subSubIdx < pGrpList[pGrpIdx].sub_list[pSubIdx].sub_subboard_list.length; ++subSubIdx)
{
if (bbs.curdir_code == pGrpList[pGrpIdx].sub_list[pSubIdx].sub_subboard_list[subSubIdx].code)
{
subSubNum = subSubIdx + 1;
break;
}
}
return subSubNum;
}
// defaultSubSubNum is the default sub-subboard # (will be 1-based)
var defaultSubSubNum = getDefaultSubSubNum(this.group_list, pGrpIdx, pSubIdx);
var searchText = "";
var continueOn = false;
do
{
console.clear("\1n");
this.DisplayAreaChgHdr(1);
if (this.areaChangeHdrLines.length > 0)
console.crlf();
// Note: This will list sub-subboards within the sub-board with a valid sub-board index
// as the 2nd parameter.
// TODO: When quitting out of the sub-suboard list, it's going back to the
// message group list
this.ListSubBoardsInMsgGroup(pGrpIdx, pSubIdx, defaultSubSubNum, searchText);
if (defaultSubSubNum >= 1)
console.print("\1n\1b\1h \1n\1cWhich, \1hQ\1n\1cuit, \1hCTRL-F\1n\1c, \1h/\1n\1c, or [\1h" + defaultSubSubNum + "\1n\1c]: \1h");
else
console.print("\1n\1b\1h \1n\1cWhich, \1hQ\1n\1cuit, \1hCTRL-F\1n\1c, \1h/\1n\1c: \1h");
// Accept Q (quit), / or CTRL_F to search, or a file sub-board number
var selectedSubSubNum = console.getkeys("Q/" + CTRL_F, this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list.length);
// If the user just pressed enter (selectedSubSubNum would be blank),
// default the selected sub-board.
if (selectedSubSubNum.toString() == "Q")
continueOn = false;
else if (selectedSubSubNum.toString() == "")
selectedSubSubNum = defaultSubSubNum;
else if ((selectedSubSubNum == "/") || (selectedSubSubNum == CTRL_F))
{
// Search
console.crlf();
var searchPromptText = "\1n\1c\1hSearch\1g: \1n";
console.print(searchPromptText);
searchText = console.getstr("", console.screen_columns-strip_ctrl(searchPromptText).length-1, K_UPPER|K_NOCRLF|K_GETSTR|K_NOSPIN|K_LINE);
console.print("\1n");
console.crlf();
if (searchText.length > 0)
defaultSubSubNum = -1;
else
defaultSubSubNum = getDefaultSubSubNum(this.group_list, pGrpIdx, pSubIdx);
continueOn = true;
console.line_counter = 0; // To avoid pausing before the clear screen
}
// If the user chose a sub-board, then set the user's message sub-board.
if (selectedSubSubNum > 0)
{
continueOn = false;
Eric Oulashin
committed
retObj.areaSelected = true;
retObj.subCode = this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list[selectedSubSubNum-1].code;
retObj.subIndex = this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list[selectedSubSubNum-1].index;
}
} while (continueOn);
return retObj;
}
// For the DDMsgAreaChooser class: Lists all message groups (for the traditional
// user interface).
//
// Parameters:
// pSearchText: Optional - Search text for the message groups
Eric Oulashin
committed
function DDMsgAreaChooser_ListMsgGrps_Traditional(pSearchText)
{
// Print the header
this.WriteGrpListHdrLine();
console.print("\1n");
var searchText = (typeof(pSearchText) == "string" ? pSearchText.toUpperCase() : "");
// List the message groups
var printIt = true;
for (var i = 0; i < msg_area.grp_list.length; ++i)
{
if (searchText.length > 0)
printIt = ((msg_area.grp_list[i].name.toUpperCase().indexOf(searchText) >= 0) || (msg_area.grp_list[i].description.toUpperCase().indexOf(searchText) >= 0));
else
printIt = true;
if (printIt)
{
console.crlf();
this.WriteMsgGroupLine(i, false);
}
}
}
Eric Oulashin
committed
// For the DDMsgAreaChooser class: Lists the sub-boards in a message group
// (or sub-subboards in a sub-board, for sub-board name collapsing), for the
// traditional user interface.
//
// Parameters:
// pGrpIndex: The index of the message group (0-based)
Eric Oulashin
committed
// pSubIdx: Optional - For sub-board name collapsing, this is the (0-based)
// index of the sub-board to show sub-subboards for. To ignore this
// and only show sub-boards of the given group, this can be null or -1.
// pMarkIndex: An index of a message group to highlight. This
// is optional; if left off, this will default to
// the current sub-board.
// pSearchText: Optional - Search text for the sub-boards
// pSortType: Optional - A string describing how to sort the list (if desired):
// "none": Default behavior - Sort by sub-board #
// "dateAsc": Sort by date, ascending
// "dateDesc": Sort by date, descending
// "description": Sort by description
Eric Oulashin
committed
function DDMsgAreaChooser_ListSubBoardsInMsgGroup_Traditional(pGrpIndex, pSubIdx, pMarkIndex, pSearchText, pSortType)
{
// Default to the current message group & sub-board if pGrpIndex
// and pMarkIndex aren't specified.
var grpIndex = 0;
if ((typeof(bbs.cursub_code) == "string") && (bbs.cursub_code != ""))
grpIndex = msg_area.sub[bbs.cursub_code].grp_index;
Eric Oulashin
committed
if ((pGrpIndex != null) && (typeof(pGrpIndex) === "number"))
grpIndex = pGrpIndex;
var highlightIndex = 0;
if ((typeof(bbs.cursub_code) == "string") && (bbs.cursub_code != ""))
highlightIndex = (pGrpIndex == msg_area.sub[bbs.cursub_code].index);
Eric Oulashin
committed
if ((pMarkIndex != null) && (typeof(pMarkIndex) === "number"))
highlightIndex = pMarkIndex;
// Make sure grpIndex and highlightIndex are valid (they might not be for
// brand-new users).
if ((grpIndex == null) || (typeof(grpIndex) == "undefined"))
grpIndex = 0;
if ((highlightIndex == null) || (typeof(highlightIndex) == "undefined"))
highlightIndex = 0;
Eric Oulashin
committed
// Check whether pSubIdx is valid
var subIdxValid = typeof(pSubIdx) === "number" && (pSubIdx > -1);
// Ensure that the sub-board printf information is created for
// this message group.
this.BuildSubBoardPrintfInfoForGrp(grpIndex);
// Print the headers
this.WriteSubBrdListHdr1Line(grpIndex);
console.crlf();
Eric Oulashin
committed
var itemsHdrStr = "Posts";
if (this.useSubCollapsing)
itemsHdrStr = subIdxValid ? "Posts" : "Items";
if (this.showDatesInSubBoardList)
Eric Oulashin
committed
printf(this.subBoardListHdrPrintfStr, "Sub #", "Name", "# " + itemsHdrStr, "Latest date & time");
else
Eric Oulashin
committed
printf(this.subBoardListHdrPrintfStr, "Sub #", "Name", "# " + itemsHdrStr);
console.print("\1n");
// Make the search text uppercase for case-insensitive matching
var searchTextUpper = (typeof(pSearchText) == "string" ? pSearchText.toUpperCase() : "");
// List each sub-board in the message group.
Eric Oulashin
committed
var subBoardArray = null; // For sorting, if desired
var newestDate = {}; // For storing the date of the newest post in a sub-board
var msgBase = null; // For opening the sub-boards with a MsgBase object
var msgHeader = null; // For getting the date & time of the newest post in a sub-board
var subBoardNum = 0; // 0-based sub-board number (because the array index is the number as a str)
// If a sort type is specified, then add the sub-board information to
// subBoardArray so that it can be sorted.
if ((typeof(pSortType) == "string") && (pSortType != "") && (pSortType != "none"))
{
var addSubBoard = true;
subBoardArray = [];
var subBoardInfo = null;
Eric Oulashin
committed
var subList = msg_area.grp_list[grpIndex].sub_list;
if (this.useSubCollapsing)
{
if (subIdxValid)
subList = this.group_list[grpIndex].sub_list[pSubIdx].sub_subboard_list;
else
subList = this.group_list[grpIndex].sub_list;
}
for (var subIdx in subList)
{
// Open the current sub-board with the msgBase object.
// If the search text is set, then use it to filter the sub-boards.
addSubBoard = true;
if (searchTextUpper.length > 0)
{
Eric Oulashin
committed
if (this.useSubCollapsing && subIdxValid)
{
// For sub-board name collapsing, sub-subboards only have descriptions, no names
addSubBoard = (this.group_list[grpIndex].sub_list[pSubIdx].sub_subboard_list[subIdx].description.indexOf(searchTextUpper) >= 0);
}
else
{
addSubBoard = ((msg_area.grp_list[grpIndex].sub_list[subIdx].name.indexOf(searchTextUpper) >= 0) ||
(msg_area.grp_list[grpIndex].sub_list[subIdx].description.indexOf(searchTextUpper) >= 0));
}
}
if (addSubBoard)
{
Eric Oulashin
committed
var subCode = "";
if (this.useSubCollapsing && subIdxValid)
subCode = this.group_list[grpIndex].sub_list[pSubIdx].sub_subboard_list[subIdx].code;
else
subCode = msg_area.grp_list[grpIndex].sub_list[subIdx].code;
msgBase = new MsgBase(subCode);
if (msgBase.open())
{
subBoardInfo = new MsgSubBoardInfo();
Eric Oulashin
committed
subBoardInfo.subBoardNum = +(subIdx);
if (this.useSubCollapsing && subIdxValid)
{
subBoardInfo.subBoardIdx = this.group_list[grpIndex].sub_list[pSubIdx].sub_subboard_list[subIdx].index;
subBoardInfo.description = this.group_list[grpIndex].sub_list[pSubIdx].sub_subboard_list[subIdx].description;
}
else
{
subBoardInfo.subBoardIdx = msg_area.grp_list[grpIndex].sub_list[subIdx].index;
subBoardInfo.description = msg_area.grp_list[grpIndex].sub_list[subIdx].description;
}
Eric Oulashin
committed
if (gUseNumReadableMessagesForMsgCount)
subBoardInfo.numPosts = numReadableMsgs(msgBase, msg_area.grp_list[grpIndex].sub_list[subIdx].code);
else
subBoardInfo.numPosts = msgBase.total_msgs;
// Get the date & time when the last message was imported.
if (this.showDatesInSubBoardList && (subBoardInfo.numPosts > 0))
{
//var msgHeader = msgBase.get_msg_header(true, msgBase.total_msgs-1, true);
Eric Oulashin
committed
var msgHeader = getLatestMsgHdr(msg_area.grp_list[grpIndex].sub_list[subIdx].code);
if (msgHeader === null)
msgHeader = getBogusMsgHdr();
if (this.showImportDates)
Eric Oulashin
committed
subBoardInfo.newestPostDate = msgHeader.when_imported_time;
else
{
var msgWrittenLocalBBSTime = msgWrittenTimeToLocalBBSTime(msgHeader);
if (msgWrittenLocalBBSTime != -1)
subBoardInfo.newestPostDate = msgWrittenLocalBBSTime;
else
subBoardInfo.newestPostDate = msgHeader.when_written_time;
}
}
}
msgBase.close();
subBoardArray.push(subBoardInfo);
delete msgBase; // Free some memory?
}
}
// Sort sub-board list.
if (pSortType == "dateAsc")
{
subBoardArray.sort(function(pA, pB)
{
// Return -1, 0, or 1, depending on whether pA's date comes
// before, is equal to, or comes after pB's date.
var returnValue = 0;
if (pA.newestPostDate < pB.newestPostDate)
returnValue = -1;
else if (pA.newestPostDate > pB.newestPostDate)
returnValue = 1;
return returnValue;
});
}
else if (pSortType == "dateDesc")
{

nightfox
committed
if (this.showDatesInSubBoardList)
{

nightfox
committed
subBoardArray.sort(function(pA, pB)
{
// Return -1, 0, or 1, depending on whether pA's date comes
// after, is equal to, or comes before pB's date.
var returnValue = 0;
if (pA.newestPostDate > pB.newestPostDate)
returnValue = -1;
else if (pA.newestPostDate < pB.newestPostDate)
returnValue = 1;
return returnValue;
});
}
}
else if (pSortType == "description")
{
// Binary safe string comparison
//
// version: 909.322
// discuss at: http://phpjs.org/functions/strcmp // + original by: Waldo Malqui Silva
// + input by: Steve Hilder
// + improved by: Kevin van Zonneveld (http://kevin.vanzonneveld.net)
// + revised by: gorthaur
// * example 1: strcmp( 'waldo', 'owald' ); // * returns 1: 1
// * example 2: strcmp( 'owald', 'waldo' );
// * returns 2: -1
subBoardArray.sort(function(pA, pB)
{
return ((pA.description == pB.description) ? 0 : ((pA.description > pB.description) ? 1 : -1));
});
}
// Display the sub-board list.
for (var i = 0; i < subBoardArray.length; ++i)
{
console.crlf();
var showSubBoardMark = false;
if ((typeof(bbs.cursub_code) == "string") && (bbs.cursub_code != ""))
{
if (subBoardArray[i].subBoardNum == highlightIndex)
showSubBoardMark = ((grpIndex == msg_area.sub[bbs.cursub_code].grp_index) && (highlightIndex == subBoardArray[i].subBoardIdx));
}
console.print(showSubBoardMark ? "\1n" + this.colors.areaMark + "*" : " ");
if (this.showDatesInSubBoardList)
{
printf(this.subBoardListPrintfInfo[grpIndex].printfStr, +(subBoardArray[i].subBoardNum+1),
subBoardArray[i].description.substr(0, this.subBoardNameLen),
subBoardArray[i].numPosts, strftime("%Y-%m-%d", subBoardArray[i].newestPostDate),
strftime("%H:%M:%S", subBoardArray[i].newestPostDate));
}
else
{
printf(this.subBoardListPrintfInfo[grpIndex].printfStr, +(subBoardArray[i].subBoardNum+1),
subBoardArray[i].description.substr(0, this.subBoardNameLen),
subBoardArray[i].numPosts, strftime("%Y-%m-%d", subBoardArray[i].newestPostDate));
}
}
}
// If no sort type is specified, then output the sub-board information in
// order of sub-board number.
else
{
var includeSubBoard = true;
Eric Oulashin
committed
//var subList = this.useSubCollapsing ? this.group_list[grpIndex].sub_list : msg_area.grp_list[grpIndex].sub_list;
var subList = msg_area.grp_list[grpIndex].sub_list;
if (this.useSubCollapsing)
{
if (subIdxValid)
subList = this.group_list[grpIndex].sub_list[pSubIdx].sub_subboard_list;
else
subList = this.group_list[grpIndex].sub_list;
}
for (var subIdx in subList)
{
// If the search text is set, then use it to filter the sub-board list.
includeSubBoard = true;
if (searchTextUpper.length > 0)
{
Eric Oulashin
committed
if (this.useSubCollapsing && subIdxValid)
{
// For sub-board name collapsing, sub-subboards only have descriptions, no names
includeSubBoard = (this.group_list[grpIndex].sub_list[pSubIdx].sub_subboard_list[subIdx].description.indexOf(searchTextUpper) >= 0);
}
else
{
includeSubBoard = ((msg_area.grp_list[grpIndex].sub_list[subIdx].name.toUpperCase().indexOf(searchTextUpper) >= 0) ||
(msg_area.grp_list[grpIndex].sub_list[subIdx].description.toUpperCase().indexOf(searchTextUpper) >= 0));
}
}
if (includeSubBoard)
{
Eric Oulashin
committed
// Call GetSubBoardInfo() to get the information about the sub-board or sub-subboard.
// Make sure we pass the correct indexes.
var subInfo = null;
if (this.useSubCollapsing)
{
Eric Oulashin
committed
// For some reason subIdx is a string, so ensure it's a number when calling GetSubBoardInfo()
if (subIdxValid) // If pSubIdx is valid
subInfo = this.GetSubBoardInfo(grpIndex, pSubIdx, +subIdx);
else
Eric Oulashin
committed
subInfo = this.GetSubBoardInfo(grpIndex, +subIdx);
}
else
subInfo = this.GetSubBoardInfo(grpIndex, subIdx);
newestDate.date = strftime("%Y-%m-%d", subInfo.newestTime);
newestDate.time = strftime("%H:%M:%S", subInfo.newestTime);
// Print the sub-board information
subBoardNum = +(subIdx);
console.crlf();
var showSubBoardMark = false;
if (this.useSubCollapsing)
{
if (subIdxValid) // If using sub-subboards
showSubBoardMark = (bbs.cursub_code == subList[subIdx].code);
else
Eric Oulashin
committed
showSubBoardMark = this.CurrentSubBoardIsInSubSubsForSub(grpIndex, +subIdx);
}
else
showSubBoardMark = (subBoardNum == highlightIndex);
console.print(showSubBoardMark ? "\1n" + this.colors.areaMark + "*" : " ");
var lengthsObj = this.GetSubNameLenAndNumMsgsLen(grpIndex);
Eric Oulashin
committed
if (this.showDatesInSubBoardList)
{
printf(this.subBoardListPrintfInfo[grpIndex].printfStr, +(subBoardNum+1),
subInfo.desc.substr(0, lengthsObj.nameLen), subInfo.numItems,
newestDate.date, newestDate.time);
Eric Oulashin
committed
}
else
{
printf(this.subBoardListPrintfInfo[grpIndex].printfStr, +(subBoardNum+1),
subInfo.desc.substr(0, lengthsObj.nameLen, subInfo.numItems));
Eric Oulashin
committed
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
}
}
}
}
}
// For the DDMsgAreaChooser class: Returns whether the user's current selected sub-board is
// one of the sub-subboards for a sub-board (if sub-board name collapsing is enabled), or
// is the given sub-board in the message group.
//
// Parameters:
// pGrpIdx: The index of the message group (0-based)
// pSubIdx: The index of the sub-board within the message group (0-based)
//
// Return value: True/false, whether or not the user's current selected sub-board is one of
// the sub-subboards for a sub-board (if sub-board name collapsing is enabled)
// or is the given sub-board in the message group.
function DDMsgAreaChooser_CurrentSubBoardIsInSubSubsForSub(pGrpIdx, pSubIdx)
{
// Sanity checking
if (typeof(bbs.cursub_code) !== "string") // Rare case, for brand new user accounts
return false;
if (typeof(pGrpIdx) !== "number")
return false;
if (typeof(pSubIdx) !== "number")
return false;
var chosenSubMatch = false;
if (this.useSubCollapsing)
{
if (pGrpIdx >= 0 && pGrpIdx < this.group_list.length && pSubIdx >= 0 && pSubIdx < this.group_list[pGrpIdx].sub_list.length)
{
// If this sub-board has a list of sub-subboards, then go through the sub-subboards and see if the
// user's current sub-board is one of the sub-subboards.
if (typeof(this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list) !== "undefined" && this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list.length > 0)
{
for (var subSubIdx = 0; subSubIdx < this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list.length && !chosenSubMatch; ++subSubIdx)
chosenSubMatch = (bbs.cursub_code == this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list[subSubIdx].code);
}
else // There is no sub-subboard list for this sub-board
chosenSubMatch = (bbs.cursub_code == this.group_list[pGrpIdx].sub_list[pSubIdx].code);
}
}
else
{
if (pGrpIdx >= 0 && pGrpIdx < msg_area.grp_list.length && pSubIdx >= 0 && pSubIdx < msg_area.grp_list[pGrpIdx].sub_list.length)
chosenSubMatch = (bbs.cursub_code == msg_area.grp_list[pGrpIdx].sub_list[pSubIdx].code);
}
return chosenSubMatch;
}
// For the DDMsgAreaChooser class: With a group & sub-board index, this function gets the date
// & time of the latest posted message from a sub-board (or group of sub-boards, if using
// sub-board name collapsing). This function also gets the description of the sub-board (or
// group of sub-boards if using sub-board name collapsing).
//
// Parameters:
// pGrpIdx: The index of the message group
// pSubIdx: The index of the sub-board in the message group (if using
// sub-board name collapsing, this could be the index of a set
// of sub-subboards).
// pSubSubIdx: Optional - When sub-board name collapsing is being used,
// this specifies the index of the sub-subboard within the subboard.
//
// Return value: An object containing the following properties:
// desc: The description of the sub-board (or group of sub-subboards if using name collapsing)
// numItems: The number of messages in the sub-board or number of sub-subboards in the group,
// if using sub-board name collapsing
// subCode: The internal code of the sub-board (this will be an empty string if it's a group of sub-subboards)
// newestTime: A value containing the date & time of the newest post in the sub-board or group of sub-boards
function DDMsgAreaChooser_GetSubBoardInfo(pGrpIdx, pSubIdx, pSubSubIdx)
{
var retObj = {
desc: "",
numItems: 0,
subCode: "",
newestTime: 0
};
Eric Oulashin
committed
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
// If using sub-board name collapsing and the given group & sub-board indexes has a
// group of sub-subboards, then look through those sub-boards for information.
if (this.useSubCollapsing)
{
if (typeof(pSubSubIdx) === "number" && pSubSubIdx >= 0 && pSubSubIdx < this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list.length)
{
retObj.desc = this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list[pSubSubIdx].description;
retObj.subCode = this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list[pSubSubIdx].code;
retObj.numItems = getNumMsgsInSubBoard(this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list[pSubSubIdx].code);
retObj.newestTime = getLatestMsgTime(this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list[pSubSubIdx].code);
}
else // pSubSubIdx wasn't specified or is invalid
{
retObj.numItems = this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list.length;
retObj.desc = this.group_list[pGrpIdx].sub_list[pSubIdx].description;
if (this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list.length > 0)
{
for (var subSubIdx = 0; subSubIdx < this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list; ++subSubIdx)
{
var latestPostTime = getLatestMsgTime(this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list[subSubIdx].code);
if (latestPostTime > retObj.newestTime)
retObj.newestTime = latestPostTime;
}
Eric Oulashin
committed
}
else
{
// No sub-subboards in this sub-board
retObj.subCode = this.group_list[pGrpIdx].sub_list[pSubIdx].code;
retObj.numItems = getNumMsgsInSubBoard(this.group_list[pGrpIdx].sub_list[pSubIdx].code);
retObj.newestTime = getLatestMsgTime(this.group_list[pGrpIdx].sub_list[pSubIdx].code);
}
}
}
else // No sub-board name collapsing, or there are no sub-subboards in this sub-board
{
retObj.desc = msg_area.grp_list[pGrpIdx].sub_list[pSubIdx].description;
retObj.subCode = msg_area.grp_list[pGrpIdx].sub_list[pSubIdx].code;
Eric Oulashin
committed
// Get the number of messages in the sub-board
Eric Oulashin
committed
var numMsgs = 0;
if (gUseNumReadableMessagesForMsgCount)
numMsgs = numReadableMsgs(msgBase, msg_area.grp_list[pGrpIdx].sub_list[pSubIdx].code);
else
numMsgs = getNumMsgsInSubBoard(msg_area.grp_list[pGrpIdx].sub_list[pSubIdx].code);
Eric Oulashin
committed
if (numMsgs > 0)
{
retObj.numItems = numMsgs;
//var msgHeader = msgBase.get_msg_header(true, msgBase.total_msgs-1, true);
var msgHeader = getLatestMsgHdr(retObj.subCode);
if (msgHeader === null)
msgHeader = getBogusMsgHdr();
// Set the newest post time
if (this.showImportDates)
retObj.newestTime = msgHeader.when_imported_time;
else
{
var msgWrittenLocalBBSTime = msgWrittenTimeToLocalBBSTime(msgHeader);
if (msgWrittenLocalBBSTime != -1)
retObj.newestTime = msgWrittenLocalBBSTime;
else
retObj.newestTime = msgHeader.when_written_time;
}
}
}
Eric Oulashin
committed
return retObj;
}
//////////////////////////////////////////////
// Message group list stuff (lightbar mode) //
//////////////////////////////////////////////
// For the DDMsgAreaChooser class - Writes a message group information line.
//
// Parameters:
// pGrpIndex: The index of the message group to write (assumed to be valid)
// pHighlight: Boolean - Whether or not to write the line highlighted.
function DDMsgAreaChooser_writeMsgGroupLine(pGrpIndex, pHighlight)
{
console.print("\1n");
// Write the highlight background color if pHighlight is true.
if (pHighlight)
console.print(this.colors.bkgHighlight);
// Write the message group information line
var grpIsSelected = false;
if ((typeof(bbs.cursub_code) == "string") && (bbs.cursub_code != ""))
grpIsSelected = (pGrpIndex == msg_area.sub[bbs.cursub_code].grp_index);
console.print(grpIsSelected ? this.colors.areaMark + "*" : " ");
printf((pHighlight ? this.msgGrpListHilightPrintfStr : this.msgGrpListPrintfStr),
+(pGrpIndex+1),
msg_area.grp_list[pGrpIndex].description.substr(0, this.msgGrpDescLen),
msg_area.grp_list[pGrpIndex].sub_list.length);
console.cleartoeol("\1n");
}
//////////////////////////////////////////////////
// Message sub-board list stuff (lightbar mode) //
//////////////////////////////////////////////////
Eric Oulashin
committed
// For the DDMsgAreaChooser class: Gets a message sub-board information line.
//
// Parameters:
// pGrpIndex: The index of the message group (assumed to be valid)
// pSubIndex: The index of the sub-board within the message group to write (assumed to be valid)
// pHighlight: Boolean - Whether or not to write the line highlighted.
Eric Oulashin
committed
function DDMsgAreaChooser_GetMsgSubBrdLine(pGrpIndex, pSubIndex, pHighlight)
{
var subBoardLine = "\1n";
// Write the highlight background color if pHighlight is true.
if (pHighlight)
subBoardLine += this.colors.bkgHighlight;
// Determine if pGrpIndex and pSubIndex specify the user's
// currently-selected group and sub-board.
var currentSub = false;
if ((typeof(bbs.cursub_code) == "string") && (bbs.cursub_code != ""))
currentSub = ((pGrpIndex == msg_area.sub[bbs.cursub_code].grp_index) && (pSubIndex == msg_area.sub[bbs.cursub_code].index));
// Open the current sub-board with the msgBase object (so that we can get
// the date & time of the last imported message).
var msgBase = new MsgBase(msg_area.grp_list[pGrpIndex].sub_list[pSubIndex].code);
if (msgBase.open())
{
Eric Oulashin
committed
var numMsgs = 0;
if (gUseNumReadableMessagesForMsgCount)
numMsgs = numReadableMsgs(msgBase, msg_area.grp_list[pGrpIndex].sub_list[pSubIndex].code);
else
numMsgs = msgBase.total_msgs;
var newestDate = {}; // For storing the date of the newest post
// Get the date & time when the last message was imported.
var msgHeader = getLatestMsgHdr(msg_area.grp_list[pGrpIndex].sub_list[pSubIndex].code);
if (msgHeader != null)
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
{
// Construct the date & time strings of the latest post
if (this.showImportDates)
{
newestDate.date = strftime("%Y-%m-%d", msgHeader.when_imported_time);
newestDate.time = strftime("%H:%M:%S", msgHeader.when_imported_time);
}
else
{
var msgWrittenLocalBBSTime = msgWrittenTimeToLocalBBSTime(msgHeader);
if (msgWrittenLocalBBSTime != -1)
{
newestDate.date = strftime("%Y-%m-%d", msgWrittenLocalBBSTime);
newestDate.time = strftime("%H:%M:%S", msgWrittenLocalBBSTime);
}
else
{
newestDate.date = strftime("%Y-%m-%d", msgHeader.when_written_time);
newestDate.time = strftime("%H:%M:%S", msgHeader.when_written_time);
}
}
}
else
newestDate.date = newestDate.time = "";
// Print the sub-board information line.
var lengthsObj = this.GetSubNameLenAndNumMsgsLen(pGrpIndex);
subBoardLine += (currentSub ? this.colors.areaMark + "*" : " ");
if (this.showDatesInSubBoardList)
{
subBoardLine += format((pHighlight ? this.subBoardListPrintfInfo[pGrpIndex].highlightPrintfStr : this.subBoardListPrintfInfo[pGrpIndex].printfStr),
+(pSubIndex+1), msg_area.grp_list[pGrpIndex].sub_list[pSubIndex].description.substr(0, lengthsObj.nameLen),
numMsgs, newestDate.date, newestDate.time);
}
else
{
subBoardLine += format((pHighlight ? this.subBoardListPrintfInfo[pGrpIndex].highlightPrintfStr : this.subBoardListPrintfInfo[pGrpIndex].printfStr),
+(pSubIndex+1), msg_area.grp_list[pGrpIndex].sub_list[pSubIndex].description.substr(0, lengthsObj.nameLen),
numMsgs);
}
msgBase.close();
}
return subBoardLine;
}
///////////////////////////////////////////////
// Other functions for the msg. area chooser //
///////////////////////////////////////////////
// For the DDMsgAreaChooser class: Reads the configuration file.
function DDMsgAreaChooser_ReadConfigFile()
{
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
// Determine the script's startup directory.
// This code is a trick that was created by Deuce, suggested by Rob Swindell
// as a way to detect which directory the script was executed in. I've
// shortened the code a little.
var startup_path = '.';
try { throw dig.dist(dist); } catch(e) { startup_path = e.fileName; }
startup_path = backslash(startup_path.replace(/[\/\\][^\/\\]*$/,''));
// Open the configuration file
var cfgFile = new File(startup_path + "DDMsgAreaChooser.cfg");
if (cfgFile.open("r"))
{
var settingsMode = "behavior";
var fileLine = null; // A line read from the file
var equalsPos = 0; // Position of a = in the line
var commentPos = 0; // Position of the start of a comment
var setting = null; // A setting name (string)
var settingUpper = null; // Upper-case setting name
var value = null; // A value for a setting (string)
while (!cfgFile.eof)
{
// Read the next line from the config file.
fileLine = cfgFile.readln(2048);
// fileLine should be a string, but I've seen some cases
// where it isn't, so check its type.
if (typeof(fileLine) != "string")
continue;
// If the line starts with with a semicolon (the comment
// character) or is blank, then skip it.
if ((fileLine.substr(0, 1) == ";") || (fileLine.length == 0))
continue;
// If in the "behavior" section, then set the behavior-related variables.
if (fileLine.toUpperCase() == "[BEHAVIOR]")
{
settingsMode = "behavior";
continue;
}
else if (fileLine.toUpperCase() == "[COLORS]")
{
settingsMode = "colors";
continue;
}
// If the line has a semicolon anywhere in it, then remove
// everything from the semicolon onward.
commentPos = fileLine.indexOf(";");
if (commentPos > -1)
fileLine = fileLine.substr(0, commentPos);
// Look for an equals sign, and if found, separate the line
// into the setting name (before the =) and the value (after the
// equals sign).
equalsPos = fileLine.indexOf("=");
if (equalsPos > 0)
{
// Read the setting & value, and trim leading & trailing spaces.
setting = trimSpaces(fileLine.substr(0, equalsPos), true, false, true);
settingUpper = setting.toUpperCase();
value = trimSpaces(fileLine.substr(equalsPos+1), true, false, true);
if (settingsMode == "behavior")
{
// Set the appropriate value in the settings object.
if (settingUpper == "USELIGHTBARINTERFACE")
this.useLightbarInterface = (value.toUpperCase() == "TRUE");
else if (settingUpper == "SHOWIMPORTDATES")
this.showImportDates = (value.toUpperCase() == "TRUE");
else if (settingUpper == "AREACHOOSERHDRFILENAMEBASE")
this.areaChooserHdrFilenameBase = value;
else if (settingUpper == "AREACHOOSERHDRMAXLINES")
{
var maxNumLines = +value;
if (maxNumLines > 0)
this.areaChooserHdrMaxLines = maxNumLines;
}
else if (settingUpper == "SHOWDATESINSUBBOARDLIST")
this.showDatesInSubBoardList = (value.toUpperCase() == "TRUE");
Eric Oulashin
committed
else if (settingUpper == "USESUBCOLLAPSING")
this.useSubCollapsing = (value.toUpperCase() == "TRUE");
else if (settingUpper == "SUBCOLLAPSESEPARATOR")
{
if (value.length > 0)
this.subCollapseSeparator = value;
}
}
else if (settingsMode == "colors")
this.colors[setting] = value;
}
}
cfgFile.close();
}
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
}
// For the DDMsgAreaChooser class: Shows the help screen
//
// Parameters:
// pLightbar: Boolean - Whether or not to show lightbar help. If
// false, then this function will show regular help.
// pClearScreen: Boolean - Whether or not to clear the screen first
function DDMsgAreaChooser_showHelpScreen(pLightbar, pClearScreen)
{
if (pClearScreen)
console.clear("\1n");
else
console.print("\1n");
console.center("\1c\1hDigital Distortion Message Area Chooser");
console.center("\1k");
console.center("\1n\1cVersion \1g" + DD_MSG_AREA_CHOOSER_VERSION +
" \1w\1h(\1b" + DD_MSG_AREA_CHOOSER_VER_DATE + "\1w)");
console.crlf();
console.print("\1n\1cFirst, a listing of message groups is displayed. One can be chosen by typing");
console.crlf();
console.print("its number. Then, a listing of sub-boards within that message group will be");
console.crlf();
console.print("shown, and one can be chosen by typing its number.");
console.crlf();
if (pLightbar)
{
console.crlf();
console.print("\1n\1cThe lightbar interface also allows up & down navigation through the lists:");
console.crlf();
console.print("\1k\1h");
console.crlf();
console.print("\1n\1c\1hUp arrow\1n\1c: Move the cursor up one line");
console.crlf();
console.print("\1hDown arrow\1n\1c: Move the cursor down one line");
console.crlf();
console.print("\1hENTER\1n\1c: Select the current group/sub-board");
console.crlf();
console.print("\1hHOME\1n\1c: Go to the first item on the screen");
console.crlf();
console.print("\1hEND\1n\1c: Go to the last item on the screen");
console.crlf();
console.print("\1hPageUp\1n\1c/\1hPageDown\1n\1c: Go to the previous/next page");
console.crlf();
console.print("\1hF\1n\1c/\1hL\1n\1c: Go to the first/last page");
console.crlf();
console.print("\1h/\1n\1c or \1hCtrl-F\1n\1c: Find by name/description");
console.crlf();
console.print("\1hN\1n\1c: Next search result (after a find)");
console.crlf();
}
console.crlf();
console.print("Additional keyboard commands:");
console.crlf();
console.print("\1k\1h");
console.crlf();
console.print("\1n\1c\1h?\1n\1c: Show this help screen");
console.crlf();
console.print("\1hQ\1n\1c: Quit");
console.crlf();
}
// For the DDMsgAreaChooser class: Builds sub-board printf format information
// for a message group. The widths of the description & # messages columns
// are calculated based on the greatest number of messages in a sub-board for
// the message group.
//
// Parameters:
// pGrpIndex: The index of the message group
Eric Oulashin
committed
function DDMsgAreaChooser_BuildSubBoardPrintfInfoForGrp(pGrpIndex)
{
// If the array of sub-board printf strings doesn't contain the printf
// strings for this message group, then figure out the largest number
// of messages in the message group and add the printf strings.
if (typeof(this.subBoardListPrintfInfo[pGrpIndex]) == "undefined")
{
var greatestNumMsgs = getGreatestNumMsgs(pGrpIndex);
this.subBoardListPrintfInfo[pGrpIndex] = {};
this.subBoardListPrintfInfo[pGrpIndex].numMsgsLen = greatestNumMsgs.toString().length;
Eric Oulashin
committed
var numMsgsLen = this.subBoardListPrintfInfo[pGrpIndex].numMsgsLen;
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
// Sub-board name length: With a # items length of 4, this should be
// 47 for an 80-column display.
this.subBoardListPrintfInfo[pGrpIndex].nameLen = console.screen_columns - this.areaNumLen - this.subBoardListPrintfInfo[pGrpIndex].numMsgsLen - 5;
if (this.showDatesInSubBoardList)
this.subBoardListPrintfInfo[pGrpIndex].nameLen -= (this.dateLen + this.timeLen + 2);
// Create the printf strings
this.subBoardListPrintfInfo[pGrpIndex].printfStr = " " + this.colors.areaNum
+ "%" + this.areaNumLen + "d "
+ this.colors.desc + "%-"
+ this.subBoardListPrintfInfo[pGrpIndex].nameLen + "s "
+ this.colors.numItems + "%"
+ this.subBoardListPrintfInfo[pGrpIndex].numMsgsLen + "d";
if (this.showDatesInSubBoardList)
{
this.subBoardListPrintfInfo[pGrpIndex].printfStr += " "
+ this.colors.latestDate + "%" + this.dateLen + "s "
+ this.colors.latestTime + "%" + this.timeLen + "s";
}
this.subBoardListPrintfInfo[pGrpIndex].highlightPrintfStr = "\1n" + this.colors.bkgHighlight
+ " " + "\1n"
+ this.colors.bkgHighlight
+ this.colors.areaNumHighlight
+ "%" + this.areaNumLen + "d \1n"
+ this.colors.bkgHighlight
+ this.colors.descHighlight + "%-"
+ this.subBoardListPrintfInfo[pGrpIndex].nameLen + "s \1n"
+ this.colors.bkgHighlight
+ this.colors.numItemsHighlight + "%"
+ this.subBoardListPrintfInfo[pGrpIndex].numMsgsLen + "d";
if (this.showDatesInSubBoardList)
{
this.subBoardListPrintfInfo[pGrpIndex].highlightPrintfStr += " \1n"
+ this.colors.bkgHighlight
+ this.colors.dateHighlight + "%" + this.dateLen + "s \1n"
+ this.colors.bkgHighlight
+ this.colors.timeHighlight + "%" + this.timeLen + "s\1n";
}
}
}
// For the DDMsgAreaChooser class: Displays the area chooser header
//
// Parameters:
// pStartScreenRow: The row on the screen at which to start displaying the
// header information. Will be used if the user's terminal
// supports ANSI.
// pClearRowsFirst: Optional boolean - Whether or not to clear the rows first.
// Defaults to true. Only valid if the user's terminal supports
// ANSI.
function DDMsgAreaChooser_DisplayAreaChgHdr(pStartScreenRow, pClearRowsFirst)
{
if (this.areaChangeHdrLines == null)
return;
if (this.areaChangeHdrLines.length == 0)
return;
// If the user's terminal supports ANSI and pStartScreenRow is a number, then
// we can move the cursor and display the header where specified.
Eric Oulashin
committed
if (console.term_supports(USER_ANSI) && (typeof(pStartScreenRow) === "number"))
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
{
// If specified to clear the rows first, then do so.
var screenX = 1;
var screenY = pStartScreenRow;
var clearRowsFirst = (typeof(pClearRowsFirst) == "boolean" ? pClearRowsFirst : true);
if (clearRowsFirst)
{
console.print("\1n");
for (var hdrFileIdx = 0; hdrFileIdx < this.areaChangeHdrLines.length; ++hdrFileIdx)
{
console.gotoxy(screenX, screenY++);
console.cleartoeol();
}
}
// Display the header starting on the first column and the given screen row.
screenX = 1;
screenY = pStartScreenRow;
for (var hdrFileIdx = 0; hdrFileIdx < this.areaChangeHdrLines.length; ++hdrFileIdx)
{
console.gotoxy(screenX, screenY++);
console.print(this.areaChangeHdrLines[hdrFileIdx]);
//console.putmsg(this.areaChangeHdrLines[hdrFileIdx]);
//console.cleartoeol("\1n"); // Shouldn't do this, as it resets color attributes
}
}
else
{
// The user's terminal doesn't support ANSI or pStartScreenRow is not a
// number - So just output the header lines.
for (var hdrFileIdx = 0; hdrFileIdx < this.areaChangeHdrLines.length; ++hdrFileIdx)
{
console.print(this.areaChangeHdrLines[hdrFileIdx]);
//console.putmsg(this.areaChangeHdrLines[hdrFileIdx]);
//console.cleartoeol("\1n"); // Shouldn't do this, as it resets color attributes
console.crlf();
}
}
}
// For the DDMsgAreaChooser class: Writes a temporary error message at the key help line
// for lightbar mode.
//
// Parameters:
// pErrorMsg: The error message to write
// pRefreshHelpLine: Whether or not to re-draw the help line on the screen
function DDMsgAreaChooser_WriteLightbarKeyHelpErrorMsg(pErrorMsg, pRefreshHelpLine)
{
console.gotoxy(1, console.screen_rows);
console.cleartoeol("\1n");
console.gotoxy(1, console.screen_rows);
console.print("\1y\1h" + pErrorMsg + "\1n");
mswait(ERROR_WAIT_MS);
if (pRefreshHelpLine)
this.WriteKeyHelpLine();
}
Eric Oulashin
committed
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
// For the DDMsgAreaChooser class: Sets up the group_list array according to
// the sub-board collapse separator
function DDMsgAreaChooser_SetUpGrpListWithCollapsedSubBoards()
{
// Returns a default object for a message group
function defaultMsgGrpObj()
{
return {
index: 0,
number: 0,
name: "",
description: "",
ars: 0,
sub_list: []
};
}
// Returns a default object for a message sub-board. It can potentially
// contain its own list of sub-boards within the original subboard.
function defaultSubBoardObj()
{
return {
index: 0,
number: 0,
grp_index: 0,
grp_number: 0,
grp_name: 0,
code: "",
name: "",
grp_name: "",
description: "",
ars: 0,
settings: 0,
sub_subboard_list: []
};
}
function subBoardObjFromOfficialSubBoard(pGrpIdx, pSubIdx)
{
var subObj = defaultSubBoardObj();
for (var prop in subObj)
{
if (prop != "sub_subboard_list") // Doesn't exist in the official dir objects
subObj[prop] = msg_area.grp_list[pGrpIdx].sub_list[pSubIdx][prop];
}
return subObj;
}
if (this.group_list.length == 0)
{
// Copy some of the information from msg_area.grp_list
for (var grpIdx = 0; grpIdx < msg_area.grp_list.length; ++grpIdx)
{
// Go through sub_list in the curent message group, and for
// any that have the collapse separator, add only one copy
// of the name to the sub_list property for this group.
// First, we'll have to see if multiple sub-boards with
// the collapse separator have the same prefix.
// dirDescs is an object indexed by sub-board description,
// and the value will be how many times it was seen.
var subBoardDescs = {};
Eric Oulashin
committed
// First, count the number of sub-boards that have the separator.
// If all of the group's sub-boards have the separator, then we
// won't collapse the sub-boards.
var numSubBoardsWithSeparator = 0;
Eric Oulashin
committed
for (var subIdx = 0; subIdx < msg_area.grp_list[grpIdx].sub_list.length; ++subIdx)
{
var subBoardDesc = msg_area.grp_list[grpIdx].sub_list[subIdx].description;
Eric Oulashin
committed
if (subBoardDesc.indexOf(this.subCollapseSeparator) > -1)
++numSubBoardsWithSeparator;
}
// Whether or not to use sub-board collapsing for this group
var collapseThisGroup = (numSubBoardsWithSeparator > 0 && numSubBoardsWithSeparator < msg_area.grp_list[grpIdx].sub_list.length);
// Go through and build the group list
for (var subIdx = 0; subIdx < msg_area.grp_list[grpIdx].sub_list.length; ++subIdx)
{
var subBoardDesc = msg_area.grp_list[grpIdx].sub_list[subIdx].description;
if (collapseThisGroup)
{
var sepIdx = subBoardDesc.indexOf(this.subCollapseSeparator);
if (sepIdx > -1)
subBoardDesc = truncsp(subBoardDesc.substr(0, sepIdx)); // Remove trailing whitespace
}
Eric Oulashin
committed
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
if (subBoardDescs.hasOwnProperty(subBoardDesc))
subBoardDescs[subBoardDesc] += 1;
else
subBoardDescs[subBoardDesc] = 1;
}
// Create an initial file group object for this file group (except
// for sub_list, which we will build ourselves for this group)
var msgGrpObj = defaultMsgGrpObj();
for (var prop in msgGrpObj)
{
if (prop != "sub_list")
msgGrpObj[prop] = msg_area.grp_list[grpIdx][prop];
}
// Go through the dirs in this group again. For each sub-board:
// If its whole description exists in subBoardDescs, then just add it to
// the sub_list array. Otherwise:
// If a collapse seprator exists, then split on that and see if the
// prefix was seen more than once. If so, then add the separate
// subdirs as their own items in the sub_list array. Otherwise,
// add the single sub-board to the sub_list array with the whole
// description.
var addedPrefixDescriptionDirs = {};
for (var subIdx = 0; subIdx < msg_area.grp_list[grpIdx].sub_list.length; ++subIdx)
{
var subBoardDesc = msg_area.grp_list[grpIdx].sub_list[subIdx].description;
if (subBoardDescs.hasOwnProperty(subBoardDesc))
msgGrpObj.sub_list.push(subBoardObjFromOfficialSubBoard(grpIdx, subIdx));
else
{
var subSubDirDesc = "";
var sepIdx = subBoardDesc.indexOf(this.subCollapseSeparator);
if (sepIdx > -1)
{
subBoardDesc = truncsp(subBoardDesc.substr(0, sepIdx)); // Remove trailing whitespace
// If it has been seen more than once, then the description should
// be the prefix description
if (subBoardDescs[subBoardDesc] > 1)
{
var addedSubIdx = msgGrpObj.sub_list.length - 1;
if (!addedPrefixDescriptionDirs.hasOwnProperty(subBoardDesc))
{
// Add it to sub_list
msgGrpObj.sub_list.push(subBoardObjFromOfficialSubBoard(grpIdx, subIdx));
addedSubIdx = msgGrpObj.sub_list.length - 1;
msgGrpObj.sub_list[addedSubIdx].description = subBoardDesc;
addedPrefixDescriptionDirs[subBoardDesc] = true;
}
// Add the sub-subboard to the sub-board's sub-subboard list
// Using skipsp() to strip leading whitespace
subSubDirDesc = skipsp(msg_area.grp_list[grpIdx].sub_list[subIdx].description.substr(sepIdx+1));
msgGrpObj.sub_list[addedSubIdx].sub_subboard_list.push({
description: subSubDirDesc,
code: msg_area.grp_list[grpIdx].sub_list[subIdx].code,
index: msg_area.grp_list[grpIdx].sub_list[subIdx].index,
grp_index: msg_area.grp_list[grpIdx].sub_list[subIdx].grp_index
});
}
else // Add it with the full description
msgGrpObj.sub_list.push(subBoardObjFromOfficialSubBoard(grpIdx, subIdx));
}
if (subBoardDescs.hasOwnProperty(subBoardDesc))
subBoardDescs[subBoardDescs] += 1;
else
subBoardDescs[subBoardDescs] = 1;
}
}
this.group_list.push(msgGrpObj);
}
}
}
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
// Removes multiple, leading, and/or trailing spaces.
// The search & replace regular expressions used in this
// function came from the following URL:
// http://qodo.co.uk/blog/javascript-trim-leading-and-trailing-spaces
//
// Parameters:
// pString: The string to trim
// pLeading: Whether or not to trim leading spaces (optional, defaults to true)
// pMultiple: Whether or not to trim multiple spaces (optional, defaults to true)
// pTrailing: Whether or not to trim trailing spaces (optional, defaults to true)
function trimSpaces(pString, pLeading, pMultiple, pTrailing)
{
var leading = true;
var multiple = true;
var trailing = true;
if(typeof(pLeading) != "undefined")
leading = pLeading;
if(typeof(pMultiple) != "undefined")
multiple = pMultiple;
if(typeof(pTrailing) != "undefined")
trailing = pTrailing;
// To remove both leading & trailing spaces:
//pString = pString.replace(/(^\s*)|(\s*$)/gi,"");
if (leading)
pString = pString.replace(/(^\s*)/gi,"");
if (multiple)
pString = pString.replace(/[ ]{2,}/gi," ");
if (trailing)
pString = pString.replace(/(\s*$)/gi,"");
return pString;
}
// Calculates & returns a page number.
//
// Parameters:
// pTopIndex: The index (0-based) of the topmost item on the page
// pNumPerPage: The number of items per page
//
// Return value: The page number
function calcPageNum(pTopIndex, pNumPerPage)
{
return ((pTopIndex / pNumPerPage) + 1);
}
// Returns the greatest number of messages of all sub-boards within
// a message group.
//
// Parameters:
// pGrpIndex: The index of the message group
//
// Returns: The greatest number of messages of all sub-boards within
// the message group
function getGreatestNumMsgs(pGrpIndex)
{
// Sanity checking
Eric Oulashin
committed
if (typeof(pGrpIndex) !== "number")
return 0;
if (typeof(msg_area.grp_list[pGrpIndex]) == "undefined")
return 0;
var greatestNumMsgs = 0;
var msgBase = null;
for (var subIndex = 0; subIndex < msg_area.grp_list[pGrpIndex].sub_list.length; ++subIndex)
{
msgBase = new MsgBase(msg_area.grp_list[pGrpIndex].sub_list[subIndex].code);
if (msgBase == null) continue;
if (msgBase.open())
{
Eric Oulashin
committed
var numMsgs = 0;
if (gUseNumReadableMessagesForMsgCount)
numMsgs = numReadableMsgs(msgBase, msg_area.grp_list[pGrpIndex].sub_list[subIndex].code);
else
numMsgs = msgBase.total_msgs;
if (numMsgs > greatestNumMsgs)
greatestNumMsgs = numMsgs;
msgBase.close();
}
}
return greatestNumMsgs;
}
Eric Oulashin
committed
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
// Returns the number of messages in a sub-board
//
// Parameters:
// pSubCode: The internal code of the sub-board
//
// Return value: The number of messages in the sub-board, or 0 if can't be opened
function getNumMsgsInSubBoard(pSubCode)
{
if (typeof(pSubCode) !== "string")
return 0;
var numMsgs = 0;
var msgBase = new MsgBase(pSubCode);
if (msgBase != null && msgBase.open())
{
numMsgs = msgBase.total_msgs;
msgBase.close();
}
delete msgBase; // Free some memory?
return numMsgs;
}
// Inputs a keypress from the user and handles some ESC-based
// characters such as PageUp, PageDown, and ESC. If PageUp
// or PageDown are pressed, this function will return the
// string "\1PgUp" (KEY_PAGE_UP) or "\1Pgdn" (KEY_PAGE_DOWN),
// respectively. Also, F1-F5 will be returned as "\1F1"
// through "\1F5", respectively.
// Thanks goes to Psi-Jack for the original impementation
// of this function.
//
// Parameters:
// pGetKeyMode: Optional - The mode bits for console.getkey().
// If not specified, K_NONE will be used.
//
// Return value: The user's keypress
function getKeyWithESCChars(pGetKeyMode)
{
var getKeyMode = K_NONE;
Eric Oulashin
committed
if (typeof(pGetKeyMode) === "number")
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
getKeyMode = pGetKeyMode;
var userInput = console.getkey(getKeyMode);
if (userInput == KEY_ESC)
{
switch (console.inkey(K_NOECHO|K_NOSPIN, 2))
{
case '[':
switch (console.inkey(K_NOECHO|K_NOSPIN, 2))
{
case 'V':
userInput = KEY_PAGE_UP;
break;
case 'U':
userInput = KEY_PAGE_DOWN;
break;
}
break;
case 'O':
switch (console.inkey(K_NOECHO|K_NOSPIN, 2))
{
case 'P':
userInput = "\1F1";
break;
case 'Q':
userInput = "\1F2";
break;
case 'R':
userInput = "\1F3";
break;
case 'S':
userInput = "\1F4";
break;
case 't':
userInput = "\1F5";
break;
}
default:
break;
}
}
return userInput;
}
// Loads a text file (an .ans or .asc) into an array. This will first look for
// an .ans version, and if exists, convert to Synchronet colors before loading
// it. If an .ans doesn't exist, this will look for an .asc version.
//
// Parameters:
// pFilenameBase: The filename without the extension
// pMaxNumLines: Optional - The maximum number of lines to load from the text file
//
// Return value: An array containing the lines from the text file
function loadTextFileIntoArray(pFilenameBase, pMaxNumLines)
{
if (typeof(pFilenameBase) != "string")
return new Array();
Eric Oulashin
committed
var maxNumLines = (typeof(pMaxNumLines) === "number" ? pMaxNumLines : -1);
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
var txtFileLines = new Array();
// See if there is a header file that is made for the user's terminal
// width (areaChgHeader-<width>.ans/asc). If not, then just go with
// msgHeader.ans/asc.
var txtFileExists = true;
var txtFilenameFullPath = gStartupPath + pFilenameBase;
var txtFileFilename = "";
if (file_exists(txtFilenameFullPath + "-" + console.screen_columns + ".ans"))
txtFileFilename = txtFilenameFullPath + "-" + console.screen_columns + ".ans";
else if (file_exists(txtFilenameFullPath + "-" + console.screen_columns + ".asc"))
txtFileFilename = txtFilenameFullPath + "-" + console.screen_columns + ".asc";
else if (file_exists(txtFilenameFullPath + ".ans"))
txtFileFilename = txtFilenameFullPath + ".ans";
else if (file_exists(txtFilenameFullPath + ".asc"))
txtFileFilename = txtFilenameFullPath + ".asc";
else
txtFileExists = false;
if (txtFileExists)
{
var syncConvertedHdrFilename = txtFileFilename;
// If the user's console doesn't support ANSI and the header file is ANSI,
// then convert it to Synchronet attribute codes and read that file instead.
if (!console.term_supports(USER_ANSI) && (getStrAfterPeriod(txtFileFilename).toUpperCase() == "ANS"))
{
syncConvertedHdrFilename = txtFilenameFullPath + "_converted.asc";
if (!file_exists(syncConvertedHdrFilename))
{
if (getStrAfterPeriod(txtFileFilename).toUpperCase() == "ANS")
{
var filenameBase = txtFileFilename.substr(0, dotIdx);
var cmdLine = system.exec_dir + "ans2asc \"" + txtFileFilename + "\" \""
+ syncConvertedHdrFilename + "\"";
// Note: Both system.exec(cmdLine) and
// bbs.exec(cmdLine, EX_NATIVE, gStartupPath) could be used to
// execute the command, but system.exec() seems noticeably faster.
system.exec(cmdLine);
}
else
syncConvertedHdrFilename = txtFileFilename;
}
}
/*
// If the header file is ANSI, then convert it to Synchronet attribute
// codes and read that file instead. This is done so that this script can
// accurately get the file line lengths using console.strlen().
var syncConvertedHdrFilename = txtFilenameFullPath + "_converted.asc";
if (!file_exists(syncConvertedHdrFilename))
{
if (getStrAfterPeriod(txtFileFilename).toUpperCase() == "ANS")
{
var filenameBase = txtFileFilename.substr(0, dotIdx);
var cmdLine = system.exec_dir + "ans2asc \"" + txtFileFilename + "\" \""
+ syncConvertedHdrFilename + "\"";
// Note: Both system.exec(cmdLine) and
// bbs.exec(cmdLine, EX_NATIVE, gStartupPath) could be used to
// execute the command, but system.exec() seems noticeably faster.
system.exec(cmdLine);
}
else
syncConvertedHdrFilename = txtFileFilename;
}
*/
// Read the header file into txtFileLines
var hdrFile = new File(syncConvertedHdrFilename);
if (hdrFile.open("r"))
{
var fileLine = null;
while (!hdrFile.eof)
{
// Read the next line from the header file.
fileLine = hdrFile.readln(2048);
// fileLine should be a string, but I've seen some cases
// where it isn't, so check its type.
if (typeof(fileLine) != "string")
continue;
// Make sure the line isn't longer than the user's terminal
//if (fileLine.length > console.screen_columns)
// fileLine = fileLine.substr(0, console.screen_columns);
txtFileLines.push(fileLine);
// If the header array now has the maximum number of lines, then
// stop reading the header file.
if (txtFileLines.length == maxNumLines)
break;
}
hdrFile.close();
}
}
return txtFileLines;
}
// Returns the portion (if any) of a string after the period.
//
// Parameters:
// pStr: The string to extract from
//
// Return value: The portion of the string after the dot, if there is one. If
// not, then an empty string will be returned.
function getStrAfterPeriod(pStr)
{
var strAfterPeriod = "";
var dotIdx = pStr.lastIndexOf(".");
if (dotIdx > -1)
strAfterPeriod = pStr.substr(dotIdx+1);
return strAfterPeriod;
}
// Adjusts a message's when-written time to the BBS's local time.
//
// Parameters:
// pMsgHdr: A message header object
//
// Return value: The message's when_written_time adjusted to the BBS's local time.
// If the message header doesn't have a when_written_time or
// when_written_zone property, then this function will return -1.
function msgWrittenTimeToLocalBBSTime(pMsgHdr)
{
if (!pMsgHdr.hasOwnProperty("when_written_time") || !pMsgHdr.hasOwnProperty("when_written_zone_offset") || !pMsgHdr.hasOwnProperty("when_imported_zone_offset"))
return -1;
var timeZoneDiffMinutes = pMsgHdr.when_imported_zone_offset - pMsgHdr.when_written_zone_offset;
//var timeZoneDiffMinutes = pMsgHdr.when_written_zone - system.timezone;
var timeZoneDiffSeconds = timeZoneDiffMinutes * 60;
var msgWrittenTimeAdjusted = pMsgHdr.when_written_time + timeZoneDiffSeconds;
return msgWrittenTimeAdjusted;
}
// Returns an object containing bare minimum properties necessary to
// display an invalid message header. Additionally, an object returned
// by this function will have an extra property, isBogus, that will be
// a boolean set to true.
//
// Parameters:
// pSubject: Optional - A string to use as the subject in the bogus message
// header object
function getBogusMsgHdr(pSubject)
{
var msgHdr = {
subject: (typeof(pSubject) == "string" ? pSubject : ""),
when_imported_time: 0,
when_written_time: 0,
when_written_zone: 0,
date: "Fri, 1 Jan 1960 00:00:00 -0000",
attr: 0,
to: "Nobody",
from: "Nobody",
number: 0,
offset: 0,
isBogus: true
};
return msgHdr;
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
}
// Returns whether a message is readable to the user, based on its
// header and the sub-board code.
//
// Parameters:
// pMsgHdr: The header object for the message
// pSubBoardCode: The internal code for the sub-board the message is in
//
// Return value: Boolean - Whether or not the message is readable for the user
function isReadableMsgHdr(pMsgHdr, pSubBoardCode)
{
if (pMsgHdr === null)
return false;
// Let the sysop see unvalidated messages and private messages but not other users.
if (gIsSysop)
{
if (pSubBoardCode != "mail")
{
if ((msg_area.sub[pSubBoardCode].is_moderated && ((pMsgHdr.attr & MSG_VALIDATED) == 0)) ||
(((pMsgHdr.attr & MSG_PRIVATE) == MSG_PRIVATE) && !userHandleAliasNameMatch(pMsgHdr.to)))
{
return false;
}
}
}
// If the message is deleted, determine whether it should be viewable, based
// on the system settings.
if ((pMsgHdr.attr & MSG_DELETE) == MSG_DELETE)
{
// If the user is a sysop, check whether sysops can view deleted messages.
// Otherwise, check whether users can view deleted messages.
if (gIsSysop)
{
if ((system.settings & SYS_SYSVDELM) == 0)
return false;
}
else
{
if ((system.settings & SYS_USRVDELM) == 0)
return false;
}
}
// The message voting and poll variables were added in sbbsdefs.js for
// Synchronet 3.17. Make sure they're defined before referencing them.
if (typeof(MSG_UPVOTE) != "undefined")
{
if ((pMsgHdr.attr & MSG_UPVOTE) == MSG_UPVOTE)
return false;
}
if (typeof(MSG_DOWNVOTE) != "undefined")
{
if ((pMsgHdr.attr & MSG_DOWNVOTE) == MSG_DOWNVOTE)
return false;
}
// Don't include polls as being unreadable messages - They just need to have
// their answer selections read from the header instead of the message body
/*
if (typeof(MSG_POLL) != "undefined")
{
if ((pMsgHdr.attr & MSG_POLL) == MSG_POLL)
return false;
}
*/
return true;
}
// Returns the number of readable messages in a sub-board.
//
// Parameters:
// pMsgbase: The MsgBase object representing the sub-board
// pSubBoardCode: The internal code of the sub-board
//
// Return value: The number of readable messages in the sub-board
function numReadableMsgs(pMsgbase, pSubBoardCode)
{
if ((pMsgbase === null) || !pMsgbase.is_open)
return 0;
var numMsgs = 0;
if (typeof(pMsgbase.get_all_msg_headers) === "function")
{
var msgHdrs = pMsgbase.get_all_msg_headers(true);
for (var msgHdrsProp in msgHdrs)
{
if (msgHdrs[msgHdrsProp] == null)
continue;
else if (isReadableMsgHdr(msgHdrs[msgHdrsProp], pSubBoardCode))
++numMsgs;
}
}
else
{
var msgHeader;
for (var i = 0; i < pMsgbase.total_msgs; ++i)
{
msgHeader = msgBase.get_msg_header(true, i, false);
if (msgHeader == null)
continue;
else if (isReadableMsgHdr(msgHeader, pSubBoardCode))
++numMsgs;
}
}
return numMsgs;

nightfox
committed
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
}
// Returns whether a given name matches the logged-in user's handle, alias, or
// name.
//
// Parameters:
// pName: A name to match against the logged-in user
//
// Return value: Boolean - Whether or not the given name matches the logged-in
// user's handle, alias, or name
function userHandleAliasNameMatch(pName)
{
if (typeof(pName) != "string")
return false;
var userMatch = false;
var nameUpper = pName.toUpperCase();
if (user.handle.length > 0)
userMatch = (nameUpper.indexOf(user.handle.toUpperCase()) > -1);
if (!userMatch && (user.alias.length > 0))
userMatch = (nameUpper.indexOf(user.alias.toUpperCase()) > -1);
if (!userMatch && (user.name.length > 0))
userMatch = (nameUpper.indexOf(user.name.toUpperCase()) > -1);
return userMatch;
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
}
// Gets a sub-board's group and sub-board indexes with a given sub-board code.
//
// Parameters:
// pSubBoardCode: The internal code of the sub-board
// pDefaultToZero: Whether or not to default the indexes to 0 instead of -1
//
// Return value: An object containing the following values:
// grpIdx: The sub-board's group index. Will be -1 if the sub-board code is invalid.
// subIdx: The sub-board index. Will be -1 if the sub-board code is invalid.
function getGrpAndSubIdxesFromCode(pSubBoardCode, pDefaultToZero)
{
var retVal = {
grpIdx: (pDefaultToZero ? 0 : -1),
subIdx: (pDefaultToZero ? 0 : -1)
};
if ((typeof(pSubBoardCode) == "string") && (pSubBoardCode != ""))
{
retVal.grpIdx = msg_area.sub[pSubBoardCode].grp_index;
retVal.subIdx = msg_area.sub[pSubBoardCode].index;
}
return retVal;
}
// Inputs a string from the user, with a timeout
//
// Parameters:
// pMode: The mode bits to use for the input (i.e., defined in sbbsdefs.js)
// pMaxLength: The maximum length of the string (0 or less for no limit)
// pTimeout: The timeout (in milliseconds). When the timeout is reached,
// input stops and the user's input is returned.
//
// Return value: The user's input (string)
function getStrWithTimeout(pMode, pMaxLength, pTimeout)
{
var inputStr = "";
var mode = K_NONE;
Eric Oulashin
committed
if (typeof(pMode) === "number")
mode = pMode;
var maxWidth = 0;
Eric Oulashin
committed
if (typeof(pMaxLength) === "number")
maxWidth = pMaxLength;
var timeout = 0;
Eric Oulashin
committed
if (typeof(pTimeout) === "number")
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
timeout = pTimeout;
var setNormalAttrAtEnd = false;
if (((mode & K_LINE) == K_LINE) && (maxWidth > 0) && console.term_supports(USER_ANSI))
{
var curPos = console.getxy();
printf("\1n\1w\1h\1" + "4%" + maxWidth + "s", "");
console.gotoxy(curPos);
setNormalAttrAtEnd = true;
}
var curPos = console.getxy();
var userKey = "";
do
{
userKey = console.inkey(mode, timeout);
if ((userKey.length > 0) && isPrintableChar(userKey))
{
var allowAppendChar = true;
if ((maxWidth > 0) && (inputStr.length >= maxWidth))
allowAppendChar = false;
if (allowAppendChar)
{
inputStr += userKey;
console.print(userKey);
++curPos.x;
}
}
else if (userKey == BACKSPACE)
{
if (inputStr.length > 0)
{
inputStr = inputStr.substr(0, inputStr.length-1);
console.gotoxy(curPos.x-1, curPos.y);
console.print(" ");
console.gotoxy(curPos.x-1, curPos.y);
--curPos.x;
}
}
else if (userKey == KEY_ENTER)
userKey = "";
} while(userKey.length > 0);
if (setNormalAttrAtEnd)
console.print("\1n");
return inputStr;
}
// Returns whether or not a character is printable.
function isPrintableChar(pText)
{
// Make sure pText is valid and is a string.
if (typeof(pText) != "string")
return false;
if (pText.length == 0)
return false;
// Make sure the character is a printable ASCII character in the range of 32 to 254,
// except for 127 (delete).
var charCode = pText.charCodeAt(0);
return ((charCode > 31) && (charCode < 255) && (charCode != 127));
}
// Finds the page number of an item, given some text to search for in the item.
//
// Parameters:
// pText: The text to search for in the items
// pNumItemsPerPage: The number of items per page
// pSubBoard: Boolean - If true, search the sub-board list for the given group index.
// If false, search the group list.
// pStartItemIdx: The item index to start at
// pGrpIdx: The index of the group to search in (only for doing a sub-board search)
//
// Return value: An object containing the following properties:
// pageNum: The page number of the item (1-based; will be 0 if not found)
// pageTopIdx: The index of the top item on the page (or -1 if not found)
// itemIdx: The index of the item (or -1 if not found)
function getPageNumFromSearch(pText, pNumItemsPerPage, pSubBoard, pStartItemIdx, pGrpIdx)
{
var retObj = {
pageNum: 0,
pageTopIdx: -1,
itemIdx: -1
};
// Sanity checking
Eric Oulashin
committed
if ((typeof(pText) != "string") || (typeof(pNumItemsPerPage) !== "number") || (typeof(pSubBoard) != "boolean"))
return retObj;
// Convert the text to uppercase for case-insensitive searching
var srchText = pText.toUpperCase();
if (pSubBoard)
{
Eric Oulashin
committed
if ((typeof(pGrpIdx) === "number") && (pGrpIdx >= 0) && (pGrpIdx < msg_area.grp_list.length))
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
{
// Go through the sub-board list of the given group and
// search for text in the descriptions
for (var i = pStartItemIdx; i < msg_area.grp_list[pGrpIdx].sub_list.length; ++i)
{
if ((msg_area.grp_list[pGrpIdx].sub_list[i].description.toUpperCase().indexOf(srchText) > -1) ||
(msg_area.grp_list[pGrpIdx].sub_list[i].name.toUpperCase().indexOf(srchText) > -1))
{
retObj.itemIdx = i;
// Figure out the page number and top index for the page
var pageObj = calcPageNumAndTopPageIdx(i, pNumItemsPerPage);
if ((pageObj.pageNum > 0) && (pageObj.pageTopIdx > -1))
{
retObj.pageNum = pageObj.pageNum;
retObj.pageTopIdx = pageObj.pageTopIdx;
}
break;
}
}
}
}
else
{
// Go through the message group list and look for a match
for (var i = pStartItemIdx; i < msg_area.grp_list.length; ++i)
{
if ((msg_area.grp_list[i].name.toUpperCase().indexOf(srchText) > -1) ||
(msg_area.grp_list[i].description.toUpperCase().indexOf(srchText) > -1))
{
retObj.itemIdx = i;
// Figure out the page number and top index for the page
var pageObj = calcPageNumAndTopPageIdx(i, pNumItemsPerPage);
if ((pageObj.pageNum > 0) && (pageObj.pageTopIdx > -1))
{
retObj.pageNum = pageObj.pageNum;
retObj.pageTopIdx = pageObj.pageTopIdx;
}
break;
}
}
}
return retObj;
}
// Calculates the page number (1-based) and top index for the page (0-based),
// given an item index.
//
// Parameters:
// pItemIdx: The index of the item
// pNumItemsPerPage: The number of items per page
//
// Return value: An object containing the following properties:
// pageNum: The page number of the item (1-based; will be 0 if not found)
// pageTopIdx: The index of the top item on the page (or -1 if not found)
function calcPageNumAndTopPageIdx(pItemIdx, pNumItemsPerPage)
{
var retObj = {
pageNum: 0,
pageTopIdx: -1
};
var pageNum = 1;
var topIdx = 0;
var continueOn = true;
do
{
var endIdx = topIdx + pNumItemsPerPage;
if ((pItemIdx >= topIdx) && (pItemIdx < endIdx))
{
continueOn = false;
retObj.pageNum = pageNum;
retObj.pageTopIdx = topIdx;
}
else
{
++pageNum;
topIdx = endIdx;
}
} while (continueOn);
return retObj;
}
// Gets the header of the latest readable message in a sub-board,
// given a number of messages to look at.
//
// Paramters:
// pSubCode: The internal code of the message sub-board
// pNumMsgsToCheck: The number of messages to check at the end of the sub-board.
// This is optional and if omitted, all messages will be
// checked (from the last message) for the latest readable
// message header.
//
// Return value: The message header of the latest readable message. If
// none is found, this will be null.
function getLatestMsgHdr(pSubCode, pNumMsgsToCheck)
{
var msgHdr = null;
var msgBase = new MsgBase(pSubCode);
if (msgBase.open())
{
Eric Oulashin
committed
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
msgHdr = getLatestMsgHdrWithMsgbase(msgBase, pNumMsgsToCheck);
msgBase.close();
}
delete msgBase; // Free some memory?
return msgHdr;
}
// Gets the header of the latest readable message in a sub-board,
// given a number of messages to look at.
//
// Paramters:
// pMsgbase: A MsgBase object for the sub-board, already opened
// pNumMsgsToCheck: The number of messages to check at the end of the sub-board.
// This is optional and if omitted, all messages will be
// checked (from the last message) for the latest readable
// message header.
//
// Return value: The message header of the latest readable message. If
// none is found, this will be null.
function getLatestMsgHdrWithMsgbase(pMsgbase, pNumMsgsToCheck)
{
if (typeof(pMsgbase) !== "object")
return null;
if (!pMsgbase.is_open)
return null;
var msgHdr = null;
var numMsgsToCheck = (typeof(pNumMsgsToCheck) === "number" ? pNumMsgsToCheck : 0);
// Look through the last numMsgsToCheck headers to find the latest
// readable message header
var numMsgs = pMsgbase.total_msgs;
var firstMsgIdx = 0;
if (numMsgsToCheck >= 1)
firstMsgIdx = numMsgs - numMsgsToCheck;
else
firstMsgIdx = 0;
if (firstMsgIdx < 0)
firstMsgIdx = 0;
for (var i = numMsgs - 1; (i >= firstMsgIdx) && (msgHdr == null); --i)
{
var msgHeader = pMsgbase.get_msg_header(true, i, true);
if (isReadableMsgHdr(msgHeader, pMsgbase.cfg.code))
msgHdr = msgHeader;
}
return msgHdr;
}
// Gets the time of the latest post in a sub-board.
//
// Parameters:
// pSubCode: The internal code of the sub-board
//
// Return value: The time of the latest post in the sub-board. If pSubCode is invalid, this will be 0.
function getLatestMsgTime(pSubCode)
{
if (typeof(pSubCode) !== "string")
return 0;
var latestPostTime = 0;
var numMsgs = 0;
var msgBase = new MsgBase(pSubCode);
if (msgBase.open())
{
Eric Oulashin
committed
if (gUseNumReadableMessagesForMsgCount)
numMsgs = numReadableMsgs(msgBase, pSubCode);
else
numMsgs = msgBase.total_msgs;
Eric Oulashin
committed
msgBase.close();
}
delete msgBase; // Free some memory?
if (numMsgs > 0)
{
// Get the latest post time from this sub-board & compare it to retObj.newestTime and
// set if necessary
var msgHeader = getLatestMsgHdr(pSubCode);
if (msgHeader === null)
msgHeader = getBogusMsgHdr();
if (this.showImportDates)
latestPostTime = msgHeader.when_imported_time;
else
{
Eric Oulashin
committed
var msgWrittenLocalBBSTime = msgWrittenTimeToLocalBBSTime(msgHeader);
latestPostTime = msgWrittenLocalBBSTime != -1 ? msgWrittenLocalBBSTime : msgHeader.when_written_time;
}
}
Eric Oulashin
committed
return latestPostTime;
}
// Finds a message group index with search text, matching either the name or
// description, case-insensitive.
//
// Parameters:
// pSearchText: The name/description text to look for
// pStartItemIdx: The item index to start at. Defaults to 0
//
// Return value: The index of the message group, or -1 if not found
Eric Oulashin
committed
function DDMsgAreaChooser_FindMsgGrpIdxFromText(pSearchText, pStartItemIdx)
{
if (typeof(pSearchText) != "string")
return -1;
var grpIdx = -1;
Eric Oulashin
committed
var startIdx = (typeof(pStartItemIdx) === "number" ? pStartItemIdx : 0);
if (this.useSubCollapsing)
{
if ((startIdx < 0) || (startIdx > this.group_list.length))
startIdx = 0;
}
else
{
if ((startIdx < 0) || (startIdx > msg_area.grp_list.length))
startIdx = 0;
}
// Go through the message group list and look for a match
var searchTextUpper = pSearchText.toUpperCase();
Eric Oulashin
committed
if (this.useSubCollapsing)
{
Eric Oulashin
committed
for (var i = startIdx; i < this.group_list.length; ++i)
{
Eric Oulashin
committed
if ((this.group_list[i].name.toUpperCase().indexOf(searchTextUpper) > -1) ||
(this.group_list[i].description.toUpperCase().indexOf(searchTextUpper) > -1))
{
grpIdx = i;
break;
}
}
}
else
{
for (var i = startIdx; i < msg_area.grp_list.length; ++i)
{
if ((msg_area.grp_list[i].name.toUpperCase().indexOf(searchTextUpper) > -1) ||
(msg_area.grp_list[i].description.toUpperCase().indexOf(searchTextUpper) > -1))
{
grpIdx = i;
break;
}
}
}
return grpIdx;
}
// For the DDMsgAreaChooser class: Finds a message group index with search text, matching either the name or
// description, case-insensitive.
//
// Parameters:
// pGrpIdx: The index of the message group
Eric Oulashin
committed
// pSubIdx: Optional - The index of the sub-board, for sub-board name collapsing.
// If this is null, then sub-board collapsing won't be used.
// pSearchText: The name/description text to look for
// pStartItemIdx: The item index to start at. Defaults to 0
//
// Return value: The index of the sub-board, or -1 if not found
Eric Oulashin
committed
function DDMsgAreaChooser_FindSubBoardIdxFromText(pGrpIdx, pSubIdx, pSearchText, pStartItemIdx)
{
Eric Oulashin
committed
if (typeof(pGrpIdx) !== "number")
return -1;
if (typeof(pSearchText) != "string")
return -1;
var subBoardIdx = -1;
Eric Oulashin
committed
var startIdx = (typeof(pStartItemIdx) === "number" ? pStartItemIdx : 0);
if (this.useSubCollapsing)
{
if (typeof(pSubIdx) === "number")
{
if ((startIdx < 0) || (startIdx > this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list.length))
startIdx = 0;
}
else
{
if ((startIdx < 0) || (startIdx > this.group_list[pGrpIdx].sub_list.length))
startIdx = 0;
}
}
else
{
if ((startIdx < 0) || (startIdx > msg_area.grp_list[pGrpIdx].sub_list.length))
startIdx = 0;
}
Eric Oulashin
committed
// Go through the message sub-board list in the group (or sub-subboard list in the sub-board)
// and look for a match
var searchTextUpper = pSearchText.toUpperCase();
Eric Oulashin
committed
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
if (this.useSubCollapsing)
{
if (typeof(pSubIdx) === "number")
{
// Look through the sub-subboards of the sub-board
for (var i = startIdx; i < this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list.length; ++i)
{
// For the sub-subboards, there is only a description, no name
if (this.group_list[pGrpIdx].sub_list[pSubIdx].sub_subboard_list[i].description.toUpperCase().indexOf(searchTextUpper) > -1)
{
subBoardIdx = i;
break;
}
}
}
else
{
// Look through the sub-boards in the group
for (var i = startIdx; i < this.group_list[pGrpIdx].sub_list.length; ++i)
{
if ((this.group_list[pGrpIdx].sub_list[i].name.toUpperCase().indexOf(searchTextUpper) > -1) ||
(this.group_list[pGrpIdx].sub_list[i].description.toUpperCase().indexOf(searchTextUpper) > -1))
{
subBoardIdx = i;
break;
}
}
}
}
else
{
Eric Oulashin
committed
for (var i = startIdx; i < msg_area.grp_list[pGrpIdx].sub_list.length; ++i)
{
Eric Oulashin
committed
if ((msg_area.grp_list[pGrpIdx].sub_list[i].name.toUpperCase().indexOf(searchTextUpper) > -1) ||
(msg_area.grp_list[pGrpIdx].sub_list[i].description.toUpperCase().indexOf(searchTextUpper) > -1))
{
subBoardIdx = i;
break;
}
}
}
return subBoardIdx;
}
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
// For the DDMsgAreaChooser class: Gets the lengths for the sub-board column and # of messages
// column for a sub-board. Gets defaults if that information isn't available.
//
// Parameters:
// pGrpIdx: The message group index
//
// Return value: An object containing the following properties:
// nameLen: The name field lengh
// numMsgsLen: The # messages field length
function DDMsgAreaChooser_GetSubNameLenAndNumMsgsLen(pGrpIdx)
{
var retObj = {
nameLen: console.screen_columns - this.areaNumLen - this.numItemsLen - 5,
numMsgsLen: this.numItemsLen
};
if (typeof(pGrpIdx) === "number" && pGrpIdx >= 0 && pGrpIdx < msg_area.grp_list.length)
{
if (typeof(this.subBoardListPrintfInfo[pGrpIdx]) === "object")
{
if (this.subBoardListPrintfInfo[pGrpIdx].hasOwnProperty("nameLen"))
retObj.nameLen = +(this.subBoardListPrintfInfo[pGrpIdx].nameLen);
if (this.subBoardListPrintfInfo[pGrpIdx].hasOwnProperty("numMsgsLen"))
retObj.numMsgsLen = +(this.subBoardListPrintfInfo[pGrpIdx].numMsgsLen);
}
}
return retObj;
}