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