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