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=ee1e5e234d5cd8cb28dee5eb15f0b698ed2b91af;hpb=5c0ff1281ecab26214c9b8279b8fb284385565f3;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm index ee1e5e2..f93a838 100644 --- a/lib/Catalyst/Request/Upload.pm +++ b/lib/Catalyst/Request/Upload.pm @@ -3,22 +3,27 @@ package Catalyst::Request::Upload; use strict; use base 'Class::Accessor::Fast'; -use IO::File; +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->fh + $upload->copy_to; + $upload->fh; $upload->filename; - $upload->link; + $upload->headers; + $upload->link_to; $upload->size; + $upload->slurp; $upload->tempname; $upload->type; @@ -26,65 +31,117 @@ 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 =over 4 +=item $upload->new + +Simple constructor. + +=item $upload->copy_to + +Copies the temporary file using L. Returns true for success, +false for failure. + + $upload->copy_to('/path/to/target'); + +=cut + +sub copy_to { + my $self = shift; + return File::Copy::copy( $self->tempname, @_ ); +} + =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, 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->link +=item $upload->headers -Creates a new filename linked to the old filename. Returns true for -success, false otherwise. +Returns an L object for the request. - $upload->link('/my/path'); +=item $upload->link_to -=cut +Creates a hard link to the temporary file. Returns true for success, +false for failure. -sub link { - my $self = shift; - my $target = shift; + $upload->link_to('/path/to/target'); +=cut + +sub link_to { + my ( $self, $target ) = @_; return CORE::link( $self->tempname, $target ); } =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 the contents of the temporary file. + +=cut + +sub slurp { + my ( $self, $layer ) = @_; + + unless ($layer) { + $layer = ':raw'; + } + + my $content = undef; + my $handle = $self->fh; + + binmode( $handle, $layer ); + + while ( $handle->sysread( my $buffer, 8192 ) ) { + $content .= $buffer; + } + + return $content; +} =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