epic-ts
[kivitendo-erp.git] / bin / mozilla / arap.pl
index e7e2378..75764a4 100644 (file)
 # common routines for gl, ar, ap, is, ir, oe
 #
 
+use strict;
+
 # any custom scripts for this one
-if (-f "$form->{path}/custom_arap.pl") {
-  eval { require "$form->{path}/custom_arap.pl"; };
+if (-f "bin/mozilla/custom_arap.pl") {
+  eval { require "bin/mozilla/custom_arap.pl"; };
 }
-if (-f "$form->{path}/$form->{login}_arap.pl") {
-  eval { require "$form->{path}/$form->{login}_arap.pl"; };
+if (-f "bin/mozilla/$::myconfig{login}_arap.pl") {
+  eval { require "bin/mozilla/$::myconfig{login}_arap.pl"; };
 }
 
 1;
 
+require "bin/mozilla/common.pl";
+
 # end of main
 
 sub check_name {
-  $lxdebug->enter_sub();
+  $main::lxdebug->enter_sub();
 
-  my ($name) = @_;
+  my $form     = $main::form;
+  my %myconfig = %main::myconfig;
+  my $locale   = $main::locale;
 
-  my ($new_name, $new_id) = split /--/, $form->{$name};
-  my $i = 0;
+  $main::auth->assert('general_ledger               | vendor_invoice_edit       | sales_order_edit    | invoice_edit |' .
+                'request_quotation_edit       | sales_quotation_edit      | purchase_order_edit | cash         |' .
+                'purchase_delivery_order_edit | sales_delivery_order_edit');
+
+  my ($name, %params) = @_;
 
+  $name = $name eq "customer" ? "customer" : "vendor";
+
+  my ($new_name,$new_id) = $form->{$name} =~ /^(.*?)--(\d+)$/;
+  my $i = 0;
   # if we use a selection
   if ($form->{"select$name"}) {
     if ($form->{"old$name"} ne $form->{$name}) {
 
       # this is needed for is, ir and oe
-
+      $form->{update} = 0;
       # for credit calculations
       $form->{oldinvtotal}  = 0;
       $form->{oldtotalpaid} = 0;
@@ -63,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');
 
@@ -76,6 +92,7 @@ sub check_name {
     if ($form->{"old$name"} ne qq|$form->{$name}--$form->{"${name}_id"}|) {
 
       # this is needed for is, ir and oe
+      $form->{update} = 0;
 
       # for credit calculations
       $form->{oldinvtotal}  = 0;
@@ -83,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) {
@@ -95,19 +120,25 @@ 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');
 
       } else {
 
         # name is not on file
-        $msg = ucfirst $name . " not on file or locked!";
+        # $locale->text('Customer not on file or locked!')
+        # $locale->text('Vendor not on file or locked!')
+        my $msg = ucfirst $name . " not on file or locked!";
         $form->error($locale->text($msg));
       }
     }
   }
+  $form->language_payment(\%myconfig);
 
-  $lxdebug->leave_sub();
+  $main::lxdebug->leave_sub();
 
   return $i;
 }
@@ -116,13 +147,20 @@ sub check_name {
 # $locale->text('Vendor not on file!')
 
 sub select_name {
-  $lxdebug->enter_sub();
+  $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 | sales_delivery_order_edit |' .
+                'request_quotation_edit | sales_quotation_edit | purchase_order_edit | cash');
 
   my ($table) = @_;
 
-  @column_index = qw(ndx name address);
+  my @column_index = qw(ndx name address);
 
-  $label             = ucfirst $table;
+  my $label             = ucfirst $table;
+  my %column_data;
   $column_data{ndx}  = qq|<th>&nbsp;</th>|;
   $column_data{name} =
     qq|<th class=listheading>| . $locale->text($label) . qq|</th>|;
@@ -132,32 +170,29 @@ sub select_name {
   # list items with radio button on a form
   $form->header;
 
-  $title = $locale->text('Select from one of the names below');
+  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%>
-       <tr class=listheading>|;
+        <tr class=listheading>|;
 
   map { print "\n$column_data{$_}" } @column_index;
 
   print qq|
-       </tr>
+        </tr>
 |;
 
   my $i = 0;
-  foreach $ref (@{ $form->{name_list} }) {
-    $checked = ($i++) ? "" : "checked";
+  my $j;
+  foreach my $ref (@{ $form->{name_list} }) {
+    my $checked = ($i++) ? "" : "checked";
 
     $ref->{name} =~ s/\"/&quot;/g;
 
@@ -170,12 +205,12 @@ sub select_name {
     $j++;
     $j %= 2;
     print qq|
-       <tr class=listrow$j>|;
+        <tr class=listrow$j>|;
 
     map { print "\n$column_data{$_}" } @column_index;
 
     print qq|
-       </tr>
+        </tr>
 
 <input name="new_id_$i" type=hidden value=$ref->{id}>
 
@@ -200,7 +235,8 @@ sub select_name {
   map { delete $form->{$_} } qw(action name_list header);
 
   # save all other form variables
-  foreach $key (keys %${form}) {
+  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|;
   }
@@ -213,21 +249,26 @@ sub select_name {
 <input class=submit type=submit name=action value="|
     . $locale->text('Continue') . qq|">
 </form>
-
-</body>
-</html>
 |;
 
-  $lxdebug->leave_sub();
+  $main::lxdebug->leave_sub();
 }
 
 sub name_selected {
-  $lxdebug->enter_sub();
+  $main::lxdebug->enter_sub();
+
+  my $form     = $main::form;
+  my %myconfig = %main::myconfig;
+
+  $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
 
   # index for new item
-  $i = $form->{ndx};
+  my $i = $form->{ndx};
+
+  _reset_salesman_id();
 
   $form->{ $form->{vc} }    = $form->{"new_name_$i"};
   $form->{"$form->{vc}_id"} = $form->{"new_id_$i"};
@@ -236,7 +277,7 @@ sub name_selected {
 
   # delete all the new_ variables
   for $i (1 .. $form->{lastndx}) {
-    map { delete $form->{"new_${_}_$i"} } (id, name);
+    map { delete $form->{"new_${_}_$i"} } qw(id name);
   }
 
   map { delete $form->{$_} } qw(ndx lastndx nextsub);
@@ -246,203 +287,201 @@ sub name_selected {
 
   &update(1);
 
-  $lxdebug->leave_sub();
+  $main::lxdebug->leave_sub();
 }
 
-sub add_transaction {
-  $lxdebug->enter_sub();
+# 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};
+}
 
-  my ($module) = @_;
+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');
 
-  delete $form->{script};
-  $form->{action} = "add";
-  $form->{type}   = "invoice" if $module =~ /(is|ir)/;
+  my ($is_global, $nextsub) = @_;
+  my $project_list = delete $::form->{project_list};
 
-  $form->{callback} = $form->escape($form->{callback}, 1);
-  map { $argv .= "$_=$form->{$_}&" } keys %$form;
+  map { delete $::form->{$_} } qw(action header update);
 
-  $form->{callback} = "$module.pl?$argv";
+  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->redirect;
+  $::form->header;
+  print $::form->parse_html_template('arap/select_project', { hiddens => \@hiddens, project_list => $project_list });
 
-  $lxdebug->leave_sub();
+  $::lxdebug->leave_sub;
 }
 
-sub check_project {
-  $lxdebug->enter_sub();
+sub project_selected {
+  $main::lxdebug->enter_sub();
 
-  for $i (1 .. $form->{rowcount}) {
-    $form->{"project_id_$i"} = "" unless $form->{"projectnumber_$i"};
-    if ($form->{"projectnumber_$i"} ne $form->{"oldprojectnumber_$i"}) {
-      if ($form->{"projectnumber_$i"}) {
+  my $form     = $main::form;
 
-        # get new project
-        $form->{projectnumber} = $form->{"projectnumber_$i"};
-        if (($rows = PE->projects(\%myconfig, $form)) > 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');
 
-          # check form->{project_list} how many there are
-          $form->{rownumber} = $i;
-          &select_project;
-          exit;
-        }
+  # replace the variable with the one checked
 
-        if ($rows == 1) {
-          $form->{"project_id_$i"}    = $form->{project_list}->[0]->{id};
-          $form->{"projectnumber_$i"} =
-            $form->{project_list}->[0]->{projectnumber};
-          $form->{"oldprojectnumber_$i"} =
-            $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->{"oldprojectnumber_$i"} = "";
-      }
-    }
+  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);
   }
 
-  $lxdebug->leave_sub();
+  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 {
-  $lxdebug->enter_sub();
+sub continue       { call_sub($main::form->{"nextsub"}); }
 
-  @column_index = qw(ndx projectnumber description);
+1;
 
-  $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>|;
+__END__
 
-  # list items with radio button on a form
-  $form->header;
+=head1 NAME
 
-  $title = $locale->text('Select from one of the projects below');
+arap.pl - helper functions or customer/vendor retrieval
 
-  print qq|
-<body>
+=head1 SYNOPSIS
 
-<form method=post action=$form->{script}>
+ check_name('vendor')
 
-<input type=hidden name=rownumber value=$form->{rownumber}>
+=head1 DESCRIPTION
 
-<table width=100%>
-  <tr>
-    <th class=listtop>$title</th>
-  </tr>
-  <tr space=5></tr>
-  <tr>
-    <td>
-      <table width=100%>
-       <tr class=listheading>|;
+Don't use anyting in this file without extreme care, and even then be prepared for massive headaches.
 
-  map { print "\n$column_data{$_}" } @column_index;
+It's a collection of helper routines that wrap the customer/vendor dropdown/textfield duality into something even complexer.
 
-  print qq|
-        </tr>
-|;
+=head1 FUNCTIONS
 
-  my $i = 0;
-  foreach $ref (@{ $form->{project_list} }) {
-    $checked = ($i++) ? "" : "checked";
+=head2 check_name customer|vendor
 
-    $ref->{name} =~ s/\"/&quot;/g;
+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.
 
-    $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>|;
+What it does is:
 
-    $j++;
-    $j %= 2;
-    print qq|
-        <tr class=listrow$j>|;
+=over 4
 
-    map { print "\n$column_data{$_}" } @column_index;
+=item *
 
-    print qq|
-        </tr>
+It checks if a vendor or customer is given. No failsafe, vendor fallback if
+$_[0] is something fancy.
 
-<input name="new_id_$i" type=hidden value=$ref->{id}>
+=item *
 
-|;
+It assumes, that there is a field named customer or vendor in $form.
 
-  }
+=item *
 
-  print qq|
-      </table>
-    </td>
-  </tr>
-  <tr>
-    <td><hr size=3 noshade></td>
-  </tr>
-</table>
+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.
 
-<input name=lastndx type=hidden value=$i>
+=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)
 
-  # delete action variable
-  map { delete $form->{$_} } qw(action project_list header);
+=item *
 
-  # save all other form variables
-  foreach $key (keys %${form}) {
-    $form->{$key} =~ s/\"/&quot;/g;
-    print qq|<input name=$key type=hidden value="$form->{$key}">\n|;
-  }
+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.
 
-  print qq|
-<input type=hidden name=nextsub value=project_selected>
+=item *
 
-<br>
-<input class=submit type=submit name=action value="|
-    . $locale->text('Continue') . qq|">
-</form>
+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.
 
-</body>
-</html>
-|;
+=item *
 
-  $lxdebug->leave_sub();
-}
+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)
 
-sub project_selected {
-  $lxdebug->enter_sub();
+=item *
 
-  # replace the variable with the one checked
+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.
 
-  # index for new item
-  $i = $form->{ndx};
+=item *
 
-  $form->{"projectnumber_$form->{rownumber}"} =
-    $form->{"new_projectnumber_$i"};
-  $form->{"oldprojectnumber_$form->{rownumber}"} =
-    $form->{"new_projectnumber_$i"};
-  $form->{"project_id_$form->{rownumber}"} = $form->{"new_id_$i"};
+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.
 
-  # delete all the new_ variables
-  for $i (1 .. $form->{lastndx}) {
-    map { delete $form->{"new_${_}_$i"} } qw(id projectnumber description);
-  }
+=item *
 
-  map { delete $form->{$_} } qw(ndx lastndx nextsub);
+The results are stored in $form>{name_list} but a count is returned, and
+checked.
 
-  if ($form->{update}) {
-    &{ $form->{update} };
-  } else {
-    &update;
-  }
+=item *
 
-  $lxdebug->leave_sub();
-}
+If only one result was found, *_id, * and old* are copied into $form, the entry
+is loaded (like above, clobbering)
+
+=item *
+
+If there is more than one, a selection dialog is rendered
+
+=item *
+
+If none is found, an error is generated.
+
+=back
+
+=head3 I built a customer/vendor box somewhere and it doesn't work, what's wrong?
+
+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.
+
+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.
 
-sub continue       { &{ $form->{nextsub} } }
-sub gl_transaction { &add }
-sub ar_transaction { &add_transaction(ar) }
-sub ap_transaction { &add_transaction(ap) }
-sub sales_invoice  { &add_transaction(is) }
-sub vendor_invoice { &add_transaction(ir) }
+Otherwise you'll have to care to include a complete state in callback.
 
+=cut