5 // Todd Berman <tberman@sevenl.net>
6 // Jackson Harper <jackson@ximian.com>
8 // Copyright 2003, 2004 Todd Berman
9 // Copyright 2004 Novell, Inc (http://www.novell.com)
16 using System.Reflection;
17 using System.Collections;
18 using System.Globalization;
19 using System.Runtime.InteropServices;
23 namespace Mono.Tools {
27 private enum Command {
38 private static bool silent;
40 public static int Main (string [] args)
45 Command command = Command.Unknown;
46 string command_str = null;
49 string name, package, gacdir, root;
50 name = package = root = gacdir = null;
51 bool check_refs = false;
53 // Check for silent arg first so we can supress
54 // warnings during command line parsing
55 if (Array.IndexOf (args, "/silent") > -1 || Array.IndexOf (args, "-silent") > -1)
58 for (int i=0; i<args.Length; i++) {
59 if (IsSwitch (args [i])) {
61 // for cmd line compatibility with other gacutils
62 // we always force it though
63 if (args [i] == "-f" || args [i] == "/f")
66 // Ignore this option for now, although we might implement it someday
67 if (args [i] == "/r") {
68 WriteLine ("WARNING: gacutil does not support traced references." +
69 "This option is being ignored.");
74 // This is already handled we just dont want to choke on it
75 if (args [i] == "-silent" || args [i] == "/silent")
78 if (args [i] == "-check_refs" || args [i] == "/check_refs") {
83 if (command == Command.Unknown) {
84 command = GetCommand (args [i]);
85 if (command != Command.Unknown) {
86 command_str = args [i];
91 if (i + 1 >= args.Length) {
92 Console.WriteLine ("Option " + args [i] + " takes 1 argument");
118 if (command == Command.Unknown && IsSwitch (args [0])) {
119 Console.WriteLine ("Unknown command: " + args [0]);
121 } else if (command == Command.Unknown) {
123 } else if (command == Command.Help) {
128 if (gacdir == null) {
129 gacdir = GetGacDir ();
130 libdir = GetLibDir ();
132 gacdir = EnsureLib (gacdir);
133 libdir = Path.Combine (gacdir, "mono");
134 gacdir = Path.Combine (libdir, "gac");
137 string link_gacdir = gacdir;
138 string link_libdir = libdir;
140 libdir = Path.Combine (root, "mono");
141 gacdir = Path.Combine (libdir, "gac");
145 case Command.Install:
147 WriteLine ("Option " + command_str + " takes 1 argument");
150 if (!Install (check_refs, name, package, gacdir, link_gacdir, libdir, link_libdir))
153 case Command.InstallFromList:
155 WriteLine ("Option " + command_str + " takes 1 argument");
158 if (!InstallFromList (check_refs, name, package, gacdir, link_gacdir, libdir, link_libdir))
161 case Command.Uninstall:
163 WriteLine ("Option " + command_str + " takes 1 argument");
166 if (!Uninstall (name, package, gacdir, libdir))
167 Environment.Exit (1);
169 case Command.UninstallFromList:
171 WriteLine ("Option " + command_str + " takes 1 argument");
174 if (!UninstallFromList (name, package, gacdir, libdir))
177 case Command.UninstallSpecific:
179 WriteLine ("Opetion " + command_str + " takes 1 argument");
182 if (!UninstallSpecific (name, package, gacdir, libdir))
193 private static bool Install (bool check_refs, string name, string package,
194 string gacdir, string link_gacdir, string libdir, string link_libdir)
196 string failure_msg = "Failure adding assembly to the cache: ";
198 if (!File.Exists (name)) {
199 WriteLine (failure_msg + "The system cannot find the file specified.");
200 Environment.Exit (1);
203 AssemblyName an = null;
207 an = AssemblyName.GetAssemblyName (name);
209 WriteLine (failure_msg + "The file specified is not a valid assembly.");
213 pub_tok = an.GetPublicKeyToken ();
214 if (pub_tok == null || pub_tok.Length == 0) {
215 WriteLine (failure_msg + "Attempt to install an assembly without a strong name.");
219 if (check_refs && !CheckReferencedAssemblies (an)) {
220 WriteLine (failure_msg + "Attempt to install an assembly that references non " +
221 "strong named assemblies with -check_refs enabled.");
225 string conf_name = name + ".config";
226 string version_token = an.Version + "_" +
227 an.CultureInfo.Name.ToLower (CultureInfo.InvariantCulture) + "_" +
228 GetStringToken (pub_tok);
229 string full_path = Path.Combine (Path.Combine (gacdir, an.Name), version_token);
230 string asmb_file = Path.GetFileName (name);
231 string asmb_path = Path.Combine (full_path, asmb_file);
234 if (Directory.Exists (full_path)) {
235 // Wipe out the directory. This way we ensure old assemblies
236 // config files, and AOTd files are removed.
237 Directory.Delete (full_path, true);
239 Directory.CreateDirectory (full_path);
241 WriteLine (failure_msg + "gac directories could not be created, " +
242 "possibly permission issues.");
246 File.Copy (name, asmb_path, true);
247 if (File.Exists (conf_name))
248 File.Copy (conf_name, asmb_path + ".config", true);
250 if (package != null) {
251 string link_path = Path.Combine (Path.Combine (link_gacdir, an.Name), version_token);
252 string ref_dir = Path.Combine (libdir, package);
253 string ref_path = Path.Combine (ref_dir, asmb_file);
255 if (File.Exists (ref_path))
256 File.Delete (ref_path);
258 Directory.CreateDirectory (ref_dir);
260 WriteLine ("ERROR: Could not create package dir file.");
261 Environment.Exit (1);
263 Symlink (Path.Combine (link_path, asmb_file), ref_path);
265 WriteLine ("Package exported to: " + ref_path + " -> " +
266 Path.Combine (link_path, asmb_file));
270 WriteLine ("{0} installed into the gac ({1})", an.Name, gacdir);
274 private static bool Uninstall (string name, string package, string gacdir, string libdir)
276 string [] assembly_pieces = name.Split (new char[] { ',' });
277 Hashtable asm_info = new Hashtable ();
279 foreach (string item in assembly_pieces) {
280 string[] pieces = item.Trim ().Split (new char[] { '=' }, 2);
281 if(pieces.Length == 1)
282 asm_info ["assembly"] = pieces [0];
284 asm_info [pieces[0].Trim ().ToLower (CultureInfo.InvariantCulture)] = pieces [1];
287 string asmdir = Path.Combine (gacdir, (string) asm_info ["assembly"]);
288 if (!Directory.Exists (asmdir)) {
289 WriteLine ("No assemblies found that match: " + name);
293 string searchString = GetSearchString (asm_info);
294 string [] directories = Directory.GetDirectories (asmdir, searchString);
296 foreach (string dir in directories) {
297 Directory.Delete (dir, true);
298 if (package != null) {
299 string link_dir = Path.Combine (libdir, package);
300 string link = Path.Combine (link_dir, (string) asm_info ["assembly"] + ".dll");
302 if (Directory.GetFiles (link_dir).Length == 0) {
303 WriteLine ("Cleaning package directory, it is empty.");
304 Directory.Delete (link_dir);
307 WriteLine ("Assembly removed from the gac.");
310 if(Directory.GetDirectories (asmdir).Length == 0) {
311 WriteLine ("Cleaning assembly dir, its empty");
312 Directory.Delete (asmdir);
318 private static bool UninstallSpecific (string name, string package,
319 string gacdir, string libdir)
321 string failure_msg = "Failure to remove assembly from the cache: ";
323 if (!File.Exists (name)) {
324 WriteLine (failure_msg + "The system cannot find the file specified.");
328 AssemblyName an = null;
331 an = AssemblyName.GetAssemblyName (name);
333 WriteLine (failure_msg + "The file specified is not a valid assembly.");
337 return Uninstall (an.FullName.Replace (" ", String.Empty),
338 package, gacdir, libdir);
341 private static void List (string name, string gacdir)
343 WriteLine ("The following assemblies are installed into the GAC:");
346 FilteredList (name, gacdir);
351 DirectoryInfo gacinfo = new DirectoryInfo (gacdir);
352 foreach (DirectoryInfo parent in gacinfo.GetDirectories ()) {
353 foreach (DirectoryInfo dir in parent.GetDirectories ()) {
354 WriteLine (AsmbNameFromVersionString (parent.Name, dir.Name));
358 WriteLine ("Number of items = " + count);
361 private static void FilteredList (string name, string gacdir)
363 string [] assembly_pieces = name.Split (new char[] { ',' });
364 Hashtable asm_info = new Hashtable ();
366 foreach (string item in assembly_pieces) {
367 string[] pieces = item.Trim ().Split (new char[] { '=' }, 2);
368 if(pieces.Length == 1)
369 asm_info ["assembly"] = pieces [0];
371 asm_info [pieces[0].Trim ().ToLower (CultureInfo.InvariantCulture)] = pieces [1];
374 string asmdir = Path.Combine (gacdir, (string) asm_info ["assembly"]);
375 if (!Directory.Exists (asmdir)) {
376 WriteLine ("Number of items = 0");
379 string search = GetSearchString (asm_info);
380 string [] dir_list = Directory.GetDirectories (asmdir, search);
383 foreach (string dir in dir_list) {
384 WriteLine (AsmbNameFromVersionString ((string) asm_info ["assembly"],
385 new DirectoryInfo (dir).Name));
388 WriteLine ("Number of items = " + count);
391 private static bool InstallFromList (bool check_refs, string list_file, string package,
392 string gacdir, string link_gacdir, string libdir, string link_libdir)
394 StreamReader s = null;
395 int processed, failed;
397 processed = failed = 0;
400 s = new StreamReader (list_file);
403 while ((line = s.ReadLine ()) != null) {
404 if (!Install (check_refs, line, package, gacdir, link_gacdir,
405 libdir, link_libdir))
410 } catch (IOException ioe) {
411 WriteLine ("Failed to open assemblies list file " + list_file + ".");
421 private static bool UninstallFromList (string list_file, string package,
422 string gacdir, string libdir)
424 StreamReader s = null;
425 int processed, failed;
427 processed = failed = 0;
430 s = new StreamReader (list_file);
433 while ((line = s.ReadLine ()) != null) {
434 if (!Uninstall (line, package, gacdir, libdir))
438 } catch (IOException ioe) {
439 WriteLine ("Failed to open assemblies list file " + list_file + ".");
449 private static bool CheckReferencedAssemblies (AssemblyName an)
453 Assembly a = Assembly.LoadFrom (an.CodeBase);
454 AssemblyName corlib = typeof (object).Assembly.GetName ();
456 foreach (AssemblyName ref_an in a.GetReferencedAssemblies ()) {
457 if (ref_an.Name == corlib.Name) // Just do a string compare so we can install on diff versions
459 byte [] pt = ref_an.GetPublicKeyToken ();
460 if (pt == null || pt.Length == 0) {
461 WriteLine ("Assembly " + ref_an.Name + " is not strong named.");
465 } catch (Exception e) {
466 WriteLine (e.ToString ()); // This should be removed pre beta3
471 AppDomain.Unload (d);
479 private static string GetSearchString (Hashtable asm_info)
481 if (asm_info.Keys.Count == 1)
483 string version, culture, token;
485 version = asm_info ["version"] as string;
486 version = (version == null ? "*" : version);
487 culture = asm_info ["culture"] as string;
488 culture = (culture == null ? "*" : culture.ToLower (CultureInfo.InvariantCulture));
489 token = asm_info ["publickeytoken"] as string;
490 token = (token == null ? "*" : token.ToLower (CultureInfo.InvariantCulture));
492 return String.Format ("{0}_{1}_{2}", version, culture, token);
495 private static string AsmbNameFromVersionString (string name, string str)
497 string [] pieces = str.Split ('_');
498 return String.Format ("{0}, Version={1}, Culture={2}, PublicKeyToken={3}",
499 name, pieces [0], (pieces [1] == String.Empty ? "neutral" : pieces [1]),
503 private static bool IsSwitch (string arg)
505 return (arg [0] == '-' || arg [0] == '/');
508 private static Command GetCommand (string arg)
510 Command c = Command.Unknown;
520 case "--install-from-list":
521 c = Command.InstallFromList;
527 c = Command.Uninstall;
531 case "--uninstall-from-list":
532 c = Command.UninstallFromList;
536 case "--uninstall-specific":
537 c = Command.UninstallSpecific;
553 private static void Symlink (string oldpath, string newpath) {
554 if (Path.DirectorySeparatorChar == '/') {
555 symlink (oldpath, newpath);
557 File.Copy (oldpath, newpath);
561 [DllImport ("libc", SetLastError=true)]
562 public static extern int symlink (string oldpath, string newpath);
564 private static string GetGacDir () {
565 PropertyInfo gac = typeof (System.Environment).GetProperty ("GacPath",
566 BindingFlags.Static|BindingFlags.NonPublic);
568 WriteLine ("ERROR: Mono runtime not detected, please use " +
569 "the mono runtime for gacutil.exe");
570 Environment.Exit (1);
572 MethodInfo get_gac = gac.GetGetMethod (true);
573 return (string) get_gac.Invoke (null, null);
576 private static string GetLibDir () {
577 MethodInfo libdir = typeof (System.Environment).GetMethod ("internalGetGacPath",
578 BindingFlags.Static|BindingFlags.NonPublic);
579 if (libdir == null) {
580 WriteLine ("ERROR: Mono runtime not detected, please use " +
581 "the mono runtime for gacutil.exe");
582 Environment.Exit (1);
584 return Path.Combine ((string)libdir.Invoke (null, null), "mono");
587 private static string GetStringToken (byte[] tok)
589 StringBuilder sb = new StringBuilder ();
590 for (int i = 0; i < tok.Length ; i++)
591 sb.Append (tok[i].ToString ("x2"));
592 return sb.ToString ();
595 private static string CombinePaths (string a, string b)
597 string dsc = Path.DirectorySeparatorChar.ToString ();
598 string sep = (a.EndsWith (dsc) ? String.Empty : dsc);
599 string end = (b.StartsWith (dsc) ? b.Substring (1) : b);
600 return String.Concat (a, sep, end);
603 private static string EnsureLib (string dir)
605 DirectoryInfo d = new DirectoryInfo (dir);
608 return Path.Combine (dir, "lib");
611 private static void WriteLine ()
615 Console.WriteLine ();
618 private static void WriteLine (string line)
622 Console.WriteLine (line);
625 private static void WriteLine (string line, params object [] p)
629 Console.WriteLine (line, p);
632 private static void Usage ()
635 Environment.Exit (1);
638 private static void ShowHelp (bool detailed)
640 WriteLine ("Usage: gacutil.exe <commands> [ <options> ]");
641 WriteLine ("Commands:");
643 WriteLine ("-i <assembly_path> [-check_refs] [-package NAME] [-root ROOTDIR] [-gacdir GACDIR]");
644 WriteLine ("\tInstalls an assembly into the global assembly cache.");
646 WriteLine ("\t<assembly_path> is the name of the file that contains the " +
647 "\tassembly manifest\n" +
648 "\tExample: -i myDll.dll");
652 WriteLine ("-il <assembly_list_file> [-check_refs] [-package NAME] [-root ROOTDIR] [-gacdir GACDIR]");
653 WriteLine ("\tInstalls one or more assemblies into the global assembly cache.");
655 WriteLine ("\t<assembly_list_file> is the path to a test file containing a list of\n" +
656 "\tassembly file paths on separate lines.\n" +
657 "\tExample -il assembly_list.txt\n" +
658 "\t\tassembly_list.txt contents:\n" +
659 "\t\tassembly1.dll\n" +
660 "\t\tassembly2.dll");
664 WriteLine ("-u <assembly_display_name> [-package NAME] [-root ROOTDIR] [-gacdir GACDIR]");
665 WriteLine ("\tUninstalls an assembly from the global assembly cache.");
667 WriteLine ("\t<assembly_display_name> is the name of the assembly (partial or\n" +
668 "\tfully qualified) to remove from the global assembly cache. If a \n" +
669 "\tpartial name is specified all matching assemblies will be uninstalled.\n" +
670 "\tExample: -u myDll,Version=1.2.1.0");
674 WriteLine ("-ul <assembly_list_file> [-package NAME] [-root ROOTDIR] [-gacdir GACDIR]");
675 WriteLine ("\tUninstalls one or more assemblies from the global assembly cache.");
677 WriteLine ("\t<assembly_list_file> is the path to a test file containing a list of\n" +
678 "\tassembly names on separate lines.\n" +
679 "\tExample -ul assembly_list.txt\n" +
680 "\t\tassembly_list.txt contents:\n" +
681 "\t\tassembly1,Version=1.0.0.0,Culture=en,PublicKeyToken=0123456789abcdef\n" +
682 "\t\tassembly2,Version=2.0.0.0,Culture=en,PublicKeyToken=0123456789abcdef");
686 WriteLine ("-us <assembly_path> [-package NAME] [-root ROOTDIR] [-gacdir GACDIR]");
687 WriteLine ("\tUninstalls an assembly using the specifed assemblies full name.");
689 WriteLine ("\t<assembly path> is the path to an assembly. The full assembly name\n" +
690 "\tis retrieved from the specified assembly if there is an assembly in\n" +
691 "\tthe GAC with a matching name, it is removed.\n" +
692 "\tExample: -us myDll.dll");
696 WriteLine ("-l [assembly_name] [-root ROOTDIR] [-gacdir GACDIR]");
697 WriteLine ("\tLists the contents of the global assembly cache.");
699 WriteLine ("\tWhen the <assembly_name> parameter is specified only matching\n" +
700 "\tassemblies are listed.");
705 WriteLine ("\tDisplays a detailed help screen");
711 WriteLine ("Options:");
712 WriteLine ("-package <NAME>");
713 WriteLine ("\tUsed to create a directory in prefix/lib/mono with the name NAME, and a\n" +
714 "\tsymlink is created from NAME/assembly_name to the assembly on the GAC.\n" +
715 "\tThis is used so developers can reference a set of libraries at once.");
718 WriteLine ("-gacdir <GACDIR>");
719 WriteLine ("\tUsed to specify the GACs base directory. Once an assembly has been installed\n" +
720 "\tto a non standard gacdir the MONO_GAC_PATH environment variable must be used\n" +
721 "\tto access the assembly.");
724 WriteLine ("-root <ROOTDIR>");
725 WriteLine ("\tUsed by developers integrating this with automake tools or packaging tools\n" +
726 "\tthat require a prefix directory to be specified. The root represents the\n" +
727 "\t\"libdir\" component of a prefix (typically prefix/lib).");
730 WriteLine ("-check_refs");
731 WriteLine ("\tUsed to ensure that the assembly being installed into the GAC does not\n" +
732 "\treference any non strong named assemblies. Assemblies being installed to\n" +
733 "\tthe GAC should not reference non strong named assemblies, however the is\n" +
734 "\tan optional check.");
737 WriteLine ("Ignored Options:");
739 WriteLine ("\tThe Mono gacutil ignores the -f option to maintian commandline compatibility with");
740 WriteLine ("\tother gacutils. gacutil will always force the installation of a new assembly.");
743 WriteLine ("-r <reference_scheme> <reference_id> <description>");
744 WriteLine ("\tThe Mono gacutil has not implemented traced references and will emit a warning");
745 WriteLine ("\twhen this option is used.");