5 <& elements/process.html,
11 'table' => 'tablename',
13 #? 'primary_key' => #required when the dbdef doesn't know...???
20 'viewall_dir' => '', #'search' or 'browse', defaults to 'search'
21 'viewall_ext' => 'html', #'cgi' or 'html', defaults to 'html'
23 'redirect' => 'view/table.cgi?', # value of primary key is appended
24 # (string or coderef returning a string)
26 'popup_reload' => 'Momentary success message', #will reload parent window
28 'error_redirect' => popurl(2).'edit/table.cgi?', #query string appended
30 'edit_ext' => 'html', #defaults to 'html', you might want 'cgi' while the
31 #naming is still inconsistent
33 'copy_on_empty' => [ 'old_field_name', 'another_old_field', ... ],
35 'clear_on_error' => [ 'form_field1', 'form_field2', ... ],
37 #pass an arrayref of hashrefs for multiple m2ms or m2names
38 #be certain you incorporate m2m_Common if you see error: param
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)
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' ],
53 'param_style' => 'link_table.value checkboxes',
55 'param_style' => 'name_colN values',
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 )],
65 'process_locale' => 'fieldname', # update entries in the _msgcat table
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 )],
74 'skip_process' => 0, #boolean, if set true, will skip the main table
75 #add/edit processing and only run any linked table
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 ) = @_; },
82 #after the new object is created
83 #return an error string or empty for no error
84 'post_new_object_callback' => sub { my( $cgi, $object ) = @_; },
86 #run right before replacing (not run for inserts)
87 'edit_callback' => sub { my( $new, $old ) = @_; },
89 #after everything's inserted
90 'noerror_callback' => sub { my( $cgi, $object ) = @_; },
92 #supplies arguments to insert() and replace()
93 # for use with tables that are FS::option_Common (among other things)
94 'args_callback' => sub { my( $cgi, $object ) = @_; },
96 # if no errors after package insert or replace will update services attached to package.
97 'update_svc' => sub { my( $cgi, $object ) = @_; },
99 'debug' => 1, #turns on debugging output
101 #agent virtualization
103 'agent_null_right' => 'Access Right Name',
105 #special bulk insert mode
112 % ## flatten any array refs so multi selects are sticky on error
113 % for my $param ($cgi->param) {
114 % if (ref($cgi->param($param)) eq "ARRAY") {
115 % $cgi->param($param, (join ",", @{$cgi->param($param)}));
119 % #my $query = $m->scomp('/elements/create_uri_query');
120 % #$cgi->redirect("$url?$query");
121 % if ( length($cgi->query_string) > 1920 ) { #stupid IE 2083 URL limit
123 % my $session = int(rand(4294967296)); #XXX
124 % my $pref = new FS::access_user_pref({
125 % 'usernum' => $FS::CurrentUser::CurrentUser->usernum,
126 % 'prefname' => "redirect$session",
127 % 'prefvalue' => $cgi->query_string,
128 % 'expiration' => time + 3600, #1h? 1m?
130 % my $pref_error = $pref->insert;
131 % if ( $pref_error ) {
132 % die "FATAL: couldn't even set redirect cookie: $pref_error".
133 % " attempting to set redirect$session to ". $cgi->query_string."\n";
136 <% $cgi->redirect("$error_redirect?redirect=$session") %>
140 <% $cgi->redirect("$error_redirect?". $cgi->query_string ) %>
144 % #different ways of handling success
146 %} elsif ( $opt{'process_upload'} and @uploaded_files ) {
148 % # construct a form to pass all the requested fields, the
150 <& /elements/header.html &>
151 <form name="UploadForm">
152 % my $job_fields = $opt{'process_upload'}{'fields'};
153 % foreach my $field ( @$job_fields ) {
154 <input type="hidden" name="<% $field %>" value="<% $cgi->param($field) |h %>">
156 % push @$job_fields, 'uploaded_files', $pkey;
158 <input type="hidden" name="uploaded_files" value="<% join(',', @uploaded_files) %>">
159 <input type="hidden" name="<% $pkey %>" value="<% $new->get($pkey) %>">
160 <& /elements/progress-init.html,
163 $fsurl . $opt{'process_upload'}{'process'},
166 error_url => "$error_redirect?$new_pkey"
169 <input type="submit" style="display:none">
172 <&| /elements/onload.js &>
176 <& /elements/footer.html &>
178 % } elsif ( $opt{'progress_init'} ) {
179 % # some false laziness with the above
180 % my ($form_name, $job_fields) = @{ $opt{'progress_init'} };
181 <form name="<% $form_name %>">
182 <input type="hidden" name="<% $pkey %>" value="<% $new->get($pkey) %>">
183 % foreach my $field (@$job_fields) {
184 % next if $field eq $pkey;
185 <input type="hidden" name="<% $field %>" value="<% $cgi->param($field) |h %>">
187 <& /elements/progress-init.html,
188 @{ $opt{'progress_init'} }
190 <input type="submit" style="display:none">
193 <&| /elements/onload.js &>
197 <& /elements/footer.html &>
199 % } elsif ( $opt{'popup_reload'} ) {
201 <% include('/elements/header-popup.html', $opt{'popup_reload'} ) %>
203 <SCRIPT TYPE="text/javascript">
211 <% $cgi->redirect($redirect) %>
215 my $me = 'process.html:';
219 my $curuser = $FS::CurrentUser::CurrentUser;
222 if ( $opt{'precheck_callback'} ) {
223 $error = &{ $opt{'precheck_callback'} }( $cgi );
226 #false laziness w/edit.html
227 my $table = $opt{'table'};
228 my $class = "FS::$table";
229 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
230 my $fields = $opt{'fields'}
231 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
232 || [ fields($table) ];
234 my $old_pkey = $cgi->param($pkey);
240 'hashref' => { $pkey => $old_pkey },
241 'extra_sql' => ( $opt{'agent_virt'}
242 ? ' AND '. $curuser->agentnums_sql(
243 'null_right' => $opt{'agent_null_right'}
250 my $bfield = $opt{'bulk'};
253 map { my @entry = ( $_ => scalar($cgi->param($_)) );
254 $opt{'value_callback'} ? ( $_ => &{ $opt{'value_callback'} }( @entry ))
256 } grep { $_ ne $bfield } @$fields;
260 @values = $cgi->param($bfield);
261 #warn join(',', @values);
268 foreach my $value ( @values ) {
270 if ($opt{'skip_process'}) {
273 $new_pkey = $old_pkey;
277 $new = $class->new( \%hash );
279 $new->$bfield($value) if $bfield;
281 if ($old && exists($opt{'copy_on_empty'})) {
282 foreach my $field (@{$opt{'copy_on_empty'}}) {
283 $new->set($field, $old->get($field))
284 unless scalar($cgi->param($field));
288 if ( $opt{'post_new_object_callback'} ) {
289 $error ||= &{ $opt{'post_new_object_callback'} }( $cgi, $new );
292 if ( $opt{'agent_virt'} ) {
294 if ( ! $new->agentnum
295 && ( ! $opt{'agent_null_right'}
296 || ! $curuser->access_right($opt{'agent_null_right'})
301 $error ||= 'Select an agent';
305 die "illegal agentnum"
306 unless $curuser->agentnums_href->{$new->agentnum}
307 or $curuser->access_right('View customers of all agents')
308 or $opt{'agent_null_right'}
310 && $curuser->access_right($opt{'agent_null_right'});
317 if ( !$error && $opt{'args_callback'} ) {
318 @args = &{ $opt{'args_callback'} }( $cgi, $new );
321 if ( !$error && $opt{'debug'} ) {
322 warn "$me updating record in $table table using $class class\n";
324 warn "with args: \n". Dumper(\@args) if @args;
330 &{ $opt{'edit_callback'} }( $new, $old ) if $opt{'edit_callback'};
332 $error = $new->replace($old, @args);
334 $error = $new->insert(@args);
336 $new_pkey = $new->getfield($pkey);
339 } #unless $opt{'skip_process'}
341 if ( !$error && $opt{'process_m2m'} ) {
343 my @process_m2m = ref($opt{'process_m2m'}) eq 'ARRAY'
344 ? @{ $opt{'process_m2m'} }
345 : ( $opt{'process_m2m'} );
347 foreach my $process_m2m (@process_m2m) {
349 $process_m2m->{'params'} ||= scalar($cgi->Vars);
351 warn "$me processing m2m:\n". Dumper( %$process_m2m )
354 $error ||= $new->process_m2m( %$process_m2m );
359 if ( !$error && $opt{'process_m2name'} ) {
361 my @process_m2name = ref($opt{'process_m2name'}) eq 'ARRAY'
362 ? @{ $opt{'process_m2name'} }
363 : ( $opt{'process_m2name'} );
366 foreach my $process_m2name (@process_m2name) {
368 if ( $opt{'debug'} ) {
369 warn "$me processing m2name:\n". Dumper( %{ $process_m2name },
370 'params' => scalar($cgi->Vars),
374 $error = $new->process_m2name( %{ $process_m2name },
375 'params' => scalar($cgi->Vars),
382 if ( $opt{'process_o2m'} ) {
383 @process_o2m = ref($opt{'process_o2m'}) eq 'ARRAY'
384 ? @{ $opt{'process_o2m'} }
385 : ( $opt{'process_o2m'} );
387 if ( $opt{'process_locale'} ) {
390 'table' => $table . '_msgcat',
391 'fields' => [ 'locale', $opt{'process_locale'} ],
397 foreach my $process_o2m (@process_o2m) {
399 if ( $opt{'debug'} ) {
400 warn "$me processing o2m:\n". Dumper( %{ $process_o2m },
401 'params' => scalar($cgi->Vars),
405 $error ||= $new->process_o2m( %{ $process_o2m },
406 'params' => scalar($cgi->Vars),
413 if ( !$error and $opt{'process_upload'} ) {
414 # mostly duplicates misc/file-upload.html
415 $cgi->param('upload_fields') =~ /^([,\w]+)$/
416 or $error = "invalid upload_fields";
419 my $dir = $FS::UID::cache_dir. "/cache.". $FS::UID::datasrc;
421 foreach my $field (split /,/, $fields) {
423 my $source_name = $cgi->param($field);
425 if ( $opt{'debug'} ) {
426 warn "$me processing upload: $source_name\n";
428 my $fh = $cgi->upload( $field ); # if no file provided, that's fine
432 if ( $source_name =~ /(\.\w+)$/ ) {
436 my $sh = File::Temp->new( TEMPLATE => 'upload.XXXXXXXX',
441 or $error ||= "can't open temporary file to store upload: $!\n";
446 $sh->filename =~ m!.*/([.\w]+)$!;
447 push @uploaded_files, "$field:$1";
448 if ( $opt{'debug'} ) {
449 warn "uploaded as $1\n";
454 if ( !$error and $opt{'update_svc'} ) {
456 @args = &{ $opt{'args_callback'} }( $cgi, $new ) if $opt{'args_callback'};
457 $error = &{ $opt{'update_svc'} }( $cgi, $new, @args );
462 $cgi->param('error', $error);
463 if ( $opt{'clear_on_error'} && scalar(@{$opt{'clear_on_error'}}) ) {
464 foreach my $field (@{$opt{'clear_on_error'}}) {
465 $cgi->param($field, '')
471 if ( $opt{'noerror_callback'} ) {
472 &{ $opt{'noerror_callback'} }( $cgi, $new );
481 if ($class eq "FS::tower") {
482 foreach my $part_svc_broadband_export ( FS::tower_sector->part_export_svc_broadband ) {
483 if ($part_svc_broadband_export and $part_svc_broadband_export->can('export_tower_sector')) {
484 my $export_tower = $part_svc_broadband_export->export_tower_sector($new);
485 $error = $export_tower->{'error'} if $export_tower;
488 $cgi->param('error', $error) if $error;
491 # set up redirect URLs
495 $opt{'redirect'} = &{$opt{'redirect'}}($cgi, $new)
496 if ref($opt{'redirect'}) eq 'CODE';
498 if ( $opt{'redirect'} ) {
500 $redirect = $opt{'redirect'} . $new_pkey;
504 my $ext = $opt{'viewall_ext'} || 'html';
505 my $viewall_dir = $opt{'viewall_dir'} || 'search';
506 my $viewall_url = $opt{'viewall_url'} || ($viewall_dir . "/$table.$ext");
508 $redirect = popurl(3) . $viewall_url;
513 my $edit_ext = $opt{'edit_ext'} || 'html';
514 my $error_redirect = $opt{'error_redirect'}
515 || popurl(2)."$table.$edit_ext";