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 #after everything's inserted
69 'noerror_callback' => sub { my( $cgi, $object ) = @_; },
71 #supplies arguments to insert() and replace()
72 # for use with tables that are FS::option_Common (among other things)
73 'args_callback' => sub { my( $cgi, $object ) = @_; },
75 'debug' => 1, #turns on debugging output
79 'agent_null_right' => 'Access Right Name',
86 % my $edit_ext = $opt{'edit_ext'} || 'html';
87 % my $url = $opt{'error_redirect'} || popurl(2)."$table.$edit_ext";
88 % if ( length($cgi->query_string) > 1920 ) { #stupid IE 2083 URL limit
90 % my $session = int(rand(4294967296)); #XXX
91 % my $pref = new FS::access_user_pref({
92 % 'usernum' => $FS::CurrentUser::CurrentUser->usernum,
93 % 'prefname' => "redirect$session",
94 % 'prefvalue' => $cgi->query_string,
95 % 'expiration' => time + 3600, #1h? 1m?
97 % my $pref_error = $pref->insert;
98 % if ( $pref_error ) {
99 % die "FATAL: couldn't even set redirect cookie: $pref_error".
100 % " attempting to set redirect$session to ". $cgi->query_string."\n";
103 <% $cgi->redirect("$url?redirect=$session") %>
107 <% $cgi->redirect("$url?". $cgi->query_string ) %>
111 % #different ways of handling success
113 %} elsif ( $opt{'popup_reload'} ) {
115 <% include('/elements/header-popup.html', $opt{'popup_reload'} ) %>
117 <SCRIPT TYPE="text/javascript">
118 window.top.location.reload();
126 % $opt{'redirect'} = &{$opt{'redirect'}}($cgi, $new)
127 % if ref($opt{'redirect'}) eq 'CODE';
129 % if ( $opt{'redirect'} ) {
131 <% $cgi->redirect( $opt{'redirect'}. $pkeyvalue ) %>
135 % my $ext = $opt{'viewall_ext'} || 'html';
137 <% $cgi->redirect( popurl(3). ($opt{viewall_dir}||'search'). "/$table.$ext" ) %>
145 my $me = 'process.html:';
149 my $curuser = $FS::CurrentUser::CurrentUser;
152 if ( $opt{'precheck_callback'} ) {
153 $error = &{ $opt{'precheck_callback'} }( $cgi );
156 #false laziness w/edit.html
157 my $table = $opt{'table'};
158 my $class = "FS::$table";
159 my $pkey = dbdef->table($table)->primary_key; #? $opt{'primary_key'} ||
160 my $fields = $opt{'fields'}
161 #|| [ grep { $_ ne $pkey } dbdef->table($table)->columns ];
162 || [ fields($table) ];
164 my $pkeyvalue = $cgi->param($pkey);
170 'hashref' => { $pkey => $pkeyvalue },
171 'extra_sql' => ( $opt{'agent_virt'}
172 ? ' AND '. $curuser->agentnums_sql(
173 'null_right' => $opt{'agent_null_right'}
181 map { my @entry = ( $_ => scalar($cgi->param($_)) );
182 $opt{'value_callback'} ? ( $_ => &{ $opt{'value_callback'} }( @entry ))
186 my $new = $class->new( \%hash );
188 if ($old && exists($opt{'copy_on_empty'})) {
189 foreach my $field (@{$opt{'copy_on_empty'}}) {
190 $new->set($field, $old->get($field))
191 unless scalar($cgi->param($field));
195 if ( $opt{'agent_virt'} ) {
197 if ( ! $new->agentnum
198 && ( ! $opt{'agent_null_right'}
199 || ! $curuser->access_right($opt{'agent_null_right'})
204 $error ||= 'Select an agent';
208 die "illegal agentnum"
209 unless $curuser->agentnums_href->{$new->agentnum}
210 or $curuser->access_right('View customers of all agents')
211 or $opt{'agent_null_right'}
213 && $curuser->access_right($opt{'agent_null_right'});
219 $error ||= $new->check;
222 if ( !$error && $opt{'args_callback'} ) {
223 @args = &{ $opt{'args_callback'} }( $cgi, $new );
226 if ( !$error && $opt{'debug'} ) {
227 warn "$me updating record in $table table using $class class\n";
229 warn "with args: \n". Dumper(\@args) if @args;
234 $error = $new->replace($old, @args);
236 $error = $new->insert(@args);
237 $pkeyvalue = $new->getfield($pkey);
241 if ( !$error && $opt{'process_m2m'} ) {
243 my @process_m2m = ref($opt{'process_m2m'}) eq 'ARRAY'
244 ? @{ $opt{'process_m2m'} }
245 : ( $opt{'process_m2m'} );
247 foreach my $process_m2m (@process_m2m) {
249 $process_m2m->{'params'} ||= scalar($cgi->Vars);
251 warn "$me processing m2m:\n". Dumper( %$process_m2m )
254 $error = $new->process_m2m( %$process_m2m );
259 if ( !$error && $opt{'process_m2name'} ) {
261 my @process_m2name = ref($opt{'process_m2name'}) eq 'ARRAY'
262 ? @{ $opt{'process_m2name'} }
263 : ( $opt{'process_m2name'} );
266 foreach my $process_m2name (@process_m2name) {
268 if ( $opt{'debug'} ) {
269 warn "$me processing m2name:\n". Dumper( %{ $process_m2name },
270 'params' => scalar($cgi->Vars),
274 $error = $new->process_m2name( %{ $process_m2name },
275 'params' => scalar($cgi->Vars),
281 if ( !$error && $opt{'process_o2m'} ) {
283 my @process_o2m = ref($opt{'process_o2m'}) eq 'ARRAY'
284 ? @{ $opt{'process_o2m'} }
285 : ( $opt{'process_o2m'} );
288 foreach my $process_o2m (@process_o2m) {
290 if ( $opt{'debug'} ) {
291 warn "$me processing o2m:\n". Dumper( %{ $process_o2m },
292 'params' => scalar($cgi->Vars),
296 $error = $new->process_o2m( %{ $process_o2m },
297 'params' => scalar($cgi->Vars),
306 $cgi->param('error', $error);
307 if ( $opt{'clear_on_error'} && scalar(@{$opt{'clear_on_error'}}) ) {
308 foreach my $field (@{$opt{'clear_on_error'}}) {
309 $cgi->param($field, '')
315 if ( $opt{'noerror_callback'} ) {
316 &{ $opt{'noerror_callback'} }( $cgi, $new );