quartz_flow 0.0.1

data/lib/quartz_flow/server.rb

@@ -0,0 +1,305 @@
+# Register an at_exit handler so that when Sinatra is shutting down
+# we stop the torrent peer client.
+$manager = nil
+at_exit do
+  puts "Stopping torrent client"
+  $manager.stopPeerClient if $manager
+end
+
+require 'haml'
+require 'json'
+require 'quartz_torrent'
+require 'quartz_flow/wrappers'
+require 'quartz_flow/torrent_manager'
+require 'quartz_flow/settings_helper'
+require 'quartz_flow/authentication'
+require 'quartz_flow/session'
+require 'fileutils'
+require 'sinatra/base'
+
+class LogConfigurator
+  def self.set(logger, level)
+    QuartzTorrent::LogManager.setLevel logger, level
+  end
+
+  def self.configLevels
+    # Load configuration settings
+    path = "./etc/logging.rb"
+    return if ! File.exists?(path)
+    eval File.open(path,"r").read
+  end
+end
+
+class Server < Sinatra::Base
+  configure do
+    enable :sessions
+    set :bind, '0.0.0.0'
+    set :port, 4444
+    set :basedir, "download" 
+    set :torrent_port, 9996
+    set :db_file, "db/quartz.sqlite"
+    set :torrent_log, "log/torrent.log"
+    set :password_file, "etc/passwd"
+    set :logging, true
+    set :monthly_usage_reset_day, 1
+
+    # Load configuration settings
+    eval File.open("./etc/quartz.rb","r").read
+
+    set :root, '.'
+
+    raise "The basedir '#{settings.basedir}' does not exist. Please create it." if ! File.directory? settings.basedir
+    raise "The metadir '#{settings.metadir}' does not exist. Please create it." if ! File.directory? settings.metadir
+
+    QuartzTorrent::LogManager.initializeFromEnv
+    logfile = settings.torrent_log
+    QuartzTorrent::LogManager.setup do
+      setLogfile logfile
+      setDefaultLevel :info
+    end
+    LogConfigurator.configLevels
+    peerClient = QuartzTorrent::PeerClient.new(settings.basedir)
+    peerClient.port = settings.torrent_port
+    peerClient.start
+
+    # Initialize Datamapper
+    path = "sqlite://#{Dir.pwd}/#{settings.db_file}"
+    DataMapper.setup(:default, path)
+
+    $manager = TorrentManager.new(peerClient, settings.metadir, settings.monthly_usage_reset_day)
+    $manager.startExistingTorrents
+  end
+
+  before do
+    if $useAuthentication
+      sid = session[:sid]
+      if ! SessionStore.instance.valid_session?(sid)
+        if request.path_info == "/"
+          # Redirect to login if not authenticated
+          session[:redir] = request.path_info
+          request.path_info = "/login"
+        elsif request.path_info != "/login"
+          halt 500, "Authentication required"
+        end
+      end
+    end
+  end
+
+  get "/login" do
+    haml :login
+  end
+
+  post "/login" do
+    json = JSON.parse(request.body.read)
+    halt 500, "Missing login" if ! json['login']
+    halt 500, "Missing password" if ! json['password']
+
+    auth = Authentication.new settings.password_file
+    if auth.authenticate json['login'], json['password']
+      sid = SessionStore.instance.start_session(params[:login].to_s)
+      session[:sid] = sid
+    else
+      halt 500, "Invalid login or password"
+    end
+    "OK"
+  end
+
+  post "/logout" do
+    SessionStore.instance.end_session(session[:sid])
+    session.delete :sid
+    "OK"
+  end
+
+  get "/" do
+    haml :index
+  end
+
+  # Get the HTML template used by the Angular module 
+  # to display the table of running torrents view.
+  get "/torrent_table" do
+    haml :torrent_table_partial
+  end
+
+  # Get the HTML template used by the Angular module 
+  # to display the details of a single running torrent view.
+  get "/torrent_detail" do
+    haml :torrent_detail_partial
+  end
+
+
+  # Get the HTML template used by the Angular module 
+  # to display the config settings
+  get "/config" do
+    haml :config_partial
+  end
+
+  # Get an array of JSON objects that represent a list of current running 
+  # torrents with various properties.
+  get "/torrent_data" do
+    JSON.generate $manager.simplifiedTorrentData
+  end
+
+  # Get usage as a JSON object.
+  get "/usage" do
+    hash = { 
+      :monthlyUsage => QuartzTorrent::Formatter.formatSize($manager.currentPeriodUsage(:monthly)),
+      :dailyUsage => QuartzTorrent::Formatter.formatSize($manager.currentPeriodUsage(:daily))
+    }
+    JSON.generate hash
+  end
+
+  # Download a .torrent file and start running it.
+  # The body of the post should be JSON encoded.
+  post "/download_torrent" do
+    json = JSON.parse(request.body.read)
+    
+    url = json["url"]
+    halt 500, "Downloading torrent file failed: no url parameter was sent to the server in the post request." if ! url || url.length == 0
+    path = nil
+    begin
+      path = $manager.downloadTorrentFile url
+    rescue
+      halt 500, "Downloading torrent file failed: #{$!}"
+    end
+
+    begin
+      $manager.startTorrentFile(path)
+    rescue BEncode::DecodeError
+      halt 500, "Starting torrent file failed: torrent file is malformed."
+    rescue
+      puts $!
+      puts $!.backtrace.join("\n")
+      halt 500, "Starting torrent file failed: #{$!}."
+    end
+      
+    # We need to return something here otherwise AngularJS chokes.
+    "Worked fine"
+  end
+
+  # Given a magnet link, start running it.
+  # The body of the post should be JSON encoded.
+  post "/start_magnet" do
+    json = JSON.parse(request.body.read)
+
+    url = json["url"]
+    halt 500, "Starting magnet link failed: no url parameter was sent to the server in the post request." if ! url || url.length == 0
+    halt 500, "Starting magnet link failed: the link doesn't appear to be a magnet link" if ! QuartzTorrent::MagnetURI.magnetURI?(url)
+
+    magnet = QuartzTorrent::MagnetURI.new(url)
+    begin
+      $manager.storeMagnet(magnet)
+    rescue
+      halt 500, "Storing magnet link failed: #{$!}."
+    end
+   
+    begin
+      $manager.startMagnet(magnet)
+    rescue
+      puts $!
+      puts $!.backtrace.join("\n")
+      halt 500, "Starting magnet link failed: #{$!}."
+    end
+
+    # We need to return something here otherwise AngularJS chokes.
+    "Worked fine"
+  end
+
+  # Handle an upload of a torrent file.
+  post "/upload_torrent" do
+    # See http://www.wooptoot.com/file-upload-with-sinatra
+    path = params['torrentfile'][:tempfile].path
+
+    #FileUtils.chmod 0644, path
+    path = $manager.storeUploadedTorrentFile path, params['torrentfile'][:filename]
+
+    begin
+      $manager.startTorrentFile(path)
+    rescue BEncode::DecodeError
+      halt 500, "Starting torrent file failed: torrent file is malformed."
+    rescue
+      puts $!
+      puts $!.backtrace.join("\n")
+      halt 500, "Starting torrent file failed: #{$!}."
+    end
+      
+    # We need to return something here otherwise AngularJS chokes.
+    "@@success"
+  end
+
+  post "/pause_torrent" do
+    json = JSON.parse(request.body.read)
+
+    infoHash = json["infohash"]
+    halt 500, "Pausing torrent failed: no infohash parameter was sent to the server in the post request." if !infoHash || infoHash.length == 0
+    $manager.peerClient.setPaused QuartzTorrent::hexToBytes(infoHash), true
+    puts "Pausing torrent"
+    "OK"
+  end
+
+  post "/unpause_torrent" do
+    json = JSON.parse(request.body.read)
+
+    infoHash = json["infohash"]
+    halt 500, "Unpausing torrent failed: no infohash parameter was sent to the server in the post request." if !infoHash || infoHash.length == 0
+    $manager.peerClient.setPaused QuartzTorrent::hexToBytes(infoHash), false
+    "OK"
+  end
+
+  post "/delete_torrent" do
+    json = JSON.parse(request.body.read)
+
+    infoHash = json["infohash"]
+    halt 500, "Deleting torrent failed: no infohash parameter was sent to the server in the post request." if !infoHash || infoHash.length == 0
+    deleteFiles = json["delete_files"]
+    halt 500, "Deleting torrent failed: no delete_files parameter was sent to the server in the post request." if deleteFiles.nil?
+
+    begin
+      $manager.removeTorrent infoHash, deleteFiles
+    rescue
+      halt 500, "Removing torrent failed: #{$!}"
+    end
+    
+    "OK"
+  end
+
+  # Return all UI configurable settings from the model as
+  # a hash.
+  get "/global_settings" do
+    settings = SettingsHelper.new.globalSettingsHash
+    JSON.generate settings
+  end
+
+  post "/global_settings" do
+    helper = SettingsHelper.new
+    json = JSON.parse(request.body.read)
+    begin
+      helper.setGlobalSettingsHash(json)
+    rescue
+      halt 500, "Saving global settings failed: #{$!}"
+    end
+    "OK"
+  end
+
+  post "/change_torrent" do
+    helper = SettingsHelper.new
+    json = JSON.parse(request.body.read)
+
+    asciiInfoHash = json['infoHash']
+    halt 500, "Saving torrent settings failed: no infoHash parameter was sent to the server in the post request." if ! asciiInfoHash
+  
+    json.each do |k,v|
+      next if k == 'infoHash'
+      begin
+        helper.set k, v, asciiInfoHash
+      rescue
+        halt 500, "Saving torrent settings failed: #{$!}"
+      end
+    end
+
+    infoHash = QuartzTorrent::hexToBytes(asciiInfoHash)
+    $manager.applyTorrentSettings infoHash
+
+    "OK"
+  end
+
+end

data/lib/quartz_flow/session.rb

@@ -0,0 +1,83 @@
+require 'thread'
+require 'singleton'
+require 'quartz_flow/randstring'
+
+class Session
+  def initialize(sid = nil, login = nil, length = 60*60)
+    @sid = sid
+    @login = login
+    # Make a 1 hr session
+    @expiry = Time.new + length
+  end
+  attr_accessor :sid
+  attr_accessor :login
+  attr_accessor :expiry
+
+  def expired?
+    @expiry < Time.new
+  end
+end
+
+# Use SessionStore.instance to access the singleton.
+class SessionStore
+  include Singleton
+
+  def initialize
+    @sessions = {}  
+    @session_mutex = Mutex.new
+    @audit_thread = Thread.new do
+      while true
+        begin
+          sleep 10
+          audit_sessions  
+        rescue
+        end
+      end
+    end
+  end
+
+  # Start a new session for the specified user.
+  def start_session(login)
+    sid = nil
+    while ! sid || @sessions.has_key?(sid)
+      sid = RandString.make_random_string(256)
+    end
+    @session_mutex.synchronize do 
+      @sessions[sid] = Session.new(sid, login)
+    end
+    sid
+  end
+
+  def end_session(sid)
+    return if ! sid
+    @session_mutex.synchronize do
+      @sessions.delete sid
+    end
+  end
+  
+  def valid_session?(sid)
+    rc = false
+    return rc if ! sid
+    @session_mutex.synchronize do
+      session = @sessions[sid]
+      if session != nil 
+        if !session.expired?
+          rc = true
+        else
+          @sessions.delete sid
+        end
+      end
+    end
+    rc
+  end
+
+  def audit_sessions
+    @sessions.each do |k,session|
+      if session.expired?
+        @session_mutex.synchronize do
+          @sessions.delete k
+        end
+      end
+    end
+  end 
+end

data/lib/quartz_flow/settings_helper.rb

@@ -0,0 +1,154 @@
+require 'quartz_flow/model'
+require 'quartz_torrent/formatter'
+
+class SettingsHelper
+  class SettingMetainfo
+    def initialize(name, scope, saveFilter = nil, loadFilter = nil, emptyIsNil = true)
+      @name = name
+      @scope = scope
+      @saveFilter = saveFilter
+      @loadFilter = loadFilter
+      @emptyIsNil = emptyIsNil
+    end
+    attr_accessor :name
+    attr_accessor :scope
+    # If the value is empty, treat it as a nil value when writing to database
+    def emptyIsNil?
+      @emptyIsNil
+    end
+    def filterOnSave(v)
+      filter @saveFilter, v
+    end
+    def filterOnLoad(v)
+      filter @loadFilter, v
+    end
+    private
+    def filter(afilter, v)
+      if afilter && v
+        afilter.call(v)
+      else
+        v
+      end
+    end
+  end
+
+  @@floatValidator = Proc.new do |v|
+    raise "Invalid ratio" if v !~ /^\d+(\.\d+)?$/
+    v.to_s
+  end
+
+  @@saveFilterForSize = Proc.new do |v|
+    if v.nil? || v.length == 0
+      nil
+    else
+      QuartzTorrent::Formatter.parseSize(v) 
+    end
+  end
+  
+
+  @@settingsMetainfo = {
+    :defaultUploadRateLimit => SettingMetainfo.new(
+      :defaultUploadRateLimit,
+      :global,
+      @@saveFilterForSize,
+      Proc.new{ |v| QuartzTorrent::Formatter.formatSpeed(v) }
+    ),
+    :defaultDownloadRateLimit => SettingMetainfo.new(
+      :defaultDownloadRateLimit,
+      :global,
+      @@saveFilterForSize,
+      Proc.new{ |v| QuartzTorrent::Formatter.formatSpeed(v) }
+    ),
+    :defaultRatio => SettingMetainfo.new(
+      :defaultRatio,
+      :global,
+      @@floatValidator,
+      Proc.new{ |v| v.to_f }
+    ),
+    :uploadRateLimit => SettingMetainfo.new(
+      :uploadRateLimit,
+      :torrent,
+      @@saveFilterForSize,
+      Proc.new{ |v| QuartzTorrent::Formatter.formatSpeed(v) }
+    ),
+    :downloadRateLimit => SettingMetainfo.new(
+      :downloadRateLimit,
+      :torrent,
+      @@saveFilterForSize,
+      Proc.new{ |v| QuartzTorrent::Formatter.formatSpeed(v) }
+    ),
+    :ratio => SettingMetainfo.new(
+      :ratio,
+      :torrent,
+      @@floatValidator,
+      Proc.new{ |v| v.to_f }
+    ),
+  }
+
+  def set(settingName, value, owner = nil)
+    setting = settingName.to_sym
+
+    metaInfo = @@settingsMetainfo[setting]
+    raise "Unknown setting #{settingName}" if ! metaInfo
+
+    value = nil if metaInfo.emptyIsNil? && value.is_a?(String) && value.length == 0
+    value = value.to_s if value
+    value = metaInfo.filterOnSave(value)
+    
+    settingModel = loadWithOwner(settingName, owner)
+
+    if ! settingModel
+      Setting.create( :name => settingName, :value => value, :scope => metaInfo.scope, :owner => owner )
+    else
+      settingModel.value = value
+      settingModel.save
+    end
+  end
+
+  def get(settingName, filter = :filter, owner = nil)
+    setting = settingName.to_sym
+    metaInfo = @@settingsMetainfo[setting]
+    raise "Unknown setting #{settingName}" if ! metaInfo
+
+    result = nil
+    settingModel = loadWithOwner(settingName, owner)
+    
+    if settingModel
+      result = settingModel.value
+      result = metaInfo.filterOnLoad(result) if filter == :filter
+    end
+    result
+  end
+
+  def deleteForOwner(owner)
+    Setting.all(:owner => owner).destroy!
+  end
+
+  # Return a hashtable of all global settings
+  def globalSettingsHash
+    result = {}
+
+    @@settingsMetainfo.each do |k,v|
+      next if v.scope != :global
+      result[k] = get(k)
+    end
+    
+    result
+  end
+
+  # Set global settings as a hash
+  def setGlobalSettingsHash(hash)
+    @@settingsMetainfo.each do |k,v|
+      set(k, hash[k.to_s]) if hash.has_key?(k.to_s)
+    end
+  end
+
+  private
+  def loadWithOwner(settingName, owner)
+    if owner
+      Setting.first(:name => settingName, :owner => owner)
+    else
+      Setting.first(:name => settingName)
+    end
+  end
+end