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
54 'm2_label' => 'Label', #
55 'm2_new_default' => \@table_name_objects, #default
58 'm2_error_callback' => sub { my($cgi, $object) = @_; },
59 'm2_remove_warnings' => \%warnings, #hashref of warning
62 'm2_new_js' => 'function_name', #javascript function called
63 #on spawned rows (one arg:
65 'm2_remove_js' => 'function_name', #js function called when
66 #a row is deleted (three
69 #layer_fields & layer_values_callback only for selectlayer
71 'fieldname' => 'Label',
74 type =>'text', #text, money
77 'layer_values_callback' =>
79 my( $cgi, $object ) = @_;
80 { 'layer' => { 'fieldname' => 'current_value',
81 'fieldname2' => 'field2value',
84 'layer2' => { 'l2fieldname' => 'l2value',
93 'menubar' => '', #menubar arrayref
97 'agent_null_right' => 'Access Right Name',
98 'agent_clone_extra_sql' => '', #if provided, this overrides the extra_sql
99 #implementing agent virt, for clone
100 #operations. i.e. pass "1=1" to allow
103 'viewall_dir' => '', #'search' or 'browse', defaults to 'search'
105 # overrides default popurl(1)."process/$table.html"
106 'post_url' => popurl(1).'process/something',
108 #we're in a popup (no title/menu/searchboxes)
115 'body_etc' => '', # Additional BODY attributes, i.e. onLoad=""
117 'html_init' => '', #after the header/menubar
119 #string or coderef of additional HTML to add before </TABLE>
120 'html_table_bottom' => '',
122 #after </TABLE> but before the submit
123 'html_bottom' => '', #string
124 'html_bottom' => sub {
130 #at the very bottom (well, as low as you can go from here)
134 # initialization callbacks
137 ###global callbacks, always run if provided
139 #after decoding long CGI "redirect=" responses but
140 # before object creation/search
141 # (useful if you have a long form that might trigger redirect= and you need
142 # to do things with $cgi params - they're not decoded in the calling
144 'begin_callback' = sub { my( $cgi, $fields_listref, $opt_hashref ) = @_; },
146 #after the mode-specific object creation/search
147 'end_callback' = sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
149 ###mode-specific callbacks. one (and only one) of these four is called
152 'new_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
155 'edit_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
157 #run when re-displaying with an error
158 'error_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
161 'clone_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
163 ###callbacks called in new mode only
165 # returns a hashref for the new object
166 'new_hashref_callback'
168 # returns the new object iself (otherwise, ->new is called)
169 'new_object_callback'
173 #run before display to return a different value
174 'value_callback' => sub { my( $columname, $value ) = @_; },
176 #run before display to manipulate element of the 'fields' arrayref
177 'field_callback' => sub { my( $cgi, $object, $field_hashref ) = @_; },
183 <% include('/elements/header'. ( $opt{popup} ? '-popup' : '' ). '.html',
185 include( '/elements/menubar.html', @menubar ),
190 <% defined($opt{'html_init'})
191 ? ( ref($opt{'html_init'})
192 ? &{$opt{'html_init'}}()
198 <% include('/elements/error.html') %>
200 % my $url = $opt{'post_url'} || popurl(1)."process/$table.html";
202 <FORM ACTION="<% $url %>" METHOD=POST NAME="edit_topform">
204 <INPUT TYPE="hidden" NAME="svcdb" VALUE="<% $table %>">
205 <INPUT TYPE="hidden" NAME="<% $pkey %>" VALUE="<% $clone ? '' : $object->$pkey() %>">
208 <% ( $opt{labels} && exists $opt{labels}->{$pkey} )
209 ? $opt{labels}->{$pkey}
213 #<% ( !$clone && $object->$pkey() ) || "(NEW)" %>
216 <TABLE ID="TableNumber<% $tablenum++ %>" BGCOLOR="#cccccc" BORDER=0 CELLSPACING=0>
219 % my @g_row_stack = ();
220 % foreach my $f ( map { ref($_) ? $_ : {'field'=>$_} }
224 % my $trash = &{ $opt{'field_callback'} }( $cgi, $object, $f )
225 % if $opt{'field_callback'};
227 % my $field = $f->{'field'};
228 % my $type = $f->{'type'} ||= 'text';
230 % my $label = ( $opt{labels} && exists $opt{labels}->{$field} )
231 % ? $opt{labels}->{$field}
234 % my $onchange = $f->{'onchange'};
236 % my $layer_values = {};
237 % $layer_values = &{ $f->{'layer_values_callback'} }( $cgi, $object )
238 % if $f->{'layer_values_callback'}
239 % && ! $f->{'m2name_table'}
240 % && ! $f->{'m2m_method'};
242 % warn "layer values: ". Dumper($layer_values)
245 % my %include_common = (
247 % #text and derivitives
248 % 'size' => $f->{'size'},
249 % 'maxlength' => $f->{'maxlength'},
251 % #checkbox, title, fixed, hidden
252 % #& deprecated weird value hashref used only by reason.html
253 % 'value' => $f->{'value'},
256 % 'options' => $f->{'options'},
257 % 'labels' => $f->{'labels'},
258 % 'multiple' => $f->{'multiple'},
259 % 'disable_empty' => $f->{'disable_empty'},
261 % 'reason_class' => $f->{'reason_class'},
264 % 'layer_fields' => $f->{'layer_fields'},
265 % 'layer_values' => $layer_values,
266 % 'html_between' => $f->{'html_between'},
268 % #umm. for select-agent_types at least
269 % 'disabled' => $f->{'disabled'},
272 % #selectlayers, others?
273 % $include_common{$_} = $f->{$_}
274 % foreach grep exists($f->{$_}),
275 % qw( js_only html_only select_only layers_only cell_style);
278 % $include_common{$_} = $f->{$_}
279 % foreach grep exists($f->{$_}), qw( empty_label );
282 % $include_common{$_} = $f->{$_}
283 % foreach grep exists($f->{$_}), qw( value_col extra_sql );
285 % #select-table, checkboxes-table
286 % $include_common{$_} = $f->{$_}
287 % foreach grep exists($f->{$_}), qw( table name_col );
290 % $include_common{$_} = $f->{$_}
291 % foreach grep exists($f->{$_}), qw( target_table link_table );
294 % $include_common{$_} = $f->{$_}
295 % foreach grep exists($f->{$_}), qw( hashref agent_virt agent_null_right );
297 % if ( $type eq 'tablebreak-tr-title' ) {
298 % $include_common{'table_id'} = 'TableNumber'. $tablenum++;
300 % if ( $type eq 'tablebreak-tr-title' || $type eq 'title' ) {
301 % $include_common{'colspan'} = $f->{colspan} if $f->{colspan};
304 % if ( $f->{include_opt_callback} ) {
305 % %include_common = ( %include_common,
306 % &{ $f->{include_opt_callback} }( $object )
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->{'m2m_method'} ) { #XXX test this for all
376 % if ( $f->{'m2name_table'} ) {
377 % $table = $f->{'m2name_table'};
378 % $col = $f->{'m2name_namecol'};
379 % } elsif ( $f->{'m2m_method'} ) {
380 % $table = $f->{'m2m_method'};
381 % $col = $f->{'m2m_dstcol'};
384 % $layer_prefix_on = 1;
385 % #print out the fields for the existing m2s
387 % if ( $mode eq 'error' ) {
388 % @existing = &{ $f->{'m2_error_callback'} }( $cgi, $object );
389 % } elsif ( $object->$pkey() ) { # $mode eq 'edit'||'clone'
390 % @existing = $object->$table();
391 % warn scalar(@existing). " from $object->$table: ". join('/', @existing)
393 % } elsif ( $f->{'m2_new_default'} ) { # && $mode eq 'new'
394 % @existing = @{ $f->{'m2_new_default'} };
396 % foreach my $name_obj ( @existing ) {
398 % my $ex_label = '<INPUT TYPE="button" VALUE="X" TITLE="Remove this '.
399 % lc($f->{'m2_label'}).
400 % qq(" onClick="remove_$field($fieldnum);").
401 % ' STYLE="color:#ff0000;font-weight:bold;'.
402 % 'padding-left:2px;padding-right:2px"'.
403 % '> '. ($f->{'m2_label'} || $field ). ' ';
405 % if ( $f->{'layer_values_callback'} ) {
406 % my %switches = ( 'mode' => $mode );
408 % &{ $f->{'layer_values_callback'} }( $cgi, $name_obj, \%switches );
410 % warn "layer values: ". Dumper($layer_values)
413 % my @existing = &{ $include_sub }(
414 % 'label' => $ex_label,
415 % 'fieldnum' => $fieldnum,
416 % 'curr_value' => $name_obj->$col(),
417 % 'onchange' => $onchange,
418 % 'layer_values' => $layer_values,
419 % 'cell_style' => ( $fieldnum ? 'border-top:1px solid black' : '' ),
421 % $existing[0] =~ s(^/elements/tr-)(/elements/);
422 % my @label = @existing;
423 % $label[0] = '/elements/tr-td-label.html';
425 <% include( @label ) %>
427 <% include( @existing ) %>
430 % if ( $f->{'m2_fields'} ) {
431 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
432 % my $column = $c->{field};
433 % my @column = &{ $column_sub }( %$c,
434 % 'fieldnum' => $fieldnum,
435 % 'curr_value' => $name_obj->$column()
438 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
439 style='text-align:right;vertical-align:top;
440 border-top:1px solid black;padding-top:5px;'>
441 <% $c->{'label'} || '' %>
443 <TD style='border-top:1px solid black;padding-top:3px;'>
444 <% include( @column ) %>
454 % #$field .= $fieldnum;
455 % $onchange .= "\nspawn_$field(what);";
457 % if ( $f->{curr_value_callback} ) {
458 % $curr_value = &{ $f->{curr_value_callback} }( $cgi, $object, $field ),
460 % $curr_value = $object->$field();
462 % $curr_value = &{ $opt{'value_callback'} }( $f->{'field'}, $curr_value )
463 % if $opt{'value_callback'} && $mode ne 'error';
466 % my @include = &{ $include_sub }(
468 % 'fieldnum' => $fieldnum,
469 % 'curr_value' => $curr_value,
470 % 'object' => $object,
472 % 'onchange' => $onchange,
473 % ( $fieldnum ? ('cell_style' => 'border-top:1px solid black') : () ),
476 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) {
477 % $include[0] =~ s(^/elements/tr-)(/elements/);
478 % my @label = @include;
479 % $label[0] = '/elements/tr-td-label.html';
481 <% include( @label ) %>
483 <% include( @include ) %>
486 % if ( $f->{'m2_fields'} ) {
487 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
488 % my $column = $c->{field};
489 % my @column = &{ $column_sub }( %$c, 'fieldnum' => $fieldnum );
491 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
492 style='text-align:right;vertical-align:top;
493 border-top:1px solid black;padding-top:5px;'>
494 <% $c->{'label'} || '' %>
496 <TD style='border-top:1px solid black;padding-top:3px;'>
497 <% include( @column ) %>
506 <% include( @include ) %>
509 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) {
511 <SCRIPT TYPE="text/javascript">
513 var <%$field%>_rownum = <% $g_row %>;
514 var <%$field%>_fieldnum = <% $fieldnum %>;
516 function spawn_<%$field%>(what) {
518 // only spawn if we're the last element... return if not
520 var field_regex = /(\d+)$/;
521 var match = field_regex.exec(what.name);
523 alert(what.name + " didn't match?!");
526 if ( match[1] != <%$field%>_fieldnum ) {
530 // change the label on the last entry & add a remove button
531 var prev_label = document.getElementById('<% $field %>_label' + <%$field%>_fieldnum );
532 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 %>';
534 <%$field%>_fieldnum++;
538 % $include[0] =~ s(^/elements/tr-)(/elements/);
539 % my @layer_opt = ( @include,
540 % 'field' => $field."MAGIC_NUMBER",
541 % 'id' => $field."MAGIC_NUMBER",
542 % 'layer_prefix' => $field."MAGIC_NUMBER.",
544 % warn @layer_opt if $opt{'debug'};
546 var newrow = <% include(@layer_opt, html_only=>1) |js_string %>;
548 % if ( $type eq 'selectlayers' ) { #until the rest have html/js_only
549 var newfunc = <% include(@layer_opt, js_only =>1) |js_string %>;
554 // substitute in the new field name
555 var magic_regex = /MAGIC_NUMBER/g;
556 newrow = newrow.replace( magic_regex, <%$field%>_fieldnum );
557 newfunc = newfunc.replace( magic_regex, <%$field%>_fieldnum );
560 if (window.ActiveXObject) {
561 window.execScript(newfunc);
562 } else { /* (window.XMLHttpRequest) */
563 //window.eval(newfunc);
564 setTimeout(newfunc, 0);
569 //hmm, can't use selectlayers after a tablebreak-title for now
570 var table = document.getElementById('TableNumber<% $tablenum-1 %>');
572 var row = table.insertRow(<%$field%>_rownum++);
574 var label_cell = document.createElement('TD');
576 label_cell.id = '<% $field %>_label' + <%$field%>_fieldnum;
578 label_cell.style.textAlign = "right";
579 label_cell.style.verticalAlign = "top";
580 label_cell.style.borderTop = "1px solid black";
581 label_cell.style.paddingTop = "5px";
583 label_cell.innerHTML = '<% $label %>';
585 row.appendChild(label_cell);
587 var widget_cell = document.createElement('TD');
589 widget_cell.style.borderTop = "1px solid black";
590 widget_cell.style.paddingTop = "3px";
592 widget_cell.innerHTML = newrow;
594 row.appendChild(widget_cell);
596 % if ( $f->{'m2_fields'} ) {
597 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
598 % my $column = $c->{field};
599 % my @column = &{ $column_sub }(%$c, 'fieldnum' => 'MAGIC_NUMBER');
601 var column = <% include(@column, html_only=>1) |js_string %>;
602 column = column.replace( magic_regex, <%$field%>_fieldnum );
604 var column_label = document.createElement('TD');
606 '<% $field %>__<% $column %>_label' + <%$field%>_fieldnum;
608 column_label.style.textAlign = "right";
609 column_label.style.verticalAlign = "top";
610 column_label.style.borderTop = "1px solid black";
611 column_label.style.paddingTop = "5px";
613 column_label.innerHTML = '<% $c->{'label'} || '' %>';
615 row.appendChild(column_label);
617 var column_widget = document.createElement('TD');
619 column_widget.style.borderTop = "1px solid black";
620 column_widget.style.paddingTop = "3px";
622 column_widget.innerHTML = column;
624 row.appendChild(column_widget);
629 % if ( $f->{'m2_new_js'} ) {
630 // take out items selected in previous dropdowns
631 var new_element = document.getElementById("<%$field%>" + <%$field%>_fieldnum );
632 <% $f->{'m2_new_js'} %>(new_element);
634 if ( new_element.length < 2 ) {
635 //just the ** Select new **, so don't display the row
636 row.style.display = 'none';
642 function remove_<%$field%>(remove_fieldnum) {
643 //alert("remove <%$field%> " + remove_fieldnum);
644 var select = document.getElementById('<%$field%>' + remove_fieldnum);
647 alert("can't find element <%$field%>" + remove_fieldnum);
651 % my $warnings = $f->{'m2_remove_warnings'};
653 var sel_value = select.options[select.selectedIndex].value;
654 % foreach my $value ( keys %$warnings ) {
655 if ( sel_value == '<% $value %>' ) {
656 if ( ! confirm( <% $warnings->{$value} |js_string %> ) ) {
663 select.disabled = 'disabled'; // this seems to prevent it from being submitted on tested browsers so far (IE, moz, konq at least)
664 var label_td = document.getElementById('<%$field%>_label' + remove_fieldnum );
665 label_td.parentNode.style.display = 'none';
667 % if ( $f->{m2_remove_js} ) {
668 var opt = select.options[select.selectedIndex];
669 <% $f->{m2_remove_js} %>( opt.value, opt.text, 'no_match');
680 <% ref( $opt{'html_table_bottom'} )
681 ? &{ $opt{'html_table_bottom'} }( $object )
682 : $opt{'html_table_bottom'}
687 <% ref( $opt{'html_bottom'} )
688 ? &{ $opt{'html_bottom'} }( $object )
689 : $opt{'html_bottom'}
694 <INPUT TYPE="submit" ID="submit" VALUE="<% ( !$clone && $object->$pkey() ) ? "Apply changes" : "Add ". ( $opt{'name'} || $opt{'name_singular'} ) %>">
698 <% ref( $opt{'html_foot'} )
699 ? &{ $opt{'html_foot'} }( $object )
703 <% include("/elements/footer.html") %>
708 my $curuser = $FS::CurrentUser::CurrentUser;
710 #false laziness w/process.html
711 my $table = $opt{'table'};
712 my $class = "FS::$table";
713 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
714 my $fields = $opt{'fields'}
715 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
716 || [ grep { $_ ne $pkey } fields($table) ];
717 #my @actualfields = map { ref($_) ? $_->{'field'} : $_ } @$fields;
719 if ( $cgi->param('redirect') ) {
720 my $session = $cgi->param('redirect');
721 my $pref = $curuser->option("redirect$session");
722 die "unknown redirect session $session\n" unless length($pref);
723 $cgi = new CGI($pref);
726 &{$opt{'begin_callback'}}( $cgi, $fields, \%opt )
727 if $opt{'begin_callback'};
731 'extra_sql' => ( $opt{'agent_virt'}
732 ? ' AND '. $curuser->agentnums_sql(
733 'null_right' => $opt{'agent_null_right'}
742 if ( $cgi->param('error') ) {
746 $object = $class->new( {
747 map { $_ => scalar($cgi->param($_)) } fields($table)
750 &{$opt{'error_callback'}}( $cgi, $object, $fields, \%opt )
751 if $opt{'error_callback'};
753 } elsif ( $cgi->param('clone') =~ /^(\d+)$/ ) {
759 $qsearch{'extra_sql'} = ' AND '. $opt{'agent_clone_extra_sql'}
760 if $opt{'agent_clone_extra_sql'};
762 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $clone } })
763 or die "$pkey $clone not found in $table";
765 &{$opt{'clone_callback'}}( $cgi, $object, $fields, \%opt )
766 if $opt{'clone_callback'};
770 $opt{action} ||= 'Add';
772 } elsif ( $cgi->keywords || $cgi->param($pkey) ) { #editing
777 if ( $cgi->param($pkey) ) {
778 $value = $cgi->param($pkey)
780 my( $query ) = $cgi->keywords;
783 $value =~ /^(\d+)$/ or die "unparsable $pkey";
784 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $1 } })
785 or die "$pkey $1 not found in $table";
787 warn "$table $pkey => $1"
790 &{$opt{'edit_callback'}}( $cgi, $object, $fields, \%opt )
791 if $opt{'edit_callback'};
797 my $hashref = $opt{'new_hashref_callback'}
798 ? &{$opt{'new_hashref_callback'}}
801 $object = $opt{'new_object_callback'}
802 ? &{$opt{'new_object_callback'}}( $cgi, $hashref, $fields, \%opt )
803 : $class->new( $hashref );
805 &{$opt{'new_callback'}}( $cgi, $object, $fields, \%opt )
806 if $opt{'new_callback'};
810 &{$opt{'end_callback'}}( $cgi, $object, $fields, \%opt )
811 if $opt{'end_callback'};
813 $opt{action} ||= $object->$pkey() ? 'Edit' : 'Add';
815 my $title = $opt{action}. ' '. ( $opt{name} || $opt{'name_singular'} );
817 my $viewall_url = $p . ( $opt{'viewall_dir'} || 'search' ) . "/$table.html";
818 $viewall_url = $opt{'viewall_url'} if $opt{'viewall_url'};
821 if ( $opt{'menubar'} ) {
822 @menubar = @{ $opt{'menubar'} };
824 my $items = $opt{'name'} ? $opt{'name'}.'s' : PL($opt{'name_singular'});
826 "View all $items" => $viewall_url,