X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FPresenter%2FTag.pm;h=a140fe4e4aeb23b64cab362e7542bd6c37f69edb;hb=53593baa211863fbf66540cf1bcc36c8fb37257f;hp=e65ca7722ef27abed26c402f62f22e58d6d2a242;hpb=39d85854d0a01b19522366dc22e784b28a85f336;p=kivitendo-erp.git diff --git a/SL/Presenter/Tag.pm b/SL/Presenter/Tag.pm index e65ca7722..a140fe4e4 100644 --- a/SL/Presenter/Tag.pm +++ b/SL/Presenter/Tag.pm @@ -2,16 +2,28 @@ package SL::Presenter::Tag; use strict; -use parent qw(Exporter); +use SL::HTML::Restrict; +use SL::Presenter::EscapedText qw(escape); +use Scalar::Util qw(blessed); use Exporter qw(import); -our @EXPORT = qw(html_tag input_tag man_days_tag name_to_id select_tag stringify_attributes); +our @EXPORT_OK = qw( + html_tag input_tag hidden_tag javascript man_days_tag name_to_id select_tag + checkbox_tag button_tag submit_tag ajax_submit_tag input_number_tag + stringify_attributes textarea_tag link_tag date_tag + div_tag radio_button_tag img_tag); +our %EXPORT_TAGS = (ALL => \@EXPORT_OK); use Carp; my %_valueless_attributes = map { $_ => 1 } qw( checked compact declare defer disabled ismap multiple noresize noshade nowrap - readonly selected + readonly selected hidden +); + +my %_singleton_tags = map { $_ => 1 } qw( + area base br col command embed hr img input keygen link meta param source + track wbr ); sub _call_on { @@ -19,55 +31,85 @@ sub _call_on { return $object->$method(@params); } +{ # 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 _id { + return ( $_id_sequence = ($_id_sequence + 1) % 1e7 ); +} +} + +sub _J { + my $string = shift; + $string =~ s/(\"|\'|\\)/\\$1/g; + return $string; +} + +sub join_values { + my ($name, $value) = @_; + my $spacer = $name eq 'class' ? ' ' : ''; # join classes with spaces, everything else as is + + ref $value && 'ARRAY' eq ref $value + ? join $spacer, map { join_values($name, $_) } @$value + : $value +} sub stringify_attributes { - my ($self, %params) = @_; + my (%params) = @_; my @result = (); while (my ($name, $value) = each %params) { next unless $name; next if $_valueless_attributes{$name} && !$value; $value = '' if !defined($value); - push @result, $_valueless_attributes{$name} ? $self->escape($name) : $self->escape($name) . '="' . $self->escape($value) . '"'; + $value = join_values($name, $value) if ref $value && 'ARRAY' eq ref $value; + push @result, $_valueless_attributes{$name} ? escape($name) : escape($name) . '="' . escape($value) . '"'; } return @result ? ' ' . join(' ', @result) : ''; } sub html_tag { - my ($self, $tag, $content, %params) = @_; - my $attributes = $self->stringify_attributes(%params); + my ($tag, $content, %params) = @_; + my $attributes = stringify_attributes(%params); - return "<${tag}${attributes}>" unless defined($content); + return "<${tag}${attributes}>" if !defined($content) && $_singleton_tags{$tag}; return "<${tag}${attributes}>${content}"; } sub input_tag { - my ($self, $name, $value, %attributes) = @_; + my ($name, $value, %attributes) = @_; - $attributes{id} ||= $self->name_to_id($name); + _set_id_attribute(\%attributes, $name); $attributes{type} ||= 'text'; - return $self->html_tag('input', undef, %attributes, name => $name, value => $value); + html_tag('input', undef, %attributes, name => $name, value => $value); +} + +sub hidden_tag { + my ($name, $value, %attributes) = @_; + input_tag($name, $value, %attributes, type => 'hidden'); } sub man_days_tag { - my ($self, $name, $object, %attributes) = @_; + my ($name, $object, %attributes) = @_; my $size = delete($attributes{size}) || 5; my $method = $name; $method =~ s/^.*\.//; - my $time_selection = $self->input_tag( "${name}_as_man_days_string", _call_on($object, "${method}_as_man_days_string"), %attributes, size => $size); - my $unit_selection = $self->select_tag("${name}_as_man_days_unit", [[ 'h', $::locale->text('h') ], [ 'man_day', $::locale->text('MD') ]], + my $time_selection = input_tag("${name}_as_man_days_string", _call_on($object, "${method}_as_man_days_string"), %attributes, size => $size); + my $unit_selection = select_tag("${name}_as_man_days_unit", [[ 'h', $::locale->text('h') ], [ 'man_day', $::locale->text('MD') ]], %attributes, default => _call_on($object, "${method}_as_man_days_unit")); return $time_selection . $unit_selection; } sub name_to_id { - my ($self, $name) = @_; + my ($name) = @_; + $name =~ s/\[\+?\]/ _id() /ge; # give constructs with [] or [+] unique ids $name =~ s/[^\w_]/_/g; $name =~ s/_+/_/g; @@ -75,14 +117,19 @@ sub name_to_id { } sub select_tag { - my ($self, $name, $collection, %attributes) = @_; + my ($name, $collection, %attributes) = @_; + + _set_id_attribute(\%attributes, $name); - $attributes{id} ||= $self->name_to_id($name); + $collection = [] if defined($collection) && !ref($collection) && ($collection eq ''); + my $with_filter = delete($attributes{with_filter}); + my $fil_placeholder = delete($attributes{filter_placeholder}); my $value_key = delete($attributes{value_key}) || 'id'; my $title_key = delete($attributes{title_key}) || $value_key; my $default_key = delete($attributes{default_key}) || 'selected'; - + my $default_val_key = delete($attributes{default_value_key}); + my $default_coll = delete($attributes{default}); my $value_title_sub = delete($attributes{value_title_sub}); @@ -95,18 +142,7 @@ sub select_tag { my $with_optgroups = delete($attributes{with_optgroups}); - my %selected; - - if ( ref($attributes{default}) eq 'ARRAY' ) { - - foreach my $entry (@{$attributes{default}}) { - $selected{$entry} = 1; - } - } elsif ( defined($attributes{default}) ) { - $selected{$attributes{default}} = 1; - } - - delete($attributes{default}); + undef $default_key if $default_sub || $default_val_key; my $normalize_entry = sub { my ($type, $entry, $sub, $key) = @_; @@ -129,9 +165,27 @@ sub select_tag { return undef; }; + my %selected; + if (defined($default_coll) && !ref $default_coll) { + %selected = ($default_coll => 1); + + } elsif (ref($default_coll) eq 'HASH') { + %selected = %{ $default_coll }; + + } elsif ($default_coll) { + $default_coll = [ $default_coll ] unless 'ARRAY' eq ref $default_coll; + + %selected = $default_val_key ? map({ ($normalize_entry->('value', $_, undef, $default_val_key) => 1) } @{ $default_coll }) + : map({ ($_ => 1) } @{ $default_coll }); + } + my $list_to_code = sub { my ($sub_collection) = @_; + if ('ARRAY' ne ref $sub_collection) { + $sub_collection = [ $sub_collection ]; + } + my @options; foreach my $entry ( @{ $sub_collection } ) { my $value; @@ -145,20 +199,16 @@ sub select_tag { $title = $normalize_entry->('title', $entry, $title_sub, $title_key); } - my $default = $normalize_entry->('default', $entry, $default_sub, $default_key); + my $default = $default_key ? $normalize_entry->('default', $entry, $default_sub, $default_key) : 0; - push(@options, [$value, $title, $default]); + push(@options, [$value, $title, $selected{$value} || $default]); } - foreach my $entry (@options) { - $entry->[2] = 1 if $selected{$entry->[0]}; - } - - return join '', map { $self->html_tag('option', $self->escape($_->[1]), value => $_->[0], selected => $_->[2]) } @options; + return join '', map { html_tag('option', escape($_->[1]), value => $_->[0], selected => $_->[2]) } @options; }; my $code = ''; - $code .= $self->html_tag('option', $self->escape($empty_title || ''), value => '') if $with_empty; + $code .= html_tag('option', escape($empty_title || ''), value => '') if $with_empty; if (!$with_optgroups) { $code .= $list_to_code->($collection); @@ -166,11 +216,212 @@ sub select_tag { } else { $code .= join '', map { my ($optgroup_title, $sub_collection) = @{ $_ }; - $self->html_tag('optgroup', $list_to_code->($sub_collection), label => $optgroup_title) + html_tag('optgroup', $list_to_code->($sub_collection), label => $optgroup_title) } @{ $collection }; } - return $self->html_tag('select', $code, %attributes, name => $name); + my $select_html = html_tag('select', $code, %attributes, name => $name); + + if ($with_filter) { + my $input_style; + + if (($attributes{style} // '') =~ m{width: *(\d+) *px}i) { + $input_style = "width: " . ($1 - 22) . "px"; + } + + my $input_html = html_tag( + 'input', undef, + autocomplete => 'off', + type => 'text', + id => $attributes{id} . '_filter', + 'data-select-id' => $attributes{id}, + (placeholder => $fil_placeholder) x !!$fil_placeholder, + (style => $input_style) x !!$input_style, + ); + $select_html = html_tag('div', $input_html . $select_html, class => "filtered_select"); + } + + return $select_html; +} + +sub checkbox_tag { + my ($name, %attributes) = @_; + + my %label_attributes = map { (substr($_, 6) => $attributes{$_}) } grep { m{^label_} } keys %attributes; + delete @attributes{grep { m{^label_} } keys %attributes}; + + _set_id_attribute(\%attributes, $name); + + $attributes{value} = 1 unless defined $attributes{value}; + my $label = delete $attributes{label}; + my $checkall = delete $attributes{checkall}; + my $for_submit = delete $attributes{for_submit}; + + if ($attributes{checked}) { + $attributes{checked} = 'checked'; + } else { + delete $attributes{checked}; + } + + my $code = ''; + $code .= hidden_tag($name, 0, %attributes, id => $attributes{id} . '_hidden') if $for_submit; + $code .= html_tag('input', undef, %attributes, name => $name, type => 'checkbox'); + $code .= html_tag('label', $label, for => $attributes{id}, %label_attributes) if $label; + $code .= javascript(qq|\$('#$attributes{id}').checkall('$checkall');|) if $checkall; + + return $code; +} + +sub radio_button_tag { + my ($name, %attributes) = @_; + + my %label_attributes = map { (substr($_, 6) => $attributes{$_}) } grep { m{^label_} } keys %attributes; + delete @attributes{grep { m{^label_} } keys %attributes}; + + $attributes{value} = 1 unless exists $attributes{value}; + + _set_id_attribute(\%attributes, $name, 1); + my $label = delete $attributes{label}; + + _set_id_attribute(\%attributes, $name . '_' . $attributes{value}); + + if ($attributes{checked}) { + $attributes{checked} = 'checked'; + } else { + delete $attributes{checked}; + } + + my $code = html_tag('input', undef, %attributes, name => $name, type => 'radio'); + $code .= html_tag('label', $label, for => $attributes{id}, %label_attributes) if $label; + + return $code; +} + +sub button_tag { + my ($onclick, $value, %attributes) = @_; + + _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name}; + $attributes{type} ||= 'button'; + + $onclick = 'if (!confirm("'. _J(delete($attributes{confirm})) .'")) return false; ' . $onclick if $attributes{confirm}; + + html_tag('input', undef, %attributes, value => $value, (onclick => $onclick)x!!$onclick); +} + +sub submit_tag { + my ($name, $value, %attributes) = @_; + + _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name}; + + if ( $attributes{confirm} ) { + $attributes{onclick} = 'return confirm("'. _J(delete($attributes{confirm})) .'");'; + } + + input_tag($name, $value, %attributes, type => 'submit', class => 'submit'); +} + +sub ajax_submit_tag { + my ($url, $form_selector, $text, %attributes) = @_; + + $url = _J($url); + $form_selector = _J($form_selector); + my $onclick = qq|kivi.submit_ajax_form('${url}', '${form_selector}')|; + + button_tag($onclick, $text, %attributes); +} + +sub input_number_tag { + my ($name, $value, %params) = @_; + + _set_id_attribute(\%params, $name); + my @onchange = $params{onchange} ? (onChange => delete $params{onchange}) : (); + my @classes = ('numeric'); + push @classes, delete($params{class}) if $params{class}; + my %class = @classes ? (class => join(' ', @classes)) : (); + + $::request->layout->add_javascripts('kivi.Validator.js'); + $::request->presenter->need_reinit_widgets($params{id}); + + input_tag( + $name, $::form->format_amount(\%::myconfig, $value, $params{precision}), + "data-validate" => "number", + %params, + %class, @onchange, + ); +} + + +sub javascript { + my ($data) = @_; + html_tag('script', $data, type => 'text/javascript'); +} + +sub _set_id_attribute { + my ($attributes, $name, $unique) = @_; + + if (!delete($attributes->{no_id}) && !$attributes->{id}) { + $attributes->{id} = name_to_id($name); + $attributes->{id} .= '_' . $attributes->{value} if $unique; + } + + %{ $attributes }; +} + +my $html_restricter; + +sub textarea_tag { + my ($name, $content, %attributes) = @_; + + _set_id_attribute(\%attributes, $name); + $attributes{rows} *= 1; # required by standard + $attributes{cols} *= 1; # required by standard + + html_tag('textarea', $content, %attributes, name => $name); +} + +sub link_tag { + my ($href, $content, %params) = @_; + + $href ||= '#'; + + html_tag('a', $content, %params, href => $href); +} +# alias for compatibility +sub link { goto &link_tag } + +sub date_tag { + my ($name, $value, %params) = @_; + + _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)) : (); + + $::request->layout->add_javascripts('kivi.Validator.js'); + $::request->presenter->need_reinit_widgets($params{id}); + + $params{'data-validate'} = join(' ', "date", grep { $_ } (delete $params{'data-validate'})); + + input_tag( + $name, blessed($value) ? $value->to_lxoffice : $value, + size => 11, + %params, + %class, @onchange, + ); +} + +sub div_tag { + my ($content, %params) = @_; + return html_tag('div', $content, %params); +} + +sub img_tag { + my (%params) = @_; + + $params{alt} ||= ''; + + return html_tag('img', undef, %params); } 1; @@ -186,7 +437,7 @@ SL::Presenter::Tag - Layouting / tag generation =head1 SYNOPSIS -Usage from a template: +Usage in a template: [% USE P %] @@ -194,17 +445,29 @@ Usage from a template: [% P.select_tag('direction', [ { direction => 'left', display => 'To the left' }, { direction => 'right', display => 'To the right' } ], - value_key => 'direction', title_key => 'display', default => 'right')) %] + value_key => 'direction', title_key => 'display', default => 'right') %] [% P.select_tag('direction', [ { direction => 'left', display => 'To the left' }, { direction => 'right', display => 'To the right', selected => 1 } ], - value_key => 'direction', title_key => 'display')) %] + value_key => 'direction', title_key => 'display') %] + + # Use an RDBO object and its n:m relationship as the default + # values. For example, a user can be a member of many groups. "All + # groups" is therefore the full collection and "$user->groups" is a + # list of RDBO AuthGroup objects whose IDs must match the ones in + # "All groups". This could look like the following: + [% P.select_tag('user.groups[]', SELF.all_groups, multiple=1, + default=SELF.user.groups, default_value_key='id' ) %] =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 @@ -242,6 +505,36 @@ 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=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 two HTML inputs: a text input for entering a number and a drop @@ -262,9 +555,45 @@ makes it possible to write statements like e.g. The attribute C can be used to set the text input's size. It defaults to 5. +=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=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