ConfuserContext.cs

using System;
using System.Collections.Generic;
using System.Threading;
using Confuser.Core.Project;
using dnlib.DotNet;
using dnlib.DotNet.Writer;
using Microsoft.Extensions.Logging;

namespace Confuser.Core {
	/// <summary>
	///     Context providing information on the current protection process.
	/// </summary>
	public class ConfuserContext {
		readonly Annotations annotations = new Annotations();
		readonly ServiceRegistry registry = new ServiceRegistry();
		internal CancellationToken token;

		/// <summary>
		///     Gets the logger used for logging events.
		/// </summary>
		/// <value>The logger.</value>
		public Microsoft.Extensions.Logging.ILogger Logger { get; internal set; }

		/// <summary>
		///     Gets the progress reporter used for reporting protection progress.
		/// </summary>
		/// <value>The progress reporter.</value>
		public IProgressReporter ProgressReporter { get; internal set; }

		/// <summary>
		///     Gets the project being processed.
		/// </summary>
		/// <value>The project.</value>
		public ConfuserProject Project { get; internal set; }

		internal bool PackerInitiated { get; set; }

		/// <summary>
		///     Gets the annotation storage.
		/// </summary>
		/// <value>The annotation storage.</value>
		public Annotations Annotations {
			get { return annotations; }
		}

		/// <summary>
		///     Gets the service registry.
		/// </summary>
		/// <value>The service registry.</value>
		public ServiceRegistry Registry {
			get { return registry; }
		}

		/// <summary>
		///     Gets the assembly resolver.
		/// </summary>
		/// <value>The assembly resolver.</value>
		public IAssemblyResolver Resolver => InternalResolver;

		/// <summary>
		///     Gets the assembly resolver.
		/// </summary>
		/// <value>The assembly resolver.</value>
		internal ConfuserAssemblyResolver InternalResolver { get; set; }

		/// <summary>
		///     Gets the modules being protected.
		/// </summary>
		/// <value>The modules being protected.</value>
		public IList<ModuleDefMD> Modules { get; internal set; }

		/// <summary>
		///     Gets the external modules.
		/// </summary>
		/// <value>The external modules.</value>
		public IList<byte[]> ExternalModules { get; internal set; }

		/// <summary>
		///     Gets the base directory.
		/// </summary>
		/// <value>The base directory.</value>
		public string BaseDirectory { get; internal set; }

		/// <summary>
		///     Gets the output directory.
		/// </summary>
		/// <value>The output directory.</value>
		public string OutputDirectory { get; internal set; }

		/// <summary>
		///     Gets the packer.
		/// </summary>
		/// <value>The packer.</value>
		public Packer Packer { get; internal set; }

		/// <summary>
		///     Gets the current processing pipeline.
		/// </summary>
		/// <value>The processing pipeline.</value>
		public ProtectionPipeline Pipeline { get; internal set; }

		/// <summary>
		///     Gets the <c>byte[]</c> of modules after protected, or null if module is not protected yet.
		/// </summary>
		/// <value>The list of <c>byte[]</c> of protected modules.</value>
		public IList<byte[]> OutputModules { get; internal set; }

		/// <summary>
		///     Gets the <c>byte[]</c> of module debug symbols after protected, or null if module is not protected yet.
		/// </summary>
		/// <value>The list of <c>byte[]</c> of module debug symbols.</value>
		public IList<byte[]> OutputSymbols { get; internal set; }

		/// <summary>
		///     Gets the relative output paths of module, or null if module is not protected yet.
		/// </summary>
		/// <value>The relative output paths of protected modules.</value>
		public IList<string> OutputPaths { get; internal set; }

		/// <summary>
		///     Gets the current module index.
		/// </summary>
		/// <value>The current module index.</value>
		public int CurrentModuleIndex { get; internal set; }

		/// <summary>
		///     Gets the current module.
		/// </summary>
		/// <value>The current module.</value>
		public ModuleDefMD CurrentModule {
			get { return CurrentModuleIndex == -1 ? null : Modules[CurrentModuleIndex]; }
		}

		/// <summary>
		///     Gets the writer options of the current module.
		/// </summary>
		/// <value>The writer options.</value>
		public ModuleWriterOptionsBase CurrentModuleWriterOptions { get; internal set; }

		/// <summary>
		///     Gets output <c>byte[]</c> of the current module
		/// </summary>
		/// <value>The output <c>byte[]</c>.</value>
		public byte[] CurrentModuleOutput { get; internal set; }

		/// <summary>
		///     Gets output <c>byte[]</c> debug symbol of the current module
		/// </summary>
		/// <value>The output <c>byte[]</c> debug symbol.</value>
		public byte[] CurrentModuleSymbol { get; internal set; }

		/// <summary>
		///		Gets the token used to indicate cancellation
		/// </summary>
		public CancellationToken CancellationToken { get { return token; } }

		/// <summary>
		///     Throws a System.OperationCanceledException if protection process has been canceled.
		/// </summary>
		/// <exception cref="OperationCanceledException">
		///     The protection process is canceled.
		/// </exception>
		public void CheckCancellation() {
			token.ThrowIfCancellationRequested();
		}

		/// <summary>
		///     Requests the current module to be written as mix-mode module, and return the native writer options.
		/// </summary>
		/// <returns>The native writer options.</returns>
		public NativeModuleWriterOptions RequestNative(bool optimizeImageSize) {
			if (CurrentModule == null)
				return null;
			if (CurrentModuleWriterOptions == null)
				CurrentModuleWriterOptions = new NativeModuleWriterOptions(CurrentModule, optimizeImageSize);

			// Clone the current options to the new options
			var newOptions = new NativeModuleWriterOptions(CurrentModule, optimizeImageSize) {
				AddCheckSum = CurrentModuleWriterOptions.AddCheckSum,
				AddMvidSection = CurrentModuleWriterOptions.AddMvidSection,
				Cor20HeaderOptions = CurrentModuleWriterOptions.Cor20HeaderOptions,
				GetPdbContentId = CurrentModuleWriterOptions.GetPdbContentId,
				Logger = CurrentModuleWriterOptions.Logger,
				MetadataLogger = CurrentModuleWriterOptions.MetadataLogger,
				MetadataOptions = CurrentModuleWriterOptions.MetadataOptions,
				ModuleKind = CurrentModuleWriterOptions.ModuleKind,
				NoWin32Resources = CurrentModuleWriterOptions.NoWin32Resources,
				PdbChecksumAlgorithm = CurrentModuleWriterOptions.PdbChecksumAlgorithm,
				PdbFileName = CurrentModuleWriterOptions.PdbFileName,
				PdbFileNameInDebugDirectory = CurrentModuleWriterOptions.PdbFileNameInDebugDirectory,
				PdbOptions = CurrentModuleWriterOptions.PdbOptions,
				PdbStream = CurrentModuleWriterOptions.PdbStream,
				PEHeadersOptions = CurrentModuleWriterOptions.PEHeadersOptions,
				ShareMethodBodies = CurrentModuleWriterOptions.ShareMethodBodies,
				DelaySign = CurrentModuleWriterOptions.DelaySign,
				StrongNameKey = CurrentModuleWriterOptions.StrongNameKey,
				StrongNamePublicKey = CurrentModuleWriterOptions.StrongNamePublicKey,
				Win32Resources = CurrentModuleWriterOptions.Win32Resources,
				WritePdb = CurrentModuleWriterOptions.WritePdb,
			};
			CurrentModuleWriterOptions = newOptions;
			return newOptions;
		}
	}
}