epic-ts
[kivitendo-erp.git] / bin / mozilla / arap.pl
index 0278aa5..75764a4 100644 (file)
 # common routines for gl, ar, ap, is, ir, oe
 #
 
-use SL::Projects;
-
 use strict;
 
 # any custom scripts for this one
 if (-f "bin/mozilla/custom_arap.pl") {
   eval { require "bin/mozilla/custom_arap.pl"; };
 }
-if (-f "bin/mozilla/$main::form->{login}_arap.pl") {
-  eval { require "bin/mozilla/$main::form->{login}_arap.pl"; };
+if (-f "bin/mozilla/$::myconfig{login}_arap.pl") {
+  eval { require "bin/mozilla/$::myconfig{login}_arap.pl"; };
 }
 
 1;
@@ -59,11 +57,11 @@ sub check_name {
                 'request_quotation_edit       | sales_quotation_edit      | purchase_order_edit | cash         |' .
                 'purchase_delivery_order_edit | sales_delivery_order_edit');
 
-  my ($name) = @_;
+  my ($name, %params) = @_;
 
   $name = $name eq "customer" ? "customer" : "vendor";
 
-  my ($new_name, $new_id) = split /--/, $form->{$name};
+  my ($new_name,$new_id) = $form->{$name} =~ /^(.*?)--(\d+)$/;
   my $i = 0;
   # if we use a selection
   if ($form->{"select$name"}) {
@@ -78,6 +76,9 @@ sub check_name {
 
       $form->{"${name}_id"} = $new_id;
 
+      _reset_salesman_id();
+      delete @{ $form }{qw(payment_id)};
+
       IS->get_customer(\%myconfig, \%$form) if ($name eq 'customer');
       IR->get_vendor(\%myconfig, \%$form) if ($name eq 'vendor');
 
@@ -99,9 +100,17 @@ sub check_name {
       $form->{calctax}      = 1;
 
       # return one name or a list of names in $form->{name_list}
-      if (($i = $form->get_name(\%myconfig, $name)) > 1) {
-        &select_name($name);
-        exit;
+      $i = $form->get_name(\%myconfig, $name);
+
+      if ($i > 1) {
+        if ($params{no_select}) {
+          # $locale->text('Customer')
+          # $locale->text('Vendor')
+          $form->error($locale->text("More than one #1 found matching, please be more specific.", $locale->text(ucfirst $name)));
+        } else {
+          &select_name($name);
+          ::end_of_request();
+        }
       }
 
       if ($i == 1) {
@@ -111,6 +120,9 @@ sub check_name {
         $form->{$name}        = $form->{name_list}[0]->{name};
         $form->{"old$name"}   = qq|$form->{$name}--$form->{"${name}_id"}|;
 
+        _reset_salesman_id();
+        delete @{ $form }{qw(payment_id)};
+
         IS->get_customer(\%myconfig, \%$form) if ($name eq 'customer');
         IR->get_vendor(\%myconfig, \%$form) if ($name eq 'vendor');
 
@@ -140,7 +152,7 @@ sub select_name {
   my $form     = $main::form;
   my $locale   = $main::locale;
 
-  $main::auth->assert('general_ledger         | vendor_invoice_edit  | sales_order_edit    | invoice_edit |' .
+  $main::auth->assert('general_ledger         | vendor_invoice_edit  | sales_order_edit    | invoice_edit | sales_delivery_order_edit |' .
                 'request_quotation_edit | sales_quotation_edit | purchase_order_edit | cash');
 
   my ($table) = @_;
@@ -161,15 +173,11 @@ sub select_name {
   my $title = $locale->text('Select from one of the names below');
 
   print qq|
-<body>
+    <h1>$title</h1>
 
 <form method=post action=$form->{script}>
 
 <table width=100%>
-  <tr>
-    <th class=listtop>$title</th>
-  </tr>
-  <tr space=5></tr>
   <tr>
     <td>
       <table width=100%>
@@ -241,9 +249,6 @@ sub select_name {
 <input class=submit type=submit name=action value="|
     . $locale->text('Continue') . qq|">
 </form>
-
-</body>
-</html>
 |;
 
   $main::lxdebug->leave_sub();
@@ -255,7 +260,7 @@ sub name_selected {
   my $form     = $main::form;
   my %myconfig = %main::myconfig;
 
-  $main::auth->assert('general_ledger         | vendor_invoice_edit  | sales_order_edit    | invoice_edit |' .
+  $main::auth->assert('general_ledger         | vendor_invoice_edit  | sales_order_edit    | invoice_edit | sales_delivery_order_edit | ' .
                 'request_quotation_edit | sales_quotation_edit | purchase_order_edit | cash');
 
   # replace the variable with the one checked
@@ -263,6 +268,8 @@ sub name_selected {
   # index for new item
   my $i = $form->{ndx};
 
+  _reset_salesman_id();
+
   $form->{ $form->{vc} }    = $form->{"new_name_$i"};
   $form->{"$form->{vc}_id"} = $form->{"new_id_$i"};
   $form->{"old$form->{vc}"} =
@@ -283,206 +290,198 @@ sub name_selected {
   $main::lxdebug->leave_sub();
 }
 
-sub check_project {
+# Reset the $::form field 'salesman_id' to the ID of the currently
+# logged in user. Useful when changing to a customer/vendor that has
+# no salesman listed in their master data.
+sub _reset_salesman_id {
+  my $current_employee   = SL::DB::Manager::Employee->current;
+  $::form->{salesman_id} = $current_employee->id if $current_employee && exists $::form->{salesman_id};
+}
+
+sub select_project {
+  $::lxdebug->enter_sub;
+
+  $::auth->assert('general_ledger         | vendor_invoice_edit  | sales_order_edit    | invoice_edit |' .
+                  'request_quotation_edit | sales_quotation_edit | purchase_order_edit | cash         | report');
+
+  my ($is_global, $nextsub) = @_;
+  my $project_list = delete $::form->{project_list};
+
+  map { delete $::form->{$_} } qw(action header update);
+
+  my @hiddens;
+  for my $key (keys %$::form) {
+    next if $key eq 'login' || $key eq 'password' || '' ne ref $::form->{$key};
+    push @hiddens, { key => $key, value => $::form->{$key} };
+  }
+  push @hiddens, { key => 'is_global',                value => $is_global },
+                 { key => 'project_selected_nextsub', value => $nextsub };
+
+  $::form->header;
+  print $::form->parse_html_template('arap/select_project', { hiddens => \@hiddens, project_list => $project_list });
+
+  $::lxdebug->leave_sub;
+}
+
+sub project_selected {
   $main::lxdebug->enter_sub();
 
   my $form     = $main::form;
-  my $locale   = $main::locale;
 
   $main::auth->assert('general_ledger         | vendor_invoice_edit  | sales_order_edit    | invoice_edit |' .
                 'request_quotation_edit | sales_quotation_edit | purchase_order_edit | cash         | report');
 
-  my $nextsub = shift || 'update';
-
-  for my $i (1 .. $form->{rowcount}) {
-    my $suffix = $i ? "_$i" : "";
-    my $prefix = $i ? "" : "global";
-    $form->{"${prefix}project_id${suffix}"} = "" unless $form->{"${prefix}projectnumber$suffix"};
-    if ($form->{"${prefix}projectnumber${suffix}"} ne $form->{"old${prefix}projectnumber${suffix}"}) {
-      if ($form->{"${prefix}projectnumber${suffix}"}) {
-
-        # get new project
-        $form->{projectnumber} = $form->{"${prefix}projectnumber${suffix}"};
-        my %params             = map { $_ => $form->{$_} } qw(projectnumber description active);
-        my $rows;
-        if (($rows = Projects->search_projects(%params)) > 1) {
-
-          # check form->{project_list} how many there are
-          $form->{rownumber} = $i;
-          &select_project($i ? undef : 1, $nextsub);
-          exit;
-        }
+  # replace the variable with the one checked
 
-        if ($rows == 1) {
-          $form->{"${prefix}project_id${suffix}"}       = $form->{project_list}->[0]->{id};
-          $form->{"${prefix}projectnumber${suffix}"}    = $form->{project_list}->[0]->{projectnumber};
-          $form->{"old${prefix}projectnumber${suffix}"} = $form->{project_list}->[0]->{projectnumber};
-        } else {
+  # index for new item
+  my $i = $form->{ndx};
 
-          # not on file
-          $form->error($locale->text('Project not on file!'));
-        }
-      } else {
-        $form->{"old${prefix}projectnumber${suffix}"} = "";
-      }
-    }
+  my $prefix = $form->{"is_global"} ? "global" : "";
+  my $suffix = $form->{"is_global"} ? "" : "_$form->{rownumber}";
+
+  $form->{"${prefix}projectnumber${suffix}"} =
+    $form->{"new_projectnumber_$i"};
+  $form->{"old${prefix}projectnumber${suffix}"} =
+    $form->{"new_projectnumber_$i"};
+  $form->{"${prefix}project_id${suffix}"} = $form->{"new_id_$i"};
+
+  # delete all the new_ variables
+  for $i (1 .. $form->{lastndx}) {
+    map { delete $form->{"new_${_}_$i"} } qw(id projectnumber description);
   }
 
+  my $nextsub = $form->{project_selected_nextsub} || 'update';
+
+  map { delete $form->{$_} } qw(ndx lastndx nextsub is_global project_selected_nextsub);
+
+  call_sub($nextsub);
+
   $main::lxdebug->leave_sub();
 }
 
-sub select_project {
-  $main::lxdebug->enter_sub();
+sub continue       { call_sub($main::form->{"nextsub"}); }
 
-  my $form     = $main::form;
-  my $locale   = $main::locale;
-  my $cgi      = $main::cgi;
+1;
 
-  $main::auth->assert('general_ledger         | vendor_invoice_edit  | sales_order_edit    | invoice_edit |' .
-                'request_quotation_edit | sales_quotation_edit | purchase_order_edit | cash         | report');
+__END__
 
-  my ($is_global, $nextsub) = @_;
+=head1 NAME
 
-  my @column_index = qw(ndx projectnumber description);
+arap.pl - helper functions or customer/vendor retrieval
 
-  my %column_data;
-  $column_data{ndx}           = qq|<th>&nbsp;</th>|;
-  $column_data{projectnumber} = qq|<th>| . $locale->text('Number') . qq|</th>|;
-  $column_data{description}   =
-    qq|<th>| . $locale->text('Description') . qq|</th>|;
+=head1 SYNOPSIS
 
-  # list items with radio button on a form
-  $form->header;
+ check_name('vendor')
 
-  my $title = $locale->text('Select from one of the projects below');
+=head1 DESCRIPTION
 
-  print qq|
-<body>
+Don't use anyting in this file without extreme care, and even then be prepared for massive headaches.
 
-<form method=post action=$form->{script}>
+It's a collection of helper routines that wrap the customer/vendor dropdown/textfield duality into something even complexer.
 
-<input type=hidden name=rownumber value=$form->{rownumber}>
+=head1 FUNCTIONS
 
-<table width=100%>
-  <tr>
-    <th class=listtop>$title</th>
-  </tr>
-  <tr space=5></tr>
-  <tr>
-    <td>
-      <table width=100%>
-        <tr class=listheading>|;
+=head2 check_name customer|vendor
 
-  map { print "\n$column_data{$_}" } @column_index;
+check_name was originally meant to update the selected customer or vendor. The
+way it does that has generted more hate than almost any other part of this
+software.
 
-  print qq|
-        </tr>
-|;
+What it does is:
 
-  my $i = 0;
-  my $j;
-  foreach my $ref (@{ $form->{project_list} }) {
-    my $checked = ($i++) ? "" : "checked";
+=over 4
 
-    $ref->{name} =~ s/\"/&quot;/g;
+=item *
 
-    $column_data{ndx} =
-      qq|<td><input name=ndx class=radio type=radio value=$i $checked></td>|;
-    $column_data{projectnumber} =
-      qq|<td><input name="new_projectnumber_$i" type=hidden value="$ref->{projectnumber}">$ref->{projectnumber}</td>|;
-    $column_data{description} = qq|<td>$ref->{description}</td>|;
+It checks if a vendor or customer is given. No failsafe, vendor fallback if
+$_[0] is something fancy.
 
-    $j++;
-    $j %= 2;
-    print qq|
-        <tr class=listrow$j>|;
+=item *
 
-    map { print "\n$column_data{$_}" } @column_index;
+It assumes, that there is a field named customer or vendor in $form.
 
-    print qq|
-        </tr>
+=item *
 
-<input name="new_id_$i" type=hidden value=$ref->{id}>
+It assumes, that this field is filled with name--id, and tries to split that.
+sql ledger uses that combination to get ids into the select keys.
 
-|;
+=item *
 
-  }
+It looks for a field selectcustomer or selectvendor in $form. sql ledger used
+to store a copy of the html select in there. (again, don't ask)
 
-  print qq|
-      </table>
-    </td>
-  </tr>
-  <tr>
-    <td><hr size=3 noshade></td>
-  </tr>
-</table>
+=item *
 
-<input name=lastndx type=hidden value=$i>
+If this field exists, it looks for a field called oldcustomer or oldvendor, in
+which the old name--id string was stored in sql ledger, and compares those.
 
-|;
+=item *
 
-  # delete action variable
-  map { delete $form->{$_} } qw(action project_list header update);
+if they don't match, it will set customer_id or vendor_id in $form, load the
+entry (which will clobber everything in $form named like a column in customer
+oder vendor) and return.
 
-  # save all other form variables
-  foreach my $key (keys %${form}) {
-    next if (($key eq 'login') || ($key eq 'password') || ('' ne ref $form->{$key}));
-    $form->{$key} =~ s/\"/&quot;/g;
-    print qq|<input name=$key type=hidden value="$form->{$key}">\n|;
-  }
+=item *
 
-  print
-      $cgi->hidden('-name' => 'is_global',                '-default' => [$is_global])
-    . $cgi->hidden('-name' => 'project_selected_nextsub', '-default' => [$nextsub])
-    . qq|<input type=hidden name=nextsub value=project_selected>
+If there was no select* entry, it assumes that vclimit was lower than the
+number of entries, and that an input field was generated. In that case the
+splitting is omitted (since users don't generally include ids in entered names)
 
-<br>
-<input class=submit type=submit name=action value="|
-    . $locale->text('Continue') . qq|">
-</form>
+=item *
 
-</body>
-</html>
-|;
+It looks for a *_id field, and combines it with the given input into a name--id
+entry and compares it to the old* entry. (Missing any of these will instantly
+break check_namea.
 
-  $main::lxdebug->leave_sub();
-}
+=item *
 
-sub project_selected {
-  $main::lxdebug->enter_sub();
+If those do not match, $form->get_name is called to get matching results.
+get_name only matches by *number and name, not by id, don't try to get it to do
+so.
 
-  my $form     = $main::form;
+=item *
 
-  $main::auth->assert('general_ledger         | vendor_invoice_edit  | sales_order_edit    | invoice_edit |' .
-                'request_quotation_edit | sales_quotation_edit | purchase_order_edit | cash         | report');
+The results are stored in $form>{name_list} but a count is returned, and
+checked.
 
-  # replace the variable with the one checked
+=item *
 
-  # index for new item
-  my $i = $form->{ndx};
+If only one result was found, *_id, * and old* are copied into $form, the entry
+is loaded (like above, clobbering)
 
-  my $prefix = $form->{"is_global"} ? "global" : "";
-  my $suffix = $form->{"is_global"} ? "" : "_$form->{rownumber}";
+=item *
 
-  $form->{"${prefix}projectnumber${suffix}"} =
-    $form->{"new_projectnumber_$i"};
-  $form->{"old${prefix}projectnumber${suffix}"} =
-    $form->{"new_projectnumber_$i"};
-  $form->{"${prefix}project_id${suffix}"} = $form->{"new_id_$i"};
+If there is more than one, a selection dialog is rendered
 
-  # delete all the new_ variables
-  for $i (1 .. $form->{lastndx}) {
-    map { delete $form->{"new_${_}_$i"} } qw(id projectnumber description);
-  }
+=item *
 
-  my $nextsub = $form->{project_selected_nextsub} || 'update';
+If none is found, an error is generated.
 
-  map { delete $form->{$_} } qw(ndx lastndx nextsub is_global project_selected_nextsub);
+=back
 
-  call_sub($nextsub);
+=head3 I built a customer/vendor box somewhere and it doesn't work, what's wrong?
 
-  $main::lxdebug->leave_sub();
-}
+Make sure a select* field is given if and only if you render a select box. The
+actual contents are ignored, but recognition fails if not present.
 
-sub continue       { call_sub($main::form->{"nextsub"}); }
+Make sure old* and *_id fields are set correctly (name--id form for old*). They
+are necessary in all steps and branches.
+
+Since get_customer and get_vendor clobber a lot of fields, make sure what
+changes exactly.
+
+=head3 select- version works fine, but things go awry when I use a textbox, any idea?
+
+If there is more than one match, check_name will display a select form, that
+will redirect to the original C<nextsub>. Unfortunately any hidden vars or
+input fields will be lost in the process unless saved before in a callback.
+
+If you still want to use it, you can disable this feature, like this:
+
+  check_name('customer', no_select => 1)
+
+In that case multiple matches will trigger an error.
+
+Otherwise you'll have to care to include a complete state in callback.
 
+=cut