new package editor
[freeside.git] / httemplate / edit / elements / edit.html
1 <%doc>
2
3 Example:
4
5   include( 'elements/edit.html',  
6     'name'  =>
7     'table' =>
8     #? 'primary_key' => #required when the dbdef doesn't know...???
9     'labels' => {
10                   'column' => 'Label',
11                 }
12    
13     #listref - each item is a literal column name (or method) or hashref
14     #                                                        or (notyet) coderef
15     #if not specified all columns (except for the primary key) will be editable
16     'fields' => [
17                   'columname',
18                   { 'field' => 'another_columname',
19                     'type'  => 'text', #text
20                                        #password
21                                        #money
22                                        #percentage
23                                        #checkbox
24                                        #select
25                                        #selectlayers (can now use after a tablebreak-tr-title... but not inside columnstart/columnnext/columnend)
26                                        #title
27                                        #tablebreak-tr-title
28                                        #columnstart
29                                        #columnnext
30                                        #columnend
31                                        #hidden - hidden value from object
32                                        #fixed - display fixed value from object or here
33                                        #fixed-country
34                                        #fixed-state
35                     'value' => 'Y', #for checkbox, title, fixed, fixedhidden
36                     'disabled' => 0,
37                     'onchange' => 'javascript_function',
38
39                     #m2 stuff only tested w/selectlayers so far
40                     #might work w/select too, dunno others
41                     'm2name_table'   => 'table_name',
42                     'm2name_namecol' => 'name_column',
43                     #OR#
44                     'm2m_table'        =>
45                     'm2m_target_table' =>
46                     'm2m_srccol'  => #opt, if not the same as this table
47                     'm2m_dstcol'  => #opt, if not the same as target table
48
49                     'm2_label'   => 'Label',        #
50                     'm2_new_default' => \@table_name_objects, #default
51                                                               #m2 objects for
52                                                               #new records
53                     'm2_error_callback' => sub { my($cgi, $object) = @_; },
54                     'm2_remove_warnings' => \%warnings, #hashref of warning
55                                                         #messages for m2
56                                                         #removal
57                     'm2_new_js' => 'function_name', #javascript function called
58                                                     #on spawned rows (one arg:
59                                                     #new_element)
60                     'm2_remove_js' => 'function_name', #js function called when
61                                                        #a row is deleted (three
62                                                        #args: value, text,
63                                                        #'no_match')
64                     #layer_fields & layer_values_callback only for selectlayer
65                     'layer_fields' => [
66                                         'fieldname'     => 'Label',
67                                         'another_field' => {
68                                           label=>'Label',
69                                           type =>'text', #text, money
70                                         },
71                                       ],
72                     'layer_values_callback' =>
73                       sub {
74                             my( $cgi, $object ) = @_;
75                             { 'layer'  => { 'fieldname'  => 'current_value',
76                                             'fieldname2' => 'field2value',
77                                             ...
78                                           },
79                               'layer2' => { 'l2fieldname' => 'l2value',
80                                             ...
81                                           },
82                               ...
83                             };
84                           },
85                   },
86                 ]
87    
88     'menubar'     => '', #menubar arrayref
89
90     #agent virtualization
91     'agent_virt'       => 1,
92     'agent_null_right' => 'Access Right Name',
93    
94     #run when re-displaying with an error
95     'error_callback' => sub { my( $cgi, $object, $fields_listref ) = @_; },
96    
97     #run when editing
98     'edit_callback' => sub { my( $cgi, $object, $fields_listref ) = @_; },
99    
100     # returns a hashref for the new object
101     'new_hashref_callback'
102
103     # returns the new object iself (otherwise, ->new is called)
104     'new_object_callback'
105    
106     #run when adding
107     'new_callback' => sub { my( $cgi, $object, $fields_listref ) = @_; },
108    
109     #run before display to return a different value
110     'value_callback' => sub { my( $columname, $value } ) = @_; },
111
112     #XXX describe
113     'field_callback' => sub { },
114
115     'viewall_dir' => '', #'search' or 'browse', defaults to 'search'
116
117     'html_init'   => '', #after the header/menubar
118
119     #string or coderef of additional HTML to add before </TABLE>
120     'html_table_bottom' => '',
121
122     #after </TABLE> but before the submit
123     'html_bottom' => '', #string
124     'html_bottom' => sub {
125                            my $object = shift;
126                            # ...
127                            "html_string";
128                          },
129     
130     #at the very bottom (well, as low as you can go from here)
131     'html_foot'  => '',
132
133     # overrides default popurl(1)."process/$table.html"
134     'post_url' => popurl(1).'process/something', 
135
136     #we're in a popup (no title/menu/searchboxes)
137     'popup' => 1,
138    
139   );
140
141 </%doc>
142
143 <% include('/elements/header'. ( $opt{popup} ? '-popup' : '' ). '.html',
144               $title,
145               include( '/elements/menubar.html', @menubar )
146            )
147 %>
148
149 <% defined($opt{'html_init'}) 
150       ? ( ref($opt{'html_init'})
151             ? &{$opt{'html_init'}}()
152             : $opt{'html_init'}
153         )
154       : ''
155 %>
156
157 <% include('/elements/error.html') %>
158
159 % my $url = $opt{'post_url'} || popurl(1)."process/$table.html";
160
161 <FORM ACTION="<% $url %>" METHOD=POST NAME="edit_topform">
162
163 <INPUT TYPE="hidden" NAME="svcdb" VALUE="<% $table %>">
164 <INPUT TYPE="hidden" NAME="<% $pkey %>" VALUE="<% $object->$pkey() %>">
165
166 <FONT SIZE="+1"><B>
167 <% ( $opt{labels} && exists $opt{labels}->{$pkey} )
168       ? $opt{labels}->{$pkey}
169       : $pkey
170 %>
171 </B></FONT>
172 #<% $object->$pkey() || "(NEW)" %>
173
174 % my $tablenum = 0;
175 <TABLE ID="TableNumber<% $tablenum++ %>" BGCOLOR="#cccccc" BORDER=0 CELLSPACING=0>
176
177 % my $g_row = 0;
178 % my @g_row_stack = ();
179 % foreach my $f ( map { ref($_) ? $_ : {'field'=>$_} }
180 %                       @$fields
181 %                 ) {
182 %
183 %   &{ $opt{'field_callback'} }( $f )
184 %     if $opt{'field_callback'};
185 %
186 %   my $field = $f->{'field'};
187 %   my $type = $f->{'type'} ||= 'text';
188 %
189 %   my $label = ( $opt{labels} && exists $opt{labels}->{$field} )
190 %                   ? $opt{labels}->{$field}
191 %                   : $field;
192 %
193 %   my $onchange = $f->{'onchange'};
194 %
195 %   my $layer_values = {};
196 %   $layer_values = &{ $f->{'layer_values_callback'} }( $cgi, $object )
197 %     if $f->{'layer_values_callback'}
198 %     && ! $f->{'m2name_table'}
199 %     && ! $f->{'m2m_table'};
200 %
201 %   warn "layer values: ". Dumper($layer_values)
202 %     if $opt{'debug'};
203 %
204 %   my %include_common = (
205 %
206 %     #text and derivitives
207 %     'size'          => $f->{'size'},
208 %
209 %     #checkbox, title, fixed, fixedhidden
210 %     #& deprecated weird value hashref used only by reason.html
211 %     'value'         => $f->{'value'},
212 %
213 %     #select(-*)
214 %     'options'       => $f->{'options'},
215 %     'labels'        => $f->{'labels'},
216 %     'multiple'      => $f->{'multiple'},
217 %     'disable_empty' => $f->{'disable_empty'},
218 %     #select-reason
219 %     'reason_class'  => $f->{'reason_class'},
220 %
221 %     #selectlayers
222 %     'layer_fields'  => $f->{'layer_fields'},
223 %     'layer_values'  => $layer_values,
224 %     'html_between'  => $f->{'html_between'},
225 %
226 %     #umm.
227 %     'disabled'      => $f->{'disabled'},
228 %   );
229 %
230 %   #select-table
231 %   $include_common{$_} = $f->{$_}
232 %     foreach grep exists($f->{$_}), qw( table name_col );
233 %
234 %   if ( $type eq 'tablebreak-tr-title' ) {
235 %     $include_common{'table_id'} = 'TableNumber'. $tablenum++
236 %   }
237 %
238 %   my $layer_prefix_on = '';
239 %
240 %   my $include_sub = sub {
241 %     my %opt = @_;
242 %
243 %     my $fieldnum   = delete $opt{'fieldnum'};
244 %
245 %     my $include = $type;
246 %     $include = "input-$include" if $include =~ /^(text|money|percentage)$/;
247 %     $include = "tr-$include" unless $include =~ /^(hidden|tablebreak|column)/;
248 %
249 %     $include_common{'layer_prefix'} = "$field$fieldnum."
250 %       if $layer_prefix_on;
251 %
252 %     my @include = 
253 %     ( "/elements/$include.html",
254 %         'field'      => "$field$fieldnum",
255 %         'id'         => "$field$fieldnum", #separate?
256 %         'label_id'   => $field."_label$fieldnum", #don't want field0_label0...
257 %         %include_common,
258 %         %opt,
259 %     );
260 %     @include;
261 %   };
262 %
263 %   unless ( $type =~ /^column/ ) {
264 %     $g_row = 1 if $type eq 'tablebreak-tr-title';
265 %     $g_row++;
266 %     $g_row++ if $type eq 'title';
267 %   } else {
268 %     if ( $type eq 'columnstart' ) {
269 %       push @g_row_stack, $g_row++;
270 %       $g_row = 0;
271 %     #} elsif ( $type eq 'columnnext' ) {
272 %     } elsif ( $type eq 'columnend' ) {
273 %       $g_row = pop @g_row_stack; 
274 %     }
275 %  
276 %   }
277 %
278 %   my $fieldnum = '';
279 %   my $curr_value = '';
280 %   if ( $f->{'m2name_table'} || $f->{'m2m_table'} ) { #XXX test this for all
281 %                                                      #types of fields
282 %     my($table, $col);
283 %     if ( $f->{'m2name_table'} ) {
284 %       $table = $f->{'m2name_table'};
285 %       $col   = $f->{'m2name_namecol'};
286 %     } elsif ( $f->{'m2m_table'} ) {
287 %       $table = $f->{'m2m_table'}; #XXX method name
288 %       $col   = $f->{'m2m_dstcol'}; #XXX or get it from schema, defualt to
289 %                                    #same name as primary key of
290 %                                    #m2m_target_table
291 %     }
292 %     $fieldnum = 0;
293 %     $layer_prefix_on = 1;
294 %     #print out the fields for the existing m2s
295 %     my @existing = ();
296 %     if ( $mode eq 'error' ) {
297 %       @existing = &{ $f->{'m2_error_callback'} }( $cgi, $object );
298 %     } elsif ( $object->$pkey() ) { # $mode eq 'edit'
299 %       @existing = $object->$table();
300 %      warn scalar(@existing). " from $object->$table: ". join('/', @existing)
301 %        if $opt{'debug'};
302 %     } elsif ( $f->{'m2_new_default'} ) { # && $mode eq 'new'
303 %       @existing = @{ $f->{'m2_new_default'} };
304 %     }
305 %     foreach my $name_obj ( @existing ) {
306 %
307 %       my $ex_label = '<INPUT TYPE="button" VALUE="X" TITLE="Remove this '.
308 %                      lc($f->{'m2_label'}).
309 %                      qq(" onClick="remove_$field($fieldnum);").
310 %                      ' STYLE="color:#ff0000;font-weight:bold;'.
311 %                              'padding-left:2px;padding-right:2px"'.
312 %                      '>&nbsp;'. ($f->{'m2_label'} || $field ). ' ';
313 %       
314 %       if ( $f->{'layer_values_callback'} ) {
315 %         my %switches = ( 'mode' => $mode );
316 %         $layer_values =
317 %           &{ $f->{'layer_values_callback'} }( $cgi, $name_obj, \%switches );
318 %       }
319 %       warn "layer values: ". Dumper($layer_values)
320 %         if $opt{'debug'};
321 %
322 %       my @existing = &{ $include_sub }(
323 %         'label'        => $ex_label,
324 %         'fieldnum'     => $fieldnum,
325 %         'curr_value'   => $name_obj->$col(),
326 %         'onchange'     => $onchange,
327 %         'layer_values' => $layer_values,
328 %         'cell_style'   => ( $fieldnum ? 'border-top:1px solid black' : '' ),
329 %       );
330
331         <% include( @existing ) %>
332
333 %       $fieldnum++;
334 %       $g_row++;
335 %     }
336 %     #$field .= $fieldnum;
337 %     $onchange .= "\nspawn_$field(what);";
338 %   } else {
339 %     if ( $f->{curr_value_callback} ) {
340 %       $curr_value = &{ $f->{curr_value_callback} }( $cgi, $object, $field ),
341 %     } else {
342 %       $curr_value = $object->$field();
343 %     }
344 %     $curr_value = &{ $opt{'value_callback'} }( $f->{'field'}, $curr_value )
345 %       if $opt{'value_callback'} && $mode ne 'error';
346 %   }
347 %
348 %   my @include = &{ $include_sub }(
349 %     'label'      => $label,
350 %     'fieldnum'   => $fieldnum,
351 %     'curr_value' => $curr_value,
352 %     'object'     => $object,
353 %     'cgi'        => $cgi,
354 %     'onchange'   => $onchange,
355 %     'cell_style'   => ( $fieldnum ? 'border-top:1px solid black' : '' ),
356 %   );
357
358     <% include( @include ) %>
359
360 %   if ( $f->{'m2name_table'} || $f->{'m2m_table'} ) {
361
362       <SCRIPT TYPE="text/javascript">
363
364         var <%$field%>_rownum = <% $g_row %>;
365         var <%$field%>_fieldnum = <% $fieldnum %>;
366
367         function spawn_<%$field%>(what) {
368
369           // only spawn if we're the last element... return if not
370
371           var field_regex = /(\d+)$/;
372           var match = field_regex.exec(what.name);
373           if ( !match ) {
374             alert(what.name + " didn't match?!");
375             return;
376           }
377           if ( match[1] != <%$field%>_fieldnum ) {
378             return;
379           }
380
381           // change the label on the last entry & add a remove button
382           var prev_label = document.getElementById('<% $field %>_label' + <%$field%>_fieldnum );
383           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" >&nbsp;<% $f->{'m2_label'} || $field %>';
384
385           <%$field%>_fieldnum++;
386
387           //get the new widget
388
389 %         $include[0] =~ s(^/elements/tr-)(/elements/);
390 %         my @layer_opt = ( @include,
391 %                           'field'        => $field."MAGIC_NUMBER",
392 %                           'id'           => $field."MAGIC_NUMBER",
393 %                           'layer_prefix' => $field."MAGIC_NUMBER.",
394 %                         );
395 %         warn @layer_opt if $opt{'debug'};
396
397           var newrow =  <% include(@layer_opt, html_only=>1) |js_string %>;
398
399 %         if ( $type eq 'selectlayers' ) { #until the rest have html/js_only
400             var newfunc = <% include(@layer_opt, js_only  =>1) |js_string %>;
401 %         } else {
402             var newfunc = '';
403 %         }
404
405           // substitute in the new field name
406           var magic_regex = /MAGIC_NUMBER/g;
407           newrow  = newrow.replace(  magic_regex, <%$field%>_fieldnum );
408           newfunc = newfunc.replace( magic_regex, <%$field%>_fieldnum );
409
410           // evaluate new_func
411           if (window.ActiveXObject) {
412             window.execScript(newfunc);
413           } else { /* (window.XMLHttpRequest) */
414             //window.eval(newfunc);
415             setTimeout(newfunc, 0);
416           }
417
418           // add new row
419
420           //hmm, can't use selectlayers after a tablebreak-title for now
421           var table = document.getElementById('TableNumber<% $tablenum-1 %>');
422
423           var row = table.insertRow(<%$field%>_rownum++);
424
425           var label_cell = document.createElement('TD');
426
427           label_cell.id = '<% $field %>_label' + <%$field%>_fieldnum;
428
429           label_cell.style.textAlign = "right";
430           label_cell.style.verticalAlign = "top";
431           label_cell.style.borderTop = "1px solid black";
432           label_cell.style.paddingTop = "5px";
433
434           label_cell.innerHTML = '<% $label %>';
435
436           row.appendChild(label_cell);
437           
438           var widget_cell = document.createElement('TD');
439
440           widget_cell.style.borderTop = "1px solid black";
441           widget_cell.style.paddingTop = "3px";
442
443           widget_cell.innerHTML = newrow;
444
445           row.appendChild(widget_cell);
446
447 %         if ( $f->{'m2_new_js'} ) {
448             // take out items selected in previous dropdowns
449             var new_element = document.getElementById("<%$field%>" + <%$field%>_fieldnum );
450             <% $f->{'m2_new_js'} %>(new_element);
451
452             if ( new_element.length < 2 ) {
453               //just the ** Select new **, so don't display the row
454               row.style.display = 'none';
455             }
456 %         }
457
458         }
459
460         function remove_<%$field%>(remove_fieldnum) {
461           //alert("remove <%$field%> " + remove_fieldnum);
462           var select = document.getElementById('<%$field%>' + remove_fieldnum);
463
464           if ( ! select ) {
465             alert("can't find element <%$field%>" + remove_fieldnum);
466             return;
467           }
468
469 %         my $warnings = $f->{'m2_remove_warnings'};
470 %         if ( $warnings ) {
471             var sel_value = select.options[select.selectedIndex].value;
472 %           foreach my $value ( keys %$warnings ) {
473               if ( sel_value == '<% $value %>' ) {
474                 if ( ! confirm( <% $warnings->{$value} |js_string %> ) ) {
475                   return;
476                 }
477               }
478 %           }
479 %         }
480
481           select.disabled = 'disabled'; // this seems to prevent it from being submitted on tested browsers so far (IE, moz, konq at least)
482           var label_td = document.getElementById('<%$field%>_label' + remove_fieldnum );
483           label_td.parentNode.style.display = 'none';
484
485 %         if ( $f->{m2_remove_js} ) {
486             var opt = select.options[select.selectedIndex];
487             <% $f->{m2_remove_js} %>( opt.value, opt.text, 'no_match');
488 %         }
489
490         }
491
492       </SCRIPT>
493
494 %   }
495
496 % } 
497
498 <% ref( $opt{'html_table_bottom'} )
499       ? &{ $opt{'html_table_bottom'} }( $object )
500       : $opt{'html_table_bottom'}
501 %>
502
503 </TABLE>
504
505 <% ref( $opt{'html_bottom'} )
506       ? &{ $opt{'html_bottom'} }( $object )
507       : $opt{'html_bottom'}
508 %>
509
510 <BR>
511
512 <INPUT TYPE="submit" ID="submit" VALUE="<% $object->$pkey() ? "Apply changes" : "Add $opt{'name'}" %>">
513
514 </FORM>
515
516 <% ref( $opt{'html_foot'} )
517       ? &{ $opt{'html_foot'} }( $object )
518       : $opt{'html_foot'}
519 %>
520
521 <% include("/elements/footer.html") %>
522 <%init>
523
524 my(%opt) = @_;
525
526 my $curuser = $FS::CurrentUser::CurrentUser;
527
528 #false laziness w/process.html
529 my $table = $opt{'table'};
530 my $class = "FS::$table";
531 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} || 
532 my $fields = $opt{'fields'}
533              #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
534              || [ grep { $_ ne $pkey } fields($table) ];
535 #my @actualfields = map { ref($_) ? $_->{'field'} : $_ } @$fields;
536
537 if ( $cgi->param('redirect') ) {
538   my $session = $cgi->param('redirect');
539   my $pref = $curuser->option("redirect$session");
540   die "unknown redirect session $session\n" unless length($pref);
541   $cgi = new CGI($pref);
542 }
543
544 my $object;
545 my $mode;
546 if ( $cgi->param('error') ) {
547
548   $mode = 'error';
549
550   $object = $class->new( {
551     map { $_ => scalar($cgi->param($_)) } fields($table)
552   });
553
554   &{$opt{'error_callback'}}($cgi, $object, $fields)
555     if $opt{'error_callback'};
556
557 } elsif ( $cgi->keywords || $cgi->param($pkey) ) { #editing
558
559   $mode = 'edit';
560
561   my $value;
562   if ( $cgi->param($pkey) ) {
563     $value = $cgi->param($pkey)
564   } else { 
565     my( $query ) = $cgi->keywords;
566     $value = $query;
567   }
568   $value =~ /^(\d+)$/ or die "unparsable $pkey";
569   $object = qsearchs({
570     'table'     => $table,
571     'hashref'   => { $pkey => $1 },
572     'extra_sql' => ( $opt{'agent_virt'}
573                        ? ' AND '. $curuser->agentnums_sql(
574                                     'null_right' => $opt{'agent_null_right'}
575                                   )
576                        : ''
577                    ),
578   });
579   warn "$table $pkey => $1"
580     if $opt{'debug'};
581
582   &{$opt{'edit_callback'}}($cgi, $object, $fields)
583     if $opt{'edit_callback'};
584
585 } else { #adding
586
587   $mode = 'new';
588
589   my $hashref = $opt{'new_hashref_callback'}
590                   ? &{$opt{'new_hashref_callback'}}
591                   : {};
592
593   $object = $opt{'new_object_callback'}
594               ? &{$opt{'new_object_callback'}}( $cgi, $hashref, $fields, \%opt )
595               : $class->new( $hashref );
596
597   &{$opt{'new_callback'}}($cgi, $object, $fields)
598     if $opt{'new_callback'};
599
600 }
601
602 $opt{action} ||= $object->$pkey() ? 'Edit' : 'Add';
603
604 my $title = $opt{action}. ' '. $opt{name};
605
606 my $viewall_url = $p . ( $opt{'viewall_dir'} || 'search' ) . "/$table.html";
607 $viewall_url = $opt{'viewall_url'} if $opt{'viewall_url'};  
608
609 my @menubar = ();
610 if ( $opt{'menubar'} ) {
611   @menubar = @{ $opt{'menubar'} };
612 } else {
613   @menubar = (
614     #eventually use Lingua::bs to pluralize
615     "View all $opt{'name'}s" => $viewall_url,
616   );
617 }
618
619 </%init>