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 assembly_resolver.Log = Log;
103 tempResolvedFiles = new List<ITaskItem> ();
104 tempCopyLocalFiles = new Dictionary<string, ITaskItem> ();
105 tempSatelliteFiles = new Dictionary<string, ITaskItem> ();
106 tempRelatedFiles = new Dictionary<string, ITaskItem> ();
107 tempResolvedDepFiles = new Dictionary<string, ITaskItem> ();
109 primaryReferences = new List<PrimaryReference> ();
110 assemblyNameToResolvedRef = new Dictionary<string, ResolvedReference> ();
111 conflictWarningsCache = new Dictionary<string, string> ();
113 ResolveAssemblies ();
114 ResolveAssemblyFiles ();
116 alreadyScannedAssemblyNames = new Dictionary<string, string> ();
118 // the first element is place holder for parent assembly's dir
119 dependency_search_paths = new List<string> () { String.Empty };
120 dependency_search_paths.AddRange (searchPaths);
122 // resolve dependencies
123 foreach (PrimaryReference pref in primaryReferences)
124 ResolveAssemblyFileDependencies (pref.TaskItem, pref.ParentCopyLocal);
126 resolvedFiles = tempResolvedFiles.ToArray ();
127 copyLocalFiles = tempCopyLocalFiles.Values.ToArray ();
128 satelliteFiles = tempSatelliteFiles.Values.ToArray ();
129 relatedFiles = tempRelatedFiles.Values.ToArray ();
130 resolvedDependencyFiles = tempResolvedDepFiles.Values.ToArray ();
132 tempResolvedFiles.Clear ();
133 tempCopyLocalFiles.Clear ();
134 tempSatelliteFiles.Clear ();
135 tempRelatedFiles.Clear ();
136 tempResolvedDepFiles.Clear ();
137 alreadyScannedAssemblyNames.Clear ();
138 primaryReferences.Clear ();
139 assemblyNameToResolvedRef.Clear ();
140 conflictWarningsCache.Clear ();
141 dependency_search_paths = null;
146 void ResolveAssemblies ()
148 if (assemblies == null || assemblies.Length == 0)
151 foreach (ITaskItem item in assemblies) {
152 if (!String.IsNullOrEmpty (item.GetMetadata ("SubType"))) {
153 Log.LogWarning ("Reference '{0}' has non-empty SubType. Ignoring.", item.ItemSpec);
157 Log.LogMessage (MessageImportance.Low, "Primary Reference {0}", item.ItemSpec);
158 ResolvedReference resolved_ref = ResolveReference (item, searchPaths, true);
159 if (resolved_ref == null) {
160 Log.LogWarning ("Reference '{0}' not resolved", item.ItemSpec);
161 assembly_resolver.LogSearchLoggerMessages ();
163 Log.LogMessage (MessageImportance.Low,
164 "\tReference {0} resolved to {1}. CopyLocal = {2}",
165 item.ItemSpec, resolved_ref.TaskItem,
166 resolved_ref.TaskItem.GetMetadata ("CopyLocal"));
168 Log.LogMessage (MessageImportance.Low,
169 "\tReference found at search path {0}",
170 resolved_ref.FoundInSearchPathAsString);
172 if (TryAddNewReference (tempResolvedFiles, resolved_ref) &&
173 !IsFromGacOrTargetFramework (resolved_ref) &&
174 resolved_ref.FoundInSearchPath != SearchPath.PkgConfig) {
175 primaryReferences.Add (new PrimaryReference (
176 resolved_ref.TaskItem,
177 resolved_ref.TaskItem.GetMetadata ("CopyLocal")));
183 // Use @search_paths to resolve the reference
184 ResolvedReference ResolveReference (ITaskItem item, IEnumerable<string> search_paths, bool set_copy_local)
186 ResolvedReference resolved = null;
187 bool specific_version;
189 assembly_resolver.ResetSearchLogger ();
191 if (!TryGetSpecificVersionValue (item, out specific_version))
194 foreach (string spath in search_paths) {
195 assembly_resolver.LogSearchMessage ("For searchpath {0}", spath);
197 if (String.Compare (spath, "{HintPathFromItem}") == 0) {
198 resolved = assembly_resolver.ResolveHintPathReference (item, specific_version);
199 } else if (String.Compare (spath, "{TargetFrameworkDirectory}") == 0) {
200 if (targetFrameworkDirectories == null)
202 foreach (string fpath in targetFrameworkDirectories) {
203 resolved = assembly_resolver.FindInTargetFramework (item,
204 fpath, specific_version);
205 if (resolved != null)
208 } else if (String.Compare (spath, "{GAC}") == 0) {
209 resolved = assembly_resolver.ResolveGacReference (item, specific_version);
210 } else if (String.Compare (spath, "{RawFileName}") == 0) {
211 //FIXME: identify assembly names, as extract the name, and try with that?
212 AssemblyName aname = assembly_resolver.GetAssemblyNameFromFile (item.ItemSpec);
214 resolved = assembly_resolver.GetResolvedReference (item, item.ItemSpec, aname, true,
215 SearchPath.RawFileName);
216 } else if (String.Compare (spath, "{CandidateAssemblyFiles}") == 0) {
217 assembly_resolver.LogSearchMessage (
218 "Warning: {{CandidateAssemblyFiles}} not supported currently");
219 } else if (String.Compare (spath, "{PkgConfig}") == 0) {
220 resolved = assembly_resolver.ResolvePkgConfigReference (item, specific_version);
222 resolved = assembly_resolver.FindInDirectory (
224 allowedAssemblyExtensions ?? default_assembly_extensions);
227 if (resolved != null)
231 if (resolved != null && set_copy_local)
232 SetCopyLocal (resolved.TaskItem, resolved.CopyLocal.ToString ());
237 bool TryGetSpecificVersionValue (ITaskItem item, out bool specific_version)
239 specific_version = true;
240 string value = item.GetMetadata ("SpecificVersion");
241 if (String.IsNullOrEmpty (value)) {
242 AssemblyName name = new AssemblyName (item.ItemSpec);
243 // If SpecificVersion is not specified, then
244 // it is true if the Include is a strong name else false
245 specific_version = assembly_resolver.IsStrongNamed (name);
249 if (Boolean.TryParse (value, out specific_version))
252 Log.LogError ("Item '{0}' has attribute SpecificVersion with invalid value '{1}' " +
253 "which could not be converted to a boolean.", item.ItemSpec, value);
257 //FIXME: Consider CandidateAssemblyFiles also here
258 void ResolveAssemblyFiles ()
260 if (assemblyFiles == null)
263 foreach (ITaskItem item in assemblyFiles) {
264 assembly_resolver.ResetSearchLogger ();
266 if (!File.Exists (item.ItemSpec)) {
267 Log.LogMessage (MessageImportance.Low,
268 "Primary Reference from AssemblyFiles {0}, file not found. Ignoring",
273 Log.LogMessage (MessageImportance.Low, "Primary Reference from AssemblyFiles {0}", item.ItemSpec);
276 AssemblyName aname = assembly_resolver.GetAssemblyNameFromFile (item.ItemSpec);
278 Log.LogWarning ("Reference '{0}' not resolved", item.ItemSpec);
279 assembly_resolver.LogSearchLoggerMessages ();
283 ResolvedReference rr = assembly_resolver.GetResolvedReference (item, item.ItemSpec, aname, true,
284 SearchPath.RawFileName);
285 copy_local = rr.CopyLocal.ToString ();
287 if (!TryAddNewReference (tempResolvedFiles, rr))
291 SetCopyLocal (rr.TaskItem, copy_local);
293 FindAndAddRelatedFiles (item.ItemSpec, copy_local);
294 FindAndAddSatellites (item.ItemSpec, copy_local);
296 if (FindDependencies && !IsFromGacOrTargetFramework (rr) &&
297 rr.FoundInSearchPath != SearchPath.PkgConfig)
298 primaryReferences.Add (new PrimaryReference (item, copy_local));
302 // Tries to resolve assemblies referenced by @item
303 // Skips gac references
305 void ResolveAssemblyFileDependencies (ITaskItem item, string parent_copy_local)
307 Queue<string> dependencies = new Queue<string> ();
308 dependencies.Enqueue (item.ItemSpec);
310 while (dependencies.Count > 0) {
311 string filename = Path.GetFullPath (dependencies.Dequeue ());
312 Assembly asm = Assembly.ReflectionOnlyLoadFrom (filename);
313 if (alreadyScannedAssemblyNames.ContainsKey (asm.FullName))
316 // set the 1st search path to this ref's base path
317 // Will be used for resolving the dependencies
318 dependency_search_paths [0] = Path.GetDirectoryName (filename);
320 foreach (AssemblyName aname in asm.GetReferencedAssemblies ()) {
321 if (alreadyScannedAssemblyNames.ContainsKey (aname.FullName))
324 ResolvedReference resolved_ref = ResolveDependencyByAssemblyName (
325 aname, asm.FullName, parent_copy_local);
327 if (resolved_ref != null && !IsFromGacOrTargetFramework (resolved_ref)
328 && resolved_ref.FoundInSearchPath != SearchPath.PkgConfig)
329 dependencies.Enqueue (resolved_ref.TaskItem.ItemSpec);
331 alreadyScannedAssemblyNames.Add (asm.FullName, String.Empty);
335 // Resolves by looking dependency_search_paths
336 // which is dir of parent reference file, and
338 ResolvedReference ResolveDependencyByAssemblyName (AssemblyName aname, string parent_asm_name,
339 string parent_copy_local)
341 // This will check for compatible assembly name/version
342 ResolvedReference resolved_ref;
343 if (TryGetResolvedReferenceByAssemblyName (aname, false, out resolved_ref))
346 Log.LogMessage (MessageImportance.Low, "Dependency {0}", aname);
347 Log.LogMessage (MessageImportance.Low, "\tRequired by {0}", parent_asm_name);
349 ITaskItem item = new TaskItem (aname.FullName);
350 item.SetMetadata ("SpecificVersion", "false");
351 resolved_ref = ResolveReference (item, dependency_search_paths, false);
353 if (resolved_ref != null) {
354 Log.LogMessage (MessageImportance.Low, "\tReference {0} resolved to {1}.",
355 aname, resolved_ref.TaskItem.ItemSpec);
357 Log.LogMessage (MessageImportance.Low,
358 "\tReference found at search path {0}",
359 resolved_ref.FoundInSearchPathAsString);
361 if (resolved_ref.FoundInSearchPath == SearchPath.Directory) {
362 // override CopyLocal with parent's val
363 SetCopyLocal (resolved_ref.TaskItem, parent_copy_local);
365 Log.LogMessage (MessageImportance.Low,
366 "\tThis is CopyLocal {0} as parent item has this value",
369 if (TryAddNewReference (tempResolvedFiles, resolved_ref)) {
370 FindAndAddRelatedFiles (resolved_ref.TaskItem.ItemSpec, parent_copy_local);
371 FindAndAddSatellites (resolved_ref.TaskItem.ItemSpec, parent_copy_local);
375 Log.LogMessage (MessageImportance.Low,
376 "\tThis is CopyLocal false as it is in the gac," +
377 "target framework directory or provided by a package.");
379 TryAddNewReference (tempResolvedFiles, resolved_ref);
382 Log.LogWarning ("Reference '{0}' not resolved", aname);
383 assembly_resolver.LogSearchLoggerMessages ();
389 void FindAndAddRelatedFiles (string filename, string parent_copy_local)
391 if (!findRelatedFiles || allowedRelatedFileExtensions == null)
394 foreach (string ext in allowedRelatedFileExtensions) {
395 string rfile = filename + ext;
396 if (File.Exists (rfile)) {
397 ITaskItem item = new TaskItem (rfile);
398 SetCopyLocal (item, parent_copy_local);
400 tempRelatedFiles.AddUniqueFile (item);
405 void FindAndAddSatellites (string filename, string parent_copy_local)
410 string basepath = Path.GetDirectoryName (filename);
411 string resource = String.Format ("{0}{1}{2}",
412 Path.GetFileNameWithoutExtension (filename),
414 Path.GetExtension (filename));
416 string dir_sep = Path.DirectorySeparatorChar.ToString ();
417 foreach (string dir in Directory.GetDirectories (basepath)) {
418 string culture = Path.GetFileName (dir);
419 if (!CultureNamesTable.ContainsKey (culture))
422 string res_path = Path.Combine (dir, resource);
423 if (File.Exists (res_path)) {
424 ITaskItem item = new TaskItem (res_path);
425 SetCopyLocal (item, parent_copy_local);
426 item.SetMetadata ("DestinationSubdirectory", culture + dir_sep);
427 tempSatelliteFiles.AddUniqueFile (item);
432 // returns true is it was new
433 bool TryAddNewReference (List<ITaskItem> file_list, ResolvedReference key_ref)
435 ResolvedReference found_ref;
436 if (!TryGetResolvedReferenceByAssemblyName (key_ref.AssemblyName, key_ref.IsPrimary, out found_ref)) {
437 assemblyNameToResolvedRef [key_ref.AssemblyName.Name] = key_ref;
438 file_list.Add (key_ref.TaskItem);
445 void SetCopyLocal (ITaskItem item, string copy_local)
447 item.SetMetadata ("CopyLocal", copy_local);
449 // Assumed to be valid value
450 if (Boolean.Parse (copy_local))
451 tempCopyLocalFiles.AddUniqueFile (item);
454 bool TryGetResolvedReferenceByAssemblyName (AssemblyName key_aname, bool is_primary, out ResolvedReference found_ref)
457 // Match by just name
458 if (!assemblyNameToResolvedRef.TryGetValue (key_aname.Name, out found_ref))
462 // match for full name
463 if (AssemblyResolver.AssemblyNamesCompatible (key_aname, found_ref.AssemblyName, true))
464 // exact match, so its already there, dont add anything
467 // we have a name match, but version mismatch!
468 assembly_resolver.LogSearchMessage ("A conflict was detected between '{0}' and '{1}'",
469 key_aname.FullName, found_ref.AssemblyName.FullName);
471 if (is_primary == found_ref.IsPrimary) {
472 assembly_resolver.LogSearchMessage ("Unable to choose between the two. " +
473 "Choosing '{0}' arbitrarily.", found_ref.AssemblyName.FullName);
477 // since all dependencies are processed after
478 // all primary refererences, the one in the cache
479 // has to be a primary
480 // Prefer a primary reference over a dependency
482 assembly_resolver.LogSearchMessage ("Choosing '{0}' as it is a primary reference.",
483 found_ref.AssemblyName.FullName);
485 LogConflictWarning (found_ref.AssemblyName.FullName, key_aname.FullName);
490 // conflict b/w @main and @conflicting, picking @main
491 void LogConflictWarning (string main, string conflicting)
493 string key = main + ":" + conflicting;
494 if (!conflictWarningsCache.ContainsKey (key)) {
495 Log.LogWarning ("Found a conflict between : '{0}' and '{1}'. Using '{0}' reference.",
497 conflictWarningsCache [key] = key;
501 bool IsFromGacOrTargetFramework (ResolvedReference rr)
503 return rr.FoundInSearchPath == SearchPath.Gac ||
504 rr.FoundInSearchPath == SearchPath.TargetFrameworkDirectory;
507 public bool AutoUnify {
508 get { return autoUnify; }
509 set { autoUnify = value; }
512 public ITaskItem[] AssemblyFiles {
513 get { return assemblyFiles; }
514 set { assemblyFiles = value; }
517 public ITaskItem[] Assemblies {
518 get { return assemblies; }
519 set { assemblies = value; }
522 public string AppConfigFile {
523 get { return appConfigFile; }
524 set { appConfigFile = value; }
527 public string[] AllowedAssemblyExtensions {
528 get { return allowedAssemblyExtensions; }
529 set { allowedAssemblyExtensions = value; }
532 public string[] AllowedRelatedFileExtensions {
533 get { return allowedRelatedFileExtensions; }
534 set { allowedRelatedFileExtensions = value; }
537 public string[] CandidateAssemblyFiles {
538 get { return candidateAssemblyFiles; }
539 set { candidateAssemblyFiles = value; }
543 public ITaskItem[] CopyLocalFiles {
544 get { return copyLocalFiles; }
548 public ITaskItem[] FilesWritten {
549 get { return filesWritten; }
550 set { filesWritten = value; }
553 public bool FindDependencies {
554 get { return findDependencies; }
555 set { findDependencies = value; }
558 public bool FindRelatedFiles {
559 get { return findRelatedFiles; }
560 set { findRelatedFiles = value; }
563 public bool FindSatellites {
564 get { return findSatellites; }
565 set { findSatellites = value; }
568 public bool FindSerializationAssemblies {
569 get { return findSerializationAssemblies; }
570 set { findSerializationAssemblies = value; }
573 public string[] InstalledAssemblyTables {
574 get { return installedAssemblyTables; }
575 set { installedAssemblyTables = value; }
579 public ITaskItem[] RelatedFiles {
580 get { return relatedFiles; }
584 public ITaskItem[] ResolvedDependencyFiles {
585 get { return resolvedDependencyFiles; }
589 public ITaskItem[] ResolvedFiles {
590 get { return resolvedFiles; }
594 public ITaskItem[] SatelliteFiles {
595 get { return satelliteFiles; }
599 public ITaskItem[] ScatterFiles {
600 get { return scatterFiles; }
604 public string[] SearchPaths {
605 get { return searchPaths; }
606 set { searchPaths = value; }
610 public ITaskItem[] SerializationAssemblyFiles {
611 get { return serializationAssemblyFiles; }
615 get { return silent; }
616 set { silent = value; }
619 public string StateFile {
620 get { return stateFile; }
621 set { stateFile = value; }
625 public ITaskItem[] SuggestedRedirects {
626 get { return suggestedRedirects; }
629 public string[] TargetFrameworkDirectories {
630 get { return targetFrameworkDirectories; }
631 set { targetFrameworkDirectories = value; }
634 public string TargetProcessorArchitecture {
635 get { return targetProcessorArchitecture; }
636 set { targetProcessorArchitecture = value; }
639 static Dictionary<string, string> cultureNamesTable;
640 static Dictionary<string, string> CultureNamesTable {
642 if (cultureNamesTable == null) {
643 cultureNamesTable = new Dictionary<string, string> ();
644 foreach (CultureInfo ci in CultureInfo.GetCultures (CultureTypes.AllCultures))
645 cultureNamesTable [ci.Name] = ci.Name;
648 return cultureNamesTable;
653 static class ResolveAssemblyReferenceHelper {
654 public static void AddUniqueFile (this Dictionary<string, ITaskItem> dic, ITaskItem item)
657 throw new ArgumentNullException ("dic");
659 throw new ArgumentNullException ("item");
661 string fullpath = Path.GetFullPath (item.ItemSpec);
662 if (!dic.ContainsKey (fullpath))
663 dic [fullpath] = item;
667 struct PrimaryReference {
668 public ITaskItem TaskItem;
669 public string ParentCopyLocal;
671 public PrimaryReference (ITaskItem item, string parent_copy_local)
674 ParentCopyLocal = parent_copy_local;