X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FRequest%2FUpload.pm;h=b1bd4e6803f1216f5fdb66bb07972062a0d459b4;hp=2cd3eb941a29c2ae6575e7d01bd2f22fdcaaa9da;hb=4090e3bb3fea1a73ac369250e31584d61428b808;hpb=212187010229e2cdb585b36f526c4a65e72bf288 diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm index 2cd3eb9..b1bd4e6 100644 --- a/lib/Catalyst/Request/Upload.pm +++ b/lib/Catalyst/Request/Upload.pm @@ -1,90 +1,180 @@ package Catalyst::Request::Upload; -use strict; -use base 'Class::Accessor::Fast'; +use Moose; + +use Catalyst::Exception; +use File::Copy (); +use IO::File (); +use File::Spec::Unix; + +has filename => (is => 'rw'); +has headers => (is => 'rw'); +has size => (is => 'rw'); +has tempname => (is => 'rw'); +has type => (is => 'rw'); +has basename => (is => 'rw'); + +has fh => ( + is => 'rw', + required => 1, + lazy => 1, + default => sub { + my $self = shift; -use IO::File; + 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': '$!'/ ); + } -__PACKAGE__->mk_accessors(qw/filename size tempname type/); + return $fh; + }, +); -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->fh + $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' ); + +It is provided a way to have configurable temporary directory. +If there is no config uploadtmp, system temprary directory will used. + + __PACKAGE__->config( uploadtmp => '/path/to/tmpdir' ); + 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 +=head2 $upload->new + +Simple constructor. + +=head2 $upload->copy_to -=item $upload->fh +Copies the temporary file using L. Returns true for success, +false for failure. -Opens tempname and returns a C handle. + $upload->copy_to('/path/to/target'); =cut -sub fh { +sub copy_to { my $self = shift; + return File::Copy::copy( $self->tempname, @_ ); +} - my $fh = IO::File->new( $self->tempname, O_RDONLY ) - or die( "Can't open ", $self->tempname, ": ", $! ); +=head2 $upload->fh - return $fh; -} +Opens a temporary file (see tempname below) and returns an L handle. + +=head2 $upload->filename -=item $upload->filename +Returns the client-supplied filename. -Contains client supplied filename. +=head2 $upload->headers -=item $upload->link +Returns an L object for the request. -Creates a new filename linked to the old filename. Returns true for -success, false otherwise. +=head2 $upload->link_to - $upload->link('/my/path'); +Creates a hard link to the temporary file. Returns true for success, +false for failure. + + $upload->link_to('/path/to/target'); =cut -sub link { - my $self = shift; - my $target = shift; +sub link_to { + my ( $self, $target ) = @_; + return CORE::link( $self->tempname, $target ); +} + +=head2 $upload->size + +Returns the size of the uploaded file in bytes. - return link( $self->tempname, $target ); +=head2 $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; +} + +sub basename { + my $self = shift; + unless ( $self->{basename} ) { + my $basename = $self->filename; + $basename =~ s|\\|/|g; + $basename = ( File::Spec::Unix->splitpath($basename) )[2]; + $basename =~ s|[^\w\.-]+|_|g; + $self->{basename} = $basename; + } + + return $self->{basename}; } -=item $upload->size +=head2 $upload->basename -Contains size of the file in bytes. +Returns basename for C. -=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 + +=head1 AUTHORS Sebastian Riedel, C + Christian Hansen, C =head1 COPYRIGHT @@ -94,4 +184,6 @@ it under the same terms as Perl itself. =cut +__PACKAGE__->meta->make_immutable; + 1;