2 // ResolveAssemblyReference.cs: Searches for assembly files.
5 // Marek Sieradzki (marek.sieradzki@gmail.com)
6 // Ankit Jain (jankit@novell.com)
8 // (C) 2006 Marek Sieradzki
9 // Copyright 2009 Novell, Inc (http://www.novell.com)
11 // Permission is hereby granted, free of charge, to any person obtaining
12 // a copy of this software and associated documentation files (the
13 // "Software"), to deal in the Software without restriction, including
14 // without limitation the rights to use, copy, modify, merge, publish,
15 // distribute, sublicense, and/or sell copies of the Software, and to
16 // permit persons to whom the Software is furnished to do so, subject to
17 // the following conditions:
19 // The above copyright notice and this permission notice shall be
20 // included in all copies or substantial portions of the Software.
22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33 using System.Collections.Generic;
34 using System.Globalization;
37 using System.Reflection;
38 using System.Security;
39 using Microsoft.Build.Framework;
40 using Microsoft.Build.Utilities;
42 namespace Microsoft.Build.Tasks {
43 public class ResolveAssemblyReference : TaskExtension {
46 ITaskItem[] assemblyFiles;
47 ITaskItem[] assemblies;
49 string[] allowedAssemblyExtensions;
50 string[] allowedRelatedFileExtensions;
51 string[] candidateAssemblyFiles;
52 ITaskItem[] copyLocalFiles;
53 ITaskItem[] filesWritten;
54 bool findDependencies;
55 bool findRelatedFiles;
57 bool findSerializationAssemblies;
58 string[] installedAssemblyTables;
59 ITaskItem[] relatedFiles;
60 ITaskItem[] resolvedDependencyFiles;
61 ITaskItem[] resolvedFiles;
62 ITaskItem[] satelliteFiles;
63 ITaskItem[] scatterFiles;
65 ITaskItem[] serializationAssemblyFiles;
68 ITaskItem[] suggestedRedirects;
69 string[] targetFrameworkDirectories;
70 string targetProcessorArchitecture;
71 static string [] default_assembly_extensions;
73 AssemblyResolver assembly_resolver;
74 List<string> dependency_search_paths;
75 Dictionary<string, ResolvedReference> assemblyNameToResolvedRef;
76 Dictionary<string, ITaskItem> tempSatelliteFiles, tempRelatedFiles,
77 tempResolvedDepFiles, tempCopyLocalFiles;
78 List<ITaskItem> tempResolvedFiles;
79 List<PrimaryReference> primaryReferences;
80 Dictionary<string, string> alreadyScannedAssemblyNames;
81 Dictionary<string, string> conflictWarningsCache;
83 //FIXME: construct and use a graph of the dependencies, useful across projects
85 static ResolveAssemblyReference ()
87 default_assembly_extensions = new string [] { ".dll", ".exe" };
90 public ResolveAssemblyReference ()
92 assembly_resolver = new AssemblyResolver ();
95 //FIXME: make this reusable
96 public override bool Execute ()
98 if (assemblies == null && assemblyFiles == null)
102 LogTaskParameters ();
104 assembly_resolver.Log = Log;
105 tempResolvedFiles = new List<ITaskItem> ();
106 tempCopyLocalFiles = new Dictionary<string, ITaskItem> ();
107 tempSatelliteFiles = new Dictionary<string, ITaskItem> ();
108 tempRelatedFiles = new Dictionary<string, ITaskItem> ();
109 tempResolvedDepFiles = new Dictionary<string, ITaskItem> ();
111 primaryReferences = new List<PrimaryReference> ();
112 assemblyNameToResolvedRef = new Dictionary<string, ResolvedReference> ();
113 conflictWarningsCache = new Dictionary<string, string> ();
115 ResolveAssemblies ();
116 ResolveAssemblyFiles ();
117 resolvedFiles = tempResolvedFiles.ToArray ();
119 alreadyScannedAssemblyNames = new Dictionary<string, string> ();
121 // the first element is place holder for parent assembly's dir
122 dependency_search_paths = new List<string> () { String.Empty };
123 dependency_search_paths.AddRange (searchPaths);
125 // resolve dependencies
126 foreach (PrimaryReference pref in primaryReferences)
127 ResolveAssemblyFileDependencies (pref.TaskItem, pref.ParentCopyLocal);
129 copyLocalFiles = tempCopyLocalFiles.Values.ToArray ();
130 satelliteFiles = tempSatelliteFiles.Values.ToArray ();
131 relatedFiles = tempRelatedFiles.Values.ToArray ();
132 resolvedDependencyFiles = tempResolvedDepFiles.Values.ToArray ();
134 tempResolvedFiles.Clear ();
135 tempCopyLocalFiles.Clear ();
136 tempSatelliteFiles.Clear ();
137 tempRelatedFiles.Clear ();
138 tempResolvedDepFiles.Clear ();
139 alreadyScannedAssemblyNames.Clear ();
140 primaryReferences.Clear ();
141 assemblyNameToResolvedRef.Clear ();
142 conflictWarningsCache.Clear ();
143 dependency_search_paths = null;
148 void ResolveAssemblies ()
150 if (assemblies == null || assemblies.Length == 0)
153 foreach (ITaskItem item in assemblies) {
154 if (!String.IsNullOrEmpty (item.GetMetadata ("SubType"))) {
155 Log.LogWarning ("Reference '{0}' has non-empty SubType. Ignoring.", item.ItemSpec);
159 LogWithPrecedingNewLine (MessageImportance.Low, "Primary Reference {0}", item.ItemSpec);
160 ResolvedReference resolved_ref = ResolveReference (item, searchPaths, true);
161 if (resolved_ref == null) {
162 Log.LogWarning ("Reference '{0}' not resolved", item.ItemSpec);
163 assembly_resolver.LogSearchLoggerMessages (MessageImportance.Normal);
165 Log.LogMessage (MessageImportance.Low,
166 "\tReference {0} resolved to {1}. CopyLocal = {2}",
167 item.ItemSpec, resolved_ref.TaskItem,
168 resolved_ref.TaskItem.GetMetadata ("CopyLocal"));
170 Log.LogMessage (MessageImportance.Low,
171 "\tReference found at search path {0}",
172 resolved_ref.FoundInSearchPathAsString);
174 assembly_resolver.LogSearchLoggerMessages (MessageImportance.Low);
176 if (TryAddNewReference (tempResolvedFiles, resolved_ref) &&
177 !IsFromGacOrTargetFramework (resolved_ref) &&
178 resolved_ref.FoundInSearchPath != SearchPath.PkgConfig) {
179 primaryReferences.Add (new PrimaryReference (
180 resolved_ref.TaskItem,
181 resolved_ref.TaskItem.GetMetadata ("CopyLocal")));
187 // Use @search_paths to resolve the reference
188 ResolvedReference ResolveReference (ITaskItem item, IEnumerable<string> search_paths, bool set_copy_local)
190 ResolvedReference resolved = null;
191 bool specific_version;
193 assembly_resolver.ResetSearchLogger ();
195 if (!TryGetSpecificVersionValue (item, out specific_version))
198 foreach (string spath in search_paths) {
199 assembly_resolver.LogSearchMessage ("For searchpath {0}", spath);
201 if (String.Compare (spath, "{HintPathFromItem}") == 0) {
202 resolved = assembly_resolver.ResolveHintPathReference (item, specific_version);
203 } else if (String.Compare (spath, "{TargetFrameworkDirectory}") == 0) {
204 if (targetFrameworkDirectories == null)
206 foreach (string fpath in targetFrameworkDirectories) {
207 resolved = assembly_resolver.FindInTargetFramework (item,
208 fpath, specific_version);
209 if (resolved != null)
212 } else if (String.Compare (spath, "{GAC}") == 0) {
213 resolved = assembly_resolver.ResolveGacReference (item, specific_version);
214 } else if (String.Compare (spath, "{RawFileName}") == 0) {
215 //FIXME: identify assembly names, as extract the name, and try with that?
217 if (assembly_resolver.TryGetAssemblyNameFromFile (item.ItemSpec, out aname))
218 resolved = assembly_resolver.GetResolvedReference (item, item.ItemSpec, aname, true,
219 SearchPath.RawFileName);
220 } else if (String.Compare (spath, "{CandidateAssemblyFiles}") == 0) {
221 assembly_resolver.LogSearchMessage (
222 "Warning: {{CandidateAssemblyFiles}} not supported currently");
223 } else if (String.Compare (spath, "{PkgConfig}") == 0) {
224 resolved = assembly_resolver.ResolvePkgConfigReference (item, specific_version);
226 resolved = assembly_resolver.FindInDirectory (
228 allowedAssemblyExtensions ?? default_assembly_extensions,
232 if (resolved != null)
236 if (resolved != null && set_copy_local)
237 SetCopyLocal (resolved.TaskItem, resolved.CopyLocal.ToString ());
242 bool TryGetSpecificVersionValue (ITaskItem item, out bool specific_version)
244 specific_version = true;
245 string value = item.GetMetadata ("SpecificVersion");
246 if (String.IsNullOrEmpty (value)) {
247 //AssemblyName name = new AssemblyName (item.ItemSpec);
248 // If SpecificVersion is not specified, then
249 // it is true if the Include is a strong name else false
250 //specific_version = assembly_resolver.IsStrongNamed (name);
252 // msbuild seems to just look for a ',' in the name :/
253 specific_version = item.ItemSpec.IndexOf (',') >= 0;
257 if (Boolean.TryParse (value, out specific_version))
260 Log.LogError ("Item '{0}' has attribute SpecificVersion with invalid value '{1}' " +
261 "which could not be converted to a boolean.", item.ItemSpec, value);
265 //FIXME: Consider CandidateAssemblyFiles also here
266 void ResolveAssemblyFiles ()
268 if (assemblyFiles == null)
271 foreach (ITaskItem item in assemblyFiles) {
272 assembly_resolver.ResetSearchLogger ();
274 if (!File.Exists (item.ItemSpec)) {
275 LogWithPrecedingNewLine (MessageImportance.Low,
276 "Primary Reference from AssemblyFiles {0}, file not found. Ignoring",
281 LogWithPrecedingNewLine (MessageImportance.Low, "Primary Reference from AssemblyFiles {0}", item.ItemSpec);
285 if (!assembly_resolver.TryGetAssemblyNameFromFile (item.ItemSpec, out aname)) {
286 Log.LogWarning ("Reference '{0}' not resolved", item.ItemSpec);
287 assembly_resolver.LogSearchLoggerMessages (MessageImportance.Normal);
291 assembly_resolver.LogSearchLoggerMessages (MessageImportance.Low);
293 ResolvedReference rr = assembly_resolver.GetResolvedReference (item, item.ItemSpec, aname, true,
294 SearchPath.RawFileName);
295 copy_local = rr.CopyLocal.ToString ();
297 if (!TryAddNewReference (tempResolvedFiles, rr))
301 SetCopyLocal (rr.TaskItem, copy_local);
303 FindAndAddRelatedFiles (item.ItemSpec, copy_local);
304 FindAndAddSatellites (item.ItemSpec, copy_local);
306 if (FindDependencies && !IsFromGacOrTargetFramework (rr) &&
307 rr.FoundInSearchPath != SearchPath.PkgConfig)
308 primaryReferences.Add (new PrimaryReference (item, copy_local));
312 // Tries to resolve assemblies referenced by @item
313 // Skips gac references
315 void ResolveAssemblyFileDependencies (ITaskItem item, string parent_copy_local)
317 Queue<string> dependencies = new Queue<string> ();
318 dependencies.Enqueue (item.ItemSpec);
320 while (dependencies.Count > 0) {
321 string filename = Path.GetFullPath (dependencies.Dequeue ());
322 Assembly asm = Assembly.ReflectionOnlyLoadFrom (filename);
323 if (alreadyScannedAssemblyNames.ContainsKey (asm.FullName))
326 // set the 1st search path to this ref's base path
327 // Will be used for resolving the dependencies
328 dependency_search_paths [0] = Path.GetDirectoryName (filename);
330 foreach (AssemblyName aname in asm.GetReferencedAssemblies ()) {
331 if (alreadyScannedAssemblyNames.ContainsKey (aname.FullName))
334 ResolvedReference resolved_ref = ResolveDependencyByAssemblyName (
335 aname, asm.FullName, parent_copy_local);
337 if (IncludeDependencies (resolved_ref, aname.FullName)) {
338 tempResolvedDepFiles[resolved_ref.AssemblyName.FullName] = resolved_ref.TaskItem;
339 dependencies.Enqueue (resolved_ref.TaskItem.ItemSpec);
342 alreadyScannedAssemblyNames.Add (asm.FullName, String.Empty);
346 // Resolves by looking dependency_search_paths
347 // which is dir of parent reference file, and
349 ResolvedReference ResolveDependencyByAssemblyName (AssemblyName aname, string parent_asm_name,
350 string parent_copy_local)
352 // This will check for compatible assembly name/version
353 ResolvedReference resolved_ref;
354 if (TryGetResolvedReferenceByAssemblyName (aname, false, out resolved_ref))
357 LogWithPrecedingNewLine (MessageImportance.Low, "Dependency {0}", aname);
358 Log.LogMessage (MessageImportance.Low, "\tRequired by {0}", parent_asm_name);
360 ITaskItem item = new TaskItem (aname.FullName);
361 item.SetMetadata ("SpecificVersion", "false");
362 resolved_ref = ResolveReference (item, dependency_search_paths, false);
364 if (resolved_ref != null) {
365 Log.LogMessage (MessageImportance.Low, "\tReference {0} resolved to {1}.",
366 aname, resolved_ref.TaskItem.ItemSpec);
368 Log.LogMessage (MessageImportance.Low,
369 "\tReference found at search path {0}",
370 resolved_ref.FoundInSearchPathAsString);
372 assembly_resolver.LogSearchLoggerMessages (MessageImportance.Low);
374 if (resolved_ref.FoundInSearchPath == SearchPath.Directory) {
375 // override CopyLocal with parent's val
376 SetCopyLocal (resolved_ref.TaskItem, parent_copy_local);
378 Log.LogMessage (MessageImportance.Low,
379 "\tThis is CopyLocal {0} as parent item has this value",
382 if (TryAddNewReference (tempResolvedFiles, resolved_ref)) {
383 FindAndAddRelatedFiles (resolved_ref.TaskItem.ItemSpec, parent_copy_local);
384 FindAndAddSatellites (resolved_ref.TaskItem.ItemSpec, parent_copy_local);
388 Log.LogMessage (MessageImportance.Low,
389 "\tThis is CopyLocal false as it is in the GAC," +
390 "target framework directory or provided by a package.");
392 TryAddNewReference (tempResolvedFiles, resolved_ref);
395 Log.LogMessage (MessageImportance.Low, "Could not resolve the assembly \"{0}\".", aname);
396 assembly_resolver.LogSearchLoggerMessages (MessageImportance.Low);
402 void FindAndAddRelatedFiles (string filename, string parent_copy_local)
404 if (!findRelatedFiles || allowedRelatedFileExtensions == null)
407 foreach (string ext in allowedRelatedFileExtensions) {
408 string rfile = Path.ChangeExtension (filename, ext);
409 if (File.Exists (rfile)) {
410 ITaskItem item = new TaskItem (rfile);
411 SetCopyLocal (item, parent_copy_local);
413 tempRelatedFiles.AddUniqueFile (item);
418 void FindAndAddSatellites (string filename, string parent_copy_local)
423 string basepath = Path.GetDirectoryName (filename);
424 string resource = String.Format ("{0}{1}{2}",
425 Path.GetFileNameWithoutExtension (filename),
427 Path.GetExtension (filename));
429 string dir_sep = Path.DirectorySeparatorChar.ToString ();
430 foreach (string dir in Directory.GetDirectories (basepath)) {
431 string culture = Path.GetFileName (dir);
432 if (!CultureNamesTable.ContainsKey (culture))
435 string res_path = Path.Combine (dir, resource);
436 if (File.Exists (res_path)) {
437 ITaskItem item = new TaskItem (res_path);
438 SetCopyLocal (item, parent_copy_local);
439 item.SetMetadata ("DestinationSubdirectory", culture + dir_sep);
440 tempSatelliteFiles.AddUniqueFile (item);
445 // returns true is it was new
446 bool TryAddNewReference (List<ITaskItem> file_list, ResolvedReference key_ref)
448 ResolvedReference found_ref;
449 if (!TryGetResolvedReferenceByAssemblyName (key_ref.AssemblyName, key_ref.IsPrimary, out found_ref)) {
450 assemblyNameToResolvedRef [key_ref.AssemblyName.Name] = key_ref;
451 file_list.Add (key_ref.TaskItem);
458 void SetCopyLocal (ITaskItem item, string copy_local)
460 item.SetMetadata ("CopyLocal", copy_local);
462 // Assumed to be valid value
463 if (Boolean.Parse (copy_local))
464 tempCopyLocalFiles.AddUniqueFile (item);
467 bool TryGetResolvedReferenceByAssemblyName (AssemblyName key_aname, bool is_primary, out ResolvedReference found_ref)
470 // Match by just name
471 if (!assemblyNameToResolvedRef.TryGetValue (key_aname.Name, out found_ref))
475 // match for full name
476 if (AssemblyResolver.AssemblyNamesCompatible (key_aname, found_ref.AssemblyName, true, false))
477 // exact match, so its already there, dont add anything
480 // we have a name match, but version mismatch!
481 assembly_resolver.LogSearchMessage ("A conflict was detected between '{0}' and '{1}'",
482 key_aname.FullName, found_ref.AssemblyName.FullName);
484 if (is_primary == found_ref.IsPrimary) {
485 assembly_resolver.LogSearchMessage ("Unable to choose between the two. " +
486 "Choosing '{0}' arbitrarily.", found_ref.AssemblyName.FullName);
490 // since all dependencies are processed after
491 // all primary refererences, the one in the cache
492 // has to be a primary
493 // Prefer a primary reference over a dependency
495 assembly_resolver.LogSearchMessage ("Choosing '{0}' as it is a primary reference.",
496 found_ref.AssemblyName.FullName);
498 // If we can successfully use the primary reference, don't log a warning. It's too
500 //LogConflictWarning (found_ref.AssemblyName.FullName, key_aname.FullName);
505 void LogWithPrecedingNewLine (MessageImportance importance, string format, params object [] args)
507 Log.LogMessage (importance, String.Empty);
508 Log.LogMessage (importance, format, args);
511 // conflict b/w @main and @conflicting, picking @main
512 void LogConflictWarning (string main, string conflicting)
514 string key = main + ":" + conflicting;
515 if (!conflictWarningsCache.ContainsKey (key)) {
516 Log.LogWarning ("Found a conflict between : '{0}' and '{1}'. Using '{0}' reference.",
518 conflictWarningsCache [key] = key;
522 bool IsFromGacOrTargetFramework (ResolvedReference rr)
524 return rr.FoundInSearchPath == SearchPath.Gac ||
525 rr.FoundInSearchPath == SearchPath.TargetFrameworkDirectory;
528 bool IncludeDependencies (ResolvedReference rr, string aname)
532 if (aname.Equals ("System.Runtime, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a"))
534 return !IsFromGacOrTargetFramework (rr) && rr.FoundInSearchPath != SearchPath.PkgConfig;
537 void LogTaskParameters ()
539 Log.LogMessage (MessageImportance.Low, "TargetFrameworkDirectories:");
540 if (TargetFrameworkDirectories != null)
541 foreach (string dir in TargetFrameworkDirectories)
542 Log.LogMessage (MessageImportance.Low, "\t{0}", dir);
544 Log.LogMessage (MessageImportance.Low, "SearchPaths:");
545 if (SearchPaths != null)
546 foreach (string path in SearchPaths)
547 Log.LogMessage (MessageImportance.Low, "\t{0}", path);
550 public bool AutoUnify {
551 get { return autoUnify; }
552 set { autoUnify = value; }
555 public ITaskItem[] AssemblyFiles {
556 get { return assemblyFiles; }
557 set { assemblyFiles = value; }
560 public ITaskItem[] Assemblies {
561 get { return assemblies; }
562 set { assemblies = value; }
565 public string AppConfigFile {
566 get { return appConfigFile; }
567 set { appConfigFile = value; }
570 public string[] AllowedAssemblyExtensions {
571 get { return allowedAssemblyExtensions; }
572 set { allowedAssemblyExtensions = value; }
575 public string[] AllowedRelatedFileExtensions {
576 get { return allowedRelatedFileExtensions; }
577 set { allowedRelatedFileExtensions = value; }
580 public string[] CandidateAssemblyFiles {
581 get { return candidateAssemblyFiles; }
582 set { candidateAssemblyFiles = value; }
586 public ITaskItem[] CopyLocalFiles {
587 get { return copyLocalFiles; }
591 public ITaskItem[] FilesWritten {
592 get { return filesWritten; }
593 set { filesWritten = value; }
596 public bool FindDependencies {
597 get { return findDependencies; }
598 set { findDependencies = value; }
601 public bool FindRelatedFiles {
602 get { return findRelatedFiles; }
603 set { findRelatedFiles = value; }
606 public bool FindSatellites {
607 get { return findSatellites; }
608 set { findSatellites = value; }
611 public bool FindSerializationAssemblies {
612 get { return findSerializationAssemblies; }
613 set { findSerializationAssemblies = value; }
616 public string[] InstalledAssemblyTables {
617 get { return installedAssemblyTables; }
618 set { installedAssemblyTables = value; }
622 public ITaskItem[] RelatedFiles {
623 get { return relatedFiles; }
627 public ITaskItem[] ResolvedDependencyFiles {
628 get { return resolvedDependencyFiles; }
632 public ITaskItem[] ResolvedFiles {
633 get { return resolvedFiles; }
637 public ITaskItem[] SatelliteFiles {
638 get { return satelliteFiles; }
642 public ITaskItem[] ScatterFiles {
643 get { return scatterFiles; }
647 public string[] SearchPaths {
648 get { return searchPaths; }
649 set { searchPaths = value; }
653 public ITaskItem[] SerializationAssemblyFiles {
654 get { return serializationAssemblyFiles; }
658 get { return silent; }
659 set { silent = value; }
662 public string StateFile {
663 get { return stateFile; }
664 set { stateFile = value; }
668 public ITaskItem[] SuggestedRedirects {
669 get { return suggestedRedirects; }
673 public string TargetFrameworkMoniker { get; set; }
675 public string TargetFrameworkMonikerDisplayName { get; set; }
678 public string TargetFrameworkVersion { get; set; }
680 public string[] TargetFrameworkDirectories {
681 get { return targetFrameworkDirectories; }
682 set { targetFrameworkDirectories = value; }
685 public string TargetProcessorArchitecture {
686 get { return targetProcessorArchitecture; }
687 set { targetProcessorArchitecture = value; }
691 static Dictionary<string, string> cultureNamesTable;
692 static Dictionary<string, string> CultureNamesTable {
694 if (cultureNamesTable == null) {
695 cultureNamesTable = new Dictionary<string, string> ();
696 foreach (CultureInfo ci in CultureInfo.GetCultures (CultureTypes.AllCultures))
697 cultureNamesTable [ci.Name] = ci.Name;
700 return cultureNamesTable;
705 static class ResolveAssemblyReferenceHelper {
706 public static void AddUniqueFile (this Dictionary<string, ITaskItem> dic, ITaskItem item)
709 throw new ArgumentNullException ("dic");
711 throw new ArgumentNullException ("item");
713 string fullpath = Path.GetFullPath (item.ItemSpec);
714 if (!dic.ContainsKey (fullpath))
715 dic [fullpath] = item;
719 struct PrimaryReference {
720 public ITaskItem TaskItem;
721 public string ParentCopyLocal;
723 public PrimaryReference (ITaskItem item, string parent_copy_local)
726 ParentCopyLocal = parent_copy_local;