/* * This source is covered by the GNU GPL http://www.gnu.org * * Software distributed under the License is distributed on a * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the * License for a specific language governing rights and limitations under * the License. * * The Initial Developer of the Original Code is: * juergen schmidt http://www.strg.at * **************************************************************************** * Description: readme.txt -> general description for use and installation * german version * changelog: 16.08.2005 **************************************************************************** */ ** * security update 16.08.2005 ***** aufgrund eines fehlers im aufruf der php-xmlrpc klassen kann code in die applikation eingeschleust und ausgefuehrt werden. dieser fehler wird durch den aufruf der funktion eval() die es ermoeglicht code als string zu generieren und spaeter auszufuehren. die klasse wurde daher von den entwicklerInnen umgebaut um den eval() aufruf zu umgehen. ab der version 1.0.1 des vai-clients ist diese verbesserte version im einsatz. wir bitten daher die version 1.0 nicht mehr zu verwenden und alle eingesetzten clients auf die version 1.0.1 upzudaten. ACHTUNG: aufgrund dieser veraenderung ist vai() mit php3 nicht mehr kompatibel. links: http://www.heise.de/newsticker/meldung/62827 http://phpxmlrpc.sourceforge.net/#security ** * allgemeine beschreibung ***** vai ist eine mitfahrzentrale die von der suedtiroler hochschuelerInnen schaft asus.sh in auftrag gegeben und von strg.at umgesetzt wurde. vai ist als xmlrpc kommunikationsschnittstelle konstruiert und arbeitet mit zentralen daten die auf dem server von strg.at gespeichert werden. der client des systems ist einfach in verschiedene webseiten einzubinden. dadurch erreicht das system eine moeglichst grosse verbreitung der mitfahrdaten die angeboten werden. der client kann als standalone betrieben werden bzw. in ein bestehendes webprojekt eingebunden werden. das interface ist als template ausgefuehrt und von der eigentlichen datenschnittstelle bzw. der aufbereitung der xmldaten getrennt. die gesamte konfiguration des clients kann ueber ein zentrales file durchgefuehrt werden. anm: wenn nicht sehr viel wissen ueber php bzw. xmlrpc vorhanden ist sollte der code ausserhalb der templates lieber nicht angetastet werden. bei sinnvollen erweiterungen waere es im sinne der GPL sehr gut, diese an uns weiterzuleiten. damit wir sie auch anderen nutzern des clients zur verfuegung stellen koennen. ** * system voraussetzungen ***** der client vai kann als standalone betrieben werden oder in eine bestehende website eingefuegt werden. technisch benoetigt der client einen webserver der php unterstuetzt (apache, bzw. iis) sowie ein mailgateway auf tcpport 25. xmlrpc muss client-seitig nicht in php eincompiliert werden, da alle funktionen ueber die mitgelieferten classen abgebildet werden. ** * client seite ***** - download die aktuelle version kann von http://vai.asus.sh/vaiclient-1.0.tar.gz downgeloaded werden oder aus dem oeffentlichen cvs von strg.at geholt werden. (im cvs befindet sich immer der aktuelle code, die stable version befindet sich auf asus.sh) - installation - vai_client.tar.gz entpacken und an die stelle, an die es eingebunden werden soll kopieren. - die konfigurationsdatei config.client.php im folder /common/ anpassen: noetig sind zwei aenderungen: - pfad zu den dateien am eigenen server eintragen (PATH_ROOT) - eigenen domainnamen eintragen (CONF_SERVER_ROOT) optional koennen weitere einstellugnen getroffen werden: - absender fuer die emails (MAILFROM) - emailsubject (MAILSUBJECT) - pfad zum emailtemplate (MAIL_TEMPLATE) - anpassung es ist moeglich das design oder die texte von vai zu veraendern. alle fuer die praesentation noetigen dateien finden sich im folder /templates/. der einfachste weg, das aussehen von vai an die eigene webseite anzupassen ist die css datei vai_client.css zu aendern, da alle styleangaben dort getroffen werden. ** * templates ***** kurze beschreibung der einzelnen templatefiles: - mail_template.txt mailvorlage - strg_vai.tpl vai_display - vai_about.tpl kurzer text zur mitfahrzentrale bzw. hilfe - vai_checkpwd.tpl passworteingabe zum bearbeiten der eintraege - vai_client.css das cascading stylesheet zur gesamten mitfahrzentrale. ueber dieses file kannst du das design veraendern. infos zum arbeiten mit css findest du unter: http://w3.org/Style/CSS/ http://de.selfhtml.org/css/ - vai_edit_item.tpl vorlage fuer das eintragen und aendern von gesuchen und angebotene. - vai_footer.tpl fusszeile - vai_header.tpl kopf. doctype (xhtml) und metaangaben sowie headerbild und menucontainer. - vai_list_show.tpl tabellarische uebersicht der eintraege. - vai_menu.tpl das menu. - vai_result.tpl bildschirmausgabe nach eintrag in die mitfahrzentrale. - vai_search.tpl suchmaske - vai_search_list.tpl ergebnisse der suche. - vai_show_item.tpl detailansicht eines eintrags.