httemplate/edit/elements/edit.html

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