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=f93a838c61b2c86bcd38b71f1b13fbea3c7c2e67;hb=4090e3bb3fea1a73ac369250e31584d61428b808;hpb=bab3a22c7bc0c348a5f336c50eaac376664862a4 diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm index f93a838..b1bd4e6 100644 --- a/lib/Catalyst/Request/Upload.pm +++ b/lib/Catalyst/Request/Upload.pm @@ -1,15 +1,38 @@ 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; + + 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 headers size tempname type/); + return $fh; + }, +); -sub new { shift->SUPER::new( ref( $_[0] ) ? $_[0] : {@_} ) } +no Moose; =head1 NAME @@ -17,6 +40,7 @@ Catalyst::Request::Upload - handles file upload requests =head1 SYNOPSIS + $upload->basename; $upload->copy_to; $upload->fh; $upload->filename; @@ -27,6 +51,16 @@ 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' ); + +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 @@ -35,13 +69,11 @@ This class provides accessors and methods to handle client upload requests. =head1 METHODS -=over 4 - -=item $upload->new +=head2 $upload->new Simple constructor. -=item $upload->copy_to +=head2 $upload->copy_to Copies the temporary file using L. Returns true for success, false for failure. @@ -55,37 +87,19 @@ sub copy_to { return File::Copy::copy( $self->tempname, @_ ); } -=item $upload->fh +=head2 $upload->fh 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; -} - -=item $upload->filename +=head2 $upload->filename Returns the client-supplied filename. -=item $upload->headers +=head2 $upload->headers Returns an L object for the request. -=item $upload->link_to +=head2 $upload->link_to Creates a hard link to the temporary file. Returns true for success, false for failure. @@ -99,11 +113,11 @@ sub link_to { return CORE::link( $self->tempname, $target ); } -=item $upload->size +=head2 $upload->size Returns the size of the uploaded file in bytes. -=item $upload->slurp +=head2 $upload->slurp Returns a scalar containing the contents of the temporary file. @@ -128,15 +142,34 @@ sub slurp { return $content; } -=item $upload->tempname +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}; +} + +=head2 $upload->basename + +Returns basename for C. + +=head2 $upload->tempname Returns the path to the temporary file. -=item $upload->type +=head2 $upload->type Returns the client-supplied Content-Type. -=back +=head2 meta + +Provided by Moose =head1 AUTHORS @@ -151,4 +184,6 @@ it under the same terms as Perl itself. =cut +__PACKAGE__->meta->make_immutable; + 1;