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 'post_new_object_callback' => sub { my( $cgi, $object ) = @_; },
85 #after everything's inserted
86 'noerror_callback' => sub { my( $cgi, $object ) = @_; },
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 ) = @_; },
92 'debug' => 1, #turns on debugging output
96 'agent_null_right' => 'Access Right Name',
98 #special bulk insert mode
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
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?
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";
123 <% $cgi->redirect("$error_redirect?redirect=$session") %>
127 <% $cgi->redirect("$error_redirect?". $cgi->query_string ) %>
131 % #different ways of handling success
133 %} elsif ( $opt{'process_upload'} and @uploaded_files ) {
135 % # construct a form to pass all the requested fields, the
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 %>">
143 % push @$job_fields, 'uploaded_files', $pkey;
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,
150 $fsurl . $opt{'process_upload'}{'process'},
153 error_url => "$error_redirect?$new_pkey"
156 <input type="submit" style="display:none">
159 <&| /elements/onload.js &>
163 <& /elements/footer.html &>
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 %>">
174 <& /elements/progress-init.html,
175 @{ $opt{'progress_init'} }
177 <input type="submit" style="display:none">
180 <&| /elements/onload.js &>
184 <& /elements/footer.html &>
186 % } elsif ( $opt{'popup_reload'} ) {
188 <% include('/elements/header-popup.html', $opt{'popup_reload'} ) %>
190 <SCRIPT TYPE="text/javascript">
191 window.top.location.reload();
198 <% $cgi->redirect($redirect) %>
202 my $me = 'process.html:';
206 my $curuser = $FS::CurrentUser::CurrentUser;
209 if ( $opt{'precheck_callback'} ) {
210 $error = &{ $opt{'precheck_callback'} }( $cgi );
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) ];
221 my $old_pkey = $cgi->param($pkey);
227 'hashref' => { $pkey => $old_pkey },
228 'extra_sql' => ( $opt{'agent_virt'}
229 ? ' AND '. $curuser->agentnums_sql(
230 'null_right' => $opt{'agent_null_right'}
237 my $bfield = $opt{'bulk'};
240 map { my @entry = ( $_ => scalar($cgi->param($_)) );
241 $opt{'value_callback'} ? ( $_ => &{ $opt{'value_callback'} }( @entry ))
243 } grep { $_ ne $bfield } @$fields;
247 @values = $cgi->param($bfield);
248 #warn join(',', @values);
255 foreach my $value ( @values ) {
257 if ($opt{'skip_process'}) {
260 $new_pkey = $old_pkey;
264 $new = $class->new( \%hash );
266 $new->$bfield($value) if $bfield;
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));
275 if ( $opt{'post_new_object_callback'} ) {
276 &{ $opt{'post_new_object_callback'} }( $cgi, $new );
279 if ( $opt{'agent_virt'} ) {
281 if ( ! $new->agentnum
282 && ( ! $opt{'agent_null_right'}
283 || ! $curuser->access_right($opt{'agent_null_right'})
288 $error ||= 'Select an agent';
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'}
297 && $curuser->access_right($opt{'agent_null_right'});
304 if ( !$error && $opt{'args_callback'} ) {
305 @args = &{ $opt{'args_callback'} }( $cgi, $new );
308 if ( !$error && $opt{'debug'} ) {
309 warn "$me updating record in $table table using $class class\n";
311 warn "with args: \n". Dumper(\@args) if @args;
317 &{ $opt{'edit_callback'} }( $new, $old ) if $opt{'edit_callback'};
319 $error = $new->replace($old, @args);
321 $error = $new->insert(@args);
323 $new_pkey = $new->getfield($pkey);
326 } #unless $opt{'skip_process'}
328 if ( !$error && $opt{'process_m2m'} ) {
330 my @process_m2m = ref($opt{'process_m2m'}) eq 'ARRAY'
331 ? @{ $opt{'process_m2m'} }
332 : ( $opt{'process_m2m'} );
334 foreach my $process_m2m (@process_m2m) {
336 $process_m2m->{'params'} ||= scalar($cgi->Vars);
338 warn "$me processing m2m:\n". Dumper( %$process_m2m )
341 $error ||= $new->process_m2m( %$process_m2m );
346 if ( !$error && $opt{'process_m2name'} ) {
348 my @process_m2name = ref($opt{'process_m2name'}) eq 'ARRAY'
349 ? @{ $opt{'process_m2name'} }
350 : ( $opt{'process_m2name'} );
353 foreach my $process_m2name (@process_m2name) {
355 if ( $opt{'debug'} ) {
356 warn "$me processing m2name:\n". Dumper( %{ $process_m2name },
357 'params' => scalar($cgi->Vars),
361 $error = $new->process_m2name( %{ $process_m2name },
362 'params' => scalar($cgi->Vars),
369 if ( $opt{'process_o2m'} ) {
370 @process_o2m = ref($opt{'process_o2m'}) eq 'ARRAY'
371 ? @{ $opt{'process_o2m'} }
372 : ( $opt{'process_o2m'} );
374 if ( $opt{'process_locale'} ) {
377 'table' => $table . '_msgcat',
378 'fields' => [ 'locale', $opt{'process_locale'} ],
384 foreach my $process_o2m (@process_o2m) {
386 if ( $opt{'debug'} ) {
387 warn "$me processing o2m:\n". Dumper( %{ $process_o2m },
388 'params' => scalar($cgi->Vars),
392 $error ||= $new->process_o2m( %{ $process_o2m },
393 'params' => scalar($cgi->Vars),
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";
406 my $dir = $FS::UID::cache_dir. "/cache.". $FS::UID::datasrc;
408 foreach my $field (split /,/, $fields) {
410 my $source_name = $cgi->param($field);
412 if ( $opt{'debug'} ) {
413 warn "$me processing upload: $source_name\n";
415 my $fh = $cgi->upload( $field ); # if no file provided, that's fine
419 if ( $source_name =~ /(\.\w+)$/ ) {
423 my $sh = File::Temp->new( TEMPLATE => 'upload.XXXXXXXX',
428 or $error ||= "can't open temporary file to store upload: $!\n";
433 $sh->filename =~ m!.*/([.\w]+)$!;
434 push @uploaded_files, "$field:$1";
435 if ( $opt{'debug'} ) {
436 warn "uploaded as $1\n";
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, '')
452 if ( $opt{'noerror_callback'} ) {
453 &{ $opt{'noerror_callback'} }( $cgi, $new );
462 # set up redirect URLs
466 $opt{'redirect'} = &{$opt{'redirect'}}($cgi, $new)
467 if ref($opt{'redirect'}) eq 'CODE';
469 if ( $opt{'redirect'} ) {
471 $redirect = $opt{'redirect'} . $new_pkey;
475 my $ext = $opt{'viewall_ext'} || 'html';
476 my $viewall_dir = $opt{'viewall_dir'} || 'search';
477 my $viewall_url = $opt{'viewall_url'} || ($viewall_dir . "/$table.$ext");
479 $redirect = popurl(3) . $viewall_url;
484 my $edit_ext = $opt{'edit_ext'} || 'html';
485 my $error_redirect = $opt{'error_redirect'}
486 || popurl(2)."$table.$edit_ext";