Die PHP_CodeSniffer Odyssee

Heute möchte ich euch eine kleine Geschichte erzählen. Die Geschichte vom Nils, der versucht hat einen Sniff zu schreiben, weil es ja gar nicht so schwer sein kann. Ihr ahnt schon, dass das nicht so einfach ist, wie man es meinen könnte.

Was der PHP_CodeSniffer für ein Tool ist, solltet ihr nach meiner Sniffer Woche ja alle wissen. Ich wollte mal wieder einen Sniff schreiben. Einen Sniff, der nach Variablen sucht, die nie initialisiert und trotzdem verwendet wurden. Koingt anfänglich ein wenig kompliziert. Aber wenn man mal einen Algorithmus gefunden hat, dann sollte es ganz einfach sein.

Meine Grundidee war:

• Falls eine Variable rechts vom Gleichheitszeichen steht, muss sie mindestens einmal im gleichen Scope auch links von einem Gleichheitszeichen gestanden haben.

// gültig
$test = 12;
$zahl = $test;

//ungültig
$zahl2 = $test2;

Der kleine naive Nils ist natürlich ein Freund des Testens. Regel in einen Sniff gegossen und auf ein Projekt losgelassen. Pustekuchen. Großes Projekt und gleich hunderte von False-Positives (also Stellen, an denen meiner Sniffer anschlägt, die aber korrekt sind). Gut so einfach war es dann doch nicht. Ich hatte Funktionen und Parameter vergessen.Die Grundidee musste also eingepasst werden:

• Falls eine Variable ein Funktionsparameter ist, gilt sie als definiert.
• Falls eine Variable rechts vom Gleichheitszeichen steht, muss sie mindestens einmal im gleichen Scope auch links von einem Gleichheitszeichen gestanden haben.

Meinen kleinen Codinstandard wieder laufen lassen und statt hunderten Fehlern waren es jetzt nur noch underte Fehler. Die Anzahl ging zwar runter, aber gelöst war das Problem immer noch nicht. Was hatte ich denn jetzt schon wieder vergessen? Klar. Globale Variablen. Also die Grundidee anpassen:

• Wenn eine Variable über global $var in den Scope geladen wurde, gilt sie als definiert.
• Falls eine Variable ein Funktionsparameter ist, gilt sie als definiert.
• Falls eine Variable rechts vom Gleichheitszeichen steht, muss sie mindestens einmal im gleichen Scope auch links von einem Gleichheitszeichen gestanden haben.

Super, jetzt habe ich sie bestimmt bald alle. Kann ja nicht sein, dass mich PHP so oft reinlegen kann. Statische Codeanalyse soll ja Spass machen. Also wieder laufen lassen und … natürlich immer noch Fehler, die eigentlich keine sind. Ihr denkt jetzt natürlich, dass ich einfach mal alle Fehlermeldungen anschauen sollte, aber vertraut mir, es waren echt viele. Wieder zurück. Ich hatte die Superglobalen vergessen. Ihr ahnt es schon Grundidee anpassen:

• Wenn eine Variable den Namen $_POST, $_GET, $_SERVER, $_SESSION, … hat, dann gilt sie als definiert
• Wenn eine Variable über global $var in den Scope geladen wurde, gilt sie als definiert.
• Falls eine Variable ein Funktionsparameter ist, gilt sie als definiert.
• Falls eine Variable rechts vom Gleichheitszeichen steht, muss sie mindestens einmal im gleichen Scope auch links von einem Gleichheitszeichen gestanden haben.

Tja mittlerweile wurde aus meinem kleinen Sniff schon ein Monsterding, denn jede Regel schlug sich in einer Menge Zeilen Code nieder. Aber zum Glück war ich ja bald am Ende. Aber leider am Ende meiner Nerven. Denn natürlich hatte ich wieder was vergessen. Ich hatte zwar Funktionen fast komplett abgedeckt, aber Methoden noch nicht. Was ist denn wenn ich Attribute verwende? Wieder anpassen:

• Wenn die Variable mit $this oder self anfängt, dann prüfe, ob sie im Klassenkopf defniert wurde
• Wenn eine Variable den Namen $_POST, $_GET, $_SERVER, $_SESSION, … hat, dann gilt sie als definiert
• Wenn eine Variable über global $var in den Scope geladen wurde, gilt sie als definiert.
• Falls eine Variable ein Funktionsparameter ist, gilt sie als definiert.
• Falls eine Variable rechts vom Gleichheitszeichen steht, muss sie mindestens einmal im gleichen Scope auch links von einem Gleichheitszeichen gestanden haben.

Von einer Regel auf fünf, nicht schlecht, für einen Vormittag. Denkste. Natürlich kommt immer noch eine Regel hinzu. Was ist denn mit Exceptions? Exceptions werden durch eine andere Syntax gefangen. Also wieder zurück ans Reißbrett:

• Wenn eine Variable neben einem Klassennamen steht und „davor“ ein catch kommt, gilt sie als definiert.
• Wenn die Variable mit $this oder self anfängt, dann prüfe, ob sie im Klassenkopf defniert wurde
• Wenn eine Variable den Namen $_POST, $_GET, $_SERVER, $_SESSION, … hat, dann gilt sie als definiert
• Wenn eine Variable über global $var in den Scope geladen wurde, gilt sie als definiert.
• Falls eine Variable ein Funktionsparameter ist, gilt sie als definiert.
• Falls eine Variable rechts vom Gleichheitszeichen steht, muss sie mindestens einmal im gleichen Scope auch links von einem Gleichheitszeichen gestanden haben.

Jetzt lief mein „kleiner“ Sniff fast bis zum Ende ohne Fehler durch. Dummerweise denkt man an den schwersten Fall immer erst sehr spät. Pass by Reference. Ich übergebe eine „leere“ Variable eine Methode und die füllt mir die dann mit Leben. preg_match wäre ein solcher Kandidat. Die Variable die reingeht, muss nicht vorher definiert worden sein, denn das passiert mehr oder weniger in der Methode selbst. PHP hat zum Glück nicht viele Funktionen, die so reagieren, diese gilt es also in eine Liste zu packen, um wenigstens diese zu erkennen. Im Userland sieht das ganz anders aus. Jeder kann solche Methoden programmieren. Es ist aber fast unmöglich über statische Codeanalyse rauszufinden, ob eine Methode Pass By Reference verwendet. Hier gilt es also eine neue Vorbedingung zu schaffen. Eine Variable, die per Pass By Reference übergeben wird, muss vorher mit dem NULL Wert initiiert worden sein. Dann greift nämlich auch die erste Regel und wir sind glücklich. Wir haben also einen neun Sniff zu schreiben, der erstmal prüft, ob alle PBR Variablen  vorher geNULLt wurden. Danach können wir unsere Regeln aktualisieren:

• Wenn die Variable als Referenz an eine native Pass-By-Reference Funktion übergeben wird, gilt sie als definiert.
• Wenn eine Variable neben einem Klassennamen steht und „davor“ ein catch kommt, gilt sie als definiert.
• Wenn die Variable mit $this oder self anfängt, dann prüfe, ob sie im Klassenkopf definiert wurde
• Wenn eine Variable den Namen $_POST, $_GET, $_SERVER, $_SESSION, … hat, dann gilt sie als definiert
• Wenn eine Variable über global $var in den Scope geladen wurde, gilt sie als definiert.
• Falls eine Variable ein Funktionsparameter ist, gilt sie als definiert.
• Falls eine Variable rechts vom Gleichheitszeichen steht, muss sie mindestens einmal im gleichen Scope auch links von einem Gleichheitszeichen gestanden haben.

Das wars. Ich war total am Ende, aber der Sniff scheint zu funktionieren (wahrscheinlich fallen euch gleich nich ein paar Punkte auf, die ich vergessen habe). Was ich aber verdeutlichen wollte ist, nichts so einfach ist, wie es aussieht. Angefangen, als eine kleine Methode, hatte ich am Ende ein Monster an Klasse. Nach so einer Odysse bleibt man das nächste mal doch ein wenig länger am Design und prüft nochmal alles durch, bevor man einfach drauf loslegt.

Wer übrigens Interesse an dem Sniff hat, den muss ich noch eine Weile vertrösten, denn ich bin gerade ein wenig am Testen und Säubern. Danach stelle ich ihn gerne zur Verfügung. Lasst euch aber nicht den Mut nehmen selbst mal einen Sniff zu schreiben. Es gibt auch viele einfache Sniffs, die es noch zu schreiben gilt.

Mist jetzt wo ich fertig bin, fällt mir ein, ich habe Klassenkonstanten vergessen. Tja soviel dazu!