3 # This file is part of Koha.
5 # Author : Frédérick Capovilla, 2011 - SYS-TECH
6 # Modified by : Élyse Morin, 2012 - Libéo
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 3 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along with
18 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
19 # Suite 330, Boston, MA 02111-1307 USA
22 =head1 orders_by_budget
24 This script displays all orders associated to a selected budget.
31 use C4::Auth qw( get_template_and_user );
32 use C4::Output qw( output_html_with_http_headers );
33 use C4::Budgets qw( GetBudgetsReport GetBudgetHierarchy );
34 use C4::Acquisition qw( GetBasket get_rounded_price );
36 use Koha::DateUtils qw( dt_from_string output_pref );
39 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
41 template_name => "reports/orders_by_budget.tt",
44 flagsrequired => { reports => '*' },
48 my $params = $query->Vars;
49 my $get_orders = $params->{'get_orders'};
52 my $budgetfilter = $params->{'budgetfilter'} || undef;
53 my $total_quantity = 0;
60 unless($budgetfilter) {
61 # If no budget filter was selected, get the orders of all budgets
62 my @budgets = C4::Budgets::GetBudgetsReport();
63 foreach my $budget (@budgets) {
64 push(@orders, $budget);
65 $budget_name{$budget->{'budget_id'}} = $budget->{'budget_name'};
69 if ($budgetfilter eq 'activebudgets') {
70 # If all active budgets's option was selected, get the orders of all active budgets
71 my @active_budgets = C4::Budgets::GetBudgetsReport(1);
72 foreach my $active_budget (@active_budgets)
74 push(@orders, $active_budget);
75 $budget_name{$active_budget->{'budget_id'}} = $active_budget->{'budget_name'};
79 # A budget filter was selected, only get the orders for the selected budget
80 my @filtered_budgets = C4::Budgets::GetBudgetReport($budgetfilter);
81 foreach my $budget (@filtered_budgets)
83 push(@orders, $budget);
84 $budget_name{$budget->{'budget_id'}} = $budget->{'budget_name'};
86 if ($filtered_budgets[0]) {
88 current_budget_name => $filtered_budgets[0]->{'budget_name'},
94 # Format the order's informations
95 foreach my $order (@orders) {
96 # Get the title of the ordered item
97 my $biblio = Koha::Biblios->find( $order->{biblionumber} );
98 my $basket = C4::Acquisition::GetBasket($order->{'basketno'});
100 $order->{'basketname'} = $basket->{'basketname'};
101 $order->{'authorisedbyname'} = $basket->{'authorisedbyname'};
103 $order->{title} = $biblio ? $biblio->title : '';
104 $order->{title} ||= $order->{biblionumber};
106 $order->{'total_rrp'} = get_rounded_price($order->{'quantity'}) * $order->{'rrp'};
107 $order->{'total_ecost'} = get_rounded_price($order->{'quantity'}) * $order->{'ecost'};
109 # Format the dates and currencies correctly
110 $order->{'datereceived'} = output_pref(dt_from_string($order->{'datereceived'}));
111 $order->{'entrydate'} = output_pref(dt_from_string($order->{'entrydate'}));
112 $total_quantity += $order->{'quantity'};
113 $total_rrp += $order->{'total_rrp'};
114 $total_ecost += $order->{'total_ecost'};
116 # Get the budget's name
117 $order->{'budget_name'} = $budget_name{$order->{'budget_id'}};
120 # If we are outputting to screen, output to the template.
121 if($params->{"output"} eq 'screen') {
123 total => scalar @orders,
124 ordersloop => \@orders,
125 get_orders => $get_orders,
126 total_quantity => $total_quantity,
127 total_rrp => $total_rrp,
128 total_ecost => $total_ecost,
131 # If we are outputting to a file, create it and exit.
133 my $basename = $params->{"basename"};
134 my $sep = $params->{"sep"};
135 $sep = "\t" if ($sep eq 'tabulation');
137 # TODO Use Text::CSV to generate the CSV file
138 print $query->header(
140 -encoding => 'utf-8',
141 -attachment => "$basename.csv",
142 -name => "$basename.csv"
145 #binmode STDOUT, ":encoding(UTF-8)";
147 # Surrounds a string with double-quotes and escape the double-quotes inside
149 my $string = shift || "";
151 return "\"$string\"";
154 foreach my $order (@orders) {
156 push(@row, _surround($order->{'budget_name'}));
157 push(@row, _surround($order->{'basketno'}));
158 push(@row, _surround($order->{'basketname'}));
159 push(@row, _surround($order->{'authorisedbyname'}));
160 push(@row, _surround($order->{'biblionumber'}));
161 push(@row, _surround($order->{'title'}));
162 push(@row, _surround($order->{'currency'}));
163 push(@row, _surround($order->{'listprice'}));
164 push(@row, _surround($order->{'rrp'}));
165 push(@row, _surround($order->{'ecost'}));
166 push(@row, _surround($order->{'quantity'}));
167 push(@row, _surround($order->{'total_rrp'}));
168 push(@row, _surround($order->{'total_ecost'}));
169 push(@row, _surround($order->{'entrydate'}));
170 push(@row, _surround($order->{'datereceived'}));
171 push(@row, _surround($order->{'order_internalnote'}));
172 push(@row, _surround($order->{'order_vendornote'}));
177 for(1..9){push(@totalrow, "")};
178 push(@totalrow, _surround($total_quantity));
179 push(@totalrow, _surround($total_rrp));
180 push(@totalrow, _surround($total_ecost));
182 my $csvTemplate = C4::Templates::gettemplate('reports/csv/orders_by_budget.tt', 'intranet', $query);
183 $csvTemplate->param(sep => $sep, rows => \@rows, totalrow => \@totalrow);
184 print $csvTemplate->output;
190 # Set file export choices
191 my @outputFormats = ('CSV');
192 my @CSVdelimiters =(',','#',qw(; tabulation \\ /));
194 # getting all budgets
195 my $budgets = GetBudgetHierarchy;
197 foreach my $budget (@{$budgets}) {
198 push @{$budgetloop},{
199 value => $budget->{budget_id},
200 description => $budget->{budget_name},
201 period => $budget->{budget_period_description},
202 active => $budget->{budget_period_active},
205 @{$budgetloop} =sort { uc( $a->{description}) cmp uc( $b->{description}) } @{$budgetloop};
206 $template->param( budgetsloop => \@{$budgetloop},
207 outputFormatloop => \@outputFormats,
208 delimiterloop => \@CSVdelimiters,
209 delimiterPreference => C4::Context->preference('CSVDelimiter')
213 # writing the template
214 output_html_with_http_headers $query, $cookie, $template->output;