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 #return an error string or empty for no error
89 'post_new_object_callback' => sub { my( $cgi, $object ) = @_; },
91 #run right before replacing (not run for inserts)
92 'edit_callback' => sub { my( $new, $old ) = @_; },
94 #after everything's inserted
95 'noerror_callback' => sub { my( $cgi, $object ) = @_; },
97 #supplies arguments to insert() and replace()
98 # for use with tables that are FS::option_Common (among other things)
99 'args_callback' => sub { my( $cgi, $object ) = @_; },
101 # if no errors after package insert or replace will update services attached to package.
102 'update_svc' => sub { my( $cgi, $object ) = @_; },
104 'debug' => 1, #turns on debugging output
106 #agent virtualization
108 'agent_null_right' => 'Access Right Name',
110 #special bulk insert mode
117 % ## flatten any array refs so multi selects are sticky on error
118 % for my $param ($cgi->param) {
119 % if (ref($cgi->param($param)) eq "ARRAY") {
120 % $cgi->param($param, (join ",", @{$cgi->param($param)}));
124 % #my $query = $m->scomp('/elements/create_uri_query');
125 % #$cgi->redirect("$url?$query");
126 % if ( length($cgi->query_string) > 1920 ) { #stupid IE 2083 URL limit
128 % my $session = int(rand(4294967296)); #XXX
129 % my $pref = new FS::access_user_pref({
130 % 'usernum' => $FS::CurrentUser::CurrentUser->usernum,
131 % 'prefname' => "redirect$session",
132 % 'prefvalue' => $cgi->query_string,
133 % 'expiration' => time + 3600, #1h? 1m?
135 % my $pref_error = $pref->insert;
136 % if ( $pref_error ) {
137 % die "FATAL: couldn't even set redirect cookie: $pref_error".
138 % " attempting to set redirect$session to ". $cgi->query_string."\n";
141 <% $cgi->redirect("$error_redirect?redirect=$session") %>
145 <% $cgi->redirect("$error_redirect?". $cgi->query_string ) %>
149 % #different ways of handling success
151 %} elsif ( $opt{'process_upload'} and @uploaded_files ) {
153 % # construct a form to pass all the requested fields, the
155 <& /elements/header.html &>
156 <form name="UploadForm">
157 % my $job_fields = $opt{'process_upload'}{'fields'};
158 % foreach my $field ( @$job_fields ) {
159 <input type="hidden" name="<% $field %>" value="<% $cgi->param($field) |h %>">
161 % push @$job_fields, 'uploaded_files', $pkey;
163 <input type="hidden" name="uploaded_files" value="<% join(',', @uploaded_files) %>">
164 <input type="hidden" name="<% $pkey %>" value="<% $new->get($pkey) %>">
165 <& /elements/progress-init.html,
168 $fsurl . $opt{'process_upload'}{'process'},
171 error_url => "$error_redirect?$new_pkey"
174 <input type="submit" style="display:none">
177 <&| /elements/onload.js &>
181 <& /elements/footer.html &>
183 % } elsif ( $opt{'progress_init'} ) {
184 % # some false laziness with the above
185 % my ($form_name, $job_fields) = @{ $opt{'progress_init'} };
186 <form name="<% $form_name %>">
187 <input type="hidden" name="<% $pkey %>" value="<% $new->get($pkey) %>">
188 % foreach my $field (@$job_fields) {
189 % next if $field eq $pkey;
190 <input type="hidden" name="<% $field %>" value="<% $cgi->param($field) |h %>">
192 <& /elements/progress-init.html,
193 @{ $opt{'progress_init'} }
195 <input type="submit" style="display:none">
198 <&| /elements/onload.js &>
202 <& /elements/footer.html &>
204 % } elsif ( $opt{'popup_reload'} ) {
206 <% include('/elements/header-popup.html', $opt{'popup_reload'} ) %>
208 <SCRIPT TYPE="text/javascript">
217 % $cookie = CGI::Cookie->new(
218 % -name => 'freeside_status',
219 % -value => $messages,
222 <% $cgi->redirect( -uri => $redirect,
229 my $me = 'process.html:';
233 my $curuser = $FS::CurrentUser::CurrentUser;
236 if ( $opt{'precheck_callback'} ) {
237 $error = &{ $opt{'precheck_callback'} }( $cgi );
240 #false laziness w/edit.html
241 my $table = $opt{'table'};
242 my $class = "FS::$table";
243 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
244 my $fields = $opt{'fields'}
245 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
246 || [ fields($table) ];
248 my $old_pkey = $cgi->param($pkey);
254 'hashref' => { $pkey => $old_pkey },
255 'extra_sql' => ( $opt{'agent_virt'}
256 ? ' AND '. $curuser->agentnums_sql(
257 'null_right' => $opt{'agent_null_right'}
264 my $bfield = $opt{'bulk'};
267 map { my @entry = ( $_ => scalar($cgi->param($_)) );
268 $opt{'value_callback'} ? ( $_ => &{ $opt{'value_callback'} }( @entry ))
270 } grep { $_ ne $bfield } @$fields;
274 @values = $cgi->param($bfield);
275 #warn join(',', @values);
282 foreach my $value ( @values ) {
284 if ($opt{'skip_process'}) {
287 $new_pkey = $old_pkey;
291 $new = $class->new( \%hash );
293 $new->$bfield($value) if $bfield;
295 if ($old && exists($opt{'copy_on_empty'})) {
296 foreach my $field (@{$opt{'copy_on_empty'}}) {
297 $new->set($field, $old->get($field))
298 unless scalar($cgi->param($field));
302 if ( $opt{'post_new_object_callback'} ) {
303 $error ||= &{ $opt{'post_new_object_callback'} }( $cgi, $new );
306 if ( $opt{'agent_virt'} ) {
308 if ( ! $new->agentnum
309 && ( ! $opt{'agent_null_right'}
310 || ! $curuser->access_right($opt{'agent_null_right'})
315 $error ||= 'Select an agent';
319 die "illegal agentnum"
320 unless $curuser->agentnums_href->{$new->agentnum}
321 or $curuser->access_right('View customers of all agents')
322 or $opt{'agent_null_right'}
324 && $curuser->access_right($opt{'agent_null_right'});
331 if ( !$error && $opt{'args_callback'} ) {
332 @args = &{ $opt{'args_callback'} }( $cgi, $new );
335 if ( !$error && $opt{'debug'} ) {
336 warn "$me updating record in $table table using $class class\n";
338 warn "with args: \n". Dumper(\@args) if @args;
344 &{ $opt{'edit_callback'} }( $new, $old ) if $opt{'edit_callback'};
346 $error = $new->replace($old, @args);
348 $error = $new->insert(@args);
350 $new_pkey = $new->getfield($pkey);
353 } #unless $opt{'skip_process'}
355 if ( !$error && $opt{'process_m2m'} ) {
357 my @process_m2m = ref($opt{'process_m2m'}) eq 'ARRAY'
358 ? @{ $opt{'process_m2m'} }
359 : ( $opt{'process_m2m'} );
361 foreach my $process_m2m (@process_m2m) {
363 $process_m2m->{'params'} ||= scalar($cgi->Vars);
365 warn "$me processing m2m:\n". Dumper( %$process_m2m )
368 $error ||= $new->process_m2m( %$process_m2m );
373 if ( !$error && $opt{'process_m2name'} ) {
375 my @process_m2name = ref($opt{'process_m2name'}) eq 'ARRAY'
376 ? @{ $opt{'process_m2name'} }
377 : ( $opt{'process_m2name'} );
380 foreach my $process_m2name (@process_m2name) {
382 if ( $opt{'debug'} ) {
383 warn "$me processing m2name:\n". Dumper( %{ $process_m2name },
384 'params' => scalar($cgi->Vars),
388 $error = $new->process_m2name( %{ $process_m2name },
389 'params' => scalar($cgi->Vars),
396 if ( $opt{'process_o2m'} ) {
397 @process_o2m = ref($opt{'process_o2m'}) eq 'ARRAY'
398 ? @{ $opt{'process_o2m'} }
399 : ( $opt{'process_o2m'} );
401 if ( $opt{'process_locale'} ) {
404 'table' => $table . '_msgcat',
405 'fields' => [ 'locale', $opt{'process_locale'} ],
411 foreach my $process_o2m (@process_o2m) {
413 if ( $opt{'debug'} ) {
414 warn "$me processing o2m:\n". Dumper( %{ $process_o2m },
415 'params' => scalar($cgi->Vars),
419 $error ||= $new->process_o2m( %{ $process_o2m },
420 'params' => scalar($cgi->Vars),
427 if ( !$error and $opt{'process_upload'} ) {
428 # mostly duplicates misc/file-upload.html
429 $cgi->param('upload_fields') =~ /^([,\w]+)$/
430 or $error = "invalid upload_fields";
433 my $dir = $FS::UID::cache_dir. "/cache.". $FS::UID::datasrc;
435 foreach my $field (split /,/, $fields) {
437 my $source_name = $cgi->param($field);
439 if ( $opt{'debug'} ) {
440 warn "$me processing upload: $source_name\n";
442 my $fh = $cgi->upload( $field ); # if no file provided, that's fine
446 if ( $source_name =~ /(\.\w+)$/ ) {
450 my $sh = File::Temp->new( TEMPLATE => 'upload.XXXXXXXX',
455 or $error ||= "can't open temporary file to store upload: $!\n";
460 $sh->filename =~ m!.*/([.\w]+)$!;
461 push @uploaded_files, "$field:$1";
462 if ( $opt{'debug'} ) {
463 warn "uploaded as $1\n";
468 if ( !$error and $opt{'update_svc'} ) {
470 @args = &{ $opt{'args_callback'} }( $cgi, $new ) if $opt{'args_callback'};
471 $error = &{ $opt{'update_svc'} }( $cgi, $new, @args );
476 if ($opt{'update_svc'}) {
477 my $encoded_error = encode_base64($error);
478 $cgi->param('error_link', $encoded_error);
480 $cgi->param('error', $error);
483 if ( $opt{'clear_on_error'} && scalar(@{$opt{'clear_on_error'}}) ) {
484 foreach my $field (@{$opt{'clear_on_error'}}) {
485 $cgi->param($field, '')
491 if ( $opt{'noerror_callback'} ) {
492 &{ $opt{'noerror_callback'} }( $cgi, $new );
501 if ($class eq "FS::tower" && !$error) {
502 foreach my $part_svc_broadband_export ( FS::tower_sector->part_export_svc_broadband ) {
503 if ($part_svc_broadband_export and $part_svc_broadband_export->can('export_tower_sector')) {
504 my $export_tower = $part_svc_broadband_export->export_tower_sector($new);
505 $error = $export_tower->{'error'} if $export_tower;
509 my $encoded_error = encode_base64($error);
510 $cgi->param('error_link', $encoded_error) if $error;
515 # set up redirect URLs
519 $opt{'redirect'} = &{$opt{'redirect'}}($cgi, $new)
520 if ref($opt{'redirect'}) eq 'CODE';
522 if ( $opt{'redirect'} ) {
524 $redirect = $opt{'redirect'} . $new_pkey;
528 my $ext = $opt{'viewall_ext'} || 'html';
529 my $viewall_dir = $opt{'viewall_dir'} || 'search';
530 my $viewall_url = $opt{'viewall_url'} || ($viewall_dir . "/$table.$ext");
532 $redirect = popurl(3) . $viewall_url;
537 my $messages = $opt{'message'} ? $opt{'message'} : '';
539 my $edit_ext = $opt{'edit_ext'} || 'html';
540 my $error_redirect = $opt{'error_redirect'}
541 || popurl(2)."$table.$edit_ext";