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=dfb169bb368ef1207797aae98cbba6d6bd33fc2c;hp=25e6d89f58f52183f8c1d44666367a715c72b4c6;hb=2f3812528068bc1d9f7840067f0c03d36cd47e6d;hpb=4be535b191e65b338b0c7d62b7c6acad83f7d455 diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm index 25e6d89..dfb169b 100644 --- a/lib/Catalyst/Request/Upload.pm +++ b/lib/Catalyst/Request/Upload.pm @@ -1,24 +1,48 @@ 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 -Catalyst::Request::Upload - Catalyst Request Upload Class +Catalyst::Request::Upload - handles file upload requests =head1 SYNOPSIS - $upload->copy_to - $upload->fh + $upload->basename; + $upload->copy_to; + $upload->fh; $upload->filename; $upload->headers; $upload->link_to; @@ -27,24 +51,27 @@ Catalyst::Request::Upload - Catalyst Request Upload Class $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 -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 +=head2 $upload->new -simple constructor. +Simple constructor. -=item $upload->copy_to +=head2 $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'); @@ -55,40 +82,22 @@ sub copy_to { return File::Copy::copy( $self->tempname, @_ ); } -=item $upload->fh - -Opens tempname and returns a C 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': '$!'/ ); - } +=head2 $upload->fh - return $fh; -} +Opens a temporary file (see tempname below) and returns an L handle. -=item $upload->filename +=head2 $upload->filename -Contains client supplied filename. +Returns the client-supplied filename. -=item $upload->headers +=head2 $upload->headers -Returns a C object. +Returns an L object for the request. -=item $upload->link_to +=head2 $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'); @@ -99,13 +108,13 @@ sub link_to { return CORE::link( $self->tempname, $target ); } -=item $upload->size +=head2 $upload->size -Contains size of the file in bytes. +Returns the size of the uploaded file in bytes. -=item $upload->slurp +=head2 $upload->slurp -Returns a scalar containing contents of tempname. +Returns a scalar containing the contents of the temporary file. =cut @@ -128,20 +137,38 @@ 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; + } -Contains path to the temporary spool file. + return $self->{basename}; +} + +=head2 $upload->basename + +Returns basename for C. + +=head2 $upload->tempname -=item $upload->type +Returns the path to the temporary file. -Contains client supplied Content-Type. +=head2 $upload->type -=back +Returns the client-supplied Content-Type. -=head1 AUTHOR +=head2 meta -Sebastian Riedel, C -Christian Hansen, C +Provided by Moose + +=head1 AUTHORS + +Catalyst Contributors, see Catalyst.pm =head1 COPYRIGHT @@ -150,4 +177,6 @@ it under the same terms as Perl itself. =cut +__PACKAGE__->meta->make_immutable; + 1;