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