Dateiverwaltung für die WebBox
ulrich
2018-03-03 977e5d042e6b24b87eae440d7cbce24201150a5a
commit | author | age
798463 1 # Dateiverwaltung
U 2
fcee96 3 Eine Bedienoberfläche zur Bearbeitung und Verwaltung von Dateien für die [WebBox](/dev/Software/WebBox/WebBox).  
798463 4
U 5 ## Funktionen
6
65ca7a 7 Die Dateiverwaltung besitzt die folgenden Funktionen
798463 8
65ca7a 9 - Persönliches und öffentliches Verzeichnis je Benutzer
680ec1 10 - Auflisten von Verzeichnissen und ihrer Inhalte
U 11 - Ansehen der Datei-Inhalte
12 - Erstellen und Bearbeiten von Texten und Dokumenten
65ca7a 13 - Dateien und Ordner kopieren, verschieben und löschen
680ec1 14 - Hochladen per Drag and Drop direkt in Ordner
U 15 - Listen- und Kachelansicht
798463 16
680ec1 17 Die Bedienoberfläche passt sich an verschiedene Geräteausstattungen an (responsiv). Weitere Informationen zur Dateiverwaltung finden sich auf der [Produktseite](/dev/Software/filecms/Dateiverwaltung).
798463 18
94179c 19 ### Konfiguration
U 20
21 Die Dateiverwaltung arbeitet mit relativen Pfadangaben und erhält den Ablageort von Dateien über die Angabe `de.uhilger.filecms.web.Initialiser.FILE_BASE` des Servlet-Kontext. Diese Angabe wird beim Start der Dateiverwaltung gebildet und kann im Deployment Descritor der Dateiverwaltung (Datei `WEB-INF/web.xml`) mit dem Context-Parameter `datenAblage` festgelegt werden. 
22
23 #### Automatische Ermittlung des Ablageortes
24
25 Ist die Angabe `datenAblage` im Deployment Descriptor der Dateiverwaltung leer, wird der Ablageort `../../../daten` ausgehend von `$CATALINA_BASE/webapps` verwendet. Wenn also z.B. das webapps-Verzeichnis in `/usr/local/tomcat/webapps` liegt, dann wird das Datenverzeichnis der Dateiablage in `/usr/daten` vermutet. Liegt es stattdessen in `/media/extmirror/srv/wbx/sys/base/webapps` dann lautet der Datenpfad `/media/extmirror/srv/wbx/daten`.
26
798463 27 ## Webanwendung herstellen
U 28
1ac489 29 Zum Herstellen der Webanwendung wird ein Java Development Kit (JDK) benötigt, wie es z.B. von [Azul](http://azul.com) oder dem [OpenJDK-Projekt](http://openjdk.java.net/) frei erhältlich ist. In der hier folgenden weiteren Beschreibung wird der lokale Ablageort des Java Development Kits `$JDK` genannt.
798463 30
U 31 Desweiteren werden die folgenden Klassenbibliotheken benötigt
32
33 ```
34 Bibliothek            Datei(en)                       Ablageort lokal
35 ----------            ---------                       ---------------
36 Commons Fileupload .. commons-fileupload-1.3.2.jar .. $JLIB
37 Commons IO .......... commons-io-2.5.jar ............ $JLIB
38 Tomcat .............. lib/servlet-api.jar ........... $CATALINA_HOME
39 XStream ............. xstream-1.4.7.jar ............. $JLIB
40 Jettison ............ jettison-1.3.3.jar ............ $JLIB
41 Transit ............. Transit.jar ................... $JLIB
42 ```
43 Diese sind an folgenden Orten frei erhältlich:
44
45 - [Apache Commons](http://commons.apache.org)
46 - [Apache Tomcat](http://tomcat.apache.org)
47 - [XStream](https://github.com/codehaus/xstream)
48 - [Jettison](https://github.com/codehaus/jettison)
2d4415 49 - [Transit](/gitblit/docs/Transit.git)
798463 50
1197b5 51 Nach Beschaffung des JDK und der oben angegebenen Klassenbibliotheken wird der Quellcode aus diesem Git-Repository an einen frei wählbaren lokalen Ablageort [heruntergeladen](http://uhilger.de/gitblit/zip/?r=file-cms.git&h=master&format=zip) und entpackt. In der hier folgenden weiteren Beschreibung wird das so entstandene Verzeichnis `file-cms-master` einschließlich des absoluten Pfades dorthin `$FILE-CMS` genannt. Ferner wird angenommen, dass die oben aufgeführten Klassenbibliotheken lokal an Orten abgelegt sind, deren Pfade mit den Platzhaltern `$JLIB` und `$CATALINA_HOME` gemeint sind. Anstelle der Platzhalter in den folgenden Kommandos muss also der absolute Pfad des lokalen Ablageortes eingesetzt werden.
798463 52
1ac489 53 Zur Herstellung der Dateiverwaltung werden die folgenden Kommandos ausgeführt (Beispiel für Linux):
798463 54
U 55 ```
56 cd $FILE-CMS
57 mkdir dist
58 mkdir build
59 cp -r web/* build
60 cd build/WEB-INF
61 mkdir classes
62 mkdir lib
63 cd ../..
64 cp $JLIB/* build/WEB-INF/lib
65
2b9663 66 $JDK/bin/javac -classpath $JLIB/commons-fileupload-1.3.2.jar:$JLIB/commons-io-2.5.jar:$JLIB/jettison-1.3.3.jar:$JLIB/Transit.jar:$JLIB/xstream-1.4.7.jar:$CATALINA_HOME/lib/servlet-api.jar -d ./build/WEB-INF/classes src/java/de/uhilger/filecms/api/*.java src/java/de/uhilger/filecms/web/*.java src/java/de/uhilger/filecms/pub/*.java
798463 67
30a32f 68 cp src/java/logging.properties build/WEB-INF/classes
798463 69 $JDK/bin/jar -cf dist/file-cms.war -C build .
U 70 rm -r build
71 ```
72
73 Das Webarchiv der Dateiverwaltung liegt anschließend als `$FILE-CMS/dist/file-cms.war` fertig zum Deployment bereit.
74
75 ### Distributionsalternative
76
77 Das Kommando `cp $JLIB/* build/WEB-INF/lib` kann auch weggelassen werden, dann sind die Klassenbibliotheken nicht Teil des Webarchivs der Dateiverwaltung. In diesem Fall muss stattdessen der Inhalt von `$JLIB` nach `$CATALINA_BASE/lib` kopiert werden.
78
79 ## Abhängigkeiten
80
81 Die Dateiverwaltung erfordert die folgenden Bestandteile auf der Instanz von Tomcat, auf der sie ausgeführt werden soll:
82
83 ```
84 $CATALINA_BASE/webapps/jslib/bootstrap ............ mindestens in Version 4.0 alpha 6
4d16ad 85 $CATALINA_BASE/webapps/jslib/jquery ............... mindestens in Version 3.2.1
798463 86 $CATALINA_BASE/webapps/jslib/mustache ............. mindestens in Version 2.3.0
U 87 $CATALINA_BASE/webapps/jslib/font-awesome ......... mindestens in Version 4.4.0
88 $CATALINA_BASE/webapps/jslib/codemirror ........... mindestens in Version 5.24.2
680ec1 89 $CATALINA_BASE/webapps/jslib/tinymce .............. mindestens in Version 4.3.4
a5c558 90 $CATALINA_BASE/webapps/jslib/fancybox ............. mindestens in Version 3
798463 91 ```
U 92
93 `$CATALINA_BASE` meint das in der der Datei [RUNNING.txt](http://tomcat.apache.org/tomcat-8.5-doc/RUNNING.txt) der Tomcat-Dokumentation so bezeichnete Verzeichnis. Nachfolgend die Quellen, von denen die obigen Abhängigkeiten bezogen werden können:
94
95 - [Bootstrap](http://getbootstrap.com)
96 - [jQuery](http://jquery.com)
97 - [Mustache](https://github.com/janl/mustache.js)
98 - [Font Awesome](http://fontawesome.io/)
85053f 99 - [Codemirror](https://codemirror.net)
680ec1 100 - [TinyMCE](https://tinymce.com)
a5c558 101 - [Fancybox](http://fancyapps.com/fancybox/3/)
85053f 102
U 103 ## Lizenz
104
db9792 105 Die Dateiverwaltung wird zu den Bedingungen der [GNU Affero General Public License](/gitblit/doc/file-cms.git/master/web!agpl.txt) bereitgestellt. Die von der Dateiverwaltung verwendeten Komponenten unterliegen zum Teil anderen Lizenzen. Deren Nutzungsbedingungen sind an den Quellen der Komponenten angegeben.