mcs/class/Microsoft.Build.Tasks/Microsoft.Build.Tasks/AssemblyResolver.cs

   1 //
   2 // AssemblyResolver.cs
   3 //
   4 // Author:
   5 //   Marek Sieradzki (marek.sieradzki@gmail.com)
   6 //   Ankit Jain (jankit@novell.com)
   7 //
   8 // (C) 2006 Marek Sieradzki
   9 // Copyright 2009 Novell, Inc (http://www.novell.com)
  10 //
  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:
  18 //
  19 // The above copyright notice and this permission notice shall be
  20 // included in all copies or substantial portions of the Software.
  21 //
  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.
  29
  30 #if NET_2_0
  31
  32 using System;
  33 using System.Collections.Generic;
  34 using System.IO;
  35 using System.Reflection;
  36 using System.Security;
  37 using Microsoft.Build.Framework;
  38 using Microsoft.Build.Utilities;
  39
  40 namespace Microsoft.Build.Tasks {
  41         internal class AssemblyResolver {
  42
  43                 // name -> (version -> assemblypath)
  44                 Dictionary<string, TargetFrameworkAssemblies> target_framework_cache;
  45                 Dictionary<string, Dictionary<Version, string>> gac;
  46                 TaskLoggingHelper log;
  47                 StringWriter sw;
  48
  49                 public AssemblyResolver ()
  50                 {
  51                         gac = new Dictionary<string, Dictionary<Version, string>> ();
  52                         target_framework_cache = new Dictionary <string, TargetFrameworkAssemblies> ();
  53
  54                         GatherGacAssemblies ();
  55                 }
  56
  57                 public StringWriter SearchLogger {
  58                         get { return sw; }
  59                 }
  60
  61                 public void ResetSearchLogger ()
  62                 {
  63                         sw = new StringWriter ();
  64                 }
  65
  66                 string GetGacPath ()
  67                 {
  68                         // NOTE: code from mcs/tools/gacutil/driver.cs
  69                         PropertyInfo gac = typeof (System.Environment).GetProperty ("GacPath", BindingFlags.Static | BindingFlags.NonPublic);
  70
  71                         if (gac == null)
  72                                 return null;
  73
  74                         MethodInfo get_gac = gac.GetGetMethod (true);
  75                         return (string) get_gac.Invoke (null, null);
  76                 }
  77
  78                 void GatherGacAssemblies ()
  79                 {
  80                         string gac_path = GetGacPath ();
  81                         if (gac_path == null)
  82                                 throw new InvalidOperationException ("XBuild must be run on Mono runtime");
  83                         if (!Directory.Exists (gac_path))
  84                                 return; // in case mono isn't "installed".
  85
  86                         Version version;
  87                         DirectoryInfo version_info, assembly_info;
  88
  89                         foreach (string assembly_name in Directory.GetDirectories (gac_path)) {
  90                                 assembly_info = new DirectoryInfo (assembly_name);
  91                                 foreach (string version_token in Directory.GetDirectories (assembly_name)) {
  92                                         foreach (string file in Directory.GetFiles (version_token, "*.dll")) {
  93                                                 version_info = new DirectoryInfo (version_token);
  94                                                 version = new Version (version_info.Name.Split (
  95                                                         new char [] {'_'}, StringSplitOptions.RemoveEmptyEntries) [0]);
  96
  97                                                 Dictionary<Version, string> assembliesByVersion = new Dictionary <Version, string> ();
  98                                                 if (!gac.TryGetValue (assembly_info.Name, out assembliesByVersion)) {
  99                                                         assembliesByVersion = new Dictionary <Version, string> ();
 100                                                         gac.Add (assembly_info.Name, assembliesByVersion);
 101                                                 }
 102
 103                                                 string found_file;
 104                                                 if (assembliesByVersion.TryGetValue (version, out found_file) &&
 105                                                         File.GetLastWriteTime (file) <= File.GetLastWriteTime (found_file))
 106                                                                 // Duplicate found, take the newer file
 107                                                                 continue;
 108
 109                                                 assembliesByVersion [version] = file;
 110                                         }
 111                                 }
 112                         }
 113                 }
 114
 115                 public string FindInTargetFramework (ITaskItem reference, string framework_dir, bool specific_version)
 116                 {
 117                         AssemblyName key_aname = new AssemblyName (reference.ItemSpec);
 118                         TargetFrameworkAssemblies gac_asm;
 119                         if (!target_framework_cache.TryGetValue (framework_dir, out gac_asm)) {
 120                                 // fill gac_asm
 121                                 gac_asm = target_framework_cache [framework_dir] = PopulateTargetFrameworkAssemblies (framework_dir);
 122                         }
 123
 124                         KeyValuePair<AssemblyName, string> pair;
 125                         if (gac_asm.NameToAssemblyNameCache.TryGetValue (key_aname.Name, out pair)) {
 126                                 if (AssemblyNamesCompatible (key_aname, pair.Key, specific_version))
 127                                         return pair.Value;
 128
 129                                 SearchLogger.WriteLine ("Considered target framework dir {0}, assembly name '{1}' did not " +
 130                                                 "match the expected '{2}' (SpecificVersion={3})",
 131                                                 framework_dir, pair.Key, key_aname, specific_version);
 132                         } else {
 133                                 SearchLogger.WriteLine ("Considered target framework dir {0}, assembly named '{1}' not found.",
 134                                                 framework_dir, key_aname.Name);
 135                         }
 136                         return null;
 137                 }
 138
 139                 public string FindInDirectory (ITaskItem reference, string directory)
 140                 {
 141                         if (reference.ItemSpec.IndexOf (',') > 0) {
 142                                 AssemblyName key_aname = new AssemblyName (reference.ItemSpec);
 143                                 foreach (string file in Directory.GetFiles (directory, "*.dll")) {
 144                                         AssemblyName found = AssemblyName.GetAssemblyName (file);
 145                                         //FIXME: Extract 'name' and look only for name.dll name.exe ?
 146                                         if (AssemblyNamesCompatible (key_aname, found, false))
 147                                                 return file;
 148
 149                                         SearchLogger.WriteLine ("Considered {0}, but assembly name wasn't compatible.", file);
 150                                 }
 151                         } else {
 152                                 string path = Path.Combine (directory, reference.ItemSpec);
 153                                 if (GetAssemblyNameFromFile (path) != null)
 154                                         return path;
 155                         }
 156
 157                         return null;
 158                 }
 159
 160                 TargetFrameworkAssemblies PopulateTargetFrameworkAssemblies (string directory)
 161                 {
 162                         TargetFrameworkAssemblies gac_asm = new TargetFrameworkAssemblies (directory);
 163                         foreach (string file in Directory.GetFiles (directory, "*.dll")) {
 164                                 AssemblyName aname = AssemblyName.GetAssemblyName (file);
 165                                 gac_asm.NameToAssemblyNameCache [aname.Name] =
 166                                         new KeyValuePair<AssemblyName, string> (aname, file);
 167                         }
 168
 169                         return gac_asm;
 170                 }
 171
 172                 public string ResolveGacReference (ITaskItem reference, bool specific_version)
 173                 {
 174                         AssemblyName name = new AssemblyName (reference.ItemSpec);
 175                         if (!gac.ContainsKey (name.Name)) {
 176                                 SearchLogger.WriteLine ("Considered {0}, but could not find in the GAC.",
 177                                                 reference.ItemSpec);
 178                                 return null;
 179                         }
 180
 181                         if (name.Version != null) {
 182                                 string ret;
 183                                 if (gac [name.Name].TryGetValue (name.Version, out ret))
 184                                         return ret;
 185
 186                                 // not found
 187                                 if (specific_version) {
 188                                         SearchLogger.WriteLine ("Considered '{0}', but an assembly with the specific version not found.",
 189                                                         reference.ItemSpec);
 190                                         return null;
 191                                 }
 192                         }
 193
 194                         Version [] versions = new Version [gac [name.Name].Keys.Count];
 195                         gac [name.Name].Keys.CopyTo (versions, 0);
 196                         Array.Sort (versions, (IComparer <Version>) null);
 197                         Version highest = versions [versions.Length - 1];
 198                         return gac [name.Name] [highest];
 199                 }
 200
 201                 public string ResolveHintPathReference (ITaskItem reference, bool specific_version)
 202                 {
 203                         AssemblyName name = new AssemblyName (reference.ItemSpec);
 204                         string resolved = null;
 205
 206                         string hintpath = reference.GetMetadata ("HintPath");
 207                         if (String.IsNullOrEmpty (hintpath)) {
 208                                 SearchLogger.WriteLine ("HintPath attribute not found");
 209                                 return null;
 210                         }
 211
 212                         if (!File.Exists (hintpath)) {
 213                                 log.LogMessage (MessageImportance.Low, "HintPath {0} does not exist.", hintpath);
 214                                 SearchLogger.WriteLine ("Considererd {0}, but it does not exist.", hintpath);
 215                                 return null;
 216                         }
 217
 218                         AssemblyName found = GetAssemblyNameFromFile (hintpath);
 219                         if (found == null) {
 220                                 log.LogMessage (MessageImportance.Low, "File at HintPath {0}, is either an invalid assembly or the file does not exist.", hintpath);
 221                                 return null;
 222                         }
 223
 224                         if (AssemblyNamesCompatible (name, found, specific_version)) {
 225                                 resolved = hintpath;
 226                         } else {
 227                                 SearchLogger.WriteLine ("Considered {0}, but assembly name '{1}' did not match the " +
 228                                                 "expected '{2}' (SpecificVersion={3})", hintpath, found, name, specific_version);
 229                                 log.LogMessage (MessageImportance.Low, "Assembly names are not compatible.");
 230                         }
 231
 232                         return resolved;
 233                 }
 234
 235                 public AssemblyName GetAssemblyNameFromFile (string filename)
 236                 {
 237                         AssemblyName aname = null;
 238                         try {
 239                                 aname = AssemblyName.GetAssemblyName (filename);
 240                         } catch (FileNotFoundException) {
 241                         } catch (BadImageFormatException) {
 242                         }
 243
 244                         if (aname != null)
 245                                 return aname;
 246
 247                         SearchLogger.WriteLine ("Considered '{0}' as a file, but it is either an invalid assembly " +
 248                                         "or file does not exist.", Path.GetFullPath (filename));
 249                         return null;
 250                 }
 251
 252                 static bool AssemblyNamesCompatible (AssemblyName a, AssemblyName b, bool specificVersion)
 253                 {
 254                         if (a.Name != b.Name)
 255                                 return false;
 256
 257                         if (a.CultureInfo != null && !a.CultureInfo.Equals (b.CultureInfo))
 258                                 return false;
 259
 260                         if (specificVersion && a.Version != null && a.Version != b.Version)
 261                                 return false;
 262
 263                         byte [] a_bytes = a.GetPublicKeyToken ();
 264                         byte [] b_bytes = b.GetPublicKeyToken ();
 265
 266                         if (specificVersion) {
 267                                 if (a_bytes == null || a_bytes.Length == 0)
 268                                         return false;
 269                                 if (b_bytes == null || b_bytes.Length == 0)
 270                                         return false;
 271
 272                                 for (int i = 0; i < a_bytes.Length; i++)
 273                                         if (a_bytes [i] != b_bytes [i])
 274                                                 return false;
 275                         }
 276
 277                         return true;
 278                 }
 279
 280                 public bool IsStrongNamed (AssemblyName name)
 281                 {
 282                         return (name.Version != null && name.GetPublicKeyToken ().Length != 0);
 283                 }
 284
 285                 public TaskLoggingHelper Log {
 286                         set { log = value; }
 287                 }
 288         }
 289
 290         class TargetFrameworkAssemblies {
 291                 public string Path;
 292
 293                 // assembly (simple) name -> (AssemblyName, file path)
 294                 public Dictionary <string, KeyValuePair<AssemblyName, string>> NameToAssemblyNameCache;
 295
 296                 public TargetFrameworkAssemblies (string path)
 297                 {
 298                         this.Path = path;
 299                         NameToAssemblyNameCache = new Dictionary<string, KeyValuePair<AssemblyName, string>> ();
 300                 }
 301         }
 302 }
 303
 304 #endif