1327b2161b67e13cdcc7b9fa9e37315f40956916
[kivitendo-erp.git] / bin / mozilla / vk.pl
1 #=====================================================================
2 # LX-Office ERP
3 # Copyright (C) 2004
4 # Based on SQL-Ledger Version 2.1.9
5 # Web http://www.lx-office.org
6 #
7 #=====================================================================
8 # SQL-Ledger Accounting
9 # Copyright (c) 2001
10 #
11 #  Author: Dieter Simader
12 #   Email: dsimader@sql-ledger.org
13 #     Web: http://www.sql-ledger.org
14 #
15 #
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.
20 #
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 #======================================================================
29 #
30 # Sales report
31 #
32 #======================================================================
33
34 use POSIX qw(strftime);
35 use List::Util qw(sum first);
36
37 use SL::VK;
38 use SL::IS;
39 use SL::ReportGenerator;
40 use Data::Dumper;
41
42 require "bin/mozilla/arap.pl";
43 require "bin/mozilla/common.pl";
44 require "bin/mozilla/drafts.pl";
45 require "bin/mozilla/reportgenerator.pl";
46
47 use strict;
48
49
50 sub search_invoice {
51   $main::lxdebug->enter_sub();
52   $main::auth->assert('general_ledger | invoice_edit');
53
54   my $form     = $main::form;
55   my %myconfig = %main::myconfig;
56   my $locale   = $main::locale;
57   my $cgi      = $main::cgi;
58
59   my ($customer, $department);
60
61   # setup customer selection
62   $form->all_vc(\%myconfig, "customer", "AR");
63
64   $form->{title}    = $locale->text('Sales Report');
65   $form->{jsscript} = 1;
66
67   $form->get_lists("projects"     => { "key" => "ALL_PROJECTS", "all" => 1 },
68                    "departments"  => "ALL_DEPARTMENTS",
69                    "customers"    => "ALL_VC");
70
71   $form->{vc_keys}   = sub { "$_[0]->{name}--$_[0]->{id}" };
72
73   $form->header;
74   print $form->parse_html_template('vk/search_invoice', { %myconfig });
75
76   $main::lxdebug->leave_sub();
77 }
78
79 sub invoice_transactions {
80   $main::lxdebug->enter_sub();
81
82   $main::auth->assert('general_ledger | invoice_edit');
83
84   my $form     = $main::form;
85   my %myconfig = %main::myconfig;
86   my $locale   = $main::locale;
87
88   my ($callback, $href, @columns);
89
90   if ( $form->{customer} =~ /--/ ) {
91     # Felddaten kommen aus Dropdownbox
92     ($form->{customername}, $form->{customer_id}) = split(/--/, $form->{customer});
93   } elsif ($form->{customer}) {
94     # es wurde ein Wert im Freitextfeld übergeben, auf Eindeutigkeit überprüfen
95
96     # check_name wird mit no_select => 1 ausgeführt, ist die Abfrage nicht eindeutig kommt ein Fehler
97     # und die Abfrage muß erneut ausgeführt werden
98
99     # Ohne no_select kommt bei Auswahl des Kunden ein Aufruf von update der ins
100     # Nichts führt, daher diese Zwischenlösung
101
102     &check_name('customer', no_select => 1);
103   
104     # $form->{customer_id} wurde schon von check_name gesetzt
105     $form->{customername} = $form->{customer};
106   };
107   # ist $form->{customer} leer passiert hier nichts weiter
108
109   # decimalplaces überprüfen oder auf Default 2 setzen
110   $form->{decimalplaces} = 2 unless $form->{decimalplaces} > 0 && $form->{decimalplaces} < 6;
111
112 #  report_generator_set_default_sort('transdate', 1);
113
114   VK->invoice_transactions(\%myconfig, \%$form);
115
116   # anhand von radio button die Sortierreihenfolge festlegen
117   if ($form->{sortby} eq 'artikelsort') {
118     $form->{'mainsort'} = 'parts_id';
119     $form->{'subsort'}  = 'name';
120   } else {
121     $form->{'mainsort'} = 'name';
122     $form->{'subsort'}  = 'parts_id';
123   };
124
125   $form->{title} = $locale->text('Sales Report');
126
127   @columns =
128     qw(description invnumber transdate customernumber partnumber transdate qty unit sellprice sellprice_total discount lastcost lastcost_total marge_total marge_percent);
129
130   # hidden variables für pdf/csv export übergeben
131   # einmal mit l_ um zu bestimmen welche Spalten ausgegeben werden sollen
132   # einmal optionen für die Überschrift (z.B. transdatefrom, partnumber, ...)
133   my @hidden_variables  = (qw(l_headers l_subtotal l_total l_customernumber transdatefrom transdateto decimalplaces customer customername customer_id department partnumber description project_id customernumber), "$form->{db}number", map { "l_$_" } @columns);
134   my @hidden_nondefault = grep({ $form->{$_} } @hidden_variables);
135   # Variablen werden dann als Hidden Variable mitgegeben, z.B.
136   # <input type="hidden" name="report_generator_hidden_transdateto" value="21.05.2010">
137
138   $href = build_std_url('action=invoice_transactions', grep { $form->{$_} } @hidden_variables);
139   # href = vk.pl?action=invoice_transactions&l_headers=Y&l_subtotal=Y&l_total=Y&transdatefrom=04.03.2010 ...
140
141   my %column_defs = (
142     'description'             => { 'text' => $locale->text('Description'), },
143     'partnumber'              => { 'text' => $locale->text('Part Number'), },
144     'invnumber'               => { 'text' => $locale->text('Invoice Number'), },
145     'transdate'               => { 'text' => $locale->text('Invoice Date'), },
146     'qty'                     => { 'text' => $locale->text('Quantity'), },
147     'unit'                    => { 'text' => $locale->text('Unit'), },
148     'sellprice'               => { 'text' => $locale->text('Sales price'), },
149     'sellprice_total'         => { 'text' => $locale->text('Sales net amount'), },
150     'lastcost_total'          => { 'text' => $locale->text('Purchase net amount'), },
151     'discount'                => { 'text' => $locale->text('Discount'), },
152     'lastcost'                => { 'text' => $locale->text('Purchase price'), },
153     'marge_total'             => { 'text' => $locale->text('Sales margin'), },
154     'marge_percent'           => { 'text' => $locale->text('Sales margin %'), },
155     'customernumber'          => { 'text' => $locale->text('Customer Number'), },
156   );
157
158   my %column_alignment = map { $_ => 'right' } qw(lastcost sellprice sellprice_total lastcost_total unit discount marge_total marge_percent qty);
159
160   $form->{"l_type"} = "Y";
161   map { $column_defs{$_}->{visible} = $form->{"l_${_}"} ? 1 : 0 } @columns;
162
163
164   my @options;
165   if ($form->{description}) {
166     push @options, $locale->text('Description') . " : $form->{description}";
167   }
168   if ($form->{customer}) {
169     push @options, $locale->text('Customer') . " : $form->{customername}";
170   }
171   if ($form->{customernumber}) {
172     push @options, $locale->text('Customer Number') . " : $form->{customernumber}";
173   }
174   if ($form->{department}) {
175     my ($department) = split /--/, $form->{department};
176     push @options, $locale->text('Department') . " : $department";
177   }
178   if ($form->{invnumber}) {
179     push @options, $locale->text('Invoice Number') . " : $form->{invnumber}";
180   }
181   if ($form->{invdate}) {
182     push @options, $locale->text('Invoice Date') . " : $form->{invdate}";
183   }
184   if ($form->{partnumber}) {
185     push @options, $locale->text('Part Number') . " : $form->{partnumber}";
186   }
187   if ($form->{ordnumber}) {
188     push @options, $locale->text('Order Number') . " : $form->{ordnumber}";
189   }
190   if ($form->{notes}) {
191     push @options, $locale->text('Notes') . " : $form->{notes}";
192   }
193   if ($form->{transaction_description}) {
194     push @options, $locale->text('Transaction description') . " : $form->{transaction_description}";
195   }
196   if ($form->{transdatefrom}) {
197     push @options, $locale->text('From') . " " . $locale->date(\%myconfig, $form->{transdatefrom}, 1);
198   }
199   if ($form->{transdateto}) {
200     push @options, $locale->text('Bis') . " " . $locale->date(\%myconfig, $form->{transdateto}, 1);
201   }
202
203   my $report = SL::ReportGenerator->new(\%myconfig, $form);
204
205   $report->set_options('top_info_text'        => join("\n", @options),
206                        'output_format'        => 'HTML',
207                        'title'                => $form->{title},
208                        'attachment_basename'  => $locale->text('Sales Report') . strftime('_%Y%m%d', localtime time),
209     );
210   $report->set_options_from_form();
211   $locale->set_numberformat_wo_thousands_separator(\%myconfig) if lc($report->{options}->{output_format}) eq 'csv';
212
213   $report->set_columns(%column_defs);
214   $report->set_column_order(@columns);
215
216   $report->set_export_options('invoice_transactions', @hidden_variables, qw(mainsort sortdir));
217
218   $report->set_sort_indicator($form->{mainsort}, $form->{sortdir});
219
220   # add sort and escape callback, this one we use for the add sub
221   $form->{callback} = $href .= "&sort=$form->{mainsort}";
222
223   # escape callback for href
224   $callback = $form->escape($href);
225
226   my @subtotal_columns = qw(qty sellprice sellprice_total lastcost lastcost_total marge_total marge_percent discount);
227   # Gesamtsumme:
228   # Summe von sellprice_total, lastcost_total und marge_total
229   # Durchschnitt von marge_percent
230   my @total_columns = qw(sellprice_total lastcost_total marge_total marge_percent );
231
232   my %totals    = map { $_ => 0 } @total_columns;
233   my %subtotals1 = map { $_ => 0 } @subtotal_columns;
234   my %subtotals2 = map { $_ => 0 } @subtotal_columns;
235
236   my $idx = 0;
237
238   foreach my $ar (@{ $form->{AR} }) {
239
240     $ar->{price_factor} = 1 unless $ar->{price_factor};
241     # calculate individual sellprice
242     # discount was already accounted for in db sellprice
243     $ar->{sellprice} = $ar->{sellprice} / $ar->{price_factor};
244     $ar->{lastcost} = $ar->{lastcost} / $ar->{price_factor};
245     $ar->{sellprice_total} = $ar->{qty} * $ar->{sellprice};
246     $ar->{lastcost_total}  = $ar->{qty} * $ar->{lastcost};
247     # marge_percent wird neu berechnet, da Wert in invoice leer ist (Bug)
248     $ar->{marge_percent} = $ar->{sellprice_total} ? (($ar->{sellprice_total}-$ar->{lastcost_total}) / $ar->{sellprice_total}) : 0;
249     # marge_total neu berechnen
250     $ar->{marge_total} = $ar->{sellprice_total} ? $ar->{sellprice_total}-$ar->{lastcost_total}  : 0;
251     $ar->{discount} *= 100;  # für Ausgabe formatieren, 10% stored as 0.1 in db
252
253     # Anfangshauptüberschrift
254     if ( $form->{l_headers} eq "Y" && ( $idx == 0 or $ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx - 1]->{ $form->{'mainsort'} } )) {
255       my $name;
256       my $headerrow;
257       if ( $form->{mainsort} eq 'parts_id' ) {
258         $headerrow->{description}->{data} = "$ar->{description}";
259       } else {
260         $headerrow->{description}->{data} = "$ar->{name}";
261       };
262       $headerrow->{description}->{class} = "listmainsortheader";
263       my $headerrow_set = [ $headerrow ];
264       $report->add_data($headerrow_set);
265
266       # add empty row after main header
267 #      my $emptyheaderrow->{description}->{data} = "";
268 #      $emptyheaderrow->{description}->{class} = "listmainsortheader";
269 #      my $emptyheaderrow_set = [ $emptyheaderrow ];
270 #      $report->add_data($emptyheaderrow_set) if $form->{l_headers} eq "Y";
271     };
272
273     # subsort überschriften
274     if ( $idx == 0
275       or $ar->{ $form->{'subsort'} }  ne $form->{AR}->[$idx - 1]->{ $form->{'subsort'} }
276       or $ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx - 1]->{ $form->{'mainsort'} }
277     ) {
278       my $headerrow;
279       my $name;
280       if ( $form->{subsort} eq 'parts_id' ) {
281         $name = 'description';
282         $headerrow->{description}->{data} = "$ar->{$name}";
283       } else {
284         $name = 'name';
285         $headerrow->{description}->{data} = "$ar->{$name}";
286       };
287       $headerrow->{description}->{class} = "listsubsortheader";
288       my $headerrow_set = [ $headerrow ];
289       $report->add_data($headerrow_set) if $form->{l_headers} eq "Y";
290     };
291
292     map { $subtotals1{$_} += $ar->{$_};
293           $subtotals2{$_} += $ar->{$_};
294         } @subtotal_columns;
295
296     map { $totals{$_}    += $ar->{$_} } @total_columns;
297
298     if ( $subtotals1{qty} != 0 ) {
299       # calculate averages for subtotals1 and subtotals2
300       # credited positions reduce both total and qty and thus don't influence average prices
301       $subtotals1{sellprice} = $subtotals1{sellprice_total} / $subtotals1{qty};
302       $subtotals1{lastcost} = $subtotals1{lastcost_total} / $subtotals1{qty};
303     } else {
304       # qty is zero, so we have a special case where each position in subtotal
305       # group has a corresponding credit note so that the total qty is zero in
306       # this case we also want the total amounts to be zero, so overwrite them,
307       # rather than leaving the last value in sellprice/lastcost
308
309       $subtotals1{sellprice} = 0;
310       $subtotals1{lastcost} = 0;
311     };
312
313     if ( $subtotals2{qty} != 0 ) {
314       $subtotals2{sellprice} = $subtotals2{sellprice_total} / $subtotals2{qty};
315       $subtotals2{lastcost} = $subtotals2{lastcost_total} / $subtotals2{qty}; 
316     } else {
317       $subtotals2{sellprice} = 0;
318       $subtotals2{lastcost} = 0;
319     };
320
321     # Ertrag prozentual in den Summen: (summe VK - summe Ertrag) / summe VK
322     $subtotals1{marge_percent} = $subtotals1{sellprice_total} ? (($subtotals1{sellprice_total} - $subtotals1{lastcost_total}) / $subtotals1{sellprice_total}) : 0;
323     $subtotals2{marge_percent} = $subtotals2{sellprice_total} ? (($subtotals2{sellprice_total} - $subtotals2{lastcost_total}) / $subtotals2{sellprice_total}) : 0;
324
325     # Ertrag prozentual:  (Summe VK betrag - Summe EK betrag) / Summe VK betrag
326     # wird laufend bei jeder Position neu berechnet
327     $totals{marge_percent}    = $totals{sellprice_total}    ? ( ($totals{sellprice_total} - $totals{lastcost_total}) / $totals{sellprice_total}   ) : 0;
328
329     map { $ar->{$_} = $form->format_amount(\%myconfig, $ar->{$_}, 2) } qw(marge_total marge_percent);
330     map { $ar->{$_} = $form->format_amount(\%myconfig, $ar->{$_}, $form->{"decimalplaces"} )} qw(lastcost sellprice sellprice_total lastcost_total);
331
332     my $row = { };
333
334     foreach my $column (@columns) {
335       $row->{$column} = {
336         'data'  => $ar->{$column},
337         'align' => $column_alignment{$column},
338       };
339     }
340
341    $row->{description}->{class} = 'listsortdescription';
342
343     $row->{invnumber}->{link} = build_std_url("script=is.pl", 'action=edit')
344       . "&id=" . E($ar->{id}) . "&callback=${callback}";
345
346     my $row_set = [ $row ];
347
348     if (($form->{l_subtotal} eq 'Y')
349         && (($idx == (scalar @{ $form->{AR} } - 1))   # last element always has a subtotal
350           || ($ar->{ $form->{'subsort'} } ne $form->{AR}->[$idx + 1]->{ $form->{'subsort'}   })
351           || ($ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx + 1]->{ $form->{'mainsort'} })
352           )) {   # if value that is sorted by changes, print subtotal
353       my $name;
354       if ( $form->{subsort} eq 'parts_id' ) {
355         $name = 'description';
356       } else {
357         $name = 'name';
358       };
359
360       if ($form->{l_subtotal} eq 'Y') {
361         push @{ $row_set }, create_subtotal_row_invoice(\%subtotals2, \@columns, \%column_alignment, \@subtotal_columns, 'listsubsortsubtotal', $ar->{$name}) ;
362         push @{ $row_set }, insert_empty_row();
363       };
364     }
365
366     # if mainsort has changed, add mainsort subtotal and empty row
367     if (($form->{l_subtotal} eq 'Y')
368         && (($idx == (scalar @{ $form->{AR} } - 1))   # last element always has a subtotal
369             || ($ar->{ $form->{'mainsort'} } ne $form->{AR}->[$idx + 1]->{ $form->{'mainsort'} })
370             )) {   # if value that is sorted by changes, print subtotal
371       my $name;
372       if ( $form->{mainsort} eq 'parts_id' ) {
373         $name = 'description';
374       } else {
375         $name = 'name';
376       };
377       if ($form->{l_subtotal} eq 'Y' ) {
378         push @{ $row_set }, create_subtotal_row_invoice(\%subtotals1, \@columns, \%column_alignment, \@subtotal_columns, 'listmainsortsubtotal', $ar->{$name});
379         push @{ $row_set }, insert_empty_row();
380       };
381     }
382
383     $report->add_data($row_set);
384
385     $idx++;
386   }
387   if ( $form->{l_total} eq "Y" ) {
388     $report->add_separator();
389     $report->add_data(create_subtotal_row_invoice(\%totals, \@columns, \%column_alignment, \@total_columns, 'listtotal'))
390   };
391
392   $report->generate_with_headers();
393   $main::lxdebug->leave_sub();
394 }
395
396
397 sub insert_empty_row {
398     my $dummyrow;
399     $dummyrow->{description}->{data} = "";
400     my $dummyrowset = [ $dummyrow ];
401     return $dummyrow;
402 };
403
404
405
406 sub create_subtotal_row_invoice {
407   $main::lxdebug->enter_sub();
408
409   my ($totals, $columns, $column_alignment, $subtotal_columns, $class, $name) = @_;
410
411   my $form     = $main::form;
412   my %myconfig = %main::myconfig;
413
414   my $row = { map { $_ => { 'data' => '', 'class' => $class, 'align' => $column_alignment->{$_}, } } @{ $columns } };
415
416   $row->{description}->{data} = "Summe " . $name;
417
418   map { $row->{$_}->{data} = $form->format_amount(\%myconfig, $totals->{$_}, 2) } qw(marge_total marge_percent);
419   map { $row->{$_}->{data} = $form->format_amount(\%myconfig, $totals->{$_}, 0) } qw(qty);
420   map { $row->{$_}->{data} = $form->format_amount(\%myconfig, $totals->{$_}, $form->{decimalplaces}) } qw(lastcost sellprice sellprice_total lastcost_total);
421
422
423   map { $totals->{$_} = 0 } @{ $subtotal_columns };
424
425   $main::lxdebug->leave_sub();
426
427   return $row;
428 }
429
430 1;
431