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