Projekt

Allgemein

Profil

Herunterladen (36,1 KB) Statistiken
| Zweig: | Markierung: | Revision:

kivitendo/SL/Template.pm @ 76c486e3

54e4131e Moritz Bunkus
#====================================================================
# LX-Office ERP
# Copyright (C) 2004
# Based on SQL-Ledger Version 2.1.9
# Web http://www.lx-office.org
#
#====================================================================

package SimpleTemplate;

# Parameters:
# 1. The template's file name
# 2. A reference to the Form object
# 3. A reference to the myconfig hash
#
# Returns:
# A new template object
sub new {
my $type = shift;
my $self = {};

bless($self, $type);
$self->_init(@_);

return $self;
}

sub _init {
my $self = shift;

a59350b1 Moritz Bunkus
$self->{source} = shift;
$self->{form} = shift;
$self->{myconfig} = shift;
$self->{userspath} = shift;
54e4131e Moritz Bunkus
a59350b1 Moritz Bunkus
$self->{error} = undef;
36012e7e Moritz Bunkus
$self->{quot_re} = '"';
a59350b1 Moritz Bunkus
$self->set_tag_style('<%', '%>');
}

sub set_tag_style {
5a545036 Moritz Bunkus
my $self = shift;
my $tag_start = shift;
my $tag_end = shift;
a59350b1 Moritz Bunkus
5a545036 Moritz Bunkus
$self->{tag_start} = $tag_start;
$self->{tag_end} = $tag_end;
$self->{tag_start_qm} = quotemeta $tag_start;
$self->{tag_end_qm} = quotemeta $tag_end;

$self->{substitute_vars_re} = "$self->{tag_start_qm}(.+?)$self->{tag_end_qm}";
54e4131e Moritz Bunkus
}

sub cleanup {
my ($self) = @_;
}

# Parameters:
# 1. A typeglob for the file handle. The output will be written
# to this file handle.
#
# Returns:
# 1 on success and undef or 0 if there was an error. In the latter case
# the calling function can retrieve the error message via $obj->get_error()
sub parse {
my $self = $_[0];
local *OUT = $_[1];

print(OUT "Hallo!\n");
}

sub get_error {
my $self = shift;

return $self->{"error"};
}

sub uses_temp_file {
return 0;
}

9c63c160 Moritz Bunkus
sub _get_loop_variable {
my $self = shift;
my $var = shift;
my $get_array = shift;
my @indices = @_;
5a545036 Moritz Bunkus
9c63c160 Moritz Bunkus
my $form = $self->{form};
my $value;

if (($get_array || @indices) && (ref $form->{TEMPLATE_ARRAYS} eq 'HASH') && (ref $form->{TEMPLATE_ARRAYS}->{$var} eq 'ARRAY')) {
$value = $form->{TEMPLATE_ARRAYS}->{$var};
} else {
$value = $form->{$var};
}
5a545036 Moritz Bunkus
for (my $i = 0; $i < scalar(@indices); $i++) {
last unless (ref($value) eq "ARRAY");
$value = $value->[$indices[$i]];
}

return $value;
}

sub substitute_vars {
my ($self, $text, @indices) = @_;

my $form = $self->{"form"};

while ($text =~ /$self->{substitute_vars_re}/) {
my ($tag_pos, $tag_len) = ($-[0], $+[0] - $-[0]);
my ($var, @options) = split(/\s+/, $1);

9c63c160 Moritz Bunkus
my $value = $self->_get_loop_variable($var, 0, @indices);
5a545036 Moritz Bunkus
$value = $self->format_string($value) unless (grep(/^NOESCAPE$/, @options));

substr($text, $tag_pos, $tag_len, $value);
}

return $text;
}

36012e7e Moritz Bunkus
sub _parse_block_if {
$main::lxdebug->enter_sub();

my $self = shift;
my $contents = shift;
my $new_contents = shift;
my $pos_if = shift;
my @indices = @_;

$$new_contents .= $self->substitute_vars(substr($$contents, 0, $pos_if), @indices);
substr($$contents, 0, $pos_if) = "";

if ($$contents !~ m/^$self->{tag_start_qm}if
\s*
(not\b|\!)? # $1 -- Eventuelle Negierung
\s+
(\b.+?\b) # $2 -- Name der zu ?berpr?fenden Variablen
( # $3 -- Beginn des optionalen Vergleiches
\s*
([!=]) # $4 -- Negierung des Vergleiches speichern
([=~]) # $5 -- Art des Vergleiches speichern
\s*
( # $6 -- Gequoteter String oder Bareword
$self->{quot_re}
(.*?)(?<!\\) # $7 -- Gequoteter String -- direkter Vergleich mit eq bzw. ne oder Patternmatching; Escapete Anf?hrungs als Teil des Strings belassen
$self->{quot_re}
|
(\b.+?\b) # $8 -- Bareword -- als Index f?r $form benutzen
)
)?
\s*
$self->{tag_end_qm}
/x) {
$self->{"error"} = "Malformed $self->{tag_start}if$self->{tag_end}.";
$main::lxdebug->leave_sub();
return undef;
}

my $not = $1;
my $var = $2;
my $operator_neg = $4; # '=' oder '!' oder undef, wenn kein Vergleich erkannt
my $operator_type = $5; # '=' oder '~' f?r Stringvergleich oder Regex
my $quoted_word = $7; # nur g?ltig, wenn quoted string angegeben (siehe unten); dann "value" aus <%if var == "value" %>
my $bareword = $8; # undef, falls quoted string angegeben wurde; andernfalls "othervar" aus <%if var == othervar %>

$not = !$not if ($operator_neg && $operator_neg eq '!');

substr($$contents, 0, length($&)) = "";

my $block;
($block, $$contents) = $self->find_end($$contents, 0, $var, $not);
if (!$block) {
$self->{"error"} = "Unclosed $self->{tag_start}if$self->{tag_end}." unless ($self->{"error"});
$main::lxdebug->leave_sub();
return undef;
}

my $value = $self->_get_loop_variable($var, 0, @indices);
my $hit = 0;

if ($operator_type) {
my $compare_to = $bareword ? $self->_get_loop_variable($bareword, 0, @indices) : $quoted_word;
if ($operator_type eq '=') {
$hit = ($not && !($value eq $compare_to)) || (!$not && ($value eq $compare_to));
} else {
$hit = ($not && !($value =~ m/$compare_to/i)) || (!$not && ($value =~ m/$compare_to/i));
}

} else {
$hit = ($not && ! $value) || (!$not && $value);
}

if ($hit) {
my $new_text = $self->parse_block($block, @indices);
if (!defined($new_text)) {
$main::lxdebug->leave_sub();
return undef;
}
$$new_contents .= $new_text;
}

$main::lxdebug->leave_sub();

return 1;
}

54e4131e Moritz Bunkus
1;

####
#### LaTeXTemplate
####

package LaTeXTemplate;

use vars qw(@ISA);

@ISA = qw(SimpleTemplate);

sub new {
my $type = shift;

5a545036 Moritz Bunkus
my $self = $type->SUPER::new(@_);

return $self;
54e4131e Moritz Bunkus
}

sub format_string {
my ($self, $variable) = @_;
my $form = $self->{"form"};

dc3cd296 Moritz Bunkus
$variable = $main::locale->quote_special_chars('Template/LaTeX', $variable);
54e4131e Moritz Bunkus
# Allow some HTML markup to be converted into the output format's
# corresponding markup code, e.g. bold or italic.
my %markup_replace = ('b' => 'textbf',
'i' => 'textit',
'u' => 'underline');

foreach my $key (keys(%markup_replace)) {
my $new = $markup_replace{$key};
$variable =~ s/\$\<\$${key}\$\>\$(.*?)\$<\$\/${key}\$>\$/\\${new}\{$1\}/gi;
}

fedfcc67 Moritz Bunkus
$variable =~ s/[\x00-\x1f]//g;

54e4131e Moritz Bunkus
return $variable;
}

6744758d Moritz Bunkus
sub parse_foreach {
my ($self, $var, $text, $start_tag, $end_tag, @indices) = @_;
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
my ($form, $new_contents) = ($self->{"form"}, "");
54e4131e Moritz Bunkus
9c63c160 Moritz Bunkus
my $ary = $self->_get_loop_variable($var, 1, @indices);
54e4131e Moritz Bunkus
59e92128 Moritz Bunkus
my $sum = 0;
my $current_page = 1;
6744758d Moritz Bunkus
my ($current_line, $corrent_row) = (0, 1);
59e92128 Moritz Bunkus
my $description_array = $self->_get_loop_variable("description", 1);
my $longdescription_array = $self->_get_loop_variable("longdescription", 1);
fbc3a232 Moritz Bunkus
my $linetotal_array = $self->_get_loop_variable("linetotal", 1);

$form->{TEMPLATE_ARRAYS}->{cumulatelinetotal} = [];
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
for (my $i = 0; $i < scalar(@{$ary}); $i++) {
59e92128 Moritz Bunkus
$form->{"__first__"} = $i == 1;
$form->{"__last__"} = ($i + 1) == scalar(@{$ary});
$form->{"__odd__"} = (($i + 1) % 2) == 1;
6744758d Moritz Bunkus
$form->{"__counter__"} = $i + 1;

67cecc96 Sven Schöling
if (scalar @{$description_array} == scalar @{$ary} && $self->{"chars_per_line"} != 0) {
my $lines = int(length($description_array->[$i]) / $self->{"chars_per_line"});
6744758d Moritz Bunkus
my $lpp;

67cecc96 Sven Schöling
$description_array->[$i] =~ s/(\\newline\s?)*$//;
my $_description = $description_array->[$i];
6744758d Moritz Bunkus
while ($_description =~ /\\newline/) {
$lines++;
$_description =~ s/\\newline//;
}
$lines++;
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
if ($current_page == 1) {
$lpp = $self->{"lines_on_first_page"};
} else {
$lpp = $self->{"lines_on_second_page"};
54e4131e Moritz Bunkus
}

6744758d Moritz Bunkus
# Yes we need a manual page break -- or the user has forced one
67cecc96 Sven Schöling
if ((($current_line + $lines) > $lpp) || ($description_array->[$i] =~ /<pagebreak>/) || ($longdescription_array->[$i] =~ /<pagebreak>/)) {
6744758d Moritz Bunkus
my $pb = $self->{"pagebreak_block"};

# replace the special variables <%sumcarriedforward%>
# and <%lastpage%>

02129bcf Moritz Bunkus
my $psum = $form->format_amount($self->{"myconfig"}, $sum, 2);
a59350b1 Moritz Bunkus
$pb =~ s/$self->{tag_start_qm}sumcarriedforward$self->{tag_end_qm}/$psum/g;
$pb =~ s/$self->{tag_start_qm}lastpage$self->{tag_end_qm}/$current_page/g;
6744758d Moritz Bunkus
my $new_text = $self->parse_block($pb, (@indices, $i));
return undef unless (defined($new_text));
$new_contents .= $new_text;

$current_page++;
$current_line = 0;
54e4131e Moritz Bunkus
}
6744758d Moritz Bunkus
$current_line += $lines;
}
fbc3a232 Moritz Bunkus
if ($i < scalar(@{$linetotal_array})) {
$sum += $form->parse_amount($self->{"myconfig"}, $linetotal_array->[$i]);
6744758d Moritz Bunkus
}
526173c2 Sven Schöling
fbc3a232 Moritz Bunkus
$form->{TEMPLATE_ARRAYS}->{cumulatelinetotal}->[$i] = $form->format_amount($self->{"myconfig"}, $sum, 2);
526173c2 Sven Schöling
6744758d Moritz Bunkus
my $new_text = $self->parse_block($text, (@indices, $i));
return undef unless (defined($new_text));
$new_contents .= $start_tag . $new_text . $end_tag;
}
map({ delete($form->{"__${_}__"}); } qw(first last odd counter));
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
return $new_contents;
}
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
sub find_end {
my ($self, $text, $pos, $var, $not) = @_;
54e4131e Moritz Bunkus
a59350b1 Moritz Bunkus
my $tag_start_len = length $self->{tag_start};

6744758d Moritz Bunkus
my $depth = 1;
$pos = 0 unless ($pos);
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
while ($pos < length($text)) {
$pos++;
54e4131e Moritz Bunkus
a59350b1 Moritz Bunkus
next if (substr($text, $pos - 1, length($self->{tag_start})) ne $self->{tag_start});
54e4131e Moritz Bunkus
a59350b1 Moritz Bunkus
my $keyword_pos = $pos - 1 + $tag_start_len;

if ((substr($text, $keyword_pos, 2) eq 'if') || (substr($text, $keyword_pos, 3) eq 'for')) {
6744758d Moritz Bunkus
$depth++;
54e4131e Moritz Bunkus
a59350b1 Moritz Bunkus
} elsif ((substr($text, $keyword_pos, 4) eq 'else') && (1 == $depth)) {
6744758d Moritz Bunkus
if (!$var) {
a59350b1 Moritz Bunkus
$self->{"error"} =
"$self->{tag_start}else$self->{tag_end} outside of "
. "$self->{tag_start}if$self->{tag_end} / "
. "$self->{tag_start}ifnot$self->{tag_end}.";
6744758d Moritz Bunkus
return undef;
}

my $block = substr($text, 0, $pos - 1);
substr($text, 0, $pos - 1) = "";
a59350b1 Moritz Bunkus
$text =~ s!^$self->{tag_start_qm}.+?$self->{tag_end_qm}!!;
$text = $self->{tag_start} . 'if' . ($not ? " " : "not ") . $var . $self->{tag_end} . $text;
6744758d Moritz Bunkus
return ($block, $text);

a59350b1 Moritz Bunkus
} elsif (substr($text, $keyword_pos, 3) eq 'end') {
6744758d Moritz Bunkus
$depth--;
if ($depth == 0) {
my $block = substr($text, 0, $pos - 1);
substr($text, 0, $pos - 1) = "";
a59350b1 Moritz Bunkus
$text =~ s!^$self->{tag_start_qm}.+?$self->{tag_end_qm}!!;
6744758d Moritz Bunkus
return ($block, $text);
54e4131e Moritz Bunkus
}
}
6744758d Moritz Bunkus
}
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
return undef;
}
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
sub parse_block {
$main::lxdebug->enter_sub();
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
my ($self, $contents, @indices) = @_;
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
my $new_contents = "";
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
while ($contents ne "") {
a59350b1 Moritz Bunkus
my $pos_if = index($contents, $self->{tag_start} . 'if');
my $pos_foreach = index($contents, $self->{tag_start} . 'foreach');
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
if ((-1 == $pos_if) && (-1 == $pos_foreach)) {
$new_contents .= $self->substitute_vars($contents, @indices);
last;
54e4131e Moritz Bunkus
}

6744758d Moritz Bunkus
if ((-1 == $pos_if) || ((-1 != $pos_foreach) && ($pos_if > $pos_foreach))) {
$new_contents .= $self->substitute_vars(substr($contents, 0, $pos_foreach), @indices);
substr($contents, 0, $pos_foreach) = "";
54e4131e Moritz Bunkus
a59350b1 Moritz Bunkus
if ($contents !~ m|^$self->{tag_start_qm}foreach (.+?)$self->{tag_end_qm}|) {
$self->{"error"} = "Malformed $self->{tag_start}foreach$self->{tag_end}.";
6744758d Moritz Bunkus
$main::lxdebug->leave_sub();
return undef;
}
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
my $var = $1;
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
substr($contents, 0, length($&)) = "";
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
my $block;
($block, $contents) = $self->find_end($contents);
if (!$block) {
a59350b1 Moritz Bunkus
$self->{"error"} = "Unclosed $self->{tag_start}foreach$self->{tag_end}." unless ($self->{"error"});
6744758d Moritz Bunkus
$main::lxdebug->leave_sub();
return undef;
}
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
my $new_text = $self->parse_foreach($var, $block, "", "", @indices);
if (!defined($new_text)) {
$main::lxdebug->leave_sub();
return undef;
}
$new_contents .= $new_text;

} else {
36012e7e Moritz Bunkus
if (!$self->_parse_block_if(\$contents, \$new_contents, $pos_if, @indices)) {
6744758d Moritz Bunkus
$main::lxdebug->leave_sub();
return undef;
}
54e4131e Moritz Bunkus
}
6744758d Moritz Bunkus
}
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
$main::lxdebug->leave_sub();
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
return $new_contents;
}
54e4131e Moritz Bunkus
a59350b1 Moritz Bunkus
sub parse_first_line {
my $self = shift;
my $line = shift || "";

if ($line =~ m/([^\s]+)set-tag-style([^\s]+)/) {
if ($1 eq $2) {
$self->{error} = "The tag start and end markers must not be equal.";
return 0;
}

$self->set_tag_style($1, $2);
}

return 1;
}

5ada8632 Moritz Bunkus
sub _parse_config_option {
my $self = shift;
my $line = shift;

$line =~ s/^\s*//;
$line =~ s/\s*$//;

my ($key, $value) = split m/\s*=\s*/, $line, 2;

if ($key eq 'tag-style') {
$self->set_tag_style(split(m/\s+/, $value, 2));
}
}

sub _parse_config_lines {
my $self = shift;
my $lines = shift;

my ($comment_start, $comment_end) = ("", "");

if (ref $self eq 'LaTeXTemplate') {
$comment_start = '\s*%';
} elsif (ref $self eq 'HTMLTemplate') {
$comment_start = '\s*<!--';
$comment_end = '>\s*';
} else {
$comment_start = '\s*\#';
}

my $num_lines = scalar @{ $lines };
my $i = 0;

while ($i < $num_lines) {
my $line = $lines->[$i];

if ($line !~ m/^${comment_start}\s*config\s*:(.*)${comment_end}$/i) {
$i++;
next;
}

$self->_parse_config_option($1);
splice @{ $lines }, $i, 1;
$num_lines--;
}
}

e7361d77 Moritz Bunkus
sub _force_mandatory_packages {
my $self = shift;
my $lines = shift;

my (%used_packages, $document_start_line);

foreach my $i (0 .. scalar @{ $lines } - 1) {
66020684 Sven Schöling
if ($lines->[$i] =~ m/\\usepackage[^\{]*{(.*?)}/) {
e7361d77 Moritz Bunkus
$used_packages{$1} = 1;

} elsif ($lines->[$i] =~ m/\\begin{document}/) {
$document_start_line = $i;
last;

}
}

$document_start_line = scalar @{ $lines } - 1 if (!defined $document_start_line);

if (!$used_packages{textcomp}) {
splice @{ $lines }, $document_start_line, 0, "\\usepackage{textcomp}\n";
$document_start_line++;
}
}

6744758d Moritz Bunkus
sub parse {
my $self = $_[0];
local *OUT = $_[1];
my $form = $self->{"form"};
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
if (!open(IN, "$form->{templates}/$form->{IN}")) {
$self->{"error"} = "$!";
return 0;
}
a59350b1 Moritz Bunkus
my @lines = <IN>;
6744758d Moritz Bunkus
close(IN);
54e4131e Moritz Bunkus
5ada8632 Moritz Bunkus
$self->_parse_config_lines(\@lines);
f6a2cdd5 Moritz Bunkus
$self->_force_mandatory_packages(\@lines) if (ref $self eq 'LaTeXTemplate');
a59350b1 Moritz Bunkus
my $contents = join("", @lines);
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
# detect pagebreak block and its parameters
a59350b1 Moritz Bunkus
if ($contents =~ /$self->{tag_start_qm}pagebreak\s+(\d+)\s+(\d+)\s+(\d+)\s*$self->{tag_end_qm}(.*?)$self->{tag_start_qm}end(\s*pagebreak)?$self->{tag_end_qm}/s) {
6744758d Moritz Bunkus
$self->{"chars_per_line"} = $1;
$self->{"lines_on_first_page"} = $2;
$self->{"lines_on_second_page"} = $3;
$self->{"pagebreak_block"} = $4;
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
substr($contents, length($`), length($&)) = "";
54e4131e Moritz Bunkus
}

6744758d Moritz Bunkus
$self->{"forced_pagebreaks"} = [];

my $new_contents = $self->parse_block($contents);
if (!defined($new_contents)) {
$main::lxdebug->leave_sub();
return 0;
}

print(OUT $new_contents);

54e4131e Moritz Bunkus
if ($form->{"format"} =~ /postscript/i) {
5235a527 Moritz Bunkus
return $self->convert_to_postscript();
54e4131e Moritz Bunkus
} elsif ($form->{"format"} =~ /pdf/i) {
5235a527 Moritz Bunkus
return $self->convert_to_pdf();
54e4131e Moritz Bunkus
} else {
return 1;
}
}

sub convert_to_postscript {
5235a527 Moritz Bunkus
my ($self) = @_;
54e4131e Moritz Bunkus
my ($form, $userspath) = ($self->{"form"}, $self->{"userspath"});

# Convert the tex file to postscript

if (!chdir("$userspath")) {
$self->{"error"} = "chdir : $!";
$self->cleanup();
return 0;
}

5cf977e5 Moritz Bunkus
$form->{tmpfile} =~ s/\Q$userspath\E\///g;
54e4131e Moritz Bunkus
ba233a63 Moritz Bunkus
my $latex = $self->_get_latex_path();

5235a527 Moritz Bunkus
for (my $run = 1; $run <= 2; $run++) {
ba233a63 Moritz Bunkus
system("${latex} --interaction=nonstopmode $form->{tmpfile} " .
54e4131e Moritz Bunkus
"> $form->{tmpfile}.err");
if ($?) {
$self->{"error"} = $form->cleanup();
$self->cleanup();
return 0;
}
}

$form->{tmpfile} =~ s/tex$/dvi/;

system("dvips $form->{tmpfile} -o -q > /dev/null");
if ($?) {
$self->{"error"} = "dvips : $!";
$self->cleanup();
return 0;
}
$form->{tmpfile} =~ s/dvi$/ps/;

$self->cleanup();

return 1;
}

sub convert_to_pdf {
5235a527 Moritz Bunkus
my ($self) = @_;
54e4131e Moritz Bunkus
my ($form, $userspath) = ($self->{"form"}, $self->{"userspath"});

# Convert the tex file to PDF

if (!chdir("$userspath")) {
$self->{"error"} = "chdir : $!";
$self->cleanup();
return 0;
}

5cf977e5 Moritz Bunkus
$form->{tmpfile} =~ s/\Q$userspath\E\///g;
54e4131e Moritz Bunkus
ba233a63 Moritz Bunkus
my $latex = $self->_get_latex_path();

5235a527 Moritz Bunkus
for (my $run = 1; $run <= 2; $run++) {
ba233a63 Moritz Bunkus
system("${latex} --interaction=nonstopmode $form->{tmpfile} " .
54e4131e Moritz Bunkus
"> $form->{tmpfile}.err");
if ($?) {
$self->{"error"} = $form->cleanup();
$self->cleanup();
return 0;
}
}

$form->{tmpfile} =~ s/tex$/pdf/;

$self->cleanup();
}

ba233a63 Moritz Bunkus
sub _get_latex_path {
return $main::latex_bin || 'pdflatex';
}

54e4131e Moritz Bunkus
sub get_mime_type() {
my ($self) = @_;

if ($self->{"form"}->{"format"} =~ /postscript/i) {
return "application/postscript";
} else {
return "application/pdf";
}
}

sub uses_temp_file {
return 1;
}


####
#### HTMLTemplate
####

package HTMLTemplate;

use vars qw(@ISA);

@ISA = qw(LaTeXTemplate);

sub new {
my $type = shift;

return $type->SUPER::new(@_);
}

sub format_string {
my ($self, $variable) = @_;
my $form = $self->{"form"};

dc3cd296 Moritz Bunkus
$variable = $main::locale->quote_special_chars('Template/HTML', $variable);
54e4131e Moritz Bunkus
# Allow some HTML markup to be converted into the output format's
# corresponding markup code, e.g. bold or italic.
6744758d Moritz Bunkus
my @markup_replace = ('b', 'i', 's', 'u', 'sub', 'sup');
54e4131e Moritz Bunkus
foreach my $key (@markup_replace) {
$variable =~ s/\&lt;(\/?)${key}\&gt;/<$1${key}>/g;
}

return $variable;
}

sub get_mime_type() {
6744758d Moritz Bunkus
my ($self) = @_;

if ($self->{"form"}->{"format"} =~ /postscript/i) {
return "application/postscript";
} elsif ($self->{"form"}->{"format"} =~ /pdf/i) {
return "application/pdf";
} else {
return "text/html";
}
54e4131e Moritz Bunkus
}

sub uses_temp_file {
6744758d Moritz Bunkus
my ($self) = @_;

if ($self->{"form"}->{"format"} =~ /postscript/i) {
return 1;
} elsif ($self->{"form"}->{"format"} =~ /pdf/i) {
return 1;
} else {
return 0;
}
}

sub convert_to_postscript {
my ($self) = @_;
my ($form, $userspath) = ($self->{"form"}, $self->{"userspath"});

# Convert the HTML file to postscript

if (!chdir("$userspath")) {
$self->{"error"} = "chdir : $!";
$self->cleanup();
return 0;
}

5cf977e5 Moritz Bunkus
$form->{"tmpfile"} =~ s/\Q$userspath\E\///g;
6744758d Moritz Bunkus
my $psfile = $form->{"tmpfile"};
$psfile =~ s/.html/.ps/;
if ($psfile eq $form->{"tmpfile"}) {
$psfile .= ".ps";
}

system("html2ps -f html2ps-config < $form->{tmpfile} > $psfile");
if ($?) {
$self->{"error"} = $form->cleanup();
$self->cleanup();
return 0;
}

$form->{"tmpfile"} = $psfile;

$self->cleanup();

return 1;
54e4131e Moritz Bunkus
}

6744758d Moritz Bunkus
sub convert_to_pdf {
my ($self) = @_;
my ($form, $userspath) = ($self->{"form"}, $self->{"userspath"});

# Convert the HTML file to PDF

if (!chdir("$userspath")) {
$self->{"error"} = "chdir : $!";
$self->cleanup();
return 0;
}

5cf977e5 Moritz Bunkus
$form->{"tmpfile"} =~ s/\Q$userspath\E\///g;
6744758d Moritz Bunkus
my $pdffile = $form->{"tmpfile"};
$pdffile =~ s/.html/.pdf/;
if ($pdffile eq $form->{"tmpfile"}) {
$pdffile .= ".pdf";
}

system("html2ps -f html2ps-config < $form->{tmpfile} | ps2pdf - $pdffile");
if ($?) {
$self->{"error"} = $form->cleanup();
$self->cleanup();
return 0;
}

$form->{"tmpfile"} = $pdffile;

$self->cleanup();

return 1;
}
54e4131e Moritz Bunkus

c03fba33 Moritz Bunkus
####
#### PlainTextTemplate
####

package PlainTextTemplate;

use vars qw(@ISA);

@ISA = qw(LaTeXTemplate);

sub new {
my $type = shift;

return $type->SUPER::new(@_);
}

sub format_string {
my ($self, $variable) = @_;

return $variable;
}

sub get_mime_type {
return "text/plain";
}

sub parse {
}

1;

54e4131e Moritz Bunkus
####
d9fcfd9a Udo Spallek
#### OpenDocumentTemplate
54e4131e Moritz Bunkus
####

package OpenDocumentTemplate;

6744758d Moritz Bunkus
use POSIX 'setsid';
54e4131e Moritz Bunkus
use vars qw(@ISA);

use Cwd;
# use File::Copy;
# use File::Spec;
# use File::Temp qw(:mktemp);
use IO::File;

@ISA = qw(SimpleTemplate);

sub new {
my $type = shift;

$self = $type->SUPER::new(@_);

foreach my $module (qw(Archive::Zip Text::Iconv)) {
eval("use ${module};");
if ($@) {
$self->{"form"}->error("The Perl module '${module}' could not be " .
"loaded. Support for OpenDocument templates " .
"does not work without it. Please install your " .
"distribution's package or get the module from " .
"CPAN ( http://www.cpan.org ).");
}
}

5a545036 Moritz Bunkus
$self->{"rnd"} = int(rand(1000000));
54e4131e Moritz Bunkus
$self->{"iconv"} = Text::Iconv->new($main::dbcharset, "UTF-8");

5a545036 Moritz Bunkus
$self->set_tag_style('&lt;%', '%&gt;');
36012e7e Moritz Bunkus
$self->{quot_re} = '&quot;';
54e4131e Moritz Bunkus
5a545036 Moritz Bunkus
return $self;
54e4131e Moritz Bunkus
}

sub parse_foreach {
my ($self, $var, $text, $start_tag, $end_tag, @indices) = @_;

my ($form, $new_contents) = ($self->{"form"}, "");

9c63c160 Moritz Bunkus
my $ary = $self->_get_loop_variable($var, 1, @indices);
54e4131e Moritz Bunkus
for (my $i = 0; $i < scalar(@{$ary}); $i++) {
6744758d Moritz Bunkus
$form->{"__first__"} = $i == 0;
$form->{"__last__"} = ($i + 1) == scalar(@{$ary});
$form->{"__odd__"} = (($i + 1) % 2) == 1;
$form->{"__counter__"} = $i + 1;
54e4131e Moritz Bunkus
my $new_text = $self->parse_block($text, (@indices, $i));
return undef unless (defined($new_text));
$new_contents .= $start_tag . $new_text . $end_tag;
}
6744758d Moritz Bunkus
map({ delete($form->{"__${_}__"}); } qw(first last odd counter));
54e4131e Moritz Bunkus
return $new_contents;
}

6744758d Moritz Bunkus
sub find_end {
my ($self, $text, $pos, $var, $not) = @_;

my $depth = 1;
$pos = 0 unless ($pos);

while ($pos < length($text)) {
$pos++;

next if (substr($text, $pos - 1, 5) ne '&lt;%');

if ((substr($text, $pos + 4, 2) eq 'if') || (substr($text, $pos + 4, 3) eq 'for')) {
$depth++;

} elsif ((substr($text, $pos + 4, 4) eq 'else') && (1 == $depth)) {
if (!$var) {
$self->{"error"} = '<%else%> outside of <%if%> / <%ifnot%>.';
return undef;
}

my $block = substr($text, 0, $pos - 1);
substr($text, 0, $pos - 1) = "";
$text =~ s!^\&lt;\%[^\%]+\%\&gt;!!;
$text = '&lt;%if' . ($not ? " " : "not ") . $var . '%&gt;' . $text;

return ($block, $text);

} elsif (substr($text, $pos + 4, 3) eq 'end') {
$depth--;
if ($depth == 0) {
my $block = substr($text, 0, $pos - 1);
substr($text, 0, $pos - 1) = "";
$text =~ s!^\&lt;\%[^\%]+\%\&gt;!!;

return ($block, $text);
}
}
}

return undef;
}

54e4131e Moritz Bunkus
sub parse_block {
$main::lxdebug->enter_sub();

my ($self, $contents, @indices) = @_;

my $new_contents = "";

while ($contents ne "") {
if (substr($contents, 0, 1) eq "<") {
$contents =~ m|^<[^>]+>|;
my $tag = $&;
substr($contents, 0, length($&)) = "";

if ($tag =~ m|<table:table-row|) {
$contents =~ m|^(.*?)(</table:table-row[^>]*>)|;
my $table_row = $1;
my $end_tag = $2;
substr($contents, 0, length($1) + length($end_tag)) = "";

if ($table_row =~ m|\&lt;\%foreachrow\s+(.*?)\%\&gt;|) {
my $var = $1;

6744758d Moritz Bunkus
substr($table_row, length($`), length($&)) = "";

my ($t1, $t2) = $self->find_end($table_row, length($`));
if (!$t1) {
$self->{"error"} = "Unclosed <\%foreachrow\%>." unless ($self->{"error"});
$main::lxdebug->leave_sub();
return undef;
}
54e4131e Moritz Bunkus
6744758d Moritz Bunkus
my $new_text = $self->parse_foreach($var, $t1 . $t2, $tag, $end_tag, @indices);
if (!defined($new_text)) {
$main::lxdebug->leave_sub();
return undef;
}
54e4131e Moritz Bunkus
$new_contents .= $new_text;

} else {
my $new_text = $self->parse_block($table_row, @indices);
6744758d Moritz Bunkus
if (!defined($new_text)) {
$main::lxdebug->leave_sub();
return undef;
}
54e4131e Moritz Bunkus
$new_contents .= $tag . $new_text . $end_tag;
}

} else {
$new_contents .= $tag;
}

} else {
$contents =~ /^[^<]+/;
my $text = $&;

my $pos_if = index($text, '&lt;%if');
my $pos_foreach = index($text, '&lt;%foreach');

if ((-1 == $pos_if) && (-1 == $pos_foreach)) {
substr($contents, 0, length($text)) = "";
$new_contents .= $self->substitute_vars($text, @indices);
next;
}

if ((-1 == $pos_if) || ((-1 != $pos_foreach) && ($pos_if > $pos_foreach))) {
$new_contents .= $self->substitute_vars(substr($contents, 0, $pos_foreach), @indices);
substr($contents, 0, $pos_foreach) = "";

if ($contents !~ m|^\&lt;\%foreach (.*?)\%\&gt;|) {
$self->{"error"} = "Malformed <\%foreach\%>.";
$main::lxdebug->leave_sub();
return undef;
}

my $var = $1;

substr($contents, 0, length($&)) = "";

6744758d Moritz Bunkus
my $block;
($block, $contents) = $self->find_end($contents);
if (!$block) {
$self->{"error"} = "Unclosed <\%foreach\%>." unless ($self->{"error"});
54e4131e Moritz Bunkus
$main::lxdebug->leave_sub();
return undef;
}

6744758d Moritz Bunkus
my $new_text = $self->parse_foreach($var, $block, "", "", @indices);
if (!defined($new_text)) {
$main::lxdebug->leave_sub();
return undef;
}
54e4131e Moritz Bunkus
$new_contents .= $new_text;

} else {
36012e7e Moritz Bunkus
if (!$self->_parse_block_if(\$contents, \$new_contents, $pos_if, @indices)) {
54e4131e Moritz Bunkus
$main::lxdebug->leave_sub();
return undef;
}
}
}
}

6744758d Moritz Bunkus
$main::lxdebug->leave_sub();

54e4131e Moritz Bunkus
return $new_contents;
}

sub parse {
$main::lxdebug->enter_sub();

my $self = $_[0];
local *OUT = $_[1];
my $form = $self->{"form"};

close(OUT);

6744758d Moritz Bunkus
my $file_name;
if ($form->{"IN"} =~ m|^/|) {
$file_name = $form->{"IN"};
} else {
$file_name = $form->{"templates"} . "/" . $form->{"IN"};
}

54e4131e Moritz Bunkus
my $zip = Archive::Zip->new();
6744758d Moritz Bunkus
if (Archive::Zip::AZ_OK != $zip->read($file_name)) {
54e4131e Moritz Bunkus
$self->{"error"} = "File not found/is not a OpenDocument file.";
$main::lxdebug->leave_sub();
return 0;
}

my $contents = $zip->contents("content.xml");
if (!$contents) {
$self->{"error"} = "File is not a OpenDocument file.";
$main::lxdebug->leave_sub();
return 0;
}

my $rnd = $self->{"rnd"};
my $new_styles = qq|<style:style style:name="TLXO${rnd}BOLD" style:family="text">
<style:text-properties fo:font-weight="bold" style:font-weight-asian="bold" style:font-weight-complex="bold"/>
</style:style>
<style:style style:name="TLXO${rnd}ITALIC" style:family="text">
<style:text-properties fo:font-style="italic" style:font-style-asian="italic" style:font-style-complex="italic"/>
</style:style>
<style:style style:name="TLXO${rnd}UNDERLINE" style:family="text">
<style:text-properties style:text-underline-style="solid" style:text-underline-width="auto" style:text-underline-color="font-color"/>
</style:style>
<style:style style:name="TLXO${rnd}STRIKETHROUGH" style:family="text">
<style:text-properties style:text-line-through-style="solid"/>
6744758d Moritz Bunkus
</style:style>
<style:style style:name="TLXO${rnd}SUPER" style:family="text">
<style:text-properties style:text-position="super 58%"/>
</style:style>
<style:style style:name="TLXO${rnd}SUB" style:family="text">
<style:text-properties style:text-position="sub 58%"/>
</style:style>
|;
54e4131e Moritz Bunkus
$contents =~ s|</office:automatic-styles>|${new_styles}</office:automatic-styles>|;
$contents =~ s|[\n\r]||gm;

my $new_contents = $self->parse_block($contents);
6744758d Moritz Bunkus
if (!defined($new_contents)) {
$main::lxdebug->leave_sub();
return 0;
}
54e4131e Moritz Bunkus
# $new_contents =~ s|>|>\n|g;

$zip->contents("content.xml", $new_contents);
6744758d Moritz Bunkus
my $styles = $zip->contents("styles.xml");
if ($contents) {
my $new_styles = $self->parse_block($styles);
if (!defined($new_contents)) {
$main::lxdebug->leave_sub();
return 0;
}
$zip->contents("styles.xml", $new_styles);
}

54e4131e Moritz Bunkus
$zip->writeToFileNamed($form->{"tmpfile"}, 1);

my $res = 1;
if ($form->{"format"} =~ /pdf/) {
$res = $self->convert_to_pdf();
}

$main::lxdebug->leave_sub();
return $res;
}

6744758d Moritz Bunkus
sub is_xvfb_running {
$main::lxdebug->enter_sub();

my ($self) = @_;

local *IN;
my $dfname = $self->{"userspath"} . "/xvfb_display";
my $display;

$main::lxdebug->message(LXDebug::DEBUG2, " Looking for $dfname\n");
if ((-f $dfname) && open(IN, $dfname)) {
my $pid = <IN>;
chomp($pid);
$display = <IN>;
chomp($display);
my $xauthority = <IN>;
chomp($xauthority);
close(IN);

$main::lxdebug->message(LXDebug::DEBUG2, " found with $pid and $display\n");

if ((! -d "/proc/$pid") || !open(IN, "/proc/$pid/cmdline")) {
$main::lxdebug->message(LXDebug::DEBUG2, " no/wrong process #1\n");
unlink($dfname, $xauthority);
$main::lxdebug->leave_sub();
return undef;
}
my $line = <IN>;
close(IN);
if ($line !~ /xvfb/i) {
$main::lxdebug->message(LXDebug::DEBUG2, " no/wrong process #2\n");
unlink($dfname, $xauthority);
$main::lxdebug->leave_sub();
return undef;
}

$ENV{"XAUTHORITY"} = $xauthority;
$ENV{"DISPLAY"} = $display;
} else {
$main::lxdebug->message(LXDebug::DEBUG2, " not found\n");
}

$main::lxdebug->leave_sub();

return $display;
}

sub spawn_xvfb {
$main::lxdebug->enter_sub();

my ($self) = @_;

$main::lxdebug->message(LXDebug::DEBUG2, "spawn_xvfb()\n");

my $display = $self->is_xvfb_running();

if ($display) {
$main::lxdebug->leave_sub();
return $display;
}

$display = 99;
while ( -f "/tmp/.X${display}-lock") {
$display++;
}
$display = ":${display}";
$main::lxdebug->message(LXDebug::DEBUG2, " display $display\n");

my $mcookie = `mcookie`;
die("Installation error: mcookie not found.") if ($? != 0);
chomp($mcookie);

$main::lxdebug->message(LXDebug::DEBUG2, " mcookie $mcookie\n");

my $xauthority = "/tmp/.Xauthority-" . $$ . "-" . time() . "-" . int(rand(9999999));
$ENV{"XAUTHORITY"} = $xauthority;

$main::lxdebug->message(LXDebug::DEBUG2, " xauthority $xauthority\n");

system("xauth add \"${display}\" . \"${mcookie}\"");
if ($? != 0) {
$self->{"error"} = "Conversion to PDF failed because OpenOffice could not be started (xauth: $!)";
$main::lxdebug->leave_sub();
return undef;
}

$main::lxdebug->message(LXDebug::DEBUG2, " about to fork()\n");

my $pid = fork();
if (0 == $pid) {
$main::lxdebug->message(LXDebug::DEBUG2, " Child execing\n");
exec($main::xvfb_bin, $display, "-screen", "0", "640x480x8", "-nolisten", "tcp");
}
sleep(3);
$main::lxdebug->message(LXDebug::DEBUG2, " parent dont sleeping\n");

local *OUT;
my $dfname = $self->{"userspath"} . "/xvfb_display";
if (!open(OUT, ">$dfname")) {
$self->{"error"} = "Conversion to PDF failed because OpenOffice could not be started ($dfname: $!)";
unlink($xauthority);
kill($pid);
$main::lxdebug->leave_sub();
return undef;
}
print(OUT "$pid\n$display\n$xauthority\n");
close(OUT);

$main::lxdebug->message(LXDebug::DEBUG2, " parent re-testing\n");

if (!$self->is_xvfb_running()) {
$self->{"error"} = "Conversion to PDF failed because OpenOffice could not be started.";
unlink($xauthority, $dfname);
kill($pid);
$main::lxdebug->leave_sub();
return undef;
}

$main::lxdebug->message(LXDebug::DEBUG2, " spawn OK\n");

$main::lxdebug->leave_sub();

return $display;
}

sub is_openoffice_running {
$main::lxdebug->enter_sub();

system("./scripts/oo-uno-test-conn.py $main::openofficeorg_daemon_port " .
"> /dev/null 2> /dev/null");
my $res = $? == 0;
$main::lxdebug->message(LXDebug::DEBUG2, " is_openoffice_running(): $?\n");

$main::lxdebug->leave_sub();

return $res;
}

sub spawn_openoffice {
$main::lxdebug->enter_sub();

my ($self) = @_;

$main::lxdebug->message(LXDebug::DEBUG2, "spawn_openoffice()\n");

my ($try, $spawned_oo, $res);

$res = 0;
for ($try = 0; $try < 15; $try++) {
if ($self->is_openoffice_running()) {
$res = 1;
last;
}

if (!$spawned_oo) {
my $pid = fork();
if (0 == $pid) {
$main::lxdebug->message(LXDebug::DEBUG2, " Child daemonizing\n");
chdir('/');
open(STDIN, '/dev/null');
open(STDOUT, '>/dev/null');
my $new_pid = fork();
exit if ($new_pid);
my $ssres = setsid();
$main::lxdebug->message(LXDebug::DEBUG2, " Child execing\n");
my @cmdline = ($main::openofficeorg_writer_bin,
"-minimized", "-norestore", "-nologo", "-nolockcheck",
"-headless",
"-accept=socket,host=localhost,port=" .
$main::openofficeorg_daemon_port . ";urp;");
exec(@cmdline);
}

$main::lxdebug->message(LXDebug::DEBUG2, " Parent after fork\n");
$spawned_oo = 1;
sleep(3);
}

sleep($try >= 5 ? 2 : 1);
}

if (!$res) {
$self->{"error"} = "Conversion from OpenDocument to PDF failed because " .
"OpenOffice could not be started.";
}

$main::lxdebug->leave_sub();

return $res;
}

54e4131e Moritz Bunkus
sub convert_to_pdf {
6744758d Moritz Bunkus
$main::lxdebug->enter_sub();

54e4131e Moritz Bunkus
my ($self) = @_;

my $form = $self->{"form"};

my $filename = $form->{"tmpfile"};
$filename =~ s/.odt$//;
if (substr($filename, 0, 1) ne "/") {
$filename = getcwd() . "/${filename}";
}

if (substr($self->{"userspath"}, 0, 1) eq "/") {
$ENV{'HOME'} = $self->{"userspath"};
} else {
$ENV{'HOME'} = getcwd() . "/" . $self->{"userspath"};
}

6744758d Moritz Bunkus
if (!$self->spawn_xvfb()) {
$main::lxdebug->leave_sub();
return 0;
}

my @cmdline;
if (!$main::openofficeorg_daemon) {
@cmdline = ($main::openofficeorg_writer_bin,
"-minimized", "-norestore", "-nologo", "-nolockcheck",
"-headless",
"file:${filename}.odt",
"macro://" . (split('/', $filename))[-1] .
"/Standard.Conversion.ConvertSelfToPDF()");
} else {
if (!$self->spawn_openoffice()) {
$main::lxdebug->leave_sub();
return 0;
}

@cmdline = ("./scripts/oo-uno-convert-pdf.py",
$main::openofficeorg_daemon_port,
"${filename}.odt");
}
54e4131e Moritz Bunkus
system(@cmdline);

my $res = $?;
if (0 == $?) {
$form->{"tmpfile"} =~ s/odt$/pdf/;

unlink($filename . ".odt");

$main::lxdebug->leave_sub();
return 1;

}

unlink($filename . ".odt", $filename . ".pdf");
$self->{"error"} = "Conversion from OpenDocument to PDF failed. " .
"Exit code: $res";

$main::lxdebug->leave_sub();
return 0;
}

sub format_string {
my ($self, $variable) = @_;
my $form = $self->{"form"};
my $iconv = $self->{"iconv"};

dc3cd296 Moritz Bunkus
$variable = $main::locale->quote_special_chars('Template/OpenDocument', $variable);
54e4131e Moritz Bunkus
# Allow some HTML markup to be converted into the output format's
# corresponding markup code, e.g. bold or italic.
my $rnd = $self->{"rnd"};
my %markup_replace = ("b" => "BOLD", "i" => "ITALIC", "s" => "STRIKETHROUGH",
6744758d Moritz Bunkus
"u" => "UNDERLINE", "sup" => "SUPER", "sub" => "SUB");
54e4131e Moritz Bunkus
foreach my $key (keys(%markup_replace)) {
my $value = $markup_replace{$key};
29795499 Sven Schöling
$variable =~ s|\&lt;${key}\&gt;|<text:span text:style-name=\"TLXO${rnd}${value}\">|gi; #"
6744758d Moritz Bunkus
$variable =~ s|\&lt;/${key}\&gt;|</text:span>|gi;
54e4131e Moritz Bunkus
}

return $iconv->convert($variable);
}

sub get_mime_type() {
if ($self->{"form"}->{"format"} =~ /pdf/) {
return "application/pdf";
} else {
return "application/vnd.oasis.opendocument.text";
}
}

sub uses_temp_file {
return 1;
}

a43c94fd Udo Spallek
##########################################################
####
#### XMLTemplate
####
##########################################################

526173c2 Sven Schöling
package XMLTemplate;
a43c94fd Udo Spallek
use vars qw(@ISA);

@ISA = qw(HTMLTemplate);

sub new {
#evtl auskommentieren
my $type = shift;

return $type->SUPER::new(@_);
}

sub format_string {
my ($self, $variable) = @_;
my $form = $self->{"form"};

dc3cd296 Moritz Bunkus
$variable = $main::locale->quote_special_chars('Template/XML', $variable);
a43c94fd Udo Spallek
# Allow no markup to be converted into the output format
my @markup_replace = ('b', 'i', 's', 'u', 'sub', 'sup');

foreach my $key (@markup_replace) {
$variable =~ s/\&lt;(\/?)${key}\&gt;//g;
}

return $variable;
}

sub get_mime_type() {
my ($self) = @_;

aa1102e9 Udo Spallek
if ($self->{"form"}->{"format"} =~ /elsterwinston/i) {
a43c94fd Udo Spallek
return "application/xml ";
aa1102e9 Udo Spallek
} elsif ($self->{"form"}->{"format"} =~ /elstertaxbird/i) {
return "application/x-taxbird";
a43c94fd Udo Spallek
} else {
aa1102e9 Udo Spallek
return "text";
a43c94fd Udo Spallek
}
}

sub uses_temp_file {
aa1102e9 Udo Spallek
# tempfile needet for XML Output
a43c94fd Udo Spallek
return 1;
}

54e4131e Moritz Bunkus
1;