2 // System.Security.Permissions.UIPermission.cs
5 // Sebastien Pouliot <sebastien@ximian.com>
7 // Copyright (C) 2003 Motus Technologies. http://www.motus.com
8 // Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)
10 // Permission is hereby granted, free of charge, to any person obtaining
11 // a copy of this software and associated documentation files (the
12 // "Software"), to deal in the Software without restriction, including
13 // without limitation the rights to use, copy, modify, merge, publish,
14 // distribute, sublicense, and/or sell copies of the Software, and to
15 // permit persons to whom the Software is furnished to do so, subject to
16 // the following conditions:
18 // The above copyright notice and this permission notice shall be
19 // included in all copies or substantial portions of the Software.
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
30 using System.Globalization;
31 using System.Runtime.InteropServices;
33 namespace System.Security.Permissions {
39 public sealed class UIPermission : CodeAccessPermission, IUnrestrictedPermission, IBuiltInPermission {
41 private UIPermissionWindow _window; // Note: this (looks like) but isn't a [Flags]
42 private UIPermissionClipboard _clipboard; // Note: this (looks like) but isn't a [Flags]
44 private const int version = 1;
48 public UIPermission (PermissionState state)
50 if (CheckPermissionState (state, true) == PermissionState.Unrestricted) {
51 _clipboard = UIPermissionClipboard.AllClipboard;
52 _window = UIPermissionWindow.AllWindows;
56 public UIPermission (UIPermissionClipboard clipboardFlag)
58 // reuse validation by the Clipboard property
59 Clipboard = clipboardFlag;
62 public UIPermission (UIPermissionWindow windowFlag)
64 // reuse validation by the Window property
68 public UIPermission (UIPermissionWindow windowFlag, UIPermissionClipboard clipboardFlag)
70 // reuse validation by the Clipboard and Window properties
71 Clipboard = clipboardFlag;
77 public UIPermissionClipboard Clipboard {
78 get { return _clipboard; }
80 if (!Enum.IsDefined (typeof (UIPermissionClipboard), value)) {
81 string msg = String.Format (Locale.GetText ("Invalid enum {0}"), value);
82 throw new ArgumentException (msg, "UIPermissionClipboard");
88 public UIPermissionWindow Window {
89 get { return _window; }
91 if (!Enum.IsDefined (typeof (UIPermissionWindow), value)) {
92 string msg = String.Format (Locale.GetText ("Invalid enum {0}"), value);
93 throw new ArgumentException (msg, "UIPermissionWindow");
101 public override IPermission Copy ()
103 return new UIPermission (_window, _clipboard);
106 public override void FromXml (SecurityElement esd)
108 // General validation in CodeAccessPermission
109 CheckSecurityElement (esd, "esd", version, version);
110 // Note: we do not (yet) care about the return value
111 // as we only accept version 1 (min/max values)
113 if (IsUnrestricted (esd)) {
114 _window = UIPermissionWindow.AllWindows;
115 _clipboard = UIPermissionClipboard.AllClipboard;
118 string w = esd.Attribute ("Window");
120 _window = UIPermissionWindow.NoWindows;
122 _window = (UIPermissionWindow) Enum.Parse (typeof (UIPermissionWindow), w);
124 string c = esd.Attribute ("Clipboard");
126 _clipboard = UIPermissionClipboard.NoClipboard;
128 _clipboard = (UIPermissionClipboard) Enum.Parse (typeof (UIPermissionClipboard), c);
132 public override IPermission Intersect (IPermission target)
134 UIPermission uip = Cast (target);
138 // there are not [Flags] so we can't use boolean operators
139 UIPermissionWindow w = ((_window < uip._window) ? _window : uip._window);
140 UIPermissionClipboard c = ((_clipboard < uip._clipboard) ? _clipboard : uip._clipboard);
145 return new UIPermission (w, c);
148 public override bool IsSubsetOf (IPermission target)
150 UIPermission uip = Cast (target);
152 return IsEmpty (_window, _clipboard);
153 if (uip.IsUnrestricted ())
156 // there are not [Flags] so we can't use boolean operators
157 return ((_window <= uip._window) && (_clipboard <= uip._clipboard));
160 public bool IsUnrestricted ()
162 return ((_window == UIPermissionWindow.AllWindows) &&
163 (_clipboard == UIPermissionClipboard.AllClipboard));
166 public override SecurityElement ToXml ()
168 SecurityElement e = Element (version);
170 if (_window == UIPermissionWindow.AllWindows && _clipboard == UIPermissionClipboard.AllClipboard) {
171 e.AddAttribute ("Unrestricted", "true");
174 if (_window != UIPermissionWindow.NoWindows)
175 e.AddAttribute ("Window", _window.ToString ());
177 if (_clipboard != UIPermissionClipboard.NoClipboard)
178 e.AddAttribute ("Clipboard", _clipboard.ToString ());
183 public override IPermission Union (IPermission target)
185 UIPermission uip = Cast (target);
189 // there are not [Flags] so we can't use boolean operators
190 UIPermissionWindow w = ((_window > uip._window) ? _window : uip._window);
191 UIPermissionClipboard c = ((_clipboard > uip._clipboard) ? _clipboard : uip._clipboard);
196 return new UIPermission (w, c);
199 // IBuiltInPermission
200 int IBuiltInPermission.GetTokenIndex ()
202 return (int) BuiltInToken.UI;
207 private bool IsEmpty (UIPermissionWindow w, UIPermissionClipboard c)
209 return ((w == UIPermissionWindow.NoWindows) && (c == UIPermissionClipboard.NoClipboard));
212 private UIPermission Cast (IPermission target)
217 UIPermission uip = (target as UIPermission);
219 ThrowInvalidPermission (target, typeof (UIPermission));