diff --git a/community-config.inc.php b/community-config.inc.php index 4cfbbd6..57daa61 100644 --- a/community-config.inc.php +++ b/community-config.inc.php @@ -3,9 +3,10 @@ * @author Caspar Armster * @copyright 2016 Caspar Armster, Freifunk Hennef/Freie Netzwerker e.V. (www.freifunk-hennef.de / www.freie-netzwerker.de) * @license Licensed under GPLv3 -* */ +/** Texte für die 2 Stufige Auswahl einer Meta-Community. +*/ $texte = array( "ebene1_titel" => "Freifunk Community", "ebene1_text" => "Freifunk Community auswählen", @@ -15,6 +16,27 @@ "ebene3_text" => "Zur Firmware-Download Seite" ); +/** Beispiel für eine einzelne Community. Das Array entkommentieren und ausfüllen, sowie das Array der Meta-Community löschen oder auskommentieren und der Downloader leitet dann automatisch direkt auf die Firmware Download Seite um. +* $community = array( +* 0 => array( +* "community_id" => 0, +* "name" => "Freifunk Hennef", +* "head_titel" => "Freifunk Hennef Firmware", +* "head_text" => "Auf dieser Seite können Sie die passende Firmware für ihren Router in Hennef auswählen und herunterladen!", +* "link_text" => "Zurück zur Startseite", +* "link_url" => "http://www.freifunk-hennef.de/", +* "logo_alt" => "Freifunk Hennef Logo", +* "logo_url" => "images/Freifunk-logo-hennef-klein-200.png", +* "lang_titel" => "Freifunk Hennef Firmware Auswahl", +* "lang_text" => "Bitte suchen Sie den passenden Router aus, indem Sie den Hersteller, das Modell und die Version auswählen.
Legen Sie anschließend fest, ob sie den Router zum ersten Mal mit einer Freifunk Firmware flashen und welches Entwicklungsstadium die Firmware haben soll.

Bitte wählen Sie -stable- im Entwicklungsstadium aus, wenn Sie nicht genau wissen was Sie sonst erwartet!", +* "download_path" => "", +* "sub_auswahl" => "" +* ) +* ); +*/ + +/** Beispiel für eine Meta-Community. +*/ $community = array( 0 => array( "community_id" => 0, diff --git a/config.inc.php b/config.inc.php index b17d985..da9e4f4 100644 --- a/config.inc.php +++ b/config.inc.php @@ -3,7 +3,6 @@ * @author Caspar Armster * @copyright 2016 Caspar Armster, Freifunk Hennef/Freie Netzwerker e.V. (www.freifunk-hennef.de / www.freie-netzwerker.de) * @license Licensed under GPLv3 -* */ $entwicklung = array( diff --git a/ffrouter.class.php b/ffrouter.class.php index f91c01a..059227b 100644 --- a/ffrouter.class.php +++ b/ffrouter.class.php @@ -3,7 +3,6 @@ * @author Caspar Armster * @copyright 2016 Caspar Armster, Freifunk Hennef/Freie Netzwerker e.V. (www.freifunk-hennef.de / www.freie-netzwerker.de) * @license Licensed under GPLv3 -* */ class ffrouter { diff --git a/ffrouter_parsen.function.php b/ffrouter_parsen.function.php index cdaf495..7246538 100644 --- a/ffrouter_parsen.function.php +++ b/ffrouter_parsen.function.php @@ -3,7 +3,6 @@ * @author Caspar Armster * @copyright 2016 Caspar Armster, Freifunk Hennef/Freie Netzwerker e.V. (www.freifunk-hennef.de / www.freie-netzwerker.de) * @license Licensed under GPLv3 -* */ if(!is_dir($firmware_download_path)) { throw new Exception("Firmwareverzeichnis existiert nicht!"); diff --git a/firmware.php b/firmware.php index 639731b..70c2a87 100644 --- a/firmware.php +++ b/firmware.php @@ -3,7 +3,6 @@ * @author Caspar Armster * @copyright 2016 Caspar Armster, Freifunk Hennef/Freie Netzwerker e.V. (www.freifunk-hennef.de / www.freie-netzwerker.de) * @license Licensed under GPLv3 -* */ error_reporting (E_ALL | E_STRICT); ini_set ('display_errors', 'On'); diff --git a/index.php b/index.php index db63a38..a44b4c8 100644 --- a/index.php +++ b/index.php @@ -3,13 +3,15 @@ * @author Caspar Armster * @copyright 2016 Caspar Armster, Freifunk Hennef/Freie Netzwerker e.V. (www.freifunk-hennef.de / www.freie-netzwerker.de) * @license Licensed under GPLv3 -* */ error_reporting (E_ALL | E_STRICT); ini_set ('display_errors', 'On'); require_once('community-config.inc.php'); require_once('config.inc.php'); - + if(count($community) == 1) { + header('Location: firmware.php?id=0'); + exit; + } echo << diff --git a/readme.md b/readme.md index 7c15f75..3b5ce4a 100644 --- a/readme.md +++ b/readme.md @@ -4,12 +4,14 @@ Freifunk Hennef Firmware Downloader Beschreibung ------------ -Der Freifunk Hennef Firmware Downloader soll es Laien ermöglichen schneller und sicherer die zu ihrem Router passende Firmware zu finden. Der Freifunker kann nacheinander aus automatisch generierten Listen seinen Router auswählen: Hersteller -> Modell -> Version und dann festlegen ob es eine Erstinstallation ist oder nicht, sowie am Ende wählen welches Entwicklungsstadium die Firmware haben soll. Dabei wird automatisch gewarnt (Download Button verändert die Farbe) falls nicht "stable" ausgewählt wird. Zusätzlich werden etliche der Router auch als Grafik (Front & Back Ansicht) gezeigt, so dass der Freifunker auf den ersten Blick erkennen kann wenn er den falschen Router ausgewählt hat. +Der Freifunk Hennef Firmware Downloader soll es Laien ermöglichen schneller und sicherer die zu ihrem Router passende Firmware zu finden. Der Freifunker kann nacheinander aus automatisch generierten Listen seinen Router auswählen: Hersteller -> Modell -> Version und dann festlegen ob es eine Erstinstallation ist oder nicht, sowie am Ende wählen welches Entwicklungsstadium die Firmware haben soll. Dabei wird automatisch gewarnt (Download Button verändert die Farbe) falls nicht "stable" ausgewählt wird. Zusätzlich werden etliche der Router auch als Grafik (Front & Back Ansicht) gezeigt, so dass der Freifunker auf den ersten Blick erkennen kann wenn er den falschen Router ausgewählt hat. Einmal anschauen kann man sich den Firmware Downlaoder unter http://images.freifunk-hennef.de/downloader/. + +Der Freifunk Hennef Firmware Downloader kann auch mit Metacommunities umgehen, bei der, vor der Auswahl der eigentlichen Firmware, noch eine Auswahl der Community/Subcommunity oder Technologie auszuwählen ist. Als Beispiel kann hier die Metacommunity Rhein-Sieg dienen, unter http://downloader.freifunk-rhein-sieg.de/downloader/ könnt ihr euch das anschauen. Technik ------- -Der Freifunk Hennef Firmware Downloader scannt das in der community-config.inc.php angegebene Verzeichnis auf Firmwares in den Unterverzeichnissen (beta/broken/experimental/stable) und dort in (stable/sysupgrade). Aus dem Ergebnis baut das PHP Script ein interaktives Javascript für die Auswahl und verwendet dabei Bootstrap für das Layout. +Der Freifunk Hennef Firmware Downloader erzeugt auf Grund der angegebenen Metadaten in der community-config.inc.php eine Auswahlseite für die Metacommunity (oder bei nur einer vorhandenen Community Konfiguration überspringt er diese Vorauswahl). Nach der Auswahl der Community (plus optionaler Subauswahl) erscheint der Link der zum eigentlichen Firmware Downloader führt. Der Freifunk Hennef Firmware Downloader scannt dann das in der community-config.inc.php angegebene Verzeichnis auf Firmwares in den Unterverzeichnissen (beta/broken/experimental/stable) und dort in (stable/sysupgrade). Aus dem Ergebnis baut das PHP Script ein interaktives Javascript für die Auswahl und verwendet dabei Bootstrap für das Layout. Bisher werden Router der folgenden Hersteller automatisch erkannt: @@ -43,8 +45,22 @@ Installation Den Freifunk Hennef Firmware Downloader in ein eigenes Unterverzeichnis des Webservers kopieren/entpacken, auf dem auch die Firmwares liegen. In der community-config.inc.php werden dann diverse Variablen gesetzt: -- $text_h1/$text_h2/$link_h2_text/$link_h2_url/$logo_url/$logo_alt Texte & Logo im Header der Seite -- $firmware_download_path = Pfad zum Hauptverzeichnis der Firmware +- $texte ist das Array mit den einzelnen Überschriften/Texten für die Auswahlstufen +- $community ist das Array mit den Metadaten für die Metacommunity und die einzelnen Subcommunites. Wenn hier nur eine Community angegeben wird wird die Communtiyauswahl übersprungen und direkt auf die Firmware Downloader Seite verwiesen. +0 => array( // ID die bei 0 Anfängt und hochgezählt wird + "community_id" => 0, // ID der Community, wiederholt sich bei den zusammengehörigen Subcommunities + "name" => "Name der Community", + "head_titel" => "Header Titel", + "head_text" => "Header Text", + "link_text" => "Header Link Text", + "link_url" => "Header Link URL", + "logo_alt" => "Logo Alt Text", + "logo_url" => "Logo URL", + "lang_titel" => "Langtext Titel", + "lang_text" => "Langtext Text", + "download_path" => "Pfad zur Firmware", // Bleibt bei der Metacommunity leer + "sub_auswahl" => "Name der Subcommunity" // Wird nur verwendet wenn die Community Subcommunites/Technologien als Auswahl hat +), In der config.inc.php sind die Angaben über die Hersteller, Entwicklungsstufen & Art der Firmware Installation. Hier muss man normalerweise nichts anpassen, außer man verwendet Firmwares für Router von Herstellern, die noch nicht integriert sind, dann bitte ich allerdings auch um Kontaktaufnahme (caspar@freifunk-hennef.de, bzw. im github). - $entwicklung = Entwicklungsstufen der Firmware (beta/broken/experimental/stable) - (sollte man in Ruhe lassen normalerweise) @@ -56,7 +72,7 @@ In der config.inc.php sind die Angaben über die Hersteller, Entwicklungsstufen - -> offset_version = Offset für das Parsen der Version im Dateinamen der Firmware - $offset_sysupgrade = Offset für "-sysupgrade" im Dateinamen der Firmware -Die Firmware liegt in folgenden Verzeichnissen: +Die Firmware liegt in folgenden Unterverzeichnissen: * firmware/ * beta/ * factory/