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