mcs/class/System.Web/System.Web/XmlSiteMapProvider.cs

   1 //
   2 // System.Web.XmlSiteMapProvider
   3 //
   4 // Authors:
   5 //      Ben Maurer (bmaurer@users.sourceforge.net)
   6 //      Lluis Sanchez Gual (lluis@novell.com)
   7 //
   8 // (C) 2003 Ben Maurer
   9 // (C) 2005 Novell, Inc (http://www.novell.com)
  10 //
  11
  12 //
  13 // Permission is hereby granted, free of charge, to any person obtaining
  14 // a copy of this software and associated documentation files (the
  15 // "Software"), to deal in the Software without restriction, including
  16 // without limitation the rights to use, copy, modify, merge, publish,
  17 // distribute, sublicense, and/or sell copies of the Software, and to
  18 // permit persons to whom the Software is furnished to do so, subject to
  19 // the following conditions:
  20 //
  21 // The above copyright notice and this permission notice shall be
  22 // included in all copies or substantial portions of the Software.
  23 //
  24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31 //
  32
  33 #if NET_2_0
  34 using System.Collections;
  35 using System.Collections.Specialized;
  36 using System.Configuration;
  37 using System.Text;
  38 using System.Xml;
  39 using System.Web.Util;
  40 using System.IO;
  41
  42 namespace System.Web
  43 {
  44         public class XmlSiteMapProvider : StaticSiteMapProvider, IDisposable
  45         {
  46                 static readonly char [] seperators = { ';', ',' };
  47                 bool building;
  48                 string file;
  49                 SiteMapNode root = null;
  50                 FileSystemWatcher watcher;
  51
  52                 public override SiteMapNode BuildSiteMap ()
  53                 {
  54                         if (root != null)
  55                                 return root;
  56                         // Whenever you call AddNode, it tries to find dups, and will call this method
  57                         // Is this a bug in MS??
  58                         if (building)
  59                                 return null;
  60
  61                         lock (this) {
  62                                 try {
  63                                         building = true;
  64                                         if (root != null)
  65                                                 return root;
  66                                         XmlDocument d = new XmlDocument ();
  67                                         d.Load (file);
  68
  69                                         XmlNode nod = d.DocumentElement ["siteMapNode"];
  70                                         if (nod == null)
  71                                                 throw new HttpException ("Invalid site map file: " + Path.GetFileName (file));
  72
  73                                         root = BuildSiteMapRecursive (nod);
  74
  75                                         AddNode (root);
  76                                 } finally {
  77                                         building = false;
  78                                 }
  79                                 return root;
  80                         }
  81                 }
  82
  83                 string GetNonEmptyOptionalAttribute (XmlNode n, string name)
  84                 {
  85                         return System.Web.Configuration.HandlersUtil.ExtractAttributeValue (name, n, true);
  86                 }
  87
  88                 string GetOptionalAttribute (XmlNode n, string name)
  89                 {
  90                         return System.Web.Configuration.HandlersUtil.ExtractAttributeValue (name, n, true, true);
  91                 }
  92
  93                 [MonoTODO]
  94                 SiteMapNode BuildSiteMapRecursive (XmlNode xmlNode)
  95                 {
  96                         if (xmlNode.Name != "siteMapNode")
  97                                 throw new ConfigurationException ("incorrect element name", xmlNode);
  98
  99                         string provider = GetNonEmptyOptionalAttribute (xmlNode, "provider");
 100                         string siteMapFile = GetNonEmptyOptionalAttribute (xmlNode, "siteMapFile");
 101
 102                         if (provider != null) {
 103                                 throw new NotImplementedException ();
 104                         } else if (siteMapFile != null) {
 105                                 throw new NotImplementedException ();
 106                         } else {
 107
 108                                 string url = GetOptionalAttribute (xmlNode, "url");
 109                                 string title = GetOptionalAttribute (xmlNode, "title");
 110                                 string description = GetOptionalAttribute (xmlNode, "description");
 111                                 string keywords = GetOptionalAttribute (xmlNode, "keywords");
 112                                 string roles = GetOptionalAttribute (xmlNode, "roles");
 113
 114                                 ArrayList keywordsList = new ArrayList ();
 115                                 if (keywords != null && keywords.Length > 0) {
 116                                         foreach (string s in keywords.Split (seperators)) {
 117                                                 string ss = s.Trim ();
 118                                                 if (ss.Length > 0)
 119                                                         keywordsList.Add (ss);
 120                                         }
 121                                 }
 122
 123                                 ArrayList rolesList = new ArrayList ();
 124                                 if (roles != null && roles.Length > 0) {
 125                                         foreach (string s in roles.Split (seperators)) {
 126                                                 string ss = s.Trim ();
 127                                                 if (ss.Length > 0)
 128                                                         rolesList.Add (ss);
 129                                         }
 130                                 }
 131
 132                                 SiteMapNode node = new SiteMapNode (this, url, url, title, description,
 133                                         /*ArrayList.ReadOnly (keywordsList), */ArrayList.ReadOnly (rolesList), null,
 134                                         null, null); // TODO what do they want for attributes
 135
 136                                 foreach (XmlNode child in xmlNode.ChildNodes) {
 137                                         if (child.NodeType != XmlNodeType.Element)
 138                                                 continue;
 139                                         AddNode (BuildSiteMapRecursive (child), node);
 140                                 }
 141
 142                                 return node;
 143                         }
 144                 }
 145
 146                 protected override void Clear ()
 147                 {
 148                         base.Clear ();
 149                         root = null;
 150                 }
 151
 152                 public void Dispose ()
 153                 {
 154                         watcher.Dispose ();
 155                 }
 156
 157                 [MonoTODO]
 158                 public override SiteMapNode FindSiteMapNode (string rawUrl)
 159                 {
 160                         return base.FindSiteMapNode (rawUrl); // why did they override this method!?
 161                 }
 162
 163                 public override void Initialize (string name, NameValueCollection attributes)
 164                 {
 165
 166                         base.Initialize (name, attributes);
 167                         file = attributes ["siteMapFile"];
 168
 169                         if (file == null && file.Length == 0)
 170                                 throw new ArgumentException ("you must provide a file");
 171
 172                         if (UrlUtils.IsRelativeUrl (file))
 173                                 file = Path.Combine(HttpRuntime.AppDomainAppPath, file);
 174                         else
 175                                 file = UrlUtils.ResolvePhysicalPathFromAppAbsolute (file);
 176
 177                         if (File.Exists (file)) {
 178                                 watcher = new FileSystemWatcher ();
 179                                 watcher.Path = Path.GetFullPath (Path.GetDirectoryName (file));
 180                                 watcher.Filter = Path.GetFileName (file);
 181                                 watcher.Changed += new FileSystemEventHandler (OnFileChanged);
 182                                 watcher.EnableRaisingEvents = true;
 183                         }
 184                 }
 185
 186                 void OnFileChanged (object sender, FileSystemEventArgs args)
 187                 {
 188                         Clear ();
 189                 }
 190
 191                 public override SiteMapNode RootNode {
 192                         get {
 193                                 BuildSiteMap ();
 194                                 return root;
 195                         }
 196                 }
 197
 198                 protected internal override SiteMapNode GetRootNodeCore ()
 199                 {
 200                         return BuildSiteMap ();
 201                 }
 202         }
 203
 204 }
 205 #endif
 206