From 0632aa95780802309ec9af49a35d33834236561c Mon Sep 17 00:00:00 2001 From: ulrich Date: Thu, 14 Nov 2024 11:57:01 +0000 Subject: [PATCH] Buildinfos in Readme hinzugefuegt --- src/de/uhilger/fm/package-info.java | 15 ++++++++++++--- 1 files changed, 12 insertions(+), 3 deletions(-) diff --git a/src/de/uhilger/fm/package-info.java b/src/de/uhilger/fm/package-info.java index 375d662..21acb4e 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. + * + * <p><b>Programme, die diese Klassenbibliothek einsetzen, muessen eigene Massnahmen gegen + * Path Traversal o.ä. vorschalten, sofern dies nicht gewuenscht ist.</b></p> + * * <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,11 +75,13 @@ * 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 * erfolgen. * + * Die Transformation nach JSON erfordert die Package <code>com.google.gson.Gson</code>. + * */ package de.uhilger.fm; \ No newline at end of file -- Gitblit v1.9.3