authors cleanup

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Request / Upload.pm

diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm
index ee1e5e2..224b29c 100644 (file)
--- a/lib/Catalyst/Request/Upload.pm
+++ b/lib/Catalyst/Request/Upload.pm
@@ -3,89 +3,164 @@ package Catalyst::Request::Upload;
 use strict;
 use base 'Class::Accessor::Fast';
 
-use IO::File;
+use Catalyst::Exception;
+use File::Copy ();
+use IO::File   ();
+use File::Spec::Unix;
 
-__PACKAGE__->mk_accessors(qw/filename size tempname type/);
+__PACKAGE__->mk_accessors(qw/filename headers size tempname type basename/);
 
 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->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' );
+
 See also L<Catalyst>.
 
 =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
+
+Copies the temporary file using L<File::Copy>. Returns true for success,
+false for failure.
+
+     $upload->copy_to('/path/to/target');
+
+=cut
+
+sub copy_to {
+    my $self = shift;
+    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, 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
+=head2 $upload->headers
 
-Creates a new filename linked to the old filename.  Returns true for
-success, false otherwise.
+Returns an L<HTTP::Headers> object for the request.
 
-    $upload->link('/my/path');
+=head2 $upload->link_to
 
-=cut
+Creates a hard link to the temporary file. Returns true for success, 
+false for failure.
+
+    $upload->link_to('/path/to/target');
 
-sub link {
-    my $self   = shift;
-    my $target = shift;
+=cut
 
+sub link_to {
+    my ( $self, $target ) = @_;
     return CORE::link( $self->tempname, $target );
 }
 
-=item $upload->size
+=head2 $upload->size
+
+Returns the size of the uploaded file in bytes.
+
+=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};
+}
 
-Contains size of the file in bytes.
+=head2 $upload->basename
 
-=item $upload->tempname
+Returns basename for C<filename>.
 
-Contains path to the temporary spool file.
+=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
+=head1 AUTHORS
 
-Sebastian Riedel, C<sri@cpan.org>
-Christian Hansen, C<ch@ngmedia.com>
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT