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)
12 #? 'primary_key' => #required when the dbdef doesn't know...???
17 #listref - each item is a literal column name (or method) or hashref
19 #if not specified all columns (except for the primary key) will be editable
22 { 'field' => 'another_columname',
23 'type' => 'text', #text
29 #selectlayers (can now use after a tablebreak-tr-title... but not inside columnstart/columnnext/columnend)
35 #hidden - hidden value from object
36 #fixed - display fixed value from object or here
39 'value' => 'Y', #for checkbox, title, fixed, hidden
41 'onchange' => 'javascript_function',
43 'include_opt_callback' => sub { my $object = @_;
44 ( 'option' => 'value', );
47 'm2name_table' => 'table_name',
48 'm2name_namecol' => 'name_column',
51 #'m2m_srccol' => #opt, if not the same as this table
52 'm2m_dstcol' => #required for now, eventuaully opt, if not the same as target table
56 'm2_label' => 'Label', #
57 'm2_new_default' => \@table_name_objects, #default
60 'm2_error_callback' => sub { my($cgi, $object) = @_; },
61 'm2_remove_warnings' => \%warnings, #hashref of warning
64 'm2_new_js' => 'function_name', #javascript function called
65 #on spawned rows (one arg:
67 'm2_remove_js' => 'function_name', #js function called when
68 #a row is deleted (three
71 #layer_fields & layer_values_callback only for selectlayer
73 'fieldname' => 'Label',
76 type =>'text', #text, money
79 'layer_values_callback' =>
81 my( $cgi, $object ) = @_;
82 { 'layer' => { 'fieldname' => 'current_value',
83 'fieldname2' => 'field2value',
86 'layer2' => { 'l2fieldname' => 'l2value',
95 'menubar' => '', #menubar arrayref
99 'agent_null_right' => 'Access Right Name',
100 'agent_clone_extra_sql' => '', #if provided, this overrides the extra_sql
101 #implementing agent virt, for clone
102 #operations. i.e. pass "1=1" to allow
105 'viewall_dir' => '', #'search' or 'browse', defaults to 'search'
107 # overrides default popurl(1)."process/$table.html"
108 'post_url' => popurl(1).'process/something',
110 #we're in a popup (no title/menu/searchboxes)
117 'body_etc' => '', # Additional BODY attributes, i.e. onLoad=""
119 'html_init' => '', #after the header/menubar
121 #string or coderef of additional HTML to add before </TABLE>
122 'html_table_bottom' => '',
124 #after </TABLE> but before the submit
125 'html_bottom' => '', #string
126 'html_bottom' => sub {
132 #at the very bottom (well, as low as you can go from here)
136 # initialization callbacks
139 ###global callbacks, always run if provided
141 #after decoding long CGI "redirect=" responses but
142 # before object creation/search
143 # (useful if you have a long form that might trigger redirect= and you need
144 # to do things with $cgi params - they're not decoded in the calling
146 'begin_callback' = sub { my( $cgi, $fields_listref, $opt_hashref ) = @_; },
148 #after the mode-specific object creation/search
149 'end_callback' = sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
151 ###mode-specific callbacks. one (and only one) of these four is called
154 'new_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
157 'edit_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
159 #run when re-displaying with an error
160 'error_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
163 'clone_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
165 ###callbacks called in new mode only
167 # returns a hashref for the new object
168 'new_hashref_callback'
170 # returns the new object iself (otherwise, ->new is called)
171 'new_object_callback'
175 #run before display to return a different value
176 'value_callback' => sub { my( $columname, $value ) = @_; },
178 #run before display to manipulate element of the 'fields' arrayref
179 'field_callback' => sub { my( $cgi, $object, $field_hashref ) = @_; },
185 <% include('/elements/header'. ( $opt{popup} ? '-popup' : '' ). '.html',
187 include( '/elements/menubar.html', @menubar ),
192 <% defined($opt{'html_init'})
193 ? ( ref($opt{'html_init'})
194 ? &{$opt{'html_init'}}()
200 <% include('/elements/error.html') %>
202 % my $url = $opt{'post_url'} || popurl(1)."process/$table.html";
204 <FORM ACTION="<% $url %>" METHOD=POST NAME="edit_topform">
206 <INPUT TYPE="hidden" NAME="svcdb" VALUE="<% $table %>">
207 <INPUT TYPE="hidden" NAME="<% $pkey %>" VALUE="<% $clone ? '' : $object->$pkey() %>">
210 <% ( $opt{labels} && exists $opt{labels}->{$pkey} )
211 ? $opt{labels}->{$pkey}
215 #<% ( !$clone && $object->$pkey() ) || "(NEW)" %>
218 <TABLE ID="TableNumber<% $tablenum++ %>" BGCOLOR="#cccccc" BORDER=0 CELLSPACING=0>
221 % my @g_row_stack = ();
222 % foreach my $f ( map { ref($_) ? $_ : {'field'=>$_} }
226 % my $trash = &{ $opt{'field_callback'} }( $cgi, $object, $f )
227 % if $opt{'field_callback'};
229 % my $field = $f->{'field'};
230 % my $type = $f->{'type'} ||= 'text';
232 % my $label = ( $opt{labels} && exists $opt{labels}->{$field} )
233 % ? $opt{labels}->{$field}
236 % my $onchange = $f->{'onchange'};
238 % my $layer_values = {};
239 % $layer_values = &{ $f->{'layer_values_callback'} }( $cgi, $object )
240 % if $f->{'layer_values_callback'}
241 % && ! $f->{'m2name_table'}
242 % && ! $f->{'o2m_table'}
243 % && ! $f->{'m2m_method'};
245 % warn "layer values: ". Dumper($layer_values)
248 % my %include_common = (
250 % #text and derivitives
251 % 'size' => $f->{'size'},
252 % 'maxlength' => $f->{'maxlength'},
253 % 'postfix' => $f->{'postfix'},
255 % #checkbox, title, fixed, hidden
256 % #& deprecated weird value hashref used only by reason.html
257 % 'value' => $f->{'value'},
260 % 'options' => $f->{'options'},
261 % 'labels' => $f->{'labels'},
262 % 'multiple' => $f->{'multiple'},
263 % 'disable_empty' => $f->{'disable_empty'},
265 % 'reason_class' => $f->{'reason_class'},
268 % 'layer_fields' => $f->{'layer_fields'},
269 % 'layer_values' => $layer_values,
270 % 'html_between' => $f->{'html_between'},
272 % #umm. for select-agent_types at least
273 % 'disabled' => $f->{'disabled'},
276 % #selectlayers, others?
277 % $include_common{$_} = $f->{$_}
278 % foreach grep exists($f->{$_}),
279 % qw( js_only html_only select_only layers_only cell_style);
282 % $include_common{$_} = $f->{$_}
283 % foreach grep exists($f->{$_}), qw( empty_label );
286 % $include_common{$_} = $f->{$_}
287 % foreach grep exists($f->{$_}), qw( value_col extra_sql );
289 % #select-table, checkboxes-table
290 % $include_common{$_} = $f->{$_}
291 % foreach grep exists($f->{$_}), qw( table name_col );
294 % $include_common{$_} = $f->{$_}
295 % foreach grep exists($f->{$_}), qw( target_table link_table );
298 % $include_common{$_} = $f->{$_}
299 % foreach grep exists($f->{$_}), qw( hashref agent_virt agent_null_right );
301 % if ( $type eq 'tablebreak-tr-title' ) {
302 % $include_common{'table_id'} = 'TableNumber'. $tablenum++;
304 % if ( $type eq 'tablebreak-tr-title' || $type eq 'title' ) {
305 % $include_common{'colspan'} = $f->{colspan} if $f->{colspan};
308 % if ( $f->{include_opt_callback} ) {
309 % %include_common = ( %include_common,
310 % &{ $f->{include_opt_callback} }( $object )
314 % my $layer_prefix_on = '';
316 % my $include_sub = sub {
319 % my $fieldnum = delete $opt{'fieldnum'};
321 % my $include = $type;
322 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
323 % $include = "tr-$include" unless $include =~ /^(hidden|tablebreak|column)/;
325 % $include_common{'layer_prefix'} = "$field$fieldnum."
326 % if $layer_prefix_on;
329 % ( "/elements/$include.html",
330 % 'field' => "$field$fieldnum",
331 % 'id' => "$field$fieldnum", #separate?
332 % 'label_id' => $field."_label$fieldnum", #don't want field0_label0...
339 % my $column_sub = sub {
342 % my $column = delete($opt{field});
343 % my $fieldnum = delete($opt{fieldnum});
344 % my $include = delete($opt{type}) || 'text';
345 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
347 % ( "/elements/$include.html",
348 % 'field' => $field.'__'.$column.$fieldnum,
349 % 'id' => $field.'__'.$column.$fieldnum,
350 % 'layer_prefix' => $field.'__'.$column.$fieldnum.".",
352 % ? ('cell_style' => 'border-top:1px solid black')
360 % unless ( $type =~ /^column/ ) {
361 % $g_row = 1 if $type eq 'tablebreak-tr-title';
363 % $g_row++ if $type eq 'title';
365 % if ( $type eq 'columnstart' ) {
366 % push @g_row_stack, $g_row;
368 % #} elsif ( $type eq 'columnnext' ) {
369 % } elsif ( $type eq 'columnend' ) {
370 % $g_row = pop @g_row_stack;
376 % my $curr_value = '';
377 % if ( $f->{'m2name_table'} || $f->{'o2m_table'} || $f->{'m2m_method'} ) {
380 % if ( $f->{'m2name_table'} ) {
381 % $table = $f->{'m2name_table'};
382 % $col = $f->{'m2name_namecol'};
383 % } elsif ( $f->{'o2m_table'} ) {
384 % $table = $f->{'o2m_tbekable'};
385 % $col = dbdef->table($f->{'o2m_table'})->primary_key;
386 % } elsif ( $f->{'m2m_method'} ) {
387 % $table = $f->{'m2m_method'};
388 % $col = $f->{'m2m_dstcol'};
391 % $layer_prefix_on = 1;
392 % #print out the fields for the existing m2s
394 % if ( $mode eq 'error' ) {
395 % @existing = &{ $f->{'m2_error_callback'} }( $cgi, $object );
396 % } elsif ( $object->$pkey() ) { # $mode eq 'edit'||'clone'
397 % @existing = $object->$table();
398 % warn scalar(@existing). " from $object->$table: ". join('/', @existing)
400 % } elsif ( $f->{'m2_new_default'} ) { # && $mode eq 'new'
401 % @existing = @{ $f->{'m2_new_default'} };
403 % foreach my $name_obj ( @existing ) {
405 % my $ex_label = '<INPUT TYPE="button" VALUE="X" TITLE="Remove this '.
406 % lc($f->{'m2_label'}).
407 % qq(" onClick="remove_$field($fieldnum);").
408 % ' STYLE="color:#ff0000;font-weight:bold;'.
409 % 'padding-left:2px;padding-right:2px"'.
410 % '> '. ($f->{'m2_label'} || $field ). ' ';
412 % if ( $f->{'layer_values_callback'} ) {
413 % my %switches = ( 'mode' => $mode );
415 % &{ $f->{'layer_values_callback'} }( $cgi, $name_obj, \%switches );
417 % warn "layer values: ". Dumper($layer_values)
420 % my @existing = &{ $include_sub }(
421 % 'label' => $ex_label,
422 % 'fieldnum' => $fieldnum,
423 % 'curr_value' => $name_obj->$col(),
424 % 'onchange' => $onchange,
425 % 'layer_values' => $layer_values,
426 % 'cell_style' => ( $fieldnum ? 'border-top:1px solid black' : '' ),
428 % $existing[0] =~ s(^/elements/tr-)(/elements/);
429 % my @label = @existing;
430 % $label[0] = '/elements/tr-td-label.html';
432 <% include( @label ) %>
433 <TD COLSPAN="<% $f->{'colspan'} || 1 %>">
434 <% include( @existing ) %>
437 % if ( $f->{'m2_fields'} ) {
438 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
439 % my $column = $c->{field};
440 % my @column = &{ $column_sub }( %$c,
441 % 'fieldnum' => $fieldnum,
442 % 'curr_value' => $name_obj->$column()
445 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
446 style='text-align:right;vertical-align:top;
447 border-top:1px solid black;padding-top:5px;'>
448 <% $c->{'label'} || '' %>
450 <TD style='border-top:1px solid black;padding-top:3px;'>
451 <% include( @column ) %>
461 % #$field .= $fieldnum;
462 % $onchange .= "\nspawn_$field(what);";
464 % if ( $f->{curr_value_callback} ) {
465 % $curr_value = &{ $f->{curr_value_callback} }( $cgi, $object, $field ),
467 % $curr_value = $object->$field();
469 % $curr_value = &{ $opt{'value_callback'} }( $f->{'field'}, $curr_value )
470 % if $opt{'value_callback'} && $mode ne 'error';
473 % my @include = &{ $include_sub }(
475 % 'fieldnum' => $fieldnum,
476 % 'curr_value' => $curr_value,
477 % 'object' => $object,
479 % 'onchange' => $onchange,
480 % ( $fieldnum ? ('cell_style' => 'border-top:1px solid black') : () ),
483 % if ( $f->{'m2name_table'} || $f->{'o2m_table'} || $f->{'m2m_method'} ) {
484 % $include[0] =~ s(^/elements/tr-)(/elements/);
485 % my @label = @include;
486 % $label[0] = '/elements/tr-td-label.html';
488 <% include( @label ) %>
489 <TD COLSPAN="<% $f->{'colspan'} || 1 %>">
490 <% include( @include ) %>
493 % if ( $f->{'m2_fields'} ) {
494 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
495 % my $column = $c->{field};
496 % my @column = &{ $column_sub }( %$c, 'fieldnum' => $fieldnum );
498 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
499 style='text-align:right;vertical-align:top;
500 border-top:1px solid black;padding-top:5px;'>
501 <% $c->{'label'} || '' %>
503 <TD style='border-top:1px solid black;padding-top:3px;'>
504 <% include( @column ) %>
513 <% include( @include ) %>
516 % if ( $f->{'m2name_table'} || $f->{'o2m_table'} || $f->{'m2m_method'} ) {
518 <SCRIPT TYPE="text/javascript">
520 var <%$field%>_rownum = <% $g_row %>;
521 var <%$field%>_fieldnum = <% $fieldnum %>;
523 function spawn_<%$field%>(what) {
525 // only spawn if we're the last element... return if not
527 var field_regex = /(\d+)(_[a-z]+)?$/;
528 var match = field_regex.exec(what.name);
530 alert(what.name + " didn't match?!");
533 if ( match[1] != <%$field%>_fieldnum ) {
537 // change the label on the last entry & add a remove button
538 var prev_label = document.getElementById('<% $field %>_label' + <%$field%>_fieldnum );
539 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" > <% $f->{'m2_label'} || $field %>';
541 <%$field%>_fieldnum++;
545 % $include[0] =~ s(^/elements/tr-)(/elements/);
546 % my @layer_opt = ( @include,
547 % 'field' => $field."MAGIC_NUMBER",
548 % 'id' => $field."MAGIC_NUMBER",
549 % 'layer_prefix' => $field."MAGIC_NUMBER.",
551 % warn @layer_opt if $opt{'debug'};
553 var newrow = <% include(@layer_opt, html_only=>1) |js_string %>;
555 % if ( $type eq 'selectlayers' ) { #until the rest have html/js_only
556 var newfunc = <% include(@layer_opt, js_only =>1) |js_string %>;
561 // substitute in the new field name
562 var magic_regex = /MAGIC_NUMBER/g;
563 newrow = newrow.replace( magic_regex, <%$field%>_fieldnum );
564 newfunc = newfunc.replace( magic_regex, <%$field%>_fieldnum );
567 if (window.ActiveXObject) {
568 window.execScript(newfunc);
569 } else { /* (window.XMLHttpRequest) */
570 //window.eval(newfunc);
571 setTimeout(newfunc, 0);
576 //hmm, can't use selectlayers after a tablebreak-title for now
577 var table = document.getElementById('TableNumber<% $tablenum-1 %>');
579 var row = table.insertRow(<%$field%>_rownum++);
581 var label_cell = document.createElement('TD');
583 label_cell.id = '<% $field %>_label' + <%$field%>_fieldnum;
585 label_cell.style.textAlign = "right";
586 label_cell.style.verticalAlign = "top";
587 label_cell.style.borderTop = "1px solid black";
588 label_cell.style.paddingTop = "5px";
590 label_cell.innerHTML = '<% $label %>';
592 row.appendChild(label_cell);
594 var widget_cell = document.createElement('TD');
596 widget_cell.style.borderTop = "1px solid black";
597 widget_cell.style.paddingTop = "3px";
598 widget_cell.colSpan = "<% $f->{'colspan'} || 1 %>"
600 widget_cell.innerHTML = newrow;
602 row.appendChild(widget_cell);
604 % if ( $f->{'m2_fields'} ) {
605 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
606 % my $column = $c->{field};
607 % my @column = &{ $column_sub }(%$c, 'fieldnum' => 'MAGIC_NUMBER');
609 var column = <% include(@column, html_only=>1) |js_string %>;
610 column = column.replace( magic_regex, <%$field%>_fieldnum );
612 var column_label = document.createElement('TD');
614 '<% $field %>__<% $column %>_label' + <%$field%>_fieldnum;
616 column_label.style.textAlign = "right";
617 column_label.style.verticalAlign = "top";
618 column_label.style.borderTop = "1px solid black";
619 column_label.style.paddingTop = "5px";
621 column_label.innerHTML = '<% $c->{'label'} || '' %>';
623 row.appendChild(column_label);
625 var column_widget = document.createElement('TD');
627 column_widget.style.borderTop = "1px solid black";
628 column_widget.style.paddingTop = "3px";
630 column_widget.innerHTML = column;
632 row.appendChild(column_widget);
637 % if ( $f->{'m2_new_js'} ) {
638 // take out items selected in previous dropdowns
639 var new_element = document.getElementById("<%$field%>" + <%$field%>_fieldnum );
640 <% $f->{'m2_new_js'} %>(new_element);
642 if ( new_element.length < 2 ) {
643 //just the ** Select new **, so don't display the row
644 row.style.display = 'none';
650 function remove_<%$field%>(remove_fieldnum) {
651 //alert("remove <%$field%> " + remove_fieldnum);
652 var select = document.getElementById('<%$field%>' + remove_fieldnum);
655 alert("can't find element <%$field%>" + remove_fieldnum);
659 % my $warnings = $f->{'m2_remove_warnings'};
661 var sel_value = select.options[select.selectedIndex].value;
662 % foreach my $value ( keys %$warnings ) {
663 if ( sel_value == '<% $value %>' ) {
664 if ( ! confirm( <% $warnings->{$value} |js_string %> ) ) {
671 select.disabled = 'disabled'; // this seems to prevent it from being submitted on tested browsers so far (IE, moz, konq at least)
672 var label_td = document.getElementById('<%$field%>_label' + remove_fieldnum );
673 label_td.parentNode.style.display = 'none';
675 % if ( $f->{m2_remove_js} ) {
676 var opt = select.options[select.selectedIndex];
677 <% $f->{m2_remove_js} %>( opt.value, opt.text, 'no_match');
688 <% ref( $opt{'html_table_bottom'} )
689 ? &{ $opt{'html_table_bottom'} }( $object )
690 : $opt{'html_table_bottom'}
695 <% ref( $opt{'html_bottom'} )
696 ? &{ $opt{'html_bottom'} }( $object )
697 : $opt{'html_bottom'}
702 <INPUT TYPE="submit" ID="submit" VALUE="<% ( !$clone && $object->$pkey() ) ? "Apply changes" : "Add ". ( $opt{'name'} || $opt{'name_singular'} ) %>">
706 <% ref( $opt{'html_foot'} )
707 ? &{ $opt{'html_foot'} }( $object )
711 <% include("/elements/footer.html") %>
716 my $curuser = $FS::CurrentUser::CurrentUser;
718 #false laziness w/process.html
719 my $table = $opt{'table'};
720 my $class = "FS::$table";
721 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
722 my $fields = $opt{'fields'}
723 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
724 || [ grep { $_ ne $pkey } fields($table) ];
725 #my @actualfields = map { ref($_) ? $_->{'field'} : $_ } @$fields;
727 if ( $cgi->param('redirect') ) {
728 my $session = $cgi->param('redirect');
729 my $pref = $curuser->option("redirect$session");
730 die "unknown redirect session $session\n" unless length($pref);
731 $cgi = new CGI($pref);
734 &{$opt{'begin_callback'}}( $cgi, $fields, \%opt )
735 if $opt{'begin_callback'};
739 'extra_sql' => ( $opt{'agent_virt'}
740 ? ' AND '. $curuser->agentnums_sql(
741 'null_right' => $opt{'agent_null_right'}
750 if ( $cgi->param('error') ) {
754 $object = $class->new( {
755 map { $_ => scalar($cgi->param($_)) } fields($table)
758 &{$opt{'error_callback'}}( $cgi, $object, $fields, \%opt )
759 if $opt{'error_callback'};
761 } elsif ( $cgi->param('clone') =~ /^(\d+)$/ ) {
767 $qsearch{'extra_sql'} = ' AND '. $opt{'agent_clone_extra_sql'}
768 if $opt{'agent_clone_extra_sql'};
770 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $clone } })
771 or die "$pkey $clone not found in $table";
773 &{$opt{'clone_callback'}}( $cgi, $object, $fields, \%opt )
774 if $opt{'clone_callback'};
778 $opt{action} ||= 'Add';
780 } elsif ( $cgi->keywords || $cgi->param($pkey) ) { #editing
785 if ( $cgi->param($pkey) ) {
786 $value = $cgi->param($pkey)
788 my( $query ) = $cgi->keywords;
791 $value =~ /^(\d+)$/ or die "unparsable $pkey";
792 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $1 } })
793 or die "$pkey $1 not found in $table";
795 warn "$table $pkey => $1"
798 &{$opt{'edit_callback'}}( $cgi, $object, $fields, \%opt )
799 if $opt{'edit_callback'};
805 my $hashref = $opt{'new_hashref_callback'}
806 ? &{$opt{'new_hashref_callback'}}
809 $object = $opt{'new_object_callback'}
810 ? &{$opt{'new_object_callback'}}( $cgi, $hashref, $fields, \%opt )
811 : $class->new( $hashref );
813 &{$opt{'new_callback'}}( $cgi, $object, $fields, \%opt )
814 if $opt{'new_callback'};
818 &{$opt{'end_callback'}}( $cgi, $object, $fields, \%opt )
819 if $opt{'end_callback'};
821 $opt{action} ||= $object->$pkey() ? 'Edit' : 'Add';
823 my $title = $opt{action}. ' '. ( $opt{name} || $opt{'name_singular'} );
825 my $viewall_url = $p . ( $opt{'viewall_dir'} || 'search' ) . "/$table.html";
826 $viewall_url = $opt{'viewall_url'} if $opt{'viewall_url'};
829 if ( $opt{'menubar'} ) {
830 @menubar = @{ $opt{'menubar'} };
832 my $items = $opt{'name'} ? $opt{'name'}.'s' : PL($opt{'name_singular'});
834 "View all $items" => $viewall_url,