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