X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FPresenter%2FTag.pm;h=0c2dff2d42f512adde80be8b440a87246a9dfab5;hb=dc48be1ca22433a40ee8b24d9976d067c6dab022;hp=e65ca7722ef27abed26c402f62f22e58d6d2a242;hpb=081e2bbcae187497b961a1d19d856c8da6e6204b;p=kivitendo-erp.git diff --git a/SL/Presenter/Tag.pm b/SL/Presenter/Tag.pm index e65ca7722..0c2dff2d4 100644 --- a/SL/Presenter/Tag.pm +++ b/SL/Presenter/Tag.pm @@ -2,16 +2,18 @@ package SL::Presenter::Tag; use strict; +use SL::HTML::Restrict; + use parent qw(Exporter); use Exporter qw(import); -our @EXPORT = qw(html_tag input_tag man_days_tag name_to_id select_tag stringify_attributes); +our @EXPORT = 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 stringify_attributes restricted_html); use Carp; my %_valueless_attributes = map { $_ => 1 } qw( checked compact declare defer disabled ismap multiple noresize noshade nowrap - readonly selected + readonly selected hidden ); sub _call_on { @@ -19,6 +21,20 @@ 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 stringify_attributes { my ($self, %params) = @_; @@ -45,12 +61,17 @@ sub html_tag { sub input_tag { my ($self, $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); } +sub hidden_tag { + my ($self, $name, $value, %attributes) = @_; + return $self->input_tag($name, $value, %attributes, type => 'hidden'); +} + sub man_days_tag { my ($self, $name, $object, %attributes) = @_; @@ -68,6 +89,7 @@ sub man_days_tag { sub name_to_id { my ($self, $name) = @_; + $name =~ s/\[\+?\]/ _id() /ge; # give constructs with [] or [+] unique ids $name =~ s/[^\w_]/_/g; $name =~ s/_+/_/g; @@ -77,12 +99,13 @@ sub name_to_id { sub select_tag { my ($self, $name, $collection, %attributes) = @_; - $attributes{id} ||= $self->name_to_id($name); + _set_id_attribute(\%attributes, $name); 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 +118,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 +141,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,13 +175,9 @@ sub select_tag { $title = $normalize_entry->('title', $entry, $title_sub, $title_key); } - my $default = $normalize_entry->('default', $entry, $default_sub, $default_key); - - push(@options, [$value, $title, $default]); - } + my $default = $default_key ? $normalize_entry->('default', $entry, $default_sub, $default_key) : 0; - foreach my $entry (@options) { - $entry->[2] = 1 if $selected{$entry->[0]}; + push(@options, [$value, $title, $selected{$value} || $default]); } return join '', map { $self->html_tag('option', $self->escape($_->[1]), value => $_->[0], selected => $_->[2]) } @options; @@ -173,6 +199,89 @@ sub select_tag { return $self->html_tag('select', $code, %attributes, name => $name); } +sub checkbox_tag { + my ($self, $name, %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 .= $self->hidden_tag($name, 0, %attributes, id => $attributes{id} . '_hidden') if $for_submit; + $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 button_tag { + my ($self, $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}; + + return $self->html_tag('input', undef, %attributes, value => $value, onclick => $onclick); +} + +sub submit_tag { + my ($self, $name, $value, %attributes) = @_; + + _set_id_attribute(\%attributes, $attributes{name}) if $attributes{name}; + + if ( $attributes{confirm} ) { + $attributes{onclick} = 'return confirm("'. _J(delete($attributes{confirm})) .'");'; + } + + return $self->input_tag($name, $value, %attributes, type => 'submit', class => 'submit'); +} + +sub ajax_submit_tag { + my ($self, $url, $form_selector, $text, %attributes) = @_; + + $url = _J($url); + $form_selector = _J($form_selector); + my $onclick = qq|kivi.submit_ajax_form('${url}', '${form_selector}')|; + + return $self->button_tag($onclick, $text, %attributes); +} + +sub javascript { + my ($self, $data) = @_; + return $self->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(undef, $name); + $attributes->{id} .= '_' . $attributes->{value} if $unique; + } + + return %{ $attributes }; +} + +my $html_restricter; + +sub restricted_html { + my ($self, $value) = @_; + + $html_restricter ||= SL::HTML::Restrict->create; + return $html_restricter->process($value); +} + 1; __END__ @@ -186,7 +295,7 @@ SL::Presenter::Tag - Layouting / tag generation =head1 SYNOPSIS -Usage from a template: +Usage in a template: [% USE P %] @@ -194,17 +303,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 @@ -230,6 +351,10 @@ 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 + +Returns HTML stripped of unknown tags. See L. + =back =head2 HIGH-LEVEL FUNCTIONS @@ -242,6 +367,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 @@ -264,7 +419,7 @@ defaults to 5. =item C -Creates a HTML 'select' tag named C<$name> with the contents of one +Creates an HTML 'select' tag named C<$name> with the contents of one 'EoptionE' tag for each element in C<\@collection> and with arbitrary HTML attributes from C<%attributes>. The value to use and the title to display are extracted from the elements in @@ -290,8 +445,10 @@ respectively. =back For cases 3 and 4 C<$attributes{value_key}> defaults to C, -C<$attributes{title_key}> defaults to C<$attributes{value_key}> -and C<$attributes{default_key}> defaults to C. +C<$attributes{title_key}> defaults to C<$attributes{value_key}> and +C<$attributes{default_key}> defaults to C. Note that +C<$attributes{default_key}> is set to C if +C<$attributes{default_value_key}> is used as well (see below). In addition to pure keys/method you can also provide coderefs as I and/or I and/or I. If present, these take precedence over keys or methods, @@ -306,24 +463,50 @@ C) will be used as the first element. The title to display for this element can be set with the option C and defaults to an empty string. -The option C can be either a scalar or an array reference -containing the values of the options which should be set to be -selected. - The tag's C defaults to C. +The option C can be quite a lot of things: + +=over 4 + +=item 1. A scalar value. This is the value of the entry that's +selected by default. + +=item 2. A hash reference for C. Whether or not an entry +is selected by default is looked up in this hash. + +=item 3. An array reference containing scalar values. Same as 1., just +for the case of C. + +=item 4. If C is given: an array reference of hash +references. For each hash reference the value belonging to the key +C is treated as one value to select by +default. Constructs a hash that's treated like 3. + +=item 5. If C is given: an array reference of +blessed objects. For each object the value returne from calling the +function named C on the object is treated as one +value to select by default. Constructs a hash that's treated like 3. + +=back + +5. also applies to single RDBO instances (due to 'wantarray' +shenanigans assigning RDBO's relationships to a hash key will result +in a single RDBO object being assigned instead of an array reference +containing that single RDBO object). + If the option C is set then this function expects C<\@collection> to be one level deeper. The upper-most level is -translated into a HTML C tag. So the structure becomes: +translated into an HTML C tag. So the structure becomes: =over 4 =item 1. Array of array references. Each element in the C<\@collection> is converted into an optgroup. -=item 2. The optgroup's C