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;
45 public static class Environment {
47 public sealed class Environment {
49 private Environment ()
54 * This is the version number of the corlib-runtime interface. When
55 * making changes to this interface (by changing the layout
56 * of classes the runtime knows about, changing icall signature or
57 * semantics etc), increment this variable. Also increment the
58 * pair of this variable in the runtime in metadata/appdomain.c.
59 * Changes which are already detected at runtime, like the addition
60 * of icalls, do not require an increment.
62 private const int mono_corlib_version = 51;
65 public enum SpecialFolder
66 { // TODO: Determine if these windoze style folder identifiers
67 // have unix/linux counterparts
83 DesktopDirectory = 0x10,
85 ApplicationData = 0x1a,
86 LocalApplicationData = 0x1c,
90 CommonApplicationData = 0x23,
94 CommonProgramFiles = 0x2b,
98 /// Gets the command line for this process
100 public static string CommandLine {
101 // note: security demand inherited from calling GetCommandLineArgs
103 // FIXME: we may need to quote, but any sane person
104 // should use GetCommandLineArgs () instead.
105 return String.Join (" ", GetCommandLineArgs ());
110 /// Gets or sets the current directory. Actually this is supposed to get
111 /// and/or set the process start directory acording to the documentation
112 /// but actually test revealed at beta2 it is just Getting/Setting the CurrentDirectory
114 public static string CurrentDirectory
117 return Directory.GetCurrentDirectory ();
120 Directory.SetCurrentDirectory (value);
125 /// Gets or sets the exit code of this process
127 public extern static int ExitCode
129 [MethodImplAttribute (MethodImplOptions.InternalCall)]
131 [MethodImplAttribute (MethodImplOptions.InternalCall)]
138 public extern bool HasShutdownStarted
140 [MethodImplAttribute (MethodImplOptions.InternalCall)]
146 /// Gets the name of the local computer
148 public extern static string MachineName {
149 [MethodImplAttribute (MethodImplOptions.InternalCall)]
150 [EnvironmentPermission (SecurityAction.Demand, Read="COMPUTERNAME")]
151 [SecurityPermission (SecurityAction.Demand, UnmanagedCode=true)]
156 /// Gets the standard new line value
158 public extern static string NewLine {
159 [MethodImplAttribute (MethodImplOptions.InternalCall)]
164 // Support methods and fields for OSVersion property
166 static OperatingSystem os;
168 internal static extern PlatformID Platform {
169 [MethodImplAttribute (MethodImplOptions.InternalCall)]
173 [MethodImplAttribute (MethodImplOptions.InternalCall)]
174 internal static extern string GetOSVersionString ();
177 /// Gets the current OS version information
179 public static OperatingSystem OSVersion {
182 Version v = Version.CreateFromString (GetOSVersionString ());
183 PlatformID p = Platform;
188 os = new OperatingSystem (p, v);
197 public static string StackTrace {
198 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
200 System.Diagnostics.StackTrace trace = new System.Diagnostics.StackTrace (1);
201 return trace.ToString ();
206 /// Get a fully qualified path to the system directory
208 public static string SystemDirectory {
210 return GetFolderPath (SpecialFolder.System);
215 /// Get the number of milliseconds that have elapsed since the system was booted
217 public extern static int TickCount {
218 [MethodImplAttribute (MethodImplOptions.InternalCall)]
223 /// Get UserDomainName
225 public static string UserDomainName {
226 // FIXME: this variable doesn't exist (at least not on WinXP) - reported to MS as FDBK20562
227 [EnvironmentPermission (SecurityAction.Demand, Read="USERDOMAINNAME")]
234 /// Gets a flag indicating whether the process is in interactive mode
237 public static bool UserInteractive {
244 /// Get the user name of current process is running under
246 public extern static string UserName {
247 [MethodImplAttribute (MethodImplOptions.InternalCall)]
248 [EnvironmentPermission (SecurityAction.Demand, Read="USERNAME;USER")]
253 /// Get the version of the common language runtime
255 public static Version Version {
257 return new Version (Consts.RuntimeVersion);
262 /// Get the amount of physical memory mapped to process
265 public static long WorkingSet {
266 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
270 [MethodImplAttribute (MethodImplOptions.InternalCall)]
271 [SecurityPermission (SecurityAction.Demand, UnmanagedCode=true)]
272 public extern static void Exit (int exitCode);
275 /// Substitute environment variables in the argument "name"
277 public static string ExpandEnvironmentVariables (string name)
280 throw new ArgumentNullException ("name");
282 int off1 = name.IndexOf ('%');
286 int len = name.Length;
288 if (off1 == len - 1 || (off2 = name.IndexOf ('%', off1 + 1)) == -1)
291 StringBuilder result = new StringBuilder ();
292 result.Append (name, 0, off1);
293 Hashtable tbl = null;
295 string var = name.Substring (off1 + 1, off2 - off1 - 1);
296 string value = GetEnvironmentVariable (var);
297 if (value == null && Environment.IsRunningOnWindows) {
298 // On windows, env. vars. are case insensitive
300 tbl = GetEnvironmentVariablesNoCase ();
302 value = tbl [var] as string;
305 // If value not found, add %FOO to stream,
306 // and use the closing % for the next iteration.
307 // If value found, expand it in place of %FOO%
313 result.Append (value);
316 off1 = name.IndexOf ('%', off2 + 1);
317 // If no % found for off1, don't look for one for off2
318 off2 = (off1 == -1 || off2 > len-1)? -1 :name.IndexOf ('%', off1 + 1);
319 // textLen is the length of text between the closing % of current iteration
320 // and the starting % of the next iteration if any. This text is added to output
322 // If no new % found, use all the remaining text
323 if (off1 == -1 || off2 == -1)
324 textLen = len - oldOff2 - 1;
325 // If value found in current iteration, use text after current closing % and next %
326 else if(value != null)
327 textLen = off1 - oldOff2 - 1;
328 // If value not found in current iteration, but a % was found for next iteration,
329 // use text from current closing % to the next %.
331 textLen = off1 - oldOff2;
332 if(off1 >= oldOff2 || off1 == -1)
333 result.Append (name, oldOff2+1, textLen);
334 } while (off2 > -1 && off2 < len);
336 return result.ToString ();
341 /// Return an array of the command line arguments of the current process
343 [MethodImplAttribute (MethodImplOptions.InternalCall)]
344 [EnvironmentPermissionAttribute (SecurityAction.Demand, Read = "PATH")]
345 public extern static string[] GetCommandLineArgs ();
347 [MethodImplAttribute (MethodImplOptions.InternalCall)]
348 internal extern static string internalGetEnvironmentVariable (string name);
351 /// Return a string containing the value of the environment
352 /// variable identifed by parameter "variable"
354 public static string GetEnvironmentVariable (string name)
356 if (SecurityManager.SecurityEnabled) {
357 new EnvironmentPermission (EnvironmentPermissionAccess.Read, name).Demand ();
359 return internalGetEnvironmentVariable (name);
362 static Hashtable GetEnvironmentVariablesNoCase ()
364 Hashtable vars = new Hashtable (CaseInsensitiveHashCodeProvider.Default,
365 CaseInsensitiveComparer.Default);
367 foreach (string name in GetEnvironmentVariableNames ()) {
368 vars [name] = internalGetEnvironmentVariable (name);
375 /// Return a set of all environment variables and their values
378 public static IDictionary GetEnvironmentVariables ()
380 StringBuilder sb = null;
381 if (SecurityManager.SecurityEnabled) {
382 // we must have access to each variable to get the lot
383 sb = new StringBuilder ();
384 // but (performance-wise) we do not want a stack-walk
385 // for each of them so we concatenate them
388 Hashtable vars = new Hashtable ();
389 foreach (string name in GetEnvironmentVariableNames ()) {
390 vars [name] = internalGetEnvironmentVariable (name);
398 new EnvironmentPermission (EnvironmentPermissionAccess.Read, sb.ToString ()).Demand ();
403 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
404 public static IDictionary GetEnvironmentVariables ()
406 Hashtable vars = new Hashtable ();
407 foreach (string name in GetEnvironmentVariableNames ()) {
408 vars [name] = internalGetEnvironmentVariable (name);
414 [MethodImplAttribute (MethodImplOptions.InternalCall)]
415 private extern static string GetWindowsFolderPath (int folder);
418 /// Returns the fully qualified path of the
419 /// folder specified by the "folder" parameter
421 public static string GetFolderPath (SpecialFolder folder)
425 if (Environment.IsRunningOnWindows) {
426 dir = GetWindowsFolderPath ((int) folder);
428 dir = InternalGetFolderPath (folder);
431 if ((dir != null) && (dir.Length > 0) && SecurityManager.SecurityEnabled) {
432 new FileIOPermission (FileIOPermissionAccess.PathDiscovery, dir).Demand ();
437 // the security runtime (and maybe other parts of corlib) needs the
438 // information to initialize themselves before permissions can be checked
439 internal static string InternalGetFolderPath (SpecialFolder folder)
441 string home = internalGetHome ();
443 // http://freedesktop.org/Standards/basedir-spec/basedir-spec-0.6.html
445 // note: skip security check for environment variables
446 string data = internalGetEnvironmentVariable ("XDG_DATA_HOME");
447 if ((data == null) || (data == String.Empty)) {
448 data = Path.Combine (home, ".local");
449 data = Path.Combine (data, "share");
452 // note: skip security check for environment variables
453 string config = internalGetEnvironmentVariable ("XDG_CONFIG_HOME");
454 if ((config == null) || (config == String.Empty)) {
455 config = Path.Combine (home, ".config");
460 // MyComputer is a virtual directory
461 case SpecialFolder.MyComputer:
465 case SpecialFolder.Personal:
467 // use FDO's CONFIG_HOME. This data will be synced across a network like the windows counterpart.
468 case SpecialFolder.ApplicationData:
470 //use FDO's DATA_HOME. This is *NOT* synced
471 case SpecialFolder.LocalApplicationData:
474 case SpecialFolder.Desktop:
476 case SpecialFolder.DesktopDirectory:
477 return Path.Combine (home, "Desktop");
479 // these simply dont exist on Linux
480 // The spec says if a folder doesnt exist, we
482 case SpecialFolder.Favorites:
483 case SpecialFolder.Programs:
484 case SpecialFolder.SendTo:
485 case SpecialFolder.StartMenu:
486 case SpecialFolder.Startup:
487 case SpecialFolder.MyMusic:
488 case SpecialFolder.MyPictures:
489 case SpecialFolder.Templates:
490 case SpecialFolder.Cookies:
491 case SpecialFolder.History:
492 case SpecialFolder.InternetCache:
493 case SpecialFolder.Recent:
494 case SpecialFolder.CommonProgramFiles:
495 case SpecialFolder.ProgramFiles:
496 case SpecialFolder.System:
498 // This is where data common to all users goes
499 case SpecialFolder.CommonApplicationData:
502 throw new ArgumentException ("Invalid SpecialFolder");
506 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
507 public static string[] GetLogicalDrives ()
509 return GetLogicalDrivesInternal ();
512 // FIXME: Anyone using this anywhere ?
513 static internal string GetResourceString (string s) { return ""; }
517 [MonoTODO ("Machine and User targets aren't supported")]
518 public static string GetEnvironmentVariable (string variable, EnvironmentVariableTarget target)
521 case EnvironmentVariableTarget.Process:
522 return GetEnvironmentVariable (variable);
523 case EnvironmentVariableTarget.Machine:
524 new EnvironmentPermission (PermissionState.Unrestricted).Demand ();
525 // under Windows this reads the LOCAL_MACHINE registry key for env vars
526 throw new NotImplementedException ();
527 case EnvironmentVariableTarget.User:
528 new EnvironmentPermission (PermissionState.Unrestricted).Demand ();
529 // under Windows this reads the CURRENT_USER registry key for env vars
530 throw new NotImplementedException ();
532 throw new ArgumentException ("target");
536 [MonoTODO ("Machine and User targets aren't supported")]
537 public static IDictionary GetEnvironmentVariables (EnvironmentVariableTarget target)
540 case EnvironmentVariableTarget.Process:
541 return GetEnvironmentVariables ();
542 case EnvironmentVariableTarget.Machine:
543 new EnvironmentPermission (PermissionState.Unrestricted).Demand ();
544 // under Windows this reads the LOCAL_MACHINE registry key for env vars
545 throw new NotImplementedException ();
546 case EnvironmentVariableTarget.User:
547 new EnvironmentPermission (PermissionState.Unrestricted).Demand ();
548 // under Windows this reads the CURRENT_USER registry key for env vars
549 throw new NotImplementedException ();
551 throw new ArgumentException ("target");
555 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
556 public static void SetEnvironmentVariable (string variable, string value)
558 if (variable == null)
559 throw new ArgumentNullException ("variable");
560 if (variable == String.Empty)
561 throw new ArgumentException ("String cannot be of zero length.", "variable");
562 if (variable.IndexOf ('=') != -1)
563 throw new ArgumentException ("Environment variable name cannot contain an equal character.", "variable");
564 if (variable [0] == '\0')
565 throw new ArgumentException ("The first char in the string is the null character.", "variable");
567 InternalSetEnvironmentVariable (variable, value);
571 [EnvironmentPermission (SecurityAction.Demand, Unrestricted=true)]
572 public static void SetEnvironmentVariable (string variable, string value, EnvironmentVariableTarget target)
575 case EnvironmentVariableTarget.Process:
576 InternalSetEnvironmentVariable (variable, value);
578 case EnvironmentVariableTarget.Machine:
579 // under Windows this reads the LOCAL_MACHINE registry key for env vars
580 throw new NotImplementedException ();
581 case EnvironmentVariableTarget.User:
582 // under Windows this reads the CURRENT_USER registry key for env vars
583 throw new NotImplementedException ();
585 throw new ArgumentException ("target");
589 [MethodImplAttribute (MethodImplOptions.InternalCall)]
590 internal static extern void InternalSetEnvironmentVariable (string variable, string value);
593 public static int ProcessorCount {
594 [EnvironmentPermission (SecurityAction.Demand, Read="NUMBER_OF_PROCESSORS")]
596 // note: Changes to the NUMBER_OF_PROCESSORS environment variable
597 // under Windows doesn't affect the (good) value returned.
598 throw new NotImplementedException ();
602 [MonoTODO ("not much documented")]
603 [SecurityPermission (SecurityAction.LinkDemand, UnmanagedCode=true)]
604 public static void FailFast (string message)
606 throw new NotImplementedException ();
612 internal static bool IsRunningOnWindows {
613 get { return ((int) Platform != 128); }
616 private static string GacPath {
618 if (Environment.IsRunningOnWindows) {
619 /* On windows, we don't know the path where mscorlib.dll will be installed */
620 string corlibDir = new DirectoryInfo (Path.GetDirectoryName (typeof (int).Assembly.Location)).Parent.Parent.FullName;
621 return Path.Combine (Path.Combine (corlibDir, "mono"), "gac");
624 return Path.Combine (Path.Combine (internalGetGacPath (), "mono"), "gac");
628 [MethodImplAttribute (MethodImplOptions.InternalCall)]
629 private extern static string [] GetLogicalDrivesInternal ();
631 [MethodImplAttribute (MethodImplOptions.InternalCall)]
632 private extern static string [] GetEnvironmentVariableNames ();
634 [MethodImplAttribute (MethodImplOptions.InternalCall)]
635 internal extern static string GetMachineConfigPath ();
637 [MethodImplAttribute (MethodImplOptions.InternalCall)]
638 internal extern static string internalGetGacPath ();
640 [MethodImplAttribute (MethodImplOptions.InternalCall)]
641 internal extern static string internalGetHome ();