X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest%2FUpload.pm;h=f93a838c61b2c86bcd38b71f1b13fbea3c7c2e67;hb=640faa87f0c572b58acd22124bfa6f6c59106873;hp=a31df3d5ad7e692c2597c11b93a31cf6e17ce8f7;hpb=32d4bba8cb8276572093428eef50bf0bda59aa3d;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm index a31df3d..f93a838 100644 --- a/lib/Catalyst/Request/Upload.pm +++ b/lib/Catalyst/Request/Upload.pm @@ -3,21 +3,24 @@ package Catalyst::Request::Upload; use strict; use base 'Class::Accessor::Fast'; +use Catalyst::Exception; use File::Copy (); use IO::File (); -__PACKAGE__->mk_accessors(qw/filename size tempname type/); +__PACKAGE__->mk_accessors(qw/filename headers size tempname type/); +sub new { shift->SUPER::new( ref( $_[0] ) ? $_[0] : {@_} ) } =head1 NAME -Catalyst::Request::Upload - Catalyst Request Upload Class +Catalyst::Request::Upload - handles file upload requests =head1 SYNOPSIS - $upload->copy_to - $upload->fh + $upload->copy_to; + $upload->fh; $upload->filename; + $upload->headers; $upload->link_to; $upload->size; $upload->slurp; @@ -28,8 +31,7 @@ See also L. =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 @@ -37,15 +39,12 @@ to the upload data. =item $upload->new -Constructor. Normally only for engine use. - -=cut - -sub new { shift->SUPER::new( ref( $_[0] ) ? $_[0] : {@_} ) } +Simple constructor. =item $upload->copy_to -Copies tempname using C. Returns true for success, false otherwise. +Copies the temporary file using L. Returns true for success, +false for failure. $upload->copy_to('/path/to/target'); @@ -58,27 +57,38 @@ sub copy_to { =item $upload->fh -Opens tempname and returns a C handle. +Opens a temporary file (see tempname below) and returns an L handle. =cut sub fh { my $self = shift; - my $fh = IO::File->new( $self->tempname, IO::File::O_RDONLY ) - or die( "Can't open ", $self->tempname, ": ", $! ); + 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; } =item $upload->filename -Contains client supplied filename. +Returns the client-supplied filename. + +=item $upload->headers + +Returns an L object for the request. =item $upload->link_to -Creates a hard link to the tempname. Returns true for success, -false otherwise. +Creates a hard link to the temporary file. Returns true for success, +false for failure. $upload->link_to('/path/to/target'); @@ -91,18 +101,18 @@ sub link_to { =item $upload->size -Contains size of the file in bytes. +Returns the size of the uploaded file in bytes. =item $upload->slurp -Returns a scalar containing contents of tempname. +Returns a scalar containing the contents of the temporary file. =cut sub slurp { my ( $self, $layer ) = @_; - unless ( $layer ) { + unless ($layer) { $layer = ':raw'; } @@ -120,17 +130,18 @@ sub slurp { =item $upload->tempname -Contains path to the temporary spool file. +Returns the path to the temporary file. =item $upload->type -Contains client supplied Content-Type. +Returns the client-supplied Content-Type. =back -=head1 AUTHOR +=head1 AUTHORS Sebastian Riedel, C + Christian Hansen, C =head1 COPYRIGHT