mcs/class/System/System.Security.Permissions/StorePermission.cs

   1 //
   2 // System.Security.Permissions.StorePermission class
   3 //
   4 // Author:
   5 //      Sebastien Pouliot  <sebastien@ximian.com>
   6 //
   7 // Copyright (C) 2005 Novell, Inc (http://www.novell.com)
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining
  10 // a copy of this software and associated documentation files (the
  11 // "Software"), to deal in the Software without restriction, including
  12 // without limitation the rights to use, copy, modify, merge, publish,
  13 // distribute, sublicense, and/or sell copies of the Software, and to
  14 // permit persons to whom the Software is furnished to do so, subject to
  15 // the following conditions:
  16 //
  17 // The above copyright notice and this permission notice shall be
  18 // included in all copies or substantial portions of the Software.
  19 //
  20 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27 //
  28
  29 using System.Globalization;
  30
  31 namespace System.Security.Permissions {
  32
  33         [Serializable]
  34         public sealed class StorePermission : CodeAccessPermission, IUnrestrictedPermission {
  35
  36                 private const int version = 1;
  37
  38                 private StorePermissionFlags _flags;
  39
  40
  41                 public StorePermission (PermissionState state)
  42                 {
  43                         if (PermissionHelper.CheckPermissionState (state, true) == PermissionState.Unrestricted)
  44                                 _flags = StorePermissionFlags.AllFlags;
  45                         else
  46                                 _flags = StorePermissionFlags.NoFlags;
  47                 }
  48
  49                 public StorePermission (StorePermissionFlags flags)
  50                 {
  51                         // reuse validation by the Flags property
  52                         Flags = flags;
  53                 }
  54
  55
  56                 public StorePermissionFlags Flags {
  57                         get { return _flags; }
  58                         set {
  59                                 if ((value != 0) && (value & StorePermissionFlags.AllFlags) == 0) {
  60                                         string msg = String.Format (Locale.GetText ("Invalid enum {0}"), value);
  61                                         throw new ArgumentException (msg, "StorePermissionFlags");
  62                                 }
  63                                 _flags = value;
  64                         }
  65                 }
  66
  67                 public bool IsUnrestricted ()
  68                 {
  69                         return (_flags == StorePermissionFlags.AllFlags);
  70                 }
  71
  72                 public override IPermission Copy ()
  73                 {
  74                         // buggy behaviour - affects other operations that use Copy
  75                         // reported as FDBK40928
  76                         if (_flags == StorePermissionFlags.NoFlags)
  77                                 return null;
  78
  79                         return new StorePermission (_flags);
  80                 }
  81
  82                 public override IPermission Intersect (IPermission target)
  83                 {
  84                         StorePermission dp = Cast (target);
  85                         if (dp == null)
  86                                 return null;
  87
  88                         if (this.IsUnrestricted () && dp.IsUnrestricted ())
  89                                 return new StorePermission (PermissionState.Unrestricted);
  90                         if (this.IsUnrestricted ())
  91                                 return dp.Copy ();
  92                         if (dp.IsUnrestricted ())
  93                                 return this.Copy ();
  94
  95                         StorePermissionFlags spf = _flags & dp._flags;
  96                         if (spf == StorePermissionFlags.NoFlags)
  97                                 return null;
  98
  99                         return new StorePermission (spf);
 100                 }
 101
 102                 public override IPermission Union (IPermission target)
 103                 {
 104                         StorePermission dp = Cast (target);
 105                         if (dp == null)
 106                                 return this.Copy (); // will return null for NoFlags
 107
 108                         if (this.IsUnrestricted () || dp.IsUnrestricted ())
 109                                 return new StorePermission (PermissionState.Unrestricted);
 110
 111                         StorePermissionFlags spf = _flags | dp._flags;
 112                         if (spf == StorePermissionFlags.NoFlags)
 113                                 return null;
 114
 115                         return new StorePermission (spf);
 116                 }
 117
 118                 public override bool IsSubsetOf (IPermission target)
 119                 {
 120                         StorePermission dp = Cast (target);
 121                         if (dp == null)
 122                                 return (_flags == StorePermissionFlags.NoFlags);
 123
 124                         if (dp.IsUnrestricted ())
 125                                 return true;
 126                         if (this.IsUnrestricted ())
 127                                 return false;
 128
 129                         return ((_flags & ~dp._flags) == 0);
 130                 }
 131
 132                 public override void FromXml (SecurityElement e)
 133                 {
 134                         // General validation in CodeAccessPermission
 135                         PermissionHelper.CheckSecurityElement (e, "e", version, version);
 136                         // Note: we do not (yet) care about the return value
 137                         // as we only accept version 1 (min/max values)
 138
 139                         string s = e.Attribute ("Flags");
 140                         if (s == null)
 141                                 _flags = StorePermissionFlags.NoFlags;
 142                         else
 143                                 _flags = (StorePermissionFlags) Enum.Parse (typeof (StorePermissionFlags), s);
 144                 }
 145
 146                 public override SecurityElement ToXml ()
 147                 {
 148                         SecurityElement e = PermissionHelper.Element (typeof (StorePermission), version);
 149                         if (this.IsUnrestricted ()) {
 150                                 e.AddAttribute ("Unrestricted", Boolean.TrueString);
 151                         } else {
 152                                 e.AddAttribute ("Flags", _flags.ToString ());
 153                         }
 154                         return e;
 155                 }
 156
 157                 // helpers
 158
 159                 private StorePermission Cast (IPermission target)
 160                 {
 161                         if (target == null)
 162                                 return null;
 163
 164                         StorePermission dp = (target as StorePermission);
 165                         if (dp == null) {
 166                                 PermissionHelper.ThrowInvalidPermission (target, typeof (StorePermission));
 167                         }
 168
 169                         return dp;
 170                 }
 171         }
 172 }
 173