1 #=====================================================================
4 # Based on SQL-Ledger Version 2.1.9
5 # Web http://www.lx-office.org
7 #=====================================================================
8 # SQL-Ledger Accounting
11 # Author: Dieter Simader
12 # Email: dsimader@sql-ledger.org
13 # Web: http://www.sql-ledger.org
16 # This program is free software; you can redistribute it and/or modify
17 # it under the terms of the GNU General Public License as published by
18 # the Free Software Foundation; either version 2 of the License, or
19 # (at your option) any later version.
21 # This program is distributed in the hope that it will be useful,
22 # but WITHOUT ANY WARRANTY; without even the implied warranty of
23 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 # GNU General Public License for more details.
25 # You should have received a copy of the GNU General Public License
26 # along with this program; if not, write to the Free Software
27 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
28 #======================================================================
30 # common routines for gl, ar, ap, is, ir, oe
35 # any custom scripts for this one
36 if (-f "bin/mozilla/custom_arap.pl") {
37 eval { require "bin/mozilla/custom_arap.pl"; };
39 if (-f "bin/mozilla/$::myconfig{login}_arap.pl") {
40 eval { require "bin/mozilla/$::myconfig{login}_arap.pl"; };
45 require "bin/mozilla/common.pl";
50 $main::lxdebug->enter_sub();
52 my $form = $main::form;
53 my %myconfig = %main::myconfig;
54 my $locale = $main::locale;
56 $main::auth->assert('general_ledger | vendor_invoice_edit | sales_order_edit | invoice_edit |' .
57 'request_quotation_edit | sales_quotation_edit | purchase_order_edit | cash |' .
58 'purchase_delivery_order_edit | sales_delivery_order_edit');
60 my ($name, %params) = @_;
62 $name = $name eq "customer" ? "customer" : "vendor";
64 my ($new_name,$new_id) = $form->{$name} =~ /^(.*?)--(\d+)$/;
66 # if we use a selection
67 if ($form->{"select$name"}) {
68 if ($form->{"old$name"} ne $form->{$name}) {
70 # this is needed for is, ir and oe
72 # for credit calculations
73 $form->{oldinvtotal} = 0;
74 $form->{oldtotalpaid} = 0;
77 $form->{"${name}_id"} = $new_id;
80 delete @{ $form }{qw(payment_id)};
82 IS->get_customer(\%myconfig, \%$form) if ($name eq 'customer');
83 IR->get_vendor(\%myconfig, \%$form) if ($name eq 'vendor');
85 $form->{$name} = $form->{"old$name"} = "$new_name--$new_id";
91 # check name, combine name and id
92 if ($form->{"old$name"} ne qq|$form->{$name}--$form->{"${name}_id"}|) {
94 # this is needed for is, ir and oe
97 # for credit calculations
98 $form->{oldinvtotal} = 0;
99 $form->{oldtotalpaid} = 0;
100 $form->{calctax} = 1;
102 # return one name or a list of names in $form->{name_list}
103 $i = $form->get_name(\%myconfig, $name);
106 if ($params{no_select}) {
107 # $locale->text('Customer')
108 # $locale->text('Vendor')
109 $form->error($locale->text("More than one #1 found matching, please be more specific.", $locale->text(ucfirst $name)));
119 $form->{"${name}_id"} = $form->{name_list}[0]->{id};
120 $form->{$name} = $form->{name_list}[0]->{name};
121 $form->{"old$name"} = qq|$form->{$name}--$form->{"${name}_id"}|;
123 _reset_salesman_id();
124 delete @{ $form }{qw(payment_id)};
126 IS->get_customer(\%myconfig, \%$form) if ($name eq 'customer');
127 IR->get_vendor(\%myconfig, \%$form) if ($name eq 'vendor');
131 # name is not on file
132 # $locale->text('Customer not on file or locked!')
133 # $locale->text('Vendor not on file or locked!')
134 my $msg = ucfirst $name . " not on file or locked!";
135 $form->error($locale->text($msg));
139 $form->language_payment(\%myconfig);
141 $main::lxdebug->leave_sub();
146 # $locale->text('Customer not on file!')
147 # $locale->text('Vendor not on file!')
150 $main::lxdebug->enter_sub();
152 my $form = $main::form;
153 my $locale = $main::locale;
155 $main::auth->assert('general_ledger | vendor_invoice_edit | sales_order_edit | invoice_edit | sales_delivery_order_edit |' .
156 'request_quotation_edit | sales_quotation_edit | purchase_order_edit | cash');
160 my @column_index = qw(ndx name address);
162 my $label = ucfirst $table;
164 $column_data{ndx} = qq|<th> </th>|;
166 qq|<th class=listheading>| . $locale->text($label) . qq|</th>|;
167 $column_data{address} =
168 qq|<th class=listheading>| . $locale->text('Address') . qq|</th>|;
170 # list items with radio button on a form
173 my $title = $locale->text('Select from one of the names below');
178 <form method=post action=$form->{script}>
184 <tr class=listheading>|;
186 map { print "\n$column_data{$_}" } @column_index;
194 foreach my $ref (@{ $form->{name_list} }) {
195 my $checked = ($i++) ? "" : "checked";
197 $ref->{name} =~ s/\"/"/g;
200 qq|<td><input name=ndx class=radio type=radio value=$i $checked></td>|;
202 qq|<td><input name="new_name_$i" type=hidden value="$ref->{name}">$ref->{name}</td>|;
203 $column_data{address} = qq|<td>$ref->{address} </td>|;
208 <tr class=listrow$j>|;
210 map { print "\n$column_data{$_}" } @column_index;
215 <input name="new_id_$i" type=hidden value=$ref->{id}>
226 <td><hr size=3 noshade></td>
230 <input name=lastndx type=hidden value=$i>
235 map { delete $form->{$_} } qw(action name_list header);
237 # save all other form variables
238 foreach my $key (keys %${form}) {
239 next if (($key eq 'login') || ($key eq 'password') || ('' ne ref $form->{$key}));
240 $form->{$key} =~ s/\"/"/g;
241 print qq|<input name=$key type=hidden value="$form->{$key}">\n|;
245 <input type=hidden name=nextsub value=name_selected>
247 <input type=hidden name=vc value=$table>
249 <input class=submit type=submit name=action value="|
250 . $locale->text('Continue') . qq|">
254 $main::lxdebug->leave_sub();
258 $main::lxdebug->enter_sub();
260 my $form = $main::form;
261 my %myconfig = %main::myconfig;
263 $main::auth->assert('general_ledger | vendor_invoice_edit | sales_order_edit | invoice_edit | sales_delivery_order_edit | ' .
264 'request_quotation_edit | sales_quotation_edit | purchase_order_edit | cash');
266 # replace the variable with the one checked
269 my $i = $form->{ndx};
271 _reset_salesman_id();
273 $form->{ $form->{vc} } = $form->{"new_name_$i"};
274 $form->{"$form->{vc}_id"} = $form->{"new_id_$i"};
275 $form->{"old$form->{vc}"} =
276 qq|$form->{$form->{vc}}--$form->{"$form->{vc}_id"}|;
278 # delete all the new_ variables
279 for $i (1 .. $form->{lastndx}) {
280 map { delete $form->{"new_${_}_$i"} } qw(id name);
283 map { delete $form->{$_} } qw(ndx lastndx nextsub);
285 IS->get_customer(\%myconfig, \%$form) if ($form->{vc} eq 'customer');
286 IR->get_vendor(\%myconfig, \%$form) if ($form->{vc} eq 'vendor');
290 $main::lxdebug->leave_sub();
293 # Reset the $::form field 'salesman_id' to the ID of the currently
294 # logged in user. Useful when changing to a customer/vendor that has
295 # no salesman listed in their master data.
296 sub _reset_salesman_id {
297 my $current_employee = SL::DB::Manager::Employee->current;
298 $::form->{salesman_id} = $current_employee->id if $current_employee && exists $::form->{salesman_id};
302 $::lxdebug->enter_sub;
304 $::auth->assert('general_ledger | vendor_invoice_edit | sales_order_edit | invoice_edit |' .
305 'request_quotation_edit | sales_quotation_edit | purchase_order_edit | cash | report');
307 my ($is_global, $nextsub) = @_;
308 my $project_list = delete $::form->{project_list};
310 map { delete $::form->{$_} } qw(action header update);
313 for my $key (keys %$::form) {
314 next if $key eq 'login' || $key eq 'password' || '' ne ref $::form->{$key};
315 push @hiddens, { key => $key, value => $::form->{$key} };
317 push @hiddens, { key => 'is_global', value => $is_global },
318 { key => 'project_selected_nextsub', value => $nextsub };
321 print $::form->parse_html_template('arap/select_project', { hiddens => \@hiddens, project_list => $project_list });
323 $::lxdebug->leave_sub;
326 sub project_selected {
327 $main::lxdebug->enter_sub();
329 my $form = $main::form;
331 $main::auth->assert('general_ledger | vendor_invoice_edit | sales_order_edit | invoice_edit |' .
332 'request_quotation_edit | sales_quotation_edit | purchase_order_edit | cash | report');
334 # replace the variable with the one checked
337 my $i = $form->{ndx};
339 my $prefix = $form->{"is_global"} ? "global" : "";
340 my $suffix = $form->{"is_global"} ? "" : "_$form->{rownumber}";
342 $form->{"${prefix}projectnumber${suffix}"} =
343 $form->{"new_projectnumber_$i"};
344 $form->{"old${prefix}projectnumber${suffix}"} =
345 $form->{"new_projectnumber_$i"};
346 $form->{"${prefix}project_id${suffix}"} = $form->{"new_id_$i"};
348 # delete all the new_ variables
349 for $i (1 .. $form->{lastndx}) {
350 map { delete $form->{"new_${_}_$i"} } qw(id projectnumber description);
353 my $nextsub = $form->{project_selected_nextsub} || 'update';
355 map { delete $form->{$_} } qw(ndx lastndx nextsub is_global project_selected_nextsub);
359 $main::lxdebug->leave_sub();
362 sub continue { call_sub($main::form->{"nextsub"}); }
370 arap.pl - helper functions or customer/vendor retrieval
378 Don't use anyting in this file without extreme care, and even then be prepared for massive headaches.
380 It's a collection of helper routines that wrap the customer/vendor dropdown/textfield duality into something even complexer.
384 =head2 check_name customer|vendor
386 check_name was originally meant to update the selected customer or vendor. The
387 way it does that has generted more hate than almost any other part of this
396 It checks if a vendor or customer is given. No failsafe, vendor fallback if
397 $_[0] is something fancy.
401 It assumes, that there is a field named customer or vendor in $form.
405 It assumes, that this field is filled with name--id, and tries to split that.
406 sql ledger uses that combination to get ids into the select keys.
410 It looks for a field selectcustomer or selectvendor in $form. sql ledger used
411 to store a copy of the html select in there. (again, don't ask)
415 If this field exists, it looks for a field called oldcustomer or oldvendor, in
416 which the old name--id string was stored in sql ledger, and compares those.
420 if they don't match, it will set customer_id or vendor_id in $form, load the
421 entry (which will clobber everything in $form named like a column in customer
422 oder vendor) and return.
426 If there was no select* entry, it assumes that vclimit was lower than the
427 number of entries, and that an input field was generated. In that case the
428 splitting is omitted (since users don't generally include ids in entered names)
432 It looks for a *_id field, and combines it with the given input into a name--id
433 entry and compares it to the old* entry. (Missing any of these will instantly
438 If those do not match, $form->get_name is called to get matching results.
439 get_name only matches by *number and name, not by id, don't try to get it to do
444 The results are stored in $form>{name_list} but a count is returned, and
449 If only one result was found, *_id, * and old* are copied into $form, the entry
450 is loaded (like above, clobbering)
454 If there is more than one, a selection dialog is rendered
458 If none is found, an error is generated.
462 =head3 I built a customer/vendor box somewhere and it doesn't work, what's wrong?
464 Make sure a select* field is given if and only if you render a select box. The
465 actual contents are ignored, but recognition fails if not present.
467 Make sure old* and *_id fields are set correctly (name--id form for old*). They
468 are necessary in all steps and branches.
470 Since get_customer and get_vendor clobber a lot of fields, make sure what
473 =head3 select- version works fine, but things go awry when I use a textbox, any idea?
475 If there is more than one match, check_name will display a select form, that
476 will redirect to the original C<nextsub>. Unfortunately any hidden vars or
477 input fields will be lost in the process unless saved before in a callback.
479 If you still want to use it, you can disable this feature, like this:
481 check_name('customer', no_select => 1)
483 In that case multiple matches will trigger an error.
485 Otherwise you'll have to care to include a complete state in callback.