-
Notifications
You must be signed in to change notification settings - Fork 54
/
UploadedFile.pm
330 lines (229 loc) · 6.36 KB
/
UploadedFile.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
package C4::UploadedFile;
# Copyright (C) 2007 LibLime
# Galen Charlton <galen.charlton@liblime.com>
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation; either version 2 of the License, or (at your option) any later
# version.
#
# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along with
# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
# Suite 330, Boston, MA 02111-1307 USA
use strict;
use Koha;
use C4::Context;
use C4::Auth qw/get_session/;
use IO::File;
use vars qw($VERSION);
BEGIN {
# set the version for version checking
$VERSION = 3.00;
}
=head1 NAME
C4::UploadedFile - manage files uploaded by the user
for later processing.
=head1 SYNOPSIS
=over 4
# create and store data
my $uploaded_file = C4::UploadedFile->new($sessionID);
my $fileID = $uploaded_file->id();
$uploaded_file->name('c:\temp\file.mrc');
$uploaded_file->max_size(1024);
while ($have_more_data) {
$uploaded_file->stash($data, $bytes_read);
}
$uploaded_file->done();
# check status of current file upload
my $progress = C4::UploadedFile->upload_progress($sessionID);
# get file handle for reading uploaded file
my $uploaded_file = C4::UploadedFile->fetch($fileID);
my $fh = $uploaded_file->fh();
=back
Stores files uploaded by the user from their web browser. The
uploaded files are temporary and at present are not guaranteed
to survive beyond the life of the user's session.
This module allows for tracking the progress of the file
currently being uploaded.
TODO: implement secure persistant storage of uploaded files.
=cut
=head1 METHODS
=cut
=head2 new
=over 4
my $uploaded_file = C4::UploadedFile->new($sessionID);
=back
Creates a new object to represent the uploaded file. Requires
the current session ID.
=cut
sub new {
my $class = shift;
my $sessionID = shift;
my $self = {};
$self->{'sessionID'} = $sessionID;
$self->{'fileID'} = Digest::MD5::md5_hex(Digest::MD5::md5_hex(time().{}.rand().{}.$$));
# FIXME - make staging area configurable
my $TEMPROOT = "/tmp";
my $OUTPUTDIR = "$TEMPROOT/$sessionID";
mkdir $OUTPUTDIR;
my $tmp_file_name = "$OUTPUTDIR/$self->{'fileID'}";
my $fh = new IO::File $tmp_file_name, "w";
unless (defined $fh) {
return undef;
}
$fh->binmode(); # Windows compatibility
$self->{'fh'} = $fh;
$self->{'tmp_file_name'} = $tmp_file_name;
$self->{'max_size'} = 0;
$self->{'progress'} = 0;
$self->{'name'} = '';
bless $self, $class;
$self->_serialize();
my $session = get_session($sessionID);
$session->param('current_upload', $self->{'fileID'});
$session->flush();
return $self;
}
sub _serialize {
my $self = shift;
my $prefix = "upload_" . $self->{'fileID'};
my $session = get_session($self->{'sessionID'});
# temporarily take file handle out of structure
my $fh = $self->{'fh'};
delete $self->{'fh'};
$session->param($prefix, $self);
$session->flush();
$self->{'fh'} =$fh;
}
=head2 id
=over 4
my $fileID = $uploaded_file->id();
=back
=cut
sub id {
my $self = shift;
return $self->{'fileID'};
}
=head2 name
=over 4
my $name = $uploaded_file->name();
$uploaded_file->name($name);
=back
Accessor method for the name by which the file is to be known.
=cut
sub name {
my $self = shift;
if (@_) {
$self->{'name'} = shift;
$self->_serialize();
} else {
return $self->{'name'};
}
}
=head2 max_size
=over 4
my $max_size = $uploaded_file->max_size();
$uploaded_file->max_size($max_size);
=back
Accessor method for the maximum size of the uploaded file.
=cut
sub max_size {
my $self = shift;
@_ ? $self->{'max_size'} = shift : $self->{'max_size'};
}
=head2 stash
=over 4
$uploaded_file->stash($dataref, $bytes_read);
=back
Write C<$dataref> to the temporary file. C<$bytes_read> represents
the number of bytes (out of C<$max_size>) transmitted so far.
=cut
sub stash {
my $self = shift;
my $dataref = shift;
my $bytes_read = shift;
my $fh = $self->{'fh'};
print $fh $$dataref;
my $percentage = int(($bytes_read / $self->{'max_size'}) * 100);
if ($percentage > $self->{'progress'}) {
$self->{'progress'} = $percentage;
$self->_serialize();
}
}
=head2 done
=over 4
$uploaded_file->done();
=back
Indicates that all of the bytes have been uploaded.
=cut
sub done {
my $self = shift;
$self->{'progress'} = 'done';
$self->{'fh'}->close();
$self->_serialize();
}
=head2 upload_progress
=over 4
my $upload_progress = C4::UploadFile->upload_progress($sessionID);
=back
Returns (as an integer from 0 to 100) the percentage
progress of the current file upload.
=cut
sub upload_progress {
my ($class, $sessionID) = shift;
my $session = get_session($sessionID);
my $fileID = $session->param('current_upload');
my $reported_progress = 0;
if (defined $fileID and $fileID ne "") {
my $file = C4::UploadedFile->fetch($sessionID, $fileID);
my $progress = $file->{'progress'};
if (defined $progress) {
if ($progress eq "done") {
$reported_progress = 100;
} else {
$reported_progress = $progress;
}
}
}
return $reported_progress;
}
=head2 fetch
=over 4
my $uploaded_file = C4::UploadedFile->fetch($sessionID, $fileID);
=back
Retrieves an uploaded file object from the current session.
=cut
sub fetch {
my $class = shift;
my $sessionID = shift;
my $fileID = shift;
my $session = get_session($sessionID);
my $prefix = "upload_$fileID";
my $self = $session->param($prefix);
my $fh = new IO::File $self->{'tmp_file_name'}, "r";
$self->{'fh'} = $fh;
bless $self, $class;
return $self;
}
=head2 fh
=over
my $fh = $uploaded_file->fh();
=back
Returns an IO::File handle to read the uploaded file.
=cut
sub fh {
my $self = shift;
return $self->{'fh'};
}
1;
__END__
=head1 AUTHOR
Koha Development Team <info@koha.org>
Galen Charlton <galen.charlton@liblime.com>
=cut