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