enigma-bbs/core/scanner_tossers/ftn_bso.js

/* jslint node: true */
'use strict';

//	ENiGMA½
let MessageScanTossModule	= require('../msg_scan_toss_module.js').MessageScanTossModule;
let Config					= require('../config.js').config;
let ftnMailpacket			= require('../ftn_mail_packet.js');
let ftnUtil					= require('../ftn_util.js');
let Address					= require('../ftn_address.js');
let Log						= require('../logger.js').log;

let moment					= require('moment');
let _						= require('lodash');

exports.moduleInfo = {
	name	: 'FTN',
	desc	: 'FidoNet Style Message Scanner/Tosser',
	author	: 'NuSkooler',
};

exports.getModule = FTNMessageScanTossModule;

function FTNMessageScanTossModule() {
	MessageScanTossModule.call(this);

	if(_.has(Config, 'scannerTossers.ftn_bso')) {
		this.config = Config.scannerTossers.ftn_bso;
	}

	this.createMessagePacket = function(message, config) {
		this.prepareMessage(message);

		let packet = new ftnMailPacket.Packet();

		let packetHeader = new ftnMailpacket.PacketHeader();
		packetHeader.init(
			config.network.localAddress,
			config.remoteAddress);

		packetHeader.setPassword(config.remoteNode.packetPassword || '');
	};

	this.prepareMessage = function(message, config) {
		//
		//	Set various FTN kludges/etc.
		//
		message.meta.FtnProperty = message.meta.FtnProperty || {};
		message.meta.FtnProperty.ftn_orig_node		= config.network.localAddress.node;
		message.meta.FtnProperty.ftn_dest_node		= config.remoteAddress.node;
		message.meta.FtnProperty.ftn_orig_network	= config.network.localAddress.net;
		message.meta.FtnProperty.ftn_dest_network	= config.remoteAddress.net;
		//	:TODO: attr1 & 2
		message.meta.FtnProperty.ftn_cost			= 0;

		message.meta.FtnProperty.ftn_tear_line		= ftnUtil.getTearLine();
		message.meta.FtnProperty.ftn_origin			= ftnUtil.getOrigin(config.network.localAddress);

		if(message.isPrivate()) {
			//
			//	NetMail messages need a FRL-1005.001 "Via" line
			//	http://ftsc.org/docs/frl-1005.001
			//
			if(_.isString(message.meta.FtnKludge['Via'])) {
				message.meta.FtnKludge['Via'] = [ message.meta.FtnKludge['Via'] ];
			}
			message.meta.FtnKludge['Via'] = message.meta.FtnKludge['Via'] || [];
			message.meta.FtnKludge['Via'].push(ftnUtil.getVia(config.network.localAddress));
		} else {
			message.meta.FtnProperty.ftn_area = message.areaTag;
		}

		//
		//	When exporting messages, we should create/update SEEN-BY
		//	with remote address(s) we are exporting to.
		//
		message.meta.FtnProperty.ftn_seen_by = 
			ftnUtil.getUpdatedSeenByEntries(
				message.meta.FtnProperty.ftn_seen_by,
				Config.messageNetworks.ftn.areas[message.areaTag].uplinks
			);

		//
		//	And create/update PATH for ourself
		//
		message.meta.FtnKludge['PATH'] = 
			ftnUtil.getUpdatedPathEntries(
				message.meta.FtnKludge['PATH'], 
				config.network.localAddress.node
			);
	};

}

require('util').inherits(FTNMessageScanTossModule, MessageScanTossModule);

FTNMessageScanTossModule.prototype.startup = function(cb) {
	Log.info('FidoNet Scanner/Tosser starting up');

	cb(null);
};

FTNMessageScanTossModule.prototype.shutdown = function(cb) {
	Log.info('FidoNet Scanner/Tosser shutting down');

	cb(null);
};

FTNMessageScanTossModule.prototype.record = function(message, cb) {
	if(!_.has(Config, [ 'messageNetworks', 'ftn', 'areas', message.areaTag ])) {
		return;
	}

	const area = Config.messageNetworks.ftn.areas[message.areaTag];
	if(!_.isString(area.ftnArea) || !_.isArray(area.uplinks)) {
		//	:TODO: should probably log a warning here
		return;
	}

	//
	//	For each uplink, find the best configuration match
	//
	area.uplinks.forEach(uplink => {
		//	:TODO: sort by least # of '*' & take top?
		let matchNodes = _.filter(Object.keys(Config.scannerTossers.ftn_bso.nodes), addr => {
			return Address.fromString(addr).isMatch(uplink);
		});

		if(matchNodes.length > 0) {
			const nodeKey = matchNodes[0];

		}
	});


	cb(null);
	
	//	:TODO: should perhaps record in batches - e.g. start an event, record
	//	to temp location until time is hit or N achieved such that if multiple
	//	messages are being created a .FTN file is not made for each one
};