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 ## 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' ],
42 #pass an arrayref of hashrefs for multiple m2ms or m2names
43 #be certain you incorporate m2m_Common if you see error: param
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)
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' ],
58 'param_style' => 'link_table.value checkboxes',
60 'param_style' => 'name_colN values',
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 )],
70 'process_locale' => 'fieldname', # update entries in the _msgcat table
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 )],
79 'skip_process' => 0, #boolean, if set true, will skip the main table
80 #add/edit processing and only run any linked table
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 ) = @_; },
87 #after the new object is created
88 'post_new_object_callback' => sub { my( $cgi, $object ) = @_; },
90 #after everything's inserted
91 'noerror_callback' => sub { my( $cgi, $object ) = @_; },
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 ) = @_; },
97 # if no errors after package insert or replace will update services attached to package.
98 'update_svc' => sub { my( $cgi, $object ) = @_; },
100 'debug' => 1, #turns on debugging output
102 #agent virtualization
104 'agent_null_right' => 'Access Right Name',
106 #special bulk insert mode
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)}));
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
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?
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";
137 <% $cgi->redirect("$error_redirect?redirect=$session") %>
141 <% $cgi->redirect("$error_redirect?". $cgi->query_string ) %>
145 % #different ways of handling success
147 %} elsif ( $opt{'process_upload'} and @uploaded_files ) {
149 % # construct a form to pass all the requested fields, the
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 %>">
157 % push @$job_fields, 'uploaded_files', $pkey;
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,
164 $fsurl . $opt{'process_upload'}{'process'},
167 error_url => "$error_redirect?$new_pkey"
170 <input type="submit" style="display:none">
173 <&| /elements/onload.js &>
177 <& /elements/footer.html &>
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 %>">
188 <& /elements/progress-init.html,
189 @{ $opt{'progress_init'} }
191 <input type="submit" style="display:none">
194 <&| /elements/onload.js &>
198 <& /elements/footer.html &>
200 % } elsif ( $opt{'popup_reload'} ) {
202 <% include('/elements/header-popup.html', $opt{'popup_reload'} ) %>
204 <SCRIPT TYPE="text/javascript">
205 window.top.location.reload();
212 <% $cgi->redirect($redirect) %>
216 my $me = 'process.html:';
220 my $curuser = $FS::CurrentUser::CurrentUser;
223 if ( $opt{'precheck_callback'} ) {
224 $error = &{ $opt{'precheck_callback'} }( $cgi );
227 #false laziness w/edit.html
228 my $table = $opt{'table'};
229 my $class = "FS::$table";
230 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
231 my $fields = $opt{'fields'}
232 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
233 || [ fields($table) ];
235 my $old_pkey = $cgi->param($pkey);
241 'hashref' => { $pkey => $old_pkey },
242 'extra_sql' => ( $opt{'agent_virt'}
243 ? ' AND '. $curuser->agentnums_sql(
244 'null_right' => $opt{'agent_null_right'}
251 my $bfield = $opt{'bulk'};
254 map { my @entry = ( $_ => scalar($cgi->param($_)) );
255 $opt{'value_callback'} ? ( $_ => &{ $opt{'value_callback'} }( @entry ))
257 } grep { $_ ne $bfield } @$fields;
261 @values = $cgi->param($bfield);
262 #warn join(',', @values);
269 foreach my $value ( @values ) {
271 if ($opt{'skip_process'}) {
274 $new_pkey = $old_pkey;
278 $new = $class->new( \%hash );
280 $new->$bfield($value) if $bfield;
282 if ($old && exists($opt{'copy_on_empty'})) {
283 foreach my $field (@{$opt{'copy_on_empty'}}) {
284 $new->set($field, $old->get($field))
285 unless scalar($cgi->param($field));
289 if ( $opt{'post_new_object_callback'} ) {
290 &{ $opt{'post_new_object_callback'} }( $cgi, $new );
293 if ( $opt{'agent_virt'} ) {
295 if ( ! $new->agentnum
296 && ( ! $opt{'agent_null_right'}
297 || ! $curuser->access_right($opt{'agent_null_right'})
302 $error ||= 'Select an agent';
306 die "illegal agentnum"
307 unless $curuser->agentnums_href->{$new->agentnum}
308 or $curuser->access_right('View customers of all agents')
309 or $opt{'agent_null_right'}
311 && $curuser->access_right($opt{'agent_null_right'});
318 if ( !$error && $opt{'args_callback'} ) {
319 @args = &{ $opt{'args_callback'} }( $cgi, $new );
322 if ( !$error && $opt{'debug'} ) {
323 warn "$me updating record in $table table using $class class\n";
325 warn "with args: \n". Dumper(\@args) if @args;
331 &{ $opt{'edit_callback'} }( $new, $old ) if $opt{'edit_callback'};
333 $error = $new->replace($old, @args);
335 $error = $new->insert(@args);
337 $new_pkey = $new->getfield($pkey);
340 } #unless $opt{'skip_process'}
342 if ( !$error && $opt{'process_m2m'} ) {
344 my @process_m2m = ref($opt{'process_m2m'}) eq 'ARRAY'
345 ? @{ $opt{'process_m2m'} }
346 : ( $opt{'process_m2m'} );
348 foreach my $process_m2m (@process_m2m) {
350 $process_m2m->{'params'} ||= scalar($cgi->Vars);
352 warn "$me processing m2m:\n". Dumper( %$process_m2m )
355 $error ||= $new->process_m2m( %$process_m2m );
360 if ( !$error && $opt{'process_m2name'} ) {
362 my @process_m2name = ref($opt{'process_m2name'}) eq 'ARRAY'
363 ? @{ $opt{'process_m2name'} }
364 : ( $opt{'process_m2name'} );
367 foreach my $process_m2name (@process_m2name) {
369 if ( $opt{'debug'} ) {
370 warn "$me processing m2name:\n". Dumper( %{ $process_m2name },
371 'params' => scalar($cgi->Vars),
375 $error = $new->process_m2name( %{ $process_m2name },
376 'params' => scalar($cgi->Vars),
383 if ( $opt{'process_o2m'} ) {
384 @process_o2m = ref($opt{'process_o2m'}) eq 'ARRAY'
385 ? @{ $opt{'process_o2m'} }
386 : ( $opt{'process_o2m'} );
388 if ( $opt{'process_locale'} ) {
391 'table' => $table . '_msgcat',
392 'fields' => [ 'locale', $opt{'process_locale'} ],
398 foreach my $process_o2m (@process_o2m) {
400 if ( $opt{'debug'} ) {
401 warn "$me processing o2m:\n". Dumper( %{ $process_o2m },
402 'params' => scalar($cgi->Vars),
406 $error ||= $new->process_o2m( %{ $process_o2m },
407 'params' => scalar($cgi->Vars),
414 if ( !$error and $opt{'process_upload'} ) {
415 # mostly duplicates misc/file-upload.html
416 $cgi->param('upload_fields') =~ /^([,\w]+)$/
417 or $error = "invalid upload_fields";
420 my $dir = $FS::UID::cache_dir. "/cache.". $FS::UID::datasrc;
422 foreach my $field (split /,/, $fields) {
424 my $source_name = $cgi->param($field);
426 if ( $opt{'debug'} ) {
427 warn "$me processing upload: $source_name\n";
429 my $fh = $cgi->upload( $field ); # if no file provided, that's fine
433 if ( $source_name =~ /(\.\w+)$/ ) {
437 my $sh = File::Temp->new( TEMPLATE => 'upload.XXXXXXXX',
442 or $error ||= "can't open temporary file to store upload: $!\n";
447 $sh->filename =~ m!.*/([.\w]+)$!;
448 push @uploaded_files, "$field:$1";
449 if ( $opt{'debug'} ) {
450 warn "uploaded as $1\n";
455 if ( !$error and $opt{'update_svc'} ) {
457 @args = &{ $opt{'args_callback'} }( $cgi, $new ) if $opt{'args_callback'};
458 $error = &{ $opt{'update_svc'} }( $cgi, $new, @args );
463 $cgi->param('error', $error);
464 if ( $opt{'clear_on_error'} && scalar(@{$opt{'clear_on_error'}}) ) {
465 foreach my $field (@{$opt{'clear_on_error'}}) {
466 $cgi->param($field, '')
472 if ( $opt{'noerror_callback'} ) {
473 &{ $opt{'noerror_callback'} }( $cgi, $new );
482 if ($class eq "FS::tower" && !$error) {
483 foreach my $part_svc_broadband_export ( FS::tower_sector->part_export_svc_broadband ) {
484 if ($part_svc_broadband_export and $part_svc_broadband_export->can('export_tower_sector')) {
485 my $export_tower = $part_svc_broadband_export->export_tower_sector($new);
486 $error = $export_tower->{'error'} if $export_tower;
490 my $encoded_error = encode_base64($error);
491 $cgi->param('error_link', $encoded_error) if $error;
496 # set up redirect URLs
500 $opt{'redirect'} = &{$opt{'redirect'}}($cgi, $new)
501 if ref($opt{'redirect'}) eq 'CODE';
503 if ( $opt{'redirect'} ) {
505 $redirect = $opt{'redirect'} . $new_pkey;
509 my $ext = $opt{'viewall_ext'} || 'html';
510 my $viewall_dir = $opt{'viewall_dir'} || 'search';
511 my $viewall_url = $opt{'viewall_url'} || ($viewall_dir . "/$table.$ext");
513 $redirect = popurl(3) . $viewall_url;
518 my $messages = $opt{'message'} ? $opt{'message'} : '';
520 my $edit_ext = $opt{'edit_ext'} || 'html';
521 my $error_redirect = $opt{'error_redirect'}
522 || popurl(2)."$table.$edit_ext";