How To: Erstellen von Applikation für den Application Vault

Transkript

1 How To: Erstellen von Applikation für den Application Vault Mit der Application Vault Funktion können Web-Applikationen, wie z.b. Zugriffszähler, Gästebücher, Foren, Foto Galerien oder ähnliches, installiert und konguriert werden. Der Plesk Administrator kann Applikationen in Form von Application Packages auf dem Server aktivieren und ermöglicht damit den Nutzern die verfügbaren Applikationen auf Ihren Domains (und Subdomains) einzusetzen und zu kongurieren. Eine Applikation muss eine Reihe von Voraussetzungen erfüllen damit sie in Plesk nutzbar ist. So ist z.b. die Verzeichnisstruktur oder die Reihenfolge der übergebenen Parameter zwischen speziellen Formularen vorgeschrieben. Dieses Dokument beschreibt die unterschiedlichen Aspekte die bei der Erstellung von Applikationen zu beachten sind. 1. Verzeichnisstruktur Die Applikation sollte die folgenden Unterverzeichnisse beinhalten: scripts/ - Hier werden die Installations-, Kongurations- und Deinstallationsskripte gespeichert. forms/ - Hier wird die Hauptkonguration und die Installationsformulare für die Konguration der Applikation innerhalb des Virtual-Hosts gespeichert. apps/ - Tarballs die in den jeweiligen Virtual-Host entpackt werden. uninstall/ - Unterverzeichnis für das Script das die Applikation vom Reposetory löscht (gilt nicht bei rpm-paketen). docs/ - Verzeichnis für die Online-Dokumentation für den Endnutzer. info/ - Hier bendet sich eine beschreibende XML-Datei für die jeweilige Applikation. Die Datei info.xml beinhaltet die System Anforderungen und den genutzten Festplattenplatz. Die wichtigsten Variablen werden ebenfalls hier beschrieben. Ein Beispiel für die Datei bzw. Verzeichnisstruktur: /supercounter /scripts preinstall postinstall preuninstall postuninstall preupgrade postupgrade /forms installer-form-1.php installer-handler-1.php installer-form-2.php

2 installer-handler-2.php installer-form-3.php installer-handler-3.php /apps cgi-bin-les.tar httpdocs-les.tar /uninstall uninstall /docs index.de.html index.en.html /info info.xml 2. Inhalt der Applikations Verzeichnisse 2.1 Das scripts/ Verzeichnis Dieses Verzeichnis beinhaltet die folgenden Skripte: postinstall wird nach dem Entpacken des Tarballs ausgeführt. Dieses Skript dient dazu Änderungen an der Konguration vorzunehmen, die nötig sind, um die Applikation voll funktionsfähig zu machen, nachdem sie in das Verzeichnis eines Virtual-Hosts installiert wurde. Das Skript kann Kongurationsdateien oder auch weitere Skripte erzeugen. Es sollte auch die notwendigen Modikationen an den Datei- und Verzeichnisattributen vornehmen und ggf. Verzeichnisse umbenennen. Die.htaccess Datei sollte ebenfalls mit diesem Skript erzeugt werden. Wenn das Skript einen anderen Wert als Null zurück liefert, so wird eine Warnung angezeigt aber die Applikation dennoch installiert. Im Problemfall sollte das Skript die Warnung auf Stdout ausgeben und eine 1; zurück liefern. recongure wird ausgeführt nachdem der User neue Parameter deniert hat. Es führt die notwendigen Änderungen an der Skript Konguration aus. Parameter werden an Stdin als Strings übergeben. Sie entsprechen folgendem Format: < Parameter Name >=< Parameter Wert > Es wird dringend empfohlen von eventuell vorhandenen original Kongurationen durch das postinstall Skript Sicherheitskopien erstellen zu lassen. #!/bin/sh # gallery postinstall script # erforderliche Parameter: app_path # *Erforderliche Variablen bitte hier einfügen # einige Standard Parameter müssen angegeben werden: # vhost_path Kompletter Pfad zum vhost root Verzeichnis # domain_name Name der Domain # install_prex Applikations Pfad innerhalb des vhost Verzeichnisses # ssl_target_directory - true, wenn die Applikation in httpsdocs existiert read_parameters() var=`cat awk '

3 eqpos=index($0, "="); if (eqpos>1) var=substr($0, 1, eqpos-1); val=substr($0, eqpos+1); tmp="[cc]"; tmp2="cccc"; gsub(tmp,tmp2,val); '` ; tmp2="ccc"; gsub("",tmp2,val); print var "=" val ""; eval $var check_standard_parameters() if [ "X$vhost_path" = "X" ]; then echo "postinstall: no vhost_path parameter specied for application" if [ "X$domain_name" = "X" ]; then echo "postinstall: no domain_name parameter specied for application" if [ "X$install_prex" = "X" ]; then echo "postinstall: no install_prex parameter specied for application" if [ "X$ssl_target_directory" = "X" ]; then echo "postinstall: no ssl_target_directory parameter specied for application" ; parse_standard_parameters() ; if [ "X$ssl_target_directory" = "Xtrue" ]; then proto="https" documents_directory="httpsdocs" else # don't forget to x it proto="http" documents_directory="httpdocs" create_dirs() if [! -d "$app_path/tmp" ] ; then mkdir "$app_path/tmp" backup_original_cong() if [ -f "$app_cong" ] ; then if [! -f "$app_cong.orig" ] ; then

4 cp $app_cong $gallery_cong.orig 2.2 Das forms/ Verzeichnis In diesem Verzeichnis benden sich Formulare im PHP oder HTML Format, mit deren Hilfe die Kongurationsparameter des Skripts entgegengenommen werden. installer-handler-<schritt Nummer>.php Eingabeformular für, während der Installation einer Applikation, erforderliche Daten. installer-form-<schritt Nummer>.php Eingabeformular für Kongurationswerte einer Applikation. recongure-handler-<schritt Nummer>.php Recongure-Handler; wird während eines Upgrades ausgeführt. recongure-form-<schritt Nummer>.php Recongure-Formular. Sollten beide Installer Dateien fehlen, so bedeutet dies, dass nur der http/https Teil des Virual-Hosts und das Unterverzeichnis der Applikation im Zuge der Installation angefordert werden. Wenn die erste Recongure-Datei fehlt, so bedeutet dies, dass es keine Möglichkeit gibt das Paket zu aktualisieren. HINWEIS Das Aktualisieren bzw. "Upgraden" von Applikationen wird in der aktuellen Version von Plesk nicht unterstützt. 2.3Das apps/ Verzeichnis httpdocs-les.tar cgi-bin-les.tar Beide Dateien sind optional. Sollte keine von beiden existieren, so muss die Applikation mit dem Postinstall-Skript installiert werden. 2.4Das uninstall/ Verzeichnis Nur für nicht RPM-Pakete.! Das Verzeichnis beinhaltet das Uninstall-Skript, dieses sollte dem Preun- Skript in RPM-Paketen entsprechen. 2.5Das docs/ Verzeichnis Dieses Verzeichnis beinhaltet die Dokumentation der Web-Applikation.

5 2.6Das info/ Verzeichnis Dieses Verzeichnis beinhaltet die Datei info.xml. Sie beschreibt die wesentlichen Eigenschaften der Applikation wie den benötigten Festplattenplatz, die Version, die Größe, für die Ausführung innerhalb eines Virtual-Hosts notwendige, benutzte Variablen. Die Struktur der Datei info.xml: <WEBAPP name="name der Applikation" version="1.1" release="1"> <VERSIONHISTORY> <VER value="1.1-1"/> </VERSIONHISTORY> <ATTRIBUTES> <DESCRIPTION>Beschreibung der Applikation</DESCRIPTION> <LICENSE accept_required="no"> GPL </LICENSE> #Art der Lizenz, GPL, Freeware, usw. <ATTRIBUTE name="disc_space" value="111222" /> # Benötigter Festplattenplatz in Bytes </ATTRIBUTES> #Anforderungen an den Virtual-Host um das Paket auszuführen. <REQUIREMENTS> <APACHE_VHOST name="php" value="on" /> <APACHE_VHOST name="ssi" value="on" /> </REQUIREMENTS> </WEBAPP> 3.Funktionen In Formularen und Handler-Skripts genutzte Funktionen: sapp_create_database($db_name, $db_type, $user_name, $user_passwd); - Überprüftdie Datenbank. Dabei werden Limits und die Existenz von Datenbanknamen überprüft, sowie Datenbanken angelegt. Die Funktion gibt im Erfolgsfall true zurück. $db_type kann Mysql, Postgresql oder Mssql sein; sapp_set_install_prex($prex); - Überprüft ob ein Verzeichnisname schon existiert oder durch eine andere Applikation genutzt wird. Wenn das Verzeichnis bereits existiert, gibt die Funktion false zurück. voidsapp_set_param($name, $value); - Fügt den Parameter und seinen Namen zu der Datenbank hinzu; string sapp_get_param($name); - Zugriff auf web_params(); Funktion; void sapp_set_errormsg($msg); - Übergibt die Fehlermeldung an ein Formular oder Handler-Skript; bool sapp_is_ssl_enabled(); - Überprüft ob SSL aktiviert ist; sapp_get_locale(); - Gibt die aktive Lokalisierung zurück, z.b. en, jp, de sapp_get_domain_name(); - Gibt den Namen der Domain zurück; check_sys_login($login); - Überprüft ob der Login-Namen gültig ist; check_sys_passwd($login, $passwd);-validiert das Passwort und den Login-Namen, auch für den Fall, dass das Passwort den Login-Namen beinhaltet; check_pg_login($login); - Überprüft ob der Postgresql Login-Name gültig ist; check_pg_passwd($login, $passwd); - Überprüft ob das Postgresql Passwort gültig ist; check_mailname($mail_name); - Überprüft ob der Mailname gültig ist;

6 check_mail_passwd($login, $passwd); - Überprüft ob das Mailname Passwort gültig ist; check_domain($dom_name); - Überprüft ob der Name der Domain gültig ist; check_url($url); - Überprüft ob die URL gültig ist; check_shorturl($url); - Überprüft ob die URL dem Muster (z.b. nur Protokoll und Hostname ohne Slash am Ende) entspricht; check_dbname($db); - Überprüft ob der Datenbankname gültig ist; check_dbusername($usr); - Überprüft ob der Datenbank User-Name gültig ist; check_phone($phone); - Überprüft ob die Telefon Nummer gültig ist; check_ ($ ); - Überprüft ob die Adresse gültig ist; check_ip($ip); - Überprüft ob die IP Adresse gültig ist; check_mask($mask); - Überprüft ob die Netzmaske (Network Mask) gültig ist; check_lename($lename); - Überprüft ob der Dateiname gültig ist; check_int($num); - Überprüft ob ein Argument ein Integer Zahl ist. 4.Erstellen von Applikationen Um eine Applikation zu erstellen, die mit dem Plesk Control Panel hoch geladen werden kann, sollten Sie ein RPM-Paket erstellen. Zunächst sollten Sie die notwendigen Variablen der Konguration ermitteln. Diese sollten in der Datei info.xml zusammen mit der Build-Number, Versionsnummer und dem benötigten Festplattenplatz angegeben sein. HINWEIS Es wird dringend empfohlen die Patch-Syntax für notwendige Änderungen an Applikationen anzuwenden. Dazu gehören z.b. Die Anpassung der Pfade oder ähnliches. 4.1Die spec Dateien Die spec Datei sollte die folgenden Daten enthalten: Patch-Info, die korrekte Build-Number, die Versionsnummer und den Namen des Programms. Die Patches müssen ebenfalls hier aufgelistet werden. Die Verzeichnisstruktur wird im folgenden beschrieben. Die folgenden Variablen werden in der spec Datei benötigt: Summary: # Eine kurze Beschreibung Name: %name Version: #Versionsnummer Release: #Release-Nummer Copyright: # Art der Lizenz, z.b. GPL oder Freeware Vendor: %vendor Group: Applications/WWW Packager: SWsoft Inc <info@plesk.com> # Geben Sie hier den Namen Ihres Unternehmens ein BuildRoot: %prodbui,ldroot/../cgitory Prex: %product_root_d/var/cgitory Requires: php # z.b. php oder ähnliches

7 Provides: Plesk-application-vault Wenn kein Kommentar für eine Variable angegeben ist, sollte der Wert genau wie geschrieben deniert werden. Die Applikation sollte die folgenden Attribute haben. Sie muss root gehören. %attr(-, root,root)%product_root_d/var/cgitory/%namesrc-%version-%release 4.2Scripts Sie sollten die notwendigen Formulare und Handler unter Zuhilfenahme der Funktionen aus Kapitel 3 erstellen. Dadurch komplettieren Sie die Liste der Kongurations Variablen der jeweiligen Applikation. 4.3Erstellen des RPM-Pakets Stellen Sie sicher, dass sich alle notwendigen Dateien und Unterverzeichnisse an den richtigen Stellen benden. Erstellen sie die Tarballs für httpdocs und cgi-bin. Erstellen Sie ein Makele das alle nötigen Patches beinhaltet. Kopieren Sie diese Datei nach /usr/src/redhat/specs HINWEIS Sie müssen als root eingeloggt sein um RPM Pakete erstellen zu können. Führen Sie das folgende Kommando aus: # rpmbuild --bb /usr/src/redhat/specs/name_der_applikation.spec NAME_DER_APPLIKATION.spec sollte durch den Namen der spec Datei der gewünschten Applikation ersetzt werden (wie in Kapitel 4.1 beschrieben). Sobald das RPM-Paket erstellt wurde wird dieses unter /usr/src/redhat/rpms/noarch abgelegt. 5.Uploader Applikation Loggen Sie sich im Plesk Control Panel als admin ein. Wählen Sie unter Server -> Application Vault, klicken Sie auf [Durchsuchen], wählen das RPM-Paket der Applikation und klicken Sie auf [Datei senden].