├── lib ├── archlinux.torrent ├── torrent-ruby │ ├── peer.rb │ ├── torrent.rb │ ├── tracker_handler.rb │ ├── tracker.rb │ └── bencode.rb ├── main.rb ├── torrent-ruby.rb └── utp │ └── utp.rb ├── test ├── extra │ ├── Fedora-15-i386-DVD.torrent │ ├── FreeBSD-8.2-RELEASE-amd64-all.torrent │ ├── archlinux-2010.05-core-dual.iso.torrent │ └── ubuntu-10.04.2-alternate-amd64.iso.torrent ├── test_tracker_handler.rb ├── test_torrent_file.rb └── test_bencode.rb ├── torrent-ruby.gemspec ├── Rakefile ├── README └── LICENSE /lib/archlinux.torrent: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mikhailvs/torrent-ruby/HEAD/lib/archlinux.torrent -------------------------------------------------------------------------------- /test/extra/Fedora-15-i386-DVD.torrent: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mikhailvs/torrent-ruby/HEAD/test/extra/Fedora-15-i386-DVD.torrent -------------------------------------------------------------------------------- /lib/torrent-ruby/peer.rb: -------------------------------------------------------------------------------- 1 | class Peer 2 | attr_reader :ip, :port 3 | 4 | def initialize ip, port 5 | @ip = ip 6 | @port = port 7 | end 8 | end -------------------------------------------------------------------------------- /test/extra/FreeBSD-8.2-RELEASE-amd64-all.torrent: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mikhailvs/torrent-ruby/HEAD/test/extra/FreeBSD-8.2-RELEASE-amd64-all.torrent -------------------------------------------------------------------------------- /test/extra/archlinux-2010.05-core-dual.iso.torrent: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mikhailvs/torrent-ruby/HEAD/test/extra/archlinux-2010.05-core-dual.iso.torrent -------------------------------------------------------------------------------- /test/extra/ubuntu-10.04.2-alternate-amd64.iso.torrent: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mikhailvs/torrent-ruby/HEAD/test/extra/ubuntu-10.04.2-alternate-amd64.iso.torrent -------------------------------------------------------------------------------- /torrent-ruby.gemspec: -------------------------------------------------------------------------------- 1 | Gem::Specification.new do |s| 2 | s.name = 'torrent-ruby' 3 | s.version = '0.1.6' 4 | s.date = '2014-02-15' 5 | s.authors = ["Mikhail Slyusarev"] 6 | 7 | s.email = 'slyusarevmikhail@gmail.com' 8 | 9 | s.summary = 'torrent-ruby is a library for easily handling bencoding/bdecoding data, .torrent files and communication with bittorrent trackers.' 10 | 11 | s.homepage = 'http://mikhailvs.github.com/torrent-ruby/' 12 | 13 | s.files = [ 14 | 'LICENSE', 15 | 'README', 16 | 'Rakefile', 17 | 'lib/torrent-ruby/bencode.rb', 18 | 'lib/torrent-ruby/torrent_file.rb', 19 | 'lib/torrent-ruby/tracker_handler.rb', 20 | 'lib/torrent-ruby.rb' 21 | ] 22 | s.licenses = ['GPL v3'] 23 | end 24 | -------------------------------------------------------------------------------- /lib/main.rb: -------------------------------------------------------------------------------- 1 | require_relative 'torrent-ruby' 2 | 3 | require 'socket' 4 | require 'thread' 5 | 6 | t = Torrent.open('archlinux.torrent') 7 | 8 | # t.get_peers.each do |peer| 9 | # puts "trying #{peer.inspect}" 10 | # begin 11 | # timeout(1) do 12 | # sock = TCPSocket.new(peer.ip, peer.port) 13 | 14 | # puts "success" 15 | # end 16 | # rescue Exception 17 | # puts "failed" 18 | # end 19 | # end 20 | 21 | mux = Mutex.new 22 | threads = [] 23 | 24 | t.trackers.first.get_peers(500).each do |p| 25 | threads << Thread.start do 26 | begin 27 | timeout(5) do 28 | s = TCPSocket.new(p.ip, p.port) 29 | mux.synchronize { puts "#{p.inspect} connected!" } 30 | end 31 | rescue 32 | end 33 | end 34 | end 35 | 36 | threads.each { |t| t.join } -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | ######################################################################## 2 | # Copyright 2011 Mikhail Slyusarev 3 | # 4 | # This file is part of torrent-ruby. 5 | # 6 | # torrent-ruby is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # torrent-ruby is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with torrent-ruby. If not, see . 18 | ######################################################################## 19 | 20 | require 'rake/testtask' 21 | 22 | Rake::TestTask.new('test') do |t| 23 | t.pattern = 'test/test_*.rb' 24 | t.verbose = true 25 | end 26 | -------------------------------------------------------------------------------- /lib/torrent-ruby.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | ######################################################################## 4 | # Copyright 2011 Mikhail Slyusarev 5 | # 6 | # This file is part of torrent-ruby. 7 | # 8 | # torrent-ruby is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # torrent-ruby is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU General Public License 19 | # along with torrent-ruby. If not, see . 20 | ######################################################################## 21 | 22 | require 'net/http' 23 | require 'digest/sha1' 24 | require 'cgi' 25 | require 'timeout' 26 | require 'pry' 27 | 28 | require_relative './torrent-ruby/bencode' 29 | require_relative './torrent-ruby/torrent' 30 | require_relative './torrent-ruby/tracker' 31 | require_relative './torrent-ruby/peer' 32 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | A Ruby library for dealing with .torrent files and trackers. 2 | 3 | Examples: 4 | require 'torrent-ruby' 5 | 6 | # bencoding data 7 | {'a' => 'animal', 'b' => ['banana', 'bologna', 42]}.bencode 8 | #=> "d1:a6:animal1:bl6:banana7:bolognai42eee" 9 | 10 | # bdecoding data 11 | "ld3:one1:a3:two1:b5:threei3eed4:fourd4:five3:sixeee".bdecode 12 | #=> [{"one"=>"a", "two"=>"b", "three"=>3}, {"four"=>{"five"=>"six"}}] 13 | 14 | # get a TorrentFile object from a torrent file 15 | file = TorrentFile.open 'somefile.torrent' 16 | 17 | # get original contents of file 18 | file.bencoded #=> some bencoded string 19 | 20 | # get dictionary from .torrent file as ruby hash 21 | file.to_h #=> dictionary from .torrent file 22 | 23 | # save as new .torrent file 24 | file.save 'newname.torrent' 25 | 26 | # initialize a TrackerHandler object 27 | handler = TrackerHandler.new( TorrentFile.open('somefile.torrent'), 28 | :tracker_timeout => 5, :port => 42309) 29 | 30 | # get list of available trackers (as an array) 31 | trackers = handler.trackers 32 | 33 | # establish connection to tracker from index of a tracker 34 | # from the above 'trackers' array 35 | success = handler.establish_connection 0 36 | connected_tracker = handler.connected_trackers.last 37 | 38 | # send request to a connected tracker 39 | if success 40 | response = handler.request( :uploaded => 1, :downloaded => 10, 41 | :left => 100, :compact = 0, 42 | :no_peer_id => 0, :event => 'started', 43 | :index => 0) 44 | end 45 | -------------------------------------------------------------------------------- /test/test_tracker_handler.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | ######################################################################## 4 | # Copyright 2011 Mikhail Slyusarev 5 | # 6 | # This file is part of torrent-ruby. 7 | # 8 | # torrent-ruby is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # torrent-ruby is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU General Public License 19 | # along with torrent-ruby. If not, see . 20 | ######################################################################## 21 | 22 | require 'test/unit' 23 | 24 | require_relative '../lib/tracker_handler.rb' 25 | require_relative '../lib/torrent_file.rb' 26 | 27 | class TestTrackerHandler < Test::Unit::TestCase 28 | @@torrent = TorrentFile.open(Dir['test/extra/*.torrent'][0]) 29 | @@tracker_handler = TrackerHandler.new(@@torrent, tracker_timeout: 1, use_announce_list_on_initial_connection: false) 30 | def test_initialize 31 | assert_nothing_raised(Exception) do 32 | tracker_handler = TrackerHandler.new(@@torrent, tracker_timeout: 1, use_announce_list_on_initial_connection: false) 33 | end 34 | end 35 | 36 | def test_establish_connection 37 | assert_nothing_raised(Exception) do 38 | @@tracker_handler.establish_connection 0 39 | end 40 | end 41 | 42 | def test_request 43 | assert_raise(ArgumentError) { @@tracker_handler.request } 44 | end 45 | end 46 | -------------------------------------------------------------------------------- /test/test_torrent_file.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | ######################################################################## 4 | # Copyright 2011 Mikhail Slyusarev 5 | # 6 | # This file is part of torrent-ruby. 7 | # 8 | # torrent-ruby is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # torrent-ruby is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU General Public License 19 | # along with torrent-ruby. If not, see . 20 | ######################################################################## 21 | 22 | require 'test/unit' 23 | require 'fileutils' 24 | require 'digest/sha2' 25 | 26 | require_relative '../lib/torrent_file.rb' 27 | 28 | class TestTorrentFile < Test::Unit::TestCase 29 | @@contents = { 30 | 'info' => 'very important', 31 | 'announce' => 'http://t.com', 32 | 'announce list' => [['one', 'two']], 33 | 'creation date' => 'today', 34 | 'comment' => 'like i said', 35 | 'created by' => 'me', 36 | 'encoding' => 'utf-8' 37 | } 38 | 39 | def test_initialize 40 | file = TorrentFile.new @@contents 41 | assert_equal @@contents, file.to_h 42 | end 43 | 44 | def test_create 45 | file = TorrentFile.new 46 | file.create @@contents 47 | assert_equal @@contents, file.to_h 48 | end 49 | 50 | def test_bencoded 51 | file = TorrentFile.new @@contents 52 | assert_equal 'd4:info14:very important8:announce12:http://t.com13:announce listll3:one3:twoee13:creation date5:today7:comment11:like i said10:created by2:me8:encoding5:utf-8e', file.bencoded 53 | end 54 | 55 | def test_to_h 56 | file = TorrentFile.new @@contents 57 | assert_equal @@contents, file.to_h 58 | end 59 | 60 | def test_open 61 | Dir['test/extra/*.torrent'].each do |torrent| 62 | file = TorrentFile.open torrent 63 | _file = File.open torrent, 'rb' 64 | hash = file.to_h 65 | assert_equal _file.read, hash.bencode 66 | end 67 | end 68 | 69 | def test_save 70 | created_files = [] 71 | Dir['test/extra/*.torrent'].each do |torrent| 72 | file = TorrentFile.open torrent 73 | filename = "test_#{File.basename torrent}" 74 | file.save filename 75 | assert_equal Digest::SHA2.file(torrent), Digest::SHA2.file(filename) 76 | created_files << filename 77 | end 78 | created_files.each { |file| FileUtils.rm file } 79 | end 80 | end 81 | -------------------------------------------------------------------------------- /lib/torrent-ruby/torrent.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | ######################################################################## 4 | # Copyright 2011 Mikhail Slyusarev 5 | # 6 | # This file is part of torrent-ruby. 7 | # 8 | # torrent-ruby is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # torrent-ruby is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU General Public License 19 | # along with torrent-ruby. If not, see . 20 | ######################################################################## 21 | 22 | # Class for easily handling .torrent files. 23 | 24 | class Torrent 25 | attr_reader :trackers, :peers, :info_hash 26 | 27 | # Create a TorrentFile object with/without the dictionary. 28 | def initialize contents = {} 29 | @contents = contents 30 | @bencoded_contents = @contents.bencode unless @contents.nil? 31 | 32 | @info_hash = CGI::escape(Digest::SHA1.digest(@contents['info'].bencode).force_encoding('binary')) 33 | 34 | @peer_id = generate_peer_id 35 | 36 | @trackers = [Tracker.new(URI.parse(@contents['announce']), @info_hash, @peer_id)] 37 | 38 | (@contents['announc-list'] || []).each do |list| 39 | list.each { |tracker| @trackers << Tracker.new(URI.parse(tracker), @info_hash, @peer_id) } 40 | end 41 | end 42 | 43 | # begin downloading the torrent 44 | def start_download 45 | end 46 | 47 | # Change contents of TorrentFile. 48 | def create contents = {} 49 | @contents = contents 50 | @bencoded_contents = @contents.bencode unless @contents.nil? 51 | end 52 | 53 | # Get the Hash representation of the TorrentFile's dictionary. 54 | def to_h 55 | @contents 56 | end 57 | 58 | # Get the bencoded dictionary from the TorrentFile. 59 | def bencoded 60 | @bencoded_contents 61 | end 62 | 63 | # Create from a file (object or filename). 64 | def self.open f 65 | f = File.open(f, 'rb') unless f.class.method_defined?(:read) 66 | @bencoded_contents = f.read.strip 67 | @contents = @bencoded_contents.bdecode 68 | Torrent.new @contents 69 | end 70 | 71 | # Save TorrentFile to file with name 'f'. 72 | def save f 73 | File.open(f, 'wb') { |file| file.write @bencoded_contents } 74 | @contents 75 | end 76 | 77 | private 78 | # Generate a peer_id for the GET request. It can be arbitrary but has to be 20 bytes 79 | # and url-encode. 80 | def generate_peer_id 81 | CGI::escape(Digest::SHA1.digest(Time.now.hash.to_s).force_encoding('binary')) 82 | end 83 | end 84 | -------------------------------------------------------------------------------- /lib/torrent-ruby/tracker_handler.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | ######################################################################## 4 | # Copyright 2011 Mikhail Slyusarev 5 | # 6 | # This file is part of torrent-ruby. 7 | # 8 | # torrent-ruby is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # torrent-ruby is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU General Public License 19 | # along with torrent-ruby. If not, see . 20 | ######################################################################## 21 | 22 | # Class for handling things related to trackers. It serves as a common place to perform 23 | # actions with all the trackers defined in a .torrent metainfo file's dictionary. 24 | 25 | class TrackerHandler 26 | attr_reader :connected_trackers, :disconnected_trackers, :peer_id, :trackers 27 | def initialize torrent, options = {} 28 | @torrent_file = torrent 29 | @options = { tracker_timeout: 10, use_announce_list_on_initial_connection: true, port: 6881 }.merge(options) 30 | 31 | # Trackers we were able to connect to successfully. 32 | @connected_trackers = [] 33 | 34 | # Trackers that timed out or refused connection. 35 | @disconnected_trackers = [] 36 | 37 | # Set up .torrent file information for GET requests 38 | info = @torrent_file.to_h['info'].bencode 39 | 40 | # This is what will be passed for the info_hash GET parameter. 41 | @info_hash = URI.encode Digest::SHA1.digest(info).force_encoding('binary') 42 | 43 | # This is what will be passed for the peer_id GET parameter. 44 | @peer_id = generate_peer_id 45 | 46 | # Set up hash of tracker info for the torrent (from announce and announce-list). 47 | @trackers = [] 48 | torrent_hash = @torrent_file.to_h 49 | @trackers << Tracker.new(URI.parse(torrent_hash['announce'])) 50 | 51 | # Honor the parameter from @options. As far as the parameter itself goes, 52 | # there is no particular reason for having it, but you may not want to 53 | # connect to every single tracker from the constructor. 54 | if @options[:use_announce_list_on_initial_connection] 55 | (torrent_hash['announce-list'] || []).each do |list| 56 | list.each { |tracker| @trackers << Tracker.new(URI.parse(tracker)) } 57 | end 58 | end 59 | end 60 | 61 | # Static method for getting an array of hashes representing peers in a string from a 62 | # tracker using the binary model for peers. 63 | def self.from_binary_peers string 64 | bytes = string.unpack 'C*' 65 | peers = [] 66 | until bytes.empty? 67 | # Host is big-endian. 68 | if [1].pack('I') == [1].pack('N') 69 | peers << { ip: bytes[0..3].join('.'), port: bytes[4] << 8 | bytes[5]} 70 | # Host is little-endian 71 | else 72 | # IP is in the first 4 bytes, port is in last 2. 73 | peers << { ip: bytes[0..3].reverse.join('.'), port: bytes[5] << 8 | bytes[4]} 74 | end 75 | bytes = bytes[6..-1] 76 | end 77 | peers 78 | end 79 | end 80 | -------------------------------------------------------------------------------- /lib/torrent-ruby/tracker.rb: -------------------------------------------------------------------------------- 1 | class Tracker 2 | attr_reader :url, :scheme, :port, :path, :host 3 | 4 | def initialize url, info_hash, peer_id 5 | @url = url.to_s 6 | @scheme = url.scheme 7 | @port = url.port 8 | @path = url.path 9 | @host = url.host 10 | @info_hash = info_hash 11 | @peer_id = peer_id 12 | end 13 | 14 | # Establish connections to this tracker 15 | def connect tracker_timeout = 10 16 | # TODO handle UDP trackers. 17 | success = false 18 | if ['http', 'https'].include?(@scheme) 19 | timeout(tracker_timeout) do 20 | @connection = Net::HTTP.start(@host, @port) 21 | @connection.use_ssl = true if @scheme == 'https' 22 | success = true 23 | end 24 | else 25 | raise Exception, 'Only HTTP trackers are currently supported.' 26 | end 27 | success 28 | end 29 | 30 | def get_peers numwant = 50 31 | # NOTE: I think the bencoder is broken or something because when compact is not set, exception are thrown 32 | # it needs to be investigated at some point 33 | response = request( 34 | info_hash: @info_hash, 35 | compact: 1, 36 | peer_id: @peer_id, 37 | numwant: numwant 38 | ) 39 | 40 | # dictionary mode 41 | if response['peers'].is_a?(Array) 42 | puts response['peers'] 43 | @peers = response['peers'].collect { |p| Peer.new(p['ip'], p['port']) } 44 | else # binary mode 45 | @peers = parse_binary_peers(response['peers']) 46 | end 47 | end 48 | 49 | # Make http request to the tracker and get results. 50 | def request params = {} 51 | # If there's nothing to connect to. Catch this exception. 52 | # raise Exception, "No trackers connected." if @connected_trackers.empty? 53 | 54 | # All parameters defined in the specification are required except for ip, numwant, 55 | # key and trackerid. 56 | required_params = [:info_hash, :peer_id] 57 | diff = required_params - params.keys 58 | 59 | if diff.empty? 60 | self.connect unless @connection 61 | 62 | raise Exception, 'Could not connect to tracker' if @connection.nil? 63 | 64 | request_string = "#{@path}?" + params.collect { |k, v| "#{k}=#{v}" }.join('&') 65 | else 66 | raise ArgumentError, "Required values for keys: #{diff.join(', ')} not provided" 67 | end 68 | 69 | # Make, and return the body of, the request. 70 | response = @connection.request(Net::HTTP::Get.new(request_string)) 71 | 72 | response.body.bdecode 73 | end 74 | 75 | # Scrape tracker if the tracker supports it (determined as described in 76 | # http://wiki.theory.org/BitTorrentSpecification#Tracker_.27scrape.27_Convention). 77 | def scrape info_hashes = [] 78 | info_hash_string = '' 79 | info_hashes.each { |hash| info_hash_string << "info_hash=#{hash}&" } 80 | 81 | # if the last element of the path is announce, then scrape is supported 82 | if @path.index('/announce') == @path.rindex('/') 83 | self.connect unless @connection 84 | raise Exception, 'Could not connect to tracker' if @connection.nil? 85 | 86 | scrape_path = @path.gsub(/(.*?)announce(.*?)/, '\1scrape\2') 87 | @connection.request(Net::HTTP::Get.new("#{scrape_path}?#{info_hash_string}")).body.bdecode 88 | end 89 | end 90 | 91 | # parse the binary list of peers into a more manageable format 92 | def parse_binary_peers peerslist 93 | bytes = peerslist.unpack('C*') 94 | peers = [] 95 | endianness = [1].pack('I') == [1].pack('N') ? :big : :little 96 | 97 | until bytes.empty? 98 | if endianness == :big 99 | peers << Peer.new(bytes[0..3].join('.'), bytes[4] << 8 | bytes[5]) 100 | else 101 | # IP is in the first 4 bytes, port is in last 2. 102 | peers << Peer.new(bytes[0..3].reverse.join('.'), bytes[5] << 8 | bytes[4]) 103 | end 104 | bytes = bytes[6..-1] 105 | end 106 | peers 107 | end 108 | end -------------------------------------------------------------------------------- /test/test_bencode.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | ######################################################################## 4 | # Copyright 2011 Mikhail Slyusarev 5 | # 6 | # This file is part of torrent-ruby. 7 | # 8 | # torrent-ruby is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # torrent-ruby is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU General Public License 19 | # along with torrent-ruby. If not, see . 20 | ######################################################################## 21 | 22 | require 'test/unit' 23 | 24 | require_relative '../lib/bencode.rb' 25 | 26 | class TestString < Test::Unit::TestCase 27 | def test_bencode 28 | assert_equal '4:spam', 'spam'.bencode 29 | assert_equal '5: spam', ' spam'.bencode 30 | assert_equal '5:spam ', 'spam '.bencode 31 | assert_equal '2: ', ' '.bencode 32 | assert_equal '19:the quick brown fox', 'the quick brown fox'.bencode 33 | assert_equal '0:', ''.bencode 34 | end 35 | 36 | def test_bdecode 37 | assert_raise(ArgumentError) { 'hello'.bdecode } 38 | assert_raise(ArgumentError) { ' '.bdecode } 39 | assert_equal [1, 2, 3], 'li1ei2ei3ee'.bdecode 40 | assert_equal [{'a' => 1, 'b' => '2', 'c' => ['3']}, 'four'], 41 | 'd1:ai1e1:b1:21:cl1:3ee4:four'.bdecode 42 | assert_equal [{'a' => 1, 'b' => '2', 'c' => ['3']}, 'four'], 43 | 'ld1:ai1e1:b1:21:cl1:3ee4:foure'.bdecode 44 | end 45 | 46 | def test_decode_str 47 | assert_equal '', '0:'.bdecode 48 | assert_equal ' ', '1: '.bdecode 49 | assert_equal ' a ', '3: a '.bdecode 50 | assert_equal 'the quick brown fox', '19:the quick brown fox'.bdecode 51 | assert_equal 'spam', '4:spam'.bdecode 52 | assert_equal 'budapest', '8:budapest'.bdecode 53 | end 54 | 55 | def test_decode_int 56 | assert_equal 1, 'i1e'.bdecode 57 | assert_equal 0, 'i0e'.bdecode 58 | assert_equal 123456789876543212345678987654321, 59 | 'i123456789876543212345678987654321e'.bdecode 60 | end 61 | 62 | def test_decode_list 63 | assert_equal [1, 2, 3], 'li1ei2ei3ee'.bdecode 64 | assert_equal [[[[1]]], [[2]], [3], 4], 'lllli1eeeelli2eeeli3eei4ee'.bdecode 65 | assert_equal [], 'le'.bdecode 66 | assert_equal ['one', 'two', 3, 4, 'five'], 'l3:one3:twoi3ei4e4:fivee'.bdecode 67 | assert_equal [{'a' => 'animal', 'b' => 'banana'}, 'canadian'], 68 | 'ld1:a6:animal1:b6:bananae8:canadiane'.bdecode 69 | end 70 | 71 | def test_decode_dict 72 | assert_raise(ArgumentError) { 'di2ei3ee'.bdecode } 73 | assert_equal ({'b' => 'budapest'}), 'd1:b8:budapeste'.bdecode 74 | assert_equal ({'1' => 2, '3' => 4}), 'd1:1i2e1:3i4ee'.bdecode 75 | assert_equal ({'one' => [1, 2, 3], 'two' => {'three' => [[[4]], [5], 6]}}), 76 | 'd3:oneli1ei2ei3ee3:twod5:threellli4eeeli5eei6eeee'.bdecode 77 | end 78 | end 79 | 80 | class TestFixnum < Test::Unit::TestCase 81 | def test_bencode 82 | assert_equal 'i1e', 1.bencode 83 | assert_equal 'i1234e', 1234.bencode 84 | end 85 | end 86 | 87 | class TestBignum < Test::Unit::TestCase 88 | def test_bencode 89 | assert_equal 'i123456789876543212345678987654321e', 123456789876543212345678987654321.bencode 90 | end 91 | end 92 | 93 | class TestArray < Test::Unit::TestCase 94 | def test_bencode 95 | assert_equal 'ld1:a6:animal1:b6:bananae8:canadiane', 96 | [{'a' => 'animal', 'b' => 'banana'}, 'canadian'].bencode 97 | assert_equal 'l1:a1:b1:c1:1i2ei3ee', ['a', 'b', 'c', '1', 2, 3].bencode 98 | end 99 | end 100 | 101 | class TestHash < Test::Unit::TestCase 102 | def test_bencode 103 | assert_equal 'd1:a1:be', ({'a' => 'b'}).bencode 104 | assert_equal 'd1:ad1:ad1:a1:beee', ({'a' => {'a' => {'a' => 'b'}}}).bencode 105 | end 106 | end 107 | -------------------------------------------------------------------------------- /lib/utp/utp.rb: -------------------------------------------------------------------------------- 1 | require 'socket' 2 | require 'timeout' 3 | 4 | module UTP 5 | class Packet 6 | attr_accessor :type, :version, :extension, :connection_id, :timestamp, :timestamp_difference, :wnd_size, :seq_nr, :ack_nr, :data 7 | 8 | PACKET_TYPES = [:data, :fin, :state, :reset, :syn] 9 | PACKING_FMT = 'CCS>L>L>L>S>S>' 10 | 11 | def initialize params = {} 12 | if params[:raw] 13 | # unpack all the header values into an array 14 | vals = params[:raw][0..19].unpack(PACKING_FMT) 15 | 16 | # type is in the first 4 bits of the first 8-bit number 17 | @type = PACKET_TYPES[vals[0] >> 4] 18 | 19 | # version is in the last 4 bits of the first 8-bit number 20 | @version = vals[0] & 0xf 21 | @extension = vals[1] 22 | @connection_id = vals[2] 23 | @timestamp = vals[3] 24 | @timestamp_difference = vals[4] 25 | @wnd_size = vals[5] 26 | @seq_nr = vals[6] 27 | @ack_nr = vals[7] 28 | 29 | # everything after the header is data 30 | @data = parm[:raw][20..-1] 31 | else 32 | # setup the default field values here 33 | fields = { type: :syn, version: 1, extension: 0, timestamp_difference: 0, connection_id: (rand * 65534).round, seq_nr: 1, ack_nr: 0, data: '' } 34 | 35 | # set the corresponding instance variables 36 | fields.merge(params).each { |k, v| instance_variable_set("@#{k}", v) } 37 | end 38 | end 39 | 40 | def bytes 41 | [ 42 | PACKET_TYPES.index(@type) << 4 | @version, 43 | @extension, 44 | @connection_id, 45 | @timestamp || (Time.now.to_f * 1000000).to_i, 46 | @timestamp_difference, 47 | @wnd_size, 48 | @seq_nr, 49 | @ack_nr 50 | ].pack(PACKING_FMT) + @data 51 | end 52 | end 53 | 54 | class NotConnectedError < RuntimeError; end 55 | class TimeoutError < RuntimeError; end 56 | 57 | class ServerSocket 58 | def initialize host, port 59 | @sock = UDPSocket.new 60 | @sock.bind(host, port) 61 | 62 | @timeout = 10 63 | @recv_buf_size = 65535 64 | 65 | @wnd_size = 0 66 | @state = :idle 67 | end 68 | 69 | def accept &blk 70 | response_pkt = Packet.new(raw: @sock.recvfrom(@recv_buf_size)) 71 | @state = :connected 72 | 73 | # since this is a server socket, we want to make sure that the connection id for this 74 | @connection_id = response_pkt.connection_id unless @connection_id 75 | 76 | @last_ack_nr = response_pkt.ack_nr 77 | 78 | response_pkt.data 79 | end 80 | end 81 | 82 | class ClientSocket 83 | attr_accessor :state, :timeout, :recv_buf_size, :last_seq_nr, :last_ack_nr, :connection_id, :last_timestamp 84 | 85 | def initialize host, port 86 | @sock = UDPSocket.new 87 | @sock.connect(host, port) 88 | 89 | @timeout = 10 90 | @recv_buf_size = 65535 91 | @wnd_size = 0 92 | 93 | syn_pkt = Packet.new(wnd_size: @wnd_size) 94 | 95 | # setup socket state 96 | @connection_id = syn_pkt.connection_id 97 | @last_seq_nr = syn_pkt.seq_nr 98 | 99 | @sock.send(syn_pkt.bytes, 0) 100 | 101 | @state = :syn_sent 102 | response = timeout(@timeout) { @sock.recvfrom(@recv_buf_size) } rescue nil 103 | 104 | if response 105 | @state = :connected 106 | 107 | response_pkt = Packet.new(raw: response) 108 | last_ack_nr = response_pkt.seq_nr 109 | 110 | last_timestamp = response_pkt.timestamp 111 | else 112 | raise TimeoutError, 'Timed out while waiting for peer' 113 | end 114 | end 115 | 116 | def send data 117 | pkt = Packet.new( 118 | type: :data, 119 | connection_id: @connection_id, 120 | seq_nr: @last_seq_nr += 1, 121 | ack_nr: @last_ack_nr, 122 | wnd_size: @wnd_size, 123 | data: data 124 | ) 125 | 126 | @sock.send(pkt.bytes, 0) 127 | end 128 | end 129 | 130 | class Socket 131 | 132 | SOCKET_STATES = [:idle, :syn_sent, :connected, :connected_full, :got_fin, :destroy_delay, :fin_sent, :reset, :destroy] 133 | 134 | def initialize host, port 135 | end 136 | 137 | def connect host, port 138 | end 139 | 140 | def send data 141 | # raise NotConnectedError, 'Cannot send data when not connected' unless [:connected, :connected_full].include?(@state) 142 | end 143 | end 144 | 145 | # s = Socket.new('127.0.0.1', 9348) 146 | 147 | # s.connect(nil, nil) 148 | 149 | s = Packet.new(wnd_size: 5, timestamp: 55555555, ack_nr: 94, seq_nr: 55) 150 | puts s.inspect 151 | 152 | t = Packet.new(raw: s.bytes) 153 | puts t.inspect 154 | end -------------------------------------------------------------------------------- /lib/torrent-ruby/bencode.rb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | ######################################################################## 4 | # Copyright 2011 Mikhail Slyusarev 5 | # 6 | # This file is part of torrent-ruby. 7 | # 8 | # torrent-ruby is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation, either version 3 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # torrent-ruby is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU General Public License 19 | # along with torrent-ruby. If not, see . 20 | ######################################################################## 21 | 22 | # Extensions to String, Fixnum, Bignum, Array and Hash 23 | # that allow conversion to and from "bencoded" strings. 24 | 25 | class String 26 | # Bencode a String. 27 | def bencode 28 | "#{self.length}:#{self}" 29 | end 30 | 31 | # Decode the string and return the object that it represents. 32 | # In the case that the string contains more than one adjacent 33 | # objects, an array of all adjacent objects is returned. If 34 | # the string is not a valid bencoded string, nil is returned. 35 | # example: 36 | # "d4:testli1ei2ei3eeel1:a1:b1:ce".bdecode #=> [{"test"=>[1, 2, 3]}, ["a", "b", "c"]] 37 | # "d1:ai1e1:bi2e1:ci3ee".bdecode #=> {"a"=>1,"b"=>2,"c"=>3} 38 | def bdecode 39 | @index = 0 40 | data = [] 41 | while @index < self.length 42 | data << case self[@index] 43 | when /\d/ 44 | decode_str 45 | when 'l' 46 | decode_list 47 | when 'i' 48 | decode_int 49 | when 'd' 50 | decode_dict 51 | else 52 | raise ArgumentError, 'Cannot bdecode invalid string.' 53 | end 54 | @index += 1 55 | end 56 | @index = 0 57 | data.length > 1 ? data : data[0] 58 | end 59 | 60 | private 61 | # Decode a bencoded string. 62 | def decode_str 63 | # @index is guaranteed to be at the position of the first digit of the integer 64 | # describing the string's length, so this is safe. 65 | index_of_last_digit = @index + self[@index..self.length - 1].index(':') 66 | length_of_string = self[(@index)..(@index + index_of_last_digit - 1)].to_i 67 | 68 | # The string itself starts 1 past the index of the last digit (because of the colon) 69 | # and ends 2 more than the length of the string past the index. 70 | string = self[(index_of_last_digit + 1)..(index_of_last_digit + length_of_string)] 71 | 72 | # Increment index by the length of the string plus the length of the digits. 73 | @index += index_of_last_digit - @index + length_of_string 74 | string 75 | end 76 | 77 | # Decode a bencoded integer. 78 | def decode_int 79 | # @index is at the position of the the 'i' so we just need everything between it 80 | # and the next appearance of 'e'. 81 | index_of_last_digit = self[@index..self.length - 1].index 'e' 82 | number_string = self[(@index + 1)..(@index + index_of_last_digit - 1)] 83 | @index += index_of_last_digit 84 | number_string.to_i 85 | end 86 | 87 | # Decode a bencoded list. 88 | def decode_list 89 | accumulator = [] 90 | 91 | # Elements begin at one past the index of the 'l'. 92 | @index += 1 93 | while self[@index] != 'e' 94 | raise ArgumentError, 'Cannot bdecode string, current object not terminated propery' if @index > self.length 95 | case self[@index] 96 | when /\d/ 97 | accumulator << decode_str 98 | when 'l' 99 | accumulator << decode_list 100 | when 'i' 101 | accumulator << decode_int 102 | when 'd' 103 | accumulator << decode_dict 104 | else 105 | raise ArgumentError, 'Cannot bdecode string.' 106 | end 107 | @index += 1 108 | end 109 | accumulator 110 | end 111 | 112 | # Decode a bencoded dictionary. 113 | def decode_dict last_visited = @index 114 | hash = {} 115 | 116 | # Note: keys may only ever be strings (from specification). 117 | key = '' 118 | while self[@index] != 'e' 119 | # binding.pry 120 | raise ArgumentError, 'Cannot bdecode string, current object not terminated propery' if @index > self.length 121 | case self[@index] 122 | when /\d/ 123 | s = decode_str 124 | if key.empty? 125 | key = s 126 | else 127 | raise ArgumentError, 'Invalid bencoded string' if key.empty? 128 | hash[key] = s 129 | key = '' 130 | end 131 | when 'l' 132 | raise ArgumentError, 'Invalid bencoded string' if key.empty? 133 | hash[key] = decode_list 134 | key = '' 135 | when 'i' 136 | raise ArgumentError, 'Invalid bencoded string' if key.empty? 137 | hash[key] = decode_int 138 | key = '' 139 | when 'd' 140 | # This is to prevent infinite recursion, which would happen if 141 | # this method was called on a string that was just a dictionary. 142 | unless @index == last_visited 143 | raise ArgumentError, 'Invalid bencoded string' if key.empty? 144 | hash[key] = decode_dict @index 145 | key = '' 146 | end 147 | end 148 | @index += 1 149 | end 150 | hash 151 | end 152 | end 153 | 154 | class Integer 155 | # Bencode an Integer (covers Fixnum as well as Bignum). 156 | def bencode 157 | "i#{self}e" 158 | end 159 | end 160 | 161 | class Array 162 | # Bencode an Array. 163 | def bencode 164 | string = 'l' 165 | self.each { |i| string << i.bencode } 166 | string + 'e' 167 | end 168 | end 169 | 170 | class Hash 171 | # Bencode a Hash. 172 | def bencode 173 | string = 'd' 174 | self.each do |k, v| 175 | # Symbols will be made into strings, because this seems to be an idiomatic thing in ruby, however they cannot be 176 | # converted back in the same way 177 | raise ArgumentError, 'Hash key must be of type String or Symbol' unless [String, Symbol].include?(k.class) 178 | string << k.to_s.bencode + v.bencode 179 | end 180 | string + 'e' 181 | end 182 | end 183 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS --------------------------------------------------------------------------------