Bug 22343: (QA follow-up) Fix some comments
[koha.git] / reports / cash_register_stats.pl
blob0e92d5c4893c0e7074da4dc2563432743f5846fd
1 #!/usr/bin/perl
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
18 use Modern::Perl;
19 use C4::Auth;
20 use CGI;
21 use C4::Context;
22 use C4::Reports;
23 use C4::Output;
24 use C4::Koha;
25 use C4::Circulation;
26 use DateTime;
27 use Koha::DateUtils;
28 use Text::CSV::Encoded;
29 use List::Util qw/any/;
31 use Koha::Account::CreditTypes;
32 use Koha::Account::DebitTypes;
34 my $input = new CGI;
35 my $dbh = C4::Context->dbh;
37 my ($template, $borrowernumber, $cookie) = get_template_and_user({
38 template_name => "reports/cash_register_stats.tt",
39 query => $input,
40 type => "intranet",
41 flagsrequired => {reports => '*'},
42 debug => 1,
43 });
45 my $do_it = $input->param('do_it');
46 my $output = $input->param("output");
47 my $basename = $input->param("basename");
48 my $transaction_type = $input->param("transaction_type") || 'ACT';
49 my $manager_branchcode = $input->param("branch") || C4::Context->userenv->{'branch'};
51 $template->param(
52 do_it => $do_it,
53 CGIsepChoice => GetDelimiterChoices,
56 #Initialize date pickers to today
57 my $fromDate = dt_from_string;
58 my $toDate = dt_from_string;
60 my @debit_types =
61 Koha::Account::DebitTypes->search()->as_list;
62 my @credit_types =
63 Koha::Account::CreditTypes->search()->as_list;
65 if ($do_it) {
67 $fromDate = output_pref({ dt => eval { dt_from_string(scalar $input->param("from")) } || dt_from_string,
68 dateformat => 'sql', dateonly => 1 }); #for sql query
69 $toDate = output_pref({ dt => eval { dt_from_string(scalar $input->param("to")) } || dt_from_string,
70 dateformat => 'sql', dateonly => 1 }); #for sql query
72 my $whereTType = q{};
73 my @extra_params; # if we add conditions to the select we need extra params
75 if ($transaction_type eq 'ALL') { #All Transactons
76 $whereTType = q{};
77 } elsif ($transaction_type eq 'ACT') { #Active
78 $whereTType = q{ AND credit_type_code IN ('PAYMENT','CREDIT') };
79 } elsif ($transaction_type eq 'FORW') {
80 $whereTType = q{ AND credit_type_code IN ('FORGIVEN','WRITEOFF') };
81 } else {
82 if ( any { $transaction_type eq $_->code } @debit_types ) {
83 $whereTType = q{ AND debit_type_code = ? };
84 push @extra_params, $transaction_type;
85 } else {
86 $whereTType = q{ AND credit_type_code = ? };
87 push @extra_params, $transaction_type;
91 my $whereBranchCode = q{};
92 if ($manager_branchcode ne 'ALL') {
93 $whereBranchCode = q{ AND m.branchcode = ?};
94 push @extra_params, $manager_branchcode;
98 my $query = "
99 SELECT round(amount,2) AS amount, description,
100 bo.surname AS bsurname, bo.firstname AS bfirstname, m.surname AS msurname, m.firstname AS mfirstname,
101 bo.cardnumber, br.branchname, bo.borrowernumber,
102 al.borrowernumber, DATE(al.date) as date, al.credit_type_code, al.debit_type_code, al.amountoutstanding, al.note,
103 bi.title, bi.biblionumber, i.barcode, i.itype
104 FROM accountlines al
105 LEFT JOIN borrowers bo ON (al.borrowernumber = bo.borrowernumber)
106 LEFT JOIN borrowers m ON (al.manager_id = m.borrowernumber)
107 LEFT JOIN branches br ON (br.branchcode = m.branchcode )
108 LEFT JOIN items i ON (i.itemnumber = al.itemnumber)
109 LEFT JOIN biblio bi ON (bi.biblionumber = i.biblionumber)
110 WHERE CAST(al.date AS DATE) BETWEEN ? AND ?
111 $whereTType
112 $whereBranchCode
113 ORDER BY al.date
115 my $sth_stats = $dbh->prepare($query) or die "Unable to prepare query " . $dbh->errstr;
116 $sth_stats->execute($fromDate, $toDate, @extra_params) or die "Unable to execute query " . $sth_stats->errstr;
118 my @loopresult;
119 my $grantotal = 0;
120 while ( my $row = $sth_stats->fetchrow_hashref()) {
121 $row->{amountoutstanding} = 0 if (!$row->{amountoutstanding});
122 #if ((abs($row->{amount}) - $row->{amountoutstanding}) > 0) {
123 $row->{amount} = sprintf("%.2f", abs ($row->{amount}));
124 $row->{date} = dt_from_string($row->{date}, 'sql');
126 push (@loopresult, $row);
127 if($transaction_type eq 'ACT' && ($row->{credit_type_code} !~ /^CREDIT$|^PAYMENT$/)){
128 pop @loopresult;
129 next;
131 if($row->{credit_type_code} =~ /^CREDIT$/){
132 $grantotal -= abs($row->{amount});
133 $row->{amount} = '-' . $row->{amount};
134 }elsif($row->{credit_type_code} eq 'FORGIVEN' || $row->{credit_type_code} eq 'WRITEOFF'){
135 }else{
136 $grantotal += abs($row->{amount});
141 $grantotal = sprintf("%.2f", $grantotal);
143 if($output eq 'screen'){
144 $template->param(
145 loopresult => \@loopresult,
146 total => $grantotal,
148 } else{
149 my $format = 'csv';
150 my $reportname = $input->param('basename');
151 my $reportfilename = $reportname ? "$reportname.$format" : "reportresults.$format" ;
152 my $delimiter = C4::Context->preference('delimiter') || ',';
153 my @rows;
154 foreach my $row (@loopresult) {
155 my @rowValues;
156 push @rowValues, $row->{mfirstname}. ' ' . $row->{msurname},
157 $row->{cardnumber},
158 $row->{bfirstname} . ' ' . $row->{bsurname},
159 $row->{branchname},
160 $row->{date},
161 $row->{credit_type},
162 $row->{debit_type},
163 $row->{note},
164 $row->{amount},
165 $row->{title},
166 $row->{barcode},
167 $row->{itype};
168 push (@rows, \@rowValues) ;
170 my @total;
171 for (1..6){push(@total,"")};
172 push(@total, $grantotal);
173 print $input->header(
174 -type => 'text/csv',
175 -encoding => 'utf-8',
176 -attachment => $reportfilename,
177 -name => $reportfilename
179 my $csvTemplate = C4::Templates::gettemplate('reports/csv/cash_register_stats.tt', 'intranet', $input);
180 $csvTemplate->param(sep => $delimiter, rows => \@rows, total => \@total );
181 print $csvTemplate->output;
182 exit;
187 $template->param(
188 beginDate => $fromDate,
189 endDate => $toDate,
190 transaction_type => $transaction_type,
191 branchloop => Koha::Libraries->search({}, { order_by => ['branchname'] })->unblessed,
192 debit_types => \@debit_types,
193 credit_types => \@credit_types,
194 CGIsepChoice => GetDelimiterChoices,
197 output_html_with_http_headers $input, $cookie, $template->output;