X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FRequest%2FUpload.pm;h=e5922c27363729c3e4e08a4bd5c9da9fb4023be9;hb=3e22baa5ca02859b9180a0ec17d49fd204f5ba37;hp=25e6d89f58f52183f8c1d44666367a715c72b4c6;hpb=4be535b191e65b338b0c7d62b7c6acad83f7d455;p=catagits%2FCatalyst-Runtime.git

diff --git a/lib/Catalyst/Request/Upload.pm b/lib/Catalyst/Request/Upload.pm
index 25e6d89..e5922c2 100644
--- a/lib/Catalyst/Request/Upload.pm
+++ b/lib/Catalyst/Request/Upload.pm
@@ -6,19 +6,21 @@ use base 'Class::Accessor::Fast';
 use Catalyst::Exception;
 use File::Copy ();
 use IO::File   ();
+use File::Spec::Unix;
 
-__PACKAGE__->mk_accessors(qw/filename headers 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->copy_to
-    $upload->fh
+    $upload->basename;
+    $upload->copy_to;
+    $upload->fh;
     $upload->filename;
     $upload->headers;
     $upload->link_to;
@@ -27,24 +29,32 @@ 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' );
+
+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<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
-
-=item $upload->new
+=head2 $upload->new
 
-simple constructor.
+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');
 
@@ -55,9 +65,9 @@ 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
 
@@ -77,18 +87,18 @@ sub fh {
     return $fh;
 }
 
-=item $upload->filename
+=head2 $upload->filename
 
-Contains client supplied filename.
+Returns the client-supplied filename.
 
-=item $upload->headers
+=head2 $upload->headers
 
-Returns a C<HTTP::Headers> object.
+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');
 
@@ -99,13 +109,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,19 +138,35 @@ 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<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>
 
 =head1 COPYRIGHT