2 // System.Web.XmlSiteMapProvider
5 // Ben Maurer (bmaurer@users.sourceforge.net)
6 // Lluis Sanchez Gual (lluis@novell.com)
9 // (C) 2005 Novell, Inc (http://www.novell.com)
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:
21 // The above copyright notice and this permission notice shall be
22 // included in all copies or substantial portions of the Software.
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.
34 using System.Collections;
35 using System.Collections.Specialized;
36 using System.Configuration;
39 using System.Web.Util;
44 public class XmlSiteMapProvider : StaticSiteMapProvider, IDisposable
46 static readonly char [] seperators = { ';', ',' };
49 SiteMapNode root = null;
50 FileSystemWatcher watcher;
53 protected internal override void AddNode (SiteMapNode node, SiteMapNode parentNode)
55 base.AddNode (node, parentNode);
58 protected virtual void AddProvider (string providerName, SiteMapNode parentNode)
60 throw new NotImplementedException ();
63 public override SiteMapNode BuildSiteMap ()
67 // Whenever you call AddNode, it tries to find dups, and will call this method
68 // Is this a bug in MS??
77 XmlDocument d = new XmlDocument ();
80 XmlNode nod = d.DocumentElement ["siteMapNode"];
82 throw new HttpException ("Invalid site map file: " + Path.GetFileName (file));
84 root = BuildSiteMapRecursive (nod);
94 string GetNonEmptyOptionalAttribute (XmlNode n, string name)
96 return System.Web.Configuration.HandlersUtil.ExtractAttributeValue (name, n, true);
99 string GetOptionalAttribute (XmlNode n, string name)
101 return System.Web.Configuration.HandlersUtil.ExtractAttributeValue (name, n, true, true);
105 SiteMapNode BuildSiteMapRecursive (XmlNode xmlNode)
107 if (xmlNode.Name != "siteMapNode")
108 throw new ConfigurationException ("incorrect element name", xmlNode);
110 string provider = GetNonEmptyOptionalAttribute (xmlNode, "provider");
111 string siteMapFile = GetNonEmptyOptionalAttribute (xmlNode, "siteMapFile");
113 if (provider != null) {
114 throw new NotImplementedException ();
115 } else if (siteMapFile != null) {
116 throw new NotImplementedException ();
119 string url = GetOptionalAttribute (xmlNode, "url");
120 string title = GetOptionalAttribute (xmlNode, "title");
121 string description = GetOptionalAttribute (xmlNode, "description");
122 string keywords = GetOptionalAttribute (xmlNode, "keywords");
123 string roles = GetOptionalAttribute (xmlNode, "roles");
125 ArrayList keywordsList = new ArrayList ();
126 if (keywords != null && keywords.Length > 0) {
127 foreach (string s in keywords.Split (seperators)) {
128 string ss = s.Trim ();
130 keywordsList.Add (ss);
134 ArrayList rolesList = new ArrayList ();
135 if (roles != null && roles.Length > 0) {
136 foreach (string s in roles.Split (seperators)) {
137 string ss = s.Trim ();
143 if (!string.IsNullOrEmpty (url)) {
144 if (UrlUtils.IsRelativeUrl (url))
145 url = UrlUtils.Combine (HttpRuntime.AppDomainAppVirtualPath, url);
148 SiteMapNode node = new SiteMapNode (this, url, url, title, description,
149 /*ArrayList.ReadOnly (keywordsList), */ArrayList.ReadOnly (rolesList), null,
150 null, null); // TODO what do they want for attributes
152 foreach (XmlNode child in xmlNode.ChildNodes) {
153 if (child.NodeType != XmlNodeType.Element)
155 AddNode (BuildSiteMapRecursive (child), node);
162 protected override void Clear ()
168 protected virtual void Dispose (bool disposing)
174 public void Dispose ()
180 public override SiteMapNode FindSiteMapNode (string rawUrl)
182 return base.FindSiteMapNode (rawUrl); // why did they override this method!?
186 public override SiteMapNode FindSiteMapNodeFromKey (string key)
188 return base.FindSiteMapNodeFromKey (key); // why did they override this method!?
191 public override void Initialize (string name, NameValueCollection attributes)
194 base.Initialize (name, attributes);
195 file = attributes ["siteMapFile"];
197 if (file == null && file.Length == 0)
198 throw new ArgumentException ("you must provide a file");
200 if (UrlUtils.IsRelativeUrl (file))
201 file = Path.Combine(HttpRuntime.AppDomainAppPath, file);
203 file = UrlUtils.ResolvePhysicalPathFromAppAbsolute (file);
205 if (File.Exists (file)) {
206 watcher = new FileSystemWatcher ();
207 watcher.Path = Path.GetFullPath (Path.GetDirectoryName (file));
208 watcher.Filter = Path.GetFileName (file);
209 watcher.Changed += new FileSystemEventHandler (OnFileChanged);
210 watcher.EnableRaisingEvents = true;
215 protected override void RemoveNode (SiteMapNode node)
217 base.RemoveNode (node);
221 protected virtual void RemoveProvider (string providerName)
223 throw new NotImplementedException ();
226 void OnFileChanged (object sender, FileSystemEventArgs args)
231 public override SiteMapNode RootNode {
238 protected internal override SiteMapNode GetRootNodeCore ()
240 return BuildSiteMap ();