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',
97 'viewall_dir' => '', #'search' or 'browse', defaults to 'search'
99 # overrides default popurl(1)."process/$table.html"
100 'post_url' => popurl(1).'process/something',
102 #we're in a popup (no title/menu/searchboxes)
109 'html_init' => '', #after the header/menubar
111 #string or coderef of additional HTML to add before </TABLE>
112 'html_table_bottom' => '',
114 #after </TABLE> but before the submit
115 'html_bottom' => '', #string
116 'html_bottom' => sub {
122 #at the very bottom (well, as low as you can go from here)
126 # initialization callbacks
131 #always run if provided, after decoding long CGI "redirect=" responses but
132 # before object creation/search
133 # (useful if you have a long form that might trigger redirect= and you need
134 # to do things with $cgi params - they're not decoded in the calling
136 'begin_callback' = sub { my( $cgi, $fields_listref, $opt_hashref ) = @_; },
138 #always run, after the mode-specific object creation/search
139 'end_callback' = sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
141 ###mode-specific callbacks
143 #run when re-displaying with an error
144 'error_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
147 'edit_callback' => sub { my( $cgi, $object, $fields_listref ) = @_; },
149 # returns a hashref for the new object
150 'new_hashref_callback'
152 # returns the new object iself (otherwise, ->new is called)
153 'new_object_callback'
156 'new_callback' => sub { my( $cgi, $object, $fields_listref ) = @_; },
159 'clone_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
163 #run before display to return a different value
164 'value_callback' => sub { my( $columname, $value ) = @_; },
166 #run before display to manipulate element of the 'fields' arrayref
167 'field_callback' => sub { my( $cgi, $object, $field_hashref ) = @_; },
173 <% include('/elements/header'. ( $opt{popup} ? '-popup' : '' ). '.html',
175 include( '/elements/menubar.html', @menubar )
179 <% defined($opt{'html_init'})
180 ? ( ref($opt{'html_init'})
181 ? &{$opt{'html_init'}}()
187 <% include('/elements/error.html') %>
189 % my $url = $opt{'post_url'} || popurl(1)."process/$table.html";
191 <FORM ACTION="<% $url %>" METHOD=POST NAME="edit_topform">
193 <INPUT TYPE="hidden" NAME="svcdb" VALUE="<% $table %>">
194 <INPUT TYPE="hidden" NAME="<% $pkey %>" VALUE="<% $clone ? '' : $object->$pkey() %>">
197 <% ( $opt{labels} && exists $opt{labels}->{$pkey} )
198 ? $opt{labels}->{$pkey}
202 #<% ( !$clone && $object->$pkey() ) || "(NEW)" %>
205 <TABLE ID="TableNumber<% $tablenum++ %>" BGCOLOR="#cccccc" BORDER=0 CELLSPACING=0>
208 % my @g_row_stack = ();
209 % foreach my $f ( map { ref($_) ? $_ : {'field'=>$_} }
213 % my $trash = &{ $opt{'field_callback'} }( $cgi, $object, $f )
214 % if $opt{'field_callback'};
216 % my $field = $f->{'field'};
217 % my $type = $f->{'type'} ||= 'text';
219 % my $label = ( $opt{labels} && exists $opt{labels}->{$field} )
220 % ? $opt{labels}->{$field}
223 % my $onchange = $f->{'onchange'};
225 % my $layer_values = {};
226 % $layer_values = &{ $f->{'layer_values_callback'} }( $cgi, $object )
227 % if $f->{'layer_values_callback'}
228 % && ! $f->{'m2name_table'}
229 % && ! $f->{'m2m_method'};
231 % warn "layer values: ". Dumper($layer_values)
234 % my %include_common = (
236 % #text and derivitives
237 % 'size' => $f->{'size'},
238 % 'maxlength' => $f->{'maxlength'},
240 % #checkbox, title, fixed, hidden
241 % #& deprecated weird value hashref used only by reason.html
242 % 'value' => $f->{'value'},
245 % 'options' => $f->{'options'},
246 % 'labels' => $f->{'labels'},
247 % 'multiple' => $f->{'multiple'},
248 % 'disable_empty' => $f->{'disable_empty'},
250 % 'reason_class' => $f->{'reason_class'},
253 % 'layer_fields' => $f->{'layer_fields'},
254 % 'layer_values' => $layer_values,
255 % 'html_between' => $f->{'html_between'},
258 % 'disabled' => $f->{'disabled'},
261 % #selectlayers, others?
262 % $include_common{$_} = $f->{$_}
263 % foreach grep exists($f->{$_}),
264 % qw( js_only html_only select_only layers_only cell_style);
267 % $include_common{$_} = $f->{$_}
268 % foreach grep exists($f->{$_}), qw( empty_label );
270 % #select-table, checkboxes-table
271 % $include_common{$_} = $f->{$_}
272 % foreach grep exists($f->{$_}), qw( table name_col );
275 % $include_common{$_} = $f->{$_}
276 % foreach grep exists($f->{$_}), qw( target_table link_table );
279 % $include_common{$_} = $f->{$_}
280 % foreach grep exists($f->{$_}), qw( hashref agent_virt agent_null_right );
282 % if ( $type eq 'tablebreak-tr-title' ) {
283 % $include_common{'table_id'} = 'TableNumber'. $tablenum++
286 % my $layer_prefix_on = '';
288 % my $include_sub = sub {
291 % my $fieldnum = delete $opt{'fieldnum'};
293 % my $include = $type;
294 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
295 % $include = "tr-$include" unless $include =~ /^(hidden|tablebreak|column)/;
297 % $include_common{'layer_prefix'} = "$field$fieldnum."
298 % if $layer_prefix_on;
301 % ( "/elements/$include.html",
302 % 'field' => "$field$fieldnum",
303 % 'id' => "$field$fieldnum", #separate?
304 % 'label_id' => $field."_label$fieldnum", #don't want field0_label0...
311 % unless ( $type =~ /^column/ ) {
312 % $g_row = 1 if $type eq 'tablebreak-tr-title';
314 % $g_row++ if $type eq 'title';
316 % if ( $type eq 'columnstart' ) {
317 % push @g_row_stack, $g_row;
319 % #} elsif ( $type eq 'columnnext' ) {
320 % } elsif ( $type eq 'columnend' ) {
321 % $g_row = pop @g_row_stack;
327 % my $curr_value = '';
328 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) { #XXX test this for all
331 % if ( $f->{'m2name_table'} ) {
332 % $table = $f->{'m2name_table'};
333 % $col = $f->{'m2name_namecol'};
334 % } elsif ( $f->{'m2m_method'} ) {
335 % $table = $f->{'m2m_method'};
336 % $col = $f->{'m2m_dstcol'};
339 % $layer_prefix_on = 1;
340 % #print out the fields for the existing m2s
342 % if ( $mode eq 'error' ) {
343 % @existing = &{ $f->{'m2_error_callback'} }( $cgi, $object );
344 % } elsif ( $object->$pkey() ) { # $mode eq 'edit'||'clone'
345 % @existing = $object->$table();
346 % warn scalar(@existing). " from $object->$table: ". join('/', @existing)
348 % } elsif ( $f->{'m2_new_default'} ) { # && $mode eq 'new'
349 % @existing = @{ $f->{'m2_new_default'} };
351 % foreach my $name_obj ( @existing ) {
353 % my $ex_label = '<INPUT TYPE="button" VALUE="X" TITLE="Remove this '.
354 % lc($f->{'m2_label'}).
355 % qq(" onClick="remove_$field($fieldnum);").
356 % ' STYLE="color:#ff0000;font-weight:bold;'.
357 % 'padding-left:2px;padding-right:2px"'.
358 % '> '. ($f->{'m2_label'} || $field ). ' ';
360 % if ( $f->{'layer_values_callback'} ) {
361 % my %switches = ( 'mode' => $mode );
363 % &{ $f->{'layer_values_callback'} }( $cgi, $name_obj, \%switches );
365 % warn "layer values: ". Dumper($layer_values)
368 % my @existing = &{ $include_sub }(
369 % 'label' => $ex_label,
370 % 'fieldnum' => $fieldnum,
371 % 'curr_value' => $name_obj->$col(),
372 % 'onchange' => $onchange,
373 % 'layer_values' => $layer_values,
374 % 'cell_style' => ( $fieldnum ? 'border-top:1px solid black' : '' ),
377 <% include( @existing ) %>
382 % #$field .= $fieldnum;
383 % $onchange .= "\nspawn_$field(what);";
385 % if ( $f->{curr_value_callback} ) {
386 % $curr_value = &{ $f->{curr_value_callback} }( $cgi, $object, $field ),
388 % $curr_value = $object->$field();
390 % $curr_value = &{ $opt{'value_callback'} }( $f->{'field'}, $curr_value )
391 % if $opt{'value_callback'} && $mode ne 'error';
394 % my @include = &{ $include_sub }(
396 % 'fieldnum' => $fieldnum,
397 % 'curr_value' => $curr_value,
398 % 'object' => $object,
400 % 'onchange' => $onchange,
401 % ( $fieldnum ? ('cell_style' => 'border-top:1px solid black') : () ),
404 <% include( @include ) %>
406 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) {
408 <SCRIPT TYPE="text/javascript">
410 var <%$field%>_rownum = <% $g_row %>;
411 var <%$field%>_fieldnum = <% $fieldnum %>;
413 function spawn_<%$field%>(what) {
415 // only spawn if we're the last element... return if not
417 var field_regex = /(\d+)$/;
418 var match = field_regex.exec(what.name);
420 alert(what.name + " didn't match?!");
423 if ( match[1] != <%$field%>_fieldnum ) {
427 // change the label on the last entry & add a remove button
428 var prev_label = document.getElementById('<% $field %>_label' + <%$field%>_fieldnum );
429 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 %>';
431 <%$field%>_fieldnum++;
435 % $include[0] =~ s(^/elements/tr-)(/elements/);
436 % my @layer_opt = ( @include,
437 % 'field' => $field."MAGIC_NUMBER",
438 % 'id' => $field."MAGIC_NUMBER",
439 % 'layer_prefix' => $field."MAGIC_NUMBER.",
441 % warn @layer_opt if $opt{'debug'};
443 var newrow = <% include(@layer_opt, html_only=>1) |js_string %>;
445 % if ( $type eq 'selectlayers' ) { #until the rest have html/js_only
446 var newfunc = <% include(@layer_opt, js_only =>1) |js_string %>;
451 // substitute in the new field name
452 var magic_regex = /MAGIC_NUMBER/g;
453 newrow = newrow.replace( magic_regex, <%$field%>_fieldnum );
454 newfunc = newfunc.replace( magic_regex, <%$field%>_fieldnum );
457 if (window.ActiveXObject) {
458 window.execScript(newfunc);
459 } else { /* (window.XMLHttpRequest) */
460 //window.eval(newfunc);
461 setTimeout(newfunc, 0);
466 //hmm, can't use selectlayers after a tablebreak-title for now
467 var table = document.getElementById('TableNumber<% $tablenum-1 %>');
469 var row = table.insertRow(<%$field%>_rownum++);
471 var label_cell = document.createElement('TD');
473 label_cell.id = '<% $field %>_label' + <%$field%>_fieldnum;
475 label_cell.style.textAlign = "right";
476 label_cell.style.verticalAlign = "top";
477 label_cell.style.borderTop = "1px solid black";
478 label_cell.style.paddingTop = "5px";
480 label_cell.innerHTML = '<% $label %>';
482 row.appendChild(label_cell);
484 var widget_cell = document.createElement('TD');
486 widget_cell.style.borderTop = "1px solid black";
487 widget_cell.style.paddingTop = "3px";
489 widget_cell.innerHTML = newrow;
491 row.appendChild(widget_cell);
493 % if ( $f->{'m2_new_js'} ) {
494 // take out items selected in previous dropdowns
495 var new_element = document.getElementById("<%$field%>" + <%$field%>_fieldnum );
496 <% $f->{'m2_new_js'} %>(new_element);
498 if ( new_element.length < 2 ) {
499 //just the ** Select new **, so don't display the row
500 row.style.display = 'none';
506 function remove_<%$field%>(remove_fieldnum) {
507 //alert("remove <%$field%> " + remove_fieldnum);
508 var select = document.getElementById('<%$field%>' + remove_fieldnum);
511 alert("can't find element <%$field%>" + remove_fieldnum);
515 % my $warnings = $f->{'m2_remove_warnings'};
517 var sel_value = select.options[select.selectedIndex].value;
518 % foreach my $value ( keys %$warnings ) {
519 if ( sel_value == '<% $value %>' ) {
520 if ( ! confirm( <% $warnings->{$value} |js_string %> ) ) {
527 select.disabled = 'disabled'; // this seems to prevent it from being submitted on tested browsers so far (IE, moz, konq at least)
528 var label_td = document.getElementById('<%$field%>_label' + remove_fieldnum );
529 label_td.parentNode.style.display = 'none';
531 % if ( $f->{m2_remove_js} ) {
532 var opt = select.options[select.selectedIndex];
533 <% $f->{m2_remove_js} %>( opt.value, opt.text, 'no_match');
544 <% ref( $opt{'html_table_bottom'} )
545 ? &{ $opt{'html_table_bottom'} }( $object )
546 : $opt{'html_table_bottom'}
551 <% ref( $opt{'html_bottom'} )
552 ? &{ $opt{'html_bottom'} }( $object )
553 : $opt{'html_bottom'}
558 <INPUT TYPE="submit" ID="submit" VALUE="<% ( !$clone && $object->$pkey() ) ? "Apply changes" : "Add $opt{'name'}" %>">
562 <% ref( $opt{'html_foot'} )
563 ? &{ $opt{'html_foot'} }( $object )
567 <% include("/elements/footer.html") %>
572 my $curuser = $FS::CurrentUser::CurrentUser;
574 #false laziness w/process.html
575 my $table = $opt{'table'};
576 my $class = "FS::$table";
577 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
578 my $fields = $opt{'fields'}
579 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
580 || [ grep { $_ ne $pkey } fields($table) ];
581 #my @actualfields = map { ref($_) ? $_->{'field'} : $_ } @$fields;
583 if ( $cgi->param('redirect') ) {
584 my $session = $cgi->param('redirect');
585 my $pref = $curuser->option("redirect$session");
586 die "unknown redirect session $session\n" unless length($pref);
587 $cgi = new CGI($pref);
590 &{$opt{'begin_callback'}}( $cgi, $fields, \%opt )
591 if $opt{'begin_callback'};
595 'extra_sql' => ( $opt{'agent_virt'}
596 ? ' AND '. $curuser->agentnums_sql(
597 'null_right' => $opt{'agent_null_right'}
606 if ( $cgi->param('error') ) {
610 $object = $class->new( {
611 map { $_ => scalar($cgi->param($_)) } fields($table)
614 &{$opt{'error_callback'}}($cgi, $object, $fields, \%opt )
615 if $opt{'error_callback'};
617 } elsif ( $cgi->param('clone') =~ /^(\d+)$/ ) {
623 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $clone } });
625 &{$opt{'clone_callback'}}($cgi, $object, $fields, \%opt )
626 if $opt{'clone_callback'};
630 $opt{action} ||= 'Add';
632 } elsif ( $cgi->keywords || $cgi->param($pkey) ) { #editing
637 if ( $cgi->param($pkey) ) {
638 $value = $cgi->param($pkey)
640 my( $query ) = $cgi->keywords;
643 $value =~ /^(\d+)$/ or die "unparsable $pkey";
644 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $1 } });
646 warn "$table $pkey => $1"
649 &{$opt{'edit_callback'}}($cgi, $object, $fields)
650 if $opt{'edit_callback'};
656 my $hashref = $opt{'new_hashref_callback'}
657 ? &{$opt{'new_hashref_callback'}}
660 $object = $opt{'new_object_callback'}
661 ? &{$opt{'new_object_callback'}}( $cgi, $hashref, $fields, \%opt )
662 : $class->new( $hashref );
664 &{$opt{'new_callback'}}($cgi, $object, $fields)
665 if $opt{'new_callback'};
669 &{$opt{'end_callback'}}( $cgi, $object, $fields, \%opt )
670 if $opt{'end_callback'};
672 $opt{action} ||= $object->$pkey() ? 'Edit' : 'Add';
674 my $title = $opt{action}. ' '. $opt{name};
676 my $viewall_url = $p . ( $opt{'viewall_dir'} || 'search' ) . "/$table.html";
677 $viewall_url = $opt{'viewall_url'} if $opt{'viewall_url'};
680 if ( $opt{'menubar'} ) {
681 @menubar = @{ $opt{'menubar'} };
683 my $items = $opt{'name'} ? $opt{'name'}.'s' : PL($opt{'name_singular'});
685 "View all $items" => $viewall_url,