package Catalyst::Request::Upload;
-use strict;
-use base 'Class::Accessor::Fast';
+use Moose;
+with 'MooseX::Emulate::Class::Accessor::Fast';
+use Catalyst::Exception;
use File::Copy ();
-use IO::File ();
+use IO::File ();
+use File::Spec::Unix;
+use namespace::clean -except => 'meta';
+
+has filename => (is => 'rw');
+has headers => (is => 'rw');
+has size => (is => 'rw');
+has tempname => (is => 'rw');
+has type => (is => 'rw');
+has basename => (is => 'ro', lazy_build => 1);
+
+has fh => (
+ is => 'rw',
+ required => 1,
+ lazy => 1,
+ default => sub {
+ my $self = shift;
+
+ my $fh = IO::File->new($self->tempname, IO::File::O_RDONLY);
+ unless ( defined $fh ) {
+ my $filename = $self->tempname;
+ Catalyst::Exception->throw(
+ message => qq/Can't open '$filename': '$!'/ );
+ }
+
+ return $fh;
+ },
+);
-__PACKAGE__->mk_accessors(qw/filename size tempname type/);
+sub _build_basename {
+ my $self = shift;
+ my $basename = $self->filename;
+ $basename =~ s|\\|/|g;
+ $basename = ( File::Spec::Unix->splitpath($basename) )[2];
+ $basename =~ s|[^\w\.-]+|_|g;
+ return $basename;
+}
-sub new { shift->SUPER::new( ref( $_[0] ) ? $_[0] : {@_} ) }
+no Moose;
=head1 NAME
-Catalyst::Request::Upload - Catalyst Request Upload Class
+Catalyst::Request::Upload - handles file upload requests
=head1 SYNOPSIS
- $upload->copy
- $upload->fh
+ my $upload = $c->req->upload('field');
+
+ $upload->basename;
+ $upload->copy_to;
+ $upload->fh;
$upload->filename;
- $upload->link;
+ $upload->headers;
+ $upload->link_to;
$upload->size;
+ $upload->slurp;
$upload->tempname;
$upload->type;
+To specify where Catalyst should put the temporary files, set the 'uploadtmp'
+option in the Catalyst config. If unset, Catalyst will use the system temp dir.
+
+ __PACKAGE__->config( uploadtmp => '/path/to/tmpdir' );
+
See also L<Catalyst>.
=head1 DESCRIPTION
-This is the Catalyst Request Upload class, which provides a set of accessors
-to the upload data.
+This class provides accessors and methods to handle client upload requests.
=head1 METHODS
-=over 4
+=head2 $upload->new
+
+Simple constructor.
-=item $upload->copy( $target [, $bufferlen ] )
+=head2 $upload->copy_to
-Copies tempname using C<File::Copy>. Returns true for success, false otherwise.
+Copies the temporary file using L<File::Copy>. Returns true for success,
+false for failure.
+
+ $upload->copy_to('/path/to/target');
=cut
-sub copy {
- my ( $self, $target, $buffer ) = @_;
- return File::Copy::copy( $self->tempname, $target, $buffer );
+sub copy_to {
+ my $self = shift;
+ return File::Copy::copy( $self->tempname, @_ );
}
-=item $upload->fh
+=head2 $upload->fh
-Opens tempname and returns a C<IO::File> handle.
+Opens a temporary file (see tempname below) and returns an L<IO::File> handle.
-=cut
+=head2 $upload->filename
-sub fh {
- my $self = shift;
+Returns the client-supplied filename.
- my $fh = IO::File->new( $self->tempname, IO::File::O_RDONLY )
- or die( "Can't open ", $self->tempname, ": ", $! );
+=head2 $upload->headers
- return $fh;
+Returns an L<HTTP::Headers> object for the request.
+
+=head2 $upload->link_to
+
+Creates a hard link to the temporary file. Returns true for success,
+false for failure.
+
+ $upload->link_to('/path/to/target');
+
+=cut
+
+sub link_to {
+ my ( $self, $target ) = @_;
+ return CORE::link( $self->tempname, $target );
}
-=item $upload->filename
+=head2 $upload->size
-Contains client supplied filename.
+Returns the size of the uploaded file in bytes.
-=item $upload->link
+=head2 $upload->slurp
-Creates a new filename linked to the old filename. Returns true for
-success, false otherwise.
+Returns a scalar containing the contents of the temporary file.
- $upload->link('/my/path');
+Note that this method will cause the filehandle pointed to by
+C<< $upload->fh >> to be seeked to the start of the file,
+and the file handle to be put into binary mode.
=cut
-sub link {
- my ( $self, $target ) = @_;
- return CORE::link( $self->tempname, $target );
+sub slurp {
+ my ( $self, $layer ) = @_;
+
+ unless ($layer) {
+ $layer = ':raw';
+ }
+
+ my $content = undef;
+ my $handle = $self->fh;
+
+ binmode( $handle, $layer );
+
+ $handle->seek(0, IO::File::SEEK_SET);
+ while ( $handle->sysread( my $buffer, 8192 ) ) {
+ $content .= $buffer;
+ }
+
+ $handle->seek(0, IO::File::SEEK_SET);
+ return $content;
}
-=item $upload->size
+=head2 $upload->basename
-Contains size of the file in bytes.
+Returns basename for C<filename>.
-=item $upload->tempname
+=head2 $upload->tempname
-Contains path to the temporary spool file.
+Returns the path to the temporary file.
-=item $upload->type
+=head2 $upload->type
-Contains client supplied Content-Type.
+Returns the client-supplied Content-Type.
-=back
+=head2 meta
-=head1 AUTHOR
+Provided by Moose
-Sebastian Riedel, C<sri@cpan.org>
-Christian Hansen, C<ch@ngmedia.com>
+=head1 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
=head1 COPYRIGHT
-This program is free software, you can redistribute it and/or modify
+This library is free software. You can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
+__PACKAGE__->meta->make_immutable;
+
1;