Umbraco-CMS/umbraco/presentation.ClientDependency/CompositeFileXmlMapper.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using System.Xml;
using System.IO;
using umbraco.presentation.ClientDependency.Config;

namespace umbraco.presentation.ClientDependency
{

	/// <summary>
	/// Creates an XML file to map a saved composite file to the URL requested for the 
	/// dependency handler. 
	/// This is used in order to determine which individual files are dependant on what composite file so 
	/// a user can remove it to clear the cache, and also if the cache expires but the file still exists
	/// this allows the system to simply read the one file again instead of compiling all of the other files
	/// into one again.
	/// </summary>
	public class CompositeFileXmlMapper
	{

		/// <summary>
		/// Singleton
		/// </summary>
		public static CompositeFileXmlMapper Instance
		{
			get
			{
				return m_Mapper;
			}
		}

		private CompositeFileXmlMapper()
		{
			Initialize();
		}

		private static readonly CompositeFileXmlMapper m_Mapper = new CompositeFileXmlMapper();

		private const string MapFileName = "map.xml";

		private XDocument m_Doc;
		private FileInfo m_XmlFile;
		private object m_Lock = new object();

		/// <summary>
		/// Loads in the existing file contents. If the file doesn't exist, it creates one.
		/// </summary>
		private void Initialize()
		{
			m_XmlFile = new FileInfo(
					Path.Combine(ClientDependencySettings.Instance.CompositeFilePath.FullName, MapFileName));

			EnsureXmlFile();

			lock (m_Lock)
			{
				try
				{
					m_Doc = XDocument.Load(m_XmlFile.FullName);
				}
				catch (XmlException ex)
				{
					//if it's an xml exception, create a new one and try one more time... should always work.
					CreateNewXmlFile();
					m_Doc = XDocument.Load(m_XmlFile.FullName);
				}
			}			
		}

		private void CreateNewXmlFile()
		{
			if (m_XmlFile.Exists)
				m_XmlFile.Delete();

			m_Doc = new XDocument(new XDeclaration("1.0", "UTF-8", "yes"),
											new XElement("map"));
			m_Doc.Save(m_XmlFile.FullName);
		}

		private void EnsureXmlFile()
		{
			if (!m_XmlFile.Exists)
			{
				lock (m_Lock)
				{
					//double check
					if (!m_XmlFile.Exists)
					{
						if (!ClientDependencySettings.Instance.CompositeFilePath.Exists)
							ClientDependencySettings.Instance.CompositeFilePath.Create();
						CreateNewXmlFile();
					}
				}
			}
		}

		/// <summary>
		/// Returns the composite file map associated with the base 64 key of the URL
		/// for the handler.
		/// </summary>
		/// <param name="base64Key"></param>
		/// <returns></returns>
		public CompositeFileMap GetCompositeFile(string base64Key)
		{
			XElement x = FindItem(base64Key);
			try
			{
				return (x == null ? null : new CompositeFileMap(base64Key,
				x.Attribute("compression").Value,
				x.Attribute("file").Value,
				x.Descendants("file")
					.Select(f => new FileInfo(f.Attribute("name").Value))
					.ToList()));
			}
			catch
			{
				return null;
			}			
		}

		/// <summary>
		/// 
		/// </summary>
		/// <param name="base64Key"></param>
		/// <param name="dependentFiles"></param>
		/// <param name="compositeFile"></param>
		/// <example>
		/// <![CDATA[
		/// <map>
		///		<item key="XSDFSDKJHLKSDIOUEYWCDCDSDOIUPOIUEROIJDSFHG" 
		///			file="C:\asdf\App_Data\ClientDependency\123456.cdj"
		///			compresion="deflate">
		///			<files>
		///				<file name="C:\asdf\JS\jquery.js" />
		///				<file name="C:\asdf\JS\jquery.ui.js" />		
		///			</files>
		///		</item>
		/// </map>
		/// ]]>
		/// </example>
		public void CreateMap(string base64Key, string compressionType, List<FileInfo> dependentFiles, string compositeFile)
		{
			lock (m_Lock)
			{
				//see if we can find an item with the key already
				XElement x = FindItem(base64Key);

				if (x != null)
				{
					x.Attribute("file").Value = compositeFile;
					//remove all of the files so we can re-add them.
					x.Element("files").Remove();

					x.Add(CreateFileNode(dependentFiles));
				}
				else
				{
					//if it doesn't exist, create it
					m_Doc.Root.Add(new XElement("item",
						new XAttribute("key", base64Key),
						new XAttribute("file", compositeFile),
						new XAttribute("compression", compressionType),
						CreateFileNode(dependentFiles)));
				}

				m_Doc.Save(m_XmlFile.FullName);
			}
		}

		private XElement FindItem(string key)
		{
			return m_Doc.Root.Elements("item")
					.Where(e => (string)e.Attribute("key") == key)
					.SingleOrDefault();
		}

		private XElement CreateFileNode(List<FileInfo> files)
		{
			XElement x = new XElement("files");

			//add all of the files
			files.ForEach(d =>
			{
				x.Add(new XElement("file",
					new XAttribute("name", d.FullName)));
			});

			return x;
		}
	}
}