Extension Key: vcd_archive
Copyright 2000-2002, Elmar Hinz, <elmar.hinz@vcd-berlin.de>
This document is published under the Open Content License
available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3
- a GNU/GPL CMS/Framework available from www.typo3.com
Übersicht
Mit diesem Plugin lassen sich offene und geschlossene Downloadarchive realisieren. Im Vordergrund stehen hierbei die intuitive Archivepflege über das Frontend und die Sicherheit der Files innerhalb von geschlossenen Archiven.
Eine einfache Importfunktion hilft, Dateien aus einem bestehenden Verzeichnisbaum rekursiv zu importieren.
Grenzen
Dateien werden beim Import mit Versionsnummern umbenannt. Beziehungen zwischen Dateien wie zwischen HTML und Bildern gehen daher verloren.
Es gibt nur eine gemeinsame Editorengruppe. Files werden also nicht personalisiert.
Features
Einfache Installation und Konfigurierbarkeit
Die Extension funktioniert im Grundsatz „out of the box“.
Eine funktionierende Loginseite wird allerdings vorausgesetzt, damit sich die Editoren einloggen können.
Es wird eine follständige Dokumentation in Deutsch und Englisch geben.
Die Konfiguration folgt dem vertrauten Schema aller VCD Extensions.
Einfache Archivepflege über das Frontend
Upload, Editieren und Löschen von Dateien und zugehörigen Metadaten.
Metadaten: Titel, Beschreibung, Datum.
Zusätzliche Records für Titel und Texte zur Strukturierung und Dokumentation des Archives.
Ändern der Reihenfolge von Files, Titeln und Texten innerhalb einer Ansicht.
Intuitive Bedienung durch aussagekräftige Graphiken.
Komfortable Ausgabe
Die Ausgabe erfolgt mit Überschriften, Zwischentexten und Metadaten.
Für Downloadlinks werden dabei automatisch Symbole für ihren Mimetype eingesetzt.
Große Sicherheit
Vor der Ausgabe von Files wird die Zugriffsberechtigung geprüft.
Dazu wird von den normalen Typo3 Frontend Authentifizierungsmechenismen Gebrauch gemacht, so daß das Schutzlevel genau denen der geschlossenen Frontendbereiche entspricht.
Das Verzeichnis, in dem die Files gespeichert werden, kann wahlweise durch die Webserver Schutzmechanismen geschützt werden (.htaccess) oder ganz außerhalb des Webservers angelegt werden.
Im zweiten Fall ist derzeit eine Administrattion über das Backened nicht möglich, was angesichts der komfortablen Frontendadministration kein echtes Problem darstellt.
Volle Internationalisierungsmöglichkeiten
Alle Texte.
Eingabeformat der Zeitangaben.
Ausgabeformat der Zeitangaben.
Flexibilität des Designs
Volle Trennung von Funktion, Sprache und Design
Volle Trennung von HTML Template und CSS, so daß im Regelfall nur das CSS angepaßt werden muß, um das eigene Corporate Design zu treffen.
Es können eigene Iconverzeichnisse für die Mimetypen und Aktionssymbole in der Konfiguration angegeben werden, um die Icons auszutauschen oder die Mimeteypen zu erweitern.
Für wen ist die Erweiterung interessant?
Der typische Einsatzbereich ist ein Filearchiv für einen geschlossenen Nutzerkreis, wie eine Firma oder einen Verein. Die praktischen Features des Plugins machen es aber auch interessant, um offene Downlaodarchive zu gestalten.
Andere Extensions im Vergleich
VCD Archiv ist kein einfacher Link für den sicheren Filedownload wie nf_downloads, sondern ein umfassenderes Archivsystem.
Andererseits ist es kein file exchange repository mit Communityfeatures und verschiedenen Zugriffsgruppen und dem Look-and-Feel eines Filebrowsers wie moc_filemanager , sondern eher ein One-To-Many System.
Welche Probleme werden gelöst?
Typo3 kennt geschlossene Loginbereiche. Hat man bisher in diesen Bereichen Files zum Download zur Verfügung gestellt, so waren zwar die Linkseiten geschützt, aber nicht die verlinkten Files selbst. Jeder der eine URL erraten konnte, oder dem diese weitergegeben wurde, hatte vollen Zugriff auf das File. Hier setzt das VCD Archiv an, indem es auch die Zugriffsberechtigung auf das File prüft.
Technische Übersicht
Konfigurationsschema
Ich strebe an, die VCD Erweiterungen nach einem einheitlichen Schema zu gestalten. Sobald die Erweiterungen als stable gelten, sollte auch die Einheitlichkeit der Bibliotheken, Bennenungen und Konfigurationen erreicht sein.
Programmierstil
Ich denke, daß ich inzwischen zeimlich sauber und organisiert programmieren kann, so daß der Code für andere leicht zu verstehen, zu erweitern und zu debuggen sein sollte.
Besonders bei dem Einfügen von Links und Bildern achte ich darauf, die Standardfunktionen von Typo3 zu nutzen, so daß das Plugin auch bei Mehrsprachigkeit und innerhalb von Framesets funktionieren sollte.
Bennenungen
Alle Benennungen von Variablen, Platzhaltern, Klassen und Funktionen folgen einheitlich dem Javamuster („vomSpeziellenZumAllgemeinen“, „fileInputFormTitle“).
Die Wortbestandteile werden also nicht durch Unterstriche getrennt, sondern durch Großbuchstaben zu Beginn jedes Bestandteils markiert. Das vereinfacht das Schreiben.
Das erste Wort beginnt klein.
Die Reihenfolge vom Speziallen zum Allgemeinen entspricht dem natürlichen Sprachgebrauch im Deutschen und Englischen.
Bei der Bennenung von Templateplatzhaltern weicht dieses Schema vom klassischen Typo3 Stil ab. „###fileInputFormTitle###“ statt „###FILE_INPUT_FORM_TITLE###“.
Der Verkehrsclub Deutschland ist der Umweltverband, der z.B. die Einführung der Bahncard 50 erreicht hat und die jährliche Auto-Umweltliste erstellt.
Die VCD Extensions sind Typo3 Erweiterungen, die ich ehrenamtlich für die Verwendung auf der Vereinshompage des Landesverbandes Berlin (www.vcd-berlin.de) entwickele und dem VCD widme. Weil wir Typo3 für unsere Homepage verwenden, möchte ich der Typo3 Community hiermit etwas Nützliches zurückgeben, das an den harten Anforderungen eines Vereins entwickelt und gestest wird. Sie stehen wie aller Code der aus Typo3 hervorgeht unter der GPL.
Wenn Du die Extensions im Rahmen deines Projektes nutzbringend einsetzt, möchte ich Dich bitten, Dich in irgendeiner Form dafür erkenntlich zu zeigen, z.B. durch eine Spende an den VCD Berlin, ein Bannerlink oder durch eine andere Verlinkung unserer Webseite. Die Krönung wäre natürlich Deine eigene VCD Mitgliedschaft, womit du ein deutliches Signal für eine Verkehrswende und gegen den Treibhauseffekt setzen würdest. (www.vcd.org)
Administration im Frontend
Files und Überschriften können angelegt, bearbeitet, verschoben und gelöscht werden.
Das Uploadformular
Die Ausgabe der Filedownload Liste
Der Button „Bearbeiten beginnen“ wird nur dann angezeigt, wenn der Besucher in der Editorgruppe eingeloggt ist.
Die Technik des sicheren Filedownloads für Typo3 wurde inspiriert durch die Typo3-Extension nf_downlaods (GPL) von Mathias Schreiber.
Die Extension enthält Icons aus Crystal GT, Version 0.9 (GPL) von Everaldo Coelho. Aus Gründen der Kapazitätsbegrenzung des Archives von typo3 kann ich nicht den vollen Iconsatz mitliefern. Du findest ihn hier: http://www.everaldo.com/crystal.html
