X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;ds=sidebyside;f=SL%2FTemplate%2FPlugin%2FL.pm;h=f7ffc11b2d046493c957b99a5f90ee0cc46c4e22;hb=d13408232bfd23d718fee1bc76535196ff409880;hp=40e132a86ee9ee67a313049f60063609abe1339e;hpb=8177c1504c953111d190d91a90523f6042bea711;p=kivitendo-erp.git
diff --git a/SL/Template/Plugin/L.pm b/SL/Template/Plugin/L.pm
index 40e132a86..f7ffc11b2 100644
--- a/SL/Template/Plugin/L.pm
+++ b/SL/Template/Plugin/L.pm
@@ -2,76 +2,534 @@ package SL::Template::Plugin::L;
use base qw( Template::Plugin );
use Template::Plugin;
+use List::MoreUtils qw(apply);
+use List::Util qw(max);
+use Scalar::Util qw(blessed);
use strict;
+{ # This will give you an id for identifying html tags and such.
+ # It's guaranteed to be unique unless you exceed 10 mio calls per request.
+ # Do not use these id's to store information across requests.
+my $_id_sequence = int rand 1e7;
+sub _tag_id {
+ return "id_" . ( $_id_sequence = ($_id_sequence + 1) % 1e7 );
+}
+}
+
+my %_valueless_attributes = map { $_ => 1 } qw(
+ checked compact declare defer disabled ismap multiple noresize noshade nowrap
+ readonly selected
+);
+
+sub _H {
+ my $string = shift;
+ return $::locale->quote_special_chars('HTML', $string);
+}
+
+sub _J {
+ my $string = "" . shift;
+ $string =~ s/\"/\\\"/g;
+ return $string;
+}
+
+sub _hashify {
+ return (@_ && (ref($_[0]) eq 'HASH')) ? %{ $_[0] } : @_;
+}
+
sub new {
- my $class = shift;
- my $context = shift;
+ my ($class, $context, @args) = @_;
+
+ return bless {
+ CONTEXT => $context,
+ }, $class;
+}
+
+sub _context {
+ die 'not an accessor' if @_ > 1;
+ return $_[0]->{CONTEXT};
+}
+
+sub name_to_id {
+ my $self = shift;
+ my $name = shift;
- return bless { }, $class;
+ $name =~ s/[^\w_]/_/g;
+ $name =~ s/_+/_/g;
+
+ return $name;
}
sub attributes {
- my $self = shift;
- my $options = shift || {};
+ my ($self, @slurp) = @_;
+ my %options = _hashify(@slurp);
my @result = ();
- while (my ($name, $value) = each %{ $options }) {
+ while (my ($name, $value) = each %options) {
next unless $name;
- $value ||= '';
- push @result, "${name}=\"" . $::locale->quote_special_chars('HTML', $value) . '"';
+ next if $_valueless_attributes{$name} && !$value;
+ $value = '' if !defined($value);
+ push @result, $_valueless_attributes{$name} ? _H($name) : _H($name) . '="' . _H($value) . '"';
}
return @result ? ' ' . join(' ', @result) : '';
}
sub html_tag {
- my $self = shift;
- my $tag = shift;
- my $content = shift;
- my $attributes = $self->attributes(shift || {});
+ my ($self, $tag, $content, @slurp) = @_;
+ my $attributes = $self->attributes(@slurp);
- return "<${tag}${attributes}/>" unless $content;
+ return "<${tag}${attributes}>" unless defined($content);
return "<${tag}${attributes}>${content}${tag}>";
}
sub select_tag {
- my $self = shift;
- my $name = shift;
- my $options_str = shift;
- my $attributes = shift || {};
+ my $self = shift;
+ my $name = shift;
+ my $options_str = shift;
+ my %attributes = _hashify(@_);
+
+ $attributes{id} ||= $self->name_to_id($name);
+ $options_str = $self->options_for_select($options_str) if ref $options_str;
+
+ return $self->html_tag('select', $options_str, %attributes, name => $name);
+}
+
+sub textarea_tag {
+ my ($self, $name, $content, @slurp) = @_;
+ my %attributes = _hashify(@slurp);
+
+ $attributes{id} ||= $self->name_to_id($name);
+ $attributes{rows} *= 1; # required by standard
+ $attributes{cols} *= 1; # required by standard
+ $content = $content ? _H($content) : '';
+
+ return $self->html_tag('textarea', $content, %attributes, name => $name);
+}
+
+sub checkbox_tag {
+ my ($self, $name, @slurp) = @_;
+ my %attributes = _hashify(@slurp);
+
+ $attributes{id} ||= $self->name_to_id($name);
+ $attributes{value} = 1 unless defined $attributes{value};
+ my $label = delete $attributes{label};
+ my $checkall = delete $attributes{checkall};
+
+ if ($attributes{checked}) {
+ $attributes{checked} = 'checked';
+ } else {
+ delete $attributes{checked};
+ }
+
+ my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'checkbox');
+ $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
+ $code .= $self->javascript(qq|\$('#$attributes{id}').checkall('$checkall');|) if $checkall;
+
+ return $code;
+}
+
+sub radio_button_tag {
+ my $self = shift;
+ my $name = shift;
+ my %attributes = _hashify(@_);
+
+ $attributes{value} = 1 unless defined $attributes{value};
+ $attributes{id} ||= $self->name_to_id($name . "_" . $attributes{value});
+ my $label = delete $attributes{label};
+
+ if ($attributes{checked}) {
+ $attributes{checked} = 'checked';
+ } else {
+ delete $attributes{checked};
+ }
+
+ my $code = $self->html_tag('input', undef, %attributes, name => $name, type => 'radio');
+ $code .= $self->html_tag('label', $label, for => $attributes{id}) if $label;
+
+ return $code;
+}
+
+sub input_tag {
+ my ($self, $name, $value, @slurp) = @_;
+ my %attributes = _hashify(@slurp);
+
+ $attributes{id} ||= $self->name_to_id($name);
+ $attributes{type} ||= 'text';
- $attributes->{name} = $name;
- $attributes->{id} ||= $name;
+ return $self->html_tag('input', undef, %attributes, name => $name, value => $value);
+}
+
+sub hidden_tag {
+ return shift->input_tag(@_, type => 'hidden');
+}
+
+sub div_tag {
+ my ($self, $content, @slurp) = @_;
+ return $self->html_tag('div', $content, @slurp);
+}
+
+sub ul_tag {
+ my ($self, $content, @slurp) = @_;
+ return $self->html_tag('ul', $content, @slurp);
+}
- return $self->html_tag('select', $options_str, $attributes);
+sub li_tag {
+ my ($self, $content, @slurp) = @_;
+ return $self->html_tag('li', $content, @slurp);
+}
+
+sub link {
+ my ($self, $href, $content, @slurp) = @_;
+ my %params = _hashify(@slurp);
+
+ $href ||= '#';
+
+ return $self->html_tag('a', $content, %params, href => $href);
+}
+
+sub submit_tag {
+ my ($self, $name, $value, @slurp) = @_;
+ my %attributes = _hashify(@slurp);
+
+ $attributes{onclick} = "if (confirm('" . delete($attributes{confirm}) . "')) return true; else return false;" if $attributes{confirm};
+
+ return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit');
+}
+
+sub button_tag {
+ my ($self, $onclick, $value, @slurp) = @_;
+ my %attributes = _hashify(@slurp);
+
+ $attributes{id} ||= $self->name_to_id($attributes{name}) if $attributes{name};
+ $attributes{type} ||= 'button';
+
+ return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick);
}
sub options_for_select {
- my $self = shift;
- my $collection = shift;
- my $options = shift || {};
+ my $self = shift;
+ my $collection = shift;
+ my %options = _hashify(@_);
+
+ my $value_key = $options{value} || 'id';
+ my $title_key = $options{title} || $value_key;
+
+ my $value_sub = $options{value_sub};
+ my $title_sub = $options{title_sub};
+
+ my $value_title_sub = $options{value_title_sub};
+
+ my %selected = map { ( $_ => 1 ) } @{ ref($options{default}) eq 'ARRAY' ? $options{default} : defined($options{default}) ? [ $options{default} ] : [] };
+
+ my $access = sub {
+ my ($element, $index, $key, $sub) = @_;
+ my $ref = ref $element;
+ return $sub ? $sub->($element)
+ : !$ref ? $element
+ : $ref eq 'ARRAY' ? $element->[$index]
+ : $ref eq 'HASH' ? $element->{$key}
+ : $element->$key;
+ };
+
+ my @elements = ();
+ push @elements, [ undef, $options{empty_title} || '' ] if $options{with_empty};
+ push @elements, map [
+ $value_title_sub ? @{ $value_title_sub->($_) } : (
+ $access->($_, 0, $value_key, $value_sub),
+ $access->($_, 1, $title_key, $title_sub),
+ )
+ ], @{ $collection } if $collection && ref $collection eq 'ARRAY';
+
+ my $code = '';
+ foreach my $result (@elements) {
+ my %attributes = ( value => $result->[0] );
+ $attributes{selected} = 'selected' if $selected{ defined($result->[0]) ? $result->[0] : '' };
+
+ $code .= $self->html_tag('option', _H($result->[1]), %attributes);
+ }
+
+ return $code;
+}
+
+sub javascript {
+ my ($self, $data) = @_;
+ return $self->html_tag('script', $data, type => 'text/javascript');
+}
+
+sub stylesheet_tag {
+ my $self = shift;
+ my $code = '';
+
+ foreach my $file (@_) {
+ $file .= '.css' unless $file =~ m/\.css$/;
+ $file = "css/${file}" unless $file =~ m|/|;
+
+ $code .= qq||;
+ }
+
+ return $code;
+}
+
+sub date_tag {
+ my ($self, $name, $value, @slurp) = @_;
+ my %params = _hashify(@slurp);
+ my $name_e = _H($name);
+ my $seq = _tag_id();
+ my $datefmt = apply {
+ s/d+/\%d/gi;
+ s/m+/\%m/gi;
+ s/y+/\%Y/gi;
+ } $::myconfig{"dateformat"};
+
+ my $cal_align = delete $params{cal_align} || 'BR';
+ my $onchange = delete $params{onchange};
+ my $str_value = blessed $value ? $value->to_lxoffice : $value;
+
+ $self->input_tag($name, $str_value,
+ id => $name_e,
+ size => 11,
+ title => _H($::myconfig{dateformat}),
+ onBlur => 'check_right_date_format(this)',
+ ($onchange ? (
+ onChange => $onchange,
+ ) : ()),
+ %params,
+ ) . ((!$params{no_cal} && !$params{readonly}) ?
+ $self->html_tag('img', undef,
+ src => 'image/calendar.png',
+ alt => $::locale->text('Calendar'),
+ id => "trigger$seq",
+ title => _H($::myconfig{dateformat}),
+ %params,
+ ) .
+ $self->javascript(
+ "Calendar.setup({ inputField: '$name_e', ifFormat: '$datefmt', align: '$cal_align', button: 'trigger$seq' });"
+ ) : '');
+}
+
+sub customer_picker {
+ my ($self, $name, $value, %params) = @_;
+ my $name_e = _H($name);
+
+ $self->hidden_tag($name, (ref $value && $value->can('id')) ? $value->id : '') .
+ $self->input_tag("$name_e\_name", (ref $value && $value->can('name')) ? $value->name : '', %params) .
+ $self->javascript(<|;
+ }
+
+ return $code;
+}
+
+sub tabbed {
+ my ($self, $tabs, @slurp) = @_;
+ my %params = _hashify(@slurp);
+ my $id = $params{id} || 'tab_' . _tag_id();
+
+ $params{selected} *= 1;
+
+ die 'L.tabbed needs an arrayred of tabs for first argument'
+ unless ref $tabs eq 'ARRAY';
+
+ my (@header, @blocks);
+ for my $i (0..$#$tabs) {
+ my $tab = $tabs->[$i];
+
+ next if $tab eq '';
+
+ my $selected = $params{selected} == $i;
+ my $tab_id = "__tab_id_$i";
+ push @header, $self->li_tag(
+ $self->link('', $tab->{name}, rel => $tab_id),
+ ($selected ? (class => 'selected') : ())
+ );
+ push @blocks, $self->div_tag($tab->{data},
+ id => $tab_id, class => 'tabcontent');
+ }
+
+ return '' unless @header;
+ return $self->ul_tag(
+ join('', @header), id => $id, class => 'shadetabs'
+ ) .
+ $self->div_tag(
+ join('', @blocks), class => 'tabcontentstyle'
+ ) .
+ $self->javascript(
+ qq|var $id = new ddtabcontent("$id");$id.setpersist(true);| .
+ qq|$id.setselectedClassTarget("link");$id.init();|
+ );
+}
+
+sub tab {
+ my ($self, $name, $src, @slurp) = @_;
+ my %params = _hashify(@slurp);
+
+ $params{method} ||= 'process';
+
+ return () if defined $params{if} && !$params{if};
+
+ my $data;
+ if ($params{method} eq 'raw') {
+ $data = $src;
+ } elsif ($params{method} eq 'process') {
+ $data = $self->_context->process($src, %{ $params{args} || {} });
+ } else {
+ die "unknown tag method '$params{method}'";
+ }
+
+ return () unless $data;
+
+ return +{ name => $name, data => $data };
+}
+
+sub areainput_tag {
+ my ($self, $name, $value, @slurp) = @_;
+ my %attributes = _hashify(@slurp);
+
+ my ($rows, $cols);
+ my $min = delete $attributes{min_rows} || 1;
+
+ if (exists $attributes{cols}) {
+ $cols = delete $attributes{cols};
+ $rows = $::form->numtextrows($value, $cols);
+ } else {
+ $rows = delete $attributes{rows} || 1;
+ }
+
+ return $rows > 1
+ ? $self->textarea_tag($name, $value, %attributes, rows => max($rows, $min), ($cols ? (cols => $cols) : ()))
+ : $self->input_tag($name, $value, %attributes, ($cols ? (size => $cols) : ()));
+}
- my $value_key = $options->{value} || 'id';
- my $title_key = $options->{title} || $value_key;
+sub multiselect2side {
+ my ($self, $id, @slurp) = @_;
+ my %params = _hashify(@slurp);
- my @tags = ();
- if ($collection && (ref $collection eq 'ARRAY')) {
- foreach my $element (@{ $collection }) {
- my @result = !ref $element ? ( $element, $element )
- : ref $element eq 'ARRAY' ? ( $element->[0], $element->[1] )
- : ref $element eq 'HASH' ? ( $element->{$value_key}, $element->{$title_key} )
- : ( $element->$value_key, $element->$title_key );
+ $params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\"";
+ $params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\"";
+ $params{moveOptions} = 'false';
- my %attributes = ( value => $result[0] );
- $attributes{selected} = 'selected' if $options->{default} && ($options->{default} eq ($result[0] || ''));
+ my $vars = join(', ', map { "${_}: " . $params{$_} } keys %params);
+ my $code = <
+ \$().ready(function() {
+ \$('#${id}').multiselect2side({ ${vars} });
+ });
+
+EOCODE
- push @tags, $self->html_tag('option', $result[1], \%attributes);
+ return $code;
+}
+
+sub sortable_element {
+ my ($self, $selector, @slurp) = @_;
+ my %params = _hashify(@slurp);
+
+ my %attributes = ( distance => 5,
+ helper => <<'JAVASCRIPT' );
+ function(event, ui) {
+ ui.children().each(function() {
+ $(this).width($(this).width());
+ });
+ return ui;
}
+JAVASCRIPT
+
+ my $stop_event = '';
+
+ if ($params{url} && $params{with}) {
+ my $as = $params{as} || $params{with};
+ my $filter = ".filter(function(idx) { return this.substr(0, " . length($params{with}) . ") == '$params{with}'; })";
+ $filter .= ".map(function(idx, str) { return str.replace('$params{with}_', ''); })";
+
+ $stop_event = <*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0');
+ \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1');
+JAVASCRIPT
}
- return join('', @tags);
+ if ($stop_event) {
+ $attributes{stop} = <
+ \$(function() {
+ \$( "${selector}" ).sortable({ ${attr_str} })
+ });
+
+JAVASCRIPT
+
+ return $code;
+}
+
+sub online_help_tag {
+ my ($self, $tag, @slurp) = @_;
+ my %params = _hashify(@slurp);
+ my $cc = $::myconfig{countrycode};
+ my $file = "doc/online/$cc/$tag.html";
+ my $text = $params{text} || $::locale->text('Help');
+
+ die 'malformed help tag' unless $tag =~ /^[a-zA-Z0-9_]+$/;
+ return unless -f $file;
+ return $self->html_tag('a', $text, href => $file, class => 'jqModal')
+}
+
+sub dump {
+ my $self = shift;
+ require Data::Dumper;
+ return '
' . Data::Dumper::Dumper(@_) . '
';
}
1;
@@ -101,22 +559,261 @@ functions that create HTML tags from various kinds of data sources.
=head1 FUNCTIONS
+=head2 LOW-LEVEL FUNCTIONS
+
=over 4
-=item C
+=item C
+
+Converts a name to a HTML id by replacing various characters.
+
+=item C
-Creates a string from all elements in C<\%items> suitable for usage as
+Creates a string from all elements in C<%items> suitable for usage as
HTML tag attributes. Keys and values are HTML escaped even though keys
must not contain non-ASCII characters for browsers to accept them.
-=item C
+=item C
Creates an opening and closing HTML tag for C<$tag_name> and puts
C<$content_string> between the two. If C<$content_string> is undefined
or empty then only a Etag/E tag will be created. Attributes
are key/value pairs added to the opening tag.
-=item C
+C<$content_string> is not HTML escaped.
+
+=back
+
+=head2 HIGH-LEVEL FUNCTIONS
+
+=over 4
+
+=item C
+
+Creates a HTML 'select' tag named C<$name> with the contents
+C<$options_string> and with arbitrary HTML attributes from
+C<%attributes>. The tag's C defaults to C.
+
+The C<$options_string> is usually created by the
+L function. If C<$options_string> is an array
+reference then it will be passed to L
+automatically.
+
+=item C
+
+Creates a HTML 'input type=text' tag named C<$name> with the value
+C<$value> and with arbitrary HTML attributes from C<%attributes>. The
+tag's C defaults to C.
+
+=item C
+
+Creates a HTML 'input type=hidden' tag named C<$name> with the value
+C<$value> and with arbitrary HTML attributes from C<%attributes>. The
+tag's C defaults to C.
+
+=item C
+
+Creates a HTML 'input type=submit class=submit' tag named C<$name> with the
+value C<$value> and with arbitrary HTML attributes from C<%attributes>. The
+tag's C defaults to C.
+
+If C<$attributes{confirm}> is set then a JavaScript popup dialog will
+be added via the C handler asking the question given with
+C<$attributes{confirm}>. If request is only submitted if the user
+clicks the dialog's ok/yes button.
+
+=item C
+
+Creates a HTML 'textarea' tag named C<$name> with the content
+C<$value> and with arbitrary HTML attributes from C<%attributes>. The
+tag's C defaults to C.
+
+=item C
+
+Creates a HTML 'input type=checkbox' tag named C<$name> with arbitrary
+HTML attributes from C<%attributes>. The tag's C defaults to
+C. The tag's C defaults to C<1>.
+
+If C<%attributes> contains a key C