Ein minimalistischer HTTP-Server
view | history | commit | commitdiff
ulrich
2021-03-26 c21adf1c57496d003aabb8bedc4b1239d3be106e
commit | author | age
9c7249 1 /*
678b07 2   mini-server - Ein minimalistischer HTTP-Server
U 3   Copyright (C) 2021  Ulrich Hilger
9c7249 4
678b07 5   This program is free software: you can redistribute it and/or modify
U 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.
9c7249 9
678b07 10   This program is distributed in the hope that it will be useful,
U 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.
9c7249 14
678b07 15   You should have received a copy of the GNU Affero General Public License
U 16   along with this program.  If not, see <https://www.gnu.org/licenses/>.
8abbcf 17  */
9c7249 18 package de.uhilger.minsrv.handler;
U 19
20 import com.sun.net.httpserver.Headers;
21 import com.sun.net.httpserver.HttpExchange;
22 import com.sun.net.httpserver.HttpHandler;
23 import java.io.File;
24 import java.io.FileInputStream;
25 import java.io.IOException;
26 import java.io.InputStream;
27 import java.io.OutputStream;
28 import java.nio.charset.StandardCharsets;
7f3fef 29 import java.nio.file.Files;
9c7249 30 import java.text.SimpleDateFormat;
U 31 import java.util.ArrayList;
32 import java.util.Date;
33 import java.util.Iterator;
34 import java.util.List;
35 import java.util.logging.Logger;
36
37 /**
8abbcf 38  * Die Klasse FileHandler dient zur Auslieferung von Dateiinhalten &uuml;ber
U 39  * HTTP.
c21adf 40  *
U 41  * F&uuml;r das Streaming &uuml;ber HTTP wird die Auslieferung von Teilinhalten
42  * mit dem Accept-Ranges-Header angeboten und via Range-Header unterst&uuml;tzt.
7f3fef 43  * (vgl. https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests)
c21adf 44  *
8abbcf 45  * @author Ulrich Hilger
9c7249 46  * @version 0.1, 25. M&auml;rz 2021
U 47  */
48 public class FileHandler implements HttpHandler {
8abbcf 49
U 50   /* Der Logger fuer diesen FileHandler */
9c7249 51   private static final Logger logger = Logger.getLogger(FileHandler.class.getName());
U 52
8abbcf 53   /* Header Namen */
c21adf 54   public static final String RANGE_HEADER = "Range";
U 55   public static final String CONTENT_RANGE_HEADER = "Content-Range";
56   public static final String ACCEPT_RANGES_HEADER = "Accept-Ranges";
57   public static final String LAST_MODIFIED_DATE_HEADER = "Last-Modified";
58   public static final String CONTENT_TYPE = "Content-Type";
8abbcf 59
U 60   /* Status Codes */
61   public static final int SC_OK = 200;
9c7249 62   public static final int SC_PARTIAL_CONTENT = 206;
8abbcf 63   public static final int SC_NOT_FOUND = 404;
c21adf 64
U 65   /* String Konstanten */
66   public static final String STR_BYTES = "bytes";
67   public static final String STR_BLANK = " ";
68   public static final String STR_DASH = "-";
69   public static final String STR_COMMA = ",";
70   public static final String STR_SLASH = "/";
71   public static final String STR_DOT = ".";
72   public static final String STR_NOT_FOUND = " not found.";
73   public static final String LM_PATTERN = "EEE, dd MMM yyyy HH:mm:ss zzz";
74   public static final String RANGE_PATTERN = "[^\\d-,]";
75   public static final String WELCOME_FILE = "index.html";
8abbcf 76
U 77   /* Ablageort fuer Webinhalte */
9c7249 78   private final String basePath;
U 79
80   /**
81    * Ein neues Objekt der Klasse FileHandler erzeugen
8abbcf 82    *
U 83    * @param basePath der Pfad zu Inhalten, die von diesem Handler ausgeliefert
84    * werden
9c7249 85    */
U 86   public FileHandler(String basePath) {
87     this.basePath = basePath;
88   }
89
90   /**
8abbcf 91    * Die Datei ermitteln, die sich aus dem angefragten URL ergibt, pr&uuml;fen,
U 92    * ob die Datei existiert und den Inhalt der Datei abh&auml;ngig davon, ob ein
93    * Range-Header vorhanden ist, ganz oder teilweise ausliefern.
94    *
95    * @param e das Objekt mit Methoden zur Untersuchung der Anfrage sowie zum
96    * Anfertigen und Senden der Antwort
97    * @throws IOException falls etwas schief geht entsteht dieser Fehler
9c7249 98    */
U 99   @Override
100   public void handle(HttpExchange e) throws IOException {
101     String ctxPath = e.getHttpContext().getPath();
102     String uriPath = e.getRequestURI().getPath();
e966eb 103     logger.info(uriPath);
9c7249 104     String fName = uriPath.substring(ctxPath.length());
c21adf 105     if (fName.startsWith(STR_DOT)) {
8abbcf 106       sendNotFound(e, fName);
9c7249 107     } else {
e966eb 108       Headers headers = e.getRequestHeaders();
8abbcf 109       if (headers.containsKey(RANGE_HEADER)) {
U 110         serveFileParts(e, new File(basePath, fName));
111       } else {
c21adf 112         if (fName.endsWith(STR_SLASH)) {
U 113           fName += WELCOME_FILE;
8abbcf 114         }
U 115         serveFile(e, new File(basePath, fName));
9c7249 116       }
U 117     }
118   }
119
120   /**
121    * Den Inhalt einer Datei ausliefern
8abbcf 122    *
U 123    * @param e das Objekt mit Methoden zur Untersuchung der Anfrage sowie zum
124    * Anfertigen und Senden der Antwort
9c7249 125    * @param file die Datei, deren Inhalt ausgeliefert werden soll
8abbcf 126    * @throws IOException falls etwas schief geht entsteht dieser Fehler
9c7249 127    */
U 128   private void serveFile(HttpExchange e, File file) throws IOException {
129     if (file.exists()) {
8abbcf 130       OutputStream os = e.getResponseBody();
51e1d5 131       Headers headers = e.getResponseHeaders();
7f3fef 132       setCommonHeaders(headers, file);
8abbcf 133       e.sendResponseHeaders(SC_OK, file.length());
9c7249 134       InputStream in = new FileInputStream(file);
U 135       int b = in.read();
136       while (b > -1) {
137         os.write(b);
138         b = in.read();
139       }
140       in.close();
8abbcf 141       os.flush();
U 142       os.close();
9c7249 143     } else {
8abbcf 144       sendNotFound(e, file.getName());
9c7249 145     }
U 146   }
8abbcf 147
9c7249 148   /**
U 149    * Einen Teil des Inhalts einer Datei ausliefern
8abbcf 150    *
U 151    * Wenn eine Range angefragt wird, hat die Antwort einen Content-Range Header
152    * wie folgt:
153    *
154    * <code>
155    * Content-Range: bytes 0-1023/146515
156    * Content-Length: 1024
157    * </code>
158    *
159    * Wenn mehrere Ranges angefragt werden, hat die Antwort mehrere Content-Range
160    * Header als Multipart Response. Multipart Responses fehlen dieser
161    * Implementierung noch.
162    *
163    * (vgl. https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests)
164    *
165    * @param e das Objekt mit Methoden zur Untersuchung der Anfrage sowie zum
166    * Anfertigen und Senden der Antwort
9c7249 167    * @param file die Datei, deren Inhalt teilweise ausgeliefert werden soll
8abbcf 168    * @throws IOException falls etwas schief geht entsteht dieser Fehler
9c7249 169    */
U 170   /*
8abbcf 171    */
9c7249 172   private void serveFileParts(HttpExchange e, File file) throws IOException {
8abbcf 173     if (file.exists()) {
U 174       InputStream is = new FileInputStream(file);
175       OutputStream os = e.getResponseBody();
176       Headers resHeaders = e.getResponseHeaders();
7f3fef 177       setCommonHeaders(resHeaders, file);
8abbcf 178       long responseLength = 0;
U 179       long start = 0;
180       long end;
181       RangeGroup rangeGroup = parseRanges(e, file);
182       Iterator<Range> i = rangeGroup.getRanges();
183       while (i.hasNext()) {
184         Range range = i.next();
185         start = range.getStart();
186         end = range.getEnd();
c21adf 187         resHeaders.add(CONTENT_RANGE_HEADER, contentRangeHdr(range, file));
8abbcf 188         responseLength += (end - start);
U 189       }
190       e.sendResponseHeaders(SC_PARTIAL_CONTENT, responseLength);
191       if (start > 0) {
192         is.skip(start);
193       }
194       long count = 0;
195       int byteRead = is.read();
196       while (byteRead > -1 && count < responseLength) {
197         ++count;
198         os.write(byteRead);
199         byteRead = is.read();
200       }
201       os.flush();
202       os.close();
203       is.close();
204     } else {
205       sendNotFound(e, file.getName());
9c7249 206     }
U 207   }
c21adf 208
U 209   private String contentRangeHdr(Range range, File file) {
210     StringBuilder sb = new StringBuilder();
211     sb.append(STR_BYTES);
212     sb.append(STR_BLANK);
213     sb.append(range.getStart());
214     sb.append(STR_DASH);
215     sb.append(range.getEnd());
216     sb.append(STR_SLASH);
217     sb.append(file.length());
218     return sb.toString();
219   }
220
7f3fef 221   private void setCommonHeaders(Headers resHeaders, File file) throws IOException {
c21adf 222     resHeaders.add(ACCEPT_RANGES_HEADER, STR_BYTES);
7f3fef 223     String mimeType = Files.probeContentType(file.toPath());
c21adf 224     if (mimeType != null) {
7f3fef 225       resHeaders.add(CONTENT_TYPE, mimeType);
U 226     }
c21adf 227     SimpleDateFormat sdf = new SimpleDateFormat(LM_PATTERN);
7f3fef 228     Date date = new Date(file.lastModified());
U 229     resHeaders.add(LAST_MODIFIED_DATE_HEADER, sdf.format(date));
230   }
8abbcf 231
9c7249 232   /**
U 233    * Die Byte-Ranges aus dem Range-Header ermitteln.
8abbcf 234    *
9c7249 235    * Der Range-Header kann unterschiedliche Abschnitte bezeichnen, Beispiele:
8abbcf 236    * Range: bytes=200-1000, 2000-6576, 19000- Range: bytes=0-499, -500 (vgl.
U 237    * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range)
238    *
239    * @param e das Objekt mit Methoden zur Untersuchung der Anfrage sowie zum
240    * Anfertigen und Senden der Antwort
9c7249 241    * @param file die Datei, deren Inhalt ausgeliefert werden soll
U 242    * @return die angefragten Byte-Ranges
243    */
244   private RangeGroup parseRanges(HttpExchange e, File file) {
245     RangeGroup ranges = new RangeGroup();
246     String rangeHeader = e.getRequestHeaders().get(RANGE_HEADER).toString();
c21adf 247
9c7249 248     /*
U 249       Inhalt des Range-Headers von nicht benoetigten Angaben befreien
250     
251       Ein Range Header enthaelt neben den Start- und Endwerten der Ranges auch 
252       die Angabe "bytes:". Es ist aber keine andere Auspraegung als Bytes 
253       spezifiziert, daher muss die Angabe nicht ausgewertet werden und kann 
254       entfallen. Der Range-Header kann zudem noch eckige Klammern haben 
255       wie in [bytes=200-1000].
256     
257       Der regulaere Ausdruck "[^\\d-,]" bezeichnet alle Zeichen, die keine 
258       Ziffern 0-9, Bindestrich oder Komma sind.
8abbcf 259      */
c21adf 260     rangeHeader = rangeHeader.replaceAll(RANGE_PATTERN, "");
8abbcf 261
9c7249 262     /*
U 263       Die Ranges ermitteln. 
264     
265       Nach dem vorangegangenen Schritt besteht der Header-Ausdruck nur noch 
266       aus einer mit Kommas getrennten Liste aus Start- und Endwerten wie z.B. 
267       "-103,214-930,1647-"
268     
269       Ein Range-Ausdruck kann dann drei verschiedene Auspraegungen haben:
270       1. Startwert fehlt, z.B. -200
271       2. Start und Ende sind vorhanden, z.B. 101-200
272       3. Endwert fehlt, z.B. 201-
273       
274       Teilt man einen Range-String mit der Methode String.split("-") am 
275       Bindestrich ('-') in ein String-Array 'values' gilt:
276       values.length < 2: Fall 3 ist gegeben
277       values.length > 1 und values[0].length < 1: Fall 1 ist gegeben
278       ansonsten: Fall 2 ist gegeben
8abbcf 279      */
c21adf 280     String[] rangeArray = rangeHeader.split(STR_COMMA);
8abbcf 281     for (String rangeStr : rangeArray) {
9c7249 282       Range range = new Range();
c21adf 283       String[] values = rangeStr.split(STR_DASH);
8abbcf 284       if (values.length < 2) {
9c7249 285         // Fall 3
U 286         range.setStart(Long.parseLong(values[0]));
287         range.setEnd(file.length());
288       } else {
8abbcf 289         if (values[0].length() < 1) {
9c7249 290           // Fall 1
U 291           range.setStart(0);
292           range.setEnd(Long.parseLong(values[1]));
293         } else {
294           // Fall 2
295           range.setStart(Long.parseLong(values[0]));
296           range.setEnd(Long.parseLong(values[1]));
297         }
298       }
299       ranges.addRange(range);
8abbcf 300     }
9c7249 301     return ranges;
U 302   }
8abbcf 303
9c7249 304   /**
51e1d5 305    * Eine nicht gefunden Antwort senden
c21adf 306    *
51e1d5 307    * @param e das Objekt mit Methoden zur Untersuchung der Anfrage sowie zum
U 308    * Anfertigen und Senden der Antwort
309    * @param fname Name der Datei, die nicht gefunden wurde
310    * @throws IOException falls etwas schief geht entsteht dieser Fehler
311    */
312   public void sendNotFound(HttpExchange e, String fname) throws IOException {
313     OutputStream os = e.getResponseBody();
c21adf 314     String response = fname + STR_NOT_FOUND;
51e1d5 315     byte[] bytes = response.getBytes(StandardCharsets.UTF_8);
U 316     e.sendResponseHeaders(SC_NOT_FOUND, bytes.length);
317     os.write(bytes);
318     os.flush();
319     os.close();
320   }
321
322   /**
9c7249 323    * Eine Range
U 324    */
325   class Range {
8abbcf 326
9c7249 327     private long start;
U 328     private long end;
329
330     /**
331      * Den Beginn dieser Range ermitteln
8abbcf 332      *
9c7249 333      * @return Beginn dieser Range
U 334      */
335     public long getStart() {
336       return start;
337     }
338
339     /**
340      * Den Beginn dieser Range angeben
8abbcf 341      *
9c7249 342      * @param start Beginn dieser Range
U 343      */
344     public void setStart(long start) {
345       this.start = start;
346     }
347
348     /**
349      * Das Ende dieser Range ermitteln
8abbcf 350      *
9c7249 351      * @return Ende dieser Range
U 352      */
353     public long getEnd() {
354       return end;
355     }
356
357     /**
358      * Das Ende dieser Range angeben
8abbcf 359      *
9c7249 360      * @param end Ende dieser Range
U 361      */
362     public void setEnd(long end) {
363       this.end = end;
364     }
365   }
8abbcf 366
9c7249 367   /**
U 368    * Eine Gruppe aus Ranges
369    */
370   class RangeGroup {
8abbcf 371
9c7249 372     private List<Range> ranges;
U 373     private long totalSize;
8abbcf 374
9c7249 375     /**
U 376      * Ein neues Objekt der Klasse RangeGroup erzeugen
377      */
378     public RangeGroup() {
379       ranges = new ArrayList();
380     }
8abbcf 381
9c7249 382     /**
U 383      * Dieser RangeGroup eine Range hinzufuegen.
8abbcf 384      *
9c7249 385      * @param range die Range, die dieser RangeGroup hinzugefuegt werden soll
U 386      */
387     public void addRange(Range range) {
388       ranges.add(range);
389       totalSize += range.getEnd() - range.getStart();
390     }
8abbcf 391
9c7249 392     /**
8abbcf 393      * Die Gesamtgr&ouml;&szlig;e dieser RangeGroup ermitteln, also die Summe
U 394      * der Anzahl von Bytes aller ihrer Ranges.
395      *
9c7249 396      * @return die Gr&ouml;&szlig;e dieser RangeGroup in Bytes
U 397      */
398     public long getSize() {
399       return totalSize;
400     }
8abbcf 401
9c7249 402     /**
U 403      * Einen Iterator &uuml;ber die Ranges dieser RangeGroup abrufen
8abbcf 404      *
9c7249 405      * @return Iterator &uuml;ber die Ranges dieser RangeGroup
U 406      */
407     public Iterator<Range> getRanges() {
408       return ranges.iterator();
409     }
410   }
411 }