X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FTemplate%2FPlugin%2FL.pm;h=78efe642aaaaae16214745cfd504c54a392e9f79;hb=35d63a9fdee45777535d7ec815bfbc76c5c1bdc9;hp=93de09bb26f322d6b1c379f4c921a9e13d8043ed;hpb=71f55f78545971d867d1e3abe9daaee0f6a1e380;p=kivitendo-erp.git diff --git a/SL/Template/Plugin/L.pm b/SL/Template/Plugin/L.pm index 93de09bb2..78efe642a 100644 --- a/SL/Template/Plugin/L.pm +++ b/SL/Template/Plugin/L.pm @@ -2,91 +2,494 @@ package SL::Template::Plugin::L; use base qw( Template::Plugin ); use Template::Plugin; +use Data::Dumper; +use List::MoreUtils qw(apply); +use List::Util qw(max); +use Scalar::Util qw(blessed); + +use SL::Presenter; +use SL::Util qw(_hashify); 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 ); +} +} + sub _H { my $string = shift; return $::locale->quote_special_chars('HTML', $string); } +sub _J { + my $string = shift; + $string =~ s/(\"|\'|\\)/\\$1/g; + return $string; +} + 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 _call_presenter { + my ($method, $self, @args) = @_; + + my $presenter = $::request->presenter; + + if (!$presenter->can($method)) { + $::lxdebug->message(LXDebug::WARN(), "SL::Presenter has no method named '$method'!"); + return ''; + } + + splice @args, -1, 1, %{ $args[-1] } if @args && (ref($args[-1]) eq 'HASH'); + + $presenter->$method(@args); +} + +sub name_to_id { return _call_presenter('name_to_id', @_); } +sub html_tag { return _call_presenter('html_tag', @_); } +sub select_tag { return _call_presenter('select_tag', @_); } +sub input_tag { return _call_presenter('input_tag', @_); } +sub truncate { return _call_presenter('truncate', @_); } +sub simple_format { return _call_presenter('simple_format', @_); } +sub part_picker { return _call_presenter('part_picker', @_); } + +sub _set_id_attribute { + my ($attributes, $name) = @_; + SL::Presenter::Tag::_set_id_attribute($attributes, $name); +} + +sub img_tag { + my ($self, %options) = _hashify(1, @_); + + $options{alt} ||= ''; + + return $self->html_tag('img', undef, %options); +} + +sub textarea_tag { + my ($self, $name, $content, %attributes) = _hashify(3, @_); + + _set_id_attribute(\%attributes, $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); +} - return bless { }, $class; +sub checkbox_tag { + my ($self, $name, %attributes) = _hashify(2, @_); + + _set_id_attribute(\%attributes, $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, $name, %attributes) = _hashify(2, @_); + + _set_id_attribute(\%attributes, $name); + $attributes{value} = 1 unless exists $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 hidden_tag { + my ($self, $name, $value, %attributes) = _hashify(3, @_); + return $self->input_tag($name, $value, %attributes, type => 'hidden'); } -sub name_to_id { - my $self = shift; - my $name = shift; +sub div_tag { + my ($self, $content, @slurp) = @_; + return $self->html_tag('div', $content, @slurp); +} - $name =~ s/[^\w_]/_/g; - $name =~ s/_+/_/g; +sub ul_tag { + my ($self, $content, @slurp) = @_; + return $self->html_tag('ul', $content, @slurp); +} - return $name; +sub li_tag { + my ($self, $content, @slurp) = @_; + return $self->html_tag('li', $content, @slurp); } -sub attributes { - my $self = shift; - my $options = shift || {}; +sub link { + my ($self, $href, $content, %params) = _hashify(3, @_); - my @result = (); - while (my ($name, $value) = each %{ $options }) { - next unless $name; - $value ||= ''; - push @result, _H($name) . '="' . _H($value) . '"'; + $href ||= '#'; + + return $self->html_tag('a', $content, %params, href => $href); +} + +sub submit_tag { + my ($self, $name, $value, %attributes) = _hashify(3, @_); + + if ( $attributes{confirm} ) { + $attributes{onclick} = 'return confirm("'. _J(delete($attributes{confirm})) .'");'; } - return @result ? ' ' . join(' ', @result) : ''; + return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit'); } -sub html_tag { - my $self = shift; - my $tag = shift; - my $content = shift; - my $attributes = $self->attributes(shift || {}); +sub button_tag { + my ($self, $onclick, $value, %attributes) = _hashify(3, @_); + + _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name}; + $attributes{type} ||= 'button'; - return "<${tag}${attributes}/>" unless $content; - return "<${tag}${attributes}>${content}"; + $onclick = 'if (!confirm("'. _J(delete($attributes{confirm})) .'")) return false; ' . $onclick if $attributes{confirm}; + + return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick); } -sub select_tag { - my $self = shift; - my $name = shift; - my $options_str = shift; - my $attributes = shift || {}; +sub ajax_submit_tag { + my ($self, $url, $form_selector, $text, @slurp) = @_; - $attributes->{name} = $name; - $attributes->{id} ||= $self->name_to_id($name); + $url = _J($url); + $form_selector = _J($form_selector); + my $onclick = qq|kivi.submit_ajax_form('${url}', '${form_selector}')|; - return $self->html_tag('select', $options_str, $attributes); + return $self->button_tag($onclick, $text, @slurp); } -sub options_for_select { - my $self = shift; - my $collection = shift; - my $options = shift || {}; +sub yes_no_tag { + my ($self, $name, $value, %attributes) = _hashify(3, @_); + + return $self->select_tag($name, [ [ 1 => $::locale->text('Yes') ], [ 0 => $::locale->text('No') ] ], default => $value ? 1 : 0, %attributes); +} - my $value_key = $options->{value} || 'id'; - my $title_key = $options->{title} || $value_key; +sub javascript { + my ($self, $data) = @_; + return $self->html_tag('script', $data, type => 'text/javascript'); +} - 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 ); +sub stylesheet_tag { + my $self = shift; + my $code = ''; - my %attributes = ( value => $result[0] ); - $attributes{selected} = 'selected' if $options->{default} && ($options->{default} eq ($result[0] || '')); + foreach my $file (@_) { + $file .= '.css' unless $file =~ m/\.css$/; + $file = "css/${file}" unless $file =~ m|/|; - push @tags, $self->html_tag('option', _H($result[1]), \%attributes); + $code .= qq||; + } + + return $code; +} + +my $date_tag_id_idx = 0; +sub date_tag { + my ($self, $name, $value, %params) = _hashify(3, @_); + + _set_id_attribute(\%params, $name); + my @onchange = $params{onchange} ? (onChange => delete $params{onchange}) : (); + my @classes = $params{no_cal} || $params{readonly} ? () : ('datepicker'); + push @classes, delete($params{class}) if $params{class}; + my %class = @classes ? (class => join(' ', @classes)) : (); + + return $self->input_tag( + $name, blessed($value) ? $value->to_lxoffice : $value, + size => 11, + onblur => "check_right_date_format(this);", + %params, + %class, @onchange, + ); +} + +sub customer_picker { + my ($self, $name, $value, %params) = @_; + my $name_e = _H($name); + + $::request->{layout}->add_javascripts('autocomplete_customer.js'); + + $self->hidden_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => 'customer_autocomplete') . + $self->input_tag("$name_e\_name", (ref $value && $value->can('name')) ? $value->name : '', %params); +} + +# simple version with select_tag +sub vendor_selector { + my ($self, $name, $value, %params) = @_; + + my $actual_vendor_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"}) ? $::form->{"$name"}->id : $::form->{"$name"}) : + (ref $value && $value->can('id')) ? $value->id : ''; + + return $self->select_tag($name, SL::DB::Manager::Vendor->get_all(), + default => $actual_vendor_id, + title_sub => sub { $_[0]->vendornumber . " : " . $_[0]->name }, + 'with_empty' => 1, + %params); +} + + +# simple version with select_tag +sub part_selector { + my ($self, $name, $value, %params) = @_; + + my $actual_part_id = (defined $::form->{"$name"})? ((ref $::form->{"$name"})? $::form->{"$name"}->id : $::form->{"$name"}) : + (ref $value && $value->can('id')) ? $value->id : ''; + + return $self->select_tag($name, SL::DB::Manager::Part->get_all(), + default => $actual_part_id, + title_sub => sub { $_[0]->partnumber . " : " . $_[0]->description }, + with_empty => 1, + %params); +} + + +sub javascript_tag { + my $self = shift; + my $code = ''; + + foreach my $file (@_) { + $file .= '.js' unless $file =~ m/\.js$/; + $file = "js/${file}" unless $file =~ m|/|; + + $code .= qq||; + } + + return $code; +} + +sub tabbed { + my ($self, $tabs, %params) = _hashify(2, @_); + 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 $tab_id = "__tab_id_$i"; + push @header, $self->li_tag($self->link('#' . $tab_id, $tab->{name})); + push @blocks, $self->div_tag($tab->{data}, id => $tab_id); + } + + return '' unless @header; + + my $ul = $self->ul_tag(join('', @header), id => $id); + return $self->div_tag(join('', $ul, @blocks), class => 'tabwidget'); +} + +sub tab { + my ($self, $name, $src, %params) = _hashify(3, @_); + + $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, %attributes) = _hashify(3, @_); + + 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) : ())); +} + +sub multiselect2side { + my ($self, $id, %params) = _hashify(2, @_); + + $params{labelsx} = "\"" . _J($params{labelsx} || $::locale->text('Available')) . "\""; + $params{labeldx} = "\"" . _J($params{labeldx} || $::locale->text('Selected')) . "\""; + $params{moveOptions} = 'false'; + + my $vars = join(', ', map { "${_}: " . $params{$_} } keys %params); + my $code = < + \$().ready(function() { + \$('#${id}').multiselect2side({ ${vars} }); + }); + +EOCODE + + return $code; +} + +sub sortable_element { + my ($self, $selector, %params) = _hashify(2, @_); + + 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}_', ''); })"; + + my $params_js = $params{params} ? qq| + ($params{params})| : ''; + + $stop_event = <*:odd').removeClass('listrow1').removeClass('listrow0').addClass('listrow0'); + \$('${selector}>*:even').removeClass('listrow1').removeClass('listrow0').addClass('listrow1'); +JAVASCRIPT + } + + if ($stop_event) { + $attributes{stop} = < + \$(function() { + \$( "${selector}" ).sortable({ ${attr_str} }) + }); + +JAVASCRIPT + + return $code; +} + +sub online_help_tag { + my ($self, $tag, %params) = _hashify(2, @_); + 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; + return '
' . Data::Dumper::Dumper(@_) . '
'; +} + +sub sortable_table_header { + my ($self, $by, %params) = _hashify(2, @_); + + my $controller = $self->{CONTEXT}->stash->get('SELF'); + my $sort_spec = $controller->get_sort_spec; + my $by_spec = $sort_spec->{$by}; + my %current_sort_params = $controller->get_current_sort_params; + my ($image, $new_dir) = ('', $current_sort_params{dir}); + my $title = delete($params{title}) || $::locale->text($by_spec->{title}); + + if ($current_sort_params{by} eq $by) { + my $current_dir = $current_sort_params{dir} ? 'up' : 'down'; + $image = ''; + $new_dir = 1 - ($current_sort_params{dir} || 0); } - return join('', @tags); + $params{ $sort_spec->{FORM_PARAMS}->[0] } = $by; + $params{ $sort_spec->{FORM_PARAMS}->[1] } = ($new_dir ? '1' : '0'); + + return '' . _H($title) . $image . ''; +} + +sub paginate_controls { + my ($self, %params) = _hashify(1, @_); + + my $controller = $self->{CONTEXT}->stash->get('SELF'); + my $paginate_spec = $controller->get_paginate_spec; + my %paginate_params = $controller->get_current_paginate_params; + + my %template_params = ( + pages => \%paginate_params, + url_maker => sub { + my %url_params = _hashify(0, @_); + $url_params{ $paginate_spec->{FORM_PARAMS}->[0] } = delete $url_params{page}; + $url_params{ $paginate_spec->{FORM_PARAMS}->[1] } = delete $url_params{per_page} if exists $url_params{per_page}; + + return $controller->get_callback(%url_params); + }, + %params, + ); + + return SL::Presenter->get->render('common/paginate', %template_params); } 1; @@ -103,90 +506,326 @@ Usage from a template: [% USE L %] - [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right' ] ]) %] + [% L.select_tag('direction', [ [ 'left', 'To the left' ], [ 'right', 'To the right', 1 ] ]) %] + + [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' }, + { direction => 'right', display => 'To the right' } ], + value_key => 'direction', title_key => 'display', default => 'right')) %] - [% L.select_tag('direction', L.options_for_select([ { direction => 'left', display => 'To the left' }, - { direction => 'right', display => 'To the right' } ], - value => 'direction', title => 'display', default => 'right')) %] + [% L.select_tag('direction', [ { direction => 'left', display => 'To the left' }, + { direction => 'right', display => 'To the right', selected => 1 } ], + value_key => 'direction', title_key => 'display')) %] =head1 DESCRIPTION A module modeled a bit after Rails' ActionView helpers. Several small functions that create HTML tags from various kinds of data sources. +The C attribute is usually calculated automatically. This can be +overridden by either specifying an C attribute or by setting +C to trueish. + =head1 FUNCTIONS =head2 LOW-LEVEL FUNCTIONS -=over 4 +The following items are just forwarded to L: + +=over 2 + +=item * C -=item C +=item * C -Converts a name to a HTML id by replacing various characters. +=item * C -=item C +=back + +=head2 HIGH-LEVEL FUNCTIONS -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. +The following functions are just forwarded to L: -=item C +=over 2 -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. +=item * C =back -=head2 HIGH-LEVEL FUNCTIONS +Available high-level functions implemented in this module: =over 4 -=item C +=item C + +Creates a HTML 'select' tag with the two entries C and C by +calling L. C<$value> determines +which entry is selected. The C<%attributes> are passed through to +L. + +=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}>. The request is only submitted if the user +clicks the dialog's ok/yes button. + +=item C + +Creates a HTML 'input type="button"' tag with a very specific onclick +handler that submits the form given by the jQuery selector +C<$form_selector> to the URL C<$url> (the actual JavaScript function +called for that is C in +C). The button's label will be C<$text>. + +=item C + +Creates a HTML 'input type="button"' tag with an onclick handler +C<$onclick> and a value of C<$text>. The button does not have a name +nor an ID by default. + +If C<$attributes{confirm}> is set then a JavaScript popup dialog will +be prepended to the C<$onclick> handler asking the question given with +C<$attributes{confirm}>. The 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