/* ========================================================================= //
# vi:  ts=4:
# vim: ts=4:
#?
#? NAME
#?      EnDeFile.js
#?
#? SYNOPSIS
#?      <SCRIPT language="JavaScript1.5" type="text/javascript" charset="utf-8" src="EnDeFile.js"></SCRIPT>
#?
#? DESCRIPTION
#?      This file defines the  EnDeFile  class with following functions:
#?          .*         - functions and variables for reading files
#?          .read()    - read a file using XMLHttpRequest()
#?          .readTXT() - read a text file using XMLHttpRequest()
#?          .readXML() - read a  XML file using XMLHttpRequest()
#?          .reset()   - reset EnDeFile.* public valiables
#?          .local()   - check if url is file:/// then return url + src
#?
#?      Public input variables:
#?          .trace     - enable trace output
#?          .name      - path/filename of current read file
#?      Public output variables:
#?          .list      - list of read files (for debug purpose only)
#?          .errors    - list of file/access errors
#?          .content   - content read by EnDeFile.read()
#?                       null if failed, otherwise plain text or XML object
#?          .lines     - array with line numbers
#?          .strip     - true: remove comments (#) and empty lines
#?
#? VERSION
#?      @(#) EnDeFile.js 3.11 11/10/03 10:29:32
#?
#? AUTHOR
#?      07-may-07 Achim Hoffmann, mailto: EnDe (at) my (dash) stp (dot) net
#?
 * ========================================================================= */

// ========================================================================= //
// EnDeFile methods                                                          //
// ========================================================================= //

var EnDeFile= new function() {
	this.SID    = '3.11';
	this.sid    = function() { return('@(#) EnDeFile.js 3.11 11/10/03 10:29:32 EnDeFile'); };

	this.trace  = false;

	// ===================================================================== //
	// public variables                                                      //
	// ===================================================================== //
	this.name   = '';   // store current file path/name here
	this.lines  = [];   // store line numbers as comment and empty lines are removed
	this.errors = [];   // store file/access errors
	this.content= null; // store read content here
	this.version= '';   // store read SID which is string containing @(#) here
	this.strip  = true; // true: remove comments and empty lines
	this.list   = [     // list of read files (for debug purpose only)
			[ '# type\t', 'loaded\t', 'lines\t',  'src\t\t', 'version' ],
			[ '#------+', '-------+', '-------+', '---------------+', '-------------------' ]
		];

	// ===================================================================== //
	// private functions                                                     //
	// ===================================================================== //

	function __dbx(t,n) { if (EnDeFile.trace===true) { EnDeGUI.dpr(t,n); } };

	function __fileread(src,type,strip,async,header) {
	// internal function to read a file and store content in EnDeFile.content
		// returns true on success; false otherwise
		// NOTE that content is appended to EnDeFile.content
		/* type:  DOM  read text from innerHTML of given src object
		 * type:  TXT  read from file src and get it as text data
		 * type:  XML  read from file src and get it as XML data
		 * strip: true removes comments and empty lines from text
		 * async: true read file asynchronous; default read synchronous
		 *        async ** NOT YET IMPLEMENTED**
		 * header:value for Content-Type header in XMLHttpRequest()
		 *        only used if not empty
		 */
		__dbx(' EnDeFile __fileread('+src+', '+type+') {', ''); // dummy }
		var _ME = 'EnDeFile.__fileread: ';
		var bux = null;
		var bbb = null;
		var kkk = null;
		var idx = -1;
		var req = null;
		switch (type) {
		  case 'DOM':
			if (document.getElementById(src)!==null) {  // if we have a DOM object ..
				kkk = document.getElementById.innerHTML;
			}
			break;
		  case 'TXT':
		  case 'XML':
			this.name = src;
			bux = new XMLHttpRequest();
			req = bux.open("GET", src, false);// always load syncronous
			if (header!=='') {
				// workaround for some picky browsers reading from file:///
				try {      bux.setRequestHeader('Accept', header) ; }
				catch(e) {
					/*
					 * need try-catch to avoid hangup or uncatched thrown
					 * privilege exception; ugly workaround but smart for
					 * pedantic browsers
					 */
					bbb = _ME + ' send() with header failed:\n' + e;
					EnDeFile.errors.push( bbb ); __dbx( bbb );
				}
			}
// ToDo: chrome on windows fails here, probably need file:///....
			try { req = bux.send(null); }
			catch(e) {
				//#dbx alert('silently catch failed requests, which may occour in some browsers for file:///');
				bbb = _ME + ' send(file:///) failed:\n' + e;
				EnDeFile.errors.push( bbb ); /* dummy { */ __dbx( bbb + ' }' );
				//return false;
			}
			if (type==='TXT') {
				kkk = bux.responseText;
			} else {
				kkk = bux.responseXML;
			}
			break;
		} // switch
		if ((bux.status!==200) && (bux.status!==0)) {
			// 200 from http:// request; 0 from file:/// request
			bbb = _ME + ' failed with status ' + bux.status + '**';
			EnDeFile.errors.push( bbb ); /* dummy { */ __dbx( bbb + ' }' );
			kkk = null; bux = null;
			return false;
		}
		if (kkk===null) {
			bbb = _ME + ' failed (null)**';
			EnDeFile.errors.push( bbb ); /* dummy { */ __dbx( bbb + ' }' );
			kkk = null; bux = null;
			return false;
		}
		if (kkk==='') {
			// failed file:/// request
			bbb = _ME + ' failed (empty)**';
			EnDeFile.errors.push( bbb ); /* dummy { */ __dbx( bbb + ' }' );
			//kkk = null; bux = null; // ToDo: Omniweb crashes
			return false;
		}
		// set EnDeFile.version
		switch (typeof( kkk )) {
		  case 'string':    // for type TXT
			//bbb = kkk.match(/\n(?:(?:#\?\s)*@\(#\)\s*)([^\n]*)/);
			// we use a lazy regex to match string behind  @
			// NOTE that this matches the first occourance
			bbb = kkk.match(/@\(#\)\s*([^\n]*)/);
			if (bbb!==null) {
				EnDeFile.version = bbb[1];
			}
			break;
		  case 'object':    // for type XML
// ToDo: parse XML and extract SID (not yet defined there)
			break;
		}
		// set EnDeFile.content
		if (strip===false) {// get text as is
			EnDeFile.content = kkk;
			__dbx(' .content=['+typeof(EnDeFile.content)+']', '');
			// EnDeFile.lines.push(???); // ToDo: set to a usefull value
		} else {            // get text and remove comments and formating stuff
			EnDeFile.content = '';
			bux = kkk.split('\n');
			while ((bbb = bux.shift())!==undefined) {   // squeeze content
				idx++;
				if (EnDeFile.strip===true) {
					if (bbb.match(/^\s*#/)!==null) { continue; }// skip comments
					if (bbb.match(/^\s*$/)!==null) { continue; }// skip empty lines
				}
				EnDeFile.content += bbb + '\n';
				EnDeFile.lines.push(idx);
			}
			__dbx(' .content=[text]', '');
		}
		/* dummy { */ __dbx(' .content.length='+EnDeFile.content.length+', .lines='+EnDeFile.lines.length+' }');
		//#dbx alert('bux:\n'+EnDeFile.content);
		kkk = null;
		bbb = null;
		bux = null;
		return true;
	}; // __fileread

	// ===================================================================== //
	// public functions                                                      //
	// ===================================================================== //

	this.reset  = function(src) {
	//#? reset EnDeFile.* valiables
		while (this.lines.pop()!==undefined) {};
		this.name   = '';
		this.lines  = [];
		this.errors = [];
		this.content= null;
		this.version= '';
		this.strip  = true;
	}; // .reset

	this.local  = function(src) {
	//#? check if url is file:/// and then return url + src
		if (document.location.protocol!=='file:') { return src; }
		if (document.location.href.match(/^file:/)!==null) { return src; }
		return document.location.href.replace(/[?&].*$/,'').replace(/\/[^\/]*$/,'/') + src;
	}; // .local

	this.read   = function(src) {
	//#? read data from DOM object or file and store content in EnDeFile.content
		// returns true on success; false otherwise
		/* read data and removes comments and empty lines */
		var bux = false;
		if (document.getElementById(src)!==null) {  // if we have a DOM object ..
			bux = __fileread(this.local(src),'DOM',true,false,'');
			this.list.push([ 'DOM', bux, (bux===true)?this.lines.length:'', src, this.version ]);
		} else {
			bux = __fileread(this.local(src),'TXT',true,false,'');
			this.list.push([ 'TXT', bux, (bux===true)?this.lines.length:'', src, this.version ]);
		}
		return bux;
	}; // .read

	this.readTXT= function(src) {   // wrapper for __fileread()
	//#? read data from file and store content in EnDeFile.content
		/* read data and removes comments and empty lines */
		var bux = __fileread(this.local(src),'TXT',true,false,'text/plain');
		this.list.push([ 'TXT', bux, (bux===true)?this.lines.length:'', this.local(src), this.version ]);
		return bux;
	}; // .readTXT

	this.readXML= function(src) {   // wrapper for __fileread()
	//#? read data from file and store content in EnDeFile.content
		/* read data and removes comments and empty lines */
		var bux = __fileread(this.local(src),'XML',false,false,'');
		this.list.push([ 'XML', bux, (bux===true)?this.lines.length:'', this.local(src), this.version ]);
		return bux;
	}; // .readXML

}; // EnDeFile