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