mongrel_send_file 0.1

data/COPYING

@@ -0,0 +1 @@
+No copying restrictions/license given.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Rick Olson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,45 @@
+== mongrel_send_file GemPlugin
+
+This is a simple plugin to handle the sending of secure files from a rails app.  Here's the typical process:
+
+- Rails app authorizes user to download file
+- Rails app sets file info in the session, redirects to custom URL like /file/UNIQUE_HASH/filename
+- Mongrel handler pulls the full filename path and content type from the session using the unique hash, sends it to the user
+
+== Usage
+
+After installing the gem, you'll need to setup the handler for your Rails app:
+
+# config/mongrel_send_file.conf
+uri "/file/", :handler => plugin("/handlers/sendfile", :session_key => '_my_session_id', :session_files_key => :files), :in_front => true
+
+# rails action that sends the file
+  def download
+    # do whatever it is you do to find get the filename/content type
+    @attachment = Attachment.find(params[:id])
+    
+    # this doesn't matter as long as it's unique
+    filehash = Digest::SHA1.hexdigest( Time.now.to_s.split('//').sort_by { rand }.join )
+    
+    # initialize session.  Use the :session_files_key option here
+    session[:files] ||= {}
+    
+    # set the value for this file with a 5 minute expiration time
+    session[:files][filehash] = [5.minutes.from_now.to_i, @attachment.full_filename, @attachment.content_type]
+    
+    # redirect to the path served by mongrel_send_file
+    redirect_to "/file/#{filehash}/#{@attachment.filename}"
+  end
+  
+# startup mongrel with this command
+mongrel_rails -S config/mongrel_send_file.conf
+
+== Note
+
+I wrote this for a couple Rails apps that use the SqlSessionStore plugin [1].  So, it's very opinionated about how
+it gets the info from the session.  This app should work with any app that runs on Mongrel (not just rails), just monkey
+patch the SendFile#find_session method.  Submit suggestions as patches if you have them too.
+
+[1] - http://railsexpress.de/blog/articles/2006/09/15/sqlsessionstore-now-available-as-a-plugin
+
+

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'tools/rakehelp'
+require 'fileutils'
+include FileUtils
+
+setup_tests
+setup_clean ["pkg", "lib/*.bundle", "*.gem", ".config"]
+
+setup_rdoc ['README', 'lib/**/*.rb']
+
+desc "Does a full compile, test run"
+task :default => [:test, :package]
+
+version = "0.1"
+name = "mongrel_send_file"
+
+setup_gem(name, version) do |spec|
+  spec.summary = "The mongrel_send_file GemPlugin"
+  spec.description = spec.summary
+  spec.author = "Nobody"
+  spec.add_dependency('mongrel', '>= 0.3.13.4')
+  spec.add_dependency('gem_plugin', '>= 0.2.1')
+  spec.files += Dir.glob("resources/**/*")
+end
+
+
+task :install => [:test, :package] do
+  sh %{gem install pkg/#{name}-#{version}.gem}
+end
+
+task :uninstall => [:clean] do
+  sh %{gem uninstall #{name}}
+end
+

data/lib/mongrel_send_file/init.rb

@@ -0,0 +1,44 @@
+require 'mongrel'
+require 'gem_plugin'
+require 'digest/sha1'
+class SendFile < GemPlugin::Plugin "/handlers"
+  include Mongrel::HttpHandlerPlugin
+
+  def process(request, response)
+    files = find_session(request)
+    files.each do |hash, args|
+      files.delete(hash) if args.first < Time.now.utc.to_i
+    end
+    
+    pieces = request.params['PATH_INFO'].split('/')
+    pieces.pop # filename
+    hash = pieces.pop
+    if files[hash].nil?
+      response.start(404){}
+    else
+      send_file(files[hash][1], files[hash][2], response)
+    end
+  end
+  
+  protected
+    def send_file(filename, content_type, response)
+      file_status = File.stat(filename)
+      response.status = 200
+      # Set the last modified times as well and etag for all files
+      response.header[Mongrel::Const::LAST_MODIFIED] = file_status.mtime.httpdate
+      # Calculated the same as apache, not sure how well the works on win32
+      response.header[Mongrel::Const::ETAG] = Mongrel::Const::ETAG_FORMAT % [file_status.mtime.to_i, file_status.size, file_status.ino]
+      # set the content type to something generic for now
+      response.header[Mongrel::Const::CONTENT_TYPE] = content_type
+      # send a status with out content length
+      response.send_status(file_status.size)
+      response.send_header
+      response.send_file(filename)
+    end
+    
+    def find_session(request)
+      cookie  = Mongrel::HttpRequest.query_parse(request.params['HTTP_COOKIE'])
+      session = SqlSessionStore.session_class.find_session(cookie[@options[:session_key]])
+      Marshal.load(Base64.decode64(session.data))[@options[:session_files_key] || :files]
+    end
+end

data/resources/defaults.yml

@@ -0,0 +1,2 @@
+--- 
+:debug: false

data/tools/rakehelp.rb

@@ -0,0 +1,105 @@
+
+def make(makedir)
+    Dir.chdir(makedir) do
+        sh(PLATFORM =~ /win32/ ? 'nmake' : 'make')
+    end
+end
+
+
+def extconf(dir)
+    Dir.chdir(dir) do ruby "extconf.rb" end
+end
+
+
+def setup_tests
+    Rake::TestTask.new do |t|
+        t.libs << "test"
+        t.test_files = FileList['test/test*.rb']
+        t.verbose = true
+    end
+end
+
+
+def setup_clean otherfiles
+    files = ['build/*', '**/*.o', '**/*.so', '**/*.a', 'lib/*-*', '**/*.log'] + otherfiles
+    CLEAN.include(files)
+end
+
+
+def setup_rdoc files
+    Rake::RDocTask.new do |rdoc|
+        rdoc.rdoc_dir = 'doc/rdoc'
+        rdoc.options << '--line-numbers'
+        rdoc.rdoc_files.add(files)
+    end
+end
+
+
+def setup_extension(dir, extension)
+    ext = "ext/#{dir}"
+    ext_so = "#{ext}/#{extension}.#{Config::CONFIG['DLEXT']}"
+    ext_files = FileList[
+    "#{ext}/*.c",
+    "#{ext}/*.h",
+    "#{ext}/extconf.rb",
+    "#{ext}/Makefile",
+    "lib"
+    ] 
+    
+    task "lib" do
+        directory "lib"
+    end
+
+    desc "Builds just the #{extension} extension"
+    task extension.to_sym => ["#{ext}/Makefile", ext_so ]
+
+    file "#{ext}/Makefile" => ["#{ext}/extconf.rb"] do
+        extconf "#{ext}"
+    end
+
+    file ext_so => ext_files do
+        make "#{ext}"
+        cp ext_so, "lib"
+    end
+end
+
+
+def base_gem_spec(pkg_name, pkg_version)
+  pkg_version = pkg_version
+  pkg_name    = pkg_name
+  pkg_file_name = "#{pkg_name}-#{pkg_version}"
+  Gem::Specification.new do |s|
+    s.name = pkg_name
+    s.version = pkg_version
+    s.platform = Gem::Platform::RUBY
+    s.has_rdoc = true
+    s.extra_rdoc_files = [ "README" ]
+    
+    s.files = %w(COPYING LICENSE README Rakefile) +
+      Dir.glob("{bin,doc/rdoc,test,lib}/**/*") + 
+      Dir.glob("ext/**/*.{h,c,rb}") +
+      Dir.glob("examples/**/*.rb") +
+      Dir.glob("tools/*.rb")
+    
+    s.require_path = "lib"
+    s.extensions = FileList["ext/**/extconf.rb"].to_a
+    s.bindir = "bin"
+  end
+end
+
+def setup_gem(pkg_name, pkg_version)
+  spec = base_gem_spec(pkg_name, pkg_version)
+  yield spec if block_given?
+    
+  Rake::GemPackageTask.new(spec) do |p|
+    p.gem_spec = spec
+    p.need_tar = true
+  end
+end
+
+def setup_win32_gem(pkg_name, pkg_version)
+  spec = base_gem_spec(pkg_name, pkg_version)
+  yield spec if block_given?
+
+  Gem::Builder.new(spec).build
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: mongrel_send_file
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2006-10-16 00:00:00 -05:00
+summary: The mongrel_send_file GemPlugin
+require_paths: 
+- lib
+email: 
+homepage: 
+rubyforge_project: 
+description: The mongrel_send_file GemPlugin
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Nobody
+files: 
+- COPYING
+- LICENSE
+- README
+- Rakefile
+- lib/mongrel_send_file
+- lib/mongrel_send_file/init.rb
+- tools/rakehelp.rb
+- resources/defaults.yml
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongrel
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.13.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gem_plugin
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+    version: