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 );
281 % #select-table, checkboxes-table
282 % $include_common{$_} = $f->{$_}
283 % foreach grep exists($f->{$_}), qw( table name_col value_col );
286 % $include_common{$_} = $f->{$_}
287 % foreach grep exists($f->{$_}), qw( target_table link_table );
290 % $include_common{$_} = $f->{$_}
291 % foreach grep exists($f->{$_}), qw( hashref agent_virt agent_null_right );
293 % if ( $type eq 'tablebreak-tr-title' ) {
294 % $include_common{'table_id'} = 'TableNumber'. $tablenum++;
295 % $include_common{'colspan'} = $f->{colspan} if $f->{colspan};
298 % if ( $f->{include_opt_callback} ) {
299 % %include_common = ( %include_common, &{ $f->{include_opt_callback} } );
302 % my $layer_prefix_on = '';
304 % my $include_sub = sub {
307 % my $fieldnum = delete $opt{'fieldnum'};
309 % my $include = $type;
310 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
311 % $include = "tr-$include" unless $include =~ /^(hidden|tablebreak|column)/;
313 % $include_common{'layer_prefix'} = "$field$fieldnum."
314 % if $layer_prefix_on;
317 % ( "/elements/$include.html",
318 % 'field' => "$field$fieldnum",
319 % 'id' => "$field$fieldnum", #separate?
320 % 'label_id' => $field."_label$fieldnum", #don't want field0_label0...
327 % my $column_sub = sub {
330 % my $column = delete($opt{field});
331 % my $fieldnum = delete($opt{fieldnum});
332 % my $include = delete($opt{type}) || 'text';
333 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
335 % ( "/elements/$include.html",
336 % 'field' => $field.'__'.$column.$fieldnum,
337 % 'id' => $field.'__'.$column.$fieldnum,
338 % 'layer_prefix' => $field.'__'.$column.$fieldnum.".",
340 % ? ('cell_style' => 'border-top:1px solid black')
348 % unless ( $type =~ /^column/ ) {
349 % $g_row = 1 if $type eq 'tablebreak-tr-title';
351 % $g_row++ if $type eq 'title';
353 % if ( $type eq 'columnstart' ) {
354 % push @g_row_stack, $g_row;
356 % #} elsif ( $type eq 'columnnext' ) {
357 % } elsif ( $type eq 'columnend' ) {
358 % $g_row = pop @g_row_stack;
364 % my $curr_value = '';
365 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) { #XXX test this for all
368 % if ( $f->{'m2name_table'} ) {
369 % $table = $f->{'m2name_table'};
370 % $col = $f->{'m2name_namecol'};
371 % } elsif ( $f->{'m2m_method'} ) {
372 % $table = $f->{'m2m_method'};
373 % $col = $f->{'m2m_dstcol'};
376 % $layer_prefix_on = 1;
377 % #print out the fields for the existing m2s
379 % if ( $mode eq 'error' ) {
380 % @existing = &{ $f->{'m2_error_callback'} }( $cgi, $object );
381 % } elsif ( $object->$pkey() ) { # $mode eq 'edit'||'clone'
382 % @existing = $object->$table();
383 % warn scalar(@existing). " from $object->$table: ". join('/', @existing)
385 % } elsif ( $f->{'m2_new_default'} ) { # && $mode eq 'new'
386 % @existing = @{ $f->{'m2_new_default'} };
388 % foreach my $name_obj ( @existing ) {
390 % my $ex_label = '<INPUT TYPE="button" VALUE="X" TITLE="Remove this '.
391 % lc($f->{'m2_label'}).
392 % qq(" onClick="remove_$field($fieldnum);").
393 % ' STYLE="color:#ff0000;font-weight:bold;'.
394 % 'padding-left:2px;padding-right:2px"'.
395 % '> '. ($f->{'m2_label'} || $field ). ' ';
397 % if ( $f->{'layer_values_callback'} ) {
398 % my %switches = ( 'mode' => $mode );
400 % &{ $f->{'layer_values_callback'} }( $cgi, $name_obj, \%switches );
402 % warn "layer values: ". Dumper($layer_values)
405 % my @existing = &{ $include_sub }(
406 % 'label' => $ex_label,
407 % 'fieldnum' => $fieldnum,
408 % 'curr_value' => $name_obj->$col(),
409 % 'onchange' => $onchange,
410 % 'layer_values' => $layer_values,
411 % 'cell_style' => ( $fieldnum ? 'border-top:1px solid black' : '' ),
413 % $existing[0] =~ s(^/elements/tr-)(/elements/);
414 % my @label = @existing;
415 % $label[0] = '/elements/tr-td-label.html';
417 <% include( @label ) %>
419 <% include( @existing ) %>
422 % if ( $f->{'m2_fields'} ) {
423 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
424 % my $column = $c->{field};
425 % my @column = &{ $column_sub }( %$c,
426 % 'fieldnum' => $fieldnum,
427 % 'curr_value' => $name_obj->$column()
430 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
431 style='text-align:right;vertical-align:top;
432 border-top:1px solid black;padding-top:5px;'>
433 <% $c->{'label'} || '' %>
435 <TD style='border-top:1px solid black;padding-top:3px;'>
436 <% include( @column ) %>
446 % #$field .= $fieldnum;
447 % $onchange .= "\nspawn_$field(what);";
449 % if ( $f->{curr_value_callback} ) {
450 % $curr_value = &{ $f->{curr_value_callback} }( $cgi, $object, $field ),
452 % $curr_value = $object->$field();
454 % $curr_value = &{ $opt{'value_callback'} }( $f->{'field'}, $curr_value )
455 % if $opt{'value_callback'} && $mode ne 'error';
458 % my @include = &{ $include_sub }(
460 % 'fieldnum' => $fieldnum,
461 % 'curr_value' => $curr_value,
462 % 'object' => $object,
464 % 'onchange' => $onchange,
465 % ( $fieldnum ? ('cell_style' => 'border-top:1px solid black') : () ),
468 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) {
469 % $include[0] =~ s(^/elements/tr-)(/elements/);
470 % my @label = @include;
471 % $label[0] = '/elements/tr-td-label.html';
473 <% include( @label ) %>
475 <% include( @include ) %>
478 % if ( $f->{'m2_fields'} ) {
479 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
480 % my $column = $c->{field};
481 % my @column = &{ $column_sub }( %$c, 'fieldnum' => $fieldnum );
483 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
484 style='text-align:right;vertical-align:top;
485 border-top:1px solid black;padding-top:5px;'>
486 <% $c->{'label'} || '' %>
488 <TD style='border-top:1px solid black;padding-top:3px;'>
489 <% include( @column ) %>
498 <% include( @include ) %>
501 % if ( $f->{'m2name_table'} || $f->{'m2m_method'} ) {
503 <SCRIPT TYPE="text/javascript">
505 var <%$field%>_rownum = <% $g_row %>;
506 var <%$field%>_fieldnum = <% $fieldnum %>;
508 function spawn_<%$field%>(what) {
510 // only spawn if we're the last element... return if not
512 var field_regex = /(\d+)$/;
513 var match = field_regex.exec(what.name);
515 alert(what.name + " didn't match?!");
518 if ( match[1] != <%$field%>_fieldnum ) {
522 // change the label on the last entry & add a remove button
523 var prev_label = document.getElementById('<% $field %>_label' + <%$field%>_fieldnum );
524 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 %>';
526 <%$field%>_fieldnum++;
530 % $include[0] =~ s(^/elements/tr-)(/elements/);
531 % my @layer_opt = ( @include,
532 % 'field' => $field."MAGIC_NUMBER",
533 % 'id' => $field."MAGIC_NUMBER",
534 % 'layer_prefix' => $field."MAGIC_NUMBER.",
536 % warn @layer_opt if $opt{'debug'};
538 var newrow = <% include(@layer_opt, html_only=>1) |js_string %>;
540 % if ( $type eq 'selectlayers' ) { #until the rest have html/js_only
541 var newfunc = <% include(@layer_opt, js_only =>1) |js_string %>;
546 // substitute in the new field name
547 var magic_regex = /MAGIC_NUMBER/g;
548 newrow = newrow.replace( magic_regex, <%$field%>_fieldnum );
549 newfunc = newfunc.replace( magic_regex, <%$field%>_fieldnum );
552 if (window.ActiveXObject) {
553 window.execScript(newfunc);
554 } else { /* (window.XMLHttpRequest) */
555 //window.eval(newfunc);
556 setTimeout(newfunc, 0);
561 //hmm, can't use selectlayers after a tablebreak-title for now
562 var table = document.getElementById('TableNumber<% $tablenum-1 %>');
564 var row = table.insertRow(<%$field%>_rownum++);
566 var label_cell = document.createElement('TD');
568 label_cell.id = '<% $field %>_label' + <%$field%>_fieldnum;
570 label_cell.style.textAlign = "right";
571 label_cell.style.verticalAlign = "top";
572 label_cell.style.borderTop = "1px solid black";
573 label_cell.style.paddingTop = "5px";
575 label_cell.innerHTML = '<% $label %>';
577 row.appendChild(label_cell);
579 var widget_cell = document.createElement('TD');
581 widget_cell.style.borderTop = "1px solid black";
582 widget_cell.style.paddingTop = "3px";
584 widget_cell.innerHTML = newrow;
586 row.appendChild(widget_cell);
588 % if ( $f->{'m2_fields'} ) {
589 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
590 % my $column = $c->{field};
591 % my @column = &{ $column_sub }(%$c, 'fieldnum' => 'MAGIC_NUMBER');
593 var column = <% include(@column, html_only=>1) |js_string %>;
594 column = column.replace( magic_regex, <%$field%>_fieldnum );
596 var column_label = document.createElement('TD');
598 '<% $field %>__<% $column %>_label' + <%$field%>_fieldnum;
600 column_label.style.textAlign = "right";
601 column_label.style.verticalAlign = "top";
602 column_label.style.borderTop = "1px solid black";
603 column_label.style.paddingTop = "5px";
605 column_label.innerHTML = '<% $c->{'label'} || '' %>';
607 row.appendChild(column_label);
609 var column_widget = document.createElement('TD');
611 column_widget.style.borderTop = "1px solid black";
612 column_widget.style.paddingTop = "3px";
614 column_widget.innerHTML = column;
616 row.appendChild(column_widget);
621 % if ( $f->{'m2_new_js'} ) {
622 // take out items selected in previous dropdowns
623 var new_element = document.getElementById("<%$field%>" + <%$field%>_fieldnum );
624 <% $f->{'m2_new_js'} %>(new_element);
626 if ( new_element.length < 2 ) {
627 //just the ** Select new **, so don't display the row
628 row.style.display = 'none';
634 function remove_<%$field%>(remove_fieldnum) {
635 //alert("remove <%$field%> " + remove_fieldnum);
636 var select = document.getElementById('<%$field%>' + remove_fieldnum);
639 alert("can't find element <%$field%>" + remove_fieldnum);
643 % my $warnings = $f->{'m2_remove_warnings'};
645 var sel_value = select.options[select.selectedIndex].value;
646 % foreach my $value ( keys %$warnings ) {
647 if ( sel_value == '<% $value %>' ) {
648 if ( ! confirm( <% $warnings->{$value} |js_string %> ) ) {
655 select.disabled = 'disabled'; // this seems to prevent it from being submitted on tested browsers so far (IE, moz, konq at least)
656 var label_td = document.getElementById('<%$field%>_label' + remove_fieldnum );
657 label_td.parentNode.style.display = 'none';
659 % if ( $f->{m2_remove_js} ) {
660 var opt = select.options[select.selectedIndex];
661 <% $f->{m2_remove_js} %>( opt.value, opt.text, 'no_match');
672 <% ref( $opt{'html_table_bottom'} )
673 ? &{ $opt{'html_table_bottom'} }( $object )
674 : $opt{'html_table_bottom'}
679 <% ref( $opt{'html_bottom'} )
680 ? &{ $opt{'html_bottom'} }( $object )
681 : $opt{'html_bottom'}
686 <INPUT TYPE="submit" ID="submit" VALUE="<% ( !$clone && $object->$pkey() ) ? "Apply changes" : "Add ". ( $opt{'name'} || $opt{'name_singular'} ) %>">
690 <% ref( $opt{'html_foot'} )
691 ? &{ $opt{'html_foot'} }( $object )
695 <% include("/elements/footer.html") %>
700 my $curuser = $FS::CurrentUser::CurrentUser;
702 #false laziness w/process.html
703 my $table = $opt{'table'};
704 my $class = "FS::$table";
705 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
706 my $fields = $opt{'fields'}
707 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
708 || [ grep { $_ ne $pkey } fields($table) ];
709 #my @actualfields = map { ref($_) ? $_->{'field'} : $_ } @$fields;
711 if ( $cgi->param('redirect') ) {
712 my $session = $cgi->param('redirect');
713 my $pref = $curuser->option("redirect$session");
714 die "unknown redirect session $session\n" unless length($pref);
715 $cgi = new CGI($pref);
718 &{$opt{'begin_callback'}}( $cgi, $fields, \%opt )
719 if $opt{'begin_callback'};
723 'extra_sql' => ( $opt{'agent_virt'}
724 ? ' AND '. $curuser->agentnums_sql(
725 'null_right' => $opt{'agent_null_right'}
734 if ( $cgi->param('error') ) {
738 $object = $class->new( {
739 map { $_ => scalar($cgi->param($_)) } fields($table)
742 &{$opt{'error_callback'}}( $cgi, $object, $fields, \%opt )
743 if $opt{'error_callback'};
745 } elsif ( $cgi->param('clone') =~ /^(\d+)$/ ) {
751 $qsearch{'extra_sql'} = ' AND '. $opt{'agent_clone_extra_sql'}
752 if $opt{'agent_clone_extra_sql'};
754 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $clone } })
755 or die "$pkey $clone not found in $table";
757 &{$opt{'clone_callback'}}( $cgi, $object, $fields, \%opt )
758 if $opt{'clone_callback'};
762 $opt{action} ||= 'Add';
764 } elsif ( $cgi->keywords || $cgi->param($pkey) ) { #editing
769 if ( $cgi->param($pkey) ) {
770 $value = $cgi->param($pkey)
772 my( $query ) = $cgi->keywords;
775 $value =~ /^(\d+)$/ or die "unparsable $pkey";
776 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $1 } })
777 or die "$pkey $1 not found in $table";
779 warn "$table $pkey => $1"
782 &{$opt{'edit_callback'}}( $cgi, $object, $fields, \%opt )
783 if $opt{'edit_callback'};
789 my $hashref = $opt{'new_hashref_callback'}
790 ? &{$opt{'new_hashref_callback'}}
793 $object = $opt{'new_object_callback'}
794 ? &{$opt{'new_object_callback'}}( $cgi, $hashref, $fields, \%opt )
795 : $class->new( $hashref );
797 &{$opt{'new_callback'}}( $cgi, $object, $fields, \%opt )
798 if $opt{'new_callback'};
802 &{$opt{'end_callback'}}( $cgi, $object, $fields, \%opt )
803 if $opt{'end_callback'};
805 $opt{action} ||= $object->$pkey() ? 'Edit' : 'Add';
807 my $title = $opt{action}. ' '. ( $opt{name} || $opt{'name_singular'} );
809 my $viewall_url = $p . ( $opt{'viewall_dir'} || 'search' ) . "/$table.html";
810 $viewall_url = $opt{'viewall_url'} if $opt{'viewall_url'};
813 if ( $opt{'menubar'} ) {
814 @menubar = @{ $opt{'menubar'} };
816 my $items = $opt{'name'} ? $opt{'name'}.'s' : PL($opt{'name_singular'});
818 "View all $items" => $viewall_url,