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=ed3b0f595b9eb9803ded389f3314ac00cf2c0c28;hp=43a7cff191bfded79a5611a98b41a1f4adeb3013;hb=ae29b412955743885e80350085167b54b69672da;hpb=b549b04945e1756688a2e79d7b065fe201001b6a

diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm
index 43a7cff..ed3b0f5 100644
--- a/lib/Catalyst/Request/Upload.pm
+++ b/lib/Catalyst/Request/Upload.pm
@@ -1,44 +1,89 @@
 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 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 => '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': '$!'/ );
+    }
 
-__PACKAGE__->mk_accessors(qw/filename size tempname type/);
+    return $fh;
+  },
+);
 
-sub new { shift->SUPER::new( ref( $_[0] ) ? $_[0] : {@_} ) }
+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;
+}
+
+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
+    my $upload = $c->req->upload('field');
+
+    $upload->basename;
+    $upload->copy_to;
+    $upload->fh;
     $upload->filename;
+    $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.
 
-=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');
 
@@ -49,29 +94,22 @@ 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;
+=head2 $upload->filename
 
-    my $fh = IO::File->new( $self->tempname, IO::File::O_RDONLY )
-      or die( "Can't open ", $self->tempname, ": ", $! );
-
-    return $fh;
-}
+Returns the client-supplied filename.
 
-=item $upload->filename
+=head2 $upload->headers
 
-Contains client supplied filename.
+Returns an L<HTTP::Headers> 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');
 
@@ -82,20 +120,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';
     }
 
@@ -111,20 +149,25 @@ sub slurp {
     return $content;
 }
 
-=item $upload->tempname
+=head2 $upload->basename
+
+Returns basename for C<filename>.
+
+=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
+=head2 meta
 
-=head1 AUTHOR
+Provided by Moose
 
-Sebastian Riedel, C<sri@cpan.org>
-Christian Hansen, C<ch@ngmedia.com>
+=head1 AUTHORS
+
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT
 
@@ -133,4 +176,6 @@ it under the same terms as Perl itself.
 
 =cut
 
+__PACKAGE__->meta->make_immutable;
+
 1;