httemplate/edit/process/elements/process.html

   1 <%doc>
   2
   3 Example:
   4
   5  include( 'elements/process.html',
   6
   7    ###
   8    # required
   9    ###
  10
  11   'table' => 'tablename',
  12
  13    #? 'primary_key' => #required when the dbdef doesn't know...???
  14    #? 'fields' => []   #""
  15
  16    ###
  17    # optional
  18    ###
  19
  20    'viewall_dir'  => '', #'search' or 'browse', defaults to 'search'
  21    'viewall_ext'  => 'html', #'cgi' or 'html', defaults to 'html'
  22    OR
  23    'redirect'     => 'view/table.cgi?', # value of primary key is appended
  24                                         # (string or coderef returning a string)
  25    OR
  26    'popup_reload' => 'Momentary success message', #will reload parent window
  27
  28    'error_redirect' => popurl(2).'edit/table.cgi?', #query string appended
  29
  30    'edit_ext' => 'html', #defaults to 'html', you might want 'cgi' while the
  31                          #naming is still inconsistent
  32
  33    'copy_on_empty'  => [ 'old_field_name', 'another_old_field', ... ],
  34
  35    'clear_on_error' => [ 'form_field1', 'form_field2', ... ],
  36
  37                   #pass an arrayref of hashrefs for multiple m2ms or m2names
  38                   #be certain you incorporate m2m_Common if you see error: param
  39
  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)
  44                       'params'       =>
  45                     },
  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' ],
  52
  53                          'param_style' => 'link_table.value checkboxes',
  54                          #or#
  55                          'param_style' => 'name_colN values',
  56
  57
  58                        },
  59    'process_o2m' => { 'table' => table_name',
  60                       'num_col' => 'column', #if column name is different in
  61                                              #link_table than source_table
  62                     },
  63
  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 ) = @_; },
  67
  68    #after everything's inserted
  69    'noerror_callback' => sub { my( $cgi, $object ) = @_; },
  70
  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 ) = @_; },
  74
  75    'debug' => 1, #turns on debugging output
  76
  77    #agent virtualization
  78    'agent_virt'       => 1,
  79    'agent_null_right' => 'Access Right Name',
  80
  81  )
  82
  83 </%doc>
  84 %if ( $error ) {
  85 %
  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
  89 %
  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?
  96 %    });
  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";
 101 %    }
 102 %
 103 <% $cgi->redirect("$url?redirect=$session") %>
 104 %
 105 %  } else {
 106 %
 107 <% $cgi->redirect("$url?". $cgi->query_string ) %>
 108 %
 109 %  }
 110 %
 111 % #different ways of handling success
 112 %
 113 %} elsif ( $opt{'popup_reload'} ) {
 114
 115   <% include('/elements/header-popup.html', $opt{'popup_reload'} ) %>
 116
 117   <SCRIPT TYPE="text/javascript">
 118     window.top.location.reload();
 119   </SCRIPT>
 120
 121   </BODY>
 122   </HTML>
 123
 124 %} else {
 125 %
 126 %  $opt{'redirect'} = &{$opt{'redirect'}}($cgi, $new)
 127 %    if ref($opt{'redirect'}) eq 'CODE';
 128 %
 129 %  if ( $opt{'redirect'} ) {
 130 %
 131 <% $cgi->redirect( $opt{'redirect'}. $pkeyvalue ) %>
 132 %
 133 %  } else {
 134 %
 135 %    my $ext = $opt{'viewall_ext'} || 'html';
 136 %
 137 <% $cgi->redirect( popurl(3). ($opt{viewall_dir}||'search'). "/$table.$ext" ) %>
 138 %
 139 %  }
 140 %
 141 %}
 142 %
 143 <%init>
 144
 145 my $me = 'process.html:';
 146
 147 my(%opt) = @_;
 148
 149 my $curuser = $FS::CurrentUser::CurrentUser;
 150
 151 my $error = '';
 152 if ( $opt{'precheck_callback'} ) {
 153   $error = &{ $opt{'precheck_callback'} }( $cgi );
 154 }
 155
 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) ];
 163
 164 my $pkeyvalue = $cgi->param($pkey);
 165
 166 my $old = '';
 167 if ( $pkeyvalue ) {
 168   $old = qsearchs({
 169     'table'   => $table,
 170     'hashref' => { $pkey => $pkeyvalue },
 171     'extra_sql' => ( $opt{'agent_virt'}
 172                        ? ' AND '. $curuser->agentnums_sql(
 173                                     'null_right' => $opt{'agent_null_right'}
 174                                   )
 175                        : ''
 176                    ),
 177   });
 178 }
 179
 180 my %hash =
 181   map { my @entry = ( $_ => scalar($cgi->param($_)) );
 182         $opt{'value_callback'} ? ( $_ => &{ $opt{'value_callback'} }( @entry ))
 183                                : ( @entry )
 184       } @$fields;
 185
 186 my $new = $class->new( \%hash );
 187
 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));
 192   }
 193 }
 194
 195 if ( $opt{'agent_virt'} ) {
 196
 197   if ( ! $new->agentnum
 198        && (    ! $opt{'agent_null_right'}
 199             || ! $curuser->access_right($opt{'agent_null_right'})
 200           )
 201      )
 202   {
 203
 204     $error ||= 'Select an agent';
 205
 206   } else {
 207
 208     die "illegal agentnum"
 209       unless $curuser->agentnums_href->{$new->agentnum}
 210           or $opt{'agent_null_right'}
 211              && ! $new->agentnum
 212              && $curuser->access_right($opt{'agent_null_right'});
 213
 214   }
 215
 216 }
 217
 218 $error ||= $new->check;
 219
 220 my @args = ();
 221 if ( !$error && $opt{'args_callback'} ) {
 222   @args = &{ $opt{'args_callback'} }( $cgi, $new );
 223 }
 224
 225 if ( !$error && $opt{'debug'} ) {
 226   warn "$me updating record in $table table using $class class\n";
 227   warn Dumper(\%hash);
 228   warn "with args: \n". Dumper(\@args) if @args;
 229 }
 230
 231 if ( !$error ) {
 232   if ( $pkeyvalue ) {
 233     $error = $new->replace($old, @args);
 234   } else {
 235     $error = $new->insert(@args);
 236     $pkeyvalue = $new->getfield($pkey);
 237   }
 238 }
 239
 240 if ( !$error && $opt{'process_m2m'} ) {
 241
 242   my @process_m2m = ref($opt{'process_m2m'}) eq 'ARRAY'
 243                       ? @{ $opt{'process_m2m'} }
 244                       :  ( $opt{'process_m2m'} );
 245
 246   foreach my $process_m2m (@process_m2m) {
 247
 248     $process_m2m->{'params'} ||= scalar($cgi->Vars);
 249
 250     warn "$me processing m2m:\n". Dumper( %$process_m2m )
 251       if $opt{'debug'};
 252
 253     $error = $new->process_m2m( %$process_m2m );
 254   }
 255
 256 }
 257
 258 if ( !$error && $opt{'process_m2name'} ) {
 259
 260   my @process_m2name = ref($opt{'process_m2name'}) eq 'ARRAY'
 261                          ? @{ $opt{'process_m2name'} }
 262                          :  ( $opt{'process_m2name'} );
 263
 264
 265   foreach my $process_m2name (@process_m2name) {
 266
 267     if ( $opt{'debug'} ) {
 268       warn "$me processing m2name:\n". Dumper( %{ $process_m2name },
 269                                                'params' => scalar($cgi->Vars),
 270                                              );
 271     }
 272
 273     $error = $new->process_m2name( %{ $process_m2name },
 274                                    'params' => scalar($cgi->Vars),
 275                                  );
 276   }
 277
 278 }
 279
 280 if ( !$error && $opt{'process_o2m'} ) {
 281
 282   my @process_o2m = ref($opt{'process_o2m'}) eq 'ARRAY'
 283                          ? @{ $opt{'process_o2m'} }
 284                          :  ( $opt{'process_o2m'} );
 285
 286
 287   foreach my $process_o2m (@process_o2m) {
 288
 289     if ( $opt{'debug'} ) {
 290       warn "$me processing o2m:\n". Dumper( %{ $process_o2m },
 291                                                'params' => scalar($cgi->Vars),
 292                                              );
 293     }
 294
 295     $error = $new->process_o2m( %{ $process_o2m },
 296                                    'params' => scalar($cgi->Vars),
 297                                  );
 298   }
 299
 300 }
 301
 302
 303 if ( $error ) {
 304
 305   $cgi->param('error', $error);
 306   if ( $opt{'clear_on_error'} && scalar(@{$opt{'clear_on_error'}}) ) {
 307     foreach my $field (@{$opt{'clear_on_error'}}) {
 308       $cgi->param($field, '')
 309     }
 310   }
 311
 312 } else {
 313
 314   if ( $opt{'noerror_callback'} ) {
 315     &{ $opt{'noerror_callback'} }( $cgi, $new );
 316   }
 317
 318 }
 319
 320 </%init>