mcs/tools/mdoc/Mono.Documentation/webdoc.cs

   1 //
   2 // webdoc.cs
   3 //
   4 // Author:
   5 //   Jonathan Pryor  <jpryor@novell.com>
   6 //
   7 // Copyright (c) 2009 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;
  30 using System.Collections.Generic;
  31 using System.Diagnostics;
  32 using System.IO;
  33 using System.Linq;
  34 using System.Text;
  35 using System.Web;
  36
  37 using Monodoc;
  38
  39 using Mono.Options;
  40 using Mono.Rocks;
  41
  42 namespace Mono.Documentation
  43 {
  44         public class MDocExportWebdocHtml : MDocCommand
  45         {
  46                 public override void Run (IEnumerable<string> args)
  47                 {
  48                         string dir = null;
  49                         bool forceUpdate = false;
  50                         var options = new OptionSet () {
  51                                 { "force-update",
  52                                         "Always generate new files.  If not specified, will only generate " +
  53                                         "files if the write time of the output directory is older than the " +
  54                                         "write time of the source .tree/.zip files.",
  55                                         v => forceUpdate = v != null },
  56                                 { "o|out=",
  57                                         "The {DIRECTORY} to place the generated files and directories.\n\n" +
  58                                         "If not specified, defaults to\n`dirname FILE`/cache/`basename FILE .tree`.",
  59                                         v => dir = v },
  60                         };
  61                         List<string> files = Parse (options, args, "export-html-webdoc",
  62                                         "[OPTIONS]+ FILES",
  63                                         "Export mdoc documentation within FILES to HTML for use by ASP.NET webdoc.\n\n" +
  64                                         "FILES are .tree or .zip files as produced by 'mdoc assemble'.");
  65                         if (files == null)
  66                                 return;
  67                         if (files.Count == 0)
  68                                 Error ("No files specified.");
  69                         HelpSource.use_css = true;
  70                         HelpSource.FullHtml = false;
  71                         SettingsHandler.Settings.EnableEditing = false;
  72                         foreach (var basePath in
  73                                         files.Select (f =>
  74                                                         Path.Combine (Path.GetDirectoryName (f), Path.GetFileNameWithoutExtension (f)))
  75                                         .Distinct ()) {
  76                                 Console.WriteLine ("# Processing BasePath={0}", basePath);
  77                                 string treeFile = basePath + ".tree";
  78                                 string zipFile  = basePath + ".zip";
  79                                 if (!Exists (treeFile) || !Exists (zipFile))
  80                                         continue;
  81                                 string outDir = dir ?? Path.Combine (
  82                                                 Path.Combine (Path.GetDirectoryName (basePath), "cache"),
  83                                                 Path.GetFileName (basePath));
  84                                 Directory.CreateDirectory (outDir);
  85                                 if (!forceUpdate &&
  86                                                         MaxWriteTime (treeFile, zipFile) < Directory.GetLastWriteTime (outDir))
  87                                         continue;
  88                                 Console.WriteLine ("# Tree file={0}", treeFile);
  89                                 Tree tree = new Tree (null, treeFile);
  90                                 RootTree docRoot = RootTree.LoadTree ();
  91                                 string helpSourceName = Path.GetFileName (basePath);
  92                                 HelpSource hs = docRoot.HelpSources.Cast<HelpSource> ()
  93                                         .FirstOrDefault (h => h.Name == helpSourceName);
  94                                 if (hs == null) {
  95                                         throw new Exception ("Only installed .tree and .zip files are supported.");
  96                                 }
  97                                 foreach (Node node in tree.TraverseDepthFirst<Node, Node> (t => t, t => t.Nodes.Cast<Node> ())) {
  98                                         var url = node.URL;
  99                                         Console.WriteLine ("# NodeUrl={0}", url);
 100                                         if (string.IsNullOrEmpty (url))
 101                                                 continue;
 102                                         var file = Path.Combine (outDir,
 103                                                         HttpUtility.UrlEncode (url).Replace ('/', '+').Replace ("*", "%2a"));
 104                                         Console.WriteLine ("# file={0}", file);
 105                                         using (var o = File.AppendText (file)) {
 106                                                 Node _;
 107                                                 o.Write (hs.GetText (url, out _));
 108                                         }
 109                                 }
 110                         }
 111                 }
 112
 113                 bool Exists (string file)
 114                 {
 115                         if (!File.Exists (file)) {
 116                                         Message (TraceLevel.Error,
 117                                                         "mdoc: Could not find file: {0}", file);
 118                                         return false;
 119                         }
 120                         return true;
 121                 }
 122
 123                 DateTime MaxWriteTime (params string[] files)
 124                 {
 125                         return files.Select (f => File.GetLastWriteTime (f)).Max ();
 126                 }
 127         }
 128 }