Changeset 28479 for lang/perl/Catalyst-Plugin-XSendFile

Timestamp:

01/16/09 11:41:09 (4 years ago)

Author:

daisuke

Message:

start refactoring

Location:

lang/perl/Catalyst-Plugin-XSendFile/trunk

Files:

• Changes (modified) (1 diff)
• Makefile.PL (modified) (3 diffs)
• lib/Catalyst/Plugin/XSendFile.pm (modified) (10 diffs)
• t/02_basic.t (modified) (3 diffs)
• t/03_basic_oldstyle.t (added)

lang/perl/Catalyst-Plugin-XSendFile/trunk/Changes

@@ -1 +1 @@
 Revision history for Perl module Catalyst::Plugin::XSendFile
+
+0.03
+    - Refactor: 
+        * no more adding methods just to use sendfile
+        * start adding support for non-lighttpd users with xsendfile capability
 
 0.03_001 2006-12-19T19:44:16+09:00

lang/perl/Catalyst-Plugin-XSendFile/trunk/Makefile.PL

@@ -3 +3 @@
 all_from 'lib/Catalyst/Plugin/XSendFile.pm';
 
-build_requires 'Test::More';
+test_requires 'Test::More';
+test_requires 'Test::Warn';
 
 requires 'Catalyst'                 => '5.6902';
@@ -9 +10 @@
 requires 'Class::Data::Inheritable' => 0;
 requires 'File::Temp'               => 0;
-requires 'File::stat'               => 0;
 requires 'NEXT'                     => 0;
 requires 'Path::Class'              => 0;
@@ -15 +15 @@
 requires 'bytes'                    => 0;
 
-use_test_base;
 auto_include;
 WriteAll;

lang/perl/Catalyst-Plugin-XSendFile/trunk/lib/Catalyst/Plugin/XSendFile.pm

@@ -6 +6 @@
 use Catalyst::Utils;
 use File::Temp qw/tempdir tempfile/;
-use File::stat;
 use NEXT;
 use Path::Class qw/file/;
@@ -16 +15 @@
 =head1 NAME
 
-Catalyst::Plugin::XSendFile - Catalyst plugin for lighttpd's X-Sendfile.
+Catalyst::Plugin::XSendFile - Catalyst plugin for X-Sendfile.
 
 =head1 SYNOPSIS
 
+    # In your MyApp.pm
     use Catalyst qw/XSendFile/;
     
-    # manual send file
+    __PACKAGE__->config(
+        'Plugin::XSendFile' => {
+            frontend => 'lighttpd', # 'Apache' or 'lighttpd'
+        }
+    );
+
+    # In your controller
     sub show : Path('/files') {
         my ( $self, $c, $filename ) = @_;
@@ -37 +43 @@
     
     
-    # auto using x-send-tempfile on large content serving
+    # auto using x-send-tempfile on large content serving (lighttpd only)
     MyApp->config->{sendfile}{tempdir} = '/dev/shm';
 
@@ -60 +66 @@
 instead of above.
 
-But off-course you know, this feature doesn't work on Catalyst Test Server (myapp_server.pl).
+But off course, this feature doesn't work on Catalyst Test Server (myapp_server.pl).
 So this module also provide its emulation when your app on test server.
 
@@ -80 +86 @@
 Faster - FastCGI
 http://blog.lighttpd.net/articles/2006/11/29/faster-fastcgi
+
+mod_xsendfile - X-Sendfile for Apache
+http://tn123.ath.cx/mod_xsendfile/ (Old)
+http://tn123.ath.cx/mod_xsendfile/beta/ (Beta, but supports Apache2.2)
 
 =head1 NOTICE
@@ -103 +113 @@
     $c->NEXT::setup(@_);
 
-    my $tempdir = $c->config->{sendfile}{tempdir}
-      || Catalyst::Utils::class2tempdir($c, 1);
-
-    __PACKAGE__->mk_classdata(
-        _sendfile_tempdir => tempdir( DIR => $tempdir, CLEANUP => 1 ) );
+    my $config  = $c->config->{'Plugin::XSendFile'};
+    if (! $config && ($config = $c->config->{sendfile})) {
+        warn "Old-style configuration detected. Please use 'Plugin::XSendFile' key instead of 'sendfile'";
+        delete $c->config->{sendfile};
+    }
+
+    $config ||= {};
+
+    my $frontend = $config->{frontend} || 'lighttpd';
+    if ($frontend =~ /^lighttpd$/i) {
+        $config->{sendfile_header} ||= 'X-LIGHTTPD-send-file';
+        $config->{sendfile_temp_header} ||= 'X-LIGHTTPD-send-tempfile';
+    } else {
+        $config->{sendfile_header} ||= 'X-SENDFILE';
+        $config->{sendfile_temp_header} ||= '';
+    }
+
+    $config->{tempdir} ||= Catalyst::Utils::class2tempdir($c, 1);
+    $c->config->{'Plugin::XSendFile'} = $config;
 
     $c;
@@ -121 +145 @@
     my $c = shift;
 
+    my $res    = $c->response;
+    my $config = $c->config->{'Plugin::XSendFile'};
     my $engine = $ENV{CATALYST_ENGINE} || '';
 
     # X-Sendfile emulation for test server.
     if ( $engine =~ /^HTTP/ ) {
-        if ( my $sendfile = file( $c->res->header('X-LIGHTTPD-send-file') ) ) {
-            $c->res->headers->remove_header('X-LIGHTTPD-send-file');
-            if ( $sendfile->stat && -f _ && -r _ ) {
-                $c->res->body( $sendfile->openr );
+        if ( my $sendfile = file( $res->header('X-LIGHTTPD-send-file') ) ) {
+            $res->headers->remove_header('X-LIGHTTPD-send-file');
+            if ( stat($sendfile) && -f _ && -r _ ) {
+                $res->body( $sendfile->openr );
             }
         }
     }
     elsif ( $engine eq 'FastCGI' ) {
-
-        if ( my $body = $c->res->body ) {
-            my ( $fh, $tempfile ) = tempfile( DIR => $c->_sendfile_tempdir );
+        if ( my $body = $res->body ) {
+            my ( $fh, $tempfile ) = tempfile( DIR => $config->{tempdir} );
 
             if ( blessed($body) && $body->can('read') or ref($body) eq 'GLOB' ) {
-                my $stat = stat $body;
-                if ( $stat and $stat->size >= 16*1024 ) {
+                my $size = (stat($body))[7];
+                if ( $size and $size >= 16*1024 ) {
                     while ( !eof $body ) {
                         read $body, my ($buffer), 4096;
@@ -147 +172 @@
                     close $fh;
 
-                    $c->res->send_tempfile($tempfile);
+                    $res->send_tempfile($tempfile);
                 }
             }
@@ -154 +179 @@
                 $fh->close;
 
-                $c->res->send_tempfile($tempfile);
+                $res->send_tempfile($tempfile);
             }
         }
@@ -177 +202 @@
         my ($self, $file) = @_;
         $self->{body} = '';
+
+        # default lighttpd, but if configured otherwise, we use
+        # x-sendfile
         $self->header( 'X-LIGHTTPD-send-file' => $file );
     }

lang/perl/Catalyst-Plugin-XSendFile/trunk/t/02_basic.t

@@ -3 +3 @@
 use strict;
 use warnings;
+use Test::More (tests => 8);
 
 use FindBin;
@@ -8 +9 @@
 use lib File::Spec->catfile($FindBin::Bin, 'lib');
 
-use Test::Base;
 use Catalyst::Test 'TestApp';
 use File::Temp qw/tempdir/;
 
-plan tests => 8;
-
-TestApp->config->{sendfile}{tempdir} = tempdir( CLEANUP => 1 );
+TestApp->config->{'Plugin::XSendFile'}{tempdir} = tempdir( CLEANUP => 1 );
 TestApp->setup;
 
@@ -24 +22 @@
 is( $res->header('X-LIGHTTPD-send-file'), $image_fn, 'correct sendfile header');
 
-# sendfile: lighty emuration
+# sendfile: lighty emulation
 {
     local $ENV{CATALYST_ENGINE} = 'HTTP';