WebBox Klassenbibliothek
view | history | commit | commitdiff
ulrich
2020-07-24 e4ff596039e48bb219ca49b03d8f84ad05236f2a
commit | author | age
1385d2 1 /*
U 2     WebBox - Dein Server.
3     Copyright (C) 2020 Ulrich Hilger, http://uhilger.de
4
5     This program is free software: you can redistribute it and/or modify
6     it under the terms of the GNU Affero General Public License as
7     published by the Free Software Foundation, either version 3 of the
8     License, or (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU Affero General Public License for more details.
14
15     You should have received a copy of the GNU Affero General Public License
16     along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18
19 package de.uhilger.wbx.web;
20
21 import java.io.BufferedReader;
22 import java.io.File;
23 import java.io.FileInputStream;
24 import java.io.IOException;
e4ff59 25 import java.io.InputStream;
1385d2 26 import java.io.InputStreamReader;
U 27 import java.io.PrintWriter;
3bbfbc 28 import java.util.HashMap;
1385d2 29 import javax.servlet.ServletException;
U 30 import javax.servlet.http.HttpServlet;
31 import javax.servlet.http.HttpServletRequest;
32 import javax.servlet.http.HttpServletResponse;
33 import java.util.Map;
e4ff59 34 import javax.servlet.ServletOutputStream;
1385d2 35
U 36 import static org.asciidoctor.Asciidoctor.Factory.create;
37 import org.asciidoctor.Asciidoctor;
c5090a 38 import static org.asciidoctor.AttributesBuilder.attributes;
U 39 import static org.asciidoctor.OptionsBuilder.options;
1385d2 40
U 41
42
43 /**
44  * Das AdocServlet wandelt AsciiDoc-Inhalte (*.adoc) 
70be19 45  * zu HTML-Seiten und PDF-Dokumenten
d8a1ab 46  * 
d572ec 47  * Mit Angabe des Parameters ?pdf=true im URL wird PDF erzeugt, andernfalls HTML
1385d2 48  */
U 49 public class AdocServlet extends HttpServlet  {
50   
51   private static final String DOT = ".";
3bbfbc 52   private static final String HTML = "html";
70be19 53   private static final String PDF = "pdf";
U 54   private static final String SERVLET_NAME = "AdocServlet";
1385d2 55   
U 56   /**
d572ec 57    * Die Methode processRequest verarbeitet HTTP-Anfragen des Typs  
U 58    * <code>GET</code> und <code>POST</code>.
1385d2 59    *
d572ec 60    * @param request die Servlet-Anfrage
U 61    * @param response die Servlet-Antwort
62    * @throws ServletException wenn ein Servlet-spezifischer Fehler passiert
63    * @throws IOException wenn ein Eingabe- oder Ausgabe-Fehler passiert
1385d2 64    */
U 65   protected void processRequest(HttpServletRequest request, HttpServletResponse response)
66           throws ServletException, IOException 
67   {
68
a22ef6 69     // Asciidoc-Quelldatei aus HTTP-Request ermitteln
U 70     String vPath = request.getServletPath();
71     String absname = getServletContext().getRealPath(vPath);
72     File adocfile = new File(absname);
73
74     // HTML-Datei ermitteln
75     String nameext = adocfile.getName();
76     String fname = nameext.substring(0, nameext.lastIndexOf(DOT));
77     File htmlfile = new File(adocfile.getParentFile(), fname + DOT + HTML);
78     File outfile = htmlfile; // Standardmaessig wird HTML zurueckgegeben
0fa5e7 79     response.setCharacterEncoding("UTF-8");
U 80     
a22ef6 81     /*
U 82       nach HTML transformieren, wenn die Quelle sich geandert hat oder 
83       die HTML-Datei noch nicht existiert
84     */
85     if(!htmlfile.exists() || adocfile.lastModified() > htmlfile.lastModified()) {
86       transform(absname);
87     }
88
89     /*
90       nach PDF transformieren, wenn der Parameter pdf=true existiert und 
91       wenn die Quelle sich geandert hat oder 
92       die PDF-Datei noch nicht existiert
93     */
e4ff59 94     
a22ef6 95     String pdf = request.getParameter(PDF);
U 96     if(null != pdf && pdf.equalsIgnoreCase(Boolean.TRUE.toString())) {
97       File pdffile = new File(adocfile.getParentFile(), fname + DOT + PDF);
98       outfile = pdffile; // PDF soll zurueckgegeben werden
99       if(!pdffile.exists() || adocfile.lastModified() > pdffile.lastModified()) {
f2a703 100         response.setContentType("application/pdf");
a22ef6 101         transform(absname, PDF);
70be19 102       }
e4ff59 103       ServletOutputStream os = response.getOutputStream();
U 104       InputStream bytes = new FileInputStream(outfile);
105       int b = bytes.read();
106       while(b > -1 ) {
107         os.write(b);
108         b = bytes.read();
1385d2 109       }
e4ff59 110     } else {
U 111       PrintWriter out = response.getWriter();
112       InputStreamReader in = new InputStreamReader(new FileInputStream(outfile), "UTF-8");
113       in.transferTo(out);
1385d2 114     }
U 115   }
116   
d572ec 117   /**
U 118    * Nach HTML transformieren
119    * @param fileName der Dateiname der Quelldatei samt absoluter Pfadangabe
120    */
3bbfbc 121   private void transform(String fileName) {
U 122     transform(fileName, null);
1385d2 123   }  
3bbfbc 124   
d572ec 125   /**
U 126    * In ein Format transformieren, das von einem 'Backend' von Asciidoctor 
127    * unterstuetzt wird
128    * @param fileName der Dateiname der Quelldatei samt absoluter Pfadangabe
129    * @param backend das Kuerzel des Backends, z.B. der String 'pdf', wenn 
130    * nach PDF transformiert werden soll
131    */
3bbfbc 132   private void transform(String fileName, String backend) {    
e70523 133     Map<String, Object> attributes;
38929a 134     File outFile = new File(fileName);
f2a703 135     String thisDirName = outFile.getParent();
e70523 136     File pdfStyles = new File(outFile.getParentFile(), "custom-theme.yml");
U 137     if(pdfStyles.exists()) {
138       attributes = attributes()
f2a703 139               .attribute("pdf-themesdir", thisDirName)
e70523 140               .attribute("pdf-theme","custom")
f2a703 141               .attribute("pdf-fontsdir", thisDirName + "/fonts")
U 142               .attribute("allow-uri-read")
e70523 143               .sourceHighlighter("highlightjs")
U 144               .asMap();
145     } else {
146       attributes = attributes()
147               .sourceHighlighter("highlightjs")
148               .asMap();
149     }
7bee9c 150     Map<String, Object> options;
U 151     if(null != backend) {
152       options = options().inPlace(false)
153               .backend(backend).attributes(attributes).asMap();
154       
155     } else {
156       options = options().inPlace(false)
157               .attributes(attributes).asMap();
158     }
3bbfbc 159     
U 160     Asciidoctor asciidoctor = create();    
16c6c6 161     asciidoctor.requireLibrary("asciidoctor-diagram");
3bbfbc 162     asciidoctor.convertFile(new File(fileName), options);    
U 163   }
1385d2 164
U 165   /**
d572ec 166    * Die HTTP-<code>GET</code>-Methode verarbeiten.
1385d2 167    *
d572ec 168    * @param request die Servlet-Anfrage
U 169    * @param response die Servlet-Antwort
170    * @throws ServletException wenn ein Servlet-spezifischer Fehler passiert
171    * @throws IOException wenn ein Eingabe- oder Ausgabe-Fehler passiert
1385d2 172    */
U 173   @Override
174   protected void doGet(HttpServletRequest request, HttpServletResponse response)
175           throws ServletException, IOException {
176     processRequest(request, response);
177   }
178
179   /**
d572ec 180    * Die HTTP-<code>POST</code>-Methode verarbeiten.
1385d2 181    *
d572ec 182    * @param request die Servlet-Anfrage
U 183    * @param response die Servlet-Antwort
184    * @throws ServletException wenn ein Servlet-spezifischer Fehler passiert
185    * @throws IOException wenn ein Eingabe- oder Ausgabe-Fehler passiert
1385d2 186    */
U 187   @Override
188   protected void doPost(HttpServletRequest request, HttpServletResponse response)
189           throws ServletException, IOException {
190     processRequest(request, response);
191   }
192
193   /**
d572ec 194    * Eine Kurzbeschreibung des Servlets ausgeben.
1385d2 195    *
d572ec 196    * @return einen String mit der Kurzbeschreibung des Servlets
1385d2 197    */
U 198   @Override
199   public String getServletInfo() {
70be19 200     return SERVLET_NAME;
U 201   }
1385d2 202
U 203 }