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