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
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++;
299 % $include_common{'colspan'} = $f->{colspan} if $f->{colspan};
302 % if ( $f->{include_opt_callback} ) {
303 % %include_common = ( %include_common, &{ $f->{include_opt_callback} } );
306 % my $layer_prefix_on = '';
308 % my $include_sub = sub {
311 % my $fieldnum = delete $opt{'fieldnum'};
313 % my $include = $type;
314 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
315 % $include = "tr-$include" unless $include =~ /^(hidden|tablebreak|column)/;
317 % $include_common{'layer_prefix'} = "$field$fieldnum."
318 % if $layer_prefix_on;
321 % ( "/elements/$include.html",
322 % 'field' => "$field$fieldnum",
323 % 'id' => "$field$fieldnum", #separate?
324 % 'label_id' => $field."_label$fieldnum", #don't want field0_label0...
331 % my $column_sub = sub {
334 % my $column = delete($opt{field});
335 % my $fieldnum = delete($opt{fieldnum});
336 % my $include = delete($opt{type}) || 'text';
337 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
339 % ( "/elements/$include.html",
340 % 'field' => $field.'__'.$column.$fieldnum,
341 % 'id' => $field.'__'.$column.$fieldnum,
342 % 'layer_prefix' => $field.'__'.$column.$fieldnum.".",
344 % ? ('cell_style' => 'border-top:1px solid black')
352 % unless ( $type =~ /^column/ ) {
353 % $g_row = 1 if $type eq 'tablebreak-tr-title';
355 % $g_row++ if $type eq 'title';
357 % if ( $type eq 'columnstart' ) {
358 % push @g_row_stack, $g_row;
360 % #} elsif ( $type eq 'columnnext' ) {
361 % } elsif ( $type eq 'columnend' ) {
362 % $g_row = pop @g_row_stack;
368 % my $curr_value = '';
369 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) { #XXX test this for all
372 % if ( $f->{'m2name_table'} ) {
373 % $table = $f->{'m2name_table'};
374 % $col = $f->{'m2name_namecol'};
375 % } elsif ( $f->{'m2m_method'} ) {
376 % $table = $f->{'m2m_method'};
377 % $col = $f->{'m2m_dstcol'};
380 % $layer_prefix_on = 1;
381 % #print out the fields for the existing m2s
383 % if ( $mode eq 'error' ) {
384 % @existing = &{ $f->{'m2_error_callback'} }( $cgi, $object );
385 % } elsif ( $object->$pkey() ) { # $mode eq 'edit'||'clone'
386 % @existing = $object->$table();
387 % warn scalar(@existing). " from $object->$table: ". join('/', @existing)
389 % } elsif ( $f->{'m2_new_default'} ) { # && $mode eq 'new'
390 % @existing = @{ $f->{'m2_new_default'} };
392 % foreach my $name_obj ( @existing ) {
394 % my $ex_label = '<INPUT TYPE="button" VALUE="X" TITLE="Remove this '.
395 % lc($f->{'m2_label'}).
396 % qq(" onClick="remove_$field($fieldnum);").
397 % ' STYLE="color:#ff0000;font-weight:bold;'.
398 % 'padding-left:2px;padding-right:2px"'.
399 % '> '. ($f->{'m2_label'} || $field ). ' ';
401 % if ( $f->{'layer_values_callback'} ) {
402 % my %switches = ( 'mode' => $mode );
404 % &{ $f->{'layer_values_callback'} }( $cgi, $name_obj, \%switches );
406 % warn "layer values: ". Dumper($layer_values)
409 % my @existing = &{ $include_sub }(
410 % 'label' => $ex_label,
411 % 'fieldnum' => $fieldnum,
412 % 'curr_value' => $name_obj->$col(),
413 % 'onchange' => $onchange,
414 % 'layer_values' => $layer_values,
415 % 'cell_style' => ( $fieldnum ? 'border-top:1px solid black' : '' ),
417 % $existing[0] =~ s(^/elements/tr-)(/elements/);
418 % my @label = @existing;
419 % $label[0] = '/elements/tr-td-label.html';
421 <% include( @label ) %>
423 <% include( @existing ) %>
426 % if ( $f->{'m2_fields'} ) {
427 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
428 % my $column = $c->{field};
429 % my @column = &{ $column_sub }( %$c,
430 % 'fieldnum' => $fieldnum,
431 % 'curr_value' => $name_obj->$column()
434 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
435 style='text-align:right;vertical-align:top;
436 border-top:1px solid black;padding-top:5px;'>
437 <% $c->{'label'} || '' %>
439 <TD style='border-top:1px solid black;padding-top:3px;'>
440 <% include( @column ) %>
450 % #$field .= $fieldnum;
451 % $onchange .= "\nspawn_$field(what);";
453 % if ( $f->{curr_value_callback} ) {
454 % $curr_value = &{ $f->{curr_value_callback} }( $cgi, $object, $field ),
456 % $curr_value = $object->$field();
458 % $curr_value = &{ $opt{'value_callback'} }( $f->{'field'}, $curr_value )
459 % if $opt{'value_callback'} && $mode ne 'error';
462 % my @include = &{ $include_sub }(
464 % 'fieldnum' => $fieldnum,
465 % 'curr_value' => $curr_value,
466 % 'object' => $object,
468 % 'onchange' => $onchange,
469 % ( $fieldnum ? ('cell_style' => 'border-top:1px solid black') : () ),
472 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) {
473 % $include[0] =~ s(^/elements/tr-)(/elements/);
474 % my @label = @include;
475 % $label[0] = '/elements/tr-td-label.html';
477 <% include( @label ) %>
479 <% include( @include ) %>
482 % if ( $f->{'m2_fields'} ) {
483 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
484 % my $column = $c->{field};
485 % my @column = &{ $column_sub }( %$c, 'fieldnum' => $fieldnum );
487 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
488 style='text-align:right;vertical-align:top;
489 border-top:1px solid black;padding-top:5px;'>
490 <% $c->{'label'} || '' %>
492 <TD style='border-top:1px solid black;padding-top:3px;'>
493 <% include( @column ) %>
502 <% include( @include ) %>
505 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) {
507 <SCRIPT TYPE="text/javascript">
509 var <%$field%>_rownum = <% $g_row %>;
510 var <%$field%>_fieldnum = <% $fieldnum %>;
512 function spawn_<%$field%>(what) {
514 // only spawn if we're the last element... return if not
516 var field_regex = /(\d+)$/;
517 var match = field_regex.exec(what.name);
519 alert(what.name + " didn't match?!");
522 if ( match[1] != <%$field%>_fieldnum ) {
526 // change the label on the last entry & add a remove button
527 var prev_label = document.getElementById('<% $field %>_label' + <%$field%>_fieldnum );
528 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 %>';
530 <%$field%>_fieldnum++;
534 % $include[0] =~ s(^/elements/tr-)(/elements/);
535 % my @layer_opt = ( @include,
536 % 'field' => $field."MAGIC_NUMBER",
537 % 'id' => $field."MAGIC_NUMBER",
538 % 'layer_prefix' => $field."MAGIC_NUMBER.",
540 % warn @layer_opt if $opt{'debug'};
542 var newrow = <% include(@layer_opt, html_only=>1) |js_string %>;
544 % if ( $type eq 'selectlayers' ) { #until the rest have html/js_only
545 var newfunc = <% include(@layer_opt, js_only =>1) |js_string %>;
550 // substitute in the new field name
551 var magic_regex = /MAGIC_NUMBER/g;
552 newrow = newrow.replace( magic_regex, <%$field%>_fieldnum );
553 newfunc = newfunc.replace( magic_regex, <%$field%>_fieldnum );
556 if (window.ActiveXObject) {
557 window.execScript(newfunc);
558 } else { /* (window.XMLHttpRequest) */
559 //window.eval(newfunc);
560 setTimeout(newfunc, 0);
565 //hmm, can't use selectlayers after a tablebreak-title for now
566 var table = document.getElementById('TableNumber<% $tablenum-1 %>');
568 var row = table.insertRow(<%$field%>_rownum++);
570 var label_cell = document.createElement('TD');
572 label_cell.id = '<% $field %>_label' + <%$field%>_fieldnum;
574 label_cell.style.textAlign = "right";
575 label_cell.style.verticalAlign = "top";
576 label_cell.style.borderTop = "1px solid black";
577 label_cell.style.paddingTop = "5px";
579 label_cell.innerHTML = '<% $label %>';
581 row.appendChild(label_cell);
583 var widget_cell = document.createElement('TD');
585 widget_cell.style.borderTop = "1px solid black";
586 widget_cell.style.paddingTop = "3px";
588 widget_cell.innerHTML = newrow;
590 row.appendChild(widget_cell);
592 % if ( $f->{'m2_fields'} ) {
593 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
594 % my $column = $c->{field};
595 % my @column = &{ $column_sub }(%$c, 'fieldnum' => 'MAGIC_NUMBER');
597 var column = <% include(@column, html_only=>1) |js_string %>;
598 column = column.replace( magic_regex, <%$field%>_fieldnum );
600 var column_label = document.createElement('TD');
602 '<% $field %>__<% $column %>_label' + <%$field%>_fieldnum;
604 column_label.style.textAlign = "right";
605 column_label.style.verticalAlign = "top";
606 column_label.style.borderTop = "1px solid black";
607 column_label.style.paddingTop = "5px";
609 column_label.innerHTML = '<% $c->{'label'} || '' %>';
611 row.appendChild(column_label);
613 var column_widget = document.createElement('TD');
615 column_widget.style.borderTop = "1px solid black";
616 column_widget.style.paddingTop = "3px";
618 column_widget.innerHTML = column;
620 row.appendChild(column_widget);
625 % if ( $f->{'m2_new_js'} ) {
626 // take out items selected in previous dropdowns
627 var new_element = document.getElementById("<%$field%>" + <%$field%>_fieldnum );
628 <% $f->{'m2_new_js'} %>(new_element);
630 if ( new_element.length < 2 ) {
631 //just the ** Select new **, so don't display the row
632 row.style.display = 'none';
638 function remove_<%$field%>(remove_fieldnum) {
639 //alert("remove <%$field%> " + remove_fieldnum);
640 var select = document.getElementById('<%$field%>' + remove_fieldnum);
643 alert("can't find element <%$field%>" + remove_fieldnum);
647 % my $warnings = $f->{'m2_remove_warnings'};
649 var sel_value = select.options[select.selectedIndex].value;
650 % foreach my $value ( keys %$warnings ) {
651 if ( sel_value == '<% $value %>' ) {
652 if ( ! confirm( <% $warnings->{$value} |js_string %> ) ) {
659 select.disabled = 'disabled'; // this seems to prevent it from being submitted on tested browsers so far (IE, moz, konq at least)
660 var label_td = document.getElementById('<%$field%>_label' + remove_fieldnum );
661 label_td.parentNode.style.display = 'none';
663 % if ( $f->{m2_remove_js} ) {
664 var opt = select.options[select.selectedIndex];
665 <% $f->{m2_remove_js} %>( opt.value, opt.text, 'no_match');
676 <% ref( $opt{'html_table_bottom'} )
677 ? &{ $opt{'html_table_bottom'} }( $object )
678 : $opt{'html_table_bottom'}
683 <% ref( $opt{'html_bottom'} )
684 ? &{ $opt{'html_bottom'} }( $object )
685 : $opt{'html_bottom'}
690 <INPUT TYPE="submit" ID="submit" VALUE="<% ( !$clone && $object->$pkey() ) ? "Apply changes" : "Add ". ( $opt{'name'} || $opt{'name_singular'} ) %>">
694 <% ref( $opt{'html_foot'} )
695 ? &{ $opt{'html_foot'} }( $object )
699 <% include("/elements/footer.html") %>
704 my $curuser = $FS::CurrentUser::CurrentUser;
706 #false laziness w/process.html
707 my $table = $opt{'table'};
708 my $class = "FS::$table";
709 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
710 my $fields = $opt{'fields'}
711 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
712 || [ grep { $_ ne $pkey } fields($table) ];
713 #my @actualfields = map { ref($_) ? $_->{'field'} : $_ } @$fields;
715 if ( $cgi->param('redirect') ) {
716 my $session = $cgi->param('redirect');
717 my $pref = $curuser->option("redirect$session");
718 die "unknown redirect session $session\n" unless length($pref);
719 $cgi = new CGI($pref);
722 &{$opt{'begin_callback'}}( $cgi, $fields, \%opt )
723 if $opt{'begin_callback'};
727 'extra_sql' => ( $opt{'agent_virt'}
728 ? ' AND '. $curuser->agentnums_sql(
729 'null_right' => $opt{'agent_null_right'}
738 if ( $cgi->param('error') ) {
742 $object = $class->new( {
743 map { $_ => scalar($cgi->param($_)) } fields($table)
746 &{$opt{'error_callback'}}( $cgi, $object, $fields, \%opt )
747 if $opt{'error_callback'};
749 } elsif ( $cgi->param('clone') =~ /^(\d+)$/ ) {
755 $qsearch{'extra_sql'} = ' AND '. $opt{'agent_clone_extra_sql'}
756 if $opt{'agent_clone_extra_sql'};
758 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $clone } })
759 or die "$pkey $clone not found in $table";
761 &{$opt{'clone_callback'}}( $cgi, $object, $fields, \%opt )
762 if $opt{'clone_callback'};
766 $opt{action} ||= 'Add';
768 } elsif ( $cgi->keywords || $cgi->param($pkey) ) { #editing
773 if ( $cgi->param($pkey) ) {
774 $value = $cgi->param($pkey)
776 my( $query ) = $cgi->keywords;
779 $value =~ /^(\d+)$/ or die "unparsable $pkey";
780 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $1 } })
781 or die "$pkey $1 not found in $table";
783 warn "$table $pkey => $1"
786 &{$opt{'edit_callback'}}( $cgi, $object, $fields, \%opt )
787 if $opt{'edit_callback'};
793 my $hashref = $opt{'new_hashref_callback'}
794 ? &{$opt{'new_hashref_callback'}}
797 $object = $opt{'new_object_callback'}
798 ? &{$opt{'new_object_callback'}}( $cgi, $hashref, $fields, \%opt )
799 : $class->new( $hashref );
801 &{$opt{'new_callback'}}( $cgi, $object, $fields, \%opt )
802 if $opt{'new_callback'};
806 &{$opt{'end_callback'}}( $cgi, $object, $fields, \%opt )
807 if $opt{'end_callback'};
809 $opt{action} ||= $object->$pkey() ? 'Edit' : 'Add';
811 my $title = $opt{action}. ' '. ( $opt{name} || $opt{'name_singular'} );
813 my $viewall_url = $p . ( $opt{'viewall_dir'} || 'search' ) . "/$table.html";
814 $viewall_url = $opt{'viewall_url'} if $opt{'viewall_url'};
817 if ( $opt{'menubar'} ) {
818 @menubar = @{ $opt{'menubar'} };
820 my $items = $opt{'name'} ? $opt{'name'}.'s' : PL($opt{'name_singular'});
822 "View all $items" => $viewall_url,