5 include( '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
64 #checks CGI params and whatever else before much else runs
65 #return an error string or empty for no error
66 'precheck_callback' => sub { my( $cgi ) = @_; },
68 #supplies arguments to insert() and replace()
69 # for use with tables that are FS::option_Common (among other things)
70 'args_callback' => sub { my( $cgi, $object ) = @_; },
72 'debug' => 1, #turns on debugging output
76 'agent_null_right' => 'Access Right Name',
83 % my $edit_ext = $opt{'edit_ext'} || 'html';
84 % my $url = $opt{'error_redirect'} || popurl(2)."$table.$edit_ext";
85 % if ( length($cgi->query_string) > 1920 ) { #stupid IE 2083 URL limit
87 % my $session = int(rand(4294967296)); #XXX
88 % my $pref = new FS::access_user_pref({
89 % 'usernum' => $FS::CurrentUser::CurrentUser->usernum,
90 % 'prefname' => "redirect$session",
91 % 'prefvalue' => $cgi->query_string,
92 % 'expiration' => time + 3600, #1h? 1m?
94 % my $pref_error = $pref->insert;
95 % if ( $pref_error ) {
96 % die "FATAL: couldn't even set redirect cookie: $pref_error".
97 % " attempting to set redirect$session to ". $cgi->query_string."\n";
100 <% $cgi->redirect("$url?redirect=$session") %>
104 <% $cgi->redirect("$url?". $cgi->query_string ) %>
108 % #different ways of handling success
110 %} elsif ( $opt{'popup_reload'} ) {
112 <% include('/elements/header-popup.html', $opt{'popup_reload'} ) %>
114 <SCRIPT TYPE="text/javascript">
115 window.top.location.reload();
123 % $opt{'redirect'} = &{$opt{'redirect'}}($cgi, $new)
124 % if ref($opt{'redirect'}) eq 'CODE';
126 % if ( $opt{'redirect'} ) {
128 <% $cgi->redirect( $opt{'redirect'}. $pkeyvalue ) %>
132 % my $ext = $opt{'viewall_ext'} || 'html';
134 <% $cgi->redirect( popurl(3). ($opt{viewall_dir}||'search'). "/$table.$ext" ) %>
142 my $me = 'process.html:';
146 my $curuser = $FS::CurrentUser::CurrentUser;
149 if ( $opt{'precheck_callback'} ) {
150 $error = &{ $opt{'precheck_callback'} }( $cgi );
153 #false laziness w/edit.html
154 my $table = $opt{'table'};
155 my $class = "FS::$table";
156 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
157 my $fields = $opt{'fields'}
158 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
159 || [ fields($table) ];
161 my $pkeyvalue = $cgi->param($pkey);
167 'hashref' => { $pkey => $pkeyvalue },
168 'extra_sql' => ( $opt{'agent_virt'}
169 ? ' AND '. $curuser->agentnums_sql(
170 'null_right' => $opt{'agent_null_right'}
178 map { my @entry = ( $_ => scalar($cgi->param($_)) );
179 $opt{'value_callback'} ? ( $_ => &{ $opt{'value_callback'} }( @entry ))
183 my $new = $class->new( \%hash );
185 if ($old && exists($opt{'copy_on_empty'})) {
186 foreach my $field (@{$opt{'copy_on_empty'}}) {
187 $new->set($field, $old->get($field))
188 unless scalar($cgi->param($field));
192 if ( $opt{'agent_virt'} ) {
194 if ( ! $new->agentnum
195 && ( ! $opt{'agent_null_right'}
196 || ! $curuser->access_right($opt{'agent_null_right'})
201 $error ||= 'Select an agent';
205 die "illegal agentnum"
206 unless $curuser->agentnums_href->{$new->agentnum}
207 or $opt{'agent_null_right'}
209 && $curuser->access_right($opt{'agent_null_right'});
215 $error ||= $new->check;
218 if ( !$error && $opt{'args_callback'} ) {
219 @args = &{ $opt{'args_callback'} }( $cgi, $new );
222 if ( !$error && $opt{'debug'} ) {
223 warn "$me updating record in $table table using $class class\n";
225 warn "with args: \n". Dumper(\@args) if @args;
230 $error = $new->replace($old, @args);
232 $error = $new->insert(@args);
233 $pkeyvalue = $new->getfield($pkey);
237 if ( !$error && $opt{'process_m2m'} ) {
239 my @process_m2m = ref($opt{'process_m2m'}) eq 'ARRAY'
240 ? @{ $opt{'process_m2m'} }
241 : ( $opt{'process_m2m'} );
243 foreach my $process_m2m (@process_m2m) {
245 $process_m2m->{'params'} ||= scalar($cgi->Vars);
247 warn "$me processing m2m:\n". Dumper( %$process_m2m )
250 $error = $new->process_m2m( %$process_m2m );
255 if ( !$error && $opt{'process_m2name'} ) {
257 my @process_m2name = ref($opt{'process_m2name'}) eq 'ARRAY'
258 ? @{ $opt{'process_m2name'} }
259 : ( $opt{'process_m2name'} );
262 foreach my $process_m2name (@process_m2name) {
264 if ( $opt{'debug'} ) {
265 warn "$me processing m2name:\n". Dumper( %{ $process_m2name },
266 'params' => scalar($cgi->Vars),
270 $error = $new->process_m2name( %{ $process_m2name },
271 'params' => scalar($cgi->Vars),
277 if ( !$error && $opt{'process_o2m'} ) {
279 my @process_o2m = ref($opt{'process_o2m'}) eq 'ARRAY'
280 ? @{ $opt{'process_o2m'} }
281 : ( $opt{'process_o2m'} );
284 foreach my $process_o2m (@process_o2m) {
286 if ( $opt{'debug'} ) {
287 warn "$me processing o2m:\n". Dumper( %{ $process_o2m },
288 'params' => scalar($cgi->Vars),
292 $error = $new->process_o2m( %{ $process_o2m },
293 'params' => scalar($cgi->Vars),
301 $cgi->param('error', $error);
302 if ( $opt{'clear_on_error'} && scalar(@{$opt{'clear_on_error'}}) ) {
303 foreach my $field (@{$opt{'clear_on_error'}}) {
304 $cgi->param($field, '')