src/DocNet/NavigationLevel.cs - master - diev/FransBouma-DocNet

src/DocNet/NavigationLevel.cs
410 строк13 KB
Geert van Horrik
Add UrlFormatting (defaults to None which is current behavior)
05 июл 2017, 12:37
05 июл 2017, 12:376cb4133
//////////////////////////////////////////////////////////////////////////////////////////////
// DocNet is licensed under the MIT License (MIT)
// Copyright(c) 2016 Frans Bouma
// Get your copy at: https://github.com/FransBouma/DocNet 
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy of 
// this software and associated documentation files (the "Software"), to deal in the
// Software without restriction, including without limitation the rights to use, copy, 
// modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, 
// and to permit persons to whom the Software is furnished to do so, subject to the 
// following conditions:
// 
// The above copyright notice and this permission notice shall be included in all copies 
// or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR 
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE 
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
// DEALINGS IN THE SOFTWARE.
//////////////////////////////////////////////////////////////////////////////////////////////
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Web;
using Newtonsoft.Json.Linq;

namespace Docnet
{
	public class NavigationLevel : NavigationElement<List<INavigationElement>>
	{
		#region Members
		private readonly string _rootDirectory;
		#endregion

		public NavigationLevel(string rootDirectory)
			: base()
		{
			this._rootDirectory = rootDirectory;
			this.Value = new List<INavigationElement>();
		}


		public void Load(JObject dataFromFile)
		{
			foreach (KeyValuePair<string, JToken> child in dataFromFile)
			{
				INavigationElement toAdd;
				if (child.Value.Type == JTokenType.String)
				{
					var nameToUse = child.Key;

					var isIndexElement = child.Key == "__index";
					if (isIndexElement)
					{
						nameToUse = this.Name;
					}

					var childValue = child.Value.ToObject<string>();
					if (childValue.EndsWith("**"))
					{
						var path = childValue.Replace("**", string.Empty)
											 .Replace('\\', Path.DirectorySeparatorChar)
											 .Replace('/', Path.DirectorySeparatorChar);

						if (!Path.IsPathRooted(path))
						{
							path = Path.Combine(_rootDirectory, path);
						}

						toAdd = CreateGeneratedLevel(path);
						toAdd.Name = nameToUse;
					}
					else
					{
						toAdd = new SimpleNavigationElement
						{
							Name = nameToUse,
							Value = childValue,
							IsIndexElement = isIndexElement
						};
					}
				}
				else
				{
					var subLevel = new NavigationLevel(_rootDirectory)
					{
						Name = child.Key,
						IsRoot = false
					};
					subLevel.Load((JObject)child.Value);
					toAdd = subLevel;
				}
				toAdd.ParentContainer = this;
				this.Value.Add(toAdd);
			}
		}


		/// <summary>
		/// Collects the search index entries. These are created from simple navigation elements found in this container, which aren't index element.
		/// </summary>
		/// <param name="collectedEntries">The collected entries.</param>
		/// <param name="activePath">The active path currently navigated.</param>
		/// <param name="navigationContext">The navigation context.</param>
		public override void CollectSearchIndexEntries(List<SearchIndexEntry> collectedEntries, NavigatedPath activePath, NavigationContext navigationContext)
		{
			activePath.Push(this);
			foreach (var element in this.Value)
			{
				element.CollectSearchIndexEntries(collectedEntries, activePath, navigationContext);
			}
			activePath.Pop();
		}


		/// <summary>
		/// Generates the output for this navigation element
		/// </summary>
		/// <param name="activeConfig">The active configuration to use for the output.</param>
		/// <param name="activePath">The active path navigated through the ToC to reach this element.</param>
		/// <param name="navigationContext">The navigation context.</param>
		public override void GenerateOutput(Config activeConfig, NavigatedPath activePath, NavigationContext navigationContext)
		{
			activePath.Push(this);
			int i = 0;
			while (i < this.Value.Count)
			{
				var element = this.Value[i];
				element.GenerateOutput(activeConfig, activePath, navigationContext);
				i++;
			}
			activePath.Pop();
		}


		/// <summary>
		/// Generates the ToC fragment for this element, which can either be a simple line or a full expanded menu.
		/// </summary>
		/// <param name="navigatedPath">The navigated path to the current element, which doesn't necessarily have to be this element.</param>
		/// <param name="relativePathToRoot">The relative path back to the URL root, e.g. ../.., so it can be used for links to elements in this path.</param>
		/// <param name="navigationContext">The navigation context.</param>
		/// <returns></returns>
		public override string GenerateToCFragment(NavigatedPath navigatedPath, string relativePathToRoot, NavigationContext navigationContext)
		{
			var fragments = new List<string>();
			if (!this.IsRoot)
			{
				fragments.Add("<li class=\"tocentry\">");
			}
			if (navigatedPath.Contains(this))
			{
				// we're expanded. If we're not root and on the top of the navigated path stack, our index page is the page we're currently generating the ToC for, so 
				// we have to mark the entry as 'current'
				if (navigatedPath.Peek() == this && !this.IsRoot)
				{
					fragments.Add("<ul class=\"current\">");
				}
				else
				{
					fragments.Add("<ul>");
				}

				// first render the level header, which is the index element, if present or a label. The root always has an __index element otherwise we'd have stopped at load.
				var elementStartTag = "<li><span class=\"navigationgroup\"><i class=\"fa fa-caret-down\"></i> ";
				var indexElement = this.GetIndexElement(navigationContext);
				if (indexElement == null)
				{
					fragments.Add(string.Format("{0}{1}</span></li>", elementStartTag, this.Name));
				}
				else
				{
					if (this.IsRoot)
					{
						fragments.Add(indexElement.PerformGenerateToCFragment(navigatedPath, relativePathToRoot, navigationContext));
					}
					else
					{
						fragments.Add(string.Format("{0}<a href=\"{1}{2}\">{3}</a></span></li>", 
							elementStartTag, relativePathToRoot, indexElement.GetFinalTargetUrl(navigationContext), this.Name));
					}
				}
				// then the elements in the container. Index elements are skipped here.
				foreach (var element in this.Value)
				{
					fragments.Add(element.GenerateToCFragment(navigatedPath, relativePathToRoot, navigationContext));
				}
				fragments.Add("</ul>");
			}
			else
			{
				// just a link
				fragments.Add(string.Format("<span class=\"navigationgroup\"><i class=\"fa fa-caret-right\"></i> <a href=\"{0}{1}\">{2}</a></span>",
											relativePathToRoot, this.GetFinalTargetUrl(navigationContext), this.Name));
			}
			if (!this.IsRoot)
			{
				fragments.Add("</li>");
			}
			return string.Join(Environment.NewLine, fragments.ToArray());
		}


		private NavigationLevel CreateGeneratedLevel(string path)
		{
			var root = new NavigationLevel(_rootDirectory)
			{
				ParentContainer = this,
				IsAutoGenerated =  true
			};

			foreach (var mdFile in Directory.GetFiles(path, "*.md", SearchOption.TopDirectoryOnly))
			{
				var name = FindTitleInMdFile(mdFile);
				if (string.IsNullOrWhiteSpace(name))
				{
					continue;
				}

				var item = new SimpleNavigationElement
				{
					Name = name,
					Value = Path.Combine(Utils.MakeRelativePath(_rootDirectory, path), Path.GetFileName(mdFile)),
					ParentContainer = root,
					IsAutoGenerated = true
				};

				root.Value.Add(item);
			}

			foreach (var directory in Directory.GetDirectories(path, "*", SearchOption.TopDirectoryOnly))
			{
				var subDirectoryNavigationElement = CreateGeneratedLevel(directory);
				subDirectoryNavigationElement.Name = new DirectoryInfo(directory).Name;
				subDirectoryNavigationElement.ParentContainer = root;

				root.Value.Add(subDirectoryNavigationElement);
			}

			return root;
		}


		private string FindTitleInMdFile(string path)
		{
			var title = string.Empty;

			using (var fileStream = File.OpenRead(path))
			{
				using (var streamReader = new StreamReader(fileStream))
				{
					var line = string.Empty;
					while (string.IsNullOrWhiteSpace(line))
					{
						line = streamReader.ReadLine();
						if (!string.IsNullOrWhiteSpace(line))
						{
							line = line.Trim();
							while (line.StartsWith("#"))
							{
								line = line.Substring(1).Trim();
							}
							if (!string.IsNullOrWhiteSpace(line))
							{
								title = line;
								break;
							}
						}
					}
				}
			}

			return title;
		}

		public override string GetTargetURL(NavigationContext navigationContext)
		{
			var defaultElement = this.GetIndexElement(navigationContext);
			if (defaultElement == null)
			{
				return string.Empty;
			}

			return defaultElement.GetTargetURL(navigationContext) ?? string.Empty;
		}

		public SimpleNavigationElement GetIndexElement(NavigationContext navigationContext)
		{
			var toReturn = this.Value.FirstOrDefault(e => e.IsIndexElement) as SimpleNavigationElement;
			if (toReturn == null)
			{
				// no index element, add an artificial one.
				var path = string.Empty;

				// Don't check parents when using relative paths since we need to walk the tree manually
				if (navigationContext.PathSpecification == PathSpecification.Full)
				{
					if (this.ParentContainer != null)
					{
						path = Path.GetDirectoryName(this.ParentContainer.GetTargetURL(navigationContext));
					}
				}

				var nameToUse = string.Empty;

				switch (navigationContext.UrlFormatting)
				{
					case UrlFormatting.None:
						// Backwards compatibility mode
						nameToUse = this.Name.Replace(".", "").Replace('/', '_').Replace("\\", "_").Replace(":", "").Replace(" ", "");
						break;

					default:
						nameToUse = this.Name.ApplyUrlFormatting(navigationContext.UrlFormatting);
						break;
				}

				if (string.IsNullOrWhiteSpace(nameToUse))
				{
					return null;
				}

				var value = string.Format("{0}{1}.md", path, nameToUse);

				switch (navigationContext.PathSpecification)
				{
					case PathSpecification.Full:
						// Default is correct
						break;

					case PathSpecification.Relative:
					case PathSpecification.RelativeAsFolder:
						if (!IsRoot)
						{
							string preferredPath = null;

							// We're making a big assumption here, but we can get the first page and assume it's 
							// in the right folder.

							// Find first (simple) child and use 1 level up. A SimpleNavigationElement mostly represents a folder
							// thus is excellent to be used as a folder name
							var firstSimpleChildPage = (SimpleNavigationElement) this.Value.FirstOrDefault(x => x is SimpleNavigationElement && !ReferenceEquals(this, x));
							if (firstSimpleChildPage != null)
							{
								preferredPath = Path.GetDirectoryName(firstSimpleChildPage.Value);
							}
							else
							{
								// This is representing an empty folder. Search for first child navigation that has real childs,
								// then retrieve the path by going levels up.
								var firstChildNavigationLevel = (NavigationLevel)this.Value.FirstOrDefault(x => x is NavigationLevel && ((NavigationLevel)x).Value.Any() && !ReferenceEquals(this, x));
								if (firstChildNavigationLevel != null)
								{
									var targetUrl = firstChildNavigationLevel.Value.First().GetTargetURL(navigationContext);

									// 3 times since we need 2 parents up
									preferredPath = Path.GetDirectoryName(targetUrl);
									preferredPath = Path.GetDirectoryName(preferredPath);
									preferredPath = Path.GetDirectoryName(preferredPath);
								}
							}

							if (!string.IsNullOrWhiteSpace(preferredPath))
							{
								value = Path.Combine(preferredPath, "index.md");
							}
						}
						break;

					default:
						throw new ArgumentOutOfRangeException(nameof(navigationContext.PathSpecification), navigationContext.PathSpecification, null);
				}

				toReturn = new SimpleNavigationElement
				{
					ParentContainer = this,
					Value = value,
					Name = this.Name,
					IsIndexElement = true
				};

				this.Value.Add(toReturn);
			}

			return toReturn;
		}

		#region Properties
		/// <summary>
		/// Gets / sets a value indicating whether this element is the __index element
		/// </summary>
		public override bool IsIndexElement
		{
			// never an index
			get { return false; }
			set
			{
				// nop;
			}
		}


		public bool IsRoot { get; set; }
		#endregion
	}
}