phpBB.de - Die deutsche phpBB-Community
Stand: 30.12.2008 04:56
aktuelle Version auf phpBB.de
 
Apache At Work Communities Community Building Informationen und Hinweise Installation/Konfiguration/Update MySQL PHP phpBB-Optimierungen phpBB3 Rechtliches Server & Technik Snippets Templates und Mods
 



Knowledge Base Offline -> Informationen und Hinweise -> Mod DB - Validierung

Mod DB - Validierung
Autor: Mungo
Stand: 30.12.2008 04:56
Neuste Version unter: http://www.phpbb.de/doku/kb/moddb_validierung

Mod DB - Validierung

Was bedeutet "validiert" bei einer Modifikation in unserer Datenbank? Kriterien für eine erfolgreiche Validierung.
  1. Allgemeines
  2. Bedeutung für Mod Nutzer
  3. Vorgehensweise für Mod Autoren
  4. Kriterien
    1. Aufnahme
    2. Bewertung
    3. Validierung

Allgemeines

Um eine möglichst große Zahl an Mods in unsere Mod-Datenbank aufzunehmen, aber trotzdem Wert auf Qualität zu legen, haben wir uns für das Prinzip der Validierung entschlossen. Dabei wird erstmal jeder Mod in die Datenbank aufgenommen, solange er einfachen Anforderungen entspricht. Der Mod Autor hat dann im Rahmen der Validierung die Möglichkeit, seinen Mod vom phpBB.de Team intensiv prüfen zu lassen, ob dieser den erweiterten Qualitätsansprüchen genügt.

Bedeutung für Mod Nutzer

Validierte Mods

Validierte Mods wurden vom phpBB.de Team eingehend geprüft. Dabei wurde unter anderem darauf geachtet, daß die Mods sauber programmiert sind und z.B. mit anderen Datenbanken als MySQL oder mit anderen Templates als subSilver funktionieren. Ausserdem wurde der Mod auf offensichtliche Sicherheitslücken untersucht. Dies ist zwar keine Garantie, daß der Mod in jedem Falle funktioniert und keine Fehler hat (nobody is perfect) - allerdings ist die Warscheinlichkeit höher, daß sich der Mod - auch in Verbindung mit anderen Mods - in Betrieb nehmen lässt.

Nicht validierte Mods

Nicht validierte Mods wurden vom Team (noch) nicht geprüft und müssen daher nicht zwingend den genannten Kriterien entsprechen. Daß ein Mod nicht validiert wurde, muss jedoch nicht zwingend heißen, daß er schlecht ist - man sollte dann die Team- / Nutzerbewertung ansehen und allgemein vorsichtiger sein.

Nicht empfehlenswerte Mods

Mods, bei denen (während der Validierung oder direkt bei der Aufnahme) festgestellt wird, daß sie zwar funktionieren, aber nur von minderer Qualität sind (z.B. nichtnutzung von DBAL oder Template-System), werden als "nicht empfehlenswert" gekennzeichnet. Wenn man solche Mods einbaut, kann es zu Problemen in Verbindung mit anderen Mods, Templates oder Datenbanken kommen. Vor dem Einbau sollte auf jeden Fall ein Backup gemacht werden.

Vorgehensweise für Mod Autoren

Mod Autoren klicken einfach in der Anzeige des Mods, den sie validieren lassen möchten unten rechts auf den Button "validieren", geben evtl. noch Hinweise an (z.B. Begründung, warum der Mod nicht das Template-System nutzt) und schicken das Formular ab. Da wir eine möglichst hohe Qualität sicherstellen möchten und vermutlich bereits andere Mods auf ihre Validierung warten, kann es jedoch längere Zeit dauern, bis der Mod als validiert gekennzeichnet wird.

Kriterien

Dies ist eine grobe Übersicht über die Kriterien, die wir bei den verschiedenen Prüfprozessen anwenden. Je nach Art/Umfang einzelner Mods kann die Gewichtung einzelner Punkte unterschiedlich sein oder zusätzliche Punkte für/gegen einen Mod sprechen.

Aufnahme

  • Verständliche und fehlerfreie Installationsanleitung
  • Der Mod und die Installationsanleitung müssen in deutscher Sprache sein (bzw. bei mehrsprachigen Mods muss eine der Sprachen Deutsch sein)
  • Download muss zumindest zusätzlich im zip-Format verfügbar sein - nicht jeder hat ein Programm installiert, das rar entpacken kann.
  • Wie können wir den Autor erreichen (d.h. E-Mail Adresse vom Autor muss vorhanden sein)
  • Mod sollte für die aktuellste phpBB Version geschrieben sein
  • Wenn ein Mod extrem unsauber programmiert ist, kann dies auch dazu führen, daß er nicht aufgenommen wird.

Bewertung

  • Stellt dieser Mod eine sinnvolle Erweiterung für ein Forum dar, die viele Administratoren gebrauchen können?
  • Sind alle Funktionen gut erklärt und verständlich?
  • Ordentlicher Programmierstil des Autoren
  • Macht dieser Mod das Forum erheblich langsamer?

Validierung

  • Gute Installationsanleitung (durch den Mod-Validator laufen lassen => http://www.phpbb.com/mods/validator/)
  • Nutzung des DBAL (Datenbank Klasse von phpBB)
  • Nutzung des Template-Systems
  • Sauberer Programmierstil (Einrückung, Variablennamen, Formatierung, Verständlichkeit). Vorbild sind die [http://www.phpbb.com/phpBB/docs/codingstandards.htm Coding Guidelines], es ist aber nicht zwingend erforderlich, diese bis auf einzelne Leerzeichen genau einzuhalten. Wichtig ist, daß der Programmierstil insgesamt sauber und durchgängig ist.
  • Keine offensichtlichen Sicherheitslücken (z.B. SQL Injection, XSS)



Knowledge Base Offline -> Informationen und Hinweise -> Mod DB - Validierung