1 //------------------------------------------------------------------------------
3 // System.Environment.cs
5 // Copyright (C) 2001 Moonlight Enterprises, All Rights Reserved
7 // Author: Jim Richardson, develop@wtfo-guru.com
8 // Dan Lewis (dihlewis@yahoo.co.uk)
9 // Created: Saturday, August 11, 2001
11 //------------------------------------------------------------------------------
13 // Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)
15 // Permission is hereby granted, free of charge, to any person obtaining
16 // a copy of this software and associated documentation files (the
17 // "Software"), to deal in the Software without restriction, including
18 // without limitation the rights to use, copy, modify, merge, publish,
19 // distribute, sublicense, and/or sell copies of the Software, and to
20 // permit persons to whom the Software is furnished to do so, subject to
21 // the following conditions:
23 // The above copyright notice and this permission notice shall be
24 // included in all copies or substantial portions of the Software.
26 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
29 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
30 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
31 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
32 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 using System.Collections;
37 using System.Runtime.CompilerServices;
38 using System.Security;
39 using System.Security.Permissions;
41 using System.Runtime.InteropServices;
46 public static class Environment {
49 * This is the version number of the corlib-runtime interface. When
50 * making changes to this interface (by changing the layout
51 * of classes the runtime knows about, changing icall signature or
52 * semantics etc), increment this variable. Also increment the
53 * pair of this variable in the runtime in metadata/appdomain.c.
54 * Changes which are already detected at runtime, like the addition
55 * of icalls, do not require an increment.
57 #pragma warning disable 169
58 private const int mono_corlib_version = 90;
59 #pragma warning restore 169
62 public enum SpecialFolder
75 DesktopDirectory = 0x10,
77 ApplicationData = 0x1a,
78 LocalApplicationData = 0x1c,
82 CommonApplicationData = 0x23,
86 CommonProgramFiles = 0x2b,
87 #if NET_4_0 || MOONLIGHT
91 NetworkShortcuts = 0x13,
93 CommonStartMenu = 0x16,
94 CommonPrograms = 0x17,
96 CommonDesktopDirectory = 0x19,
97 PrinterShortcuts = 0x1b,
101 ProgramFilesX86 = 0x2a,
102 CommonProgramFilesX86 = 0x2c,
103 CommonTemplates = 0x2d,
104 CommonDocuments = 0x2e,
105 CommonAdminTools = 0x2f,
108 CommonPictures = 0x36,
111 LocalizedResources = 0x39,
112 CommonOemLinks = 0x3a,
120 enum SpecialFolderOption {
122 DoNotVerify = 0x4000,
127 /// Gets the command line for this process
129 public static string CommandLine {
130 // note: security demand inherited from calling GetCommandLineArgs
132 // FIXME: we may need to quote, but any sane person
133 // should use GetCommandLineArgs () instead.
134 return String.Join (" ", GetCommandLineArgs ());
139 /// Gets or sets the current directory. Actually this is supposed to get
140 /// and/or set the process start directory acording to the documentation
141 /// but actually test revealed at beta2 it is just Getting/Setting the CurrentDirectory
143 public static string CurrentDirectory
146 return Directory.GetCurrentDirectory ();
149 Directory.SetCurrentDirectory (value);
154 /// Gets or sets the exit code of this process
156 public extern static int ExitCode
158 [MethodImplAttribute (MethodImplOptions.InternalCall)]
160 [MethodImplAttribute (MethodImplOptions.InternalCall)]
164 static public extern bool HasShutdownStarted
166 [MethodImplAttribute (MethodImplOptions.InternalCall)]
172 /// Gets the name of the local computer
174 public extern static string MachineName {
175 [MethodImplAttribute (MethodImplOptions.InternalCall)]
176 [EnvironmentPermission (SecurityAction.Demand, Read="COMPUTERNAME")]
177 [SecurityPermission (SecurityAction.Demand, UnmanagedCode=true)]
182 /// Gets the standard new line value
184 public extern static string NewLine {
185 [MethodImplAttribute (MethodImplOptions.InternalCall)]
190 // Support methods and fields for OSVersion property
192 static OperatingSystem os;
194 internal static extern PlatformID Platform {
195 [MethodImplAttribute (MethodImplOptions.InternalCall)]
199 [MethodImplAttribute (MethodImplOptions.InternalCall)]
200 internal static extern string GetOSVersionString ();
203 /// Gets the current OS version information
205 public static OperatingSystem OSVersion {
208 Version v = Version.CreateFromString (GetOSVersionString ());
209 PlatformID p = Platform;
210 os = new OperatingSystem (p, v);
219 public static string StackTrace {
220 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
222 System.Diagnostics.StackTrace trace = new System.Diagnostics.StackTrace (0, true);
223 return trace.ToString ();
228 /// Get a fully qualified path to the system directory
230 public static string SystemDirectory {
232 return GetFolderPath (SpecialFolder.System);
237 /// Get the number of milliseconds that have elapsed since the system was booted
239 public extern static int TickCount {
240 [MethodImplAttribute (MethodImplOptions.InternalCall)]
245 /// Get UserDomainName
247 public static string UserDomainName {
248 // FIXME: this variable doesn't exist (at least not on WinXP) - reported to MS as FDBK20562
249 [EnvironmentPermission (SecurityAction.Demand, Read="USERDOMAINNAME")]
256 /// Gets a flag indicating whether the process is in interactive mode
258 [MonoTODO ("Currently always returns false, regardless of interactive state")]
259 public static bool UserInteractive {
266 /// Get the user name of current process is running under
268 public extern static string UserName {
269 [MethodImplAttribute (MethodImplOptions.InternalCall)]
270 [EnvironmentPermission (SecurityAction.Demand, Read="USERNAME;USER")]
275 /// Get the version of the common language runtime
277 public static Version Version {
279 return new Version (Consts.FxFileVersion);
284 /// Get the amount of physical memory mapped to process
286 [MonoTODO ("Currently always returns zero")]
287 public static long WorkingSet {
288 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
292 [MethodImplAttribute (MethodImplOptions.InternalCall)]
293 [SecurityPermission (SecurityAction.Demand, UnmanagedCode=true)]
294 public extern static void Exit (int exitCode);
297 /// Substitute environment variables in the argument "name"
299 public static string ExpandEnvironmentVariables (string name)
302 throw new ArgumentNullException ("name");
304 int off1 = name.IndexOf ('%');
308 int len = name.Length;
310 if (off1 == len - 1 || (off2 = name.IndexOf ('%', off1 + 1)) == -1)
313 StringBuilder result = new StringBuilder ();
314 result.Append (name, 0, off1);
315 Hashtable tbl = null;
317 string var = name.Substring (off1 + 1, off2 - off1 - 1);
318 string value = GetEnvironmentVariable (var);
319 if (value == null && Environment.IsRunningOnWindows) {
320 // On windows, env. vars. are case insensitive
322 tbl = GetEnvironmentVariablesNoCase ();
324 value = tbl [var] as string;
327 // If value not found, add %FOO to stream,
328 // and use the closing % for the next iteration.
329 // If value found, expand it in place of %FOO%
335 result.Append (value);
338 off1 = name.IndexOf ('%', off2 + 1);
339 // If no % found for off1, don't look for one for off2
340 off2 = (off1 == -1 || off2 > len-1)? -1 :name.IndexOf ('%', off1 + 1);
341 // textLen is the length of text between the closing % of current iteration
342 // and the starting % of the next iteration if any. This text is added to output
344 // If no new % found, use all the remaining text
345 if (off1 == -1 || off2 == -1)
346 textLen = len - oldOff2 - 1;
347 // If value found in current iteration, use text after current closing % and next %
348 else if(value != null)
349 textLen = off1 - oldOff2 - 1;
350 // If value not found in current iteration, but a % was found for next iteration,
351 // use text from current closing % to the next %.
353 textLen = off1 - oldOff2;
354 if(off1 >= oldOff2 || off1 == -1)
355 result.Append (name, oldOff2+1, textLen);
356 } while (off2 > -1 && off2 < len);
358 return result.ToString ();
363 /// Return an array of the command line arguments of the current process
365 [MethodImplAttribute (MethodImplOptions.InternalCall)]
366 [EnvironmentPermissionAttribute (SecurityAction.Demand, Read = "PATH")]
367 public extern static string[] GetCommandLineArgs ();
369 [MethodImplAttribute (MethodImplOptions.InternalCall)]
370 internal extern static string internalGetEnvironmentVariable (string variable);
373 /// Return a string containing the value of the environment
374 /// variable identifed by parameter "variable"
376 public static string GetEnvironmentVariable (string variable)
379 if (SecurityManager.SecurityEnabled) {
380 new EnvironmentPermission (EnvironmentPermissionAccess.Read, variable).Demand ();
383 return internalGetEnvironmentVariable (variable);
386 static Hashtable GetEnvironmentVariablesNoCase ()
388 Hashtable vars = new Hashtable (CaseInsensitiveHashCodeProvider.Default,
389 CaseInsensitiveComparer.Default);
391 foreach (string name in GetEnvironmentVariableNames ()) {
392 vars [name] = internalGetEnvironmentVariable (name);
399 /// Return a set of all environment variables and their values
402 public static IDictionary GetEnvironmentVariables ()
404 StringBuilder sb = null;
405 if (SecurityManager.SecurityEnabled) {
406 // we must have access to each variable to get the lot
407 sb = new StringBuilder ();
408 // but (performance-wise) we do not want a stack-walk
409 // for each of them so we concatenate them
412 Hashtable vars = new Hashtable ();
413 foreach (string name in GetEnvironmentVariableNames ()) {
414 vars [name] = internalGetEnvironmentVariable (name);
422 new EnvironmentPermission (EnvironmentPermissionAccess.Read, sb.ToString ()).Demand ();
427 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
428 public static IDictionary GetEnvironmentVariables ()
430 Hashtable vars = new Hashtable ();
431 foreach (string name in GetEnvironmentVariableNames ()) {
432 vars [name] = internalGetEnvironmentVariable (name);
438 [MethodImplAttribute (MethodImplOptions.InternalCall)]
439 private extern static string GetWindowsFolderPath (int folder);
442 /// Returns the fully qualified path of the
443 /// folder specified by the "folder" parameter
445 public static string GetFolderPath (SpecialFolder folder)
447 return GetFolderPath (folder, SpecialFolderOption.None);
450 [MonoTODO ("Figure out the folder path for all the new values in SpecialFolder. Use the 'option' argument.")]
453 static string GetFolderPath(SpecialFolder folder, SpecialFolderOption option)
455 SecurityManager.EnsureElevatedPermissions (); // this is a no-op outside moonlight
459 if (Environment.IsRunningOnWindows) {
460 dir = GetWindowsFolderPath ((int) folder);
462 dir = InternalGetFolderPath (folder);
465 if ((dir != null) && (dir.Length > 0) && SecurityManager.SecurityEnabled) {
466 new FileIOPermission (FileIOPermissionAccess.PathDiscovery, dir).Demand ();
472 private static string ReadXdgUserDir (string config_dir, string home_dir,
473 string key, string fallback)
475 string env_path = internalGetEnvironmentVariable (key);
476 if (env_path != null && env_path != String.Empty) {
480 string user_dirs_path = Path.Combine (config_dir, "user-dirs.dirs");
482 if (!File.Exists (user_dirs_path)) {
483 return Path.Combine (home_dir, fallback);
487 using(StreamReader reader = new StreamReader (user_dirs_path)) {
489 while ((line = reader.ReadLine ()) != null) {
491 int delim_index = line.IndexOf ('=');
492 if(delim_index > 8 && line.Substring (0, delim_index) == key) {
493 string path = line.Substring (delim_index + 1).Trim ('"');
494 bool relative = false;
496 if (path.StartsWith ("$HOME/")) {
498 path = path.Substring (6);
499 } else if (!path.StartsWith ("/")) {
503 return relative ? Path.Combine (home_dir, path) : path;
507 } catch (FileNotFoundException) {
510 return Path.Combine (home_dir, fallback);
514 // the security runtime (and maybe other parts of corlib) needs the
515 // information to initialize themselves before permissions can be checked
516 internal static string InternalGetFolderPath (SpecialFolder folder)
518 string home = internalGetHome ();
520 // http://freedesktop.org/Standards/basedir-spec/basedir-spec-0.6.html
522 // note: skip security check for environment variables
523 string data = internalGetEnvironmentVariable ("XDG_DATA_HOME");
524 if ((data == null) || (data == String.Empty)) {
525 data = Path.Combine (home, ".local");
526 data = Path.Combine (data, "share");
529 // note: skip security check for environment variables
530 string config = internalGetEnvironmentVariable ("XDG_CONFIG_HOME");
531 if ((config == null) || (config == String.Empty)) {
532 config = Path.Combine (home, ".config");
536 // MyComputer is a virtual directory
537 case SpecialFolder.MyComputer:
541 case SpecialFolder.Personal:
543 return Path.Combine (home, "Documents");
547 // use FDO's CONFIG_HOME. This data will be synced across a network like the windows counterpart.
548 case SpecialFolder.ApplicationData:
550 //use FDO's DATA_HOME. This is *NOT* synced
551 case SpecialFolder.LocalApplicationData:
553 case SpecialFolder.Desktop:
554 case SpecialFolder.DesktopDirectory:
555 return ReadXdgUserDir (config, home, "XDG_DESKTOP_DIR", "Desktop");
557 case SpecialFolder.MyMusic:
558 return ReadXdgUserDir (config, home, "XDG_MUSIC_DIR", "Music");
560 case SpecialFolder.MyPictures:
561 return ReadXdgUserDir (config, home, "XDG_PICTURES_DIR", "Pictures");
563 // these simply dont exist on Linux
564 // The spec says if a folder doesnt exist, we
566 case SpecialFolder.Favorites:
567 case SpecialFolder.Programs:
568 case SpecialFolder.SendTo:
569 case SpecialFolder.StartMenu:
570 case SpecialFolder.Startup:
571 case SpecialFolder.Templates:
572 case SpecialFolder.Cookies:
573 case SpecialFolder.History:
574 case SpecialFolder.InternetCache:
575 case SpecialFolder.Recent:
576 case SpecialFolder.CommonProgramFiles:
577 case SpecialFolder.ProgramFiles:
578 case SpecialFolder.System:
580 // This is where data common to all users goes
581 case SpecialFolder.CommonApplicationData:
584 throw new ArgumentException ("Invalid SpecialFolder");
588 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
589 public static string[] GetLogicalDrives ()
591 return GetLogicalDrivesInternal ();
595 [MethodImplAttribute (MethodImplOptions.InternalCall)]
596 private static extern void internalBroadcastSettingChange ();
598 public static string GetEnvironmentVariable (string variable, EnvironmentVariableTarget target)
601 case EnvironmentVariableTarget.Process:
602 return GetEnvironmentVariable (variable);
603 case EnvironmentVariableTarget.Machine:
604 new EnvironmentPermission (PermissionState.Unrestricted).Demand ();
605 if (!IsRunningOnWindows)
607 using (Microsoft.Win32.RegistryKey env = Microsoft.Win32.Registry.LocalMachine.OpenSubKey (@"SYSTEM\CurrentControlSet\Control\Session Manager\Environment")) {
608 object regvalue = env.GetValue (variable);
609 return (regvalue == null) ? null : regvalue.ToString ();
611 case EnvironmentVariableTarget.User:
612 new EnvironmentPermission (PermissionState.Unrestricted).Demand ();
613 if (!IsRunningOnWindows)
615 using (Microsoft.Win32.RegistryKey env = Microsoft.Win32.Registry.CurrentUser.OpenSubKey ("Environment", false)) {
616 object regvalue = env.GetValue (variable);
617 return (regvalue == null) ? null : regvalue.ToString ();
620 throw new ArgumentException ("target");
624 public static IDictionary GetEnvironmentVariables (EnvironmentVariableTarget target)
626 IDictionary variables = (IDictionary)new Hashtable ();
628 case EnvironmentVariableTarget.Process:
629 variables = GetEnvironmentVariables ();
631 case EnvironmentVariableTarget.Machine:
632 new EnvironmentPermission (PermissionState.Unrestricted).Demand ();
633 if (IsRunningOnWindows) {
634 using (Microsoft.Win32.RegistryKey env = Microsoft.Win32.Registry.LocalMachine.OpenSubKey (@"SYSTEM\CurrentControlSet\Control\Session Manager\Environment")) {
635 string[] value_names = env.GetValueNames ();
636 foreach (string value_name in value_names)
637 variables.Add (value_name, env.GetValue (value_name));
641 case EnvironmentVariableTarget.User:
642 new EnvironmentPermission (PermissionState.Unrestricted).Demand ();
643 if (IsRunningOnWindows) {
644 using (Microsoft.Win32.RegistryKey env = Microsoft.Win32.Registry.CurrentUser.OpenSubKey ("Environment")) {
645 string[] value_names = env.GetValueNames ();
646 foreach (string value_name in value_names)
647 variables.Add (value_name, env.GetValue (value_name));
652 throw new ArgumentException ("target");
657 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
658 public static void SetEnvironmentVariable (string variable, string value)
660 SetEnvironmentVariable (variable, value, EnvironmentVariableTarget.Process);
663 [EnvironmentPermission (SecurityAction.Demand, Unrestricted = true)]
664 public static void SetEnvironmentVariable (string variable, string value, EnvironmentVariableTarget target)
666 if (variable == null)
667 throw new ArgumentNullException ("variable");
668 if (variable == String.Empty)
669 throw new ArgumentException ("String cannot be of zero length.", "variable");
670 if (variable.IndexOf ('=') != -1)
671 throw new ArgumentException ("Environment variable name cannot contain an equal character.", "variable");
672 if (variable[0] == '\0')
673 throw new ArgumentException ("The first char in the string is the null character.", "variable");
676 case EnvironmentVariableTarget.Process:
677 InternalSetEnvironmentVariable (variable, value);
679 case EnvironmentVariableTarget.Machine:
680 if (!IsRunningOnWindows)
682 using (Microsoft.Win32.RegistryKey env = Microsoft.Win32.Registry.LocalMachine.OpenSubKey (@"SYSTEM\CurrentControlSet\Control\Session Manager\Environment", true)) {
683 if (String.IsNullOrEmpty (value))
684 env.DeleteValue (variable, false);
686 env.SetValue (variable, value);
687 internalBroadcastSettingChange ();
690 case EnvironmentVariableTarget.User:
691 if (!IsRunningOnWindows)
693 using (Microsoft.Win32.RegistryKey env = Microsoft.Win32.Registry.CurrentUser.OpenSubKey ("Environment", true)) {
694 if (String.IsNullOrEmpty (value))
695 env.DeleteValue (variable, false);
697 env.SetValue (variable, value);
698 internalBroadcastSettingChange ();
702 throw new ArgumentException ("target");
706 [MethodImplAttribute (MethodImplOptions.InternalCall)]
707 internal static extern void InternalSetEnvironmentVariable (string variable, string value);
709 [SecurityPermission (SecurityAction.LinkDemand, UnmanagedCode=true)]
710 public static void FailFast (string message)
712 throw new NotImplementedException ();
715 #if NET_4_0 || MOONLIGHT
717 public static void FailFast (string message, Exception exception)
719 throw new NotImplementedException ();
724 public static bool Is64BitOperatingSystem {
725 get { return IntPtr.Size == 8; } // FIXME: is this good enough?
728 public static bool Is64BitProcess {
729 get { return Is64BitOperatingSystem; }
732 public static int SystemPageSize {
733 get { return GetPageSize (); }
737 public static extern int ProcessorCount {
738 [EnvironmentPermission (SecurityAction.Demand, Read="NUMBER_OF_PROCESSORS")]
739 [MethodImplAttribute (MethodImplOptions.InternalCall)]
745 internal static bool IsRunningOnWindows {
746 get { return ((int) Platform < 4); }
750 // Used by gacutil.exe
752 #pragma warning disable 169
753 private static string GacPath {
755 if (Environment.IsRunningOnWindows) {
756 /* On windows, we don't know the path where mscorlib.dll will be installed */
757 string corlibDir = new DirectoryInfo (Path.GetDirectoryName (typeof (int).Assembly.Location)).Parent.Parent.FullName;
758 return Path.Combine (Path.Combine (corlibDir, "mono"), "gac");
761 return Path.Combine (Path.Combine (internalGetGacPath (), "mono"), "gac");
764 #pragma warning restore 169
765 [MethodImplAttribute (MethodImplOptions.InternalCall)]
766 internal extern static string internalGetGacPath ();
768 [MethodImplAttribute (MethodImplOptions.InternalCall)]
769 private extern static string [] GetLogicalDrivesInternal ();
771 [MethodImplAttribute (MethodImplOptions.InternalCall)]
772 private extern static string [] GetEnvironmentVariableNames ();
774 [MethodImplAttribute (MethodImplOptions.InternalCall)]
775 internal extern static string GetMachineConfigPath ();
777 [MethodImplAttribute (MethodImplOptions.InternalCall)]
778 internal extern static string internalGetHome ();
780 [MethodImplAttribute (MethodImplOptions.InternalCall)]
781 internal extern static int GetPageSize ();
783 static internal bool IsUnix {
785 int platform = (int) Environment.Platform;
787 return (platform == 4 || platform == 128 || platform == 6);