X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest%2FUpload.pm;h=80a3624b379fb361893c8608b857385ee8bb1eaf;hb=7c48f3f64ce15094564731aea15afbd0d8a87904;hp=a31df3d5ad7e692c2597c11b93a31cf6e17ce8f7;hpb=32d4bba8cb8276572093428eef50bf0bda59aa3d;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm
index a31df3d..80a3624 100644
--- a/lib/Catalyst/Request/Upload.pm
+++ b/lib/Catalyst/Request/Upload.pm
@@ -3,49 +3,56 @@ package Catalyst::Request::Upload;
 use strict;
 use base 'Class::Accessor::Fast';
 
+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->copy_to
-    $upload->fh
+    $upload->copy_to;
+    $upload->fh;
     $upload->filename;
+    $upload->headers;
     $upload->link_to;
     $upload->size;
     $upload->slurp;
     $upload->tempname;
     $upload->type;
 
-See also L<Catalyst>.
+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.
 
-=head1 DESCRIPTION
+    __PACKAGE__->config( uploadtmp => '/path/to/tmpdir' );
 
-This is the Catalyst Request Upload class, which provides a set of accessors 
-to the upload data.
+It is provided a way to have configurable temporary directory.
+If there is no config uploadtmp, system temprary directory will used.
 
-=head1 METHODS
+    __PACKAGE__->config( uploadtmp => '/path/to/tmpdir' );
 
-=over 4
+See also L<Catalyst>.
 
-=item $upload->new
+=head1 DESCRIPTION
+
+This class provides accessors and methods to handle client upload requests.
 
-Constructor. Normally only for engine use.
+=head1 METHODS
 
-=cut 
+=head2 $upload->new
 
-sub new { shift->SUPER::new( ref( $_[0] ) ? $_[0] : {@_} ) }
+Simple constructor.
 
-=item $upload->copy_to
+=head2 $upload->copy_to
 
-Copies tempname using C<File::Copy>. Returns true for success, false otherwise.
+Copies the temporary file using L<File::Copy>. Returns true for success,
+false for failure.
 
      $upload->copy_to('/path/to/target');
 
@@ -56,29 +63,40 @@ sub copy_to {
     return File::Copy::copy( $self->tempname, @_ );
 }
 
-=item $upload->fh
+=head2 $upload->fh
 
-Opens tempname and returns a C<IO::File> handle.
+Opens a temporary file (see tempname below) and returns an L<IO::File> handle.
 
 =cut
 
 sub fh {
     my $self = shift;
 
-    my $fh = IO::File->new( $self->tempname, IO::File::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
+=head2 $upload->filename
 
-Contains client supplied filename.
+Returns the client-supplied filename.
 
-=item $upload->link_to
+=head2 $upload->headers
 
-Creates a hard link to the tempname.  Returns true for success, 
-false otherwise.
+Returns an L<HTTP::Headers> object for the request.
+
+=head2 $upload->link_to
+
+Creates a hard link to the temporary file. Returns true for success, 
+false for failure.
 
     $upload->link_to('/path/to/target');
 
@@ -89,20 +107,20 @@ 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
 
 sub slurp {
     my ( $self, $layer ) = @_;
 
-    unless ( $layer ) {
+    unless ($layer) {
         $layer = ':raw';
     }
 
@@ -118,19 +136,18 @@ sub slurp {
     return $content;
 }
 
-=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
-
-=head1 AUTHOR
+=head1 AUTHORS
 
 Sebastian Riedel, C<sri@cpan.org>
+
 Christian Hansen, C<ch@ngmedia.com>
 
 =head1 COPYRIGHT