Upgrade ImageBank to general-purpose FileBank

net/systemeD/halcyon/FileBank.as

@@ -0,0 +1,173 @@
+package net.systemeD.halcyon {
+    import flash.events.*;
+	import flash.display.*;
+	import flash.net.*;
+	import flash.utils.ByteArray;
+	import nochump.util.zip.*;
+
+	/*
+		FileBank stores and retrieves bitmap images and other files.
+		Images are internally stored as Loader. Other files are stored as strings.
+
+		See blog.yoz.sk/2009/10/bitmap-bitmapdata-bytearray/ for a really useful conversion guide!
+	*/
+
+    public class FileBank extends EventDispatcher{
+		private var files:Object={};
+		private var filesRequested:uint=0;
+		private var filesReceived:uint=0;
+
+		public static const FILES_LOADED:String="filesLoaded";
+		public static const ZIP_LOADED:String="zipLoaded";
+
+		private static const GLOBAL_INSTANCE:FileBank = new FileBank();
+		public static function getInstance():FileBank { return GLOBAL_INSTANCE; }
+
+		public function hasFile(name:String):Boolean {
+			if (files[name]) return true;
+			return false;
+		}
+
+		/* ==========================================================================================
+		   Add an individual file to bank (not from a .zip file)
+		   Used when we want to load a file for use later on (e.g. an image referenced in a stylesheet)
+		   ========================================================================================== */
+
+		public function addFromFile(filename:String):void {
+			if (files[filename]) return;
+			filesRequested++;
+
+			var request:URLRequest=new URLRequest(filename);
+			if (isImageType(filename)) {
+				var loader:Loader=new Loader();
+				files[filename]=loader;
+				loader.contentLoaderInfo.addEventListener(Event.COMPLETE,						loadedImage);
+				loader.contentLoaderInfo.addEventListener(HTTPStatusEvent.HTTP_STATUS,			httpStatusHandler);
+				loader.contentLoaderInfo.addEventListener(SecurityErrorEvent.SECURITY_ERROR,	securityErrorHandler);
+				loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR,				ioErrorHandler);
+				loader.load(request);
+			} else {
+				var urlloader:URLLoader = new URLLoader();
+				urlloader.addEventListener(Event.COMPLETE,                    loadedImage);
+				urlloader.addEventListener(HTTPStatusEvent.HTTP_STATUS,		  httpStatusHandler);
+				urlloader.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);
+				urlloader.addEventListener(IOErrorEvent.IO_ERROR,             ioErrorHandler);
+				urlloader.load(request);
+			}
+		}
+
+		private function loadedImage(event:Event):void {
+			fileReceived();
+		}
+		private function httpStatusHandler(event:HTTPStatusEvent):void { }
+		private function securityErrorHandler(event:SecurityErrorEvent):void { 
+			trace("securityErrorEvent: "+event.target.url);
+			fileReceived();
+		}
+		private function ioErrorHandler(event:IOErrorEvent):void { 
+			trace("ioErrorEvent: "+event.target.url); 
+			fileReceived();
+		}
+		private function fileReceived():void {
+			filesReceived++;
+			if (filesReceived==filesRequested) { dispatchEvent(new Event(FILES_LOADED)); }
+		}
+
+		/* ==========================================================================================
+		   Add files to bank from .zip file
+		   ========================================================================================== */
+
+		public function addFromZip(filename:String, prefix:String=""):void {
+			var loader:URLLoader = new URLLoader();
+			loader.dataFormat="binary";
+			loader.addEventListener(Event.COMPLETE, function(e:Event):void { zipReady(e,prefix); } );
+			loader.load(new URLRequest(filename));
+		}
+		private function zipReady(event:Event, prefix:String):void {
+			var zip:ZipFile = new ZipFile(event.target.data);
+			for (var i:uint=0; i<zip.entries.length; i++) {
+				var fileref:ZipEntry = zip.entries[i];
+				var data:ByteArray = zip.getInput(fileref);
+				if (isImageType(fileref.name)) {
+					// Store as an image
+					var loader:Loader=new Loader();
+					files[prefix+fileref.name]=loader;
+					loader.loadBytes(data);
+				} else {
+					// Store as a document
+					files[prefix+fileref.name]=data.toString();
+				}
+			}
+			dispatchEvent(new Event(ZIP_LOADED));
+		}
+		private function isImageType(filename:String):Boolean {
+			if (filename.match(/\.jpe?g$/i) ||
+				filename.match(/\.png$/i) ||
+				filename.match(/\.gif$/i) ||
+				filename.match(/\.swf$/i)) { return true; }
+			return false;
+		}
+
+		/* ==========================================================================================
+		   Get files
+		   get(filename)
+		   getAsDisplayObject(filename)
+		   getAsBitmapData(filename)
+		   getAsByteArray(filename)
+		   ========================================================================================== */
+
+		public function get(name:String):String {
+			return files[name];
+		}
+
+		public function getAsDisplayObject(name:String):DisplayObject {
+			/* If the image hasn't loaded yet, then add an EventListener for when it does. */
+			if (getWidth(name)==0) {
+				var loader:Loader = new Loader();
+				files[name].contentLoaderInfo.addEventListener(Event.COMPLETE,
+					function(e:Event):void { loaderReady(e, loader) });
+				return loader;
+			}
+			/* Otherwise, create a new Bitmap, because just returning the raw Loader
+		 	   (i.e. files[name]) would only allow it to be added to one parent. (The other 
+			   way to do this would be by copying the bytes as loaderReady does.). */
+			return new Bitmap(getAsBitmapData(name));
+		}
+
+		public function getOriginalDisplayObject(name:String):DisplayObject {
+			/* But if we're going to clone it later, this'll work fine. */
+			return files[name];
+		}
+
+		private function loaderReady(event:Event, loader:Loader):void {
+			/* The file has loaded, so we can copy the data from there into our new Loader */
+			var info:LoaderInfo = event.target as LoaderInfo;
+			loader.loadBytes(info.bytes);
+		}
+
+		public function getAsBitmapData(name:String):BitmapData {
+			var bitmapData:BitmapData=new BitmapData(getWidth(name), getHeight(name), true, 0xFFFFFF);
+			bitmapData.draw(files[name]);
+			return bitmapData;
+		}
+
+		public function getAsByteArray(name:String):ByteArray {
+			return files[name].contentLoaderInfo.bytes;
+		}
+
+		/* ==========================================================================================
+		   Get file information
+		   ========================================================================================== */
+
+		public function getWidth(name:String):int { 
+			try { return files[name].contentLoaderInfo.width; }
+			catch (error:Error) { } return 0;
+		}
+
+		public function getHeight(name:String):int { 
+			try { return files[name].contentLoaderInfo.height; }
+			catch (error:Error) { } return 0;
+		}
+
+	}
+}