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 %  my $cookie;
 213 %  $cookie = CGI::Cookie->new(
 214 %                        -name    => 'freeside_status',
 215 %                        -value   => $messages,
 216 %                        -expires => '+5m',
 217 %                      ) if $messages;
 218    <% $cgi->redirect( -uri    => $redirect,
 219                       -cookie => $cookie,
 220       )
 221    %>
 222 %}
 223 <%init>
 224
 225 my $me = 'process.html:';
 226
 227 my(%opt) = @_;
 228
 229 my $curuser = $FS::CurrentUser::CurrentUser;
 230
 231 my $error = '';
 232 if ( $opt{'precheck_callback'} ) {
 233   $error = &{ $opt{'precheck_callback'} }( $cgi );
 234 }
 235
 236 #false laziness w/edit.html
 237 my $table = $opt{'table'};
 238 my $class = "FS::$table";
 239 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
 240 my $fields = $opt{'fields'}
 241              #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
 242              || [ fields($table) ];
 243
 244 my $old_pkey = $cgi->param($pkey);
 245
 246 my $old = '';
 247 if ( $old_pkey ) {
 248   $old = qsearchs({
 249     'table'   => $table,
 250     'hashref' => { $pkey => $old_pkey },
 251     'extra_sql' => ( $opt{'agent_virt'}
 252                        ? ' AND '. $curuser->agentnums_sql(
 253                                     'null_right' => $opt{'agent_null_right'}
 254                                   )
 255                        : ''
 256                    ),
 257   });
 258 }
 259
 260 my $bfield = $opt{'bulk'};
 261
 262 my %hash =
 263   map { my @entry = ( $_ => scalar($cgi->param($_)) );
 264         $opt{'value_callback'} ? ( $_ => &{ $opt{'value_callback'} }( @entry ))
 265                                : ( @entry )
 266       } grep { $_ ne $bfield } @$fields;
 267
 268 my @values = ( 1 );
 269 if ( $bfield ) {
 270   @values = $cgi->param($bfield);
 271   #warn join(',', @values);
 272 }
 273
 274 my @uploaded_files;
 275
 276 my $new;
 277 my $new_pkey = '';
 278 foreach my $value ( @values ) {
 279
 280   if ($opt{'skip_process'}) {
 281
 282     $new = $old;
 283     $new_pkey = $old_pkey;
 284
 285   } else {
 286
 287     $new = $class->new( \%hash );
 288
 289     $new->$bfield($value) if $bfield;
 290
 291     if ($old && exists($opt{'copy_on_empty'})) {
 292       foreach my $field (@{$opt{'copy_on_empty'}}) {
 293         $new->set($field, $old->get($field))
 294           unless scalar($cgi->param($field));
 295       }
 296     }
 297
 298     if ( $opt{'post_new_object_callback'} ) {
 299       &{ $opt{'post_new_object_callback'} }( $cgi, $new );
 300     }
 301
 302     if ( $opt{'agent_virt'} ) {
 303
 304       if ( ! $new->agentnum
 305            && (    ! $opt{'agent_null_right'}
 306                 || ! $curuser->access_right($opt{'agent_null_right'})
 307               )
 308          )
 309       {
 310
 311         $error ||= 'Select an agent';
 312
 313       } else {
 314
 315         die "illegal agentnum"
 316           unless $curuser->agentnums_href->{$new->agentnum}
 317               or $curuser->access_right('View customers of all agents')
 318               or $opt{'agent_null_right'}
 319                  && ! $new->agentnum
 320                  && $curuser->access_right($opt{'agent_null_right'});
 321
 322       }
 323
 324     }
 325
 326     my @args = ();
 327     if ( !$error && $opt{'args_callback'} ) {
 328       @args = &{ $opt{'args_callback'} }( $cgi, $new );
 329     }
 330
 331     if ( !$error && $opt{'debug'} ) {
 332       warn "$me updating record in $table table using $class class\n";
 333       warn Dumper(\%hash);
 334       warn "with args: \n". Dumper(\@args) if @args;
 335     }
 336
 337     if ( !$error ) {
 338       if ( $old_pkey ) {
 339
 340         &{ $opt{'edit_callback'} }( $new, $old ) if $opt{'edit_callback'};
 341
 342         $error = $new->replace($old, @args);
 343       } else {
 344         $error = $new->insert(@args);
 345       }
 346       $new_pkey = $new->getfield($pkey);
 347     }
 348
 349   } #unless $opt{'skip_process'}
 350
 351   if ( !$error && $opt{'process_m2m'} ) {
 352
 353     my @process_m2m = ref($opt{'process_m2m'}) eq 'ARRAY'
 354                         ? @{ $opt{'process_m2m'} }
 355                         :  ( $opt{'process_m2m'} );
 356
 357     foreach my $process_m2m (@process_m2m) {
 358
 359       $process_m2m->{'params'} ||= scalar($cgi->Vars);
 360
 361       warn "$me processing m2m:\n". Dumper( %$process_m2m )
 362         if $opt{'debug'};
 363
 364       $error ||= $new->process_m2m( %$process_m2m );
 365     }
 366
 367   }
 368
 369   if ( !$error && $opt{'process_m2name'} ) {
 370
 371     my @process_m2name = ref($opt{'process_m2name'}) eq 'ARRAY'
 372                            ? @{ $opt{'process_m2name'} }
 373                            :  ( $opt{'process_m2name'} );
 374
 375
 376     foreach my $process_m2name (@process_m2name) {
 377
 378       if ( $opt{'debug'} ) {
 379         warn "$me processing m2name:\n". Dumper( %{ $process_m2name },
 380                                                  'params' => scalar($cgi->Vars),
 381                                                );
 382       }
 383
 384       $error = $new->process_m2name( %{ $process_m2name },
 385                                      'params' => scalar($cgi->Vars),
 386                                    );
 387     }
 388
 389   }
 390
 391   my @process_o2m;
 392   if ( $opt{'process_o2m'} ) {
 393     @process_o2m = ref($opt{'process_o2m'}) eq 'ARRAY'
 394                         ? @{ $opt{'process_o2m'} }
 395                         :  ( $opt{'process_o2m'} );
 396   }
 397   if ( $opt{'process_locale'} ) {
 398     push @process_o2m,
 399     {
 400       'table'  => $table . '_msgcat',
 401       'fields' => [ 'locale', $opt{'process_locale'} ],
 402     };
 403   }
 404
 405   if ( !$error ) {
 406
 407     foreach my $process_o2m (@process_o2m) {
 408
 409       if ( $opt{'debug'} ) {
 410         warn "$me processing o2m:\n". Dumper( %{ $process_o2m },
 411                                                  'params' => scalar($cgi->Vars),
 412                                                );
 413       }
 414
 415       $error ||= $new->process_o2m( %{ $process_o2m },
 416                                      'params' => scalar($cgi->Vars),
 417                                    );
 418     }
 419
 420   }
 421
 422
 423   if ( !$error and $opt{'process_upload'} ) {
 424     # mostly duplicates misc/file-upload.html
 425     $cgi->param('upload_fields') =~ /^([,\w]+)$/
 426       or $error = "invalid upload_fields";
 427     my $fields = $1;
 428
 429     my $dir = $FS::UID::cache_dir. "/cache.". $FS::UID::datasrc;
 430
 431     foreach my $field (split /,/, $fields) {
 432       next if $error;
 433       my $source_name = $cgi->param($field);
 434
 435       if ( $opt{'debug'} ) {
 436         warn "$me processing upload: $source_name\n";
 437       }
 438       my $fh = $cgi->upload( $field ); # if no file provided, that's fine
 439       next if !$fh;
 440
 441       my $suffix = '';
 442       if ( $source_name =~ /(\.\w+)$/ ) {
 443         $suffix = lc($1);
 444       }
 445
 446       my $sh = File::Temp->new( TEMPLATE => 'upload.XXXXXXXX',
 447                                 SUFFIX   => $suffix,
 448                                 DIR      => $dir,
 449                                 UNLINK   => 0,
 450                               )
 451         or $error ||= "can't open temporary file to store upload: $!\n";
 452       next if $error;
 453       while(<$fh>) {
 454         print $sh $_;
 455       }
 456       $sh->filename =~ m!.*/([.\w]+)$!;
 457       push @uploaded_files, "$field:$1";
 458       if ( $opt{'debug'} ) {
 459         warn "uploaded as $1\n";
 460       }
 461     }
 462   }
 463
 464   if ( !$error and $opt{'update_svc'} ) {
 465     my @args = ();
 466     @args = &{ $opt{'args_callback'} }( $cgi, $new ) if $opt{'args_callback'};
 467    $error = &{ $opt{'update_svc'} }( $cgi, $new, @args );
 468   }
 469
 470   if ( $error ) {
 471
 472     $cgi->param('error', $error);
 473     if ( $opt{'clear_on_error'} && scalar(@{$opt{'clear_on_error'}}) ) {
 474       foreach my $field (@{$opt{'clear_on_error'}}) {
 475         $cgi->param($field, '')
 476       }
 477     }
 478
 479   } else {
 480
 481     if ( $opt{'noerror_callback'} ) {
 482       &{ $opt{'noerror_callback'} }( $cgi, $new );
 483     }
 484
 485   }
 486
 487   last if $error;
 488
 489 }
 490
 491 if ($class eq "FS::tower") {
 492   foreach my $part_svc_broadband_export ( FS::tower_sector->part_export_svc_broadband ) {
 493     if ($part_svc_broadband_export and $part_svc_broadband_export->can('export_tower_sector')) {
 494       my $export_tower = $part_svc_broadband_export->export_tower_sector($new);
 495       $error = $export_tower->{'error'} if $export_tower;
 496     }
 497   }
 498   $cgi->param('error', $error) if $error;
 499 }
 500
 501 # set up redirect URLs
 502
 503 my $redirect;
 504 if ( !$error ) {
 505   $opt{'redirect'} = &{$opt{'redirect'}}($cgi, $new)
 506     if ref($opt{'redirect'}) eq 'CODE';
 507
 508   if ( $opt{'redirect'} ) {
 509
 510     $redirect = $opt{'redirect'} . $new_pkey;
 511
 512   } else {
 513
 514     my $ext = $opt{'viewall_ext'} || 'html';
 515     my $viewall_dir = $opt{'viewall_dir'} || 'search';
 516     my $viewall_url = $opt{'viewall_url'} || ($viewall_dir . "/$table.$ext");
 517
 518     $redirect = popurl(3) . $viewall_url;
 519
 520   }
 521 }
 522
 523 my $messages = $opt{'message'} ? $opt{'message'} : '';
 524
 525 my $edit_ext = $opt{'edit_ext'} || 'html';
 526 my $error_redirect = $opt{'error_redirect'}
 527                      || popurl(2)."$table.$edit_ext";
 528 </%init>