# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1335, USA.
#======================================================================
#
# common routines for gl, ar, ap, is, ir, oe
#
+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/$form->{login}_arap.pl") {
- eval { require "bin/mozilla/$form->{login}_arap.pl"; };
+if (-f "bin/mozilla/$::myconfig{login}_arap.pl") {
+ eval { require "bin/mozilla/$::myconfig{login}_arap.pl"; };
}
1;
# end of main
sub check_name {
- $lxdebug->enter_sub();
+ $main::lxdebug->enter_sub();
+
+ my $form = $main::form;
+ my %myconfig = %main::myconfig;
+ my $locale = $main::locale;
- my ($name) = @_;
+ $main::auth->assert('ar_transactions | ap_transactions | 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) = split /--/, $form->{$name};
+ my ($new_name,$new_id) = $form->{$name} =~ /^(.*?)--(\d+)$/;
my $i = 0;
# if we use a selection
if ($form->{"select$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');
$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);
+ $::dispatcher->end_request;
+ }
}
if ($i == 1) {
$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');
# name is not on file
# $locale->text('Customer not on file or locked!')
# $locale->text('Vendor not on file or locked!')
- $msg = ucfirst $name . " 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;
}
# $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('ar_transactions| ap_transactions | 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> </th>|;
$column_data{name} =
qq|<th class=listheading>| . $locale->text($label) . qq|</th>|;
# 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/\"/"/g;
$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}>
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/\"/"/g;
print qq|<input name=$key type=hidden value="$form->{$key}">\n|;
}
<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('ar_transactions | ap_transactions | 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();
+ delete @{ $form }{qw(payment_id)};
$form->{ $form->{vc} } = $form->{"new_name_$i"};
$form->{"$form->{vc}_id"} = $form->{"new_id_$i"};
&update(1);
- $lxdebug->leave_sub();
+ $main::lxdebug->leave_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};
}
-sub add_transaction {
- $lxdebug->enter_sub();
+sub select_project {
+ $::lxdebug->enter_sub;
- my ($module) = @_;
+ $::auth->assert('ar_transactions | ap_transactions | 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}) {
- 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}"}) {
+ my $form = $main::form;
- # get new project
- $form->{projectnumber} = $form->{"${prefix}projectnumber${suffix}"};
- if (($rows = PE->projects(\%myconfig, $form)) > 1) {
+ $main::auth->assert('ar_transactions | ap_transactions | 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($i ? undef : 1);
- 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);
}
- $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"}); }
- my ($is_global) = @_;
+1;
- @column_index = qw(ndx projectnumber description);
+__END__
- $column_data{ndx} = qq|<th> </th>|;
- $column_data{projectnumber} = qq|<th>| . $locale->text('Number') . qq|</th>|;
- $column_data{description} =
- qq|<th>| . $locale->text('Description') . qq|</th>|;
+=head1 NAME
- # list items with radio button on a form
- $form->header;
+arap.pl - helper functions or customer/vendor retrieval
- $title = $locale->text('Select from one of the projects below');
+=head1 SYNOPSIS
- print qq|
-<body>
+ check_name('vendor')
-<form method=post action=$form->{script}>
+=head1 DESCRIPTION
-<input type=hidden name=rownumber value=$form->{rownumber}>
+Don't use anyting in this file without extreme care, and even then be prepared for massive headaches.
-<table width=100%>
- <tr>
- <th class=listtop>$title</th>
- </tr>
- <tr space=5></tr>
- <tr>
- <td>
- <table width=100%>
- <tr class=listheading>|;
+It's a collection of helper routines that wrap the customer/vendor dropdown/textfield duality into something even complexer.
- map { print "\n$column_data{$_}" } @column_index;
+=head1 FUNCTIONS
- print qq|
- </tr>
-|;
+=head2 check_name customer|vendor
- my $i = 0;
- foreach $ref (@{ $form->{project_list} }) {
- $checked = ($i++) ? "" : "checked";
+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.
- $ref->{name} =~ s/\"/"/g;
+What it does is:
- $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>|;
+=over 4
- $j++;
- $j %= 2;
- print qq|
- <tr class=listrow$j>|;
+=item *
- map { print "\n$column_data{$_}" } @column_index;
+It checks if a vendor or customer is given. No failsafe, vendor fallback if
+$_[0] is something fancy.
- print qq|
- </tr>
+=item *
-<input name="new_id_$i" type=hidden value=$ref->{id}>
+It assumes, that there is a field named customer or vendor in $form.
-|;
+=item *
- }
+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.
- print qq|
- </table>
- </td>
- </tr>
- <tr>
- <td><hr size=3 noshade></td>
- </tr>
-</table>
+=item *
-<input name=lastndx type=hidden value=$i>
+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)
-|;
+=item *
- # delete action variable
- map { delete $form->{$_} } qw(action project_list header update);
+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.
- # save all other form variables
- foreach $key (keys %${form}) {
- $form->{$key} =~ s/\"/"/g;
- print qq|<input name=$key type=hidden value="$form->{$key}">\n|;
- }
+=item *
- print qq|
-<input type="hidden" name="is_global" value="$is_global">
-<input type=hidden name=nextsub value=project_selected>
+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.
-<br>
-<input class=submit type=submit name=action value="|
- . $locale->text('Continue') . qq|">
-</form>
+=item *
-</body>
-</html>
-|;
+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)
- $lxdebug->leave_sub();
-}
+=item *
-sub project_selected {
- $lxdebug->enter_sub();
+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.
- # replace the variable with the one checked
+=item *
- # index for new item
- $i = $form->{ndx};
+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 $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"};
+The results are stored in $form>{name_list} but a count is returned, and
+checked.
- # 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 is_global);
+If only one result was found, *_id, * and old* are copied into $form, the entry
+is loaded (like above, clobbering)
- if ($form->{update}) {
- call_sub($form->{"update"});
- } else {
- &update;
- }
+=item *
- $lxdebug->leave_sub();
-}
+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 { call_sub($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