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;
49 public static class Environment {
51 public sealed class Environment {
53 private Environment ()
58 * This is the version number of the corlib-runtime interface. When
59 * making changes to this interface (by changing the layout
60 * of classes the runtime knows about, changing icall signature or
61 * semantics etc), increment this variable. Also increment the
62 * pair of this variable in the runtime in metadata/appdomain.c.
63 * Changes which are already detected at runtime, like the addition
64 * of icalls, do not require an increment.
66 private const int mono_corlib_version = 58;
68 public enum SpecialFolder
69 { // TODO: Determine if these windoze style folder identifiers
70 // have unix/linux counterparts
86 DesktopDirectory = 0x10,
88 ApplicationData = 0x1a,
89 LocalApplicationData = 0x1c,
93 CommonApplicationData = 0x23,
97 CommonProgramFiles = 0x2b,
101 /// Gets the command line for this process
103 public static string CommandLine {
104 // note: security demand inherited from calling GetCommandLineArgs
106 // FIXME: we may need to quote, but any sane person
107 // should use GetCommandLineArgs () instead.
108 return String.Join (" ", GetCommandLineArgs ());
113 /// Gets or sets the current directory. Actually this is supposed to get
114 /// and/or set the process start directory acording to the documentation
115 /// but actually test revealed at beta2 it is just Getting/Setting the CurrentDirectory
117 public static string CurrentDirectory
120 return Directory.GetCurrentDirectory ();
123 Directory.SetCurrentDirectory (value);
128 /// Gets or sets the exit code of this process
130 public extern static int ExitCode
132 [MethodImplAttribute (MethodImplOptions.InternalCall)]
134 [MethodImplAttribute (MethodImplOptions.InternalCall)]
141 public extern bool HasShutdownStarted
143 [MethodImplAttribute (MethodImplOptions.InternalCall)]
149 /// Gets the name of the local computer
151 public extern static string MachineName {
152 [MethodImplAttribute (MethodImplOptions.InternalCall)]
153 [EnvironmentPermission (SecurityAction.Demand, Read="COMPUTERNAME")]
154 [SecurityPermission (SecurityAction.Demand, UnmanagedCode=true)]
159 /// Gets the standard new line value
161 public extern static string NewLine {
162 [MethodImplAttribute (MethodImplOptions.InternalCall)]
167 // Support methods and fields for OSVersion property
169 static OperatingSystem os;
171 internal static extern PlatformID Platform {
172 [MethodImplAttribute (MethodImplOptions.InternalCall)]
176 [MethodImplAttribute (MethodImplOptions.InternalCall)]
177 internal static extern string GetOSVersionString ();
180 /// Gets the current OS version information
182 public static OperatingSystem OSVersion {
185 Version v = Version.CreateFromString (GetOSVersionString ());
186 PlatformID p = Platform;
191 os = new OperatingSystem (p, v);
200 public static string StackTrace {
201 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
203 System.Diagnostics.StackTrace trace = new System.Diagnostics.StackTrace (0, true);
204 return trace.ToString ();
209 /// Get a fully qualified path to the system directory
211 public static string SystemDirectory {
213 return GetFolderPath (SpecialFolder.System);
218 /// Get the number of milliseconds that have elapsed since the system was booted
220 public extern static int TickCount {
221 [MethodImplAttribute (MethodImplOptions.InternalCall)]
226 /// Get UserDomainName
228 public static string UserDomainName {
229 // FIXME: this variable doesn't exist (at least not on WinXP) - reported to MS as FDBK20562
230 [EnvironmentPermission (SecurityAction.Demand, Read="USERDOMAINNAME")]
237 /// Gets a flag indicating whether the process is in interactive mode
239 [MonoTODO ("Currently always returns false, regardless of interactive state")]
240 public static bool UserInteractive {
247 /// Get the user name of current process is running under
249 public extern static string UserName {
250 [MethodImplAttribute (MethodImplOptions.InternalCall)]
251 [EnvironmentPermission (SecurityAction.Demand, Read="USERNAME;USER")]
256 /// Get the version of the common language runtime
258 public static Version Version {
260 return new Version (Consts.FxFileVersion);
265 /// Get the amount of physical memory mapped to process
267 [MonoTODO ("Currently always returns zero")]
268 public static long WorkingSet {
269 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
273 [MethodImplAttribute (MethodImplOptions.InternalCall)]
274 [SecurityPermission (SecurityAction.Demand, UnmanagedCode=true)]
275 public extern static void Exit (int exitCode);
278 /// Substitute environment variables in the argument "name"
280 public static string ExpandEnvironmentVariables (string name)
283 throw new ArgumentNullException ("name");
285 int off1 = name.IndexOf ('%');
289 int len = name.Length;
291 if (off1 == len - 1 || (off2 = name.IndexOf ('%', off1 + 1)) == -1)
294 StringBuilder result = new StringBuilder ();
295 result.Append (name, 0, off1);
296 Hashtable tbl = null;
298 string var = name.Substring (off1 + 1, off2 - off1 - 1);
299 string value = GetEnvironmentVariable (var);
300 if (value == null && Environment.IsRunningOnWindows) {
301 // On windows, env. vars. are case insensitive
303 tbl = GetEnvironmentVariablesNoCase ();
305 value = tbl [var] as string;
308 // If value not found, add %FOO to stream,
309 // and use the closing % for the next iteration.
310 // If value found, expand it in place of %FOO%
316 result.Append (value);
319 off1 = name.IndexOf ('%', off2 + 1);
320 // If no % found for off1, don't look for one for off2
321 off2 = (off1 == -1 || off2 > len-1)? -1 :name.IndexOf ('%', off1 + 1);
322 // textLen is the length of text between the closing % of current iteration
323 // and the starting % of the next iteration if any. This text is added to output
325 // If no new % found, use all the remaining text
326 if (off1 == -1 || off2 == -1)
327 textLen = len - oldOff2 - 1;
328 // If value found in current iteration, use text after current closing % and next %
329 else if(value != null)
330 textLen = off1 - oldOff2 - 1;
331 // If value not found in current iteration, but a % was found for next iteration,
332 // use text from current closing % to the next %.
334 textLen = off1 - oldOff2;
335 if(off1 >= oldOff2 || off1 == -1)
336 result.Append (name, oldOff2+1, textLen);
337 } while (off2 > -1 && off2 < len);
339 return result.ToString ();
344 /// Return an array of the command line arguments of the current process
346 [MethodImplAttribute (MethodImplOptions.InternalCall)]
347 [EnvironmentPermissionAttribute (SecurityAction.Demand, Read = "PATH")]
348 public extern static string[] GetCommandLineArgs ();
350 [MethodImplAttribute (MethodImplOptions.InternalCall)]
351 internal extern static string internalGetEnvironmentVariable (string name);
354 /// Return a string containing the value of the environment
355 /// variable identifed by parameter "variable"
357 public static string GetEnvironmentVariable (string name)
359 if (SecurityManager.SecurityEnabled) {
360 new EnvironmentPermission (EnvironmentPermissionAccess.Read, name).Demand ();
362 return internalGetEnvironmentVariable (name);
365 static Hashtable GetEnvironmentVariablesNoCase ()
367 Hashtable vars = new Hashtable (CaseInsensitiveHashCodeProvider.Default,
368 CaseInsensitiveComparer.Default);
370 foreach (string name in GetEnvironmentVariableNames ()) {
371 vars [name] = internalGetEnvironmentVariable (name);
378 /// Return a set of all environment variables and their values
381 public static IDictionary GetEnvironmentVariables ()
383 StringBuilder sb = null;
384 if (SecurityManager.SecurityEnabled) {
385 // we must have access to each variable to get the lot
386 sb = new StringBuilder ();
387 // but (performance-wise) we do not want a stack-walk
388 // for each of them so we concatenate them
391 Hashtable vars = new Hashtable ();
392 foreach (string name in GetEnvironmentVariableNames ()) {
393 vars [name] = internalGetEnvironmentVariable (name);
401 new EnvironmentPermission (EnvironmentPermissionAccess.Read, sb.ToString ()).Demand ();
406 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
407 public static IDictionary GetEnvironmentVariables ()
409 Hashtable vars = new Hashtable ();
410 foreach (string name in GetEnvironmentVariableNames ()) {
411 vars [name] = internalGetEnvironmentVariable (name);
417 [MethodImplAttribute (MethodImplOptions.InternalCall)]
418 private extern static string GetWindowsFolderPath (int folder);
421 /// Returns the fully qualified path of the
422 /// folder specified by the "folder" parameter
424 public static string GetFolderPath (SpecialFolder folder)
428 if (Environment.IsRunningOnWindows) {
429 dir = GetWindowsFolderPath ((int) folder);
431 dir = InternalGetFolderPath (folder);
434 if ((dir != null) && (dir.Length > 0) && SecurityManager.SecurityEnabled) {
435 new FileIOPermission (FileIOPermissionAccess.PathDiscovery, dir).Demand ();
440 private static string ReadXdgUserDir (string config_dir, string home_dir,
441 string key, string fallback)
443 string env_path = internalGetEnvironmentVariable (key);
444 if (env_path != null && env_path != String.Empty) {
448 string user_dirs_path = Path.Combine (config_dir, "user-dirs.dirs");
450 if (!File.Exists (user_dirs_path)) {
451 return Path.Combine (home_dir, fallback);
455 using(StreamReader reader = new StreamReader (user_dirs_path)) {
457 while ((line = reader.ReadLine ()) != null) {
459 int delim_index = line.IndexOf ('=');
460 if (delim_index > 8 && line.Substring (0, delim_index) == key) {
461 return Path.Combine (home_dir, line.Substring (delim_index + 1));
465 } catch (FileNotFoundException) {
468 return Path.Combine (home_dir, fallback);
472 // the security runtime (and maybe other parts of corlib) needs the
473 // information to initialize themselves before permissions can be checked
474 internal static string InternalGetFolderPath (SpecialFolder folder)
476 string home = internalGetHome ();
478 // http://freedesktop.org/Standards/basedir-spec/basedir-spec-0.6.html
480 // note: skip security check for environment variables
481 string data = internalGetEnvironmentVariable ("XDG_DATA_HOME");
482 if ((data == null) || (data == String.Empty)) {
483 data = Path.Combine (home, ".local");
484 data = Path.Combine (data, "share");
487 // note: skip security check for environment variables
488 string config = internalGetEnvironmentVariable ("XDG_CONFIG_HOME");
489 if ((config == null) || (config == String.Empty)) {
490 config = Path.Combine (home, ".config");
495 // MyComputer is a virtual directory
496 case SpecialFolder.MyComputer:
500 case SpecialFolder.Personal:
502 // use FDO's CONFIG_HOME. This data will be synced across a network like the windows counterpart.
503 case SpecialFolder.ApplicationData:
505 //use FDO's DATA_HOME. This is *NOT* synced
506 case SpecialFolder.LocalApplicationData:
509 case SpecialFolder.Desktop:
511 case SpecialFolder.DesktopDirectory:
512 return ReadXdgUserDir (config, home, "XDG_DESKTOP_DIR", "Desktop");
514 case SpecialFolder.MyMusic:
515 return ReadXdgUserDir (config, home, "XDG_MUSIC_DIR", "Music");
517 case SpecialFolder.MyPictures:
518 return ReadXdgUserDir (config, home, "XDG_PICTURES_DIR", "Pictures");
520 // these simply dont exist on Linux
521 // The spec says if a folder doesnt exist, we
523 case SpecialFolder.Favorites:
524 case SpecialFolder.Programs:
525 case SpecialFolder.SendTo:
526 case SpecialFolder.StartMenu:
527 case SpecialFolder.Startup:
528 case SpecialFolder.Templates:
529 case SpecialFolder.Cookies:
530 case SpecialFolder.History:
531 case SpecialFolder.InternetCache:
532 case SpecialFolder.Recent:
533 case SpecialFolder.CommonProgramFiles:
534 case SpecialFolder.ProgramFiles:
535 case SpecialFolder.System:
537 // This is where data common to all users goes
538 case SpecialFolder.CommonApplicationData:
541 throw new ArgumentException ("Invalid SpecialFolder");
545 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
546 public static string[] GetLogicalDrives ()
548 return GetLogicalDrivesInternal ();
551 // FIXME: Anyone using this anywhere ?
552 static internal string GetResourceString (string s) { return String.Empty; }
556 public static string GetEnvironmentVariable (string variable, EnvironmentVariableTarget target)
559 case EnvironmentVariableTarget.Process:
560 return GetEnvironmentVariable (variable);
561 case EnvironmentVariableTarget.Machine:
562 new EnvironmentPermission (PermissionState.Unrestricted).Demand ();
563 if (!IsRunningOnWindows)
565 using (Microsoft.Win32.RegistryKey env = Microsoft.Win32.Registry.LocalMachine.OpenSubKey (@"SYSTEM\CurrentControlSet\Control\Session Manager\Environment")) {
566 return env.GetValue (variable).ToString ();
568 case EnvironmentVariableTarget.User:
569 new EnvironmentPermission (PermissionState.Unrestricted).Demand ();
570 if (!IsRunningOnWindows)
572 using (Microsoft.Win32.RegistryKey env = Microsoft.Win32.Registry.CurrentUser.OpenSubKey ("Environment", false)) {
573 return env.GetValue (variable).ToString ();
576 throw new ArgumentException ("target");
580 public static IDictionary GetEnvironmentVariables (EnvironmentVariableTarget target)
582 IDictionary variables = (IDictionary)new Hashtable ();
584 case EnvironmentVariableTarget.Process:
585 variables = GetEnvironmentVariables ();
587 case EnvironmentVariableTarget.Machine:
588 new EnvironmentPermission (PermissionState.Unrestricted).Demand ();
589 if (IsRunningOnWindows) {
590 using (Microsoft.Win32.RegistryKey env = Microsoft.Win32.Registry.LocalMachine.OpenSubKey (@"SYSTEM\CurrentControlSet\Control\Session Manager\Environment")) {
591 string[] value_names = env.GetValueNames ();
592 foreach (string value_name in value_names)
593 variables.Add (value_name, env.GetValue (value_name));
597 case EnvironmentVariableTarget.User:
598 new EnvironmentPermission (PermissionState.Unrestricted).Demand ();
599 if (IsRunningOnWindows) {
600 using (Microsoft.Win32.RegistryKey env = Microsoft.Win32.Registry.CurrentUser.OpenSubKey ("Environment")) {
601 string[] value_names = env.GetValueNames ();
602 foreach (string value_name in value_names)
603 variables.Add (value_name, env.GetValue (value_name));
608 throw new ArgumentException ("target");
613 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
614 public static void SetEnvironmentVariable (string variable, string value)
616 SetEnvironmentVariable (variable, value, EnvironmentVariableTarget.Process);
619 [EnvironmentPermission (SecurityAction.Demand, Unrestricted = true)]
620 public static void SetEnvironmentVariable (string variable, string value, EnvironmentVariableTarget target)
622 if (variable == null)
623 throw new ArgumentNullException ("variable");
624 if (variable == String.Empty)
625 throw new ArgumentException ("String cannot be of zero length.", "variable");
626 if (variable.IndexOf ('=') != -1)
627 throw new ArgumentException ("Environment variable name cannot contain an equal character.", "variable");
628 if (variable[0] == '\0')
629 throw new ArgumentException ("The first char in the string is the null character.", "variable");
632 case EnvironmentVariableTarget.Process:
633 InternalSetEnvironmentVariable (variable, value);
635 case EnvironmentVariableTarget.Machine:
636 if (!IsRunningOnWindows)
638 using (Microsoft.Win32.RegistryKey env = Microsoft.Win32.Registry.LocalMachine.OpenSubKey (@"SYSTEM\CurrentControlSet\Control\Session Manager\Environment", true)) {
639 if (value == null || value.Length == 0)
640 env.DeleteValue (variable, false);
642 env.SetValue (variable, value);
645 case EnvironmentVariableTarget.User:
646 if (!IsRunningOnWindows)
648 using (Microsoft.Win32.RegistryKey env = Microsoft.Win32.Registry.CurrentUser.OpenSubKey ("Environment", true)) {
649 if (value == null || value.Length == 0)
650 env.DeleteValue (variable, false);
652 env.SetValue (variable, value);
656 throw new ArgumentException ("target");
660 [MethodImplAttribute (MethodImplOptions.InternalCall)]
661 internal static extern void InternalSetEnvironmentVariable (string variable, string value);
663 public static extern int ProcessorCount {
664 [EnvironmentPermission (SecurityAction.Demand, Read="NUMBER_OF_PROCESSORS")]
665 [MethodImplAttribute (MethodImplOptions.InternalCall)]
669 [MonoTODO ("Not implemented")]
670 [SecurityPermission (SecurityAction.LinkDemand, UnmanagedCode=true)]
671 public static void FailFast (string message)
673 throw new NotImplementedException ();
679 internal static bool IsRunningOnWindows {
680 get { return ((int) Platform != 128); }
683 private static string GacPath {
685 if (Environment.IsRunningOnWindows) {
686 /* On windows, we don't know the path where mscorlib.dll will be installed */
687 string corlibDir = new DirectoryInfo (Path.GetDirectoryName (typeof (int).Assembly.Location)).Parent.Parent.FullName;
688 return Path.Combine (Path.Combine (corlibDir, "mono"), "gac");
691 return Path.Combine (Path.Combine (internalGetGacPath (), "mono"), "gac");
695 [MethodImplAttribute (MethodImplOptions.InternalCall)]
696 private extern static string [] GetLogicalDrivesInternal ();
698 [MethodImplAttribute (MethodImplOptions.InternalCall)]
699 private extern static string [] GetEnvironmentVariableNames ();
701 [MethodImplAttribute (MethodImplOptions.InternalCall)]
702 internal extern static string GetMachineConfigPath ();
704 [MethodImplAttribute (MethodImplOptions.InternalCall)]
705 internal extern static string internalGetGacPath ();
707 [MethodImplAttribute (MethodImplOptions.InternalCall)]
708 internal extern static string internalGetHome ();