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