mcs/class/System.Web/System.Web/SiteMapNode.cs

   1 //
   2 // System.Web.SiteMapNode
   3 //
   4 // Authors:
   5 //      Ben Maurer (bmaurer@users.sourceforge.net)
   6 //
   7 // (C) 2003 Ben Maurer
   8 //
   9
  10 //
  11 // Permission is hereby granted, free of charge, to any person obtaining
  12 // a copy of this software and associated documentation files (the
  13 // "Software"), to deal in the Software without restriction, including
  14 // without limitation the rights to use, copy, modify, merge, publish,
  15 // distribute, sublicense, and/or sell copies of the Software, and to
  16 // permit persons to whom the Software is furnished to do so, subject to
  17 // the following conditions:
  18 //
  19 // The above copyright notice and this permission notice shall be
  20 // included in all copies or substantial portions of the Software.
  21 //
  22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29 //
  30
  31 #if NET_2_0
  32 using System.Collections;
  33 using System.Collections.Specialized;
  34 using System.Text;
  35 using System.Web.UI;
  36 using System.Web.UI.WebControls;
  37 using System.ComponentModel;
  38
  39 namespace System.Web {
  40         public class SiteMapNode : IHierarchyData, INavigateUIData, ICloneable {
  41
  42                 private SiteMapNode () {}
  43
  44                 public SiteMapNode (SiteMapProvider provider, string key) : this (provider, key, null, null, null, null, null, null, null) {}
  45                 public SiteMapNode (SiteMapProvider provider, string key, string url) : this (provider, key, url, null, null, null, null, null, null) {}
  46                 public SiteMapNode (SiteMapProvider provider, string key, string url, string title) : this (provider, key, url, title, null, null, null, null, null) {}
  47                 public SiteMapNode (SiteMapProvider provider, string key, string url, string title, string description) : this (provider, key, url, title, description, null, null, null, null) {}
  48                 public SiteMapNode (SiteMapProvider provider, string key, string url, string title, string description, IList roles, NameValueCollection attributes, NameValueCollection explicitResourceKeys, string implicitResourceKey)
  49                 {
  50                         if (provider == null)
  51                                 throw new ArgumentNullException ("provider");
  52                         if (key == null)
  53                                 throw new ArgumentNullException ("key");
  54
  55                         this.provider = provider;
  56                         this.key = key;
  57                         this.url = url;
  58                         this.title = title;
  59                         this.description = description;
  60                         this.roles = roles;
  61                         this.attributes = attributes;
  62                         this.resourceKeys = explicitResourceKeys;
  63                         this.implicitResourceKey = implicitResourceKey;
  64                 }
  65
  66                 public SiteMapDataSourceView GetDataSourceView (SiteMapDataSource owner, string viewName)
  67                 {
  68                         return new SiteMapDataSourceView (owner, viewName, this);
  69                 }
  70
  71                 public SiteMapHierarchicalDataSourceView GetHierarchicalDataSourceView ()
  72                 {
  73                         return new SiteMapHierarchicalDataSourceView (this);
  74                 }
  75
  76                 public virtual bool IsAccessibleToUser (System.Web.HttpContext ctx)
  77                 {
  78                         return provider.IsAccessibleToUser (ctx, this);
  79                 }
  80
  81                 public override string ToString()
  82                 {
  83                         return Title;
  84                 }
  85
  86                 public virtual bool HasChildNodes {
  87                         get { return ChildNodes != null && ChildNodes.Count != 0; }
  88                 }
  89
  90                 public SiteMapNodeCollection GetAllNodes ()
  91                 {
  92                         SiteMapNodeCollection ret;
  93
  94                         ret = new SiteMapNodeCollection ();
  95                         GetAllNodesRecursive (ret);
  96                         return SiteMapNodeCollection.ReadOnly (ret);
  97                 }
  98
  99                 void GetAllNodesRecursive(SiteMapNodeCollection c)
 100                 {
 101                         SiteMapNodeCollection childNodes = this.ChildNodes;
 102
 103                         if (childNodes.Count > 0) {
 104                                 childNodes.AddRange (childNodes);
 105                                 foreach (SiteMapNode n in childNodes)
 106                                         n.GetAllNodesRecursive (c);
 107                         }
 108                 }
 109
 110
 111                 public virtual bool IsDescendantOf (SiteMapNode node)
 112                 {
 113                         for (SiteMapNode n = ParentNode; n != null; n = n.ParentNode)
 114                                 if (n == node) return true;
 115
 116                         return false;
 117                 }
 118
 119                 public virtual SiteMapNode NextSibling {
 120                         get {
 121                                 IList siblings = this.SiblingNodes;
 122                                 if (siblings == null)
 123                                         return null;
 124
 125                                 int pos = siblings.IndexOf (this);
 126                                 if (pos >= 0 && pos < siblings.Count - 1)
 127                                         return (SiteMapNode) siblings [pos + 1];
 128
 129                                 return null;
 130                         }
 131                 }
 132
 133                 public virtual SiteMapNode PreviousSibling {
 134                         get {
 135                                 IList siblings = this.SiblingNodes;
 136                                 if (siblings == null)
 137                                         return null;
 138
 139                                 int pos = siblings.IndexOf (this);
 140                                 if (pos > 0 && pos < siblings.Count)
 141                                         return (SiteMapNode) siblings [pos - 1];
 142
 143                                 return null;
 144                         }
 145                 }
 146
 147                 public virtual SiteMapNode ParentNode {
 148                         get {
 149                                 if (parent != null) return parent;
 150
 151                                 SiteMapProvider provider = this.provider;
 152
 153                                 do {
 154                                         parent = provider.GetParentNode (this);
 155                                         if (parent != null)
 156                                                 return parent;
 157
 158                                         provider = provider.ParentProvider;
 159                                 } while (provider != null);
 160                                 return null;
 161                         }
 162                         set {
 163                                 CheckWritable ();
 164                                 parent = value;
 165                         }
 166                 }
 167
 168                 public virtual SiteMapNodeCollection ChildNodes {
 169                         get {
 170                                 if (childNodes != null) return childNodes;
 171                                 return provider.GetChildNodes (this);
 172                         }
 173                         set {
 174                                 CheckWritable ();
 175                                 childNodes = value;
 176                         }
 177                 }
 178
 179                 public virtual SiteMapNode RootNode { get { return provider.RootProvider.RootNode; }  }
 180
 181                 SiteMapNodeCollection SiblingNodes {
 182                         get {
 183                                 if (ParentNode != null)
 184                                         return ParentNode.ChildNodes;
 185
 186                                 return null;
 187                         }
 188                 }
 189
 190                 [MonoTODO("Not implemented, always returns null")]
 191                 protected string GetExplicitResourceString (string attributeName, string defaultValue, bool throwIfNotFound)
 192                 {
 193                         return null;
 194                 }
 195
 196                 [MonoTODO("Not implemented, always returns null")]
 197                 protected string GetImplicitResourceString (string attributeName)
 198                 {
 199                         return null;
 200                 }
 201
 202                 public virtual string this [string key]
 203                 {
 204                         get {
 205                                 string val = null;
 206                                 if (provider.EnableLocalization) {
 207                                         val = GetExplicitResourceString (key, null, true);
 208                                         if (val == null) val = GetImplicitResourceString (key);
 209                                 }
 210                                 if (val != null) return null;
 211                                 if (attributes != null) return attributes [key];
 212                                 return null;
 213                         }
 214                         set {
 215                                 CheckWritable ();
 216                                 if (attributes == null) attributes = new NameValueCollection ();
 217                                 attributes [key] = value;
 218                         }
 219                 }
 220
 221                 object ICloneable.Clone ()
 222                 {
 223                         return Clone (false);
 224                 }
 225
 226                 public virtual SiteMapNode Clone ()
 227                 {
 228                         return Clone (false);
 229                 }
 230
 231                 public virtual SiteMapNode Clone (bool cloneParentNodes)
 232                 {
 233                         SiteMapNode node = new SiteMapNode ();
 234                         node.provider = provider;
 235                         node.key = key;
 236                         node.url = url;
 237                         node.title = title;
 238                         node.description = description;
 239                         if (roles != null)
 240                                 node.roles = new ArrayList (roles);
 241                         if (attributes != null)
 242                                 node.attributes = new NameValueCollection (attributes);
 243                         if (cloneParentNodes && ParentNode != null)
 244                                 node.parent = (SiteMapNode) ParentNode.Clone (true);
 245                         return node;
 246                 }
 247
 248                 public override bool Equals (object ob)
 249                 {
 250                         SiteMapNode node = ob as SiteMapNode;
 251                         if (node == null) return false;
 252
 253                         if (node.key != key ||
 254                                         node.url != url ||
 255                                         node.title != title ||
 256                                         node.description != description) {
 257                                 return false;
 258                         }
 259
 260                         if (roles == null || node.roles == null) {
 261                                 if (roles != node.roles)
 262                                         return false;
 263                         }
 264                         else {
 265                                 if (roles.Count != node.roles.Count)
 266                                         return false;
 267
 268                                 foreach (object role in roles)
 269                                         if (!node.roles.Contains (role)) return false;
 270                         }
 271                         if (attributes == null || node.attributes == null) {
 272                                 if (attributes != node.attributes)
 273                                         return false;
 274                         }
 275                         else {
 276                                 if (attributes.Count != node.attributes.Count)
 277                                         return false;
 278
 279                                 foreach (string k in attributes)
 280                                         if (attributes[k] != node.attributes[k])
 281                                                 return false;
 282                         }
 283                         return true;
 284                 }
 285
 286                 public override int GetHashCode ()
 287                 {
 288                         return (key + url + title + description).GetHashCode ();
 289                 }
 290
 291                 void CheckWritable ()
 292                 {
 293                         if (readOnly)
 294                                 throw new InvalidOperationException ("Can't modify read-only node");
 295                 }
 296
 297                 #region Field Accessors
 298
 299                 protected NameValueCollection Attributes {
 300                         get { return attributes; }
 301                         set { CheckWritable (); attributes = value; }
 302                 }
 303
 304                 [Localizable (true)]
 305                 public virtual string Description {
 306                         get { return description != null ? description : ""; }
 307                         set { CheckWritable (); description = value; }
 308                 }
 309
 310                 [LocalizableAttribute (true)]
 311                 public virtual string Title {
 312                         get { return title != null ? title : ""; }
 313                         set { CheckWritable (); title = value; }
 314                 }
 315
 316                 public virtual string Url {
 317                         get { return url != null ? url : ""; }
 318                         set { CheckWritable (); url = value; }
 319                 }
 320
 321                 public IList Roles {
 322                         get { return roles; }
 323                         set { CheckWritable (); roles = value; }
 324                 }
 325
 326                 public bool ReadOnly {
 327                         get { return readOnly; }
 328                         set { readOnly = value; }
 329                 }
 330
 331                 [MonoTODO ("Do somethig with this")]
 332                 public string ResourceKey {
 333                         get { return resourceKey; }
 334                         set { resourceKey = value; }
 335                 }
 336
 337                 public string Key { get { return key; } }
 338                 public SiteMapProvider Provider { get { return provider; } }
 339
 340                 #endregion
 341
 342                 #region INavigateUIData
 343                 IHierarchicalEnumerable System.Web.UI.IHierarchyData.GetChildren () { return ChildNodes; }
 344                 IHierarchyData System.Web.UI.IHierarchyData.GetParent ()
 345                 {
 346                         return ParentNode;
 347                 }
 348
 349                 bool System.Web.UI.IHierarchyData.HasChildren { get { return HasChildNodes; } }
 350                 object System.Web.UI.IHierarchyData.Item { get { return this; } }
 351                 string System.Web.UI.IHierarchyData.Path { get { return Url; } }
 352                 string System.Web.UI.IHierarchyData.Type { get { return "SiteMapNode"; } }
 353                 #endregion
 354
 355                 #region INavigateUIData
 356                 string INavigateUIData.Name { get { return Title; }  }
 357                 string INavigateUIData.NavigateUrl { get { return Url; } }
 358                 string INavigateUIData.Value { get { return Title; } }
 359                 #endregion
 360
 361                 #region Fields
 362                 SiteMapProvider provider;
 363                 string key;
 364                 string url;
 365                 string title;
 366                 string description;
 367                 IList roles;
 368                 NameValueCollection attributes;
 369                 NameValueCollection resourceKeys;
 370                 bool readOnly;
 371                 string resourceKey;
 372                 SiteMapNode parent;
 373                 string implicitResourceKey;
 374                 SiteMapNodeCollection childNodes;
 375                 #endregion
 376
 377         }
 378 }
 379 #endif
 380