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 #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',
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
52 'm2_label' => 'Label', #
53 'm2_new_default' => \@table_name_objects, #default
56 'm2_error_callback' => sub { my($cgi, $object) = @_; },
57 'm2_remove_warnings' => \%warnings, #hashref of warning
60 'm2_new_js' => 'function_name', #javascript function called
61 #on spawned rows (one arg:
63 'm2_remove_js' => 'function_name', #js function called when
64 #a row is deleted (three
67 #layer_fields & layer_values_callback only for selectlayer
69 'fieldname' => 'Label',
72 type =>'text', #text, money
75 'layer_values_callback' =>
77 my( $cgi, $object ) = @_;
78 { 'layer' => { 'fieldname' => 'current_value',
79 'fieldname2' => 'field2value',
82 'layer2' => { 'l2fieldname' => 'l2value',
91 'menubar' => '', #menubar arrayref
95 'agent_null_right' => 'Access Right Name',
96 'agent_clone_extra_sql' => '', #if provided, this overrides the extra_sql
97 #implementing agent virt, for clone
98 #operations. i.e. pass "1=1" to allow
101 'viewall_dir' => '', #'search' or 'browse', defaults to 'search'
103 # overrides default popurl(1)."process/$table.html"
104 'post_url' => popurl(1).'process/something',
106 #we're in a popup (no title/menu/searchboxes)
113 'body_etc' => '', # Additional BODY attributes, i.e. onLoad=""
115 'html_init' => '', #after the header/menubar
117 #string or coderef of additional HTML to add before </TABLE>
118 'html_table_bottom' => '',
120 #after </TABLE> but before the submit
121 'html_bottom' => '', #string
122 'html_bottom' => sub {
128 #at the very bottom (well, as low as you can go from here)
132 # initialization callbacks
135 ###global callbacks, always run if provided
137 #after decoding long CGI "redirect=" responses but
138 # before object creation/search
139 # (useful if you have a long form that might trigger redirect= and you need
140 # to do things with $cgi params - they're not decoded in the calling
142 'begin_callback' = sub { my( $cgi, $fields_listref, $opt_hashref ) = @_; },
144 #after the mode-specific object creation/search
145 'end_callback' = sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
147 ###mode-specific callbacks. one (and only one) of these four is called
150 'new_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
153 'edit_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
155 #run when re-displaying with an error
156 'error_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
159 'clone_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
161 ###callbacks called in new mode only
163 # returns a hashref for the new object
164 'new_hashref_callback'
166 # returns the new object iself (otherwise, ->new is called)
167 'new_object_callback'
171 #run before display to return a different value
172 'value_callback' => sub { my( $columname, $value ) = @_; },
174 #run before display to manipulate element of the 'fields' arrayref
175 'field_callback' => sub { my( $cgi, $object, $field_hashref ) = @_; },
181 <% include('/elements/header'. ( $opt{popup} ? '-popup' : '' ). '.html',
183 include( '/elements/menubar.html', @menubar ),
188 <% defined($opt{'html_init'})
189 ? ( ref($opt{'html_init'})
190 ? &{$opt{'html_init'}}()
196 <% include('/elements/error.html') %>
198 % my $url = $opt{'post_url'} || popurl(1)."process/$table.html";
200 <FORM ACTION="<% $url %>" METHOD=POST NAME="edit_topform">
202 <INPUT TYPE="hidden" NAME="svcdb" VALUE="<% $table %>">
203 <INPUT TYPE="hidden" NAME="<% $pkey %>" VALUE="<% $clone ? '' : $object->$pkey() %>">
206 <% ( $opt{labels} && exists $opt{labels}->{$pkey} )
207 ? $opt{labels}->{$pkey}
211 #<% ( !$clone && $object->$pkey() ) || "(NEW)" %>
214 <TABLE ID="TableNumber<% $tablenum++ %>" BGCOLOR="#cccccc" BORDER=0 CELLSPACING=0>
217 % my @g_row_stack = ();
218 % foreach my $f ( map { ref($_) ? $_ : {'field'=>$_} }
222 % my $trash = &{ $opt{'field_callback'} }( $cgi, $object, $f )
223 % if $opt{'field_callback'};
225 % my $field = $f->{'field'};
226 % my $type = $f->{'type'} ||= 'text';
228 % my $label = ( $opt{labels} && exists $opt{labels}->{$field} )
229 % ? $opt{labels}->{$field}
232 % my $onchange = $f->{'onchange'};
234 % my $layer_values = {};
235 % $layer_values = &{ $f->{'layer_values_callback'} }( $cgi, $object )
236 % if $f->{'layer_values_callback'}
237 % && ! $f->{'m2name_table'}
238 % && ! $f->{'m2m_method'};
240 % warn "layer values: ". Dumper($layer_values)
243 % my %include_common = (
245 % #text and derivitives
246 % 'size' => $f->{'size'},
247 % 'maxlength' => $f->{'maxlength'},
249 % #checkbox, title, fixed, hidden
250 % #& deprecated weird value hashref used only by reason.html
251 % 'value' => $f->{'value'},
254 % 'options' => $f->{'options'},
255 % 'labels' => $f->{'labels'},
256 % 'multiple' => $f->{'multiple'},
257 % 'disable_empty' => $f->{'disable_empty'},
259 % 'reason_class' => $f->{'reason_class'},
262 % 'layer_fields' => $f->{'layer_fields'},
263 % 'layer_values' => $layer_values,
264 % 'html_between' => $f->{'html_between'},
266 % #umm. for select-agent_types at least
267 % 'disabled' => $f->{'disabled'},
270 % #selectlayers, others?
271 % $include_common{$_} = $f->{$_}
272 % foreach grep exists($f->{$_}),
273 % qw( js_only html_only select_only layers_only cell_style);
276 % $include_common{$_} = $f->{$_}
277 % foreach grep exists($f->{$_}), qw( empty_label );
279 % #select-table, checkboxes-table
280 % $include_common{$_} = $f->{$_}
281 % foreach grep exists($f->{$_}), qw( table name_col );
284 % $include_common{$_} = $f->{$_}
285 % foreach grep exists($f->{$_}), qw( target_table link_table );
288 % $include_common{$_} = $f->{$_}
289 % foreach grep exists($f->{$_}), qw( hashref agent_virt agent_null_right );
291 % if ( $type eq 'tablebreak-tr-title' ) {
292 % $include_common{'table_id'} = 'TableNumber'. $tablenum++;
293 % $include_common{'colspan'} = $f->{colspan} if $f->{colspan};
296 % my $layer_prefix_on = '';
298 % my $include_sub = sub {
301 % my $fieldnum = delete $opt{'fieldnum'};
303 % my $include = $type;
304 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
305 % $include = "tr-$include" unless $include =~ /^(hidden|tablebreak|column)/;
307 % $include_common{'layer_prefix'} = "$field$fieldnum."
308 % if $layer_prefix_on;
311 % ( "/elements/$include.html",
312 % 'field' => "$field$fieldnum",
313 % 'id' => "$field$fieldnum", #separate?
314 % 'label_id' => $field."_label$fieldnum", #don't want field0_label0...
321 % my $column_sub = sub {
324 % my $column = delete($opt{field});
325 % my $fieldnum = delete($opt{fieldnum});
326 % my $include = delete($opt{type}) || 'text';
327 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
329 % ( "/elements/$include.html",
330 % 'field' => $field.'__'.$column.$fieldnum,
331 % 'id' => $field.'__'.$column.$fieldnum,
332 % 'layer_prefix' => $field.'__'.$column.$fieldnum.".",
334 % ? ('cell_style' => 'border-top:1px solid black')
342 % unless ( $type =~ /^column/ ) {
343 % $g_row = 1 if $type eq 'tablebreak-tr-title';
345 % $g_row++ if $type eq 'title';
347 % if ( $type eq 'columnstart' ) {
348 % push @g_row_stack, $g_row;
350 % #} elsif ( $type eq 'columnnext' ) {
351 % } elsif ( $type eq 'columnend' ) {
352 % $g_row = pop @g_row_stack;
358 % my $curr_value = '';
359 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) { #XXX test this for all
362 % if ( $f->{'m2name_table'} ) {
363 % $table = $f->{'m2name_table'};
364 % $col = $f->{'m2name_namecol'};
365 % } elsif ( $f->{'m2m_method'} ) {
366 % $table = $f->{'m2m_method'};
367 % $col = $f->{'m2m_dstcol'};
370 % $layer_prefix_on = 1;
371 % #print out the fields for the existing m2s
373 % if ( $mode eq 'error' ) {
374 % @existing = &{ $f->{'m2_error_callback'} }( $cgi, $object );
375 % } elsif ( $object->$pkey() ) { # $mode eq 'edit'||'clone'
376 % @existing = $object->$table();
377 % warn scalar(@existing). " from $object->$table: ". join('/', @existing)
379 % } elsif ( $f->{'m2_new_default'} ) { # && $mode eq 'new'
380 % @existing = @{ $f->{'m2_new_default'} };
382 % foreach my $name_obj ( @existing ) {
384 % my $ex_label = '<INPUT TYPE="button" VALUE="X" TITLE="Remove this '.
385 % lc($f->{'m2_label'}).
386 % qq(" onClick="remove_$field($fieldnum);").
387 % ' STYLE="color:#ff0000;font-weight:bold;'.
388 % 'padding-left:2px;padding-right:2px"'.
389 % '> '. ($f->{'m2_label'} || $field ). ' ';
391 % if ( $f->{'layer_values_callback'} ) {
392 % my %switches = ( 'mode' => $mode );
394 % &{ $f->{'layer_values_callback'} }( $cgi, $name_obj, \%switches );
396 % warn "layer values: ". Dumper($layer_values)
399 % my @existing = &{ $include_sub }(
400 % 'label' => $ex_label,
401 % 'fieldnum' => $fieldnum,
402 % 'curr_value' => $name_obj->$col(),
403 % 'onchange' => $onchange,
404 % 'layer_values' => $layer_values,
405 % 'cell_style' => ( $fieldnum ? 'border-top:1px solid black' : '' ),
407 % $existing[0] =~ s(^/elements/tr-)(/elements/);
408 % my @label = @existing;
409 % $label[0] = '/elements/tr-td-label.html';
411 <% include( @label ) %>
413 <% include( @existing ) %>
416 % if ( $f->{'m2_fields'} ) {
417 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
418 % my $column = $c->{field};
419 % my @column = &{ $column_sub }( %$c,
420 % 'fieldnum' => $fieldnum,
421 % 'curr_value' => $name_obj->$column()
424 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
425 style='text-align:right;vertical-align:top;
426 border-top:1px solid black;padding-top:5px;'>
427 <% $c->{'label'} || '' %>
429 <TD style='border-top:1px solid black;padding-top:3px;'>
430 <% include( @column ) %>
440 % #$field .= $fieldnum;
441 % $onchange .= "\nspawn_$field(what);";
443 % if ( $f->{curr_value_callback} ) {
444 % $curr_value = &{ $f->{curr_value_callback} }( $cgi, $object, $field ),
446 % $curr_value = $object->$field();
448 % $curr_value = &{ $opt{'value_callback'} }( $f->{'field'}, $curr_value )
449 % if $opt{'value_callback'} && $mode ne 'error';
452 % my @include = &{ $include_sub }(
454 % 'fieldnum' => $fieldnum,
455 % 'curr_value' => $curr_value,
456 % 'object' => $object,
458 % 'onchange' => $onchange,
459 % ( $fieldnum ? ('cell_style' => 'border-top:1px solid black') : () ),
462 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) {
463 % $include[0] =~ s(^/elements/tr-)(/elements/);
464 % my @label = @include;
465 % $label[0] = '/elements/tr-td-label.html';
467 <% include( @label ) %>
469 <% include( @include ) %>
472 % if ( $f->{'m2_fields'} ) {
473 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
474 % my $column = $c->{field};
475 % my @column = &{ $column_sub }( %$c, 'fieldnum' => $fieldnum );
477 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
478 style='text-align:right;vertical-align:top;
479 border-top:1px solid black;padding-top:5px;'>
480 <% $c->{'label'} || '' %>
482 <TD style='border-top:1px solid black;padding-top:3px;'>
483 <% include( @column ) %>
492 <% include( @include ) %>
495 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) {
497 <SCRIPT TYPE="text/javascript">
499 var <%$field%>_rownum = <% $g_row %>;
500 var <%$field%>_fieldnum = <% $fieldnum %>;
502 function spawn_<%$field%>(what) {
504 // only spawn if we're the last element... return if not
506 var field_regex = /(\d+)$/;
507 var match = field_regex.exec(what.name);
509 alert(what.name + " didn't match?!");
512 if ( match[1] != <%$field%>_fieldnum ) {
516 // change the label on the last entry & add a remove button
517 var prev_label = document.getElementById('<% $field %>_label' + <%$field%>_fieldnum );
518 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 %>';
520 <%$field%>_fieldnum++;
524 % $include[0] =~ s(^/elements/tr-)(/elements/);
525 % my @layer_opt = ( @include,
526 % 'field' => $field."MAGIC_NUMBER",
527 % 'id' => $field."MAGIC_NUMBER",
528 % 'layer_prefix' => $field."MAGIC_NUMBER.",
530 % warn @layer_opt if $opt{'debug'};
532 var newrow = <% include(@layer_opt, html_only=>1) |js_string %>;
534 % if ( $type eq 'selectlayers' ) { #until the rest have html/js_only
535 var newfunc = <% include(@layer_opt, js_only =>1) |js_string %>;
540 // substitute in the new field name
541 var magic_regex = /MAGIC_NUMBER/g;
542 newrow = newrow.replace( magic_regex, <%$field%>_fieldnum );
543 newfunc = newfunc.replace( magic_regex, <%$field%>_fieldnum );
546 if (window.ActiveXObject) {
547 window.execScript(newfunc);
548 } else { /* (window.XMLHttpRequest) */
549 //window.eval(newfunc);
550 setTimeout(newfunc, 0);
555 //hmm, can't use selectlayers after a tablebreak-title for now
556 var table = document.getElementById('TableNumber<% $tablenum-1 %>');
558 var row = table.insertRow(<%$field%>_rownum++);
560 var label_cell = document.createElement('TD');
562 label_cell.id = '<% $field %>_label' + <%$field%>_fieldnum;
564 label_cell.style.textAlign = "right";
565 label_cell.style.verticalAlign = "top";
566 label_cell.style.borderTop = "1px solid black";
567 label_cell.style.paddingTop = "5px";
569 label_cell.innerHTML = '<% $label %>';
571 row.appendChild(label_cell);
573 var widget_cell = document.createElement('TD');
575 widget_cell.style.borderTop = "1px solid black";
576 widget_cell.style.paddingTop = "3px";
578 widget_cell.innerHTML = newrow;
580 row.appendChild(widget_cell);
582 % if ( $f->{'m2_fields'} ) {
583 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
584 % my $column = $c->{field};
585 % my @column = &{ $column_sub }(%$c, 'fieldnum' => 'MAGIC_NUMBER');
587 var column = <% include(@column, html_only=>1) |js_string %>;
588 column = column.replace( magic_regex, <%$field%>_fieldnum );
590 var column_label = document.createElement('TD');
592 '<% $field %>__<% $column %>_label' + <%$field%>_fieldnum;
594 column_label.style.textAlign = "right";
595 column_label.style.verticalAlign = "top";
596 column_label.style.borderTop = "1px solid black";
597 column_label.style.paddingTop = "5px";
599 column_label.innerHTML = '<% $c->{'label'} || '' %>';
601 row.appendChild(column_label);
603 var column_widget = document.createElement('TD');
605 column_widget.style.borderTop = "1px solid black";
606 column_widget.style.paddingTop = "3px";
608 column_widget.innerHTML = column;
610 row.appendChild(column_widget);
615 % if ( $f->{'m2_new_js'} ) {
616 // take out items selected in previous dropdowns
617 var new_element = document.getElementById("<%$field%>" + <%$field%>_fieldnum );
618 <% $f->{'m2_new_js'} %>(new_element);
620 if ( new_element.length < 2 ) {
621 //just the ** Select new **, so don't display the row
622 row.style.display = 'none';
628 function remove_<%$field%>(remove_fieldnum) {
629 //alert("remove <%$field%> " + remove_fieldnum);
630 var select = document.getElementById('<%$field%>' + remove_fieldnum);
633 alert("can't find element <%$field%>" + remove_fieldnum);
637 % my $warnings = $f->{'m2_remove_warnings'};
639 var sel_value = select.options[select.selectedIndex].value;
640 % foreach my $value ( keys %$warnings ) {
641 if ( sel_value == '<% $value %>' ) {
642 if ( ! confirm( <% $warnings->{$value} |js_string %> ) ) {
649 select.disabled = 'disabled'; // this seems to prevent it from being submitted on tested browsers so far (IE, moz, konq at least)
650 var label_td = document.getElementById('<%$field%>_label' + remove_fieldnum );
651 label_td.parentNode.style.display = 'none';
653 % if ( $f->{m2_remove_js} ) {
654 var opt = select.options[select.selectedIndex];
655 <% $f->{m2_remove_js} %>( opt.value, opt.text, 'no_match');
666 <% ref( $opt{'html_table_bottom'} )
667 ? &{ $opt{'html_table_bottom'} }( $object )
668 : $opt{'html_table_bottom'}
673 <% ref( $opt{'html_bottom'} )
674 ? &{ $opt{'html_bottom'} }( $object )
675 : $opt{'html_bottom'}
680 <INPUT TYPE="submit" ID="submit" VALUE="<% ( !$clone && $object->$pkey() ) ? "Apply changes" : "Add ". ( $opt{'name'} || $opt{'name_singular'} ) %>">
684 <% ref( $opt{'html_foot'} )
685 ? &{ $opt{'html_foot'} }( $object )
689 <% include("/elements/footer.html") %>
694 my $curuser = $FS::CurrentUser::CurrentUser;
696 #false laziness w/process.html
697 my $table = $opt{'table'};
698 my $class = "FS::$table";
699 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
700 my $fields = $opt{'fields'}
701 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
702 || [ grep { $_ ne $pkey } fields($table) ];
703 #my @actualfields = map { ref($_) ? $_->{'field'} : $_ } @$fields;
705 if ( $cgi->param('redirect') ) {
706 my $session = $cgi->param('redirect');
707 my $pref = $curuser->option("redirect$session");
708 die "unknown redirect session $session\n" unless length($pref);
709 $cgi = new CGI($pref);
712 &{$opt{'begin_callback'}}( $cgi, $fields, \%opt )
713 if $opt{'begin_callback'};
717 'extra_sql' => ( $opt{'agent_virt'}
718 ? ' AND '. $curuser->agentnums_sql(
719 'null_right' => $opt{'agent_null_right'}
728 if ( $cgi->param('error') ) {
732 $object = $class->new( {
733 map { $_ => scalar($cgi->param($_)) } fields($table)
736 &{$opt{'error_callback'}}( $cgi, $object, $fields, \%opt )
737 if $opt{'error_callback'};
739 } elsif ( $cgi->param('clone') =~ /^(\d+)$/ ) {
745 $qsearch{'extra_sql'} = ' AND '. $opt{'agent_clone_extra_sql'}
746 if $opt{'agent_clone_extra_sql'};
748 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $clone } })
749 or die "$pkey $clone not found in $table";
751 &{$opt{'clone_callback'}}( $cgi, $object, $fields, \%opt )
752 if $opt{'clone_callback'};
756 $opt{action} ||= 'Add';
758 } elsif ( $cgi->keywords || $cgi->param($pkey) ) { #editing
763 if ( $cgi->param($pkey) ) {
764 $value = $cgi->param($pkey)
766 my( $query ) = $cgi->keywords;
769 $value =~ /^(\d+)$/ or die "unparsable $pkey";
770 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $1 } })
771 or die "$pkey $1 not found in $table";
773 warn "$table $pkey => $1"
776 &{$opt{'edit_callback'}}( $cgi, $object, $fields, \%opt )
777 if $opt{'edit_callback'};
783 my $hashref = $opt{'new_hashref_callback'}
784 ? &{$opt{'new_hashref_callback'}}
787 $object = $opt{'new_object_callback'}
788 ? &{$opt{'new_object_callback'}}( $cgi, $hashref, $fields, \%opt )
789 : $class->new( $hashref );
791 &{$opt{'new_callback'}}( $cgi, $object, $fields, \%opt )
792 if $opt{'new_callback'};
796 &{$opt{'end_callback'}}( $cgi, $object, $fields, \%opt )
797 if $opt{'end_callback'};
799 $opt{action} ||= $object->$pkey() ? 'Edit' : 'Add';
801 my $title = $opt{action}. ' '. ( $opt{name} || $opt{'name_singular'} );
803 my $viewall_url = $p . ( $opt{'viewall_dir'} || 'search' ) . "/$table.html";
804 $viewall_url = $opt{'viewall_url'} if $opt{'viewall_url'};
807 if ( $opt{'menubar'} ) {
808 @menubar = @{ $opt{'menubar'} };
810 my $items = $opt{'name'} ? $opt{'name'}.'s' : PL($opt{'name_singular'});
812 "View all $items" => $viewall_url,