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