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
56 'm2_label' => 'Label', #
57 'm2_new_default' => \@table_name_objects, #default
60 'm2_error_callback' => sub { my($cgi, $object) = @_; },
61 'm2_remove_warnings' => \%warnings, #hashref of warning
64 'm2_new_js' => 'function_name', #javascript function called
65 #on spawned rows (one arg:
67 'm2_remove_js' => 'function_name', #js function called when
68 #a row is deleted (three
71 #layer_fields & layer_values_callback only for selectlayer
73 'fieldname' => 'Label',
76 type =>'text', #text, money
79 'layer_values_callback' =>
81 my( $cgi, $object ) = @_;
82 { 'layer' => { 'fieldname' => 'current_value',
83 'fieldname2' => 'field2value',
86 'layer2' => { 'l2fieldname' => 'l2value',
95 'menubar' => '', #menubar arrayref
99 'agent_null_right' => 'Access Right Name',
100 'agent_clone_extra_sql' => '', #if provided, this overrides the extra_sql
101 #implementing agent virt, for clone
102 #operations. i.e. pass "1=1" to allow
105 'viewall_dir' => '', #'search' or 'browse', defaults to 'search'
107 # overrides default popurl(1)."process/$table.html"
108 'post_url' => popurl(1).'process/something',
110 #we're in a popup (no title/menu/searchboxes)
117 'body_etc' => '', # Additional BODY attributes, i.e. onLoad=""
119 'html_init' => '', #after the header/menubar
121 #string or coderef of additional HTML to add before </TABLE>
122 'html_table_bottom' => '',
124 #after </TABLE> but before the submit
125 'html_bottom' => '', #string
126 'html_bottom' => sub {
132 #at the very bottom (well, as low as you can go from here)
136 # initialization callbacks
139 ###global callbacks, always run if provided
141 #after decoding long CGI "redirect=" responses but
142 # before object creation/search
143 # (useful if you have a long form that might trigger redirect= and you need
144 # to do things with $cgi params - they're not decoded in the calling
146 'begin_callback' = sub { my( $cgi, $fields_listref, $opt_hashref ) = @_; },
148 #after the mode-specific object creation/search
149 'end_callback' = sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
151 ###mode-specific callbacks. one (and only one) of these four is called
154 'new_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
157 'edit_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
159 #run when re-displaying with an error
160 'error_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
163 'clone_callback' => sub { my( $cgi, $object, $fields_listref, $opt_hashref ) = @_; },
165 ###callbacks called in new mode only
167 # returns a hashref for the new object
168 'new_hashref_callback'
170 # returns the new object iself (otherwise, ->new is called)
171 'new_object_callback'
175 #run before display to return a different value
176 'value_callback' => sub { my( $columname, $value ) = @_; },
178 #run before display to manipulate element of the 'fields' arrayref
179 'field_callback' => sub { my( $cgi, $object, $field_hashref ) = @_; },
185 <% include('/elements/header'. ( $opt{popup} ? '-popup' : '' ). '.html',
187 include( '/elements/menubar.html', @menubar ),
192 <% defined($opt{'html_init'})
193 ? ( ref($opt{'html_init'})
194 ? &{$opt{'html_init'}}()
200 <% include('/elements/error.html') %>
202 % my $url = $opt{'post_url'} || popurl(1)."process/$table.html";
204 <FORM ACTION="<% $url %>" METHOD=POST NAME="edit_topform">
206 <INPUT TYPE="hidden" NAME="svcdb" VALUE="<% $table %>">
207 <INPUT TYPE="hidden" NAME="<% $pkey %>" VALUE="<% $clone ? '' : $object->$pkey() %>">
210 <% ( $opt{labels} && exists $opt{labels}->{$pkey} )
211 ? $opt{labels}->{$pkey}
215 #<% ( !$clone && $object->$pkey() ) || "(NEW)" %>
218 <TABLE ID="TableNumber<% $tablenum++ %>" BGCOLOR="#cccccc" BORDER=0 CELLSPACING=0>
221 % my @g_row_stack = ();
222 % foreach my $f ( map { ref($_) ? $_ : {'field'=>$_} }
226 % my $trash = &{ $opt{'field_callback'} }( $cgi, $object, $f )
227 % if $opt{'field_callback'};
229 % my $field = $f->{'field'};
230 % my $type = $f->{'type'} ||= 'text';
232 % my $label = ( $opt{labels} && exists $opt{labels}->{$field} )
233 % ? $opt{labels}->{$field}
236 % my $onchange = $f->{'onchange'};
238 % my $layer_values = {};
239 % $layer_values = &{ $f->{'layer_values_callback'} }( $cgi, $object )
240 % if $f->{'layer_values_callback'}
241 % && ! $f->{'m2name_table'}
242 % && ! $f->{'o2m_table'}
243 % && ! $f->{'m2m_method'};
245 % warn "layer values: ". Dumper($layer_values)
248 % my %include_common = (
250 % #text and derivitives
251 % 'size' => $f->{'size'},
252 % 'maxlength' => $f->{'maxlength'},
254 % #checkbox, title, fixed, hidden
255 % #& deprecated weird value hashref used only by reason.html
256 % 'value' => $f->{'value'},
259 % 'options' => $f->{'options'},
260 % 'labels' => $f->{'labels'},
261 % 'multiple' => $f->{'multiple'},
262 % 'disable_empty' => $f->{'disable_empty'},
264 % 'reason_class' => $f->{'reason_class'},
267 % 'layer_fields' => $f->{'layer_fields'},
268 % 'layer_values' => $layer_values,
269 % 'html_between' => $f->{'html_between'},
271 % #umm. for select-agent_types at least
272 % 'disabled' => $f->{'disabled'},
275 % #selectlayers, others?
276 % $include_common{$_} = $f->{$_}
277 % foreach grep exists($f->{$_}),
278 % qw( js_only html_only select_only layers_only cell_style);
281 % $include_common{$_} = $f->{$_}
282 % foreach grep exists($f->{$_}), qw( empty_label );
284 % #select-table, checkboxes-table
285 % $include_common{$_} = $f->{$_}
286 % foreach grep exists($f->{$_}), qw( table name_col );
289 % $include_common{$_} = $f->{$_}
290 % foreach grep exists($f->{$_}), qw( target_table link_table );
293 % $include_common{$_} = $f->{$_}
294 % foreach grep exists($f->{$_}), qw( hashref agent_virt agent_null_right );
296 % if ( $type eq 'tablebreak-tr-title' ) {
297 % $include_common{'table_id'} = 'TableNumber'. $tablenum++;
298 % $include_common{'colspan'} = $f->{colspan} if $f->{colspan};
301 % if ( $f->{include_opt_callback} ) {
302 % %include_common = ( %include_common, &{ $f->{include_opt_callback} } );
305 % my $layer_prefix_on = '';
307 % my $include_sub = sub {
310 % my $fieldnum = delete $opt{'fieldnum'};
312 % my $include = $type;
313 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
314 % $include = "tr-$include" unless $include =~ /^(hidden|tablebreak|column)/;
316 % $include_common{'layer_prefix'} = "$field$fieldnum."
317 % if $layer_prefix_on;
320 % ( "/elements/$include.html",
321 % 'field' => "$field$fieldnum",
322 % 'id' => "$field$fieldnum", #separate?
323 % 'label_id' => $field."_label$fieldnum", #don't want field0_label0...
330 % my $column_sub = sub {
333 % my $column = delete($opt{field});
334 % my $fieldnum = delete($opt{fieldnum});
335 % my $include = delete($opt{type}) || 'text';
336 % $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
338 % ( "/elements/$include.html",
339 % 'field' => $field.'__'.$column.$fieldnum,
340 % 'id' => $field.'__'.$column.$fieldnum,
341 % 'layer_prefix' => $field.'__'.$column.$fieldnum.".",
343 % ? ('cell_style' => 'border-top:1px solid black')
351 % unless ( $type =~ /^column/ ) {
352 % $g_row = 1 if $type eq 'tablebreak-tr-title';
354 % $g_row++ if $type eq 'title';
356 % if ( $type eq 'columnstart' ) {
357 % push @g_row_stack, $g_row;
359 % #} elsif ( $type eq 'columnnext' ) {
360 % } elsif ( $type eq 'columnend' ) {
361 % $g_row = pop @g_row_stack;
367 % my $curr_value = '';
368 % if ( $f->{'m2name_table'} || $f->{'o2m_table'} || $f->{'m2m_method'} ) {
371 % if ( $f->{'m2name_table'} ) {
372 % $table = $f->{'m2name_table'};
373 % $col = $f->{'m2name_namecol'};
374 % } elsif ( $f->{'o2m_table'} ) {
375 % $table = $f->{'o2m_table'};
376 % $col = dbdef->table($f->{'o2m_table'})->primary_key;
377 % } elsif ( $f->{'m2m_method'} ) {
378 % $table = $f->{'m2m_method'};
379 % $col = $f->{'m2m_dstcol'};
382 % $layer_prefix_on = 1;
383 % #print out the fields for the existing m2s
385 % if ( $mode eq 'error' ) {
386 % @existing = &{ $f->{'m2_error_callback'} }( $cgi, $object );
387 % } elsif ( $object->$pkey() ) { # $mode eq 'edit'||'clone'
388 % @existing = $object->$table();
389 % warn scalar(@existing). " from $object->$table: ". join('/', @existing)
391 % } elsif ( $f->{'m2_new_default'} ) { # && $mode eq 'new'
392 % @existing = @{ $f->{'m2_new_default'} };
394 % foreach my $name_obj ( @existing ) {
396 % my $ex_label = '<INPUT TYPE="button" VALUE="X" TITLE="Remove this '.
397 % lc($f->{'m2_label'}).
398 % qq(" onClick="remove_$field($fieldnum);").
399 % ' STYLE="color:#ff0000;font-weight:bold;'.
400 % 'padding-left:2px;padding-right:2px"'.
401 % '> '. ($f->{'m2_label'} || $field ). ' ';
403 % if ( $f->{'layer_values_callback'} ) {
404 % my %switches = ( 'mode' => $mode );
406 % &{ $f->{'layer_values_callback'} }( $cgi, $name_obj, \%switches );
408 % warn "layer values: ". Dumper($layer_values)
411 % my @existing = &{ $include_sub }(
412 % 'label' => $ex_label,
413 % 'fieldnum' => $fieldnum,
414 % 'curr_value' => $name_obj->$col(),
415 % 'onchange' => $onchange,
416 % 'layer_values' => $layer_values,
417 % 'cell_style' => ( $fieldnum ? 'border-top:1px solid black' : '' ),
419 % $existing[0] =~ s(^/elements/tr-)(/elements/);
420 % my @label = @existing;
421 % $label[0] = '/elements/tr-td-label.html';
423 <% include( @label ) %>
424 <TD COLSPAN="<% $f->{'colspan'} || 1 %>">
425 <% include( @existing ) %>
428 % if ( $f->{'m2_fields'} ) {
429 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
430 % my $column = $c->{field};
431 % my @column = &{ $column_sub }( %$c,
432 % 'fieldnum' => $fieldnum,
433 % 'curr_value' => $name_obj->$column()
436 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
437 style='text-align:right;vertical-align:top;
438 border-top:1px solid black;padding-top:5px;'>
439 <% $c->{'label'} || '' %>
441 <TD style='border-top:1px solid black;padding-top:3px;'>
442 <% include( @column ) %>
452 % #$field .= $fieldnum;
453 % $onchange .= "\nspawn_$field(what);";
455 % if ( $f->{curr_value_callback} ) {
456 % $curr_value = &{ $f->{curr_value_callback} }( $cgi, $object, $field ),
458 % $curr_value = $object->$field();
460 % $curr_value = &{ $opt{'value_callback'} }( $f->{'field'}, $curr_value )
461 % if $opt{'value_callback'} && $mode ne 'error';
464 % my @include = &{ $include_sub }(
466 % 'fieldnum' => $fieldnum,
467 % 'curr_value' => $curr_value,
468 % 'object' => $object,
470 % 'onchange' => $onchange,
471 % ( $fieldnum ? ('cell_style' => 'border-top:1px solid black') : () ),
474 % if ( $f->{'m2name_table'} || $f->{'o2m_table'} || $f->{'m2m_method'} ) {
475 % $include[0] =~ s(^/elements/tr-)(/elements/);
476 % my @label = @include;
477 % $label[0] = '/elements/tr-td-label.html';
479 <% include( @label ) %>
480 <TD COLSPAN="<% $f->{'colspan'} || 1 %>">
481 <% include( @include ) %>
484 % if ( $f->{'m2_fields'} ) {
485 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
486 % my $column = $c->{field};
487 % my @column = &{ $column_sub }( %$c, 'fieldnum' => $fieldnum );
489 <TD id='<% $field %>__<% $column %>_label<% $fieldnum %>'
490 style='text-align:right;vertical-align:top;
491 border-top:1px solid black;padding-top:5px;'>
492 <% $c->{'label'} || '' %>
494 <TD style='border-top:1px solid black;padding-top:3px;'>
495 <% include( @column ) %>
504 <% include( @include ) %>
507 % if ( $f->{'m2name_table'} || $f->{'o2m_table'} || $f->{'m2m_method'} ) {
509 <SCRIPT TYPE="text/javascript">
511 var <%$field%>_rownum = <% $g_row %>;
512 var <%$field%>_fieldnum = <% $fieldnum %>;
514 function spawn_<%$field%>(what) {
516 // only spawn if we're the last element... return if not
518 var field_regex = /(\d+)(_[a-z]+)?$/;
519 var match = field_regex.exec(what.name);
521 alert(what.name + " didn't match?!");
524 if ( match[1] != <%$field%>_fieldnum ) {
528 // change the label on the last entry & add a remove button
529 var prev_label = document.getElementById('<% $field %>_label' + <%$field%>_fieldnum );
530 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 %>';
532 <%$field%>_fieldnum++;
536 % $include[0] =~ s(^/elements/tr-)(/elements/);
537 % my @layer_opt = ( @include,
538 % 'field' => $field."MAGIC_NUMBER",
539 % 'id' => $field."MAGIC_NUMBER",
540 % 'layer_prefix' => $field."MAGIC_NUMBER.",
542 % warn @layer_opt if $opt{'debug'};
544 var newrow = <% include(@layer_opt, html_only=>1) |js_string %>;
546 % if ( $type eq 'selectlayers' ) { #until the rest have html/js_only
547 var newfunc = <% include(@layer_opt, js_only =>1) |js_string %>;
552 // substitute in the new field name
553 var magic_regex = /MAGIC_NUMBER/g;
554 newrow = newrow.replace( magic_regex, <%$field%>_fieldnum );
555 newfunc = newfunc.replace( magic_regex, <%$field%>_fieldnum );
558 if (window.ActiveXObject) {
559 window.execScript(newfunc);
560 } else { /* (window.XMLHttpRequest) */
561 //window.eval(newfunc);
562 setTimeout(newfunc, 0);
567 //hmm, can't use selectlayers after a tablebreak-title for now
568 var table = document.getElementById('TableNumber<% $tablenum-1 %>');
570 var row = table.insertRow(<%$field%>_rownum++);
572 var label_cell = document.createElement('TD');
574 label_cell.id = '<% $field %>_label' + <%$field%>_fieldnum;
576 label_cell.style.textAlign = "right";
577 label_cell.style.verticalAlign = "top";
578 label_cell.style.borderTop = "1px solid black";
579 label_cell.style.paddingTop = "5px";
581 label_cell.innerHTML = '<% $label %>';
583 row.appendChild(label_cell);
585 var widget_cell = document.createElement('TD');
587 widget_cell.style.borderTop = "1px solid black";
588 widget_cell.style.paddingTop = "3px";
589 widget_cell.colSpan = "<% $f->{'colspan'} || 1 %>"
591 widget_cell.innerHTML = newrow;
593 row.appendChild(widget_cell);
595 % if ( $f->{'m2_fields'} ) {
596 % foreach my $c ( @{ $f->{'m2_fields'} } ) {
597 % my $column = $c->{field};
598 % my @column = &{ $column_sub }(%$c, 'fieldnum' => 'MAGIC_NUMBER');
600 var column = <% include(@column, html_only=>1) |js_string %>;
601 column = column.replace( magic_regex, <%$field%>_fieldnum );
603 var column_label = document.createElement('TD');
605 '<% $field %>__<% $column %>_label' + <%$field%>_fieldnum;
607 column_label.style.textAlign = "right";
608 column_label.style.verticalAlign = "top";
609 column_label.style.borderTop = "1px solid black";
610 column_label.style.paddingTop = "5px";
612 column_label.innerHTML = '<% $c->{'label'} || '' %>';
614 row.appendChild(column_label);
616 var column_widget = document.createElement('TD');
618 column_widget.style.borderTop = "1px solid black";
619 column_widget.style.paddingTop = "3px";
621 column_widget.innerHTML = column;
623 row.appendChild(column_widget);
628 % if ( $f->{'m2_new_js'} ) {
629 // take out items selected in previous dropdowns
630 var new_element = document.getElementById("<%$field%>" + <%$field%>_fieldnum );
631 <% $f->{'m2_new_js'} %>(new_element);
633 if ( new_element.length < 2 ) {
634 //just the ** Select new **, so don't display the row
635 row.style.display = 'none';
641 function remove_<%$field%>(remove_fieldnum) {
642 //alert("remove <%$field%> " + remove_fieldnum);
643 var select = document.getElementById('<%$field%>' + remove_fieldnum);
646 alert("can't find element <%$field%>" + remove_fieldnum);
650 % my $warnings = $f->{'m2_remove_warnings'};
652 var sel_value = select.options[select.selectedIndex].value;
653 % foreach my $value ( keys %$warnings ) {
654 if ( sel_value == '<% $value %>' ) {
655 if ( ! confirm( <% $warnings->{$value} |js_string %> ) ) {
662 select.disabled = 'disabled'; // this seems to prevent it from being submitted on tested browsers so far (IE, moz, konq at least)
663 var label_td = document.getElementById('<%$field%>_label' + remove_fieldnum );
664 label_td.parentNode.style.display = 'none';
666 % if ( $f->{m2_remove_js} ) {
667 var opt = select.options[select.selectedIndex];
668 <% $f->{m2_remove_js} %>( opt.value, opt.text, 'no_match');
679 <% ref( $opt{'html_table_bottom'} )
680 ? &{ $opt{'html_table_bottom'} }( $object )
681 : $opt{'html_table_bottom'}
686 <% ref( $opt{'html_bottom'} )
687 ? &{ $opt{'html_bottom'} }( $object )
688 : $opt{'html_bottom'}
693 <INPUT TYPE="submit" ID="submit" VALUE="<% ( !$clone && $object->$pkey() ) ? "Apply changes" : "Add ". ( $opt{'name'} || $opt{'name_singular'} ) %>">
697 <% ref( $opt{'html_foot'} )
698 ? &{ $opt{'html_foot'} }( $object )
702 <% include("/elements/footer.html") %>
707 my $curuser = $FS::CurrentUser::CurrentUser;
709 #false laziness w/process.html
710 my $table = $opt{'table'};
711 my $class = "FS::$table";
712 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
713 my $fields = $opt{'fields'}
714 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
715 || [ grep { $_ ne $pkey } fields($table) ];
716 #my @actualfields = map { ref($_) ? $_->{'field'} : $_ } @$fields;
718 if ( $cgi->param('redirect') ) {
719 my $session = $cgi->param('redirect');
720 my $pref = $curuser->option("redirect$session");
721 die "unknown redirect session $session\n" unless length($pref);
722 $cgi = new CGI($pref);
725 &{$opt{'begin_callback'}}( $cgi, $fields, \%opt )
726 if $opt{'begin_callback'};
730 'extra_sql' => ( $opt{'agent_virt'}
731 ? ' AND '. $curuser->agentnums_sql(
732 'null_right' => $opt{'agent_null_right'}
741 if ( $cgi->param('error') ) {
745 $object = $class->new( {
746 map { $_ => scalar($cgi->param($_)) } fields($table)
749 &{$opt{'error_callback'}}( $cgi, $object, $fields, \%opt )
750 if $opt{'error_callback'};
752 } elsif ( $cgi->param('clone') =~ /^(\d+)$/ ) {
758 $qsearch{'extra_sql'} = ' AND '. $opt{'agent_clone_extra_sql'}
759 if $opt{'agent_clone_extra_sql'};
761 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $clone } })
762 or die "$pkey $clone not found in $table";
764 &{$opt{'clone_callback'}}( $cgi, $object, $fields, \%opt )
765 if $opt{'clone_callback'};
769 $opt{action} ||= 'Add';
771 } elsif ( $cgi->keywords || $cgi->param($pkey) ) { #editing
776 if ( $cgi->param($pkey) ) {
777 $value = $cgi->param($pkey)
779 my( $query ) = $cgi->keywords;
782 $value =~ /^(\d+)$/ or die "unparsable $pkey";
783 $object = qsearchs({ %qsearch, 'hashref' => { $pkey => $1 } })
784 or die "$pkey $1 not found in $table";
786 warn "$table $pkey => $1"
789 &{$opt{'edit_callback'}}( $cgi, $object, $fields, \%opt )
790 if $opt{'edit_callback'};
796 my $hashref = $opt{'new_hashref_callback'}
797 ? &{$opt{'new_hashref_callback'}}
800 $object = $opt{'new_object_callback'}
801 ? &{$opt{'new_object_callback'}}( $cgi, $hashref, $fields, \%opt )
802 : $class->new( $hashref );
804 &{$opt{'new_callback'}}( $cgi, $object, $fields, \%opt )
805 if $opt{'new_callback'};
809 &{$opt{'end_callback'}}( $cgi, $object, $fields, \%opt )
810 if $opt{'end_callback'};
812 $opt{action} ||= $object->$pkey() ? 'Edit' : 'Add';
814 my $title = $opt{action}. ' '. ( $opt{name} || $opt{'name_singular'} );
816 my $viewall_url = $p . ( $opt{'viewall_dir'} || 'search' ) . "/$table.html";
817 $viewall_url = $opt{'viewall_url'} if $opt{'viewall_url'};
820 if ( $opt{'menubar'} ) {
821 @menubar = @{ $opt{'menubar'} };
823 my $items = $opt{'name'} ? $opt{'name'}.'s' : PL($opt{'name_singular'});
825 "View all $items" => $viewall_url,