Skip to content
Snippets Groups Projects
Commit f752e485 authored by nightfox's avatar nightfox
Browse files

Version 1.10 beta: 

- Added a new configuration option, postOnSubBoardInsteadOfGoToNext, that affects what happens after the user reads the last message on a sub-board: If this is set to true, then the reader will prompt the user if they want to post on the sub-board, then exit (this is the stock Synchronet behavior).  If this is set to false, then the reader will prompt the user whether to go to the next sub-board after reading the last message on a sub-board.  Also, added the postOnSubBoard text configuration parameter for the theme filename, which specifies the text to use for prompting the user if they want to post on the sub-board after reading the last message.
- Added new configuration options areaChooserHdrFilenameBase and areaChooserHdrMaxLines.  These options specify the filename base for a header file to use for the message area chooser list and the maximum number of lines to use from the area chooser header file.  The filaname is without the extension - The reader will first look for an .ans version, then an .asc version.  Additionally, multiple header files can be used for different terminal widths - For example, chooserMsgHdr-80.ans for an 80-column terminal, choosrMsgHdr-140.ans for a 140-column terminal, etc.
parent 7da8280c
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
xtrn/DDMsgReader/DDMsgReader.cfg
+ 6
− 0
View file @ f752e485
...@@ -23,6 +23,12 @@ startMode=Reader ...@@ -23,6 +23,12 @@ startMode=Reader
tabSpaces=3 tabSpaces=3
; Whether or not to pause at the end of a newscan ; Whether or not to pause at the end of a newscan
pauseAfterNewMsgScan=true pauseAfterNewMsgScan=true
; Whether or not to ask the user whether to post on the sub-board in reader
; mode after reading the last message instead of prompting to go to the next
; sub-board. This is like the stock Synchronet behavior.
postOnSubBoardInsteadOfGoToNext=false
areaChooserHdrFilenameBase=areaChgHeader
areaChooserHdrMaxLines=5
; The theme file name (for colors, strings, etc.) ; The theme file name (for colors, strings, etc.)
themeFilename=DefaultTheme.cfg themeFilename=DefaultTheme.cfg
\ No newline at end of file
xtrn/DDMsgReader/DDMsgReader.js
+ 556
− 369
View file @ f752e485
...@@ -117,6 +117,12 @@ ...@@ -117,6 +117,12 @@
* not center the enhanced reader header lines horizontally. * not center the enhanced reader header lines horizontally.
* Now, it displays it in column 1. This was done to fix * Now, it displays it in column 1. This was done to fix
* a display issue in some terminal software. * a display issue in some terminal software.
* 2016-02-05 Eric Oulashin Version 1.10 beta
* Added the ability to prompt the user to post a message
* on a sub-board and quit after reading the last message
* in a sub-board rather than going to the next sub-board.
* 2016-02-06 Eric Oulashin Started working on the ability to display a custom header
* above the message area chooser lists.
*/ */
   
/* Command-line arguments (in -arg=val format, or -arg format to enable an /* Command-line arguments (in -arg=val format, or -arg format to enable an
...@@ -208,8 +214,8 @@ if (system.version_num < 31500) ...@@ -208,8 +214,8 @@ if (system.version_num < 31500)
} }
   
// Reader version information // Reader version information
var READER_VERSION = "1.09"; var READER_VERSION = "1.10 Beta";
var READER_DATE = "2016-01-15"; var READER_DATE = "2016-02-06";
   
// Keyboard key codes for displaying on the screen // Keyboard key codes for displaying on the screen
var UP_ARROW = ascii(24); var UP_ARROW = ascii(24);
...@@ -645,8 +651,8 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs) ...@@ -645,8 +651,8 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs)
// startMode specifies the mode for the reader to start in - List mode // startMode specifies the mode for the reader to start in - List mode
// or reader mode, etc. This is a setting that is read from the configuration // or reader mode, etc. This is a setting that is read from the configuration
// file. The configuration file can be either READER_MODE_READ or // file. The configuration file can be either READER_MODE_READ or
// READER_MODE_LIST, but the optional "mode" parameter in pArgv can specify // READER_MODE_LIST, but the optional "mode" parameter in the command-line
// another mode. // arguments can specify another mode.
this.startMode = READER_MODE_LIST; this.startMode = READER_MODE_LIST;
   
// msgSearchHdrs is an object containing message headers found via searching. // msgSearchHdrs is an object containing message headers found via searching.
...@@ -698,6 +704,11 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs) ...@@ -698,6 +704,11 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs)
this.promptToContinueListingMessages = false; this.promptToContinueListingMessages = false;
// Whether or not to prompt the user to confirm to read a message // Whether or not to prompt the user to confirm to read a message
this.promptToReadMessage = false; this.promptToReadMessage = false;
// For enhanced reader mode: Whether or not to ask the user whether to post
// on the sub-board in reader mode after reading the last message instead of
// prompting to go to the next sub-board. This is like the stock Synchronet
// behavior.
this.postOnSubBoardInsteadOfGoToNext = false;
   
// String lengths for the columns to write // String lengths for the columns to write
// Fixed field widths: Message number, date, and time // Fixed field widths: Message number, date, and time
...@@ -793,6 +804,7 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs) ...@@ -793,6 +804,7 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs)
this.text.cannotDeleteAllSelectedMsgsText = "\1n\1y\1h* Cannot delete all selected messages"; this.text.cannotDeleteAllSelectedMsgsText = "\1n\1y\1h* Cannot delete all selected messages";
this.text.msgEditConfirmText = "\1n\1cEdit message #\1h%d\1n\1c: Are you sure"; this.text.msgEditConfirmText = "\1n\1cEdit message #\1h%d\1n\1c: Are you sure";
this.text.noPersonalEmailText = "\1n\1cYou have no messages."; this.text.noPersonalEmailText = "\1n\1cYou have no messages.";
this.text.postOnSubBoard = "\1n\1gPost on %s %s";
   
// Set the methods for the object // Set the methods for the object
this.RefreshSearchResultMsgHdr = DigDistMsgReader_RefreshSearchResultMsgHdr; // Refreshes a message header in the search results this.RefreshSearchResultMsgHdr = DigDistMsgReader_RefreshSearchResultMsgHdr; // Refreshes a message header in the search results
...@@ -853,6 +865,7 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs) ...@@ -853,6 +865,7 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs)
this.DoPrivateReply = DigDistMsgReader_DoPrivateReply; this.DoPrivateReply = DigDistMsgReader_DoPrivateReply;
this.DisplayEnhancedReaderHelp = DigDistMsgReader_DisplayEnhancedReaderHelp; this.DisplayEnhancedReaderHelp = DigDistMsgReader_DisplayEnhancedReaderHelp;
this.DisplayEnhancedMsgHdr = DigDistMsgReader_DisplayEnhancedMsgHdr; this.DisplayEnhancedMsgHdr = DigDistMsgReader_DisplayEnhancedMsgHdr;
this.DisplayAreaChgHdr = DigDistMsgReader_DisplayAreaChgHdr;
this.DisplayEnhancedReaderWholeScrollbar = DigDistMsgReader_DisplayEnhancedReaderWholeScrollbar; this.DisplayEnhancedReaderWholeScrollbar = DigDistMsgReader_DisplayEnhancedReaderWholeScrollbar;
this.UpdateEnhancedReaderScollbar = DigDistMsgReader_UpdateEnhancedReaderScollbar; this.UpdateEnhancedReaderScollbar = DigDistMsgReader_UpdateEnhancedReaderScollbar;
this.MessageIsDeleted = DigDistMsgReader_MessageIsDeleted; this.MessageIsDeleted = DigDistMsgReader_MessageIsDeleted;
...@@ -890,6 +903,11 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs) ...@@ -890,6 +903,11 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs)
// Whether or not to pause (with a message) after doing a new message scan // Whether or not to pause (with a message) after doing a new message scan
this.pauseAfterNewMsgScan = true; this.pauseAfterNewMsgScan = true;
   
// For the message area chooser header filename & maximum number of
// area chooser header lines to display
this.areaChooserHdrFilenameBase = "areaChgHeader";
this.areaChooserHdrMaxLines = 5;
this.cfgFilename = "DDMsgReader.cfg"; this.cfgFilename = "DDMsgReader.cfg";
// Check the command-line arguments for a custom configuration file name // Check the command-line arguments for a custom configuration file name
// before reading the configuration file. // before reading the configuration file.
...@@ -1137,7 +1155,7 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs) ...@@ -1137,7 +1155,7 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs)
if (hdrFile.open("r")) if (hdrFile.open("r"))
{ {
var fileLine = null; var fileLine = null;
while (!hdrFile.eof && (this.enhMsgHeaderLines.length <= 10)) while (!hdrFile.eof)
{ {
// Read the next line from the header file. // Read the next line from the header file.
fileLine = hdrFile.readln(2048); fileLine = hdrFile.readln(2048);
...@@ -1150,7 +1168,13 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs) ...@@ -1150,7 +1168,13 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs)
//if (fileLine.length > console.screen_columns) //if (fileLine.length > console.screen_columns)
// fileLine = fileLine.substr(0, console.screen_columns); // fileLine = fileLine.substr(0, console.screen_columns);
this.enhMsgHeaderLines.push(fileLine); this.enhMsgHeaderLines.push(fileLine);
// If the header now has the maximum number of lines, then
// stop reading the header file.
if (this.enhMsgHeaderLines.length == 10)
break;
} }
hdrFile.close();
} }
} }
// Save the enhanced reader header width. This will be the length of the longest // Save the enhanced reader header width. This will be the length of the longest
...@@ -1320,6 +1344,84 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs) ...@@ -1320,6 +1344,84 @@ function DigDistMsgReader(pSubBoardCode, pScriptArgs)
// sub-boards. Messages can be selected by the user for doing things such // sub-boards. Messages can be selected by the user for doing things such
// as a batch delete, etc. // as a batch delete, etc.
this.selectedMessages = new Object(); this.selectedMessages = new Object();
// areaChangeHdrLines is an array of text lines to use as a header to display
// above the message area changer lists.
this.areaChangeHdrLines = 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 areaChgHdrFileExists = true;
var areaChgHdrFilenameBaseFullPath = gStartupPath + this.areaChooserHdrFilenameBase;
var areaChgHdrFilename = "";
if (file_exists(areaChgHdrFilenameBaseFullPath + "-" + console.screen_columns + ".ans"))
areaChgHdrFilename = areaChgHdrFilenameBaseFullPath + "-" + console.screen_columns + ".ans";
else if (file_exists(areaChgHdrFilenameBaseFullPath + "-" + console.screen_columns + ".asc"))
areaChgHdrFilename = areaChgHdrFilenameBaseFullPath + "-" + console.screen_columns + ".asc";
else if (file_exists(areaChgHdrFilenameBaseFullPath + ".ans"))
areaChgHdrFilename = areaChgHdrFilenameBaseFullPath + ".ans";
else if (file_exists(areaChgHdrFilenameBaseFullPath + ".asc"))
areaChgHdrFilename = areaChgHdrFilenameBaseFullPath + ".asc";
else
areaChgHdrFileExists = false;
if (areaChgHdrFileExists)
{
// 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 = areaChgHdrFilenameBaseFullPath + "_converted.asc";
if (!file_exists(syncConvertedHdrFilename))
{
var dotIdx = areaChgHdrFilename.lastIndexOf(".");
if (dotIdx > -1)
{
// If header file is ANSI, then convert it to Synchronet attribute
// format and save it as an .asc file. Otherwise, just use the
// header file without conversion since it's already ASCII or
// Synchronet attribute code format.
var isANSI = (areaChgHdrFilename.substr(dotIdx+1).toUpperCase() == "ANS");
if (isANSI)
{
var filenameBase = areaChgHdrFilename.substr(0, dotIdx);
var cmdLine = system.exec_dir + "ans2asc \"" + areaChgHdrFilename + "\" \""
+ 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 = areaChgHdrFilename;
}
}
// Read the header file into this.enhMsgHeaderLines
var hdrFile = new File(syncConvertedHdrFilename);
if (hdrFile.open("r"))
{
var fileLine = null;
//while (!hdrFile.eof && (this.areaChangeHdrLines.length <= this.areaChooserHdrMaxLines))
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);
this.areaChangeHdrLines.push(fileLine);
// If the header array now has the maximum number of lines, then
// stop reading the header file.
if (this.areaChangeHdrLines.length == this.areaChooserHdrMaxLines)
break;
}
hdrFile.close();
}
}
} }
   
// For the DigDistMsgReader class: Sets the subBoardCode property and also // For the DigDistMsgReader class: Sets the subBoardCode property and also
...@@ -4933,11 +5035,22 @@ function DigDistMsgReader_ReadMessageEnhanced(pOffset, pAllowChgArea) ...@@ -4933,11 +5035,22 @@ function DigDistMsgReader_ReadMessageEnhanced(pOffset, pAllowChgArea)
writeMessage = false; writeMessage = false;
else else
{ {
// TODO: Prompt the user if they want to post in the sub-board // If configured to allow the user to post in the sub-board
// (to mimic the Synchronet stock behavior). // instead of go on to the next message area, then do so.
if (this.postOnSubBoardInsteadOfGoToNext)
{
console.print("\1n");
console.crlf();
// Ask the user if they want to post on the sub-board.
// If they say yes, then do so before exiting.
if (!console.noyes(format(this.text.postOnSubBoard, this.msgbase.cfg.grp_name, this.msgbase.cfg.description)))
bbs.post_msg(this.subBoardCode);
continueOn = false;
retObj.nextAction = ACTION_QUIT;
}
else
{
// Prompt the user whether they want to go to the next message area // Prompt the user whether they want to go to the next message area
// TODO: Add an option to toggle this behavior
if (this.EnhReaderPromptYesNo(this.text.goToNextMsgAreaPromptText, msgInfo.messageLines, topMsgLineIdx, msgLineFormatStr, solidBlockStartRow, numSolidScrollBlocks)) if (this.EnhReaderPromptYesNo(this.text.goToNextMsgAreaPromptText, msgInfo.messageLines, topMsgLineIdx, msgLineFormatStr, solidBlockStartRow, numSolidScrollBlocks))
{ {
// Let this method exit and let the caller go to the next sub-board // Let this method exit and let the caller go to the next sub-board
...@@ -4948,6 +5061,7 @@ function DigDistMsgReader_ReadMessageEnhanced(pOffset, pAllowChgArea) ...@@ -4948,6 +5061,7 @@ function DigDistMsgReader_ReadMessageEnhanced(pOffset, pAllowChgArea)
writeMessage = false; // No need to refresh the message writeMessage = false; // No need to refresh the message
} }
} }
}
else else
{ {
// We're not at the end of the sub-board, so it's okay to exit this // We're not at the end of the sub-board, so it's okay to exit this
...@@ -5518,7 +5632,21 @@ function DigDistMsgReader_ReadMessageEnhanced(pOffset, pAllowChgArea) ...@@ -5518,7 +5632,21 @@ function DigDistMsgReader_ReadMessageEnhanced(pOffset, pAllowChgArea)
// user whether they want to continue onto the next message area. // user whether they want to continue onto the next message area.
if (retObj.newMsgOffset == -1 && !curMsgSubBoardIsLast()) if (retObj.newMsgOffset == -1 && !curMsgSubBoardIsLast())
{ {
console.print("\1n");
console.crlf(); console.crlf();
// If configured to allow the user to post in the sub-board
// instead of go on to the next message area, then do so.
if (this.postOnSubBoardInsteadOfGoToNext)
{
// Ask the user if they want to post on the sub-board.
// If they say yes, then do so before exiting.
if (!console.noyes(format(this.text.postOnSubBoard, this.msgbase.cfg.grp_name, this.msgbase.cfg.description)))
bbs.post_msg(this.subBoardCode);
continueOn = false;
retObj.nextAction = ACTION_QUIT;
}
else
{
if (console.yesno(this.text.goToNextMsgAreaPromptText)) if (console.yesno(this.text.goToNextMsgAreaPromptText))
{ {
// Let this method exit and let the caller go to the next sub-board // Let this method exit and let the caller go to the next sub-board
...@@ -5526,6 +5654,7 @@ function DigDistMsgReader_ReadMessageEnhanced(pOffset, pAllowChgArea) ...@@ -5526,6 +5654,7 @@ function DigDistMsgReader_ReadMessageEnhanced(pOffset, pAllowChgArea)
retObj.nextAction = ACTION_GO_NEXT_MSG; retObj.nextAction = ACTION_GO_NEXT_MSG;
} }
} }
}
else else
{ {
// We're not at the end of the sub-board, so it's okay to exit this // We're not at the end of the sub-board, so it's okay to exit this
...@@ -7094,6 +7223,16 @@ function DigDistMsgReader_ReadConfigFile() ...@@ -7094,6 +7223,16 @@ function DigDistMsgReader_ReadConfigFile()
} }
else if (settingUpper == "PAUSEAFTERNEWMSGSCAN") else if (settingUpper == "PAUSEAFTERNEWMSGSCAN")
this.pauseAfterNewMsgScan = (valueUpper == "TRUE"); this.pauseAfterNewMsgScan = (valueUpper == "TRUE");
else if (settingUpper == "POSTONSUBBOARDINSTEADOFGOTONEXT")
this.postOnSubBoardInsteadOfGoToNext = (valueUpper == "TRUE");
else if (settingUpper == "AREACHOOSERHDRFILENAMEBASE")
this.areaChooserHdrFilenameBase = value;
else if (settingUpper == "AREACHOOSERHDRMAXLINES")
{
var maxNumLines = +value;
if (maxNumLines > 0)
this.areaChooserHdrMaxLines = maxNumLines;
}
else if (settingUpper == "THEMEFILENAME") else if (settingUpper == "THEMEFILENAME")
{ {
// First look for the theme config file in the sbbs/mods // First look for the theme config file in the sbbs/mods
...@@ -7242,7 +7381,8 @@ function DigDistMsgReader_ReadConfigFile() ...@@ -7242,7 +7381,8 @@ function DigDistMsgReader_ReadConfigFile()
(setting == "cannotDeleteMsgText_notYoursNotASysop") || (setting == "cannotDeleteMsgText_notYoursNotASysop") ||
(setting == "cannotDeleteMsgText_notLastPostedMsg") || (setting == "cannotDeleteMsgText_notLastPostedMsg") ||
(setting == "msgEditConfirmText") || (setting == "msgEditConfirmText") ||
(setting == "noPersonalEmailText")) (setting == "noPersonalEmailText") ||
(setting == "postOnSubBoard"))
{ {
// Replace any instances of "\1" with the Synchronet // Replace any instances of "\1" with the Synchronet
// attribute control character // attribute control character
...@@ -8847,6 +8987,48 @@ function DigDistMsgReader_DisplayEnhancedMsgHdr(pMsgHdr, pDisplayMsgNum, pStartS ...@@ -8847,6 +8987,48 @@ function DigDistMsgReader_DisplayEnhancedMsgHdr(pMsgHdr, pDisplayMsgNum, pStartS
} }
} }
   
// For the DigDistMsgReader 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.
function DigDistMsgReader_DisplayAreaChgHdr(pStartScreenRow)
{
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.
if (console.term_supports(USER_ANSI) && (typeof(pStartScreenRow) == "number"))
{
// Display the header starting on the first column and the given screen row.
var screenX = 1;
var 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");
}
}
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");
console.crlf();
}
}
}
// For the DigDistMsgReader class: Displays the whole/initial scrollbar for a message // For the DigDistMsgReader class: Displays the whole/initial scrollbar for a message
// in enhanced reader mode. // in enhanced reader mode.
// //
...@@ -9597,7 +9779,8 @@ function DigDistMsgReader_SelectMsgArea_Lightbar() ...@@ -9597,7 +9779,8 @@ function DigDistMsgReader_SelectMsgArea_Lightbar()
selectedGrpIndex = bbs.curgrp; selectedGrpIndex = bbs.curgrp;
*/ */
   
var listStartRow = 2; // The row on the screen where the list will start // listStartRow is the row on the screen where the list will start
var listStartRow = 2 + this.areaChangeHdrLines.length;
var listEndRow = console.screen_rows - 1; // Row on screen where list will end var listEndRow = console.screen_rows - 1; // Row on screen where list will end
var topMsgGrpIndex = 0; // The index of the message group at the top of the list var topMsgGrpIndex = 0; // The index of the message group at the top of the list
   
...@@ -9640,9 +9823,10 @@ function DigDistMsgReader_SelectMsgArea_Lightbar() ...@@ -9640,9 +9823,10 @@ function DigDistMsgReader_SelectMsgArea_Lightbar()
} }
} }
   
// Clear the screen, write the help line and group list header, and output // Clear the screen, write the header lines, help line and group list header,
// a screenful of message groups. // and output a screenful of message groups.
console.clear("\1n"); console.clear("\1n");
this.DisplayAreaChgHdr(1);
this.WriteChgMsgAreaKeysHelpLine(); this.WriteChgMsgAreaKeysHelpLine();
   
// Make a backup of the current message group & sub-board indexes so // Make a backup of the current message group & sub-board indexes so
...@@ -9658,7 +9842,7 @@ function DigDistMsgReader_SelectMsgArea_Lightbar() ...@@ -9658,7 +9842,7 @@ function DigDistMsgReader_SelectMsgArea_Lightbar()
// Input loop - Let the user choose a message group & sub-board // Input loop - Let the user choose a message group & sub-board
var curpos = new Object(); var curpos = new Object();
curpos.x = 1; curpos.x = 1;
curpos.y = 1; curpos.y = listStartRow - 1;
console.gotoxy(curpos); console.gotoxy(curpos);
var pageNum = calcPageNum(topMsgGrpIndex, numItemsPerPage); var pageNum = calcPageNum(topMsgGrpIndex, numItemsPerPage);
this.WriteGrpListHdrLine(numPages, pageNum); this.WriteGrpListHdrLine(numPages, pageNum);
...@@ -9767,7 +9951,7 @@ function DigDistMsgReader_SelectMsgArea_Lightbar() ...@@ -9767,7 +9951,7 @@ function DigDistMsgReader_SelectMsgArea_Lightbar()
{ {
// A sub-board was not chosen, so we'll have to re-draw // A sub-board was not chosen, so we'll have to re-draw
// the header and list of message groups. // the header and list of message groups.
console.gotoxy(1, 1); console.gotoxy(1, this.areaChangeHdrLines.length+1);
this.WriteGrpListHdrLine(numPages, pageNum); this.WriteGrpListHdrLine(numPages, pageNum);
this.ListScreenfulOfMsgGrps(topMsgGrpIndex, listStartRow, listEndRow, this.ListScreenfulOfMsgGrps(topMsgGrpIndex, listStartRow, listEndRow,
false, true); false, true);
...@@ -10020,7 +10204,8 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10020,7 +10204,8 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
} }
*/ */
   
var listStartRow = 3; // The row on the screen where the list will start // listStartRow is the row on the screen where the list will start
var listStartRow = 3 + this.areaChangeHdrLines.length;
var listEndRow = console.screen_rows - 1; // Row on screen where list will end var listEndRow = console.screen_rows - 1; // Row on screen where list will end
var topSubIndex = 0; // The index of the message group at the top of the list var topSubIndex = 0; // The index of the message group at the top of the list
// Figure out the index of the last message group to appear on the screen. // Figure out the index of the last message group to appear on the screen.
...@@ -10063,20 +10248,22 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10063,20 +10248,22 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
} }
} }
   
// Clear the screen, write the help line and group list header, and output // Clear the screen, write the header line, help line and group list header,
// a screenful of message groups. // and output a screenful of message sub-boards.
console.clear("\1n"); console.clear("\1n");
this.DisplayAreaChgHdr(1);
if (this.areaChangeHdrLines.length > 0)
console.crlf();
var pageNum = calcPageNum(topSubIndex, numItemsPerPage); var pageNum = calcPageNum(topSubIndex, numItemsPerPage);
this.WriteSubBrdListHdr1Line(grpIndex, numPages, pageNum); this.WriteSubBrdListHdr1Line(grpIndex, numPages, pageNum);
this.WriteChgMsgAreaKeysHelpLine(); this.WriteChgMsgAreaKeysHelpLine();
   
var curpos = new Object(); var curpos = new Object();
curpos.x = 1; curpos.x = 1;
curpos.y = 2; curpos.y = 2 + this.areaChangeHdrLines.length;
console.gotoxy(curpos); console.gotoxy(curpos);
printf(this.subBoardListHdrPrintfStr, "Sub #", "Name", "# Posts", "Latest date & time"); printf(this.subBoardListHdrPrintfStr, "Sub #", "Name", "# Posts", "Latest date & time");
this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, listEndRow, this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, listEndRow, false, false);
false, false);
// Start of the input loop. // Start of the input loop.
var highlightScrenRow = 0; // The row on the screen for the highlighted group var highlightScrenRow = 0; // The row on the screen for the highlighted group
var userInput = ""; // Will store a keypress from the user var userInput = ""; // Will store a keypress from the user
...@@ -10093,7 +10280,8 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10093,7 +10280,8 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
} }
   
// Get a key from the user (upper-case) and take action based upon it. // Get a key from the user (upper-case) and take action based upon it.
userInput = console.getkey(K_UPPER | K_NOCRLF); //userInput = console.getkey(K_UPPER | K_NOCRLF);
userInput = getKeyWithESCChars(K_UPPER | K_NOCRLF);
switch (userInput) switch (userInput)
{ {
case KEY_UP: // Move up one message group in the list case KEY_UP: // Move up one message group in the list
...@@ -10110,8 +10298,7 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10110,8 +10298,7 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
bottomSubIndex = getBottommostSubIndex(topSubIndex, numItemsPerPage); bottomSubIndex = getBottommostSubIndex(topSubIndex, numItemsPerPage);
pageNum = calcPageNum(topSubIndex, numItemsPerPage); pageNum = calcPageNum(topSubIndex, numItemsPerPage);
this.UpdateMsgAreaPageNumInHeader(pageNum, numPages, false, false); this.UpdateMsgAreaPageNumInHeader(pageNum, numPages, false, false);
this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, listEndRow, false, true);
listEndRow, false, true);
} }
else else
{ {
...@@ -10136,8 +10323,7 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10136,8 +10323,7 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
bottomSubIndex = getBottommostSubIndex(topSubIndex, numItemsPerPage); bottomSubIndex = getBottommostSubIndex(topSubIndex, numItemsPerPage);
pageNum = calcPageNum(topSubIndex, numItemsPerPage); pageNum = calcPageNum(topSubIndex, numItemsPerPage);
this.UpdateMsgAreaPageNumInHeader(pageNum, numPages, false, false); this.UpdateMsgAreaPageNumInHeader(pageNum, numPages, false, false);
this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, listEndRow, false, true);
listEndRow, false, true);
} }
else else
{ {
...@@ -10196,7 +10382,8 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10196,7 +10382,8 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
retObj.subBoardIndex = -1; retObj.subBoardIndex = -1;
} }
break; break;
case 'N': // Go to the next page case KEY_PAGE_DOWN: // Go to the next page
case 'N':
var nextPageTopIndex = topSubIndex + numItemsPerPage; var nextPageTopIndex = topSubIndex + numItemsPerPage;
if (nextPageTopIndex < msg_area.grp_list[grpIndex].sub_list.length) if (nextPageTopIndex < msg_area.grp_list[grpIndex].sub_list.length)
{ {
...@@ -10206,12 +10393,12 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10206,12 +10393,12 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
pageNum = calcPageNum(topSubIndex, numItemsPerPage); pageNum = calcPageNum(topSubIndex, numItemsPerPage);
bottomSubIndex = getBottommostSubIndex(topSubIndex, numItemsPerPage); bottomSubIndex = getBottommostSubIndex(topSubIndex, numItemsPerPage);
this.UpdateMsgAreaPageNumInHeader(pageNum, numPages, false, false); this.UpdateMsgAreaPageNumInHeader(pageNum, numPages, false, false);
this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, listEndRow, false, true);
listEndRow, false, true);
selectedSubIndex = topSubIndex; selectedSubIndex = topSubIndex;
} }
break; break;
case 'P': // Go to the previous page case KEY_PAGE_UP: // Go to the previous page
case 'P':
var prevPageTopIndex = topSubIndex - numItemsPerPage; var prevPageTopIndex = topSubIndex - numItemsPerPage;
if (prevPageTopIndex >= 0) if (prevPageTopIndex >= 0)
{ {
...@@ -10221,8 +10408,7 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10221,8 +10408,7 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
pageNum = calcPageNum(topSubIndex, numItemsPerPage); pageNum = calcPageNum(topSubIndex, numItemsPerPage);
bottomSubIndex = getBottommostSubIndex(topSubIndex, numItemsPerPage); bottomSubIndex = getBottommostSubIndex(topSubIndex, numItemsPerPage);
this.UpdateMsgAreaPageNumInHeader(pageNum, numPages, false, false); this.UpdateMsgAreaPageNumInHeader(pageNum, numPages, false, false);
this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, listEndRow, false, true);
listEndRow, false, true);
selectedSubIndex = topSubIndex; selectedSubIndex = topSubIndex;
} }
break; break;
...@@ -10233,8 +10419,7 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10233,8 +10419,7 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
pageNum = calcPageNum(topSubIndex, numItemsPerPage); pageNum = calcPageNum(topSubIndex, numItemsPerPage);
bottomSubIndex = getBottommostSubIndex(topSubIndex, numItemsPerPage); bottomSubIndex = getBottommostSubIndex(topSubIndex, numItemsPerPage);
this.UpdateMsgAreaPageNumInHeader(pageNum, numPages, false, false); this.UpdateMsgAreaPageNumInHeader(pageNum, numPages, false, false);
this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, listEndRow, false, true);
listEndRow, false, true);
selectedSubIndex = 0; selectedSubIndex = 0;
} }
break; break;
...@@ -10245,8 +10430,7 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10245,8 +10430,7 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
pageNum = calcPageNum(topSubIndex, numItemsPerPage); pageNum = calcPageNum(topSubIndex, numItemsPerPage);
bottomSubIndex = getBottommostSubIndex(topSubIndex, numItemsPerPage); bottomSubIndex = getBottommostSubIndex(topSubIndex, numItemsPerPage);
this.UpdateMsgAreaPageNumInHeader(pageNum, numPages, false, false); this.UpdateMsgAreaPageNumInHeader(pageNum, numPages, false, false);
this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, listEndRow, false, true);
listEndRow, false, true);
selectedSubIndex = topIndexForLastPage; selectedSubIndex = topIndexForLastPage;
} }
break; break;
...@@ -10262,10 +10446,8 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10262,10 +10446,8 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
console.cleartoeol("\1n"); console.cleartoeol("\1n");
this.WriteChgMsgAreaKeysHelpLine(); this.WriteChgMsgAreaKeysHelpLine();
console.gotoxy(1, 2); console.gotoxy(1, 2);
printf(this.subBoardListHdrPrintfStr, "Sub #", "Name", "# Posts", printf(this.subBoardListHdrPrintfStr, "Sub #", "Name", "# Posts", "Latest date & time");
"Latest date & time"); this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, listEndRow, false, true);
this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow,
listEndRow, false, true);
break; break;
default: default:
// If the user entered a numeric digit, then treat it as // If the user entered a numeric digit, then treat it as
...@@ -10313,14 +10495,15 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10313,14 +10495,15 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
// re-draw the screen due to everything being moved up one // re-draw the screen due to everything being moved up one
// line. // line.
console.gotoxy(1, 1); console.gotoxy(1, 1);
this.DisplayAreaChgHdr(1);
if (this.areaChangeHdrLines.length > 0)
console.crlf();
this.WriteSubBrdListHdr1Line(grpIndex, numPages, pageNum); this.WriteSubBrdListHdr1Line(grpIndex, numPages, pageNum);
console.cleartoeol("\1n"); console.cleartoeol("\1n");
this.WriteChgMsgAreaKeysHelpLine(); this.WriteChgMsgAreaKeysHelpLine();
console.gotoxy(1, 2); console.gotoxy(1, 2);
printf(this.subBoardListHdrPrintfStr, "Sub #", "Name", "# Posts", printf(this.subBoardListHdrPrintfStr, "Sub #", "Name", "# Posts", "Latest date & time");
"Latest date & time"); this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, listEndRow, false, true);
this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow,
listEndRow, false, true);
} }
} }
else else
...@@ -10328,14 +10511,15 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex) ...@@ -10328,14 +10511,15 @@ function DigDistMsgReader_SelectSubBoard_Lightbar(pGrpIndex, pMarkIndex)
// The user didn't enter a selection. Now we need to re-draw // The user didn't enter a selection. Now we need to re-draw
// the screen due to everything being moved up one line. // the screen due to everything being moved up one line.
console.gotoxy(1, 1); console.gotoxy(1, 1);
this.DisplayAreaChgHdr(1);
if (this.areaChangeHdrLines.length > 0)
console.crlf();
this.WriteSubBrdListHdr1Line(grpIndex, numPages, pageNum); this.WriteSubBrdListHdr1Line(grpIndex, numPages, pageNum);
console.cleartoeol("\1n"); console.cleartoeol("\1n");
this.WriteChgMsgAreaKeysHelpLine(); this.WriteChgMsgAreaKeysHelpLine();
console.gotoxy(1, 2); console.gotoxy(1, 2);
printf(this.subBoardListHdrPrintfStr, "Sub #", "Name", "# Posts", printf(this.subBoardListHdrPrintfStr, "Sub #", "Name", "# Posts", "Latest date & time");
"Latest date & time"); this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow, listEndRow, false, true);
this.ListScreenfulOfSubBrds(grpIndex, topSubIndex, listStartRow,
listEndRow, false, true);
} }
} }
break; break;
...@@ -10379,6 +10563,8 @@ function DigDistMsgReader_SelectMsgArea_Traditional() ...@@ -10379,6 +10563,8 @@ function DigDistMsgReader_SelectMsgArea_Traditional()
bbs.command_str = ""; bbs.command_str = "";
   
console.clear("\1n"); console.clear("\1n");
this.DisplayAreaChgHdr();
//console.crlf();
this.ListMsgGrps(); this.ListMsgGrps();
console.crlf(); console.crlf();
console.print("\1n\1b\1h \1n\1cWhich, \1hQ\1n\1cuit, or [\1h" + console.print("\1n\1b\1h \1n\1cWhich, \1hQ\1n\1cuit, or [\1h" +
...@@ -10427,6 +10613,7 @@ function DigDistMsgReader_SelectMsgArea_Traditional() ...@@ -10427,6 +10613,7 @@ function DigDistMsgReader_SelectMsgArea_Traditional()
while (continueChoosingSubBoard) while (continueChoosingSubBoard)
{ {
console.clear("\1n"); console.clear("\1n");
this.DisplayAreaChgHdr();
this.ListSubBoardsInMsgGroup(selectedGrp-1, defaultSubBoard-1); this.ListSubBoardsInMsgGroup(selectedGrp-1, defaultSubBoard-1);
console.crlf(); console.crlf();
console.print("\1n\1b\1h \1n\1cWhich, \1hQ\1n\1cuit, or [\1h" + console.print("\1n\1b\1h \1n\1cWhich, \1hQ\1n\1cuit, or [\1h" +
...@@ -10824,13 +11011,13 @@ function DigDistMsgReader_updateMsgAreaPageNumInHeader(pPageNum, pNumPages, pGro ...@@ -10824,13 +11011,13 @@ function DigDistMsgReader_updateMsgAreaPageNumInHeader(pPageNum, pNumPages, pGro
   
if (pGroup) if (pGroup)
{ {
console.gotoxy(29, 1); console.gotoxy(29, 1+this.areaChangeHdrLines.length);
console.print("\1n" + this.colors.areaChooserMsgAreaHeaderColor + pPageNum + " of " + console.print("\1n" + this.colors.areaChooserMsgAreaHeaderColor + pPageNum + " of " +
pNumPages + ") "); pNumPages + ") ");
} }
else else
{ {
console.gotoxy(51, 1); console.gotoxy(51, 1+this.areaChangeHdrLines.length);
console.print("\1n" + this.colors.areaChooserSubBoardHeaderColor + pPageNum + " of " + console.print("\1n" + this.colors.areaChooserSubBoardHeaderColor + pPageNum + " of " +
pNumPages + ") "); pNumPages + ") ");
} }
......
xtrn/DDMsgReader/Read Me.txt
+ 34
− 2
View file @ f752e485
Digital Distortion Message Reader Digital Distortion Message Reader
Version 1.09 Version 1.10
Release date: 2016-01-15 Release date: 2016-??-??
by by
...@@ -583,6 +583,31 @@ pauseAfterNewMsgScan Whether or not to pause (i.e., with a ...@@ -583,6 +583,31 @@ pauseAfterNewMsgScan Whether or not to pause (i.e., with a
message scan. Valid values are true message scan. Valid values are true
and false. and false.
postOnSubBoardInsteadOfGoToNext Whether or not to ask the user whether to
post on the sub-board in reader mode after
reading the last message instead of
prompting to go to the next sub-board.
This is like the stock Synchronet
behavior. Valid values are true and
false. This defaults to false.
areaChooserHdrFilenameBase The filename to use (without the
extension) for a header to display above
the message area chooser list. For
example, if areaChgHeader is specified,
then the reader will look for
areaChgHeader.ans if it exists, and if
not, the reader will look for
areaChgHeader.asc. Additionally, you
can have multiple header files for
different terminal widths; fpr example,
areaChgHeader-80.ans for an 80-column
terminal, areaChgHeader-140.ans for a
140-column terminal, etc.
areaChooserHdrMaxLines The maximum number of lines to use from
the message area chooser header file.
themeFilename The name of the configuration file to themeFilename The name of the configuration file to
use for colors & string settings use for colors & string settings
...@@ -793,6 +818,13 @@ enhReaderHelpLineParenColor Color to use for ) characters in the ...@@ -793,6 +818,13 @@ enhReaderHelpLineParenColor Color to use for ) characters in the
hotkey help line displayed at the bottom hotkey help line displayed at the bottom
of the scrollable message reader interface of the scrollable message reader interface
postOnSubBoard The text to use for asking the user whether
they want to post on a sub-board (for
instance, after reading the last message).
The two %s will be replaced with the
message group name and sub-board
description, respectively.
newMsgScanText The first text displayed when doing a new newMsgScanText The first text displayed when doing a new
message scan, before the sub-board/group/ message scan, before the sub-board/group/
all prompt is displayed all prompt is displayed
......
xtrn/DDMsgReader/Revision history.txt
+ 24
− 0
View file @ f752e485
...@@ -5,6 +5,30 @@ Revision History (change log) ...@@ -5,6 +5,30 @@ Revision History (change log)
============================= =============================
Version Date Description Version Date Description
------- ---- ----------- ------- ---- -----------
1.10 2016-??-?? Added a new configuration option,
postOnSubBoardInsteadOfGoToNext, that affects what happens
after the user reads the last message on a sub-board: If
this is set to true, then the reader will prompt the user
if they want to post on the sub-board, then exit (this
is the stock Synchronet behavior). If this is set to
false, then the reader will prompt the user whether to go
to the next sub-board after reading the last message on a
sub-board. Also, added the postOnSubBoard text
configuration parameter for the theme filename, which
specifies the text to use for prompting the user if they
want to post on the sub-board after reading the last
message.
Added new configuration options areaChooserHdrFilenameBase
and areaChooserHdrMaxLines. These options specify the
filename base for a header file to use for the message
area chooser list and the maximum number of lines to use
from the area chooser header file. The filaname is
without the extension - The reader will first look for an
.ans version, then an .asc version. Additionally,
multiple header files can be used for different terminal
widths - For example, chooserMsgHdr-80.ans for an
80-column terminal, choosrMsgHdr-140.ans for a 140-column
terminal, etc.
1.09 2016-01-15 Updated to not center the message header lines 1.09 2016-01-15 Updated to not center the message header lines
horizontally. Now, it will display the header lines horizontally. Now, it will display the header lines
starting on column 1. This was done to fix a display starting on column 1. This was done to fix a display
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment