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