X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest%2FUpload.pm;h=d8e58bea7e0f7834b39ad0b9048d648b482d1e52;hb=f8db2ed7cc69853222729adfdbb48e5e4bea9bd2;hp=9a5f1c4e6b3969e61f9c4a0c60c33e9d050c87df;hpb=b5ecfcf07b8ffe7e9984f0279c8781ce51c6ac6a;p=catagits%2FCatalyst-Runtime.git diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm index 9a5f1c4..d8e58be 100644 --- a/lib/Catalyst/Request/Upload.pm +++ b/lib/Catalyst/Request/Upload.pm @@ -1,15 +1,51 @@ 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; + }, +); + +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; +} -__PACKAGE__->mk_accessors(qw/filename headers size tempname type/); +no Moose; -sub new { shift->SUPER::new( ref( $_[0] ) ? $_[0] : {@_} ) } +=for stopwords uploadtmp =head1 NAME @@ -17,6 +53,9 @@ Catalyst::Request::Upload - handles file upload requests =head1 SYNOPSIS + my $upload = $c->req->upload('field'); + + $upload->basename; $upload->copy_to; $upload->fh; $upload->filename; @@ -27,6 +66,11 @@ Catalyst::Request::Upload - handles file upload requests $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. =head1 DESCRIPTION @@ -57,24 +101,6 @@ sub copy_to { 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 ); - - unless ( defined $fh ) { - - my $filename = $self->tempname; - - Catalyst::Exception->throw( - message => qq/Can't open '$filename': '$!'/ ); - } - - return $fh; -} - =head2 $upload->filename Returns the client-supplied filename. @@ -85,7 +111,7 @@ Returns an L object for the request. =head2 $upload->link_to -Creates a hard link to the temporary file. Returns true for success, +Creates a hard link to the temporary file. Returns true for success, false for failure. $upload->link_to('/path/to/target'); @@ -105,6 +131,10 @@ Returns the size of the uploaded file in bytes. Returns a scalar containing the contents of the temporary file. +Note that this will cause the filehandle pointed to by C<< $upload->fh >> to +be reset to the start of the file using seek and the file handle to be put +into binary mode. + =cut sub slurp { @@ -119,13 +149,19 @@ sub slurp { 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; } +=head2 $upload->basename + +Returns basename for C. + =head2 $upload->tempname Returns the path to the temporary file. @@ -134,17 +170,21 @@ Returns the path to the temporary file. Returns the client-supplied Content-Type. -=head1 AUTHORS +=head2 meta + +Provided by Moose -Sebastian Riedel, C +=head1 AUTHORS -Christian Hansen, C +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;