Merge branch 'msg_network' of ssh://numinibsd/git/base/enigma-bbs into msg_network

core/bbs.js

@@ -200,7 +200,13 @@ function startListening(cb) {
 		}
 
 		const moduleInst	= new module.getModule();
-		const server		= moduleInst.createServer();
+        let server;
+        try {
+		    server		= moduleInst.createServer();
+        } catch(e) {
+            logger.log.warn(e, 'Exception caught creating server!');
+            return;
+        }
 
 		//	:TODO: handle maxConnections, e.g. conf.maxConnections
 

core/config.js

@@ -192,7 +192,7 @@ function getDefaultConfig() {
 			},
 			ssh : {
 				port				: 8889,
-				enabled				: true,
+				enabled				: false,    //  defualt to false as PK/pass in config.hjson are required
 
 				//
 				//	Private key in PEM format

core/ftn_mail_packet.js

@@ -169,9 +169,11 @@ exports.PacketHeader = PacketHeader;
 //	*	Writeup on differences between type 2, 2.2, and 2+:
 //		http://walon.org/pub/fidonet/FTSC-nodelists-etc./pkt-types.txt
 //
-function Packet() {
+function Packet(options) {
 	var self = this;
     
+    this.options = options || {};
+
 	this.parsePacketHeader = function(packetBuffer, cb) {
 		assert(Buffer.isBuffer(packetBuffer));
 
@@ -574,6 +576,10 @@ function Packet() {
 			
 					if(messageBodyData.tearLine) {
 						msg.meta.FtnProperty.ftn_tear_line = messageBodyData.tearLine;
+                        
+                        if(self.options.keepTearAndOrigin) {
+                            msg.message += `\r\n${messageBodyData.tearLine}\r\n`;
+                        }
 					}
 					
 					if(messageBodyData.seenBy.length > 0) {
@@ -586,6 +592,10 @@ function Packet() {
 					
 					if(messageBodyData.originLine) {
 						msg.meta.FtnProperty.ftn_origin = messageBodyData.originLine;
+                        
+                        if(self.options.keepTearAndOrigin) {
+                            msg.message += `${messageBodyData.originLine}\r\n`;
+                        }
 					}			
 					
 					const nextBuf = packetBuffer.slice(read);

core/message_area.js

@@ -70,6 +70,8 @@ function getSortedAvailMessageConferences(client, options) {
 function getAvailableMessageAreasByConfTag(confTag, options) {
 	options = options || {};
     
+    //  :TODO: confTag === "" then find default
+
 	if(_.has(Config.messageConferences, [ confTag, 'areas' ])) {
         const areas = Config.messageConferences[confTag].areas;
 

core/multi_line_edit_text_view.js

@@ -267,23 +267,20 @@ function MultiLineEditTextView(options) {
 		return lines;
  	};
      
-	this.getOutputText = function(startIndex, endIndex, includeEol) {
-		var lines = self.getTextLines(startIndex, endIndex);
-
-		//
-		//	Convert lines to contiguous string -- all expanded
-		//	tabs put back to single '\t' characters.
-		//
-		var text = '';
+    this.getOutputText = function(startIndex, endIndex, eolMarker) {
+        let lines   = self.getTextLines(startIndex, endIndex);
+        let text    = '';
         var re      = new RegExp('\\t{1,' + (self.tabWidth) + '}', 'g');
-		for(var i = 0; i < lines.length; ++i) {
-			text += lines[i].text.replace(re, '\t');
-			if(includeEol && lines[i].eol) {
-				text += '\n';
-			}
+        
+        lines.forEach(line => {
+           text += line.text.replace(re, '\t');
+           if(eolMarker && line.eol) {
+               text += eolMarker;
            } 
+        });
+        
         return text;
-	};
+    }
 
 	this.getContiguousText = function(startIndex, endIndex, includeEol) {
 		var lines = self.getTextLines(startIndex, endIndex);
@@ -1018,7 +1015,7 @@ MultiLineEditTextView.prototype.addText = function(text) {
 };
 
 MultiLineEditTextView.prototype.getData = function() {
-	return this.getOutputText(0, this.textLines.length, true);
+	return this.getOutputText(0, this.textLines.length, '\r\n');
 };
 
 MultiLineEditTextView.prototype.setPropertyValue = function(propName, value) {

core/scanner_tossers/ftn_bso.js

@@ -806,7 +806,9 @@ function FTNMessageScanTossModule() {
 	this.importMessagesFromPacketFile = function(packetPath, password, cb) {
 		let packetHeader;
 				
-		new ftnMailPacket.Packet().read(packetPath, (entryType, entryData, next) => {
+        const packetOpts = { keepTearAndOrigin : true };
+        
+		new ftnMailPacket.Packet(packetOpts).read(packetPath, (entryType, entryData, next) => {
 			if('header' === entryType) {
 				packetHeader = entryData;
 				

core/servers/ssh.js

@@ -235,6 +235,7 @@ SSHServerModule.prototype.createServer = function() {
 		privateKey	: fs.readFileSync(Config.servers.ssh.privateKeyPem),
 		passphrase	: Config.servers.ssh.privateKeyPass,
 		ident		: 'enigma-bbs-' + enigVersion + '-srv',
+		
         //	Note that sending 'banner' breaks at least EtherTerm!
 		debug		: function debugSsh(dbgLine) { 
 			if(true === Config.servers.ssh.traceConnections) {

docs/config.md

@@ -21,5 +21,90 @@ general: {
 }
 ```
 
+#### A Sample Configuration
+Below is a **sample** `config.hjson` illustrating various (but not all!) elements that can be configured / tweaked.
+
+
+```hjson
+{
+	general: {
+		boardName: A Sample BBS
+	}
+
+	defaults: {
+		theme: super-fancy-theme
+	}
+
+	preLoginTheme: luciano_blocktronics
+
+	messageConferences: {
+		local_general: {
+			name: Local
+			desc: Local Discussions
+			default: true
+
+			areas: {
+				local_enigma_dev: {
+					name: ENiGMA 1/2 Development
+					desc: Discussion related to development and features of ENiGMA 1/2!
+					default: true
+				}
+			}
+		}
+
+		agoranet: {
+			name: Agoranet
+			desc: This network is for blatant exploitation of the greatest BBS scene art group ever.. ACiD.
+
+			areas: {
+				agoranet_bbs: {
+					name: BBS Discussion
+					desc: Discussion related to BBSs
+				}
+			}
+		}
+	}
+
+	messageNetworks: {
+		ftn: {
+			areas: {
+				agoranet_bbs: { /* hey kids, this matches above! */
+
+					// oh oh oh, and this one pairs up with a network below
+					network: agoranet
+					tag: AGN_BBS
+					uplinks: "46:1/100"
+				}
+			}
+
+			networks: {
+				agoranet: {
+					localAddress: "46:3/102"
+				}
+			}
+		}
+	}
+
+	scannerTossers: {
+		ftn_bso: {
+			schedule: {
+				import: every 1 hours or @watch:/home/enigma/bink/watchfile.txt
+				export: every 1 hours or @immediate
+			}
+
+			defaultZone: 46
+			defaultNetwork: agoranet
+
+			nodes: {
+				"46:*": {
+					archiveType: ZIP
+					encoding: utf8
+				}
+			}
+		}
+	}
+}
+```
+
 ### Menus
 TODO: Documentation on menu.hjson, etc.

docs/msg_networks.md

@@ -7,34 +7,41 @@ FTN networks are configured under the `messageNetworks::ftn` section of `config.
 ### Networks
 The `networks` section contains a sub section for network(s) you wish you join your board with. Each entry's key name can be referenced elsewhere in `config.hjson` for FTN oriented configurations.
 
-Members:
+**Members**:
   * `localAddress` (required): FTN address of **your local system**
   
-Example:
+**Example**:
 ```hjson
 {
+  messageNetworks: {
+    ftn: {
       networks: {
         agoranet: {
           localAddress: "46:3/102"
         }
       }
     }
+  }
+}
 ```
   
 ### Areas
-The `areas` section defines a mapping of local **area tags** to a message network (from `networks` described previously), a FTN area tag, and remote uplink address(s). This section can be thought of similar to the *AREAS.BBS* file used by other BBS packages.
+The `areas` section describes a mapping of local **area tags** found in your `messageConferences` to a message network (from `networks` described previously), a FTN specific area tag, and remote uplink address(s). This section can be thought of similar to the *AREAS.BBS* file used by other BBS packages.
 
-Members:
+When importing, messages will be placed in the local area that matches key under `areas`.
+
+**Members**:
   * `network` (required): Associated network from the `networks` section
   * `tag` (required): FTN area tag
   * `uplinks`: An array of FTN address uplink(s) for this network
 
-Example:
+**Example**:
 ```hjson
 {
+  messageNetworks: {
     ftn: {
       areas: {
-      agoranet_bbs: {
+        agoranet_bbs: { /* found within messageConferences */
           network: agoranet
           tag: AGN_BBS
           uplinks: "46:1/100"
@@ -42,12 +49,13 @@ Example:
       }
     }
   }
+}
 ```
 
 ### BSO Import / Export
 The scanner/tosser module `ftn_bso` provides **B**inkley **S**tyle **O**utbound (BSO) import/toss & scan/export of messages EchoMail and NetMail messages. Configuration is supplied in `config.hjson` under `scannerTossers::ftn_bso`.
 
-Members:
+**Members**:
   * `defaultZone` (required): Sets the default BSO outbound zone
   * `defaultNetwork` (optional): Sets the default network name from `messageNetworks::ftn::networks`. **Required if more than one network is defined**.
   * `paths` (optional): Override default paths set by the system. This section may contain `outbound`, `inbound`, and `secInbound`.
@@ -61,15 +69,16 @@ The `nodes` section defines how to export messages for one or more uplinks.
 
 A node entry starts with a FTN style address (up to 5D) **as a key** in `config.hjson`. This key may contain wildcard(s) for net/zone/node/point/domain.
 
-Members:
+**Members**:
   * `packetType` (optional): `2`, `2.2`, or `2+`. Defaults to `2+` for modern mailer compatiability
   * `packetPassword` (optional): Password for the packet
   * `encoding` (optional): Encoding to use for message bodies; Defaults to `utf-8`
   * `archiveType` (optional): Specifies the archive type for ArcMail bundles. Must be a valid archiver name such as `zip` (See archiver configuration)
 
-Example:
+**Example**:
 ```hjson
 {
+  scannerTossers: {
     ftn_bso: {
       nodes: {
         "46:*: {
@@ -81,20 +90,22 @@ Example:
       }
     }
   }
+}
 ```
 
 #### Scheduling
 Schedules can be defined for importing and exporting via `import` and `export` under `schedule`. Each entry is allowed a "free form" text and/or special indicators for immediate export or watch file triggers.
 
-  * `@immediate`: Currently only makes sense for exporting: A message will be immediately exported if this trigger is defined in a schedule.
-  * `@watch:/path/to/file`: This trigger watches the path specified for changes and will trigger an import or export when such events occur.
+  * `@immediate`: A message will be immediately exported if this trigger is defined in a schedule. Only used for `export`.
+  * `@watch:/path/to/file`: This trigger watches the path specified for changes and will trigger an import or export when such events occur. Only used for `import`.
   * Free form text can be things like `at 5:00 pm` or `every 2 hours`. 
   
 See [Later text parsing documentation](http://bunkat.github.io/later/parsers.html#text) for more information.
 
-Example:
+**Example**:
 ```hjson
 {
+  scannerTossers: {
     ftn_bso: {
       schedule: {
         import: every 1 hours or @watch:/path/to/watchfile.ext
@@ -102,4 +113,5 @@ Example:
       }
     }
   }
+}
 ```