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 $ = @_;
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++;
303 % $include_common{'colspan'} = $f->{colspan} if $f->{colspan};
306 % if ( $f->{include_opt_callback} ) {
307 % %include_common = ( %include_common, &{ $f->{include_opt_callback} } );
310 % my $layer_prefix_on = '';
312 % my $include_sub = sub {
315 % my $fieldnum = delete $opt{'fieldnum'};
317 % my $include = $type;
318 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
319 % $include = "tr-$include" unless $include =~ /^(hidden|tablebreak|column)/;
321 % $include_common{'layer_prefix'} = "$field$fieldnum."
322 % if $layer_prefix_on;
325 % ( "/elements/$include.html",
326 % 'field' => "$field$fieldnum",
327 % 'id' => "$field$fieldnum", #separate?
328 % 'label_id' => $field."_label$fieldnum", #don't want field0_label0...
335 % my $column_sub = sub {
338 % my $column = delete($opt{field});
339 % my $fieldnum = delete($opt{fieldnum});
340 % my $include = delete($opt{type}) || 'text';
341 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
343 % ( "/elements/$include.html",
344 % 'field' => $field.'__'.$column.$fieldnum,
345 % 'id' => $field.'__'.$column.$fieldnum,
346 % 'layer_prefix' => $field.'__'.$column.$fieldnum.".",
348 % ? ('cell_style' => 'border-top:1px solid black')
356 % unless ( $type =~ /^column/ ) {
357 % $g_row = 1 if $type eq 'tablebreak-tr-title';
359 % $g_row++ if $type eq 'title';
361 % if ( $type eq 'columnstart' ) {
362 % push @g_row_stack, $g_row;
364 % #} elsif ( $type eq 'columnnext' ) {
365 % } elsif ( $type eq 'columnend' ) {
366 % $g_row = pop @g_row_stack;
372 % my $curr_value = '';
373 % if ( $f->{'m2name_table'} || $f->{'o2m_table'} || $f->{'m2m_method'} ) {
376 % if ( $f->{'m2name_table'} ) {
377 % $table = $f->{'m2name_table'};
378 % $col = $f->{'m2name_namecol'};
379 % } elsif ( $f->{'o2m_table'} ) {
380 % $table = $f->{'o2m_tbekable'};
381 % $col = dbdef->table($f->{'o2m_table'})->primary_key;
382 % } elsif ( $f->{'m2m_method'} ) {
383 % $table = $f->{'m2m_method'};
384 % $col = $f->{'m2m_dstcol'};
387 % $layer_prefix_on = 1;
388 % #print out the fields for the existing m2s
390 % if ( $mode eq 'error' ) {
391 % @existing = &{ $f->{'m2_error_callback'} }( $cgi, $object );
392 % } elsif ( $object->$pkey() ) { # $mode eq 'edit'||'clone'
393 % @existing = $object->$table();
394 % warn scalar(@existing). " from $object->$table: ". join('/', @existing)
396 % } elsif ( $f->{'m2_new_default'} ) { # && $mode eq 'new'
397 % @existing = @{ $f->{'m2_new_default'} };
399 % foreach my $name_obj ( @existing ) {
401 % my $ex_label = '<INPUT TYPE="button" VALUE="X" TITLE="Remove this '.
402 % lc($f->{'m2_label'}).
403 % qq(" onClick="remove_$field($fieldnum);").
404 % ' STYLE="color:#ff0000;font-weight:bold;'.
405 % 'padding-left:2px;padding-right:2px"'.
406 % '> '. ($f->{'m2_label'} || $field ). ' ';
408 % if ( $f->{'layer_values_callback'} ) {
409 % my %switches = ( 'mode' => $mode );
411 % &{ $f->{'layer_values_callback'} }( $cgi, $name_obj, \%switches );
413 % warn "layer values: ". Dumper($layer_values)
416 % my @existing = &{ $include_sub }(
417 % 'label' => $ex_label,
418 % 'fieldnum' => $fieldnum,
419 % 'curr_value' => $name_obj->$col(),
420 % 'onchange' => $onchange,
421 % 'layer_values' => $layer_values,
422 % 'cell_style' => ( $fieldnum ? 'border-top:1px solid black' : '' ),
424 % $existing[0] =~ s(^/elements/tr-)(/elements/);
425 % my @label = @existing;
426 % $label[0] = '/elements/tr-td-label.html';
428 <% include( @label ) %>
429 <TD COLSPAN="<% $f->{'colspan'} || 1 %>">
430 <% include( @existing ) %>
433 % if ( $f->{'m2_fields'} ) {
434 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
435 % my $column = $c->{field};
436 % my @column = &{ $column_sub }( %$c,
437 % 'fieldnum' => $fieldnum,
438 % 'curr_value' => $name_obj->$column()
441 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
442 style='text-align:right;vertical-align:top;
443 border-top:1px solid black;padding-top:5px;'>
444 <% $c->{'label'} || '' %>
446 <TD style='border-top:1px solid black;padding-top:3px;'>
447 <% include( @column ) %>
457 % #$field .= $fieldnum;
458 % $onchange .= "\nspawn_$field(what);";
460 % if ( $f->{curr_value_callback} ) {
461 % $curr_value = &{ $f->{curr_value_callback} }( $cgi, $object, $field ),
463 % $curr_value = $object->$field();
465 % $curr_value = &{ $opt{'value_callback'} }( $f->{'field'}, $curr_value )
466 % if $opt{'value_callback'} && $mode ne 'error';
469 % my @include = &{ $include_sub }(
471 % 'fieldnum' => $fieldnum,
472 % 'curr_value' => $curr_value,
473 % 'object' => $object,
475 % 'onchange' => $onchange,
476 % ( $fieldnum ? ('cell_style' => 'border-top:1px solid black') : () ),
479 % if ( $f->{'m2name_table'} || $f->{'o2m_table'} || $f->{'m2m_method'} ) {
480 % $include[0] =~ s(^/elements/tr-)(/elements/);
481 % my @label = @include;
482 % $label[0] = '/elements/tr-td-label.html';
484 <% include( @label ) %>
485 <TD COLSPAN="<% $f->{'colspan'} || 1 %>">
486 <% include( @include ) %>
489 % if ( $f->{'m2_fields'} ) {
490 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
491 % my $column = $c->{field};
492 % my @column = &{ $column_sub }( %$c, 'fieldnum' => $fieldnum );
494 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
495 style='text-align:right;vertical-align:top;
496 border-top:1px solid black;padding-top:5px;'>
497 <% $c->{'label'} || '' %>
499 <TD style='border-top:1px solid black;padding-top:3px;'>
500 <% include( @column ) %>
509 <% include( @include ) %>
512 % if ( $f->{'m2name_table'} || $f->{'o2m_table'} || $f->{'m2m_method'} ) {
514 <SCRIPT TYPE="text/javascript">
516 var <%$field%>_rownum = <% $g_row %>;
517 var <%$field%>_fieldnum = <% $fieldnum %>;
519 function spawn_<%$field%>(what) {
521 // only spawn if we're the last element... return if not
523 var field_regex = /(\d+)(_[a-z]+)?$/;
524 var match = field_regex.exec(what.name);
526 alert(what.name + " didn't match?!");
529 if ( match[1] != <%$field%>_fieldnum ) {
533 // change the label on the last entry & add a remove button
534 var prev_label = document.getElementById('<% $field %>_label' + <%$field%>_fieldnum );
535 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 %>';
537 <%$field%>_fieldnum++;
541 % $include[0] =~ s(^/elements/tr-)(/elements/);
542 % my @layer_opt = ( @include,
543 % 'field' => $field."MAGIC_NUMBER",
544 % 'id' => $field."MAGIC_NUMBER",
545 % 'layer_prefix' => $field."MAGIC_NUMBER.",
547 % warn @layer_opt if $opt{'debug'};
549 var newrow = <% include(@layer_opt, html_only=>1) |js_string %>;
551 % if ( $type eq 'selectlayers' ) { #until the rest have html/js_only
552 var newfunc = <% include(@layer_opt, js_only =>1) |js_string %>;
557 // substitute in the new field name
558 var magic_regex = /MAGIC_NUMBER/g;
559 newrow = newrow.replace( magic_regex, <%$field%>_fieldnum );
560 newfunc = newfunc.replace( magic_regex, <%$field%>_fieldnum );
563 if (window.ActiveXObject) {
564 window.execScript(newfunc);
565 } else { /* (window.XMLHttpRequest) */
566 //window.eval(newfunc);
567 setTimeout(newfunc, 0);
572 //hmm, can't use selectlayers after a tablebreak-title for now
573 var table = document.getElementById('TableNumber<% $tablenum-1 %>');
575 var row = table.insertRow(<%$field%>_rownum++);
577 var label_cell = document.createElement('TD');
579 label_cell.id = '<% $field %>_label' + <%$field%>_fieldnum;
581 label_cell.style.textAlign = "right";
582 label_cell.style.verticalAlign = "top";
583 label_cell.style.borderTop = "1px solid black";
584 label_cell.style.paddingTop = "5px";
586 label_cell.innerHTML = '<% $label %>';
588 row.appendChild(label_cell);
590 var widget_cell = document.createElement('TD');
592 widget_cell.style.borderTop = "1px solid black";
593 widget_cell.style.paddingTop = "3px";
594 widget_cell.colSpan = "<% $f->{'colspan'} || 1 %>"
596 widget_cell.innerHTML = newrow;
598 row.appendChild(widget_cell);
600 % if ( $f->{'m2_fields'} ) {
601 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
602 % my $column = $c->{field};
603 % my @column = &{ $column_sub }(%$c, 'fieldnum' => 'MAGIC_NUMBER');
605 var column = <% include(@column, html_only=>1) |js_string %>;
606 column = column.replace( magic_regex, <%$field%>_fieldnum );
608 var column_label = document.createElement('TD');
610 '<% $field %>__<% $column %>_label' + <%$field%>_fieldnum;
612 column_label.style.textAlign = "right";
613 column_label.style.verticalAlign = "top";
614 column_label.style.borderTop = "1px solid black";
615 column_label.style.paddingTop = "5px";
617 column_label.innerHTML = '<% $c->{'label'} || '' %>';
619 row.appendChild(column_label);
621 var column_widget = document.createElement('TD');
623 column_widget.style.borderTop = "1px solid black";
624 column_widget.style.paddingTop = "3px";
626 column_widget.innerHTML = column;
628 row.appendChild(column_widget);
633 % if ( $f->{'m2_new_js'} ) {
634 // take out items selected in previous dropdowns
635 var new_element = document.getElementById("<%$field%>" + <%$field%>_fieldnum );
636 <% $f->{'m2_new_js'} %>(new_element);
638 if ( new_element.length < 2 ) {
639 //just the ** Select new **, so don't display the row
640 row.style.display = 'none';
646 function remove_<%$field%>(remove_fieldnum) {
647 //alert("remove <%$field%> " + remove_fieldnum);
648 var select = document.getElementById('<%$field%>' + remove_fieldnum);
651 alert("can't find element <%$field%>" + remove_fieldnum);
655 % my $warnings = $f->{'m2_remove_warnings'};
657 var sel_value = select.options[select.selectedIndex].value;
658 % foreach my $value ( keys %$warnings ) {
659 if ( sel_value == '<% $value %>' ) {
660 if ( ! confirm( <% $warnings->{$value} |js_string %> ) ) {
667 select.disabled = 'disabled'; // this seems to prevent it from being submitted on tested browsers so far (IE, moz, konq at least)
668 var label_td = document.getElementById('<%$field%>_label' + remove_fieldnum );
669 label_td.parentNode.style.display = 'none';
671 % if ( $f->{m2_remove_js} ) {
672 var opt = select.options[select.selectedIndex];
673 <% $f->{m2_remove_js} %>( opt.value, opt.text, 'no_match');
684 <% ref( $opt{'html_table_bottom'} )
685 ? &{ $opt{'html_table_bottom'} }( $object )
686 : $opt{'html_table_bottom'}
691 <% ref( $opt{'html_bottom'} )
692 ? &{ $opt{'html_bottom'} }( $object )
693 : $opt{'html_bottom'}
698 <INPUT TYPE="submit" ID="submit" VALUE="<% ( !$clone && $object->$pkey() ) ? "Apply changes" : "Add ". ( $opt{'name'} || $opt{'name_singular'} ) %>">
702 <% ref( $opt{'html_foot'} )
703 ? &{ $opt{'html_foot'} }( $object )
707 <% include("/elements/footer.html") %>
712 my $curuser = $FS::CurrentUser::CurrentUser;
714 #false laziness w/process.html
715 my $table = $opt{'table'};
716 my $class = "FS::$table";
717 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
718 my $fields = $opt{'fields'}
719 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
720 || [ grep { $_ ne $pkey } fields($table) ];
721 #my @actualfields = map { ref($_) ? $_->{'field'} : $_ } @$fields;
723 if ( $cgi->param('redirect') ) {
724 my $session = $cgi->param('redirect');
725 my $pref = $curuser->option("redirect$session");
726 die "unknown redirect session $session\n" unless length($pref);
727 $cgi = new CGI($pref);
730 &{$opt{'begin_callback'}}( $cgi, $fields, \%opt )
731 if $opt{'begin_callback'};
735 'extra_sql' => ( $opt{'agent_virt'}
736 ? ' AND '. $curuser->agentnums_sql(
737 'null_right' => $opt{'agent_null_right'}
746 if ( $cgi->param('error') ) {
750 $object = $class->new( {
751 map { $_ => scalar($cgi->param($_)) } fields($table)
754 &{$opt{'error_callback'}}( $cgi, $object, $fields, \%opt )
755 if $opt{'error_callback'};
757 } elsif ( $cgi->param('clone') =~ /^(\d+)$/ ) {
763 $qsearch{'extra_sql'} = ' AND '. $opt{'agent_clone_extra_sql'}
764 if $opt{'agent_clone_extra_sql'};
766 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $clone } })
767 or die "$pkey $clone not found in $table";
769 &{$opt{'clone_callback'}}( $cgi, $object, $fields, \%opt )
770 if $opt{'clone_callback'};
774 $opt{action} ||= 'Add';
776 } elsif ( $cgi->keywords || $cgi->param($pkey) ) { #editing
781 if ( $cgi->param($pkey) ) {
782 $value = $cgi->param($pkey)
784 my( $query ) = $cgi->keywords;
787 $value =~ /^(\d+)$/ or die "unparsable $pkey";
788 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $1 } })
789 or die "$pkey $1 not found in $table";
791 warn "$table $pkey => $1"
794 &{$opt{'edit_callback'}}( $cgi, $object, $fields, \%opt )
795 if $opt{'edit_callback'};
801 my $hashref = $opt{'new_hashref_callback'}
802 ? &{$opt{'new_hashref_callback'}}
805 $object = $opt{'new_object_callback'}
806 ? &{$opt{'new_object_callback'}}( $cgi, $hashref, $fields, \%opt )
807 : $class->new( $hashref );
809 &{$opt{'new_callback'}}( $cgi, $object, $fields, \%opt )
810 if $opt{'new_callback'};
814 &{$opt{'end_callback'}}( $cgi, $object, $fields, \%opt )
815 if $opt{'end_callback'};
817 $opt{action} ||= $object->$pkey() ? 'Edit' : 'Add';
819 my $title = $opt{action}. ' '. ( $opt{name} || $opt{'name_singular'} );
821 my $viewall_url = $p . ( $opt{'viewall_dir'} || 'search' ) . "/$table.html";
822 $viewall_url = $opt{'viewall_url'} if $opt{'viewall_url'};
825 if ( $opt{'menubar'} ) {
826 @menubar = @{ $opt{'menubar'} };
828 my $items = $opt{'name'} ? $opt{'name'}.'s' : PL($opt{'name_singular'});
830 "View all $items" => $viewall_url,