3 # 2008 Kyle Hall <kyle.m.hall@gmail.com>
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
24 use C4::Output qw( output_html_with_http_headers );
25 use C4::Auth qw( get_template_and_user );
28 use C4::Circulation qw( AddOfflineOperation );
32 use Koha::UploadedFiles;
36 # this is the file version number that we're coded against.
37 my $FILE_VERSION = '1.0';
42 my ($template, $loggedinuser, $cookie) = get_template_and_user({
43 template_name => "offline_circ/enqueue_koc.tt",
46 flagsrequired => { circulate => "circulate_remaining_permissions" },
50 my $fileID=$query->param('uploadedfileid');
51 my %cookies = parse CGI::Cookie($cookie);
52 my $sessionID = $cookies{'CGISESSID'}->value;
54 our $dbh = C4::Context->dbh();
57 my $upload = Koha::UploadedFiles->find($fileID);
58 my $fh = $upload? $upload->file_handle: undef;
59 my @input_lines = $fh? <$fh>: ();
62 my $header_line = shift @input_lines;
63 my $file_info = parse_header_line($header_line);
64 if ($file_info->{'Version'} ne $FILE_VERSION) {
67 ERROR_file_version => 1,
68 upload_version => $file_info->{'Version'},
69 current_version => $FILE_VERSION
73 my $userid = C4::Context->userenv->{id};
74 my $branchcode = C4::Context->userenv->{branch};
76 foreach my $line (@input_lines) {
77 my $command_line = parse_command_line($line);
78 my $timestamp = $command_line->{'date'} . ' ' . $command_line->{'time'};
79 my $action = $command_line->{'command'};
80 my $barcode = $command_line->{'barcode'};
81 my $cardnumber = $command_line->{'cardnumber'};
82 my $amount = $command_line->{'amount'};
84 AddOfflineOperation( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
89 $template->param( messages => \@output );
91 output_html_with_http_headers $query, $cookie, $template->output;
95 =head2 parse_header_line
97 parses the header line from a .koc file. This is the line that
98 specifies things such as the file version, and the name and version of
99 the offline circulation tool that generated the file. See
100 L<http://wiki.koha-community.org/wiki/Koha_offline_circulation_file_format>
101 for more information.
103 pass in a string containing the header line (the first line from th
106 returns a hashref containing the information from the header.
110 sub parse_header_line {
111 my $header_line = shift;
113 $header_line =~ s/\r//g;
115 my @fields = split( /\t/, $header_line );
116 my %header_info = map { split( /=/, $_ ) } @fields;
117 return \%header_info;
120 =head2 parse_command_line
124 sub parse_command_line {
125 my $command_line = shift;
126 chomp($command_line);
127 $command_line =~ s/\r//g;
129 my ( $timestamp, $command, @args ) = split( /\t/, $command_line );
130 my ( $date, $time, $id ) = split( /\s/, $timestamp );
139 # set the rest of the keys using a hash slice
140 my $argument_names = arguments_for_command($command);
141 @command{@$argument_names} = @args;
147 =head2 arguments_for_command
149 fetches the names of the columns (and function arguments) found in the
150 .koc file for a particular command name. For instance, the C<issue>
151 command requires a C<cardnumber> and C<barcode>. In that case this
152 function returns a reference to the list C<qw( cardnumber barcode )>.
154 parameters: the command name
156 returns: listref of column names.
160 sub arguments_for_command {
163 # define the fields for this version of the file.
165 issue => [qw( cardnumber barcode )],
166 return => [qw( barcode )],
167 payment => [qw( cardnumber amount )],
170 return $format{$command};
173 =head2 _get_borrowernumber_from_barcode
176 get back the borrowernumber of the patron who has it checked out.
177 undef if that can't be found
181 sub _get_borrowernumber_from_barcode {
184 return unless $barcode;
186 my $item = Koha::Items->find({ barcode => $barcode });
189 my $issue = Koha::Checkouts->find( { itemnumber => $item->itemnumber } );
190 return unless $issue;
191 return $issue->borrowernumber;