xamarin-macios/msbuild/Xamarin.MacDev.Tasks.Core/Tasks/UnpackLibraryResourcesTaskBase.cs

using System;
using System.IO;
using System.Text;
using System.Collections.Generic;

using Microsoft.Build.Framework;
using Microsoft.Build.Utilities;
using Xamarin.Localization.MSBuild;

namespace Xamarin.MacDev.Tasks
{
	public abstract class UnpackLibraryResourcesTaskBase : XamarinTask
	{
		List<ITaskItem> unpackedResources = new List<ITaskItem> ();
		
		#region Inputs

		[Required]
		public string Prefix { get; set; }

		[Required]
		public ITaskItem[] NoOverwrite { get; set; }
		
		[Required]
		public string IntermediateOutputPath { get; set; }

		[Required]
		public ITaskItem[] ReferencedLibraries { get; set; }

		[Required]
		public ITaskItem[] TargetFrameworkDirectory { get; set; }

		#endregion

		#region Outputs

		[Output]
		public ITaskItem[] BundleResourcesWithLogicalNames { get; set; }

		[Output]
		public ITaskItem[] UnpackedResources { get; set; }

		#endregion

		public override bool Execute ()
		{
			// TODO: give each assembly its own intermediate output directory
			// TODO: use list file to avoid re-extracting assemblies but allow FileWrites to work
			var results = new List<ITaskItem> ();
			HashSet<string> ignore = null;

			foreach (var asm in ReferencedLibraries) {
				// mscorlib.dll was not coming out with ResolvedFrom == {TargetFrameworkDirectory}
				// and what we really care is where it comes from, not how it was resolved
				if (IsFrameworkAssembly (asm)) {
					Log.LogMessage (MessageImportance.Low, MSBStrings.M0168, asm.ItemSpec);
				} else {
					var extracted = ExtractContentAssembly (asm.ItemSpec, IntermediateOutputPath);

					foreach (var bundleResource in extracted) {
						string logicalName;

						if (ignore == null) {
							// Create a hashset of the bundle resources that should not be overwritten by extracted resources
							// from the referenced assemblies.
							//
							// See https://bugzilla.xamarin.com/show_bug.cgi?id=8409 for details.
							ignore = new HashSet<string> ();

							foreach (var item in NoOverwrite) {
								logicalName = item.GetMetadata ("LogicalName");
								if (string.IsNullOrEmpty (logicalName))
									ignore.Add (logicalName);
							}
						}

						logicalName = bundleResource.GetMetadata ("LogicalName");
						if (!ignore.Contains (logicalName))
							results.Add (bundleResource);
					}
				}
			}

			BundleResourcesWithLogicalNames = results.ToArray ();
			UnpackedResources = unpackedResources.ToArray ();

			return !Log.HasLoggedErrors;
		}

		bool IsFrameworkAssembly (ITaskItem asm)
		{
			var asm_path = asm.GetMetadata ("FullPath");
			foreach (var dir in TargetFrameworkDirectory) {
				if (asm_path.StartsWith (dir.GetMetadata ("FullPath"), StringComparison.OrdinalIgnoreCase))
					return true;
			}
			return false;
		}

		IEnumerable<ITaskItem> ExtractContentAssembly (string assembly, string intermediatePath)
		{
			Log.LogMessage (MessageImportance.Low, "  Inspecting assembly: {0}", assembly);

			if (!File.Exists (assembly))
				yield break;

			var asmWriteTime = File.GetLastWriteTimeUtc (assembly);

			foreach (var embedded in GetAssemblyManifestResources (assembly)) {
				string rpath;

				if (embedded.Name.StartsWith ("__" + Prefix + "_content_", StringComparison.Ordinal)) {
					var mangled = embedded.Name.Substring (("__" + Prefix + "_content_").Length);
					rpath = UnmangleResource (mangled);
				} else if (embedded.Name.StartsWith ("__" + Prefix + "_page_", StringComparison.Ordinal)) {
					var mangled = embedded.Name.Substring (("__" + Prefix + "_page_").Length);
					rpath = UnmangleResource (mangled);
				} else {
					continue;
				}

				var path = Path.Combine (intermediatePath, rpath);
				var file = new FileInfo (path);

				var item = new TaskItem (path);
				item.SetMetadata ("LogicalName", rpath);
				item.SetMetadata ("Optimize", "false");

				if (file.Exists && file.LastWriteTimeUtc >= asmWriteTime) {
					Log.LogMessage ("    Up to date: {0}", rpath);
				} else {
					Log.LogMessage ("    Unpacking: {0}", rpath);

					Directory.CreateDirectory (Path.GetDirectoryName (path));

					using (var stream = File.Open (path, FileMode.Create)) {
						using (var resource = embedded.Open ())
							resource.CopyTo (stream);
					}

					unpackedResources.Add (item);
				}

				yield return item;
			}

			yield break;
		}

		// FIXME: Using cecil for now, due to not having IKVM available in the mtbserver build.
		//  Eventually, we will want to prefer IKVM over cecil if we can work out the build in a sane way.
		/*
		static IEnumerable<ManifestResource> GetAssemblyManifestResources (string fileName)
		{
			using (var universe = new IKVM.Reflection.Universe ()) {
				IKVM.Reflection.Assembly assembly;
				try {
					assembly = universe.LoadFile (fileName);
				} catch {
					yield break;
				}
				foreach (var _r in assembly.GetManifestResourceNames ()) {
					var r = _r;
					yield return new ManifestResource (r, () => assembly.GetManifestResourceStream (r));
				}
			}
		}
		*/

		protected abstract IEnumerable<ManifestResource> GetAssemblyManifestResources (string fileName);

		static string UnmangleResource (string mangled)
		{
			var unmangled = new StringBuilder (mangled.Length);
			bool escaped = false;

			for (int i = 0; i < mangled.Length; i++) {
				char c = mangled[i];

				if (c == '_' && !escaped) {
					escaped = true;
					continue;
				}

				if (escaped) {
					switch (c) {
					case 'b': c = '\\'; break;
					case 'f': c = '/'; break;
					case '_': c = '_'; break;
					default: throw new FormatException ("Invalid resource name: " + mangled);
					}

					escaped = false;
				}

				unmangled.Append (c);
			}

			if (escaped)
				throw new FormatException ("Invalid resource name: " + mangled);

			return unmangled.ToString ();
		}

		public class ManifestResource
		{
			readonly Func<Stream> callback;

			public ManifestResource (string name, Func<Stream> streamCallback)
			{
				callback = streamCallback;
				Name = name;
			}

			public string Name {
				get; private set;
			}

			public Stream Open ()
			{
				return callback ();
			}
		}
	}
}