doc/html/ch04.html

   1 <html><head>
   2       <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
   3    <title>Kapitel 4. Entwicklerdokumentation</title><link rel="stylesheet" type="text/css" href="style.css"><meta name="generator" content="DocBook XSL Stylesheets V1.76.1-RC2"><link rel="home" href="index.html" title="Lx-Office: Installation, Konfiguration, Entwicklung"><link rel="up" href="index.html" title="Lx-Office: Installation, Konfiguration, Entwicklung"><link rel="prev" href="ch03s03.html" title="3.3. Excel-Vorlagen"><link rel="next" href="ch04s02.html" title="4.2. Entwicklung unter FastCGI"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Kapitel 4. Entwicklerdokumentation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch03s03.html">Zurück</a>&nbsp;</td><th width="60%" align="center">&nbsp;</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch04s02.html">Weiter</a></td></tr></table><hr></div><div class="chapter" title="Kapitel 4. Entwicklerdokumentation"><div class="titlepage"><div><div><h2 class="title"><a name="d0e4243"></a>Kapitel 4. Entwicklerdokumentation</h2></div></div></div><div class="sect1" title="4.1. Globale Variablen"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="devel.globals"></a>4.1. Globale Variablen</h2></div></div></div><div class="sect2" title="4.1.1. Wie sehen globale Variablen in Perl aus?"><div class="titlepage"><div><div><h3 class="title"><a name="d0e4249"></a>4.1.1. Wie sehen globale Variablen in Perl aus?</h3></div></div></div><p>Globale Variablen liegen in einem speziellen namespace namens
   4         "main", der von überall erreichbar ist. Darüber hinaus sind bareword
   5         globs global und die meisten speziellen Variablen sind...
   6         speziell.</p><p>Daraus ergeben sich folgende Formen:</p><div class="variablelist"><dl><dt><span class="term">
   7                      <code class="literal">$main::form</code>
   8                   </span></dt><dd><p>expliziter Namespace "main"</p></dd><dt><span class="term">
   9                      <code class="literal">$::form</code>
  10                   </span></dt><dd><p>impliziter Namespace "main"</p></dd><dt><span class="term">
  11                      <code class="literal">open FILE, "file.txt"</code>
  12                   </span></dt><dd><p>
  13                         <code class="varname">FILE</code> ist global</p></dd><dt><span class="term">
  14                      <code class="literal">$_</code>
  15                   </span></dt><dd><p>speziell</p></dd></dl></div><p>Im Gegensatz zu <span class="productname">PHP</span>&#8482; gibt es kein
  16         Schlüsselwort wie "<code class="function">global</code>", mit dem man
  17         importieren kann. <code class="function">my</code>, <code class="function">our</code>
  18         und <code class="function">local</code> machen was anderes.</p><div class="variablelist"><dl><dt><span class="term">
  19                      <code class="literal">my $form</code>
  20                   </span></dt><dd><p>lexikalische Variable, gültig bis zum Ende des
  21               Scopes</p></dd><dt><span class="term">
  22                      <code class="literal">our $form</code>
  23                   </span></dt><dd><p>
  24                         <code class="varname">$form</code> referenziert ab hier
  25               <code class="varname">$PACKAGE::form</code>.</p></dd><dt><span class="term">
  26                      <code class="literal">local $form</code>
  27                   </span></dt><dd><p>Alle Änderungen an <code class="varname">$form</code> werden am Ende
  28               des scopes zurückgesetzt</p></dd></dl></div></div><div class="sect2" title="4.1.2. Warum sind globale Variablen ein Problem?"><div class="titlepage"><div><div><h3 class="title"><a name="d0e4350"></a>4.1.2. Warum sind globale Variablen ein Problem?</h3></div></div></div><p>Das erste Problem ist <span class="productname">FCGI</span>&#8482;.</p><p>
  29                <span class="productname">SQL-Ledger</span>&#8482; hat fast alles im globalen
  30         namespace abgelegt, und erwartet, dass es da auch wiederzufinden ist.
  31         Unter <span class="productname">FCGI</span>&#8482; müssen diese Sachen auch wieder
  32         aufgeräumt werden, damit sie nicht in den nächsten Request kommen.
  33         Einige Sachen wiederum sollen nicht gelöscht werden, wie zum Beispiel
  34         Datenbankverbindungen, weil die ne Ewigkeit zum initialisieren
  35         brauchen.</p><p>Das zweite Problem ist <code class="function">strict</code>. Unter
  36         <code class="function">strict</code> werden alle Variablen die nicht explizit
  37         mit <code class="function">Package</code>, <code class="function">my</code> oder
  38         <code class="function">our</code> angegeben werden als Tippfehler angemarkert,
  39         was einen vor so mancher Stunde suchen nach einem Bug erspart. Da
  40         globale Variablen aber implizit mit Package angegeben werden, werden
  41         die nicht geprüft, und ein Tippfehler da fällt niemandem auf.</p></div><div class="sect2" title="4.1.3. Kanonische globale Variablen"><div class="titlepage"><div><div><h3 class="title"><a name="d0e4383"></a>4.1.3. Kanonische globale Variablen</h3></div></div></div><p>Um dieses Problem im Griff zu halten gibt es einige wenige
  42         globale Variablen, die kanonisch sind, und alles andere sollte
  43         anderweitig umhergereicht werden.</p><p>Diese Variablen sind im Moment die folgenden neun:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
  44                      <code class="varname">$::form</code>
  45                   </p></li><li class="listitem"><p>
  46                      <code class="varname">%::myconfig</code>
  47                   </p></li><li class="listitem"><p>
  48                      <code class="varname">$::locale</code>
  49                   </p></li><li class="listitem"><p>
  50                      <code class="varname">$::lxdebug</code>
  51                   </p></li><li class="listitem"><p>
  52                      <code class="varname">$::auth</code>
  53                   </p></li><li class="listitem"><p>
  54                      <code class="varname">$::lx_office_conf</code>
  55                   </p></li><li class="listitem"><p>
  56                      <code class="varname">$::instance_conf</code>
  57                   </p></li><li class="listitem"><p>
  58                      <code class="varname">$::dispatcher</code>
  59                   </p></li><li class="listitem"><p>
  60                      <code class="varname">$::request</code>
  61                   </p></li></ul></div><p>Damit diese nicht als Müllhalde misbrauch werden, im Folgenden
  62         eine kurze Erläuterung was man von denn erwarten kann.</p><div class="sect3" title="4.1.3.1. $::form"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4447"></a>4.1.3.1. $::form</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Ist ein Objekt der Klasse
  63               "<code class="classname">Form</code>"</p></li><li class="listitem"><p>Wird nach jedem Request gelöscht</p></li><li class="listitem"><p>Muss auch in Tests und Konsolenscripts vorhanden
  64               sein.</p></li><li class="listitem"><p>Enthält am Anfang eines Requests die Requestparameter vom
  65               User</p></li><li class="listitem"><p>Kann zwar intern über Requestgrenzen ein Datenbankhandle
  66               cachen, das wird aber momentan absichtlich zerstört</p></li></ul></div><p>
  67                   <code class="varname">$::form</code> wurde unter <span class="productname">SQL
  68           Ledger</span>&#8482; als Gottobjekt für alles misbraucht. Sämtliche
  69           alten Funktionen unter SL/ mutieren <code class="varname">$::form</code>, das
  70           heißt, alles was einem lieb ist, sollte man vor einem Aufruf von zum
  71           Beispiel <code class="function">IS-&gt;retrieve_customer()</code> in
  72           Sicherheit bringen.</p><p>Das Objekt der Klasse Form hat leider im Moment noch viele
  73           zentrale Funktionen Gdie vom internen Zustand abhängen, deshalb
  74           bitte nie einfach zerstören oder überschreiben. Es geht ziemlich
  75           sicher etwas kaputt.</p><p>
  76                   <code class="varname">$::form</code> ist gleichzeitig der Standard Scope
  77           in den <span class="productname">Template::Toolkit</span>&#8482; Templates
  78           außerhalb der Controller: der Ausdruck <code class="function">[% var
  79           %]</code> greift auf <code class="varname">$::form-&gt;{var}</code> zu.
  80           Unter Controllern ist der Standard Scope anders, da lautet der
  81           Zugriff <code class="function">[% FORM.var %]</code>. In Druckvorlagen sind
  82           normale Variablen ebenfall im <code class="varname">$::form</code> Scope, d.h.
  83           <code class="function">&lt;%var%&gt;</code> zeigt auf
  84           <code class="varname">$::form-&gt;{var}</code>. Innerhalb von Schleifen wird
  85           <code class="varname">$::form-&gt;{TEMPLATE_ARRAYS}{var}[$index]</code>
  86           bevorzugt, wenn vorhanden.</p></div><div class="sect3" title="4.1.3.2. %::myconfig"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4514"></a>4.1.3.2. %::myconfig</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Das einzige Hash unter den globalen Variablen</p></li><li class="listitem"><p>Wird spätestens benötigt wenn auf die Datenbank
  87               zugegriffen wird</p></li><li class="listitem"><p>Wird bei jedem Request neu erstellt.</p></li><li class="listitem"><p>Enthält die Userdaten des aktuellen Logins</p></li><li class="listitem"><p>Sollte nicht ohne Filterung irgendwo gedumpt werden oder
  88               extern serialisiert werden, weil da auch der Datenbankzugriff
  89               für diesenuser drinsteht.</p></li><li class="listitem"><p>Enthält unter anderem Listenbegrenzung vclimit,
  90               Datumsformat dateformat und Nummernformat numberformat</p></li><li class="listitem"><p>Enthält Datenbankzugriffinformationen</p></li></ul></div><p>
  91                   <code class="varname">%::myconfig</code> ist im Moment der Ersatz für
  92           ein Userobjekt. Die meisten Funktionen, die etwas anhand des
  93           aktuellen Users entscheiden müssen, befragen
  94           <code class="varname">%::myconfig</code>.</p></div><div class="sect3" title="4.1.3.3. $::locale"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4547"></a>4.1.3.3. $::locale</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Objekt der Klasse "Locale"</p></li><li class="listitem"><p>Wird pro Request erstellt</p></li><li class="listitem"><p>Muss auch für Tests und Scripte immer verfügbar
  95               sein.</p></li><li class="listitem"><p>Cached intern über Requestgrenzen hinweg benutzte
  96               Locales</p></li></ul></div><p>Lokalisierung für den aktuellen User. Alle Übersetzungen,
  97           Zahlen- und Datumsformatierungen laufen über dieses Objekt.</p></div><div class="sect3" title="4.1.3.4. $::lxdebug"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4565"></a>4.1.3.4. $::lxdebug</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Objekt der Klasse "LXDebug"</p></li><li class="listitem"><p>Wird global gecached</p></li><li class="listitem"><p>Muss immer verfügbar sein, in nahezu allen
  98               Funktionen</p></li></ul></div><p>
  99                   <code class="varname">$::lxdebug</code> stellt Debuggingfunktionen
 100           bereit, wie "<code class="function">enter_sub</code>" und
 101           "<code class="function">leave_sub</code>", mit denen in den alten Modulen ein
 102           brauchbares Tracing gebaut ist, "<code class="function">log_time</code>", mit
 103           der man die Wallclockzeit seit Requeststart loggen kann, sowie
 104           "<code class="function">message</code>" und "<code class="function">dump</code>" mit
 105           denen man flott Informationen ins Log packen kann.</p></div><div class="sect3" title="4.1.3.5. $::auth"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4598"></a>4.1.3.5. $::auth</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Objekt der Klasse "SL::Auth"</p></li><li class="listitem"><p>Wird global gecached</p></li><li class="listitem"><p>Hat eine permanente DB Verbindung zur Authdatenbank</p></li><li class="listitem"><p>Wird nach jedem Request resettet.</p></li></ul></div><p>
 106                   <code class="varname">$::auth</code> stellt Funktionen bereit um die
 107           Rechte des aktuellen Users abzufragen. Obwohl diese Informationen
 108           vom aktuellen User abhängen wird das Objekt aus
 109           Geschwindigkeitsgründen nur einmal angelegt und dann nach jedem
 110           Request kurz resettet.</p></div><div class="sect3" title="4.1.3.6. $::lx_office_conf"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4619"></a>4.1.3.6. $::lx_office_conf</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Objekt der Klasse
 111               "<code class="classname">SL::LxOfficeConf</code>"</p></li><li class="listitem"><p>Global gecached</p></li><li class="listitem"><p>Repräsentation der
 112               <code class="filename">config/lx_office.conf[.default]</code>-Dateien</p></li></ul></div><p>Globale Konfiguration. Configdateien werden zum Start gelesen,
 113           und nicht mehr angefasst. Es ist derzeit nicht geplant, dass das
 114           Programm die Konfiguration ändern kann oder sollte.</p><p>Für die folgende Konfigurationsdatei:</p><pre class="programlisting">[debug]
 115 file = /tmp/lxoffice_debug_log.txt</pre><p>ist der Key <code class="varname">file</code> im Programm als
 116           <code class="varname">$::lx_office_conf-&gt;{debug}{file}</code>
 117           erreichbar.</p><div class="warning" title="Warnung" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Warning"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Warnung]" src="../../../../system/docbook-xsl/images/warning.png"></td><th align="left">Warnung</th></tr><tr><td align="left" valign="top"><p>Zugriff auf die Konfiguration erfolgt im Moment über
 118             Hashkeys, sind also nicht gegen Tippfehler abgesichert.</p></td></tr></table></div></div><div class="sect3" title="4.1.3.7. $::instance_conf"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4655"></a>4.1.3.7. $::instance_conf</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Objekt der Klasse
 119               "<code class="classname">SL::InstanceConfiguration</code>"</p></li><li class="listitem"><p>wird pro Request neu erstellt</p></li></ul></div><p>Funktioniert wie <code class="varname">$::lx_office_conf</code>,
 120           speichert aber Daten die von der Instanz abhängig sind. Eine Instanz
 121           ist hier eine Mandantendatenbank. Prominentestes Datum ist "eur",
 122           die Information ob Bilanz oder Einnahmenüberschussrechnung gemacht
 123           wird.</p></div><div class="sect3" title="4.1.3.8. $::dispatcher"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4673"></a>4.1.3.8. $::dispatcher</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Objekt der Klasse
 124               "<code class="varname">SL::Dispatcher</code>"</p></li><li class="listitem"><p>wird pro Serverprozess erstellt.</p></li><li class="listitem"><p>enthält Informationen über die technische Verbindung zum
 125               Server</p></li></ul></div><p>Der dritte Punkt ist auch der einzige Grund warum das Objekt
 126           global gespeichert wird. Wird vermutlich irgendwann in einem anderen
 127           Objekt untergebracht.</p></div><div class="sect3" title="4.1.3.9. $::request"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4691"></a>4.1.3.9. $::request</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Hashref (evtl später Objekt)</p></li><li class="listitem"><p>Wird pro Request neu initialisiert.</p></li><li class="listitem"><p>Keine Unterstruktur garantiert.</p></li></ul></div><p>
 128                   <code class="varname">$::request</code> ist ein generischer Platz um
 129           Daten "für den aktuellen Request" abzulegen. Sollte nicht für action
 130           at a distance benutzt werden, sondern um lokales memoizing zu
 131           ermöglichen, das garantiert am Ende des Requests zerstört
 132           wird.</p><p>Vieles von dem, was im moment in <code class="varname">$::form</code>
 133           liegt, sollte eigentlich hier liegen. Die groben
 134           Differentialkriterien sind:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>Kommt es vom User, und soll unverändert wieder an den User? Dann <code class="varname">$::form</code>, steht da eh schon</p></li><li class="listitem"><p>Sind es Daten aus der Datenbank, die nur bis zum Ende des Requests gebraucht werden? Dann
 135               <code class="varname">$::request</code>
 136                      </p></li><li class="listitem"><p>Muss ich von anderen Teilen des Programms lesend drauf zugreifen? Dann <code class="varname">$::request</code>, aber Zugriff über
 137               Wrappermethode</p></li></ul></div></div></div><div class="sect2" title="4.1.4. Ehemalige globale Variablen"><div class="titlepage"><div><div><h3 class="title"><a name="d0e4733"></a>4.1.4. Ehemalige globale Variablen</h3></div></div></div><p>Die folgenden Variablen waren einmal im Programm, und wurden
 138         entfernt.</p><div class="sect3" title="4.1.4.1. $::cgi"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4738"></a>4.1.4.1. $::cgi</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>war nötig, weil cookie Methoden nicht als
 139               Klassenfunktionen funktionieren</p></li><li class="listitem"><p>Aufruf als Klasse erzeugt Dummyobjekt was im
 140               Klassennamespace gehalten wird und über Requestgrenzen
 141               leaked</p></li><li class="listitem"><p>liegt jetzt unter
 142               <code class="varname">$::request-&gt;{cgi}</code>
 143                      </p></li></ul></div></div><div class="sect3" title="4.1.4.2. $::all_units"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4754"></a>4.1.4.2. $::all_units</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>war nötig, weil einige Funktionen in Schleifen zum Teil
 144               ein paar hundert mal pro Request eine Liste der Einheiten
 145               brauchen, und de als Parameter durch einen Riesenstack von
 146               Funktionen geschleift werden müssten.</p></li><li class="listitem"><p>Liegt jetzt unter
 147               <code class="varname">$::request-&gt;{cache}{all_units}</code>
 148                      </p></li><li class="listitem"><p>Wird nur in
 149               <code class="function">AM-&gt;retrieve_all_units()</code> gesetzt oder
 150               gelesen.</p></li></ul></div></div><div class="sect3" title="4.1.4.3. %::called_subs"><div class="titlepage"><div><div><h4 class="title"><a name="d0e4773"></a>4.1.4.3. %::called_subs</h4></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>wurde benutzt um callsub deep recursions
 151               abzufangen.</p></li><li class="listitem"><p>Wurde entfernt, weil callsub nur einen Bruchteil der
 152               möglichen Rekursioenen darstellt, und da nie welche
 153               auftreten.</p></li><li class="listitem"><p>komplette recursion protection wurde entfernt.</p></li></ul></div></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch03s03.html">Zurück</a>&nbsp;</td><td width="20%" align="center">&nbsp;</td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch04s02.html">Weiter</a></td></tr><tr><td width="40%" align="left" valign="top">3.3. Excel-Vorlagen&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Zum Anfang</a></td><td width="40%" align="right" valign="top">&nbsp;4.2. Entwicklung unter FastCGI</td></tr></table></div></body></html>