Version vom 13. November 2011, 14:51 Uhr

Hinweis

Achtung: Artikel wird grad überarbeitet, bitte nichts dran ändern solange dieser Hinweis noch besteht. Dringende Hinweise über IRC an mich. (BugBuster)

Live Update nutzt diese, die Extensions nutzen diese auch: eine Datei runonce.php

Diese Datei tut genau das, was der Name schon vermuten lässt. Sie wird nur einmal ausgeführt und anschließend gelöscht.

Von der Contao 2.9 zu 2.10 gab es eine Änderung diesbezüglich was Ort und Zeitpunkt des Aufrufes betrifft. Es ist möglich, für beide Arten gleichzeitg kompatibel zu sein und wird deshalb hier auch mit beschrieben.

Verwendung ab Contao 2.10

Ab Contao 2.10 ist die runonce Nutzung modulbasiert. Das heißt, jedes Modul bringt seine eigene runonce.php in der Verzeichnistruktur des Moduls mit. Nicht mehr wie in 2.9 im System Verzeichis.

Ablageort

Die runonce.php muss im config Verzeichnis des Moduls liegen. Beispiel:

/system/modules/banner/config/runonce.php

Der Ablageort /system/runonce.php funktioniert zwar auch noch, sollte aber nicht mehr verwendet werden, da es zu gegenseitigem Überschreiben kommen kann. (siehe dazu Problemfall in 2.9)

Aufruf von Contao

Contao ruft die runonce.php Dateien aller aktiven Module auf (sofern vorhanden) direkt vor einem Datenbank Update bzw. dem Test ob dieser notwendig ist. Das passiert somit bei zwei Ereignissen:

• Installation oder Update oder Deinstalltion einer Erweiterung über den Erweiterungskatalog bzw. Erweiterungsverwaltung.
• Liveupdate von Contao

Installiert man eine Erweiterung manuell oder macht ein manuelles Update von Contao, muss wie üblich die install.php aufgerufen werden, bzw. im Backend über Erweiterungsverwaltung - Datenbank aktualisieren, um den Vorgang auszulösen.

Code Beispiele

Beispiele sind auf einer extra Seite zu finden: Runonce Code Beispiele

Verwendung in Contao 2.9 und älter

Ablageort

Aufruf von Contao

Problemfall

+ Lösung Code Bespiel Link Spezialfall nächster Abschnitt

Spezialfall: runonce.php für 2.9 und 2.10

Code Beispiele

Beispiele sind auf einer extra Seite zu finden: Runonce Code Beispiele

Backup

wird em Ende gelöscht

Anwendungsbeispiele

Löschen einer Datei

<?php @error_reporting(0); @ini_set("display_errors", 0); 
try { 
    // Datei relativ zu TL_ROOT
    $file = 'system/modules/demo/delete_me.gif'; 
    $objFiles = Files::getInstance();
    $objFiles->delete($file);
} catch (Exception $e) { $errors[] = $e->getMessage(); }
?>

Die Fehlerausgaben, sollte es welche geben, werden in diesem Beispiel unterdrückt.

Datenbank Insert / Update

<?php @error_reporting(0); @ini_set("display_errors", 0); 
$objDatabase = Database::getInstance();
//
// Update database
try { 
    $objDatabase->execute("UPDATE `tl_demo_table` SET `demo_counter`=0 WHERE demo_browser`='Unknown'");
} catch (Exception $e) { $errors[] = $e->getMessage(); }
//
// Insert database
try { 
    $objDatabase->execute("INSERT INTO `tl_demo_table` (`id`, `demo_counter`) VALUES (0, '10')"); 
} catch (Exception $e) { $errors[] = $e->getMessage(); }
?>

Datenbank Insert, OOP Variante

Quelle: Forum.

<?php
class RunonceJob extends Frontend
{
   public function __construct()
   {
       parent::__construct();
   }
   public function run()
   {
       $arrInsert=array(
           'action'    => 'runonce',
           'text'      => 'runonce'
       );
       $this->Database->prepare("INSERT INTO tl_log %s")->set($arrInsert)->execute();
   }
}
$objRunonceJob = new RunonceJob();
$objRunonceJob->run();
?>

Hinweis

Achtung: Vorsicht damit bei Extensions mit Abhängigkeiten zu weiteren Extensions. Bringen 2 Extensions jeweils eine runonce.php mit, wird nur eine ausgeführt!

Hier ist der Author nicht sicher, ob die erste oder die letzte davon.

Modulbasierte runonce.php

Um den obigen Nachteil aus dem Weg zu gehen, wurde über eine modulbasierte runonce.php nachgedacht.
Den nachfolgenden Code in die config.php des eigenen Modules einfügen. Den Pfad anpassen, "MODULNAME" durch den Verzeichnisnamen des eigenen Moduls ersetzen und eine runonce.php im config Verzeichnis erstellen.
Diese runonce.php wird beim nächsten Seitenaufruf einmalig ausgeführt und danach gelöscht.

$runonceFile = '/system/modules/MODULNAME/config/runonce.php';
if (file_exists(TL_ROOT . $runonceFile))
{
 include(TL_ROOT . $runonceFile);
 $objFiles = Files::getInstance();
 $objFiles->delete($runonceFile);
}

Nachteil dieser Variante: Die ER Verwaltung meckert, dass das Modul unvollständig sei, da nun eine Datei fehlt.
Eine Idee wäre, die Datei nicht zu löschen, sondern zu überschreiben:

$runonceFile = 'system/modules/MODULNAME/config/runonce.php'; // relativ zu TL_ROOT
if (file_exists(TL_ROOT . '/' . $runonceFile))
{
   $GLOBALS['runonce']['MODULNAME'] = false;
   include(TL_ROOT . '/' . $runonceFile);
   if ($GLOBALS['runonce']['MODULNAME'] === false) 
   {
       $objFiles = Files::getInstance();
       $objFiles->delete($runonceFile); // hier wird intern ein "TL_ROOT/" vorgesetzt
       //nun wieder neu anlegen mit neuem Inhalt
       $objFile = new File($runonceFile); // hier wird intern ein "TL_ROOT/" vorgesetzt
       $objFile->write("<?php \$GLOBALS['runonce']['MODULNAME'] = true; ?>");
       $objFile->close();
   }
}

Wobei man nun die file_exists Prüfung weglassen könnte.
Andererseits könnte man diesen Abschnitt immer im Modul lassen und nur durch Setzen der Variablen $runonceFile bestimmen, ob es was zu tun gibt oder nicht.

Probleme

Einen kleinen Nebeneffekt hat die ganze Sache. Es kommt zu einer Fehlermeldung, sobald man die Datenbank Instanz nutzt; egal ob die funktions- oder objektorientierte Variante verwendet wird.
Am Ende der Seite erscheint die Meldung:

Fatal error: Exception thrown without a stack frame in Unknown  on line 0

Das Script selbst wird dabei ohne Probleme abgearbeitet, auch das Backend selbst wird dadurch nicht gestört.

Modulbasierte runonce.php als System runonce.php

Durch Analyse einer runonce.php bei einem Liveupdate wurde klar, wenn diese aus dem System heraus aufgerufen wird und nicht aus einer config Datei, gibt es keine Fehlermeldung.
Durch langes Experimentieren ist der Author auf eine Lösung gekommen, die zumindest bei ihm funktioniert.
Prinzip:

• in der config.php wird geprüft ob eine Datei /system/runonce.php existiert
• Ja: Abbruch, beim nächsten Seitenaufruf wird erneut geprüft.
• Nein: die mitgebrachte RunonceJob.php wird nach /system/runonce.php kopiert und dadurch beim nächsten Seitenaufruf abgearbeitet.
  • die mitgebrachte wird überschrieben, um später zu erkennen, dass diese bereits ausgeführt wurde.

Damit die Fehlermeldung nicht auftritt, muss auch die eigentliche RunonceJob.php einen speziellen Syntax haben.
Aus diesem Grund hier beide Dateien für ein einfaches Beispiel.
Hier nun der geänderte Code - config.php:

$runonceJob  = 'system/modules/MODULNAME/config/RunonceJob.php'; // eigene runonce
$runonceFile = 'system/runonce.php'; // system runonce
 
if ( (file_exists(TL_ROOT . '/' . $runonceJob)) && (!file_exists(TL_ROOT . '/' . $runonceFile)) ) 
{
	//keine /system/runonce.php, let's go
	$objFile = new File($runonceJob); // hier wird intern ein "TL_ROOT/" vorgesetzt
	if ($objFile->filesize > 100) 
	{
		$objFiles = Files::getInstance();
		$objFiles->copy($runonceJob,$runonceFile);
		//
		$objFile->write("<?php // Module Migration Complete ?>");  // Datei muss kleiner 100 Zeichen werden
	}
	$objFile->close();
}

Hier wird über die Dateigröße geprüft, ob die Datei noch kopiert werden muss oder nicht.

Hier nun der Aufbau der passenden eigenen runonce.php, im obigem Beispiel die RunonceJob.php:

<?php @error_reporting(0); @ini_set("display_errors", 0);  
 
if (version_compare(VERSION . '.' . BUILD, '2.8.9', '>'))  // die soll nur ab Contao 2.9 ausgeführt werden
{
    $objDatabase = Database::getInstance();
    $objDatabase->listTables();
 
    // Nur wenn tl_meinmodul.feld_01 existiert aber tl_module.feld_02 nicht, gibt es was zu tun
    if ($objDatabase->fieldExists('feld_01', 'tl_meinmodul') 
    && !$objDatabase->fieldExists('feld_02', 'tl_module'))
    {
        //Migration mit Neufeldanlegung
        //Feld anlegen
        try { $objDatabase->execute("ALTER TABLE `tl_module` ADD `feld_02` varchar(32) NOT NULL default ''"); } 
        catch (Exception $e) { $errors[] = $e->getMessage(); }
       // Nun würden hier weiter Anweisungen folgen, z.B. das neue Feld gleich zu füllen.
    }
}
?>

Wichtig ist also, jede SQL Anweisung in try { .... } catch (Exception $e) { $errors[] = $e->getMessage(); } zu kapseln.

Die Zukunft / Contao 2.10

Die letzte Lösung funktioniert. Aber es wäre besser, wenn es die Möglichkeit gäbe, dass alle Module ihre eigene runonce.php mitbringen im Verzeichnis /system, ohne das diese gegenseitig überschrieben werden.
In Contao 2.10 wurde im Core eine neue Variante implementiert, welche hier bald erläutert wird. Geplant habe ich das während des Contao-Camps zu tun.

--BugBuster 21:19, 6. Nov. 2011 (CET)