distribustream 0.4.0 → 0.4.1

data/CHANGES

@@ -1,3 +1,16 @@
+Version 0.4.1
+* Add -v / --version flags to dsclient and dstream
+
+* Add additional flags to dstream for specifying listen addr / port
+
+* Status page now factored into its own ERb template in status/
+
+* Added Mongrel handlers to serve images/stylesheets for status page
+
+* Added StatusHelper module to provide helpers for status page
+
+* New status page
+
 Version 0.4.0
 * Change PDTP::Client#run to take an instance of PDTP::Client::Callbacks rather
   than the name of the class to instantiate

data/README

@@ -34,7 +34,7 @@ You can see what's going on through the web interface, which runs one port
 above the port you configured the server to listen on.  If the server is
 listening on the default port of 6086, you can reach the web interface at:
 
-http://myserver.url:6087/stats
+http://myserver.url:6087/status/
 
 To test your server, use the DistribuStream client:
 

data/bin/dsclient

@@ -51,6 +51,7 @@ require File.dirname(__FILE__) + '/../lib/pdtp/client'
 
 opts = GetoptLong.new(
   [ '--help',   '-h', GetoptLong::NO_ARGUMENT ],
+  [ '--version', '-v', GetoptLong::NO_ARGUMENT],
   [ '--output', '-o', GetoptLong::REQUIRED_ARGUMENT ],
   [ '--listen', '-l', GetoptLong::OPTIONAL_ARGUMENT ]
 )
@@ -64,11 +65,19 @@ def display_usage
   exit
 end
 
+# Display version information
+def display_version
+  STDERR.write "#{File.basename $0} #{PDTP::VERSION} - DistribuStream client application\n"
+  STDERR.write "Copyright (C) 2006-07 ClickCaster, Inc. (info@clickcaster.com)\n"
+  exit
+end
+
 opts.each do |opt, arg|
   case opt
-  when '--help'   then display_usage
-  when '--output' then filename = arg
-  when '--listen' then listen_port = arg.to_i
+  when '--help'    then display_usage
+  when '--version' then display_version
+  when '--output'  then filename = arg
+  when '--listen'  then listen_port = arg.to_i
   end
 end
 

data/bin/dstream

@@ -26,20 +26,33 @@ require File.dirname(__FILE__) + '/../lib/pdtp/server'
 
 program_name = File.basename($0)
 config_filename = nil
+listen_addr = nil
+listen_port = nil
 
 OptionParser.new do |opts|
   opts.banner = "Usage: #{program_name} [options]"
   opts.on("--config CONFIGFILE", "Load specified config file.") do |c|
     config_filename = c
   end
+  opts.on("--listen ADDR", "Listen at the specified host address.") do |h|
+    listen_addr = h
+  end
+  opts.on("--port PORT", "Listen on the specified port number.") do |p|
+    listen_port = p
+  end
   opts.on("--help", "Prints this usage info.") do
     puts opts
     exit
   end
+  opts.on("--version", "Print version information.") do
+    puts "#{program_name} #{PDTP::VERSION} - DistribuStream server application"
+    puts "Copyright (C) 2006-07 ClickCaster, Inc. (info@clickcaster.com)"
+    exit
+  end
 end.parse!      
 
 config = {
-  :host             => '0.0.0.0',
+  :host             => '127.0.0.1',
   :port             => 6086, #server port
   :listen_port      => 8000, #client listen port
   :file_root        => '.',
@@ -68,7 +81,10 @@ else
   end
 end
 
-puts "#{program_name} starting. Run '#{program_name} --help' for more info."
+config[:host] = listen_addr unless listen_addr.nil?
+config[:port] = listen_port unless listen_port.nil?
+
+puts "#{program_name} #{PDTP::VERSION} starting. Run '#{program_name} --help' for more info."
 
 server = PDTP::Server.new config[:host], config[:port]
 

data/distribustream.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 GEMSPEC = Gem::Specification.new do |s|
   s.name = "distribustream"
-  s.version = "0.4.0"
+  s.version = "0.4.1"
   s.date = "2008-11-15"
   s.summary = "DistribuStream is a fully open peercasting system allowing on-demand or live streaming media to be delivered at a fraction of the normal cost"
   s.email = "tony@clickcaster.com"
@@ -12,7 +12,7 @@ GEMSPEC = Gem::Specification.new do |s|
   s.rdoc_options = ["--exclude", "definitions", "--exclude", "indexes"]
   s.extra_rdoc_files = ["COPYING", "README", "CHANGES", "pdtp-specification.xml"]
   s.authors = ["Tony Arcieri", "Ashvin Mysore", "Galen Pahlke", "James Sanders", "Tom Stapleton"]
-  s.files = Dir.glob("{bin,lib,conf}/**/*") + ['Rakefile', 'distribustream.gemspec']
+  s.files = Dir.glob("{bin,lib,conf,status}/**/*") + ['Rakefile', 'distribustream.gemspec']
   s.executables = %w{dstream dsclient}
   s.add_dependency("eventmachine", ">= 0.9.0")
   s.add_dependency("mongrel", ">= 1.0.2")

data/lib/pdtp/common.rb

@@ -22,7 +22,7 @@
 
 # Namespace for all PDTP components
 module PDTP
-  PDTP::VERSION = '0.4.0' unless defined? PDTP::VERSION
+  PDTP::VERSION = '0.4.1' unless defined? PDTP::VERSION
   def self.version() VERSION end
 
   PDTP::DEFAULT_PORT = 6086 unless defined? PDTP::DEFAULT_PORT

data/lib/pdtp/common/length_prefix_protocol.rb

@@ -88,34 +88,33 @@ module PDTP
     
     # Callback for processing incoming frames
     def receive_data(data)
-      # Read data and append it to the size prefix unless it's already been read
-      data = @prefix.append(data) unless @prefix.read?
-      return if data.nil?
-      
-      # If we've read the prefix, append the data
-      @buffer << data
-      
-      # Don't do anything until we receive the specified amount of data
-      return unless @buffer.length >= @prefix.length
-      
-      # Extract the specified amount of data and process it
-      data = @buffer[0..(@prefix.length - 1)]
-      
-      # Store any remaining data
-      remainder = @buffer[@prefix.length..@buffer.length]
-      
-      # Invoke receive_packet and allow the user to process the data
-      receive_packet data
-      
-      # Reset the prefix and buffer since we've received a whole frame
-      @prefix.reset!
-      @buffer = ''
-      
-      # Don't do anything if there's no more data
-      return if remainder.nil? or remainder.empty?
-      
-      # Otherwise continue processing the data
-      receive_data remainder
+      begin
+        # Read data and append it to the size prefix unless it's already been read
+        data = @prefix.append(data) unless @prefix.read?
+        return if data.nil?
+        
+        # If we've read the prefix, append the data
+        @buffer << data
+        
+        # Don't do anything until we receive the specified amount of data
+        return unless @buffer.length >= @prefix.length
+        
+        # Extract the specified amount of data and process it
+        data = @buffer[0..(@prefix.length - 1)]
+        
+        # Store any remaining data
+        remainder = @buffer[@prefix.length..@buffer.length]
+        
+        # Invoke receive_packet and allow the user to process the data
+        receive_packet data
+        
+        # Reset the prefix and buffer since we've received a whole frame
+        @prefix.reset!
+        @buffer = ''
+
+        # Store data for next iteration of the loop
+        data = remainder
+      end until data.nil? or data.empty?
     end
     
     # Stub for receiving a frame

data/lib/pdtp/server.rb

@@ -50,8 +50,24 @@ module PDTP
     
     # Run a web server to display statistics on the given address and port 
     def enable_status_page(path = '/status')
-      log "status at http://#{@addr}:#{@http_port}#{path}"
-      http_server.register path, StatusHandler.new(@dispatcher), true
+      # Strip trailing slash (if present)
+      path.sub!(/\/$/, '')
+      
+      log "status at http://#{@addr}:#{@http_port}#{path}/"
+      
+      # Redirect requests without a trailing slash
+      http_server.register path, Mongrel::RedirectHandler.new(path + '/')
+      
+      # Register the status handler
+      http_server.register path + '/', StatusHandler.new(@orig_addr, @dispatcher), true
+      
+      # Serve status images
+      images = Mongrel::DirHandler.new(File.dirname(__FILE__) + '/../../status/images', false)
+      http_server.register path + '/images', images
+      
+      # Serve status stylesheets
+      styles = Mongrel::DirHandler.new(File.dirname(__FILE__) + '/../../status/stylesheets', false)
+      http_server.register path + '/stylesheets', styles
     end
     
     # Serve files from the given directory

data/lib/pdtp/server/status_handler.rb

@@ -25,79 +25,38 @@ require 'mongrel'
 require 'erb'
 
 require File.dirname(__FILE__) + '/../common/http_server'
+require File.dirname(__FILE__) + '/status_helper'
 
 module PDTP
   class Server
-    #set up the mongrel server for serving the stats page
+    # A Mongrel::HttpHandler for generating the status page
     class StatusHandler < Mongrel::HttpHandler
-      def initialize(dispatcher)
-        @dispatcher = dispatcher
+      include StatusHelper
+      
+      def initialize(vhost, dispatcher)
+        @vhost, @dispatcher = vhost, dispatcher
       end
 
-      # process an incoming request to the admin page 
+      # Process an incoming request to generate the status page
       def process(request, response)
         response.start(200) do |head, out|
           out.write begin
-            generate_html_stats
+            # Read the status page ERb template
+            erb_data = File.read(File.dirname(__FILE__) + '/../../../status/index.erb')
+            
+            # Render the status ERb template
+            html = ERB.new(erb_data).result(binding)
+            
+            # Call reset_cycle from the StatusHelper to reset cycle() calls
+            reset_cycle
+            
+            # Return output html
+            html
           rescue Exception => e
             "Exception: #{e}\n#{e.backtrace.join("\n")}"
           end
         end    
-      end
-      
-      #builds an html page with information about the server's internal workings
-      def generate_html_stats
-        s = ERB.new <<EOF
-<html><head><title>DistribuStream Status</title></head>
-<body>
-<h1>DistribuStream Status</h1>
-Time=<%= Time.now %><br> Connected Clients=<%= @dispatcher.connections.size %>
-<center><table border="1">
-<tr><th>Client</th><th>Transfers</th><th>Files</th></tr>
-<% @dispatcher.connections.each do |c| %>
-  <tr><td>
-  <% if c.file_service? %>
-    <b>File Service</b>
-  <% else %>
-    <%= @dispatcher.connection_name(c) %>
-  <% end %>
-  <% host, port = c.get_peer_info %>
-  <br><%= host %>:<%= port %>
-  </td>
-  <td>
-  <%
-  @dispatcher.client_info(c).transfers.each do |key,t|
-    if c==t.giver
-      type="UP: "
-      peer=t.taker
-    else
-      type="DOWN: "
-      peer=t.giver
-    end
-    %>
-    <%= type %> id=<%= t.transfer_id %><br>
-    <%
-  end
-  %>
-  </td>
-  <td>
-  <%
-  @dispatcher.client_info(c).chunk_info.get_file_stats.each do |fs|
-    %>
-    <%= fs.url %> size=<%= fs.file_chunks %> req=<%= fs.chunks_requested %>
-    prov=<%= fs.chunks_provided %> transf=<%= fs.chunks_transferring %><br>    
-    <%
-  end      
-  %>
-  </td></tr>
-  <%
-end
-%>
-</table>
-</body></html>
-EOF
-        s.result binding
-      end
+      end      
     end
   end
-end
+end

data/lib/pdtp/server/status_helper.rb

@@ -0,0 +1,155 @@
+#--
+# Copyright (C) 2006-07 ClickCaster, Inc. (info@clickcaster.com)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# 
+# This source file is distributed as part of the 
+# DistribuStream file transfer system.
+#
+# See http://distribustream.org/
+#++
+
+module PDTP
+  class Server
+    # Helpers to be called from the DistribuStream status page ERb
+    module StatusHelper
+      # Number of clients presently connected
+      def client_count
+        clients = @dispatcher.connections.size - 1
+        clients == 1 ? "1 client" : "#{clients} clients"
+      end
+
+      # Server's virtual host name
+      def vhost
+        @vhost
+      end
+
+      # Iterate over all connected peers
+      def each_peer(&block)
+        @dispatcher.connections.each(&block)
+      end
+
+      # Iterate over all of a peer's active transfers
+      def each_transfer(peer)
+        raise ArgumentError, "no block given" unless block_given?
+        @dispatcher.client_info(peer).transfers.each { |_, transfer| yield transfer }
+      end
+
+      # Iterate over all of a peer's active files
+      def each_file(peer, &block)
+        @dispatcher.client_info(peer).chunk_info.get_file_stats.each(&block)
+      end
+
+      # Name of a peer (client ID or file service)
+      def peer_name(peer)
+        if peer.file_service?
+          "<b>File Service</b>"
+        else
+          @dispatcher.connection_name(peer)
+        end
+      end
+      
+      # IP address and port of a peer
+      def peer_address(peer)
+        host, port = peer.get_peer_info
+        "#{host}:#{port}"
+      end
+
+      # Information about an active transfer
+      def transfer_info(peer, transfer)
+        "#{peer == transfer.giver ? 'UP' : 'DOWN'}: id=#{transfer.transfer_id.split('$')[2..3].join(':')}"
+      end
+
+      # Path to a file
+      def file_path(file)
+        file.url.sub(/.+?:\/\/.+?\//, '/')
+      end
+      
+      # Number of requested chunks that have been completed
+      def chunks_completed(file)
+        file.chunks_provided
+      end
+      
+      # Number of requested or completed chunks
+      def chunks_active(file)
+        file.file_chunks
+      end
+      
+      # Percent of a file that has been transferred
+      def percent_complete(file)
+        (chunks_completed(file).to_f / chunks_active(file) * 100).to_i
+      end
+
+      #
+      # Cycle code excerpted from ActionPack and released under the MIT license
+      # Copyright (c) 2004-2006 David Heinemeier Hansson
+      #
+
+      def cycle(first_value, *values)
+        if (values.last.instance_of? Hash)
+          params = values.pop
+          name = params[:name]
+        else
+          name = "default"
+        end
+        values.unshift(first_value)
+
+        cycle = get_cycle(name)
+        if (cycle.nil? || cycle.values != values)
+          cycle = set_cycle(name, Cycle.new(*values))
+        end
+        return cycle.to_s
+      end
+
+      def reset_cycle(name = "default")
+        cycle = get_cycle(name)
+        cycle.reset unless cycle.nil?
+      end
+
+      #######
+      private
+      #######
+      
+      class Cycle #:nodoc:
+        attr_reader :values
+        
+        def initialize(first_value, *values)
+          @values = values.unshift(first_value)
+          reset
+        end
+        
+        def reset
+          @index = 0
+        end
+
+        def to_s
+          value = @values[@index].to_s
+          @index = (@index + 1) % @values.size
+          return value
+        end
+      end
+      
+
+      def get_cycle(name)
+        @_cycles = Hash.new unless defined?(@_cycles)
+        return @_cycles[name]
+      end
+
+      def set_cycle(name, cycle_object)
+        @_cycles = Hash.new unless defined?(@_cycles)
+        @_cycles[name] = cycle_object
+      end      
+    end
+  end
+end

data/status/index.erb

@@ -0,0 +1,44 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>DistribuStream Status</title>
+  <link href="stylesheets/style.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+  <h1><img src="images/logo.png" alt="DistribuStream Status" /></h1>
+  <div id="server_info">
+    Host: <%= vhost %><br />
+    <%= client_count %>
+  </div>
+  <center>
+    <table border="0" cellpadding="0" cellspacing="0">
+      <tr><th>Client</th><th>Transfers</th><th>Files</th></tr>
+      <% each_peer do |peer| %>
+        <tr class="row<%= cycle(' row_alternate', '') %>"><td>
+          <%= peer_name(peer) %><br />
+          <%= peer_address(peer) %>
+        </td>
+        <td>
+        <% each_transfer(peer) do |transfer| %>
+          <%= transfer_info(peer, transfer) %><br />
+        <% end %>
+        </td>
+        <td>
+        <% each_file(peer) do |file| %>
+          <%= file_path(file) %> 
+          (<%= chunks_completed(file) %>/<%= chunks_active(file) %>, 
+          <%= percent_complete(file) %>%)<br />
+        <% end %>
+        </td></tr>
+      <% end %>
+    </table>
+  </center>
+  <hr />
+  <div id="footer"> 
+    <%= vhost %> - 
+    <a href="http://distribustream.org/">DistribuStream</a> <%= PDTP::VERSION %> 
+    &copy;2006-07 <a href="http://www.clickcaster.com/">ClickCaster, Inc.</a><br />
+    <%= Time.now %>
+  </div>
+</body>
+</html>

data/status/stylesheets/style.css

@@ -0,0 +1,42 @@
+* {
+  margin: 0;
+  padding: 0;
+}
+
+html, body {
+	font-family: Verdana, Helvetica, Arial, sans-serif;
+	font-size: 12px;
+	color: black;
+	background: white;
+	padding: 0.5em;
+}
+
+hr {
+	margin: 0.5em;
+}
+
+th {
+	text-align: left;
+	font-size: 1.2em;
+	padding: 0.2em 1em;
+}
+
+td {
+	text-align: left;
+	padding: 0.5em;
+}
+
+#server_info {
+	position: absolute;
+	top: 1em;
+	right: 1em;
+	font-size: 1.2em;
+}
+
+#footer {
+	font-style: italic;
+}
+
+.row_alternate {
+	background: #EEEEEE;
+}

metadata

@@ -1,9 +1,9 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
+rubygems_version: 0.9.0
 specification_version: 1
 name: distribustream
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 date: 2008-11-15 00:00:00 -07:00
 summary: DistribuStream is a fully open peercasting system allowing on-demand or live streaming media to be delivered at a fraction of the normal cost
 require_paths: 
@@ -33,37 +33,43 @@ authors:
 - James Sanders
 - Tom Stapleton
 files: 
-- bin/dsclient
 - bin/dstream
+- bin/dsclient
 - lib/pdtp
+- lib/pdtp/server
+- lib/pdtp/common.rb
 - lib/pdtp/client
-- lib/pdtp/client/callbacks.rb
-- lib/pdtp/client/connection.rb
+- lib/pdtp/common
+- lib/pdtp/client.rb
+- lib/pdtp/server.rb
+- lib/pdtp/server/file_service_protocol.rb
+- lib/pdtp/server/status_handler.rb
+- lib/pdtp/server/trust.rb
+- lib/pdtp/server/status_helper.rb
+- lib/pdtp/server/transfer.rb
+- lib/pdtp/server/client_info.rb
+- lib/pdtp/server/connection.rb
+- lib/pdtp/server/file_service.rb
+- lib/pdtp/server/dispatcher.rb
 - lib/pdtp/client/file_buffer.rb
-- lib/pdtp/client/file_service.rb
 - lib/pdtp/client/http_client.rb
 - lib/pdtp/client/http_handler.rb
+- lib/pdtp/client/callbacks.rb
 - lib/pdtp/client/transfer.rb
-- lib/pdtp/client.rb
-- lib/pdtp/common
-- lib/pdtp/common/file_service.rb
-- lib/pdtp/common/http_server.rb
+- lib/pdtp/client/connection.rb
+- lib/pdtp/client/file_service.rb
 - lib/pdtp/common/length_prefix_protocol.rb
+- lib/pdtp/common/http_server.rb
 - lib/pdtp/common/protocol.rb
-- lib/pdtp/common.rb
-- lib/pdtp/server
-- lib/pdtp/server/client_info.rb
-- lib/pdtp/server/connection.rb
-- lib/pdtp/server/dispatcher.rb
-- lib/pdtp/server/file_service.rb
-- lib/pdtp/server/file_service_protocol.rb
-- lib/pdtp/server/status_handler.rb
-- lib/pdtp/server/transfer.rb
-- lib/pdtp/server/trust.rb
-- lib/pdtp/server.rb
+- lib/pdtp/common/file_service.rb
+- conf/example.yml
 - conf/bigchunk.yml
 - conf/debug.yml
-- conf/example.yml
+- status/stylesheets
+- status/images
+- status/index.erb
+- status/stylesheets/style.css
+- status/images/logo.png
 - Rakefile
 - distribustream.gemspec
 - COPYING