From 7e5166a55fa459deab5579f764b7bb34719e5ec9 Mon Sep 17 00:00:00 2001 From: ulrich Date: Thu, 14 Nov 2024 11:06:34 +0000 Subject: [PATCH] Dokumentation in Arbeit: Inflator fertig dokumentiert, kleinere Anpassungen --- src/de/uhilger/fm/package-info.java | 13 ++++++++++--- 1 files changed, 10 insertions(+), 3 deletions(-) diff --git a/src/de/uhilger/fm/package-info.java b/src/de/uhilger/fm/package-info.java index 375d662..aa832be 100644 --- a/src/de/uhilger/fm/package-info.java +++ b/src/de/uhilger/fm/package-info.java @@ -32,12 +32,19 @@ * Inflator().extractZipfile(fileName, path, base) * </pre> * + * Die hier enthaltenen Funktionen beinhalten keine Massnahmen gegen Path Traversal o.ä. + * Dies ist beabsichtigt, um Pfadausdruecke wie z.B. '../' bei den hier implementierten + * Dateioperationen verarbeiten zu koennen. + * + * <b>Programme, die diese Klassenbibliothek einsetzen, muessen eigene Massnahmen gegen + * Path Traversal o.ä. beisteuern, sofern dies nicht gewuenscht ist.</b> + * * <p>Die folgenden Funktionalitaeten sind in dieser Auspraegung einer * Dateiverwaltung fest angelegt. Sie sind damit Kandidaten fuer eine * Erweiterung dieser Klassenbibliothek um andere evtl. benoetigte * Auspraegungen.</p> * - * <p>Handhabung von Bilddateien</p> + * <p><b>Handhabung von Bilddateien</b></p> * * Neben der Datei eines Bildes in Originalgroesse werden weitere Dateien als Varianten * eines Bildes unterstuetzt. @@ -49,7 +56,7 @@ * fuer small usw. Gleichsam lassen sich damit Eigenschaften wie zum Beispiel * eine Base64-Kodierung kombinieren. Hier waere der Namenszusatz dann eine Kombination * aus Groesse und Kodierung wie mit <code>_sm_b64</code>, so dass sich fuer ein Bild stets - * eine ganze Gruppe von Datien ergibt, z.B.: + * eine ganze Gruppe von Dateien ergibt, z.B.: * * <pre> * bild.jpg @@ -68,7 +75,7 @@ * Eine Dateiliste enthaelt aus diesem Grund fuer Bilddateien die beiden zusaetzlichen Angaben * <code>miniurl</code> und <code>imgsrc</code>. * - * <p>Ordnerliste im JSON-Format</p> + * <p><b>Ordnerliste im JSON-Format</b></p> * * Die Liste mit Dateien eines Ordners wird im JSON-Format ausgegeben. Ueber eine * entsprechende Erweiterung koennte die Ausgabe in verschiedenen waehlbaren Formaten -- Gitblit v1.9.3