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