shooting_star 1.0.3 → 1.0.4

data/History.txt

@@ -1,3 +1,18 @@
+*** 1.0.4 / 2007-03-29
++ 2 major enhancements:
+  + Cached rendering result of meteor/strike.
+  + Improved error and disconnection detection when reading socket.
++ 5 minor enhancements:
+  + Disabled caching when back.
+  + Added meteor_helper.
+  + Added timer to remove forsaken iframes for Safari.
+  + Added configuration option 'sweep_timeout'.
+  + Added 'session_timeout' option.
++ 2 minor bugfixes:
+  + Solved problem on caching of browsers of MacOS.
+  + Added workaround for Safari's strange behaviour after back navigation.
+  + Solved problem on connection management.
+
 *** 1.0.3 / 2007-03-22
 + 2 major enhancements:
   + Rails plugin is installed when shooting_star init.

data/Manifest.txt

@@ -32,6 +32,7 @@ vendor/plugins/meteor_strike/generators/meteor/meteor_generator.rb
 vendor/plugins/meteor_strike/generators/meteor/templates
 vendor/plugins/meteor_strike/generators/meteor/templates/controller.rb
 vendor/plugins/meteor_strike/generators/meteor/templates/model.rb
+vendor/plugins/meteor_strike/generators/meteor/templates/helper.rb
 vendor/plugins/meteor_strike/generators/meteor/templates/view.rhtml
 vendor/plugins/meteor_strike/generators/meteor/templates/migration.rb
 vendor/plugins/meteor_strike/generators/meteor/templates/unit_test.rb

data/Rakefile

@@ -42,6 +42,8 @@ task 'update_generator_template_files' do
     templates + '/controller.rb'
   cp 'app/models/meteor.rb',
     templates + '/model.rb'
+  cp 'app/helpers/meteor_helper.rb',
+    templates + '/helper.rb'
   cp 'app/views/meteor/strike.rhtml',
     templates + '/view.rhtml'
   cp 'test/unit/meteor_test.rb',

data/ext/asteroid.c

@@ -97,7 +97,7 @@ static int asteroid_poll_wait(
 #endif
 #ifdef HAVE_SYS_EPOLL_H
   #define AST_POLL_EVENT_SOCK(event) ((event)->data.fd)
-  #define AST_POLL_EVENT_CAN_READ(event) ((event)->events & (EPOLLIN | EPOLLPRI))
+  #define AST_POLL_EVENT_CAN_READ(event) ((event)->events & (EPOLLIN|EPOLLPRI))
 #endif
 
 #ifdef SO_NOSIGPIPE
@@ -206,15 +206,29 @@ static VALUE asteroid_s_stop(VALUE Self){
 
 static VALUE asteroid_server_send_data(VALUE Self, VALUE Data){
   VALUE Fd = rb_iv_get(Self, "@fd");
-  int fd = FIX2INT(Fd);
+  int fd = FIX2INT(Fd), remain = RSTRING(Data)->len, len;
   char *data = StringValuePtr(Data);
-  send(fd, data, RSTRING(Data)->len, MSG_NOSIGNAL);
+  while((len = send(fd, data, remain, MSG_NOSIGNAL)) > 0){
+    remain -= len;
+    data += len;
+  }
+  if(len == -1 && errno != EAGAIN){
+    if(rb_respond_to(Self, rb_intern("unbind"))){
+      rb_funcall(Self, rb_intern("unbind"), 0);
+    }
+  }
   return Qnil;
 }
 
 static VALUE asteroid_server_write_and_close(VALUE Self){
   VALUE Fd = rb_iv_get(Self, "@fd");
   int fd = FIX2INT(Fd);
+  char buf[1];
+  if(read(fd, buf, 1) == -1 && errno != EAGAIN){
+    if(rb_respond_to(Self, rb_intern("unbind"))){
+      rb_funcall(Self, rb_intern("unbind"), 0);
+    }
+  }
   asteroid_poll_event_t event;
   memset(&event, 0, sizeof(event));
   asteroid_poll_remove(epoll_fd, &event, fd);
@@ -239,7 +253,7 @@ int dispatch(){
           buf[len] = '\0';
           rb_str_concat(Buf, rb_str_new2(buf));
         }
-        if(len == -1){
+        if(len == -1 && errno == EAGAIN){
           if(rb_respond_to(Server, rb_intern("receive_data"))){
             rb_funcall(Server, rb_intern("receive_data"), 1, Buf);
           }

data/lib/shooting_star/channel.rb

@@ -33,9 +33,10 @@ module ShootingStar
     def self.sweep; @@channels.delete_if{|k,v| v.waiters.empty?} end
 
     def self.cleanup(channel)
-      result = @@channels[channel] && @@channels[channel].waiters.empty?
-      @@channels.delete(channel) if result
-      result
+      if @@channels[channel] && @@channels[channel].waiters.empty?
+        @@channels.delete(channel)
+      end
+      !@@channels.include?(channel)
     end
   end
 end

data/lib/shooting_star/server.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'cgi'
+require 'uri'
 require 'md5'
 require 'set'
 require 'form_encoder'
@@ -32,17 +33,20 @@ module ShootingStar
       if channel = Channel[@channel]
         channel.leave(self)
         notify(:event => :leave, :uid => @uid, :tag => @tag)
-        Channel.cleanup(@channel)
       end
       @@servers.delete(@signature)
       @@uids.delete(@signature)
       @@tags.delete(@signature)
       @@executings.delete(@signature)
       log "Disconnected: #{@uid}"
+      if Channel.cleanup(@channel)
+        log "Channel closed: #{@channel}"
+      end
     end
 
     # respond to an execution command. it'll be buffered.
     def respond(id, params)
+      return unbind && false unless @waiting || !session_timeout?
       @executing = @@executings[@signature] ||= Hash.new
       if params[:tag] && !params[:tag].empty? && !@tag.empty?
         return false if (params[:tag] & @tag).empty?
@@ -58,6 +62,7 @@ module ShootingStar
       return false if @execution.empty?
       send_data "HTTP/1.1 200 OK\nContent-Type: text/javascript\n\n"
       send_data @execution
+      @committed_at = Time.now
       @waiting = nil
       @execution = ''
       @executing = Hash.new
@@ -94,6 +99,12 @@ module ShootingStar
   private
     def log(*arg, &block) ShootingStar::log(*arg, &block) end
 
+    # check session timeout
+    def session_timeout?
+      return true unless @committed_at
+      Time.now - @committed_at > ShootingStar::CONFIG.session_timeout
+    end
+
     # broadcast an event to clients.
     def notify(params = {})
       return unless Channel[@channel]
@@ -112,13 +123,6 @@ module ShootingStar
       @waiting = true
     end
 
-    # clean up channel and it'll be closed if no one's listening.
-    def cleanup(channel)
-      if Channel.cleanup(channel)
-        log "Channel closed: #{@channel}"
-      end
-    end
-
     # give a response to the request or keep them waiting.
     def response
       headers = @data.split("\n")
@@ -143,26 +147,24 @@ module ShootingStar
       # load or create session informations
       @signature ||= @params['sig']
       @channel ||= path[1..-1].split('?', 2)[0]
-      @uid = @@uids[@signature] ||= @params['uid']
-      @tag = @@tags[@signature] ||=
-        (@params['tag'] || '').split(',').map{|i| CGI.unescape(i)}
-      @executing = @@executings[@signature] ||= Hash.new
-      @@servers[@signature] = self
-      # make uncacheable path
-      @timestamp = ShootingStar::timestamp
-      path += (path.index('?') ? '&' : '?') + "timestamp=#{@timestamp}"
       @query = "channel=#{@channel}&sig=#{@signature}"
-      # prepare channel
-      unless Channel[@channel]
-        Channel.new(@channel)
-        log "Channel opened: #{@channel}"
-      end
       # process verb
       if method == 'GET'
         make_connection(path)
-        notify(:event => :enter, :uid => @uid, :tag => @tag)
-        log "Connected: #{@uid}"
       else
+        unless Channel[@channel]
+          Channel.new(@channel)
+          log "Channel opened: #{@channel}"
+        end
+        unless @@servers[@signature] || @params['__t__'] == 'rc'
+          notify(:event => :enter, :uid => @uid, :tag => @tag)
+          log "Connected: #{@uid}"
+        end
+        @uid = @@uids[@signature] ||= @params['uid']
+        @tag = @@tags[@signature] ||=
+          (@params['tag'] || '').split(',').map{|i| CGI.unescape(i)}
+        @executing = @@executings[@signature] ||= Hash.new
+        @@servers[@signature] = self
         wait_for
       end
     rescue
@@ -174,33 +176,40 @@ module ShootingStar
 
     # add execution line to the buffer.
     def execute(id, params)
+      sweep_timeout = ShootingStar::CONFIG.sweep_timeout
       @executing[id] = params
-      @query += "&" +FormEncoder.encode(params) if params
+      query = @query.sub(%r[\&sig=\d+], '')
+      query += "&" + FormEncoder.encode(params) if params
       @execution += <<-"EOH"
       (function(){
         var iframe = document.createElement('iframe');
         var remove = function(){document.body.removeChild(iframe)};
-        iframe.onload = function(){setTimeout(remove, 0)};
-        iframe.src = '#{@params['execute']}/#{id}?#{@query}';
+        var timer = setTimeout(remove, #{sweep_timeout});
+        iframe.onload = function(){clearTimeout(timer); setTimeout(remove, 0)};
         document.body.appendChild(iframe);
+        iframe.src = '#{@params['execute']}/#{id}?#{query}';
       })();
       EOH
     end
 
     # make client connect us.
     def make_connection(path)
+      path.sub!(%r[\&__ts__=.*$], '&__ts__=')
+      assets = URI.parse(@params['execute'])
+      assets.path = '/javascripts/prototype.js'
+      assets.query = assets.fragment = nil
       send_data "HTTP/1.1 200 OK\nContent-Type: text/html\n\n" +
       <<-"EOH"
-      <html><head><script type='text/javascript'
-       src='http://alphastars.drecom.jp/javascripts/prototype.js'
-      ></script>
-      <script type='text/javascript'>
+      <html><head><script type="text/javascript" src="#{assets}"></script>
+      <script type="text/javascript">
       //<![CDATA[
-      var connect = function()
-      { var request = new Ajax.Request(
-          #{path.to_json}, {method: 'post', evalScript: true,
-          onComplete: function(xhr){
-            setTimeout(connect,
+      var connect = function(reconnect)
+      { var request = new Ajax.Request([#{path.to_json},
+            new Number(new Date()).toString(32),
+            reconnect && '&__t__=rc'
+          ].join(''),
+          {evalScript: true, onComplete: function(xhr){
+            setTimeout(function(){connect(true)},
               xhr.getResponseHeader('Content-Type') ? 0 : 1000);
           }});
         var disconnect = function()
@@ -209,10 +218,12 @@ module ShootingStar
         };
         Event.observe(window, 'unload', disconnect);
       };
-      setTimeout(connect, 0);
+      setTimeout(function(){connect(false)}, 0);
       //]]>
       </script></head><body></body></html>
       EOH
+    rescue
+    ensure
       write_and_close
     end
   end

data/lib/shooting_star.rb

@@ -7,13 +7,15 @@ require 'shooting_star/config'
 require 'shooting_star/shooter'
 
 module ShootingStar
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
   CONFIG = Config.new(
     :config => 'config/shooting_star.yml',
     :pid_file => 'log/shooting_star.pid',
     :log_file => 'log/shooting_star.log',
     :daemon => false,
-    :slient => false)
+    :slient => false,
+    :session_timeout => 10,
+    :sweep_timeout => 500_000)
 
   def self.configure(options = {})
     if @log_file
@@ -48,11 +50,10 @@ module ShootingStar
     plugin_dir = File.join(base_dir, 'vendor/plugins')
     `mkdir -p #{plugin_dir}` unless File.exist? plugin_dir
     meteor_strike_dir = File.join(plugin_dir, 'meteor_strike')
-    unless File.exist?(meteor_strike_dir)
-      src_dir = File.join(File.dirname(__FILE__),
-        '../vendor/plugins/meteor_strike')
-      `cp -R #{src_dir} #{meteor_strike_dir}`
-    end
+    src_dir = File.join(File.dirname(__FILE__),
+      '../vendor/plugins/meteor_strike')
+    `mkdir -p #{meteor_strike_dir}`
+    `cp -Rf #{src_dir}/* #{meteor_strike_dir}`
   end
 
   def self.start(&block)

data/vendor/plugins/meteor_strike/generators/meteor/meteor_generator.rb

@@ -23,6 +23,9 @@ class MeteorGenerator < Rails::Generator::NamedBase
       m.template 'functional_test.rb',
         File.join('test/functional', class_path, "#{controller_file}_test.rb")
 
+      m.template 'helper.rb',
+        File.join('app/helpers', class_path, "#{file_name}_helper.rb")
+
       m.file 'view.rhtml',
         File.join('app/views', class_path, "#{file_name}/strike.rhtml")
 

data/vendor/plugins/meteor_strike/generators/meteor/templates/controller.rb

@@ -1,5 +1,7 @@
 class MeteorController < ApplicationController
   layout nil
+  caches_action :strike
+  after_filter :notify_execution, :only => [:strike]
 
   def strike
     @channel = params[:channel].split('/').map{|i| CGI.escape(i)}.join('/')
@@ -10,7 +12,6 @@ class MeteorController < ApplicationController
       @javascript = %Q[setTimeout(function(){
         meteorStrike.event[#{@channel.to_json}](#{params.to_json});}, 0);]
     end
-    Meteor.shooter.executed(params[:sig], params[:id])
   end
 
   def update
@@ -21,5 +22,11 @@ class MeteorController < ApplicationController
 
   def sweep
     Meteor.shooter.sweep
+    render :nothing => true
+  end
+
+private
+  def notify_execution
+    Meteor.shooter.executed(params[:sig], params[:id])
   end
 end

data/vendor/plugins/meteor_strike/generators/meteor/templates/helper.rb

@@ -0,0 +1,2 @@
+module MeteorHelper
+end

data/vendor/plugins/meteor_strike/lib/meteor_strike.rb

@@ -3,7 +3,21 @@ require 'md5'
 
 module MeteorStrike
   module Helper
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :form_tag, :timestamp
+      end
+    end
+
     def meteor_strike(channel, options = {})
+      unless options[:cache] || @meteor_strike
+        cc = controller.headers['Cache-Control'] || ''
+        cc += ', ' unless cc.empty?
+        cc += 'no-store, no-cache, must-revalidate, max-age=0, '
+        cc += 'post-check=0, pre-check=0'
+        controller.headers['Cache-Control'] = cc
+        @meteor_strike = true
+      end
       config = ActiveRecord::Base.configurations[RAILS_ENV]
       shooting_star_uri = "#{config['shooting_star']['server']}/#{channel}"
       uri = url_for(:only_path => false).split('/')[0..2].join('/')
@@ -44,7 +58,8 @@ module MeteorStrike
         };
         setTimeout(function(){ 
           var iframe = document.createElement('iframe');
-          iframe.src = "#{base_uri}&uid=#{uid}&tag=#{tag}&sig=#{sig}";
+          iframe.src = ["#{base_uri}&uid=#{uid}&tag=#{tag}&sig=#{sig}",
+            '&__ts__=', new Number(new Date()).toString(32)].join('');
           iframe.frameborder = "0";
           iframe.width = "0";
           iframe.height = "0";
@@ -57,5 +72,23 @@ module MeteorStrike
       </script>
       EOH
     end
+
+  private
+    # Workaround for Safari's strange behaviour after back navigation.
+    # Safari never posts if form elements are not modified since back
+    # navigation. So we append timestamp before submitting.
+    def form_tag_with_timestamp(urlop = {}, options = {}, *arg, &block)
+      options = options.stringify_keys
+      (options['onsubmit'] ||= '').insert(0, %Q[
+        if(!this.__ts__){
+          var ts = document.createElement('input');
+          ts.name = ts.id = '__ts__';
+          ts.type = 'hidden';
+          this.appendChild(ts);
+        }
+        this.__ts__.value = new Number(new Date()).toString(32);
+      ]) unless /^get$/i === options['method']
+      form_tag_without_timestamp(urlop, options, *arg, &block)
+    end 
   end
 end

data/vendor/plugins/meteor_strike/test/meteor_strike_test.rb

@@ -1,15 +1,23 @@
 require 'test/unit'
+require 'rubygems'
+require 'active_support'
 require File.join(File.dirname(__FILE__), '../lib/meteor_strike')
 begin
-  require 'rubygems'
   require 'redgreen'
 rescue
 end
 
 class MeteorStrikeTest < Test::Unit::TestCase
-  include MeteorStrike::Helper
-
   def test_meteor_strike
     assert respond_to?(:meteor_strike)
+    form_tag
+    assert @form_tag
+  end
+
+private
+  def form_tag(*arg, &block)
+    @form_tag = true
   end
+
+  include MeteorStrike::Helper
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: shooting_star
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
-date: 2007-03-23 00:00:00 +09:00
+  version: 1.0.4
+date: 2007-03-29 00:00:00 +09:00
 summary: Our goal is development of practical comet server which will be achieving over 100,000 simultaneous connections per host. On this purpose, we abandon portability and use system calls depending on particular OS such as epoll and kqueue.
 require_paths: 
 - lib
@@ -64,6 +64,7 @@ files:
 - vendor/plugins/meteor_strike/generators/meteor/templates
 - vendor/plugins/meteor_strike/generators/meteor/templates/controller.rb
 - vendor/plugins/meteor_strike/generators/meteor/templates/model.rb
+- vendor/plugins/meteor_strike/generators/meteor/templates/helper.rb
 - vendor/plugins/meteor_strike/generators/meteor/templates/view.rhtml
 - vendor/plugins/meteor_strike/generators/meteor/templates/migration.rb
 - vendor/plugins/meteor_strike/generators/meteor/templates/unit_test.rb