SL/Template/Simple.pm

   1 #====================================================================
   2 # LX-Office ERP
   3 # Copyright (C) 2004
   4 # Based on SQL-Ledger Version 2.1.9
   5 # Web http://www.lx-office.org
   6 #
   7 #====================================================================
   8
   9 package SL::Template::Simple;
  10
  11 use strict;
  12
  13 use Scalar::Util qw(blessed);
  14
  15 # Parameters:
  16 #   1. The template's file name
  17 #   2. A reference to the Form object
  18 #   3. A reference to the myconfig hash
  19 #
  20 # Returns:
  21 #   A new template object
  22 sub new {
  23   my $type = shift;
  24   my $self = {};
  25
  26   bless($self, $type);
  27   $self->_init(@_);
  28
  29   return $self;
  30 }
  31
  32 sub _init {
  33   my ($self, %params) = @_;
  34
  35   $self->{$_} = $params{$_} for keys %params;
  36
  37   $self->{error}     = undef;
  38   $self->{quot_re}   = '"';
  39
  40   $self->set_tag_style('<%', '%>');
  41 }
  42
  43 sub set_tag_style {
  44   my $self                    = shift;
  45   my $tag_start               = shift;
  46   my $tag_end                 = shift;
  47
  48   $self->{custom_tag_style}   = 1;
  49   $self->{tag_start}          = $tag_start;
  50   $self->{tag_end}            = $tag_end;
  51   $self->{tag_start_qm}       = quotemeta $tag_start;
  52   $self->{tag_end_qm}         = quotemeta $tag_end;
  53
  54   $self->{substitute_vars_re} = "$self->{tag_start_qm}(.+?)$self->{tag_end_qm}";
  55 }
  56
  57 sub set_use_template_toolkit {
  58   my $self                    = shift;
  59   my $value                   = shift;
  60
  61   $self->{use_template_toolkit} = $value;
  62 }
  63
  64 sub cleanup {
  65   my ($self) = @_;
  66 }
  67
  68 # Parameters:
  69 #   1. A typeglob for the file handle. The output will be written
  70 #      to this file handle.
  71 #
  72 # Returns:
  73 #   1 on success and undef or 0 if there was an error. In the latter case
  74 #   the calling function can retrieve the error message via $obj->get_error()
  75 sub parse {
  76   my $self = $_[0];
  77   local *OUT = $_[1];
  78
  79   print(OUT "Hallo!\n");
  80 }
  81
  82 sub get_error {
  83   my $self = shift;
  84
  85   return $self->{"error"};
  86 }
  87
  88 sub uses_temp_file {
  89   return 0;
  90 }
  91
  92 sub _get_loop_variable {
  93   my ($self, $var, $get_array, @indices) = @_;
  94   my $form      = $self->{form};
  95   my ($value, @methods);
  96
  97   if ($var =~ m/\./) {
  98     ($var, @methods) = split m/\./, $var;
  99   }
 100
 101   if (($get_array || @indices) && (ref $form->{TEMPLATE_ARRAYS} eq 'HASH') && (ref $form->{TEMPLATE_ARRAYS}->{$var} eq 'ARRAY')) {
 102     $value = $form->{TEMPLATE_ARRAYS}->{$var};
 103   } else {
 104     $value = $form->{$var};
 105   }
 106
 107   for (my $i = 0; $i < scalar(@indices); $i++) {
 108     last unless (ref($value) eq "ARRAY");
 109     $value = $value->[$indices[$i]];
 110   }
 111
 112   for my $part (@methods) {
 113     if (ref($value) =~ m/^(?:Form|HASH)$/) {
 114       $value = $value->{$part};
 115     } elsif (blessed($value) && $value->can($part)) {
 116       $value = $value->$part;
 117     } else {
 118       $value = '';
 119       last;
 120     }
 121   }
 122
 123   return $value;
 124 }
 125
 126 sub substitute_vars {
 127   my ($self, $text, @indices) = @_;
 128
 129   my $form = $self->{"form"};
 130
 131   while ($text =~ /$self->{substitute_vars_re}/) {
 132     my ($tag_pos, $tag_len) = ($-[0], $+[0] - $-[0]);
 133     my ($var, @option_list) = split(/\s+/, $1);
 134     my %options             = map { ($_ => 1) } @option_list;
 135
 136     my $value               = $self->_get_loop_variable($var, 0, @indices);
 137     $value                  = $form->parse_amount({ numberformat => $::myconfig{output_numberformat} || $::myconfig{numberformat} }, $value) if     $options{NOFORMAT};
 138     $value                  = $self->format_string($value)                                                                                   unless $options{NOESCAPE};
 139
 140     substr($text, $tag_pos, $tag_len, $value);
 141   }
 142
 143   return $text;
 144 }
 145
 146 sub _parse_block_if {
 147   $main::lxdebug->enter_sub();
 148
 149   my $self         = shift;
 150   my $contents     = shift;
 151   my $new_contents = shift;
 152   my $pos_if       = shift;
 153   my @indices      = @_;
 154
 155   $$new_contents .= $self->substitute_vars(substr($$contents, 0, $pos_if), @indices);
 156   substr($$contents, 0, $pos_if) = "";
 157
 158   if ($$contents !~ m/^$self->{tag_start_qm}if
 159                      \s*
 160                      (not\b|\!)?           # $1 -- Eventuelle Negierung
 161                      \s+
 162                      (\b.+?\b)             # $2 -- Name der zu überprüfenden Variablen
 163                      (                     # $3 -- Beginn des optionalen Vergleiches
 164                        \s*
 165                        ([!=])              # $4 -- Negierung des Vergleiches speichern
 166                        ([=~])              # $5 -- Art des Vergleiches speichern
 167                        \s*
 168                        (                   # $6 -- Gequoteter String oder Bareword
 169                          $self->{quot_re}
 170                          (.*?)(?<!\\)      # $7 -- Gequoteter String -- direkter Vergleich mit eq bzw. ne oder Patternmatching; Escapete Anführungs als Teil des Strings belassen
 171                          $self->{quot_re}
 172                        |
 173                          (\b.+?\b)         # $8 -- Bareword -- als Index für $form benutzen
 174                        )
 175                      )?
 176                      \s*
 177                      $self->{tag_end_qm}
 178                     /x) {
 179     $self->{"error"} = "Malformed $self->{tag_start}if$self->{tag_end}.";
 180     $main::lxdebug->leave_sub();
 181     return undef;
 182   }
 183
 184   my $not           = $1;
 185   my $var           = $2;
 186   my $comparison    = $3; # Optionaler Match um $4..$8
 187   my $operator_neg  = $4; # '=' oder '!' oder undef, wenn kein Vergleich erkannt
 188   my $operator_type = $5; # '=' oder '~' für Stringvergleich oder Regex
 189   my $quoted_word   = $7; # nur gültig, wenn quoted string angegeben (siehe unten); dann "value" aus <%if var == "value" %>
 190   my $bareword      = $8; # undef, falls quoted string angegeben wurde; andernfalls "othervar" aus <%if var == othervar %>
 191
 192   $not = !$not if ($operator_neg && $operator_neg eq '!');
 193
 194   substr($$contents, 0, length($&)) = "";
 195
 196   my $block;
 197   ($block, $$contents) = $self->find_end($$contents, 0, "$var $comparison", $not);
 198   if (!$block) {
 199     $self->{"error"} = "Unclosed $self->{tag_start}if$self->{tag_end}." unless ($self->{"error"});
 200     $main::lxdebug->leave_sub();
 201     return undef;
 202   }
 203
 204   my $value = $self->_get_loop_variable($var, 0, @indices);
 205   $value    = scalar(@{ $value }) if (ref($value) || '') eq 'ARRAY';
 206   my $hit   = 0;
 207
 208   if ($operator_type) {
 209     my $compare_to = $bareword ? $self->_get_loop_variable($bareword, 0, @indices) : $quoted_word;
 210     if ($operator_type eq '=') {
 211       $hit         = ($not && !($value eq $compare_to))     || (!$not && ($value eq $compare_to));
 212     } else {
 213       $hit         = ($not && !($value =~ m/$compare_to/i)) || (!$not && ($value =~ m/$compare_to/i));
 214     }
 215
 216   } else {
 217     $hit           = ($not && ! $value)                     || (!$not &&  $value);
 218   }
 219
 220   if ($hit) {
 221     my $new_text = $self->parse_block($block, @indices);
 222     if (!defined($new_text)) {
 223       $main::lxdebug->leave_sub();
 224       return undef;
 225     }
 226     $$new_contents .= $new_text;
 227   }
 228
 229   $main::lxdebug->leave_sub();
 230
 231   return 1;
 232 }
 233
 234 1;