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