1 |
package Frey::Action; |
2 |
use Moose; |
3 |
extends 'Frey::PPI'; |
4 |
with 'Frey::Web', 'Frey::Config'; |
5 |
|
6 |
use Clone qw/clone/; |
7 |
use Data::Dump qw/dump/; |
8 |
|
9 |
=head1 DESCRIPTION |
10 |
|
11 |
Invoke any L<Frey> object creating html for with various default parameters |
12 |
if not supplied at invocation. |
13 |
|
14 |
You can force rendering of fields if you define C<render_attribute> sub with |
15 |
desired rendering as in: |
16 |
|
17 |
sub render_pipe { 'radio' } |
18 |
|
19 |
=cut |
20 |
|
21 |
has 'class' => ( |
22 |
is => 'rw', |
23 |
isa => 'Str', |
24 |
required => 1, |
25 |
); |
26 |
|
27 |
has 'params' => ( |
28 |
is => 'rw', |
29 |
isa => 'HashRef', |
30 |
default => sub { {} }, |
31 |
); |
32 |
|
33 |
has 'input_step_size' => ( |
34 |
documentation => 'Resize input fields by this step', |
35 |
is => 'rw', |
36 |
isa => 'Int', |
37 |
# required => 1, |
38 |
default => 20, |
39 |
); |
40 |
|
41 |
=head2 required |
42 |
|
43 |
my @required_attributes = $self->required; |
44 |
my $required_attributes = $self->required; |
45 |
my $required_hash = $self->required('as_hash'); |
46 |
|
47 |
=cut |
48 |
|
49 |
sub required { |
50 |
my ($self,$param) = @_; |
51 |
$self->load_class( $self->class ); |
52 |
|
53 |
my @required = |
54 |
grep { |
55 |
defined $_ && $_->can('name') && |
56 |
! $_->is_lazy |
57 |
} |
58 |
map { |
59 |
my $attr = $self->class->meta->get_attribute($_); |
60 |
blessed $attr && $attr->is_required && $attr; |
61 |
} $self->class->meta->get_attribute_list; |
62 |
|
63 |
@required = map { $_->name } @required; |
64 |
warn "## required = ",dump( @required ), " for ", $self->class if @required && $self->debug; |
65 |
|
66 |
if ( $param eq 'as_hash' ) { |
67 |
my $hash; |
68 |
map { |
69 |
$hash->{$_} = 1; |
70 |
$hash->{$_} = 0 if defined $self->params->{$_}; |
71 |
} @required; |
72 |
return $hash; |
73 |
} |
74 |
return @required if wantarray; |
75 |
return \@required; |
76 |
} |
77 |
|
78 |
=head2 attributes |
79 |
|
80 |
Generated from attributes specified in code (extracted using L<Frey::PPI>) |
81 |
and required atributes |
82 |
|
83 |
my @class_attributes = $self->attributes; |
84 |
my @class_attributes = $self->attributes; |
85 |
|
86 |
=cut |
87 |
|
88 |
sub attributes { |
89 |
my ( $self ) = @_; |
90 |
my $a; |
91 |
my @attrs = @{ $self->attribute_order }; |
92 |
@attrs = map { $a->{$_}++; $_ } @attrs; |
93 |
push @attrs, $_ foreach grep { ! $a->{$_} } @{ $self->required }; |
94 |
warn "# attributes = ",dump( @attrs ) if $self->debug; |
95 |
return @attrs if wantarray; |
96 |
return \@attrs; |
97 |
} |
98 |
|
99 |
=head2 params_form |
100 |
|
101 |
my $html = $self->params_form; |
102 |
my ($html,$default_params) = $self->params_form; |
103 |
|
104 |
=cut |
105 |
|
106 |
sub form_id { |
107 |
my ($self) = @_; |
108 |
my $form_id = $self->class; |
109 |
$form_id =~ s{\W+}{_}g; |
110 |
return $form_id; |
111 |
} |
112 |
|
113 |
sub select_values { |
114 |
my ( $self, $name, $attr_type, $values ) = @_; |
115 |
|
116 |
$attr_type ||= '?' and warn "$name doesn't have attr_type"; |
117 |
|
118 |
my $form_id = $self->form_id; |
119 |
my $max_value_len = 0; |
120 |
my $form_value_len = $self->class->form_value_len if $self->class->can('form_value_len'); |
121 |
my @values; |
122 |
my $display; |
123 |
my $html = ''; |
124 |
|
125 |
foreach ( @$values ) { |
126 |
my $v = ref($_) eq 'HASH' ? $_->{$name} : $_; |
127 |
if ( $v =~ s/\t+(.+)$// ) { |
128 |
$display->{$v} = $1; |
129 |
} |
130 |
warn "## value '$v'"; |
131 |
push @values, $v; |
132 |
$max_value_len = length($v) if length($v) > $max_value_len; |
133 |
} |
134 |
|
135 |
if ( my $l = $form_value_len->{$name} ) { |
136 |
$max_value_len = $l if $l > $max_value_len; |
137 |
} |
138 |
|
139 |
warn "# max_value_len: $max_value_len"; |
140 |
#my $render = eval $class . '->render_' . $name; |
141 |
my $call = 'render_' . $name; |
142 |
my $render = $self->class->$call if $self->class->can($call); |
143 |
warn "## render $@"; |
144 |
|
145 |
if ( $#values > 3 && $render !~ m{radio} ) { |
146 |
my $options = join("\n", |
147 |
map { |
148 |
my $d = $display->{$_} || $_; |
149 |
qq|<option value="$_">$d</option>|; |
150 |
} @values |
151 |
); |
152 |
# onchange="alert(this.options[this.selectedIndex].value);" |
153 |
$html = qq| |
154 |
<select title="$attr_type" name="$name"> |
155 |
$options |
156 |
</select> |
157 |
| if $options; |
158 |
} else { |
159 |
my $delimiter = $max_value_len > $self->input_step_size ? qq|<br>| : ''; |
160 |
my $radio = |
161 |
# $delimiter . |
162 |
join("\n", |
163 |
map { strip(qq| |
164 |
<span title="$attr_type"> |
165 |
<input type="radio" name="$name" value="$_"> |
166 |
$_ |
167 |
</span> |
168 |
$delimiter |
169 |
|) } @values |
170 |
); |
171 |
if ( $radio ) { |
172 |
|
173 |
$self->add_js('static/Frey/Action.js'); # clear_radio |
174 |
my $js = qq{ |
175 |
onfocus="clear_radio('$form_id','$name'); this.disabled = false;" onblur="clear_radio('$form_id','$name'); this.disabled = true;" |
176 |
}; |
177 |
my $size = int( $max_value_len / $self->input_step_size ) + 1; |
178 |
my $span = qq| |
179 |
<input type="radio" name="$name" value=" " onclick="document.getElementById('new-$name').focus();" > |
180 |
|; |
181 |
|
182 |
if ( $size <= 5 ) { |
183 |
|
184 |
$size *= $self->input_step_size; |
185 |
$span .= qq|<input type="text" name="new-$name" id="new-$name" $js title="enter new value" size="$size">|; |
186 |
|
187 |
} else { |
188 |
|
189 |
my $cols = $self->input_step_size * 5; |
190 |
my $rows = int( $max_value_len / $cols ) + 1; |
191 |
$span .= qq|<textarea name="new-$name" id="new-$name" cols=$cols rows=$rows $js title="enter new value"></textarea>|; |
192 |
|
193 |
} |
194 |
|
195 |
$radio .= qq|<span>$span</span>|; |
196 |
|
197 |
} |
198 |
$html = qq|<div style="display: block;">$radio</div>|; |
199 |
} |
200 |
|
201 |
return $html; |
202 |
} |
203 |
|
204 |
sub params_form { |
205 |
my ( $self ) = @_; |
206 |
|
207 |
foreach my $checkbox ( split(/\s+/, $self->params->{'frey-checkboxes'} ) ) { |
208 |
next if defined $self->params->{ $checkbox }; |
209 |
|
210 |
$self->params->{ $checkbox } = 0; |
211 |
warn "# checkbox $checkbox not ticked"; |
212 |
} |
213 |
|
214 |
my $required = $self->required('as_hash'); |
215 |
if ( grep { $required->{$_} } keys %$required ) { |
216 |
warn $self->class, " required params ", dump( keys %$required ) if $self->debug; |
217 |
} else { |
218 |
warn "all params available ", dump( $self->params ), " not creating form" if $self->debug; |
219 |
return (undef,$self->params) if wantarray; |
220 |
return; |
221 |
} |
222 |
|
223 |
my $class = $self->class; |
224 |
|
225 |
$self->load_class( $class ); |
226 |
|
227 |
my $default = clone $self->params; # XXX we really don't want to modify params! |
228 |
|
229 |
my $params_config = {}; |
230 |
$params_config = $self->config($class); |
231 |
warn "# $class config = ",dump( $params_config ) if $self->debug; |
232 |
|
233 |
my $form; |
234 |
my $form_id = $self->form_id; |
235 |
|
236 |
my @checkboxes; |
237 |
|
238 |
my $label_width = 1; # minimum |
239 |
|
240 |
my @fields = |
241 |
grep { |
242 |
die "$_ doesn't have meta" unless $class->can('meta'); |
243 |
! $class->meta->get_attribute($_)->is_lazy |
244 |
# && ! defined $default->{$_} # XXX show fields with values |
245 |
&& ! m{^_} # skip _private |
246 |
} $self->attributes; |
247 |
|
248 |
my $fieldset; |
249 |
|
250 |
my $last; |
251 |
foreach my $name ( @fields ) { |
252 |
my $set = $name; |
253 |
$set =~ s{_[^_]+$}{}; |
254 |
push @{ $fieldset->{$set} }, $name; |
255 |
} |
256 |
|
257 |
delete( $fieldset->{$_} ) |
258 |
foreach ( grep { $#{ $fieldset->{$_} } == 0 } keys %$fieldset ); |
259 |
|
260 |
warn "# fieldset = ",dump( $fieldset ); |
261 |
|
262 |
foreach my $name ( @fields ) { |
263 |
my $attr_type = ''; |
264 |
my $type = $name =~ m/^pass/ ? 'password' : 'text'; |
265 |
my $label = $name; |
266 |
my $label_title = ''; |
267 |
my $value_html = ''; |
268 |
|
269 |
my $attr = $class->meta->get_attribute( $name ); |
270 |
$attr_type = $attr->type_constraint->name if $attr->has_type_constraint; |
271 |
|
272 |
my $value = |
273 |
defined $default->{$name} ? $default->{$name} : |
274 |
$attr->has_default ? $attr->default( $name ) : |
275 |
undef; |
276 |
|
277 |
if ( defined $params_config && ref($params_config) eq 'HASH' && defined $params_config->{$name} ) { |
278 |
$value = $params_config->{$name}; |
279 |
} elsif ( ref($params_config) eq 'ARRAY' ) { |
280 |
$value_html = $self->select_values( $name, $attr_type, $params_config ); |
281 |
$default->{$name} = $params_config->[0]->{$name}; |
282 |
} elsif ( $attr->has_type_constraint && $attr->type_constraint->can('values') ) { |
283 |
$value_html = $self->select_values( $name, $attr_type, $attr->type_constraint->values ); |
284 |
} elsif ( $class->can( $name . '_available' ) ) { |
285 |
my $available = $name . '_available'; |
286 |
$available = $class->$available; |
287 |
confess $@ if $@; |
288 |
$available =~ s/^\s+//gs; |
289 |
$available =~ s/\s+$//gs; |
290 |
$value_html = $self->select_values( $name, $attr_type, [ split(/\n/,$available) ]); |
291 |
} elsif ( $attr_type =~ m{^Bool} ) { |
292 |
my $suffix = ''; |
293 |
$suffix = ' checked=1' if $value; |
294 |
$value_html = qq|<input type="checkbox" name="$name" title="$attr_type" value=1$suffix>|; |
295 |
push @checkboxes, $name; |
296 |
} elsif ( ! defined $value && ! $required->{$name} ) { |
297 |
$value_html = qq|<tt id="$name">undef</tt><!-- $name = undef -->|; # FIXME if $self->debug |
298 |
} elsif ( $attr_type !~ m{^(Str|Int|Email)$} || $value =~ $Frey::Web::re_html || $name =~ m{text} ) { |
299 |
$value_html = qq|<textarea name="$name" title="$attr_type">$value</textarea>|; |
300 |
} |
301 |
|
302 |
$label_title = qq| title="| . $attr->documentation . qq|"| if $attr->has_documentation; |
303 |
|
304 |
my $value_size = ''; |
305 |
|
306 |
$default->{$name} = $value unless defined $default->{$name}; |
307 |
|
308 |
if ( ! $value_html ) { # fallback to default input type=text |
309 |
|
310 |
my $form_value_len = $self->class->form_value_len->{$name} if $self->class->can('form_value_len'); |
311 |
$form_value_len = length($value) if length($value) > $form_value_len; |
312 |
|
313 |
my $size = ( int( $form_value_len / ( $self->input_step_size * 1.5 ) ) + 1 ) * $self->input_step_size if $form_value_len; |
314 |
$value = qq|value="$value"| if defined $value; |
315 |
$size = qq|size="$size"| if $size; |
316 |
$value_html = qq|<input type="$type" name="$name" title="$attr_type" $value $size>| unless $value_html; |
317 |
|
318 |
} |
319 |
|
320 |
# warn "# required $name ", $class->meta->get_attribute( $name )->dump( 2 ); |
321 |
|
322 |
if ( defined $required->{$name} ) { |
323 |
$label_title .= qq| class="required"|; |
324 |
my $class = 'required'; |
325 |
$class = 'required-filled' if ! $required->{$name}; |
326 |
$value_html =~ s{(<\S+)\s}{$1 class=$class }; |
327 |
} |
328 |
|
329 |
my $set = $name; |
330 |
$set =~ s{_[^_]+$}{}; |
331 |
|
332 |
my ( $before, $after ) = ( '', '<br>' ); |
333 |
|
334 |
if ( my $s = $fieldset->{$set} ) { |
335 |
if ($s->[0] eq $name) { |
336 |
$before = qq| |
337 |
<fieldset> |
338 |
<legend>$set</legend> |
339 |
|; |
340 |
} elsif ( $s->[ -1 ] eq $name ) { |
341 |
$after = qq| |
342 |
</fieldset> |
343 |
|; |
344 |
} |
345 |
$label =~ s{^\Q$set\E_+}{}; |
346 |
} |
347 |
|
348 |
$label = $self->_label( $label ); |
349 |
$form .= qq|$before<label for="$name"$label_title>$label</label>$value_html $after|; |
350 |
my $ll = length($label); |
351 |
$label_width = $ll if $ll > $label_width; |
352 |
} |
353 |
$form .= qq|<input type="hidden" name="frey-checkboxes" value="| . join(' ', @checkboxes) . qq|">| if @checkboxes; |
354 |
|
355 |
$label_width += 2; # XXX padding left+right em |
356 |
|
357 |
$self->add_css(qq| |
358 |
label,input { |
359 |
display: block; |
360 |
float: left; |
361 |
margin-bottom: 10px; |
362 |
} |
363 |
|
364 |
input:focus { |
365 |
border-color: #cc0; |
366 |
background: #ffc; |
367 |
} |
368 |
|
369 |
label { |
370 |
text-align: right; |
371 |
width: ${label_width}ex; |
372 |
padding-right: 1ex; |
373 |
white-space: nowrap; |
374 |
} |
375 |
|
376 |
label.required { |
377 |
font-weight: bold; |
378 |
} |
379 |
|
380 |
input.required, |
381 |
select.required { |
382 |
border-color: #c00; |
383 |
} |
384 |
input.required-filled, |
385 |
select.required-filled { |
386 |
border-color: #0c0; |
387 |
} |
388 |
|
389 |
br { |
390 |
clear: left; |
391 |
} |
392 |
|
393 |
fieldset { |
394 |
margin: 0; |
395 |
padding: 0; |
396 |
margin-bottom: 0.5em; |
397 |
} |
398 |
|); |
399 |
|
400 |
my $html; |
401 |
|
402 |
# http://www.quirksmode.org/oddsandends/forms.html |
403 |
# $form =~ s{<([^>]+)(name=")([^"]+)(")([^>]*)>}{<$1$2$3$4 id="$3" $5}gs; |
404 |
|
405 |
if ( $form ) { |
406 |
|
407 |
if ( $self->class->can('form_header') ) { |
408 |
$html = $self->class->form_header; |
409 |
} else { |
410 |
$html = qq| |
411 |
<h1>$class params</h1> |
412 |
|; |
413 |
} |
414 |
|
415 |
my $submit = $self->_label( 'submit' ); |
416 |
$submit =~ s{^submit$}{Run $class}; |
417 |
|
418 |
$html .= qq| |
419 |
<form name="$form_id" id="$form_id" method="post"> |
420 |
$form |
421 |
<input type="submit" value="$submit"> |
422 |
</form> |
423 |
|; |
424 |
$html .= $self->class->form_footer if $self->class->can('form_footer'); |
425 |
} |
426 |
|
427 |
$self->add_status({ |
428 |
$self->class => { |
429 |
params => $self->params, |
430 |
params_config => $params_config, |
431 |
default => $default, |
432 |
}, |
433 |
}); |
434 |
|
435 |
if ( $self->class->can('title') ) { |
436 |
my $title = eval { |
437 |
$self->class->title; |
438 |
}; |
439 |
$self->title( $title ) if defined $title && ! $@; |
440 |
} |
441 |
|
442 |
return ($html,$default) if wantarray; |
443 |
return $html; |
444 |
} |
445 |
|
446 |
sub _label { |
447 |
my ($self,$name) = @_; |
448 |
my $labels = $self->class->form_labels if $self->class->can('form_labels'); |
449 |
my $label = $labels->{$name}; |
450 |
if ( ! defined $label ) { |
451 |
$label = $name; |
452 |
$label =~ s{_}{ }g; |
453 |
} |
454 |
return $label; |
455 |
} |
456 |
|
457 |
=head1 SEE ALSO |
458 |
|
459 |
L<http://www.quirksmode.org/css/forms.html> for info on CSS2 forms |
460 |
|
461 |
=cut |
462 |
|
463 |
__PACKAGE__->meta->make_immutable; |
464 |
no Moose; |
465 |
|
466 |
1; |