// Copyright (C) 2015, The Duplicati Team // http://www.duplicati.com, info@duplicati.com // // This library is free software; you can redistribute it and/or modify // it under the terms of the GNU Lesser General Public License as // published by the Free Software Foundation; either version 2.1 of the // License, or (at your option) any later version. // // This library is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU // Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public // License along with this library; if not, write to the Free Software // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA using System; using System.Linq; using System.Text; using Newtonsoft.Json; namespace Duplicati.Server.WebServer.RESTMethods { public class Help : IRESTMethodGET { public void GET(string key, RequestInfo info) { var sb = new StringBuilder(); if (string.IsNullOrWhiteSpace(key)) { foreach(var m in RESTHandler.Modules.Keys.OrderBy(x => x)) { var mod = RESTHandler.Modules[m]; if (mod == this) continue; var desc = mod.GetType().Name; if (mod is IRESTMethodDocumented documented) desc = documented.Description; sb.AppendFormat(ITEM_TEMPLATE, RESTHandler.API_URI_PATH, m, mod.GetType().Name, desc); } var data = Encoding.UTF8.GetBytes(string.Format(TEMPLATE, "API Information", "", sb)); info.Response.ContentType = "text/html"; info.Response.ContentLength = data.Length; info.Response.Body.Write(data, 0, data.Length); info.Response.Send(); } else { IRESTMethod m; RESTHandler.Modules.TryGetValue(key, out m); if (m == null) { info.Response.Status = System.Net.HttpStatusCode.NotFound; info.Response.Reason = "Module not found"; } else { var desc = ""; if (m is IRESTMethodDocumented doc) { desc = doc.Description; foreach(var t in doc.Types) sb.AppendFormat(METHOD_TEMPLATE, t.Key, JsonConvert.SerializeObject(t.Value)); //TODO: Format the type } var data = Encoding.UTF8.GetBytes(string.Format(TEMPLATE, m.GetType().Name, desc, sb)); info.Response.ContentType = "text/html"; info.Response.ContentLength = data.Length; info.Response.Body.Write(data, 0, data.Length); info.Response.Send(); } } } private const string TEMPLATE = @" {0}

{0}

{1}

"; private const string ITEM_TEMPLATE = @"
  • {2}: {3}
  • "; private const string METHOD_TEMPLATE = @" {0}:
    {1}
    "; } }