Using the move() function from the File::Copy module is more reliable than using

[devedit.git] / modules / Template.pm

diff --git a/modules/Template.pm b/modules/Template.pm
index e3fbb98f83404dbfb7bac02d289663014c72dd27..dd0f24baa860664dbe401e50a078edacfbc34137 100644 (file)
--- a/modules/Template.pm
+++ b/modules/Template.pm
@@ -1,12 +1,12 @@
 package Template;
 
 #
-# Template (Version 1.2a)
+# Template (Version 1.4)
 #
 # Klasse zum Parsen von Templates
 #
-# Autor:            Patrick Canterino <patshaping@gmx.net>
-# Letzte Aenderung: 12.9.2003
+# Autor:            Patrick Canterino <patrick@patshaping.de>
+# Letzte Aenderung: 5.2.2005
 #
 
 use strict;
@@ -24,7 +24,7 @@ use Carp qw(croak);
 sub new
 {
  my $class = shift;
- my $self  = {template => ''};
+ my $self  = {file => '', template => ''};
  return bless($self,$class);
 }
 
@@ -73,23 +73,29 @@ sub add_text($)
 
 # read_file()
 #
-# Einlesen einer Vorlagendatei
-# (Inhalt wird an bereits vorhandenen Text angehaengt)
+# Einlesen einer Vorlagendatei und {INCLUDE}-Anweisungen ggf. verarbeiten
+# (Text wird an bereits vorhandenen Text angehaengt)
 #
-# Parameter: Datei zum Einlesen
+# Parameter: 1. Datei zum Einlesen
+#            2. Status-Code (Boolean):
+#               true  => {INCLUDE}-Anweisungen nicht verarbeiten
+#               false => {INCLUDE}-Anweisungen verarbeiten (Standard)
 #
 # Rueckgabe: -nichts- (Template-Objekt wird modifiziert)
 
-sub read_file($)
+sub read_file($;$)
 {
- my ($self,$tfile) = @_;
+ my ($self,$file,$not_include) = @_;
  local *FILE;
 
- open(FILE,"<$tfile") or croak "Open $tfile: $!";
- read(FILE, my $content, -s $tfile);
- close(FILE) or croak "Closing $tfile: $!";
+ $self->{'file'} = $file;
+
+ open(FILE,'<'.$file) or croak "Open $file: $!";
+ read(FILE, my $content, -s $file);
+ close(FILE) or croak "Closing $file: $!";
 
  $self->add_text($content);
+ $self->parse_includes unless($not_include);
 }
 
 # fillin()
@@ -106,7 +112,7 @@ sub fillin($$)
  my ($self,$var,$text) = @_;
 
  $var  = quotemeta($var);
- $text = "" unless defined $text; # Um Fehler zu vermeiden
+ $text = '' unless defined $text; # Um Fehler zu vermeiden
 
  my $template = $self->get_template;
  $template    =~ s/\{$var\}/$text/g;
@@ -121,7 +127,7 @@ sub fillin($$)
 # Parameter: 1. Variable zum Ersetzen
 #            2. Array-Referenz, durch die die Variable ersetzt werden soll
 #            3. Zeichenkette, mit der das Array verbunden werden soll
-#               (Standard: "")
+#               (Standard: '')
 #
 # Rueckgabe: -nichts- (Template-Objekt wird modifiziert)
 
@@ -133,13 +139,27 @@ sub fillin_array($$;$)
  $self->fillin($var,join($glue,@$array));
 }
 
+# to_file()
+#
+# Template in Datei schreiben
+#
+# Parameter: Datei-Handle
+#
+# Rueckgabe: Status-Code (Boolean)
+
+sub to_file($)
+{
+ my ($self,$handle) = @_;
+ return print $handle $self->get_template;
+}
+
 # parse_if_block()
 #
 # IF-Bloecke verarbeiten
 #
 # Parameter: 1. Name des IF-Blocks (das, was nach dem IF steht)
-#            2. Statuscode (true  => Inhalt anzeigen
-#                           false => Inhalt nicht anzeigen
+#            2. Status-Code (true  => Inhalt anzeigen
+#                            false => Inhalt nicht anzeigen
 #
 # Rueckgabe: -nichts- (Template-Objekt wird modifiziert)
 
@@ -148,25 +168,32 @@ sub parse_if_block($$)
  my ($self,$name,$state) = @_;
  my $template            = $self->get_template;
 
- while(index($template,"{IF ".$name."}") >= 0)
+ my $count = 0;
+
+ while(index($template,'{IF '.$name.'}') >= 0)
  {
   # Das alles hier ist nicht wirklich elegant geloest...
   # ... aber solange es funktioniert... ;-)
 
-  my $start    = index($template,"{IF ".$name."}");
+  $count++;
+
+  my $start    = index($template,'{IF '.$name.'}');
   my $tpl_tmp  = substr($template,$start);
   my @splitted = split(/\{ENDIF\}/,$tpl_tmp);
+  push(@splitted,'') if(substr($template,-7) eq '{ENDIF}');
 
-  my $block = ""; # Kompletter bedingter Block
+  my $block = ''; # Kompletter bedingter Block
   my $ifs   = 0;  # IF-Zaehler (wird fuer jedes IF erhoeht und fuer jedes ENDIF erniedrigt)
 
   # {IF}
 
   for(my $x=0;$x<@splitted;$x++)
   {
-   $ifs += substr_count($splitted[$x],"{IF"); # Zum Zaehler jedes Vorkommen von IF hinzuzaehlen
-   $ifs--;                                    # Zaehler um 1 erniedrigen
-   $block .= $splitted[$x]."{ENDIF}";         # Daten zum Block hinzufuegen
+   croak 'Nesting error found while parsing IF block "'.$name.'" nr. '.$count.' in template file "'.$self->{'file'}.'"' if($x == $#splitted);
+
+   $ifs += substr_count($splitted[$x],'{IF '); # Zum Zaehler jedes Vorkommen von IF hinzuzaehlen
+   $ifs--;                                     # Zaehler um 1 erniedrigen
+   $block .= $splitted[$x].'{ENDIF}';          # Daten zum Block hinzufuegen
 
    if($ifs == 0)
    {
@@ -180,15 +207,15 @@ sub parse_if_block($$)
 
   # {ELSE}
 
-  my $else_block = ""; # Alles ab {ELSE}
+  my $else_block = ''; # Alles ab {ELSE}
      $ifs        = 0;  # IF-Zaehler
 
   @splitted = split(/\{ELSE\}/,$if_block);
 
   for(my $x=0;$x<@splitted;$x++)
   {
-   $ifs += substr_count($splitted[$x],"{IF");     # Zum Zaehler jedes Vorkommen von IF hinzuzaehlen
-   $ifs -= substr_count($splitted[$x],"{ENDIF}"); # Vom Zaehler jedes Vorkommen von ENDIF abziehen
+   $ifs += substr_count($splitted[$x],'{IF ');    # Zum Zaehler jedes Vorkommen von IF hinzuzaehlen
+   $ifs -= substr_count($splitted[$x],'{ENDIF}'); # Vom Zaehler jedes Vorkommen von ENDIF abziehen
 
    if($ifs == 0)
    {
@@ -198,13 +225,13 @@ sub parse_if_block($$)
 
     for(my $y=$x+1;$y<@splitted;$y++)
     {
-     $else_block .= "{ELSE}".$splitted[$y];
+     $else_block .= '{ELSE}'.$splitted[$y];
     }
 
     if($else_block)
     {
      $if_block   = substr($if_block,0,length($if_block)-length($else_block));
-     $else_block = (length($else_block) > 6) ? substr($else_block,6) : "";    # Ansonsten gibt es Fehler
+     $else_block = (length($else_block) > 6) ? substr($else_block,6) : '';    # Ansonsten gibt es Fehler
     }
 
     last;
@@ -226,8 +253,8 @@ sub parse_if_block($$)
 # Bedingungstags in einem Vorlagentext verarbeiten
 #
 # Parameter: 1. Tagname
-#            2. Statuscode (true  => Tag-Inhalt anzeigen
-#                           false => Tag-Inhalt nicht anzeigen
+#            2. Status-Code (true  => Tag-Inhalt anzeigen
+#                            false => Tag-Inhalt nicht anzeigen
 #
 # Rueckgabe: -nichts- (Template-Objekt wird modifiziert)
 
@@ -237,22 +264,56 @@ sub parse_condtag($$)
 
  my $template = $self->get_template;
 
- while(index($template,"<$condtag>") >= 0)
+ while(index($template,'<'.$condtag.'>') >= 0)
  {
-  my $start = index($template,"<$condtag>");                                # Beginn des Blocks
-  my $end   = index($template,"</$condtag>")+length($condtag)+3;            # Ende des Blocks
+  my $start = index($template,'<'.$condtag.'>');                                # Beginn des Blocks
+  my $end   = index($template,'</'.$condtag.'>')+length($condtag)+3;            # Ende des Blocks
 
-  my $extract = substr($template,$start,$end-$start);                       # Kompletten Bedingungsblock extrahieren...
+  my $extract = substr($template,$start,$end-$start);                           # Kompletten Bedingungsblock extrahieren...
 
-  my $replacement = ($state) ? substr($extract,length($condtag)+2,0-length($condtag)-3) : "";
+  my $replacement = ($state) ? substr($extract,length($condtag)+2,0-length($condtag)-3) : '';
 
   $extract = quotemeta($extract);
 
-  $template =~ s/$extract/$replacement/g;                                   # Block durch neue Daten ersetzen
+  $template =~ s/$extract/$replacement/g;                                       # Block durch neue Daten ersetzen
  }
  $self->set_template($template);
 }
 
+# parse_includes()
+#
+# {INCLUDE}-Anweisungen verarbeiten
+#
+# Parameter: -nichts-
+#
+# Rueckgabe: -nichts- (Template-Objekt wird modifiziert)
+
+sub parse_includes
+{
+ my $self     = shift;
+ my $template = $self->get_template;
+
+ while($template =~ /(\{INCLUDE (\S+?)\})/)
+ {
+  my ($directive,$file) = ($1,$2);
+  my $qm_directive      = quotemeta($directive);
+  my $replacement       = '';
+
+  if(-f $file)
+  {
+   local *FILE;
+
+   open(FILE,'<'.$file) or croak "Open $file: $!";
+   read(FILE, $replacement, -s $file);
+   close(FILE) or croak "Closing $file: $!";
+  }
+
+  $template =~ s/$qm_directive/$replacement/g;
+ }
+
+ $self->set_template($template);
+}
+
 # ==================
 #  Private Funktion
 # ==================