//
// flash-check.js
//

// -----------------------------------------------------------------------------
// NOTE: FLASH_MIN_VERSION_STR may be re-initialized elsewhere, if you need
// a different min version. The format is: WIN 9,0,124,0 
// The leading OS ("WIN") is ignored

var FLASH_MIN_VERSION_STR = "WIN 9,0,124,0";
//var FLASH_MIN_RECOMMENDED_VERSION_STR = "WIN 10,0,45,2";
var FLASH_MIN_RECOMMENDED_VERSION_STR = "WIN 10,1,53,64";


// You must write a callback function that is called when the Flash version
// has been determined. The function has this signature:
//      void pMyStatusCallback(status)
//
// 'status' is one of the FlashCheck.STATUS_xxx constants, indicating whether
// the Flash version is OK, old, missing, or if the browser is not a supported
// browser.
//
// You can use FlashCheck.MIN_VERSION, FlashCheck.VERSION, and FlashCheck.HAS_MICROPHONE
// to determine Flash capabilities.

// To use the FlashCheck:
// (1) Embed flash movie 'test-flash-and-mic.swf' in the page, as shown here:
//     <script type="text/javascript">
//         var flashInfo = {
//             src: 'test-flash-and-mic.swf',
//             width: 1,
//             height: 1,
//             flashVars: '',
//             bgColor: 'white',
//             movieName: 'flashCheck'
//     };
//         embedFlash(flashInfo);
//     </script>
//
// (2) Define status callback function (see above).
// (3) In the document's onload handler, call FlashCheck.run(pMyStatusCallback).


// -----------------------------------------------------------------------------
// FlashVersion (parsed Flash version information)
// -----------------------------------------------------------------------------
function FlashVersion(versionStr /* e.g., "WIN 8,0,0,0" */) {
    this.valid = false;
    this.rawVersion = versionStr;
    this.os = null;
    this.majorVersion = 0;          
    this.minorVersion1 = 0;
    this.minorVersion2 = 0;
    this.minorVersion3 = 0;
    this.dottedVersion = null;
 
    // parse flash version
    var re = /^(.+)[ ]+([^ ]+)$/;
    var resultArray = re.exec(versionStr);
    if (resultArray) {
        this.os = resultArray[1];
        var commaStr = resultArray[2];
        var pieces = commaStr.split(',');
        this.majorVersion = pieces.length > 0 ? pieces[0] - 0 : 0;
        this.minorVersion1 = pieces.length > 1 ? pieces[1] - 0 : 0;
        this.minorVersion2 = pieces.length > 2 ? pieces[2] - 0 : 0;
        this.minorVersion3 = pieces.length > 3 ? pieces[3] - 0 : 0;
        this.dottedVersion = commaStr.replace(/,/g, '.');
        this.valid = this.majorVersion > 0;
    } 
}

FlashVersion.prototype.isValid = function() {
    return this.valid;
}

FlashVersion.prototype.getRawVersion = function() {
    return this.rawVersion;
}

FlashVersion.prototype.getDottedVersion = function() {
    return this.dottedVersion;
}

FlashVersion.prototype.toString = function() {
    return this.dottedVersion;
}

FlashVersion.prototype.compareTo = function(rhs) {
    if (!this.valid) {
        // always "less than" if not valid
        return -1;
    }
    if (!rhs || !rhs.valid) {
        return 1;
    }
    
    var diff;
    diff = this.majorVersion - rhs.majorVersion;
    if (diff) return diff;
    
    diff = this.minorVersion1 - rhs.minorVersion1;
    if (diff) return diff;
    
    diff = this.minorVersion2 - rhs.minorVersion2;
    if (diff) return diff;
    
    diff = this.minorVersion3 - rhs.minorVersion3;
    if (diff) return diff;
 
    return this.dottedVersion.localeCompare(rhs.dottedVersion);   
}


// -----------------------------------------------------------------------------
// FlashCheck (static methods)
// -----------------------------------------------------------------------------
function FlashCheck() {}    

FlashCheck.MIN_VERSION = new FlashVersion(FLASH_MIN_VERSION_STR);
FlashCheck.MIN_RECOMMENDED_VERSION = new FlashVersion(FLASH_MIN_RECOMMENDED_VERSION_STR);

FlashCheck.VERSION = null;     // gets created by callFromFlash
FlashCheck.HAS_MICROPHONE = false;
FlashCheck.LOADED = false;
FlashCheck.CALLBACK = null;
FlashCheck.STATUS = null;

FlashCheck.STATUS_OK = 'ok';                    // Browser OK, Flash player new enough
FlashCheck.STATUS_OLD_FLASH = 'old-flash';      // Browser OK, Flash player too old
FlashCheck.STATUS_NO_FLASH = 'no-flash';        // Browser OK, no Flash player (or pre-version 8 Flash player)
FlashCheck.STATUS_BAD_BROWSER = 'bad-browser';  // Browser not supported, no information about Flash player
FlashCheck.STATUS_NEED_IMMEDIATE_UPDATE = 'need-immediate-update';   // problem that hits Firefox and not-latest Flash
FlashCheck.STATUS_RECOMMEND_UPDATE = 'recommend-update';

FlashCheck._finishIfLoaded = function() {   // IfLoaded refers to the Flash movie, not the document
    if (FlashCheck.LOADED) {
        FlashCheck._finish();
    } else {
        window.setTimeout(FlashCheck._finishIfLoaded, 100);
    }
}

FlashCheck._deadline = function() {
    if (!FlashCheck.LOADED) {
        FlashCheck.LOADED = true;
    }
}
        
// FlashCheck.run must be called to get things started.
FlashCheck.run = function(pStatusCallback) {

    FlashCheck.CALLBACK = pStatusCallback;

    // if Flash is earlier than 8.0.0, it won't report back to Javascript 
    if (!DetectFlashVer(8, 0, 0)) { 
        FlashCheck.LOADED = true;
        var swfVersion = GetSwfVer();
        FlashCheck.VERSION = swfVersion != -1 ? new FlashVersion(swfVersion) : null;
        FlashCheck._finish();
    } else {
        FlashCheck._finishIfLoaded();
    }
}

FlashCheck._finish = function() {
    var isBrowserOK = isBrowserOKForClassroom();    // from browser-check.js
    var hasFlash = FlashCheck.VERSION != null;
    var isFlashNew = FlashCheck.VERSION != null && (FlashCheck.VERSION.compareTo(FlashCheck.MIN_VERSION) >= 0);
    
    var status;
    if (isBrowserOK && hasFlash && isFlashNew) {
    
        status = FlashCheck.STATUS_OK;

        // check if Flash is at least minimum recommended version
        if (FlashCheck.VERSION.compareTo(FlashCheck.MIN_RECOMMENDED_VERSION) < 0) {

            // for Firefox 3, display more urgent message
            var browser = new Browser();
            if (browser.type == Browser.TYPE_FIREFOX && browser.version >= 3) {
                // is Firefox 3 or later
                status = FlashCheck.STATUS_NEED_IMMEDIATE_UPDATE;
            } else {
                // is non-Firefox 3 browser
                status = FlashCheck.STATUS_RECOMMEND_UPDATE;
            }
        }
                    
    } else if (isBrowserOK && hasFlash) {   // == has flash, but it is too old
        status = FlashCheck.STATUS_OLD_FLASH; 
    } else if (isBrowserOK) { 
        status = FlashCheck.STATUS_NO_FLASH;
    } else {
        status = FlashCheck.STATUS_BAD_BROWSER;
    }
    
    FlashCheck.STATUS = status;
    if (FlashCheck.CALLBACK) {
        FlashCheck.CALLBACK(status);
    }        
}

// called from Flash if version is 8 or later - don't change function name
function callFromFlash(hasMic, rawVersionStr) {
    FlashCheck.VERSION = new FlashVersion(rawVersionStr);
    FlashCheck.HAS_MICROPHONE = hasMic ? true : false;
    FlashCheck.LOADED = true;
    //FlashCheck._finishIfLoaded();
}    


// -----------------------------------------------------------------------------
// Flash Player Version Detection - Rev 1.6
// Detect Client Browser type
// Copyright(c) 2005-2006 Adobe Macromedia Software, LLC. All rights reserved.
var isIE  = (navigator.appVersion.indexOf("MSIE") != -1) ? true : false;
var isWin = (navigator.appVersion.toLowerCase().indexOf("win") != -1) ? true : false;
var isOpera = (navigator.userAgent.indexOf("Opera") != -1) ? true : false;

function ControlVersion()
{
	var version;
	var axo;
	var e;

	// NOTE : new ActiveXObject(strFoo) throws an exception if strFoo isn't in the registry

	try {
		// version will be set for 7.X or greater players
		axo = new ActiveXObject("ShockwaveFlash.ShockwaveFlash.7");
		version = axo.GetVariable("$version");
	} catch (e) {
	}

	if (!version)
	{
		try {
			// version will be set for 6.X players only
			axo = new ActiveXObject("ShockwaveFlash.ShockwaveFlash.6");
			
			// installed player is some revision of 6.0
			// GetVariable("$version") crashes for versions 6.0.22 through 6.0.29,
			// so we have to be careful. 
			
			// default to the first public version
			version = "WIN 6,0,21,0";

			// throws if AllowScripAccess does not exist (introduced in 6.0r47)		
			axo.AllowScriptAccess = "always";

			// safe to call for 6.0r47 or greater
			version = axo.GetVariable("$version");

		} catch (e) {
		}
	}

	if (!version)
	{
		try {
			// version will be set for 4.X or 5.X player
			axo = new ActiveXObject("ShockwaveFlash.ShockwaveFlash.3");
			version = axo.GetVariable("$version");
		} catch (e) {
		}
	}

	if (!version)
	{
		try {
			// version will be set for 3.X player
			axo = new ActiveXObject("ShockwaveFlash.ShockwaveFlash.3");
			version = "WIN 3,0,18,0";
		} catch (e) {
		}
	}

	if (!version)
	{
		try {
			// version will be set for 2.X player
			axo = new ActiveXObject("ShockwaveFlash.ShockwaveFlash");
			version = "WIN 2,0,0,11";
		} catch (e) {
			version = -1;
		}
	}
	
	return version;
}

// JavaScript helper required to detect Flash Player PlugIn version information
function GetSwfVer(){
	// NS/Opera version >= 3 check for Flash plugin in plugin array
	var flashVer = -1;
	
	if (navigator.plugins != null && navigator.plugins.length > 0) {
		if (navigator.plugins["Shockwave Flash 2.0"] || navigator.plugins["Shockwave Flash"]) {
			var swVer2 = navigator.plugins["Shockwave Flash 2.0"] ? " 2.0" : "";
			var flashDescription = navigator.plugins["Shockwave Flash" + swVer2].description;
			var descArray = flashDescription.split(" ");
			var tempArrayMajor = descArray[2].split(".");			
			var versionMajor = tempArrayMajor[0];
			var versionMinor = tempArrayMajor[1];
			var versionRevision = descArray[3];
			if (versionRevision == "") {
				versionRevision = descArray[4];
			}
			if (versionRevision[0] == "d") {
				versionRevision = versionRevision.substring(1);
			} else if (versionRevision[0] == "r") {
				versionRevision = versionRevision.substring(1);
				if (versionRevision.indexOf("d") > 0) {
					versionRevision = versionRevision.substring(0, versionRevision.indexOf("d"));
				}
			}
			var flashVer = versionMajor + "." + versionMinor + "." + versionRevision;
		}
	}
	// MSN/WebTV 2.6 supports Flash 4
	else if (navigator.userAgent.toLowerCase().indexOf("webtv/2.6") != -1) flashVer = 4;
	// WebTV 2.5 supports Flash 3
	else if (navigator.userAgent.toLowerCase().indexOf("webtv/2.5") != -1) flashVer = 3;
	// older WebTV supports Flash 2
	else if (navigator.userAgent.toLowerCase().indexOf("webtv") != -1) flashVer = 2;
	else if ( isIE && isWin && !isOpera ) {
		flashVer = ControlVersion();
	}	
	return flashVer;
}

// When called with reqMajorVer, reqMinorVer, reqRevision returns true if that version or greater is available
function DetectFlashVer(reqMajorVer, reqMinorVer, reqRevision)
{
	versionStr = GetSwfVer();
	if (versionStr == -1 ) {
		return false;
	} else if (versionStr != 0) {
		if(isIE && isWin && !isOpera) {
			// Given "WIN 2,0,0,11"
			tempArray         = versionStr.split(" "); 	// ["WIN", "2,0,0,11"]
			tempString        = tempArray[1];			// "2,0,0,11"
			versionArray      = tempString.split(",");	// ['2', '0', '0', '11']
		} else {
			versionArray      = versionStr.split(".");
		}
		var versionMajor      = versionArray[0];
		var versionMinor      = versionArray[1];
		var versionRevision   = versionArray[2];

        	// is the major.revision >= requested major.revision AND the minor version >= requested minor
		if (versionMajor > parseFloat(reqMajorVer)) {
			return true;
		} else if (versionMajor == parseFloat(reqMajorVer)) {
			if (versionMinor > parseFloat(reqMinorVer))
				return true;
			else if (versionMinor == parseFloat(reqMinorVer)) {
				if (versionRevision >= parseFloat(reqRevision))
					return true;
			}
		}
		return false;
	}
}
