sinatra-torrent 0.0.3

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sinatra-torrent"
+    gem.description = "An extension to Sinatra which will allow you to run a webseeded torrent tracker of files in the folder you specify."
+    gem.summary = "A sinatra extension to run webseeded torrent tracker"
+    gem.email = "jphastings@gmail.com"
+    gem.homepage = "http://github.com/jphastings/sinatra-torrent"
+    gem.authors = ["JP Hastings-Spital"]
+    
+    gem.add_dependency('sinatra','>=1.1.2') # Required for send_file modifications
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test

data/Readme.md

@@ -0,0 +1,37 @@
+Sinatra-Torrent
+===============
+
+There was [a /. article](http://ask.slashdot.org/story/10/10/04/0035231) about BitTorrent replacing standard downloads and I thought: Yes.
+
+Ruby doesn't appear to like BitTorrent very much, most libraries are pretty old and I figured I'd spruce up my favourite jazz legend themed DSL with a library to make serving torrents *ridiculously* easy.
+
+Usage
+-----
+
+    require 'sinatra'
+    require 'sinatra/torrent'
+
+"Woah, that's pretty simple!" I hear you say. Why yes, I think it is.
+
+All files you put in the `downloads` directory at the root of your sinatra app will be downloadable at `/downloads/your_file.ext` and it's torrent will be dynamically generated (and cached) at `/torrents/your_file.ext.torrent`. You will have trouble with larger files as it currently hashes as part of the request first time round. I'm planning on pushing this out to workers at some point. Not yet sure how I'm going to do that…
+
+**NB.** Files that take longer than 1s to hash will fail at the moment!
+
+The extension is in it's early stages at the moment, so many of the settings aren't adhered to, and there are some issues with the webseeding… however it *does* work.
+
+### I want options!
+
+There needs to be a database of torrents and peers, this is taken care of by a database adapter. Currently I've written (a breally basic) one for active record, so many databases are supported. I'm still finding my way around the Sinatra extensions api, so this is how you specify your own ActiveRecord settings:
+
+    require 'sinatra'
+    require 'sinatra/torrent/activerecord'
+    SinatraTorrentDatabase.settings = {
+	  'adapater' => 'sqlite3',
+	  'database' => 'torrents.db'
+    }
+    require 'sinatra/torrent'
+
+Ummmm
+-----
+
+That's it for now. If you have any feed back - get in touch! You can use [twitter](http://twitter.com/jphastings), [github issues](http://github.com/jphastings/sinatra-torrent/issues) or any other medium you can think of.

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/sinatra/torrent.rb

@@ -0,0 +1,161 @@
+require 'timeout'
+require 'time'
+require 'digest/sha1'
+require 'bencode'
+require 'sinatra/base'
+
+# This extension will serve up the contents of the specified folder as web seeded torrents.
+# Both webseed versions are supported (shad0w's and GetRight's) and there is an inbuilt tracker
+# with a modicum of intelligence, though an external tracker can be used if desired.
+
+module Sinatra
+  module Torrent
+    
+    # Options etc
+    def self.registered(app)
+      # Putting the annouce URL of a tracker in here will use that tracker rather than the inbuilt one
+      app.set :external_tracker, nil
+      # Directory which holds all the files which will be provided as torrents
+      app.set :downloads_directory, File.dirname(__FILE__)+'downloads'
+      # Mount point for the downloads directory
+      app.set :downloads_mount, 'downloads'
+      # Mount point for the torrents directory
+      app.set :torrents_mount, 'torrents'
+      # Load up a database adapter if one isn't already loaded
+      require 'sinatra/torrent/activerecord' unless (Sinatra::Torrent.const_defined?('Database') rescue false)
+      # Stores the instance of the database used to store tracker info.
+      app.set :database_adapter, Sinatra::Torrent::Database.new
+      # The comment added into torrents
+      app.set :torrent_comment, ''
+      # Do we wish to track external torrents too? (untested)
+      app.set :allow_external_torrents, false
+      # The frequency with which we ask trackers to announce themselves. Once every x seconds
+      app.set :announce_frequency, 30
+      
+# TORRENTS
+
+      app.mime_type :torrent, 'application/x-bittorrent'
+
+      # Serves up the torrents with appropriate announce URL
+      app.get Regexp.new("^/#{app.options.torrents_mount}/(.+)\.torrent$") do |rel_location|
+        filename = File.join(options.downloads_directory, rel_location)
+        halt(404, "That file doesn't exist! #{filename}") unless File.exists?(filename)
+        
+        if true #!(d = options.database_adapter.torrent_by_path_and_timestamp(filename,File.mtime(filename)))
+          
+          d = {
+            'metadata' => {
+              # TODO: Version?
+              'created by' => 'sinatra-torrent (0.0.1) (http://github.com/jphastings/sinatra-torrent)',
+              'creation date' => Time.now.to_i,
+              'info' => {
+                'name' => File.basename(rel_location),
+                'length' => File.size(filename),
+                'piece length' => 2**10, # TODO: Choose reasonable piece size
+                'pieces' => ''
+              }
+            }
+          }
+          
+          begin
+            file = open(filename,'r')
+            
+            Timeout::timeout(1) do
+              begin
+                d['metadata']['info']['pieces'] += Digest::SHA1.digest(file.read(d['metadata']['info']['piece length']))
+              end until file.eof?
+            end
+          rescue Timeout::Error
+            # TODO: Actually run it in the background!
+            halt(503,"This torrent is taking too long to build, we're [not currently supporting!] running it in the background. Please try again in a few minutes.")
+          ensure
+            file.close
+          end
+          
+          d['infohash'] = Digest::SHA1.hexdigest(d['metadata']['info'].bencode)
+          options.database_adapter.store_torrent(filename,File.mtime(filename),d['metadata'],d['infohash'])
+        end
+        
+        # These are options which could change between database retrievals
+        d['metadata'].merge!({
+          'httpseeds' => [File.join('http://'+env['HTTP_HOST'],URI.encode(options.torrents_mount),'webseed')],
+          'url-list' => [File.join('http://'+env['HTTP_HOST'],URI.encode(options.downloads_mount),URI.encode(rel_location)+'?'+d['infohash'])],
+          'announce' => options.external_tracker || File.join('http://'+env['HTTP_HOST'],URI.encode(options.torrents_mount),'announce'),
+          'comment' => options.torrent_comment,
+        })
+        
+        content_type :torrent, :charset => 'utf-8'
+        d['metadata'].bencode
+      end
+      
+# TRACKER
+      
+      # Tracker announce mount point
+      app.get "/#{app.options.torrents_mount}/announce" do
+        # Convert to a hex info_hash if required TODO: Is it required?
+        params['info_hash'] = Digest.hexencode(params['info_hash'] || '')
+        halt(400,"A valid info-hash was not given") if params['info_hash'].match(/^[0-9a-f]{40}$/).nil?
+        info = options.database_adapter.torrent_info(params['info_hash'])
+        
+        if (!options.allow_external_torrents and !options.database_adapter.torrent_by_infohash(params['info_hash']))
+          return {
+            'failure reason' => 'This tracker does not track that torrent'
+          }.bencode
+        end
+        
+        # TODO: Validation
+        
+        params['ip'] ||= env['REMOTE_ADDR']
+        
+        # Errmmm - HACK!
+        params['peer_id'] = params['peer_id'].force_encoding("ISO-8859-1")
+        
+        # Registers this peer's announcement
+        options.database_adapter.announce(params)
+
+        {
+          'interval' => options.announce_frequency,
+          #'tracker id' => 'bleugh', # TODO: Keep this?
+          'complete' => info['complete'],
+          'incomplete' => info['incomplete'],
+          'peers' => options.database_adapter.peers_by_infohash(params['info_hash'],[params['peer_id']],(params['numwant'] || 50).to_i),
+        }.bencode
+      end
+      
+      # TODO: Scrape
+      app.get '/torrents/scrape' do
+        # TODO: Make it work!
+      end
+
+# INDEX PAGE
+      app.get "/#{app.options.torrents_mount}/" do
+        haml :torrents_index,:locals => {:torrents => Dir.glob("#{options.downloads_directory}/**").collect {|f| f[options.downloads_directory.length+1..-1] } }
+      end
+
+# DATA
+
+      # BitTornado WebSeeding manager
+      app.get "/#{app.options.torrents_mount}/webseed" do
+        # Which file is the client looking for?
+        halt(404, "Torrent not tracked") unless (options.database_adapter.torrent_by_infohash(params[:infohash]))
+        
+        # http://bittornado.com/docs/webseed-spec.txt
+        
+        # TODO: intelligent wait period
+        halt(503,"15") if false # ask clients to wait 15 seconds before requesting again
+      end
+      
+      # Provides the files for web download. Any query parameters are treated as a checksum for the file (via the torrent infohash)
+      app.get "/#{app.options.downloads_mount}/:filename" do
+        filename = File.join(options.downloads_directory,File.expand_path('/'+params[:filename]))
+        halt(404) unless File.exists?(filename)
+        
+        # If there are query params then we assume it's specifying a specific version of the file by info_hash
+        halt(409,"The file is no longer the same as the one specified in your torrent") if !env['QUERY_STRING'].empty? and (options.database_adapter.torrent_by_path_and_timestamp(filename,File.mtime(filename))['infohash'] rescue nil) != env['QUERY_STRING'] 
+        send_file(filename)
+      end
+    end
+  end
+  
+  register Torrent
+end

data/lib/sinatra/torrent/activerecord.rb

@@ -0,0 +1,143 @@
+# The active record adapter works with SQLite3 in memory by default
+require 'active_record'
+
+module Sinatra
+  module Torrent
+    # This is the wrapper class used by sinatra-torrent to communicate with
+    # any database system
+    class Database
+      # Default settings for the connection
+      @@settings = {
+        'adapter' => 'sqlite3',
+        'database' => ':memory:'
+      }
+  
+      # Allows the set up of Active Record 
+      def self.settings=(settings)
+        raise ArgumentError if !settings.is_a?(Hash)
+        @@settings = settings
+      end
+  
+      # Makes sure the table is present & ready, log in using the settings
+      def initialize
+        @db = ActiveRecord::Base.establish_connection(@@settings)
+    
+        unless Torrent.table_exists?
+          ActiveRecord::Schema.define do
+            create_table :torrents do |table|
+              table.text :path, :null => false
+              table.text :metadata, :null => false
+              table.string :infohash, :null => false
+              table.timestamp :timestamp, :null => false
+            end
+        
+            add_index :torrents, :infohash, :unique => true
+        
+            create_table :peers do |table|
+              table.string :torrent_infohash, :null => false
+              table.string :peer_id
+              table.integer :port
+              table.integer :uploaded
+              table.integer :downloaded
+              table.integer :left
+              table.string :ip
+          
+              table.timestamps
+            end
+        
+            add_index :peers, [:peer_id,:torrent_infohash],:unique => true
+          end
+        end
+      end
+  
+      # Stores a torrent in the database
+      def store_torrent(path,timestamp,metadata,infohash)
+        # Make sure this path and this infohash don't already exist
+        Torrent.find_by_path_and_timestamp(path,timestamp).delete rescue nil
+        Torrent.find_by_infohash(infohash).delete rescue nil
+    
+        Torrent.new(
+          :path => path,
+          :metadata => metadata,
+          :infohash => infohash,
+          :timestamp => timestamp
+        ).save
+      end
+  
+      # Find a torrent by infohash
+      def torrent_by_infohash(infohash)
+        torrent = Torrent.find_by_infohash(infohash)
+        return false if torrent.nil?
+    
+        {
+          'metadata' => torrent.metadata,
+          'infohash' => torrent.infohash,
+          'path'     => torrent.path,
+          'timestamp'=> torrent.timestamp
+        }
+      end
+  
+      # Finds a torrent by 
+      def torrent_by_path_and_timestamp(path,timestamp)
+        torrent = Torrent.find_by_path_and_timestamp(path,timestamp)
+        return false if torrent.nil?
+    
+        {
+          'metadata' => torrent.metadata,
+          'infohash' => torrent.infohash,
+          'path'     => torrent.path,
+          'timestamp'=> torrent.timestamp
+        }
+      end
+  
+      # Lists the currently registered peers for a given torrent
+      # if peer_ids is populated with any peer ids then they will be excluded from the list
+      def peers_by_infohash(infohash, peer_ids = [], peers = 50)
+        begin
+          # TODO: Random order & actual number of peers (if peer_ids is in returned amount)
+          Peer.find_by_torrent_infohash(infohash,:limit => peers).delete_if {|peer| peer_ids.include? peer.peer_id}.map do |peer|
+            {
+              'peer id' => peer.peer_id,
+              'ip'      => peer.ip,
+              'port'    => peer.port
+            }
+          end
+        rescue NoMethodError
+          []
+        end
+      end
+  
+      # Returns information about the torrent as provided by it's infohash
+      def torrent_info(infohash)
+        info = Peer.find_by_sql(["SELECT (SELECT COUNT(*) FROM 'peers' WHERE `left` != 0 AND `torrent_infohash` = ?) as `incomplete`, (SELECT COUNT(*) FROM 'peers' WHERE `left` == 0 AND `torrent_infohash` = ?) as `complete`",infohash, infohash])[0]
+    
+        {
+          'complete' => info.complete,
+          'incomplete' => info.incomplete
+        }
+      end
+  
+      # Announce!
+      def announce(params)
+        peer = Peer.find_or_create_by_torrent_infohash_and_peer_id(params['info_hash'],params['peer_id'])
+    
+        peer.ip ||= params['ip']
+        peer.port ||= params['port']
+        peer.uploaded = params['uploaded']
+        peer.downloaded = params['downloaded']
+        peer.left = params['left']
+    
+        peer.save
+      end
+  
+      private
+      class Torrent < ActiveRecord::Base
+        serialize :metadata, Hash
+      end
+  
+      class Peer < ActiveRecord::Base
+    
+      end
+    end
+  end
+end

data/sinatra-torrent.gemspec

@@ -0,0 +1,43 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sinatra-torrent}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["JP Hastings-Spital"]
+  s.date = %q{2011-02-08}
+  s.description = %q{An extension to Sinatra which will allow you to run a webseeded torrent tracker of files in the folder you specify.}
+  s.email = %q{jphastings@gmail.com}
+  s.files = [
+    "Rakefile",
+     "Readme.md",
+     "VERSION",
+     "lib/sinatra/torrent.rb",
+     "lib/sinatra/torrent/activerecord.rb",
+     "sinatra-torrent.gemspec",
+     "views/torrents_index.haml"
+  ]
+  s.homepage = %q{http://github.com/jphastings/sinatra-torrent}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A sinatra extension to run webseeded torrent tracker}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, [">= 1.1.2"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 1.1.2"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 1.1.2"])
+  end
+end
+

data/views/torrents_index.haml

@@ -0,0 +1,5 @@
+%ul
+	-locals[:torrents].each do |torrent|
+		%li
+			%a{:href=>"/#{options.torrents_mount}/#{torrent}.torrent"}=torrent
+	

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-torrent
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- JP Hastings-Spital
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-08 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  type: :runtime
+  version_requirements: *id001
+description: An extension to Sinatra which will allow you to run a webseeded torrent tracker of files in the folder you specify.
+email: jphastings@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- Readme.md
+- VERSION
+- lib/sinatra/torrent.rb
+- lib/sinatra/torrent/activerecord.rb
+- sinatra-torrent.gemspec
+- views/torrents_index.haml
+has_rdoc: true
+homepage: http://github.com/jphastings/sinatra-torrent
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A sinatra extension to run webseeded torrent tracker
+test_files: []
+