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