Kapitel 4. Entwicklerdokumentation

4.1. Globale Variablen

4.1.1. Wie sehen globale Variablen in Perl aus?

Globale Variablen liegen in einem speziellen namespace namens "main", der von �berall erreichbar ist. Dar�ber hinaus sind bareword globs global und die meisten speziellen Variablen sind... speziell.

Daraus ergeben sich folgende Formen:

$main::form

expliziter Namespace "main"

$::form

impliziter Namespace "main"

open FILE, "file.txt"

FILE ist global

$_

speziell

Im Gegensatz zu PHP™ gibt es kein Schl�sselwort wie "global", mit dem man importieren kann. my, our und local machen was anderes.

my $form

lexikalische Variable, g�ltig bis zum Ende des Scopes

our $form

$form referenziert ab hier $PACKAGE::form.

local $form

Alle �nderungen an $form werden am Ende des scopes zur�ckgesetzt

4.1.2. Warum sind globale Variablen ein Problem?

Das erste Problem ist FCGI™.

SQL-Ledger™ hat fast alles im globalen namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist. Unter FCGI™ m�ssen diese Sachen aber wieder aufger�umt werden, damit sie nicht in den n�chsten Request kommen. Einige Sachen wiederum sollen nicht gel�scht werden, wie zum Beispiel Datenbankverbindungen, weil die sehr lange zum Initialisieren brauchen.

Das zweite Problem ist strict. Unter strict werden alle Variablen die nicht explizit mit Package, my oder our angegeben werden als Tippfehler angemarkert, dies hat, seit der Einf�hrung, u.a. schon so manche langwierige Bug-Suche verk�rzt. Da globale Variablen aber implizit mit Package angegeben werden, werden die nicht gepr�ft, und somit kann sich schnell ein Tippfehler einschleichen.

4.1.3. Kanonische globale Variablen

Um dieses Problem im Griff zu halten gibt es einige wenige globale Variablen, die kanonisch sind, d.h. sie haben bestimmte vorgegebenen Eigenschaften, und alles andere sollte anderweitig umhergereicht werden.

Diese Variablen sind im Moment die folgenden neun:

  • $::form

  • %::myconfig

  • $::locale

  • $::lxdebug

  • $::auth

  • $::lx_office_conf

  • $::instance_conf

  • $::dispatcher

  • $::request

Damit diese nicht erneut als M�llhalde missbraucht werden, im Folgenden eine kurze Erl�uterung der bestimmten vorgegebenen Eigenschaften (Konventionen):

4.1.3.1. $::form

  • Ist ein Objekt der Klasse "Form"

  • Wird nach jedem Request gel�scht

  • Muss auch in Tests und Konsolenscripts vorhanden sein.

  • Enth�lt am Anfang eines Requests die Requestparameter vom User

  • Kann zwar intern �ber Requestgrenzen ein Datenbankhandle cachen, das wird aber momentan absichtlich zerst�rt

$::form wurde unter SQL Ledger™ als Gottobjekt f�r alles misbraucht. S�mtliche alten Funktionen unter SL/ mutieren $::form, das hei�t, alles was einem lieb ist (alle Variablen die einem ans Herz gewachsen sind), sollte man vor einem Aufruf (!) von zum Beispiel IS->retrieve_customer() in Sicherheit bringen.

Z.B. das vom Benutzer eingestellte Zahlenformat, bevor man Berechnung in einem bestimmten Format durchf�hrt (SL/Form.pm Zeile 3552, Stand version 2.7beta), um dies hinterher wieder auf den richtigen Wert zu setzen:

  my $saved_numberformat    = $::myconfig{numberformat};
  $::myconfig{numberformat} = $numberformat;
  # (...) div Berechnungen
  $::myconfig{numberformat} = $saved_numberformat;

Das Objekt der Klasse Form hat leider im Moment noch viele zentrale Funktionen die vom internen Zustand abh�ngen, deshalb bitte nie einfach zerst�ren oder �berschreiben (zumindestens nicht kurz vor einem Release oder in Absprache �ber bspw. die devel-Liste ;-). Es geht ziemlich sicher etwas kaputt.

$::form ist gleichzeitig der Standard Scope in den Template::Toolkit™ Templates au�erhalb der Controller: der Ausdruck [% var %] greift auf $::form->{var} zu. Unter Controllern ist der Standard Scope anders, da lautet der Zugriff [% FORM.var %]. In Druckvorlagen sind normale Variablen ebenfall im $::form Scope, d.h. <%var%> zeigt auf $::form->{var}. Nochmal von der anderen Seite erl�utert, innerhalb von (Web-)Templates sieht man h�ufiger solche Konstrukte:

[%- IF business %]
# (... Zeig die Auswahlliste Kunden-/Lieferantentyp an)
[%- END %]

Entweder wird hier dann $::form->{business} ausgewertet oder aber der Funktion $form->parse_html_template wird explizit noch ein zus�tzlicher Hash �bergeben, der dann auch in den (Web-)Templates zu Verf�gung steht, bspw. so:

$form->parse_html_template("is/form_header", \%TMPL_VAR);

Innerhalb von Schleifen wird $::form->{TEMPLATE_ARRAYS}{var}[$index] bevorzugt, wenn vorhanden. Ein Beispiel findet sich in SL/DO.pm, welches �ber alle Positionen eines Lieferscheins in Schleife l�uft:

for $i (1 .. $form->{rowcount}) {
  # ...
  push @{ $form->{TEMPLATE_ARRAYS}{runningnumber} },   $position;
  push @{ $form->{TEMPLATE_ARRAYS}{number} },          $form->{"partnumber_$i"};
  push @{ $form->{TEMPLATE_ARRAYS}{description} },     $form->{"description_$i"};
  # ...
}

4.1.3.2. %::myconfig

  • Das einzige Hash unter den globalen Variablen

  • Wird sp�testens ben�tigt wenn auf die Datenbank zugegriffen wird

  • Wird bei jedem Request neu erstellt.

  • Enth�lt die Userdaten des aktuellen Logins

  • Sollte nicht ohne Filterung irgendwo gedumpt werden oder extern serialisiert werden, weil da auch der Datenbankzugriff f�r diesen user drinsteht.

  • Enth�lt unter anderem Listenbegrenzung vclimit, Datumsformat dateformat und Nummernformat numberformat

  • Enth�lt Datenbankzugriffinformationen

%::myconfig ist im Moment der Ersatz f�r ein Userobjekt. Die meisten Funktionen, die etwas anhand des aktuellen Users entscheiden m�ssen, befragen %::myconfig. Innerhalb der Anwendungen sind dies �berwiegend die Daten, die sich unter Programm -> Einstellungen befinden, bzw. die Informationen �ber den Benutzer die �ber die Administrator-Schnittstelle (admin.pl) eingegeben wurden.

4.1.3.3. $::locale

  • Objekt der Klasse "Locale"

  • Wird pro Request erstellt

  • Muss auch f�r Tests und Scripte immer verf�gbar sein.

  • Cached intern �ber Requestgrenzen hinweg benutzte Locales

Lokalisierung f�r den aktuellen User. Alle �bersetzungen, Zahlen- und Datumsformatierungen laufen �ber dieses Objekt.

4.1.3.4. $::lxdebug

  • Objekt der Klasse "LXDebug"

  • Wird global gecached

  • Muss immer verf�gbar sein, in nahezu allen Funktionen

$::lxdebug stellt Debuggingfunktionen bereit, wie "enter_sub" und "leave_sub", mit denen in den alten Modulen ein brauchbares Tracing gebaut ist, "log_time", mit der man die Wallclockzeit seit Requeststart loggen kann, sowie "message" und "dump" mit denen man flott Informationen ins Log (tmp/lx-office-debug.log) packen kann.

Beispielsweise so:

$main::lxdebug->message(0, 'Meine Konfig:' . Dumper (%::myconfig));
$main::lxdebug->message(0, 'Wer bin ich? Kunde oder Lieferant:' . $form->{vc});

4.1.3.5. $::auth

  • Objekt der Klasse "SL::Auth"

  • Wird global gecached

  • Hat eine permanente DB Verbindung zur Authdatenbank

  • Wird nach jedem Request resettet.

$::auth stellt Funktionen bereit um die Rechte des aktuellen Users abzufragen. Obwohl diese Informationen vom aktuellen User abh�ngen wird das Objekt aus Geschwindigkeitsgr�nden nur einmal angelegt und dann nach jedem Request kurz resettet.

4.1.3.6. $::lx_office_conf

  • Objekt der Klasse "SL::LxOfficeConf"

  • Global gecached

  • Repr�sentation der config/lx_office.conf[.default]-Dateien

Globale Konfiguration. Configdateien werden zum Start gelesen und danach nicht mehr angefasst. Es ist derzeit nicht geplant, dass das Programm die Konfiguration �ndern kann oder sollte.

Beispielsweise ist �ber den Konfigurationseintrag [debug] die Debug- und Trace-Log-Datei wie folgt konfiguriert und verf�gbar:

[debug]
file = /tmp/lx-office-debug.log

ist der Key file im Programm als $::lx_office_conf->{debug}{file} erreichbar.

[Warnung]Warnung

Zugriff auf die Konfiguration erfolgt im Moment �ber Hashkeys, sind also nicht gegen Tippfehler abgesichert.

4.1.3.7. $::instance_conf

  • Objekt der Klasse "SL::InstanceConfiguration"

  • wird pro Request neu erstellt

Funktioniert wie $::lx_office_conf, speichert aber Daten die von der Instanz abh�ngig sind. Eine Instanz ist hier eine Mandantendatenbank. Beispielsweise �berpr�ft

$::instance_conf->get_inventory_system eq 'perpetual'

ob die ber�chtigte Bestandsmethode zur Anwendung kommt.

4.1.3.8. $::dispatcher

  • Objekt der Klasse "SL::Dispatcher"

  • wird pro Serverprozess erstellt.

  • enth�lt Informationen �ber die technische Verbindung zum Server

Der dritte Punkt ist auch der einzige Grund warum das Objekt global gespeichert wird. Wird vermutlich irgendwann in einem anderen Objekt untergebracht.

4.1.3.9. $::request

  • Hashref (evtl sp�ter Objekt)

  • Wird pro Request neu initialisiert.

  • Keine Unterstruktur garantiert.

$::request ist ein generischer Platz um Daten "f�r den aktuellen Request" abzulegen. Sollte nicht f�r action at a distance benutzt werden, sondern um lokales memoizing zu erm�glichen, das garantiert am Ende des Requests zerst�rt wird.

Vieles von dem, was im moment in $::form liegt, sollte eigentlich hier liegen. Die groben Differentialkriterien sind:

  • Kommt es vom User, und soll unver�ndert wieder an den User? Dann $::form, steht da eh schon

  • Sind es Daten aus der Datenbank, die nur bis zum Ende des Requests gebraucht werden? Dann $::request

  • Muss ich von anderen Teilen des Programms lesend drauf zugreifen? Dann $::request, aber Zugriff �ber Wrappermethode

4.1.4. Ehemalige globale Variablen

Die folgenden Variablen waren einmal im Programm, und wurden entfernt.

4.1.4.1. $::cgi

  • war n�tig, weil cookie Methoden nicht als Klassenfunktionen funktionieren

  • Aufruf als Klasse erzeugt Dummyobjekt was im Klassennamespace gehalten wird und �ber Requestgrenzen leaked

  • liegt jetzt unter $::request->{cgi}

4.1.4.2. $::all_units

  • war n�tig, weil einige Funktionen in Schleifen zum Teil ein paar hundert mal pro Request eine Liste der Einheiten brauchen, und de als Parameter durch einen Riesenstack von Funktionen geschleift werden m�ssten.

  • Liegt jetzt unter $::request->{cache}{all_units}

  • Wird nur in AM->retrieve_all_units() gesetzt oder gelesen.

4.1.4.3. %::called_subs

  • wurde benutzt um callsub deep recursions abzufangen.

  • Wurde entfernt, weil callsub nur einen Bruchteil der m�glichen Rekursioenen darstellt, und da nie welche auftreten.

  • komplette recursion protection wurde entfernt.