60 char soft max length for packages, so invoices don't wrap, RT#4328
[freeside.git] / httemplate / edit / elements / edit.html
1 <%doc>
2
3 Example:
4
5   include( 'elements/edit.html',  
6     'name_singular' =>  #singular name for the record
7                         # (preferred, will be pluralized automatically)
8     'name'          =>  #name for the record
9                         # (deprecated, will be pluralized simplistically)
10     'table'         =>
11
12     #? 'primary_key' => #required when the dbdef doesn't know...???
13     'labels' => {
14                   'column' => 'Label',
15                 }
16    
17     #listref - each item is a literal column name (or method) or hashref
18     #                                                        or (notyet) coderef
19     #if not specified all columns (except for the primary key) will be editable
20     'fields' => [
21                   'columname',
22                   { 'field' => 'another_columname',
23                     'type'  => 'text', #text
24                                        #password
25                                        #money
26                                        #percentage
27                                        #checkbox
28                                        #select
29                                        #selectlayers (can now use after a tablebreak-tr-title... but not inside columnstart/columnnext/columnend)
30                                        #title
31                                        #tablebreak-tr-title
32                                        #columnstart
33                                        #columnnext
34                                        #columnend
35                                        #hidden - hidden value from object
36                                        #fixed - display fixed value from object or here
37                                        #fixed-country
38                                        #fixed-state
39                     'value' => 'Y', #for checkbox, title, fixed, fixedhidden
40                     'disabled' => 0,
41                     'onchange' => 'javascript_function',
42
43                     #m2 stuff only tested w/selectlayers so far
44                     #might work w/select too, dunno others
45                     'm2name_table'   => 'table_name',
46                     'm2name_namecol' => 'name_column',
47                     #OR#
48                     'm2m_method'       =>
49                     #'m2m_srccol'  => #opt, if not the same as this table
50                     'm2m_dstcol'  => #required for now, eventuaully opt, if not the same as target table
51
52                     'm2_label'   => 'Label',        #
53                     'm2_new_default' => \@table_name_objects, #default
54                                                               #m2 objects for
55                                                               #new records
56                     'm2_error_callback' => sub { my($cgi, $object) = @_; },
57                     'm2_remove_warnings' => \%warnings, #hashref of warning
58                                                         #messages for m2
59                                                         #removal
60                     'm2_new_js' => 'function_name', #javascript function called
61                                                     #on spawned rows (one arg:
62                                                     #new_element)
63                     'm2_remove_js' => 'function_name', #js function called when
64                                                        #a row is deleted (three
65                                                        #args: value, text,
66                                                        #'no_match')
67                     #layer_fields & layer_values_callback only for selectlayer
68                     'layer_fields' => [
69                                         'fieldname'     => 'Label',
70                                         'another_field' => {
71                                           label=>'Label',
72                                           type =>'text', #text, money
73                                         },
74                                       ],
75                     'layer_values_callback' =>
76                       sub {
77                             my( $cgi, $object ) = @_;
78                             { 'layer'  => { 'fieldname'  => 'current_value',
79                                             'fieldname2' => 'field2value',
80                                             ...
81                                           },
82                               'layer2' => { 'l2fieldname' => 'l2value',
83                                             ...
84                                           },
85                               ...
86                             };
87                           },
88                   },
89                 ]
90    
91     'menubar'     => '', #menubar arrayref
92
93     #agent virtualization
94     'agent_virt'       => 1,
95     'agent_null_right' => 'Access Right Name',
96    
97     #run when re-displaying with an error
98     'error_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
99    
100     #run when editing
101     'edit_callback' => sub { my( $cgi, $object, $fields_listref ) = @_; },
102    
103     # returns a hashref for the new object
104     'new_hashref_callback'
105
106     # returns the new object iself (otherwise, ->new is called)
107     'new_object_callback'
108    
109     #run when adding
110     'new_callback' => sub { my( $cgi, $object, $fields_listref ) = @_; },
111    
112     #run before display to return a different value
113     'value_callback' => sub { my( $columname, $value ) = @_; },
114
115     #run before display to manipulate element of the 'fields' arrayref
116     'field_callback' => sub { my( $cgi, $object, $field_hashref ) = @_; },
117
118     'viewall_dir' => '', #'search' or 'browse', defaults to 'search'
119
120     'html_init'   => '', #after the header/menubar
121
122     #string or coderef of additional HTML to add before </TABLE>
123     'html_table_bottom' => '',
124
125     #after </TABLE> but before the submit
126     'html_bottom' => '', #string
127     'html_bottom' => sub {
128                            my $object = shift;
129                            # ...
130                            "html_string";
131                          },
132     
133     #at the very bottom (well, as low as you can go from here)
134     'html_foot'  => '',
135
136     # overrides default popurl(1)."process/$table.html"
137     'post_url' => popurl(1).'process/something', 
138
139     #we're in a popup (no title/menu/searchboxes)
140     'popup' => 1,
141    
142   );
143
144 </%doc>
145
146 <% include('/elements/header'. ( $opt{popup} ? '-popup' : '' ). '.html',
147               $title,
148               include( '/elements/menubar.html', @menubar )
149            )
150 %>
151
152 <% defined($opt{'html_init'}) 
153       ? ( ref($opt{'html_init'})
154             ? &{$opt{'html_init'}}()
155             : $opt{'html_init'}
156         )
157       : ''
158 %>
159
160 <% include('/elements/error.html') %>
161
162 % my $url = $opt{'post_url'} || popurl(1)."process/$table.html";
163
164 <FORM ACTION="<% $url %>" METHOD=POST NAME="edit_topform">
165
166 <INPUT TYPE="hidden" NAME="svcdb" VALUE="<% $table %>">
167 <INPUT TYPE="hidden" NAME="<% $pkey %>" VALUE="<% $clone ? '' : $object->$pkey() %>">
168
169 <FONT SIZE="+1"><B>
170 <% ( $opt{labels} && exists $opt{labels}->{$pkey} )
171       ? $opt{labels}->{$pkey}
172       : $pkey
173 %>
174 </B></FONT>
175 #<% ( !$clone && $object->$pkey() ) || "(NEW)" %>
176
177 % my $tablenum = 0;
178 <TABLE ID="TableNumber<% $tablenum++ %>" BGCOLOR="#cccccc" BORDER=0 CELLSPACING=0>
179
180 % my $g_row = 0;
181 % my @g_row_stack = ();
182 % foreach my $f ( map { ref($_) ? $_ : {'field'=>$_} }
183 %                       @$fields
184 %                 ) {
185 %
186 %   my $trash = &{ $opt{'field_callback'} }( $cgi, $object, $f )
187 %     if $opt{'field_callback'};
188 %
189 %   my $field = $f->{'field'};
190 %   my $type = $f->{'type'} ||= 'text';
191 %
192 %   my $label = ( $opt{labels} && exists $opt{labels}->{$field} )
193 %                   ? $opt{labels}->{$field}
194 %                   : $field;
195 %
196 %   my $onchange = $f->{'onchange'};
197 %
198 %   my $layer_values = {};
199 %   $layer_values = &{ $f->{'layer_values_callback'} }( $cgi, $object )
200 %     if $f->{'layer_values_callback'}
201 %     && ! $f->{'m2name_table'}
202 %     && ! $f->{'m2m_method'};
203 %
204 %   warn "layer values: ". Dumper($layer_values)
205 %     if $opt{'debug'};
206 %
207 %   my %include_common = (
208 %
209 %     #text and derivitives
210 %     'size'          => $f->{'size'},
211 %     'maxlength'     => $f->{'maxlength'},
212 %
213 %     #checkbox, title, fixed, fixedhidden
214 %     #& deprecated weird value hashref used only by reason.html
215 %     'value'         => $f->{'value'},
216 %
217 %     #select(-*)
218 %     'options'       => $f->{'options'},
219 %     'labels'        => $f->{'labels'},
220 %     'multiple'      => $f->{'multiple'},
221 %     'disable_empty' => $f->{'disable_empty'},
222 %     #select-reason
223 %     'reason_class'  => $f->{'reason_class'},
224 %
225 %     #selectlayers
226 %     'layer_fields'  => $f->{'layer_fields'},
227 %     'layer_values'  => $layer_values,
228 %     'html_between'  => $f->{'html_between'},
229 %
230 %     #umm.
231 %     'disabled'      => $f->{'disabled'},
232 %   );
233 %
234 %   #selectlayers, others?
235 %   $include_common{$_} = $f->{$_}
236 %     foreach grep exists($f->{$_}),
237 %                  qw( js_only html_only select_only layers_only cell_style);
238 %
239 %   #select-*
240 %   $include_common{$_} = $f->{$_}
241 %     foreach grep exists($f->{$_}), qw( empty_label );
242 %
243 %   #select-table, checkboxes-table
244 %   $include_common{$_} = $f->{$_}
245 %     foreach grep exists($f->{$_}), qw( table name_col );
246 %
247 %   #checkboxes-table
248 %   $include_common{$_} = $f->{$_}
249 %     foreach grep exists($f->{$_}), qw( target_table link_table );
250 %
251 %   #*-table
252 %   $include_common{$_} = $f->{$_}
253 %     foreach grep exists($f->{$_}), qw( hashref agent_virt agent_null_right );
254 %
255 %   if ( $type eq 'tablebreak-tr-title' ) {
256 %     $include_common{'table_id'} = 'TableNumber'. $tablenum++
257 %   }
258 %
259 %   my $layer_prefix_on = '';
260 %
261 %   my $include_sub = sub {
262 %     my %opt = @_;
263 %
264 %     my $fieldnum   = delete $opt{'fieldnum'};
265 %
266 %     my $include = $type;
267 %     $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
268 %     $include = "tr-$include" unless $include =~ /^(hidden|tablebreak|column)/;
269 %
270 %     $include_common{'layer_prefix'} = "$field$fieldnum."
271 %       if $layer_prefix_on;
272 %
273 %     my @include = 
274 %     ( "/elements/$include.html",
275 %         'field'      => "$field$fieldnum",
276 %         'id'         => "$field$fieldnum", #separate?
277 %         'label_id'   => $field."_label$fieldnum", #don't want field0_label0...
278 %         %include_common,
279 %         %opt,
280 %     );
281 %     @include;
282 %   };
283 %
284 %   unless ( $type =~ /^column/ ) {
285 %     $g_row = 1 if $type eq 'tablebreak-tr-title';
286 %     $g_row++;
287 %     $g_row++ if $type eq 'title';
288 %   } else {
289 %     if ( $type eq 'columnstart' ) {
290 %       push @g_row_stack, $g_row;
291 %       $g_row = 0;
292 %     #} elsif ( $type eq 'columnnext' ) {
293 %     } elsif ( $type eq 'columnend' ) {
294 %       $g_row = pop @g_row_stack; 
295 %     }
296 %  
297 %   }
298 %
299 %   my $fieldnum = '';
300 %   my $curr_value = '';
301 %   if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) { #XXX test this for all
302 %                                                      #types of fields
303 %     my($table, $col);
304 %     if ( $f->{'m2name_table'} ) {
305 %       $table = $f->{'m2name_table'};
306 %       $col   = $f->{'m2name_namecol'};
307 %     } elsif ( $f->{'m2m_method'} ) {
308 %       $table = $f->{'m2m_method'};
309 %       $col   = $f->{'m2m_dstcol'};
310 %     }
311 %     $fieldnum = 0;
312 %     $layer_prefix_on = 1;
313 %     #print out the fields for the existing m2s
314 %     my @existing = ();
315 %     if ( $mode eq 'error' ) {
316 %       @existing = &{ $f->{'m2_error_callback'} }( $cgi, $object );
317 %     } elsif ( $object->$pkey() ) { # $mode eq 'edit'||'clone'
318 %       @existing = $object->$table();
319 %      warn scalar(@existing). " from $object->$table: ". join('/', @existing)
320 %        if $opt{'debug'};
321 %     } elsif ( $f->{'m2_new_default'} ) { # && $mode eq 'new'
322 %       @existing = @{ $f->{'m2_new_default'} };
323 %     }
324 %     foreach my $name_obj ( @existing ) {
325 %
326 %       my $ex_label = '<INPUT TYPE="button" VALUE="X" TITLE="Remove this '.
327 %                      lc($f->{'m2_label'}).
328 %                      qq(" onClick="remove_$field($fieldnum);").
329 %                      ' STYLE="color:#ff0000;font-weight:bold;'.
330 %                              'padding-left:2px;padding-right:2px"'.
331 %                      '>&nbsp;'. ($f->{'m2_label'} || $field ). ' ';
332 %       
333 %       if ( $f->{'layer_values_callback'} ) {
334 %         my %switches = ( 'mode' => $mode );
335 %         $layer_values =
336 %           &{ $f->{'layer_values_callback'} }( $cgi, $name_obj, \%switches );
337 %       }
338 %       warn "layer values: ". Dumper($layer_values)
339 %         if $opt{'debug'};
340 %
341 %       my @existing = &{ $include_sub }(
342 %         'label'        => $ex_label,
343 %         'fieldnum'     => $fieldnum,
344 %         'curr_value'   => $name_obj->$col(),
345 %         'onchange'     => $onchange,
346 %         'layer_values' => $layer_values,
347 %         'cell_style'   => ( $fieldnum ? 'border-top:1px solid black' : '' ),
348 %       );
349
350         <% include( @existing ) %>
351
352 %       $fieldnum++;
353 %       $g_row++;
354 %     }
355 %     #$field .= $fieldnum;
356 %     $onchange .= "\nspawn_$field(what);";
357 %   } else {
358 %     if ( $f->{curr_value_callback} ) {
359 %       $curr_value = &{ $f->{curr_value_callback} }( $cgi, $object, $field ),
360 %     } else {
361 %       $curr_value = $object->$field();
362 %     }
363 %     $curr_value = &{ $opt{'value_callback'} }( $f->{'field'}, $curr_value )
364 %       if $opt{'value_callback'} && $mode ne 'error';
365 %   }
366 %
367 %   my @include = &{ $include_sub }(
368 %     'label'      => $label,
369 %     'fieldnum'   => $fieldnum,
370 %     'curr_value' => $curr_value,
371 %     'object'     => $object,
372 %     'cgi'        => $cgi,
373 %     'onchange'   => $onchange,
374 %     ( $fieldnum ? ('cell_style' => 'border-top:1px solid black') : () ),
375 %   );
376
377     <% include( @include ) %>
378
379 %   if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) {
380
381       <SCRIPT TYPE="text/javascript">
382
383         var <%$field%>_rownum = <% $g_row %>;
384         var <%$field%>_fieldnum = <% $fieldnum %>;
385
386         function spawn_<%$field%>(what) {
387
388           // only spawn if we're the last element... return if not
389
390           var field_regex = /(\d+)$/;
391           var match = field_regex.exec(what.name);
392           if ( !match ) {
393             alert(what.name + " didn't match?!");
394             return;
395           }
396           if ( match[1] != <%$field%>_fieldnum ) {
397             return;
398           }
399
400           // change the label on the last entry & add a remove button
401           var prev_label = document.getElementById('<% $field %>_label' + <%$field%>_fieldnum );
402           prev_label.innerHTML = '<INPUT TYPE="button" VALUE="X" TITLE="Remove this <% lc($f->{'m2_label'}) %>" onClick="remove_<% $field %>(' + <%$field%>_fieldnum + ');" STYLE="color:#ff0000;font-weight:bold;padding-left:2px;padding-right:2px" >&nbsp;<% $f->{'m2_label'} || $field %>';
403
404           <%$field%>_fieldnum++;
405
406           //get the new widget
407
408 %         $include[0] =~ s(^/elements/tr-)(/elements/);
409 %         my @layer_opt = ( @include,
410 %                           'field'        => $field."MAGIC_NUMBER",
411 %                           'id'           => $field."MAGIC_NUMBER",
412 %                           'layer_prefix' => $field."MAGIC_NUMBER.",
413 %                         );
414 %         warn @layer_opt if $opt{'debug'};
415
416           var newrow =  <% include(@layer_opt, html_only=>1) |js_string %>;
417
418 %         if ( $type eq 'selectlayers' ) { #until the rest have html/js_only
419             var newfunc = <% include(@layer_opt, js_only  =>1) |js_string %>;
420 %         } else {
421             var newfunc = '';
422 %         }
423
424           // substitute in the new field name
425           var magic_regex = /MAGIC_NUMBER/g;
426           newrow  = newrow.replace(  magic_regex, <%$field%>_fieldnum );
427           newfunc = newfunc.replace( magic_regex, <%$field%>_fieldnum );
428
429           // evaluate new_func
430           if (window.ActiveXObject) {
431             window.execScript(newfunc);
432           } else { /* (window.XMLHttpRequest) */
433             //window.eval(newfunc);
434             setTimeout(newfunc, 0);
435           }
436
437           // add new row
438
439           //hmm, can't use selectlayers after a tablebreak-title for now
440           var table = document.getElementById('TableNumber<% $tablenum-1 %>');
441
442           var row = table.insertRow(<%$field%>_rownum++);
443
444           var label_cell = document.createElement('TD');
445
446           label_cell.id = '<% $field %>_label' + <%$field%>_fieldnum;
447
448           label_cell.style.textAlign = "right";
449           label_cell.style.verticalAlign = "top";
450           label_cell.style.borderTop = "1px solid black";
451           label_cell.style.paddingTop = "5px";
452
453           label_cell.innerHTML = '<% $label %>';
454
455           row.appendChild(label_cell);
456           
457           var widget_cell = document.createElement('TD');
458
459           widget_cell.style.borderTop = "1px solid black";
460           widget_cell.style.paddingTop = "3px";
461
462           widget_cell.innerHTML = newrow;
463
464           row.appendChild(widget_cell);
465
466 %         if ( $f->{'m2_new_js'} ) {
467             // take out items selected in previous dropdowns
468             var new_element = document.getElementById("<%$field%>" + <%$field%>_fieldnum );
469             <% $f->{'m2_new_js'} %>(new_element);
470
471             if ( new_element.length < 2 ) {
472               //just the ** Select new **, so don't display the row
473               row.style.display = 'none';
474             }
475 %         }
476
477         }
478
479         function remove_<%$field%>(remove_fieldnum) {
480           //alert("remove <%$field%> " + remove_fieldnum);
481           var select = document.getElementById('<%$field%>' + remove_fieldnum);
482
483           if ( ! select ) {
484             alert("can't find element <%$field%>" + remove_fieldnum);
485             return;
486           }
487
488 %         my $warnings = $f->{'m2_remove_warnings'};
489 %         if ( $warnings ) {
490             var sel_value = select.options[select.selectedIndex].value;
491 %           foreach my $value ( keys %$warnings ) {
492               if ( sel_value == '<% $value %>' ) {
493                 if ( ! confirm( <% $warnings->{$value} |js_string %> ) ) {
494                   return;
495                 }
496               }
497 %           }
498 %         }
499
500           select.disabled = 'disabled'; // this seems to prevent it from being submitted on tested browsers so far (IE, moz, konq at least)
501           var label_td = document.getElementById('<%$field%>_label' + remove_fieldnum );
502           label_td.parentNode.style.display = 'none';
503
504 %         if ( $f->{m2_remove_js} ) {
505             var opt = select.options[select.selectedIndex];
506             <% $f->{m2_remove_js} %>( opt.value, opt.text, 'no_match');
507 %         }
508
509         }
510
511       </SCRIPT>
512
513 %   }
514
515 % } 
516
517 <% ref( $opt{'html_table_bottom'} )
518       ? &{ $opt{'html_table_bottom'} }( $object )
519       : $opt{'html_table_bottom'}
520 %>
521
522 </TABLE>
523
524 <% ref( $opt{'html_bottom'} )
525       ? &{ $opt{'html_bottom'} }( $object )
526       : $opt{'html_bottom'}
527 %>
528
529 <BR>
530
531 <INPUT TYPE="submit" ID="submit" VALUE="<% ( !$clone && $object->$pkey() ) ? "Apply changes" : "Add $opt{'name'}" %>">
532
533 </FORM>
534
535 <% ref( $opt{'html_foot'} )
536       ? &{ $opt{'html_foot'} }( $object )
537       : $opt{'html_foot'}
538 %>
539
540 <% include("/elements/footer.html") %>
541 <%init>
542
543 my(%opt) = @_;
544
545 my $curuser = $FS::CurrentUser::CurrentUser;
546
547 #false laziness w/process.html
548 my $table = $opt{'table'};
549 my $class = "FS::$table";
550 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} || 
551 my $fields = $opt{'fields'}
552              #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
553              || [ grep { $_ ne $pkey } fields($table) ];
554 #my @actualfields = map { ref($_) ? $_->{'field'} : $_ } @$fields;
555
556 if ( $cgi->param('redirect') ) {
557   my $session = $cgi->param('redirect');
558   my $pref = $curuser->option("redirect$session");
559   die "unknown redirect session $session\n" unless length($pref);
560   $cgi = new CGI($pref);
561 }
562
563 my %qsearch = (
564     'table'     => $table,
565     'extra_sql' => ( $opt{'agent_virt'}
566                        ? ' AND '. $curuser->agentnums_sql(
567                                     'null_right' => $opt{'agent_null_right'}
568                                   )
569                        : ''
570                    ),
571 );
572
573 my $mode;
574 my $object;
575 my $clone = '';
576 if ( $cgi->param('error') ) {
577
578   $mode = 'error';
579
580   $object = $class->new( {
581     map { $_ => scalar($cgi->param($_)) } fields($table)
582   });
583
584   &{$opt{'error_callback'}}($cgi, $object, $fields, \%opt )
585     if $opt{'error_callback'};
586
587 } elsif ( $cgi->param('clone') =~ /^(\d+)$/ ) {
588
589   $mode = 'clone';
590
591   $clone = $1;
592
593   $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $clone } });
594
595   #XXX document me
596   &{$opt{'clone_callback'}}($cgi, $object, $fields)
597     if $opt{'clone_callback'};
598
599   #$object->$pkey('');
600
601   $opt{action} ||= 'Add';
602
603 } elsif ( $cgi->keywords || $cgi->param($pkey) ) { #editing
604
605   $mode = 'edit';
606
607   my $value;
608   if ( $cgi->param($pkey) ) {
609     $value = $cgi->param($pkey)
610   } else { 
611     my( $query ) = $cgi->keywords;
612     $value = $query;
613   }
614   $value =~ /^(\d+)$/ or die "unparsable $pkey";
615   $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $1 } });
616   
617   warn "$table $pkey => $1"
618     if $opt{'debug'};
619
620   &{$opt{'edit_callback'}}($cgi, $object, $fields)
621     if $opt{'edit_callback'};
622
623 } else { #adding
624
625   $mode = 'new';
626
627   my $hashref = $opt{'new_hashref_callback'}
628                   ? &{$opt{'new_hashref_callback'}}
629                   : {};
630
631   $object = $opt{'new_object_callback'}
632               ? &{$opt{'new_object_callback'}}( $cgi, $hashref, $fields, \%opt )
633               : $class->new( $hashref );
634
635   &{$opt{'new_callback'}}($cgi, $object, $fields)
636     if $opt{'new_callback'};
637
638 }
639
640 $opt{action} ||= $object->$pkey() ? 'Edit' : 'Add';
641
642 my $title = $opt{action}. ' '. $opt{name};
643
644 my $viewall_url = $p . ( $opt{'viewall_dir'} || 'search' ) . "/$table.html";
645 $viewall_url = $opt{'viewall_url'} if $opt{'viewall_url'};  
646
647 my @menubar = ();
648 if ( $opt{'menubar'} ) {
649   @menubar = @{ $opt{'menubar'} };
650 } else {
651   my $items = $opt{'name'} ? $opt{'name'}.'s' : PL($opt{'name_singular'});
652   @menubar = (
653     "View all $items" => $viewall_url,
654   );
655 }
656
657 </%init>