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 f93a838..224b29c 100644 (file)
--- a/lib/Catalyst/Request/Upload.pm
+++ b/lib/Catalyst/Request/Upload.pm
@@ -6,8 +6,9 @@ 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] : {@_} ) }
 
@@ -17,6 +18,7 @@ Catalyst::Request::Upload - handles file upload requests
 
 =head1 SYNOPSIS
 
+    $upload->basename;
     $upload->copy_to;
     $upload->fh;
     $upload->filename;
@@ -27,6 +29,11 @@ Catalyst::Request::Upload - handles file upload requests
     $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
@@ -35,13 +42,11 @@ This class provides accessors and methods to handle client upload requests.
 
 =head1 METHODS
 
-=over 4
-
-=item $upload->new
+=head2 $upload->new
 
 Simple constructor.
 
-=item $upload->copy_to
+=head2 $upload->copy_to
 
 Copies the temporary file using L<File::Copy>. Returns true for success,
 false for failure.
@@ -55,7 +60,7 @@ sub copy_to {
     return File::Copy::copy( $self->tempname, @_ );
 }
 
-=item $upload->fh
+=head2 $upload->fh
 
 Opens a temporary file (see tempname below) and returns an L<IO::File> handle.
 
@@ -77,15 +82,15 @@ sub fh {
     return $fh;
 }
 
-=item $upload->filename
+=head2 $upload->filename
 
 Returns the client-supplied filename.
 
-=item $upload->headers
+=head2 $upload->headers
 
 Returns an L<HTTP::Headers> object for the request.
 
-=item $upload->link_to
+=head2 $upload->link_to
 
 Creates a hard link to the temporary file. Returns true for success, 
 false for failure.
@@ -99,11 +104,11 @@ sub link_to {
     return CORE::link( $self->tempname, $target );
 }
 
-=item $upload->size
+=head2 $upload->size
 
 Returns the size of the uploaded file in bytes.
 
-=item $upload->slurp
+=head2 $upload->slurp
 
 Returns a scalar containing the contents of the temporary file.
 
@@ -128,21 +133,34 @@ 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>.
+
+=head2 $upload->tempname
 
 Returns the path to the temporary file.
 
-=item $upload->type
+=head2 $upload->type
 
 Returns the client-supplied Content-Type.
 
-=back
-
 =head1 AUTHORS
 
-Sebastian Riedel, C<sri@cpan.org>
-
-Christian Hansen, C<ch@ngmedia.com>
+Catalyst Contributors, see Catalyst.pm
 
 =head1 COPYRIGHT