httemplate/edit/process/elements/process.html

   1 <%doc>
   2
   3 Example:
   4
   5  <& elements/process.html,
   6
   7    ###
   8    # required
   9    ###
  10
  11   'table' => 'tablename',
  12
  13    #? 'primary_key' => #required when the dbdef doesn't know...???
  14    #? 'fields' => []   #""
  15
  16    ###
  17    # optional
  18    ###
  19
  20    'viewall_dir'  => '', #'search' or 'browse', defaults to 'search'
  21    'viewall_ext'  => 'html', #'cgi' or 'html', defaults to 'html'
  22    OR
  23    'redirect'     => 'view/table.cgi?', # value of primary key is appended
  24                                         # (string or coderef returning a string)
  25    OR
  26    'popup_reload' => 'Momentary success message', #will reload parent window
  27
  28    'error_redirect' => popurl(2).'edit/table.cgi?', #query string appended
  29
  30    'edit_ext' => 'html', #defaults to 'html', you might want 'cgi' while the
  31                          #naming is still inconsistent
  32
  33    'copy_on_empty'  => [ 'old_field_name', 'another_old_field', ... ],
  34
  35    'clear_on_error' => [ 'form_field1', 'form_field2', ... ],
  36
  37                   #pass an arrayref of hashrefs for multiple m2ms or m2names
  38                   #be certain you incorporate m2m_Common if you see error: param
  39
  40    'process_m2m' => { 'link_table'   => 'link_table_name',
  41                       'target_table' => 'target_table_name',
  42                       #optional (see m2m_Common::process_m2m), if not specified
  43                       # all CGI params will be passed)
  44                       'params'       =>
  45                     },
  46    'process_m2name' => { 'link_table'   => 'link_table_name',
  47                          'link_static' => { 'column' => 'value' },
  48                          'num_col' => 'column', #if column name is different in
  49                                                 #link_table than source_table
  50                          'name_col' => 'name_column',
  51                          'names_list' => [ 'list', 'names' ],
  52
  53                          'param_style' => 'link_table.value checkboxes',
  54                          #or#
  55                          'param_style' => 'name_colN values',
  56
  57
  58                        },
  59    'process_o2m' => { 'table' => table_name',
  60                       'num_col' => 'column', #if column name is different in
  61                                              #link_table than source_table
  62                       'fields' => [qw( fieldname fieldname2 )],
  63                     },
  64
  65    'process_locale' => 'fieldname', # update entries in the _msgcat table
  66
  67    'process_upload' => {
  68                          'process'  => 'misc/mytable-import.html',
  69                           # fields to pass to the back end job, besides the
  70                           # primary key of the object
  71                          'fields'   => [qw( fieldname fieldname2 )],
  72                        },
  73
  74    'skip_process' => 0, #boolean, if set true, will skip the main table
  75                         #add/edit processing and only run any linked table
  76                         #process_ items
  77
  78    #checks CGI params and whatever else before much else runs
  79    #return an error string or empty for no error
  80    'precheck_callback' => sub { my( $cgi ) = @_; },
  81
  82    #after the new object is created
  83    'post_new_object_callback' => sub { my( $cgi, $object ) = @_; },
  84
  85    #after everything's inserted
  86    'noerror_callback' => sub { my( $cgi, $object ) = @_; },
  87
  88    #supplies arguments to insert() and replace()
  89    # for use with tables that are FS::option_Common (among other things)
  90    'args_callback' => sub { my( $cgi, $object ) = @_; },
  91
  92    # if no errors after package insert or replace will update services attached to package.
  93    'update_svc' => sub { my( $cgi, $object ) = @_; },
  94
  95    'debug' => 1, #turns on debugging output
  96
  97    #agent virtualization
  98    'agent_virt'       => 1,
  99    'agent_null_right' => 'Access Right Name',
 100
 101    #special bulk insert mode
 102    'bulk' => 'field',
 103
 104  &>
 105
 106 </%doc>
 107 %if ( $error ) {
 108 %  ## flatten any array refs so multi selects are sticky on error
 109 %  for my $param ($cgi->param) {
 110 %    if (ref($cgi->param($param)) eq "ARRAY") {
 111 %      $cgi->param($param, (join ",", @{$cgi->param($param)}));
 112 %    }
 113 %  }
 114 %
 115 %  #my $query = $m->scomp('/elements/create_uri_query');
 116 %  #$cgi->redirect("$url?$query");
 117 %  if ( length($cgi->query_string) > 1920 ) { #stupid IE 2083 URL limit
 118 %
 119 %    my $session = int(rand(4294967296)); #XXX
 120 %    my $pref = new FS::access_user_pref({
 121 %      'usernum'    => $FS::CurrentUser::CurrentUser->usernum,
 122 %      'prefname'   => "redirect$session",
 123 %      'prefvalue'  => $cgi->query_string,
 124 %      'expiration' => time + 3600, #1h?  1m?
 125 %    });
 126 %    my $pref_error = $pref->insert;
 127 %    if ( $pref_error ) {
 128 %      die "FATAL: couldn't even set redirect cookie: $pref_error".
 129 %          " attempting to set redirect$session to ". $cgi->query_string."\n";
 130 %    }
 131 %
 132 <% $cgi->redirect("$error_redirect?redirect=$session") %>
 133 %
 134 %  } else {
 135 %
 136 <% $cgi->redirect("$error_redirect?". $cgi->query_string ) %>
 137 %
 138 %  }
 139 %
 140 % #different ways of handling success
 141 %
 142 %} elsif ( $opt{'process_upload'} and @uploaded_files ) {
 143 %
 144 % # construct a form to pass all the requested fields, the
 145 %
 146 <& /elements/header.html &>
 147 <form name="UploadForm">
 148 %   my $job_fields = $opt{'process_upload'}{'fields'};
 149 %   foreach my $field ( @$job_fields ) {
 150   <input type="hidden" name="<% $field %>" value="<% $cgi->param($field) |h %>">
 151 %   }
 152 %   push @$job_fields, 'uploaded_files', $pkey;
 153 %
 154   <input type="hidden" name="uploaded_files" value="<% join(',', @uploaded_files) %>">
 155   <input type="hidden" name="<% $pkey %>" value="<% $new->get($pkey) %>">
 156 <& /elements/progress-init.html,
 157   'UploadForm',
 158   $job_fields,
 159   $fsurl . $opt{'process_upload'}{'process'},
 160   {
 161     url => $redirect,
 162     error_url => "$error_redirect?$new_pkey"
 163   },
 164 &>
 165 <input type="submit" style="display:none">
 166 </form>
 167 <script>
 168 <&| /elements/onload.js &>
 169 process();
 170 </&>
 171 </script>
 172 <& /elements/footer.html &>
 173
 174 % } elsif ( $opt{'progress_init'} ) {
 175 %   # some false laziness with the above
 176 %   my ($form_name, $job_fields) = @{ $opt{'progress_init'} };
 177 <form name="<% $form_name %>">
 178   <input type="hidden" name="<% $pkey %>" value="<% $new->get($pkey) %>">
 179 %   foreach my $field (@$job_fields) {
 180 %     next if $field eq $pkey;
 181   <input type="hidden" name="<% $field %>" value="<% $cgi->param($field) |h %>">
 182 %   }
 183 <& /elements/progress-init.html,
 184   @{ $opt{'progress_init'} }
 185 &>
 186 <input type="submit" style="display:none">
 187 </form>
 188 <script>
 189 <&| /elements/onload.js &>
 190 process();
 191 </&>
 192 </script>
 193 <& /elements/footer.html &>
 194
 195 % } elsif ( $opt{'popup_reload'} ) {
 196
 197   <% include('/elements/header-popup.html', $opt{'popup_reload'} ) %>
 198
 199   <SCRIPT TYPE="text/javascript">
 200     window.top.location.reload();
 201   </SCRIPT>
 202
 203   </BODY>
 204   </HTML>
 205
 206 %} else {
 207 <% $cgi->redirect($redirect) %>
 208 %}
 209 <%init>
 210
 211 my $me = 'process.html:';
 212
 213 my(%opt) = @_;
 214
 215 my $curuser = $FS::CurrentUser::CurrentUser;
 216
 217 my $error = '';
 218 if ( $opt{'precheck_callback'} ) {
 219   $error = &{ $opt{'precheck_callback'} }( $cgi );
 220 }
 221
 222 #false laziness w/edit.html
 223 my $table = $opt{'table'};
 224 my $class = "FS::$table";
 225 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
 226 my $fields = $opt{'fields'}
 227              #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
 228              || [ fields($table) ];
 229
 230 my $old_pkey = $cgi->param($pkey);
 231
 232 my $old = '';
 233 if ( $old_pkey ) {
 234   $old = qsearchs({
 235     'table'   => $table,
 236     'hashref' => { $pkey => $old_pkey },
 237     'extra_sql' => ( $opt{'agent_virt'}
 238                        ? ' AND '. $curuser->agentnums_sql(
 239                                     'null_right' => $opt{'agent_null_right'}
 240                                   )
 241                        : ''
 242                    ),
 243   });
 244 }
 245
 246 my $bfield = $opt{'bulk'};
 247
 248 my %hash =
 249   map { my @entry = ( $_ => scalar($cgi->param($_)) );
 250         $opt{'value_callback'} ? ( $_ => &{ $opt{'value_callback'} }( @entry ))
 251                                : ( @entry )
 252       } grep { $_ ne $bfield } @$fields;
 253
 254 my @values = ( 1 );
 255 if ( $bfield ) {
 256   @values = $cgi->param($bfield);
 257   #warn join(',', @values);
 258 }
 259
 260 my @uploaded_files;
 261
 262 my $new;
 263 my $new_pkey = '';
 264 foreach my $value ( @values ) {
 265
 266   if ($opt{'skip_process'}) {
 267
 268     $new = $old;
 269     $new_pkey = $old_pkey;
 270
 271   } else {
 272
 273     $new = $class->new( \%hash );
 274
 275     $new->$bfield($value) if $bfield;
 276
 277     if ($old && exists($opt{'copy_on_empty'})) {
 278       foreach my $field (@{$opt{'copy_on_empty'}}) {
 279         $new->set($field, $old->get($field))
 280           unless scalar($cgi->param($field));
 281       }
 282     }
 283
 284     if ( $opt{'post_new_object_callback'} ) {
 285       &{ $opt{'post_new_object_callback'} }( $cgi, $new );
 286     }
 287
 288     if ( $opt{'agent_virt'} ) {
 289
 290       if ( ! $new->agentnum
 291            && (    ! $opt{'agent_null_right'}
 292                 || ! $curuser->access_right($opt{'agent_null_right'})
 293               )
 294          )
 295       {
 296
 297         $error ||= 'Select an agent';
 298
 299       } else {
 300
 301         die "illegal agentnum"
 302           unless $curuser->agentnums_href->{$new->agentnum}
 303               or $curuser->access_right('View customers of all agents')
 304               or $opt{'agent_null_right'}
 305                  && ! $new->agentnum
 306                  && $curuser->access_right($opt{'agent_null_right'});
 307
 308       }
 309
 310     }
 311
 312     my @args = ();
 313     if ( !$error && $opt{'args_callback'} ) {
 314       @args = &{ $opt{'args_callback'} }( $cgi, $new );
 315     }
 316
 317     if ( !$error && $opt{'debug'} ) {
 318       warn "$me updating record in $table table using $class class\n";
 319       warn Dumper(\%hash);
 320       warn "with args: \n". Dumper(\@args) if @args;
 321     }
 322
 323     if ( !$error ) {
 324       if ( $old_pkey ) {
 325
 326         &{ $opt{'edit_callback'} }( $new, $old ) if $opt{'edit_callback'};
 327
 328         $error = $new->replace($old, @args);
 329       } else {
 330         $error = $new->insert(@args);
 331       }
 332       $new_pkey = $new->getfield($pkey);
 333     }
 334
 335   } #unless $opt{'skip_process'}
 336
 337   if ( !$error && $opt{'process_m2m'} ) {
 338
 339     my @process_m2m = ref($opt{'process_m2m'}) eq 'ARRAY'
 340                         ? @{ $opt{'process_m2m'} }
 341                         :  ( $opt{'process_m2m'} );
 342
 343     foreach my $process_m2m (@process_m2m) {
 344
 345       $process_m2m->{'params'} ||= scalar($cgi->Vars);
 346
 347       warn "$me processing m2m:\n". Dumper( %$process_m2m )
 348         if $opt{'debug'};
 349
 350       $error ||= $new->process_m2m( %$process_m2m );
 351     }
 352
 353   }
 354
 355   if ( !$error && $opt{'process_m2name'} ) {
 356
 357     my @process_m2name = ref($opt{'process_m2name'}) eq 'ARRAY'
 358                            ? @{ $opt{'process_m2name'} }
 359                            :  ( $opt{'process_m2name'} );
 360
 361
 362     foreach my $process_m2name (@process_m2name) {
 363
 364       if ( $opt{'debug'} ) {
 365         warn "$me processing m2name:\n". Dumper( %{ $process_m2name },
 366                                                  'params' => scalar($cgi->Vars),
 367                                                );
 368       }
 369
 370       $error = $new->process_m2name( %{ $process_m2name },
 371                                      'params' => scalar($cgi->Vars),
 372                                    );
 373     }
 374
 375   }
 376
 377   my @process_o2m;
 378   if ( $opt{'process_o2m'} ) {
 379     @process_o2m = ref($opt{'process_o2m'}) eq 'ARRAY'
 380                         ? @{ $opt{'process_o2m'} }
 381                         :  ( $opt{'process_o2m'} );
 382   }
 383   if ( $opt{'process_locale'} ) {
 384     push @process_o2m,
 385     {
 386       'table'  => $table . '_msgcat',
 387       'fields' => [ 'locale', $opt{'process_locale'} ],
 388     };
 389   }
 390
 391   if ( !$error ) {
 392
 393     foreach my $process_o2m (@process_o2m) {
 394
 395       if ( $opt{'debug'} ) {
 396         warn "$me processing o2m:\n". Dumper( %{ $process_o2m },
 397                                                  'params' => scalar($cgi->Vars),
 398                                                );
 399       }
 400
 401       $error ||= $new->process_o2m( %{ $process_o2m },
 402                                      'params' => scalar($cgi->Vars),
 403                                    );
 404     }
 405
 406   }
 407
 408
 409   if ( !$error and $opt{'process_upload'} ) {
 410     # mostly duplicates misc/file-upload.html
 411     $cgi->param('upload_fields') =~ /^([,\w]+)$/
 412       or $error = "invalid upload_fields";
 413     my $fields = $1;
 414
 415     my $dir = $FS::UID::cache_dir. "/cache.". $FS::UID::datasrc;
 416
 417     foreach my $field (split /,/, $fields) {
 418       next if $error;
 419       my $source_name = $cgi->param($field);
 420
 421       if ( $opt{'debug'} ) {
 422         warn "$me processing upload: $source_name\n";
 423       }
 424       my $fh = $cgi->upload( $field ); # if no file provided, that's fine
 425       next if !$fh;
 426
 427       my $suffix = '';
 428       if ( $source_name =~ /(\.\w+)$/ ) {
 429         $suffix = lc($1);
 430       }
 431
 432       my $sh = File::Temp->new( TEMPLATE => 'upload.XXXXXXXX',
 433                                 SUFFIX   => $suffix,
 434                                 DIR      => $dir,
 435                                 UNLINK   => 0,
 436                               )
 437         or $error ||= "can't open temporary file to store upload: $!\n";
 438       next if $error;
 439       while(<$fh>) {
 440         print $sh $_;
 441       }
 442       $sh->filename =~ m!.*/([.\w]+)$!;
 443       push @uploaded_files, "$field:$1";
 444       if ( $opt{'debug'} ) {
 445         warn "uploaded as $1\n";
 446       }
 447     }
 448   }
 449
 450   if ( !$error and $opt{'update_svc'} ) {
 451     my @args = ();
 452     @args = &{ $opt{'args_callback'} }( $cgi, $new ) if $opt{'args_callback'};
 453    $error = &{ $opt{'update_svc'} }( $cgi, $new, @args );
 454   }
 455
 456   if ( $error ) {
 457
 458     $cgi->param('error', $error);
 459     if ( $opt{'clear_on_error'} && scalar(@{$opt{'clear_on_error'}}) ) {
 460       foreach my $field (@{$opt{'clear_on_error'}}) {
 461         $cgi->param($field, '')
 462       }
 463     }
 464
 465   } else {
 466
 467     if ( $opt{'noerror_callback'} ) {
 468       &{ $opt{'noerror_callback'} }( $cgi, $new );
 469     }
 470
 471   }
 472
 473   last if $error;
 474
 475 }
 476
 477 if ($class eq "FS::tower") {
 478   foreach my $part_svc_broadband_export ( FS::tower_sector->part_export_svc_broadband ) {
 479     if ($part_svc_broadband_export and $part_svc_broadband_export->can('export_tower_sector')) {
 480       $error = $part_svc_broadband_export->export_tower_sector($new);
 481     }
 482   }
 483 }
 484
 485 # set up redirect URLs
 486
 487 my $redirect;
 488 if ( !$error ) {
 489   $opt{'redirect'} = &{$opt{'redirect'}}($cgi, $new)
 490     if ref($opt{'redirect'}) eq 'CODE';
 491
 492   if ( $opt{'redirect'} ) {
 493
 494     $redirect = $opt{'redirect'} . $new_pkey;
 495
 496   } else {
 497
 498     my $ext = $opt{'viewall_ext'} || 'html';
 499     my $viewall_dir = $opt{'viewall_dir'} || 'search';
 500     my $viewall_url = $opt{'viewall_url'} || ($viewall_dir . "/$table.$ext");
 501
 502     $redirect = popurl(3) . $viewall_url;
 503
 504   }
 505 }
 506
 507 my $edit_ext = $opt{'edit_ext'} || 'html';
 508 my $error_redirect = $opt{'error_redirect'}
 509                      || popurl(2)."$table.$edit_ext";
 510 </%init>