mono/mcs/class/System.Web/System.Web.J2EE/PageMapper.cs

//
// (C) 2005 Mainsoft Corporation (http://www.mainsoft.com)
//

//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//

using System;
using System.Xml;
using System.IO;
using System.Collections;
using System.Web.Compilation;
using System.Collections.Specialized;
using System.Threading;
using vmw.common;
using System.Reflection;

namespace System.Web.J2EE
{
	/// <summary>
	/// Class that allows reading assemblies.xml file for getting information about different types.
	/// </summary>
	public class PageMapper
	{
		private static readonly string _fileListName = "/filelist.xml";
		private static readonly object LOCK_GETASSEMBLIESCACHEDDOCUMENT = new object();
		private static readonly object LOCK_GETFROMMAPPATHCACHE = new object();


		static Assembly CurrentDomain_AssemblyResolve (object sender, ResolveEventArgs args)
		{
			Assembly resolvedAssembly = null;
			try
			{
				resolvedAssembly = GetCachedAssembly (args.Name);
			}
			catch
			{
				resolvedAssembly = null;
			}

			return resolvedAssembly;
		}
		public static string GetFromMapPathCache(string key)
		{
			Hashtable answer = null;
			lock(LOCK_GETFROMMAPPATHCACHE)
			{
				answer = (Hashtable) AppDomain.CurrentDomain.GetData(J2EEConsts.MAP_PATH_CACHE);
				if (answer == null)
				{
					answer = new Hashtable();
					CachedDocumentTypeStorage storage = (CachedDocumentTypeStorage)GetAssembliesCachedDocument();
					IDictionaryEnumerator e = storage.GetEnumerator();
					e.Reset();
					while (e.MoveNext())
					{					
						string currentFile = (string)((DictionaryEntry)e.Current).Key;
						answer[currentFile]= IAppDomainConfig.WAR_ROOT_SYMBOL + currentFile;
					}
					AppDomain.CurrentDomain.SetData(J2EEConsts.MAP_PATH_CACHE,answer);

					AppDomain.CurrentDomain.AssemblyResolve += new ResolveEventHandler (CurrentDomain_AssemblyResolve);
					try
					{
						//Try to load the  global resources
						HttpContext.AppGlobalResourcesAssembly = GetCachedAssembly ("app_globalresources");
					}
					catch
					{
					}
				}
			}
			return (string)answer[key];
		}

#if UNUSED
		// UNUSED METHOD
		//The method was used by runtime to force file names casesensitivity
		// problem. The filelist.xml file should contain correct file names,
		// but currently it is unused
		public static void LoadFileList()
		{
			Hashtable hashTable = (Hashtable) AppDomain.CurrentDomain.GetData(J2EEConsts.FILE_LIST_FILE);
			if (hashTable == null)
			{
				XmlDocument doc;
				try
				{
					Stream fs = (Stream)IOUtils.getStream(_fileListName);
					if (fs == null)
					{
						AppDomain.CurrentDomain.SetData(J2EEConsts.FILE_LIST_FILE, new Hashtable());
						return;
					}

					doc = new XmlDocument();
					doc.Load(fs);
				}
				catch (Exception)
				{
//					Console.WriteLine("filelist.xml was not found!!!");
					AppDomain.CurrentDomain.SetData(J2EEConsts.FILE_LIST_FILE, new Hashtable());
					return;
				}
//				Console.WriteLine("filelist.xml was found!!!");
				if (doc != null && doc.DocumentElement.HasChildNodes)
				{
					hashTable = CollectionsUtil.CreateCaseInsensitiveHashtable();
					XmlNodeList nodeList = doc.DocumentElement.ChildNodes;
					for (int i = 0;i < nodeList.Count ; i++)
					{
						string fileName = nodeList.Item(i).InnerText;
						hashTable.Add(fileName,fileName);
					}
					AppDomain.CurrentDomain.SetData(J2EEConsts.FILE_LIST_FILE, hashTable);
				}
			}

		}
#endif
		private static ICachedXmlDoc GetAssembliesCachedDocument()
		{
			lock(LOCK_GETASSEMBLIESCACHEDDOCUMENT)
			{
				ICachedXmlDoc doc = (ICachedXmlDoc) AppDomain.CurrentDomain.GetData(J2EEConsts.ASSEMBLIES_FILE);
				if (doc == null)
				{
					doc = CreateDocument();
					if (doc != null)
						AppDomain.CurrentDomain.SetData(J2EEConsts.ASSEMBLIES_FILE, doc);
				}

				return doc;
			}
		}

		private static String NormalizeName(string url)
		{
#if NET_2_0
			url = System.Web.Util.UrlUtils.RemoveDoubleSlashes(url);
#endif 
			if (url.StartsWith(IAppDomainConfig.WAR_ROOT_SYMBOL))
				url = url.Substring(IAppDomainConfig.WAR_ROOT_SYMBOL.Length);
			return url;
		}
		private static ICachedXmlDoc CreateDocument()
		{
			return new CachedDocumentTypeStorage();
		}

		public static Type GetObjectType(string url)
		{
			return GetCachedType(NormalizeName(url), true);
		}

		public static Type GetObjectType (string url, bool throwException) {
			return GetCachedType (NormalizeName (url), throwException);
		}

		public static Assembly GetObjectAssembly(string url)
		{
			return GetCachedAssembly(NormalizeName(url));
		}
		public static string GetAssemblyResource(string url)
		{
			return GetCachedResource(NormalizeName(url));
		}
		private static string GetCachedResource(string url)
		{
			ICachedXmlDoc doc = PageMapper.GetAssembliesCachedDocument();
			return doc.GetAssemblyResourceName(url);
		}
		private static Assembly GetCachedAssembly(string url)
		{
			ICachedXmlDoc doc = PageMapper.GetAssembliesCachedDocument();
			Assembly t = doc.GetAssembly(url);
			if (t == null)
				throw new HttpException(404, "The requested resource (" + url + ") is not available.");

			return t;
		}
		private static Type GetCachedType (string url) {
			return GetCachedType (url, true);
		}
		private static Type GetCachedType (string url, bool throwException)
		{
			ICachedXmlDoc doc = PageMapper.GetAssembliesCachedDocument();						
			Type t = doc.GetType(url);
			if (t == null && throwException)
				throw new HttpException(404,"The requested resource (" + url + ") is not available.");

			return t;
		}

		#region ICachedXmlDoc interface
		interface ICachedXmlDoc
		{
			Type GetType(string key);
			Assembly GetAssembly(string key);
			string GetAssemblyResourceName(string key);
		}
		#endregion

		#region CachedDocumentTypeStorage class
		class CachedDocumentTypeStorage : ICachedXmlDoc
		{
			private static readonly object _fuse = new object();
			public static readonly ICachedXmlDoc DEFAULT_DOC =
				new CachedDocumentTypeStorage(0);

			private static readonly int DEFAULT_PAGES_NUMBER = 25;

			private Hashtable _table;

			private CachedDocumentTypeStorage(int initTableSize)
			{
				_table = Hashtable.Synchronized(new Hashtable(initTableSize));
			}

			public CachedDocumentTypeStorage() :
				this(DEFAULT_PAGES_NUMBER)
			{}

			string ICachedXmlDoc.GetAssemblyResourceName(string o)
			{
				return GetMetaByURL(o).Resource;
			}
			Type ICachedXmlDoc.GetType(string o)
			{
				return GetMetaByURL(o).Type;
			}
			Assembly ICachedXmlDoc.GetAssembly(string o)
			{
				return GetMetaByURL(o).Assembly;
			}

			internal IDictionaryEnumerator GetEnumerator()
			{
				return _table.GetEnumerator();				
			}	

			//rewamped for perfomance reasons
			//It looks like issue is not important in development mode,
			//but only will became important in production mode when dynamyc compilation will be enabled
			//Anyway, locking whole table and compiling under lock looks odd
			//spivak.December 07 2006
			public MetaProvider GetMetaByURL(string url)
			{

#if !NO_GLOBAL_LOCK_ON_COMPILE
				string lwUrl = url.ToLower();
				lock (_table)
				{
					object retVal = _table[lwUrl];
					if (retVal == null)
					{
						retVal = PageCompiler.GetCompiler(url);
						_table[lwUrl] = retVal;
					}
				
					return (MetaProvider)retVal;
				}

#else
				string lwUrl = url.ToLower();
				if (!_table.ContainsKey(lwUrl))
				{
					lock (_table.SyncRoot)
					{
						if (_table.ContainsKey(lwUrl))
							goto Fused;
						_table[lwUrl] = _fuse;
					}
					try
					{
						MetaProvider meta = PageCompiler.GetCompiler(url);
						lock (_table.SyncRoot)
						{
							return (MetaProvider)(_table[lwUrl] = meta);
						}
					}
					catch(Exception e)
					{
						_table.Remove(lwUrl);
					}
				}				
			Fused:
				
				while (_table[lwUrl] == _fuse) 
					Thread.Sleep(10);

				return !_table.ContainsKey(lwUrl)? PageCompiler.Error: (MetaProvider)_table[lwUrl];
#endif
			}
		}
		

		#endregion
	}

	public interface  MetaProvider
	{
		Type Type { get;}
		Assembly Assembly {get;}
		string Resource { get;}
	}
	public class PageCompiler : MetaProvider
	{
		private static readonly string PAGE_XPATH = "preserve";
		private static readonly string ASSEM_ATTRIB_NAME = "assem";
		private static readonly string TYPE_ATTRIB_NAME = "type";
		private static string _parser = null;
		private static PageCompiler _errorProvider = new PageCompiler();

		private Type _type = null;
		private string _typeName = null;
		private Assembly _assembly = null;
		private string _origAssemblyName = null;
		private string _xmlDescriptor = null;
		private string _url = null;
		private string _session = null;

		PageCompiler(string url)
		{
			_url = url;
			_xmlDescriptor = GetDescFromUrl();
			_session = DateTime.Now.Ticks.ToString();
			LoadTypeAndAssem();
		}
		PageCompiler()
		{
		}

		public static PageCompiler Error
		{
			get 
			{
				return _errorProvider; 
			}
		}
		public static PageCompiler GetCompiler(string url)
		{
			try{
				return new PageCompiler(url);
			}
			catch(Exception e)
			{
				return Error;
			}
		}

		Type MetaProvider.Type
		{
			get{
				return _type;
			}
		}
		Assembly MetaProvider.Assembly
		{
			get{
				return _assembly;
			}
		}
		string MetaProvider.Resource
		{
			get
			{
				return _origAssemblyName != null ? _origAssemblyName + ".ghres" : "dll.ghres";
			}
		}
		private void LoadTypeAndAssem()
		{
			if (_assembly == null)
			{
				string typeName = GetCachedTypeName();
				if (typeName != null)
				{
					if ((_type = Type.GetType(typeName)) != null)
						_assembly = _type.Assembly;
					else
						_assembly = Assembly.Load(_origAssemblyName);
				}
			}
		}
		private void InternalCompile()
		{
			string fileName = Path.GetFileName(_url);

			string fullFileName = (fileName.ToLower() == "global.asax") ? _url : HttpContext.Current.Request.MapPath(_url);
#if DEBUG
			Console.WriteLine("fullFileName=" + fullFileName);
#endif
			//type not found - run aspxparser
			if (File.Exists(fullFileName) || Directory.Exists(fullFileName))
			{
				string[] command = GetParserCmd(fileName.ToLower() == "global.asax");
				if (J2EEUtils.RunProc(command) != 0)
					throw GetCompilerError();
			}
			else
			{
				string message = "The requested resource (" + _url + ") is not available.";
				throw new HttpException(404, message);
			}
		}
		private string GetDescriptorPath()
		{
			return String.Join("/", new string[] { "assemblies", _xmlDescriptor });
		}
		private string GetTypeNameFromAppFolder()
		{
			try
			{
				using (StreamReader sr = new StreamReader(HttpContext.Current.Request.MapPath("/" + GetDescriptorPath())))
				{
					return GetTypeFromDescStream(sr.BaseStream);
				}
			}
			catch (Exception ex)
			{
				Console.WriteLine(ex);
				throw ex;
			}
		}
		internal string GetTypeFromResources()
		{
			string typeName = null;

			//if the desciptor exists in the war - get the type
			string descPath = GetDescriptorPath();

			try
			{
#if DEBUG
				Console.WriteLine(descPath);
#endif
				using (Stream fs = (Stream)IOUtils.getStreamRecursive("/" + descPath))
				{
					if (fs != null)
					{
						return GetTypeFromDescStream(fs);
					}
				}
			}
			catch (Exception ex)
			{
#if DEBUG
				Console.WriteLine(ex);
#endif
			}
			return null;
		}
		internal string GetCachedTypeName()
		{			
			string typeName = GetTypeFromResources();
			if (typeName == null)
			{
				//spawn dynamic compilation and lookup typename from created folder
				InternalCompile();
				typeName = GetTypeNameFromAppFolder();
			}
			return typeName;
		}
		private string GetTypeName()
		{
			return String.Format("{0}, {1}", _typeName, _origAssemblyName); 
		}
		private bool LoadMetaFromXmlStream(Stream fs)
		{
			if (fs != null)
			{
				try
				{
					XmlDocument descXml = new XmlDocument();
					descXml.Load(fs);
					_origAssemblyName = descXml.SelectSingleNode(PAGE_XPATH).Attributes[ASSEM_ATTRIB_NAME].Value;
					_typeName = descXml.SelectSingleNode(PAGE_XPATH).Attributes[TYPE_ATTRIB_NAME].Value;
					return true;
				}
				catch
				{
#if DEBUG
					Console.WriteLine("Failed to load typename from stream");
#endif
				}
			}
			return false;
		}

		private string GetTypeFromDescStream(Stream fs)
		{
			if (LoadMetaFromXmlStream(fs))
				return GetTypeName();
			return null;
		}

		private string[] GetParserCmd(bool globalAsax)
		{
            string[] cmd = null;			
            if (globalAsax)
            {
                cmd = new string[4];
                cmd[3] = "/buildglobalasax";
            }
            else
            {
                cmd = new string[5];
                cmd[3] = "/aspxFiles:" + _url;
                cmd[4] = "/compilepages";
            }
            cmd[0] = GetParser();
            cmd[1] = "/session:" + _session;
            cmd[2] = "/appDir:" + (string)AppDomain.CurrentDomain.GetData(IAppDomainConfig.APP_PHYS_DIR);
			return cmd;
		}

		private string GetParser()
		{
			if (_parser == null)
			{
				StreamReader sr =
					File.OpenText(HttpContext.Current.Request.MapPath("/AspxParser.params"));
				_parser = sr.ReadLine();
				sr.Close();
			}

			return _parser;
		}

		private string GetDescFromUrl()
		{
			string fileName = Path.GetFileName(_url);
			
			if (fileName.ToLower() == "global.asax")
				return "global.asax.xml";

			string id = GetIdFromUrl(_url);
			string[] descName = new string[3] {fileName, id, ".xml"} ;
			return string.Concat(descName).ToLower();
		}

		private string GetIdFromUrl(string path)
		{
			path = path.Trim('/');
			string fileName = Path.GetFileName(path);
			string id = string.Empty;

			path = path.Substring (path.IndexOf ("/") + 1);

			if (path.Length > fileName.Length)
				id = "." + path.Substring(0,path.Length - fileName.Length).Replace('/','_');
			return id;	
		}

		private Exception GetCompilerError()
		{
			string _errFile = HttpContext.Current.Request.MapPath("/" + _session + ".vmwerr");
			
			if (!File.Exists(_errFile))
				throw new FileNotFoundException("Internal Error",_errFile);

			StreamReader sr = new StreamReader(_errFile);
			string message = string.Empty, line = null, file = null, lineInFile = "0";

			while ((line = sr.ReadLine()) != null)
			{
				if (line.StartsWith("Message: "))
					message = line.Substring("Message: ".Length);
				else if (line.StartsWith("File: "))
					file = line.Substring("File: ".Length);
				else if (line.StartsWith("Line: "))
					lineInFile = line.Substring("Line: ".Length);
			}

			sr.Close();

			if (file != null)
			{
				Location loc = new Location(null);
				loc.Filename = file;
				loc.BeginLine = int.Parse(lineInFile);
				return new ParseException(loc,message);
			}

			if (message.IndexOf(typeof(FileNotFoundException).Name) != -1 &&
				message.IndexOf(_url.Trim('\\','/').Replace('/','\\')) != -1)
				message = "The requested resource (" + _url + ") is not available.";
			return new HttpException(404,(message !=  null ? message : string.Empty));
		}
	}
}