sbbs/load/funcs.js

'use strict';
require('ansitex/load/defs.js','ANSITEX_HOME');		// ANSITEX definitions

// Array of page owners
var pageowners = [];

// String repeat.
if (!String.prototype.repeat) {
	String.prototype.repeat = function(count) {
		'use strict';
		if (this === null) {
			throw new TypeError('can\'t convert ' + this + ' to object');
		}
		var str = '' + this;
		count = +count;
		if (count !== count) {
			count = 0;
		}
		if (count < 0) {
			throw new RangeError('repeat count must be non-negative: '+count);
		}
		if (count === Infinity) {
			throw new RangeError('repeat count must be less than infinity');
		}
		count = Math.floor(count);
		if (str.length === 0 || count === 0) {
			return '';
		}
		// Ensuring count is a 31-bit integer allows us to heavily optimize the
		// main part. But anyway, most current (August 2014) browsers can't handle
		// strings 1 << 28 chars or longer, so:
		if (str.length * count >= 1 << 28) {
			throw new RangeError('repeat count must not overflow maximum string size');
		}
		var rpt = '';
		for (;;) {
			if ((count & 1) === 1) {
				rpt += str;
			}
			count >>>= 1;
			if (count === 0) {
				break;
			}
			str += str;
		}
		return rpt;
	};
}

/**
 * Convert ANSI into BIN for loading into a Frame
 *
 * @param ansi
 */
function ans2bin(ansi,frame) {
	var x = new Graphic;
	x.ANSI = ansi;

	var o = 0; // offset into 'bin'
	for (var yy = 0; yy < 22; yy++) {
		for (var xx = 0; xx < 80; xx++) {
			frame.setData(
				xx,
				yy,
				x.BIN.substr(o,1),
				x.BIN.substr(o+1,1).charCodeAt(0) || BG_BLACK
			);

			o = o+2;
		}
	}
}

/**
 * Dynamic Field Processing
 *
 * @param field	field we want to get a value for
 * @param length length to fill this field
 * @param pad the padding character if field is less than length
 * @param context a context value to determine the value from
 * @returns {string|*|null}
 * @note bbs.atcodes() cannot process modifiers, so this function is a replacement.
 */
function atcode(field,length,pad,context) {
	pad = pad ? pad : ' ';
	var result = {};
	var args = [];

	if (field.search(/:/)) {
		args = field.split(':');
		field = args.shift();
	}

	log(LOG_DEBUG,'Field:'+field,'Args:'+JSON.stringify(args));

	switch(field) {
		// Work out the key for the message area
		case 'msg_area_key':
			var index = args.shift();

			log(LOG_DEBUG,'Context:'+context+', Index:'+index);

			// If the message area exists, we'll return a key and a index
			if (new MsgAreas().getArea(context+index.padStart(2,'0'))) {
				result.value = index;
				result.key = '1'+context+index.padStart(2,'0');
			}

			break;

		// Get the ECHOAREA Internal Code
		case 'msg_area_tag':
			var index = args.shift();
			var area = new MsgAreas().getArea(context+index.padStart(2,'0'));

			log(LOG_DEBUG,'Context:'+context+', Index:'+index+', Area:'+JSON.stringify(area));

			// If the message area exists
			if (area)
				result.value = area.code.toUpperCase();

			break;

		// Get the ECHOAREA Name
		case 'msg_area_name':
			var index = args.shift();
			var area = new MsgAreas().getArea(context+index.padStart(2,'0'));

			if (area)
				result.value = area.area_name;

			break;

		// Oldest message in msgarea
		// Our oldest message, is the first message with a tag from the headers
		case 'msg_area_msgoldest_date':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			var x = context.list_tagged[0];

			result.value = x ? x.date : '';
			break;

		case 'msg_area_msgoldest_page':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			var x = context.list_tagged[0];

			return x ? context.getMessagePage(x.number) : null;

		// Newest message in msgarea
		// Our newest message, is the last message with a tag from the headers
		case 'msg_area_msgnewest_date':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			var x = context.list_tagged[context.list_tagged.length-1];

			result.value = x ? x.date : '';
			break;

		case 'msg_area_msgnewest_page':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			var x = context.list_tagged[context.list_tagged.length-1];

			return x ? context.getMessagePage(x.number) : null;

		// First unread message
		case 'msg_area_msgunread_date':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			var x = context.newMsgs();

			result.value = x.length ? x.shift().date : '';
			break;

		case 'msg_area_msgunread_page':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			var x = context.newMsgs();
			return x.length ? context.getMessagePage(x.shift().number) : null;

		// First unread message to me
		case 'msg_area_msgotome_date':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			var x = context.newMsgsToMe();

			result.value = x.length > 1 ? x[1].date : '';
			break;

		case 'msg_area_msgtome_page':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			var x = context.newMsgsToMe();
			return x.length > 1 ? context.getMessagePage(x[1].number) : null;

		// Count of unread messages
		case 'msg_area_new':
			if (args.length === 1) {
				context = new MsgArea();
				context.code = args[0];
			}

			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			result.value = ''+context.newMsgs().length;
			break;

		// Count of unread messages to me
		case 'msg_area_newtome':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			result.value = ''+(context.newMsgsToMe().length > 1 ? context.newMsgsToMe().length-1 : 0);
			break;

		// Is this message area in my new scan list
		case 'msg_area_newscan':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			result.value = (context.getUserStats().scan_ptr & SCAN_CFG_TOYOU) ? 'YES' : 'NO';
			break;

		// Is this message area in my new scan list
		case 'msg_area_pending':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			result.value = ''+context.list_untagged.length;
			break;

		// Get the ECHOAREA Total Number of Messages
		case 'msg_area_total':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			result.value = ''+context.msgbase.total_msgs;
			break;

		// Get the ECHOAREA Group Name
		case 'msg_grp_name':
			if (typeof context !== 'object') {
				log(LOG_ERROR,'Unable to render ['+field+'], no context provided');
				break;
			}

			result.value = context.zone_name;
			break;

		case 'nodeid':
			result.value = getNodeID();
			break;

		default:
			result.value = (typeof bbs === 'undefined') ? '*'.repeat(Math.abs(length)) : bbs.atcode(field+(args.length ? ':'+args : ''));
	}

	if ((result.value === null) || (result.value === undefined))
		result.value = '';

	length = length ? length : result.value.length;

	//log(LOG_DEBUG,'  - result length ['+result.length+'] desired ('+length+')');
	if (result.value.length < Math.abs(length))
		result.value = (length < 0) ? padright(result.value,Math.abs(length),pad) : padleft(result.value,length,pad);
	else if (result.value.length > Math.abs(length))
		result.value = result.value.substr(0,Math.abs(length));

	log(LOG_DEBUG,'* ATCODE ['+field+'] ('+length+'|"'+pad+'") returns ['+result.value+'] key ['+result.key+']');

	return result;
}

/**
 * Find a message base by code
 *
 * @param code
 * @returns {number | string|boolean}
 * @deprecated Can this move to the msgbases.js?
 */
function findMsgBase(code) {
	if (! code)
		code = "vtx_data";

	for (var s in msg_area.sub) {
		var sub = msg_area.sub[s];
		writeln('sub:'+sub.code);

		if (sub.code.substr(-code.length).toLowerCase() === code)
			return sub;
	}

	return false;
}

/**
 * Return an argument from argv, or an error if it doesnt exit
 *
 * @param key
 * @param error
 * @param abort
 */
function getArg(key,error,abort) {
	index = argv.indexOf(key);

	if ((index !== -1) && (! (argv[index+1] === undefined || argv[index+1].match(/^-/)))) {
		return argv[index+1];
	}

	if (abort) {
		log(LOG_ERROR,error);
		exit(1);
	}
}

/**
 * Returns the current node number
 *
 * @returns {string}
 */
function getNodeID() {
	var regex = new RegExp('^'+SYSTEM_ZONE+':');
	var matches = [];

	for each (var addr in system.fido_addr_list)
	{
		if (regex.test(addr)) {
			addr = addr.replace(regex,'');
			matches = addr.split('/',2);
			break;
		}
	}

	return (matches.length === 0) ? '-' : padright(matches[0],3,'0')+padright(matches[1],3,'0')+padright((typeof bbs === 'undefined') ? 0 : bbs.node_num,2,'0');
}

function getPageOwners() {
	// Load the owner configuration into memory
	if (! pageowners.length) {
		var f = new File(ANSITEX_HOME+'/ctrl/videotex.ini');

		if (f.open('r')) {
			var logoans = f.iniGetValue('prefix','logoans');
			var logovtx = f.iniGetValue('prefix','logovtx');
			var users = f.iniGetValue('prefix','user');
			//log(LOG_DEBUG,'+ pageOwner: users='+JSON.stringify(users));
			pageowners.push({prefix: 0,logoans: logoans,logovtx: logovtx,user:users});

			f.iniGetSections('prefix:').forEach(function (prefix) {
				var p = parseInt(prefix.substr(7));
				var logoans = f.iniGetValue(prefix,'logoans','');
				var logovtx = f.iniGetValue(prefix,'logovtx','');
				var users = f.iniGetValue(prefix,'user','');
				//log(LOG_DEBUG,'+ pageOwner: users='+JSON.stringify(users));
				pageowners.push({prefix: p,logoans: logoans,logovtx: logovtx,user:users});
			});

		} else {
			log(LOG_DEBUG,'getPageOwners: Couldnt open videotex.ini? :'+JSON.stringify(f));
		}

		f.close();

		// Sort the pageowners ascending
		pageowners.sort(function(a,b) { return (a.prefix < b.prefix) ? 1 : ((b.prefix < a.prefix) ? -1 : 0); });

		//log(LOG_DEBUG,'+ pageOwner: pageowners='+JSON.stringify(pageowners));
	}

	return pageowners;
}

function loadOptions(option) {
	var f = new File(ANSITEX_HOME+'/ctrl/videotex.ini');

	if (! f.open('r')) {
		log(LOG_DEBUG,'loadOptions: Couldnt open videotex.ini? :'+JSON.stringify(f));

		return undefined;
	}

	val = f.iniGetObject(option);

	f.close();

	return val;
}

function msgBaseImport(msgbase,page,text) {
	var msgbase = new MsgBase(findMsgBase(msgbase).code);

	log(LOG_DEBUG,'Sending ['+page+'] to message base ['+msgbase.cfg.code+']');

	var hdr = { to:'All', from:'Videotex', subject:'Frame: '+page };

	var body = '';
	body += text+"\r\n";
	body += "--- " + js.exec_file + " " + '1.0' + "\r\n";

	return msgbase.save_msg(hdr, body);
}

// Right Pad a string with char c
function padright(n,width,c) {
	c = c || '0';
	n = n + '';
	return n.length >= width ? n : new Array(width - n.length + 1).join(c) + n;
}

// Left Pad a string with char c
function padleft(n,width,c) {
	c = c || '0';
	n = n + '';
	return n.length >= width ? n : n+new Array(width - n.length + 1).join(c);
}

/**
 * Return the frame as a string
 */
function pageStr(page) {
	if (page.frame==null)
		return null;

	if (! page.index)
		page.index = 'a';

	return page.frame.toString()+page.index;
}

/**
 * Read our videotex.ini configuration and determine who owns a page.
 * If there is no prefix for the page, it is owned by the system '0'
 *
 * @param page
 * @returns {undefined}
 */
function pageOwner(page) {
	var BreakException = {};
	var o = null;

	try {
		getPageOwners().forEach(function(owner) {
			var p = owner.prefix.toString();
			o = owner;

			var re = new RegExp('^' + p, 'g');
			if (page.toString().match(re)) {
				//log(LOG_DEBUG,'= pageOwner: p='+p+',o: '+o);
				throw BreakException;
			}
		});

	} catch (e) {
		if (e !== BreakException) throw e;
	}

	//log(LOG_DEBUG,'+ pageOwner: page='+page+', owner: '+JSON.stringify(o));
	return o;
}

/**
 * Can the user edit the frame
 *
 * @param page
 * @param user
 */
function pageEditor(page) {
	//log(LOG_DEBUG,'+ pageEditor: page='+page+', user #'+user.number);

	var BreakException = {};
	var pageditor = false;

	try {
		getPageOwners().forEach(function(owner) {
			var p = owner.prefix.toString();
			//log(LOG_DEBUG,'  - pageEditor: '+JSON.stringify(owner));
			frameusers = owner.user ? owner.user.toString().split(',') : [1];

			log(LOG_DEBUG,'  - pageEditor: p='+p+'('+p.length+') user ['+JSON.stringify(frameusers)+'] - :'+frameusers.indexOf(user.number.toString()));

			var re = new RegExp('^' + p, 'g');
			if (page.toString().match(re) && (frameusers.indexOf(user.number.toString()) !== -1)) {
				pageditor = true;
				throw BreakException;
			}
		});

	} catch (e) {
		if (e !== BreakException) throw e;
	}

	log(LOG_DEBUG,'+ pageEditor: page='+page+', editor: '+JSON.stringify(pageditor));
	return pageditor;
}

/**
 * This function returns a list of zones used by this system.
 */
function zones() {
	var z = [];
	var ftn = /([0-9]+):([0-9]+)\/([0-9]+)(\.([0-9]+))?/;

	for(var g=0;g<system.fido_addr_list.length;g++) {
		z.push(parseInt(system.fido_addr_list[g].match(ftn)[1]));
	}

	return z.sort(function(a,b) {
		return (a>b);
	});
}

this;