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_upload' => {
  66                          'process'  => 'misc/mytable-import.html',
  67                           # fields to pass to the back end job, besides the
  68                           # primary key of the object
  69                          'fields'   => [qw( fieldname fieldname2 )],
  70                        },
  71
  72    'skip_process' => 0, #boolean, if set true, will skip the main table
  73                         #add/edit processing and only run any linked table
  74                         #process_ items
  75
  76    #checks CGI params and whatever else before much else runs
  77    #return an error string or empty for no error
  78    'precheck_callback' => sub { my( $cgi ) = @_; },
  79
  80    #after everything's inserted
  81    'noerror_callback' => sub { my( $cgi, $object ) = @_; },
  82
  83    #supplies arguments to insert() and replace()
  84    # for use with tables that are FS::option_Common (among other things)
  85    'args_callback' => sub { my( $cgi, $object ) = @_; },
  86
  87    'debug' => 1, #turns on debugging output
  88
  89    #agent virtualization
  90    'agent_virt'       => 1,
  91    'agent_null_right' => 'Access Right Name',
  92
  93    #special bulk insert mode
  94    'bulk' => 'field',
  95
  96  &>
  97
  98 </%doc>
  99 %if ( $error ) {
 100 %
 101 %  #my $query = $m->scomp('/elements/create_uri_query');
 102 %  #$cgi->redirect("$url?$query");
 103 %  if ( length($cgi->query_string) > 1920 ) { #stupid IE 2083 URL limit
 104 %
 105 %    my $session = int(rand(4294967296)); #XXX
 106 %    my $pref = new FS::access_user_pref({
 107 %      'usernum'    => $FS::CurrentUser::CurrentUser->usernum,
 108 %      'prefname'   => "redirect$session",
 109 %      'prefvalue'  => $cgi->query_string,
 110 %      'expiration' => time + 3600, #1h?  1m?
 111 %    });
 112 %    my $pref_error = $pref->insert;
 113 %    if ( $pref_error ) {
 114 %      die "FATAL: couldn't even set redirect cookie: $pref_error".
 115 %          " attempting to set redirect$session to ". $cgi->query_string."\n";
 116 %    }
 117 %
 118 <% $cgi->redirect("$error_redirect?redirect=$session") %>
 119 %
 120 %  } else {
 121 %
 122 <% $cgi->redirect("$error_redirect?". $cgi->query_string ) %>
 123 %
 124 %  }
 125 %
 126 % #different ways of handling success
 127 %
 128 %} elsif ( $opt{'process_upload'} and @uploaded_files ) {
 129 %
 130 % # construct a form to pass all the requested fields, the
 131 %
 132 <& /elements/header.html &>
 133 <form name="UploadForm">
 134 %   my $job_fields = $opt{'process_upload'}{'fields'};
 135 %   foreach my $field ( @$job_fields ) {
 136   <input type="hidden" name="<% $field %>" value="<% $cgi->param($field) |h %>">
 137 %   }
 138 %   push @$job_fields, 'uploaded_files', $pkey;
 139 %
 140   <input type="hidden" name="uploaded_files" value="<% join(',', @uploaded_files) %>">
 141   <input type="hidden" name="<% $pkey %>" value="<% $new->get($pkey) %>">
 142 <& /elements/progress-init.html,
 143   'UploadForm',
 144   $job_fields,
 145   $fsurl . $opt{'process_upload'}{'process'},
 146   {
 147     url => $redirect,
 148     error_url => "$error_redirect?$new_pkey"
 149   },
 150 &>
 151 <input type="submit" style="display:none">
 152 </form>
 153 <script>
 154 <&| /elements/onload.js &>
 155 process();
 156 </&>
 157 </script>
 158 <& /elements/footer.html &>
 159
 160 % } elsif ( $opt{'progress_init'} ) {
 161 %   # some false laziness with the above
 162 %   my ($form_name, $job_fields) = @{ $opt{'progress_init'} };
 163 <form name="<% $form_name %>">
 164   <input type="hidden" name="<% $pkey %>" value="<% $new->get($pkey) %>">
 165 %   foreach my $field (@$job_fields) {
 166 %     next if $field eq $pkey;
 167   <input type="hidden" name="<% $field %>" value="<% $cgi->param($field) |h %>">
 168 %   }
 169 <& /elements/progress-init.html,
 170   @{ $opt{'progress_init'} }
 171 &>
 172 <input type="submit" style="display:none">
 173 </form>
 174 <script>
 175 <&| /elements/onload.js &>
 176 process();
 177 </&>
 178 </script>
 179 <& /elements/footer.html &>
 180
 181 % } elsif ( $opt{'popup_reload'} ) {
 182
 183   <% include('/elements/header-popup.html', $opt{'popup_reload'} ) %>
 184
 185   <SCRIPT TYPE="text/javascript">
 186     window.top.location.reload();
 187   </SCRIPT>
 188
 189   </BODY>
 190   </HTML>
 191
 192 %} else {
 193 <% $cgi->redirect($redirect) %>
 194 %}
 195 <%init>
 196
 197 my $me = 'process.html:';
 198
 199 my(%opt) = @_;
 200
 201 my $curuser = $FS::CurrentUser::CurrentUser;
 202
 203 my $error = '';
 204 if ( $opt{'precheck_callback'} ) {
 205   $error = &{ $opt{'precheck_callback'} }( $cgi );
 206 }
 207
 208 #false laziness w/edit.html
 209 my $table = $opt{'table'};
 210 my $class = "FS::$table";
 211 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
 212 my $fields = $opt{'fields'}
 213              #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
 214              || [ fields($table) ];
 215
 216 my $old_pkey = $cgi->param($pkey);
 217
 218 my $old = '';
 219 if ( $old_pkey ) {
 220   $old = qsearchs({
 221     'table'   => $table,
 222     'hashref' => { $pkey => $old_pkey },
 223     'extra_sql' => ( $opt{'agent_virt'}
 224                        ? ' AND '. $curuser->agentnums_sql(
 225                                     'null_right' => $opt{'agent_null_right'}
 226                                   )
 227                        : ''
 228                    ),
 229   });
 230 }
 231
 232 my $bfield = $opt{'bulk'};
 233
 234 my %hash =
 235   map { my @entry = ( $_ => scalar($cgi->param($_)) );
 236         $opt{'value_callback'} ? ( $_ => &{ $opt{'value_callback'} }( @entry ))
 237                                : ( @entry )
 238       } grep { $_ ne $bfield } @$fields;
 239
 240 my @values = ( 1 );
 241 if ( $bfield ) {
 242   @values = $cgi->param($bfield);
 243   #warn join(',', @values);
 244 }
 245
 246 my @uploaded_files;
 247
 248 my $new;
 249 my $new_pkey = '';
 250 foreach my $value ( @values ) {
 251
 252   if ($opt{'skip_process'}) {
 253
 254     $new = $old;
 255     $new_pkey = $old_pkey;
 256
 257   } else {
 258
 259     $new = $class->new( \%hash );
 260
 261     $new->$bfield($value) if $bfield;
 262
 263     if ($old && exists($opt{'copy_on_empty'})) {
 264       foreach my $field (@{$opt{'copy_on_empty'}}) {
 265         $new->set($field, $old->get($field))
 266           unless scalar($cgi->param($field));
 267       }
 268     }
 269
 270     if ( $opt{'agent_virt'} ) {
 271
 272       if ( ! $new->agentnum
 273            && (    ! $opt{'agent_null_right'}
 274                 || ! $curuser->access_right($opt{'agent_null_right'})
 275               )
 276          )
 277       {
 278
 279         $error ||= 'Select an agent';
 280
 281       } else {
 282
 283         die "illegal agentnum"
 284           unless $curuser->agentnums_href->{$new->agentnum}
 285               or $curuser->access_right('View customers of all agents')
 286               or $opt{'agent_null_right'}
 287                  && ! $new->agentnum
 288                  && $curuser->access_right($opt{'agent_null_right'});
 289
 290       }
 291
 292     }
 293
 294     my @args = ();
 295     if ( !$error && $opt{'args_callback'} ) {
 296       @args = &{ $opt{'args_callback'} }( $cgi, $new );
 297     }
 298
 299     if ( !$error && $opt{'debug'} ) {
 300       warn "$me updating record in $table table using $class class\n";
 301       warn Dumper(\%hash);
 302       warn "with args: \n". Dumper(\@args) if @args;
 303     }
 304
 305     if ( !$error ) {
 306       if ( $old_pkey ) {
 307
 308         &{ $opt{'edit_callback'} }( $new, $old ) if $opt{'edit_callback'};
 309
 310         $error = $new->replace($old, @args);
 311       } else {
 312         $error = $new->insert(@args);
 313       }
 314       $new_pkey = $new->getfield($pkey);
 315     }
 316
 317   } #unless $opt{'skip_process'}
 318
 319   if ( !$error && $opt{'process_m2m'} ) {
 320
 321     my @process_m2m = ref($opt{'process_m2m'}) eq 'ARRAY'
 322                         ? @{ $opt{'process_m2m'} }
 323                         :  ( $opt{'process_m2m'} );
 324
 325     foreach my $process_m2m (@process_m2m) {
 326
 327       $process_m2m->{'params'} ||= scalar($cgi->Vars);
 328
 329       warn "$me processing m2m:\n". Dumper( %$process_m2m )
 330         if $opt{'debug'};
 331
 332       $error ||= $new->process_m2m( %$process_m2m );
 333     }
 334
 335   }
 336
 337   if ( !$error && $opt{'process_m2name'} ) {
 338
 339     my @process_m2name = ref($opt{'process_m2name'}) eq 'ARRAY'
 340                            ? @{ $opt{'process_m2name'} }
 341                            :  ( $opt{'process_m2name'} );
 342
 343
 344     foreach my $process_m2name (@process_m2name) {
 345
 346       if ( $opt{'debug'} ) {
 347         warn "$me processing m2name:\n". Dumper( %{ $process_m2name },
 348                                                  'params' => scalar($cgi->Vars),
 349                                                );
 350       }
 351
 352       $error = $new->process_m2name( %{ $process_m2name },
 353                                      'params' => scalar($cgi->Vars),
 354                                    );
 355     }
 356
 357   }
 358
 359   if ( !$error && $opt{'process_o2m'} ) {
 360
 361     my @process_o2m = ref($opt{'process_o2m'}) eq 'ARRAY'
 362                            ? @{ $opt{'process_o2m'} }
 363                            :  ( $opt{'process_o2m'} );
 364
 365
 366     foreach my $process_o2m (@process_o2m) {
 367
 368       if ( $opt{'debug'} ) {
 369         warn "$me processing o2m:\n". Dumper( %{ $process_o2m },
 370                                                  'params' => scalar($cgi->Vars),
 371                                                );
 372       }
 373
 374       $error ||= $new->process_o2m( %{ $process_o2m },
 375                                      'params' => scalar($cgi->Vars),
 376                                    );
 377     }
 378
 379   }
 380
 381
 382   if ( !$error and $opt{'process_upload'} ) {
 383     # mostly duplicates misc/file-upload.html
 384     $cgi->param('upload_fields') =~ /^([,\w]+)$/
 385       or $error = "invalid upload_fields";
 386     my $fields = $1;
 387
 388     my $dir = $FS::UID::cache_dir. "/cache.". $FS::UID::datasrc;
 389
 390     foreach my $field (split /,/, $fields) {
 391       next if $error;
 392       my $source_name = $cgi->param($field);
 393
 394       if ( $opt{'debug'} ) {
 395         warn "$me processing upload: $source_name\n";
 396       }
 397       my $fh = $cgi->upload( $field ); # if no file provided, that's fine
 398       next if !$fh;
 399
 400       my $suffix = '';
 401       if ( $source_name =~ /(\.\w+)$/ ) {
 402         $suffix = lc($1);
 403       }
 404
 405       my $sh = File::Temp->new( TEMPLATE => 'upload.XXXXXXXX',
 406                                 SUFFIX   => $suffix,
 407                                 DIR      => $dir,
 408                                 UNLINK   => 0,
 409                               )
 410         or $error ||= "can't open temporary file to store upload: $!\n";
 411       next if $error;
 412       while(<$fh>) {
 413         print $sh $_;
 414       }
 415       $sh->filename =~ m!.*/([.\w]+)$!;
 416       push @uploaded_files, "$field:$1";
 417       if ( $opt{'debug'} ) {
 418         warn "uploaded as $1\n";
 419       }
 420     }
 421   }
 422
 423   if ( $error ) {
 424
 425     $cgi->param('error', $error);
 426     if ( $opt{'clear_on_error'} && scalar(@{$opt{'clear_on_error'}}) ) {
 427       foreach my $field (@{$opt{'clear_on_error'}}) {
 428         $cgi->param($field, '')
 429       }
 430     }
 431
 432   } else {
 433
 434     if ( $opt{'noerror_callback'} ) {
 435       &{ $opt{'noerror_callback'} }( $cgi, $new );
 436     }
 437
 438   }
 439
 440   last if $error;
 441
 442 }
 443
 444 # set up redirect URLs
 445
 446 my $redirect;
 447 if ( !$error ) {
 448   $opt{'redirect'} = &{$opt{'redirect'}}($cgi, $new)
 449     if ref($opt{'redirect'}) eq 'CODE';
 450
 451   if ( $opt{'redirect'} ) {
 452
 453     $redirect = $opt{'redirect'} . $new_pkey;
 454
 455   } else {
 456
 457     my $ext = $opt{'viewall_ext'} || 'html';
 458     my $viewall_dir = $opt{'viewall_dir'} || 'search';
 459     my $viewall_url = $opt{'viewall_url'} || ($viewall_dir . "/$table.$ext");
 460
 461     $redirect = popurl(3) . $viewall_url;
 462
 463   }
 464 }
 465
 466 my $edit_ext = $opt{'edit_ext'} || 'html';
 467 my $error_redirect = $opt{'error_redirect'}
 468                      || popurl(2)."$table.$edit_ext";
 469 </%init>