rsence 2.0.9.23 → 2.1.0

data/lib/transporter/transporter.rb

@@ -38,19 +38,26 @@ module RSence
     def initialize
       @config = RSence.config[:transporter_conf]
       @accept_req = false
-      @valuemanager = ValueManager.new
-      @sessions = SessionManager.new( self )
       core_pkgs = {
         :core => [:transporter, :session_storage, :session_manager, :value_manager]
       }
-      @plugins = PluginManager.new(
-        RSence.config[:plugin_paths],
-        self,
-        RSence.args[:autoupdate],
-        false,
-        core_pkgs[:core],
-        core_pkgs
-      )
+      @plugins = PluginManager.new( {
+        :plugin_paths => RSence.config[:plugin_paths],
+        :transporter => self,
+        :autoreload => RSence.args[:autoupdate],
+        :name_prefix => false,
+        :resolved_deps => core_pkgs[:core],
+        :resolved_categories => core_pkgs
+      })
+      @valuemanager = ValueManager.new
+      @sessions = SessionManager.new( self )
+      if RSence.config[:session_conf][:reset_sessions]
+        puts "Resetting all sessions..."
+        @sessions.reset_sessions()
+      else
+        @sessions.restore_sessions()
+      end
+
       if RSence.launch_pid != Process.pid
         Process.kill( 'TERM', RSence.launch_pid )
       end
@@ -180,7 +187,7 @@ module RSence
         ## Calls the restore_ses of plugins, when a session is restored (page reload with previously active session)
         if msg.restored_session
           msg.session[:deps] = []
-        
+          
           if msg.cloned_source
             begin
               @plugins.delegate( :cloned_target, msg, msg.cloned_source )
@@ -190,24 +197,29 @@ module RSence
               xhr_traceback_handler( e, "Transporter::PluginDelegateClonedTargetError: @plugins.delegate 'cloned_target' failed." )
             end
           end
-        
+          
           begin
             @plugins.delegate( :restore_ses, msg )
+            msg.session[:plugin_incr] == @plugins.incr
           rescue => e
             response_success = false
             xhr_error_handler( msg, :plugin_delegate_restore_ses_error, e.message )
             xhr_traceback_handler( e, "Transporter::PluginDelegateRestoreSesError: @plugins.delegate 'restore_ses' failed." )
           end
-        
+          
         elsif msg.new_session
+          
           begin
             @plugins.delegate( :init_ses, msg )
+            msg.session[:plugin_incr] == @plugins.incr
           rescue => e
             response_success = false
             xhr_error_handler( msg, :plugin_delegate_init_ses_error, e.message )
             xhr_traceback_handler( e, "Transporter::PluginDelegateInitSesError: @plugins.delegate 'init_ses' failed." )
           end
+          
         elsif msg.cloned_targets
+          
           begin
             @plugins.delegate( :cloned_source, msg, msg.cloned_targets )
           rescue => e
@@ -215,6 +227,10 @@ module RSence
             xhr_error_handler( msg, :plugin_delegate_cloned_source_error, e.message )
             xhr_traceback_handler( e, "Transporter::PluginDelegateClonedSourceError: @plugins.delegate 'cloned_source' failed." )
           end
+          
+        elsif msg.refresh_page?( @plugins.incr ) and @config[:client_autoreload]
+          # Forces the client to reload, if plugins are incremented
+          msg.reply("window.location.reload( true );")
         end
         
         ## Calls validators for changed values

data/lib/values/hvalue.rb

@@ -122,6 +122,14 @@ module RSence
       return true
     end
     
+    # Checks, if the plugin_name and method_name pairing is already bound with the bind method. Returns true or false.
+    def bound?( plugin_name, method_name )
+      plugin_name = plugin_name.to_sym unless plugin_name.class == Symbol
+      method_name = method_name.to_sym unless method_name.class == Symbol
+      return false unless @members.has_key?(plugin_name)
+      return @members[plugin_name].include?(method_name)
+    end
+    
     # Releases the responder of the value, both params as in bind, but optional +method_name+ can be omitted, matching all methods bound to the +plugin_name+.
     # @param [Symbol] plugin_name The name of the plugin acting as a responder to the value.
     # @param [Symbol] method_name The name of the method of the plugin acting as a responder to the value.
@@ -135,6 +143,9 @@ module RSence
         @members.delete( plugin_name )
       else 
         @members[plugin_name].slice!(@members[plugin_name].index( method_name )) if @members[plugin_name].include?(method_name)
+        if @members[plugin_name].empty?
+          @members.delete( plugin_name )
+        end
       end
       return true
     end
@@ -211,6 +222,25 @@ module RSence
       end
     end
     
+    # Sets the key of the hash data of the value, the change will be synced with the client.
+    # @param [Message] msg The {Message} instance.
+    # @param [String] key The key of data to change
+    # @param [#to_json] data Any data that can be mapped to JSON and handled by the client.
+    # @param [Boolean] dont_tell_client Doesn't notify the client about the change, if true.
+    def set_key( msg, key, data, dont_tell_client=false )
+      
+      @data[key] = data
+      
+      # won't tell the client about the change, usually not needed
+      unless dont_tell_client
+        ## update the flags
+        @sync  = false
+        @is_valid = true
+        
+        add_to_sync( msg )
+      end
+    end
+    
     # @private Tell the client that the value changed.
     def to_client( msg )
       if @is_new_to_client

data/plugins/client_pkg/info.yaml

@@ -3,7 +3,7 @@
 title: Client Resource Package
 
 # The human-readable version of the package
-version: 2.0.0
+version: 2.1.0
 
 # A brief description of the package (rdoc formatting supported)
 description: |
@@ -17,7 +17,7 @@ description: |
 reloadable: false
 
 # System version requirement.
-sys_version: '>= 2.0.0'
+sys_version: '>= 2.1.0'
 
 category: :system
 

data/plugins/main/info.yaml

@@ -3,16 +3,17 @@
 title: Main Plugin
 
 # The human-readable version of the package
-version: 2.0.0
+version: 2.1.0
 
 # A brief description of the package (rdoc formatting supported)
 description: |
-  The main plugin manages the flow of communication between client and server.
+  The main plugin manages the flow of communication between client and server
+  as well as initializes a startup web page, if no other plugin does so.
 
 # System version requirement.
-sys_version: '>= 2.0.0'
+sys_version: '>= 2.1.0'
 
 category: :system
 
-depends_on: :index_html
+depends_on: :client_pkg
 

data/plugins/main/main.rb

@@ -7,9 +7,10 @@
  ##
 
 
-# The MainPlugin is accessible as +@plugins.main+ from other plugins.
+# The MainPlugin is accessible as +@plugins.main+ and just +main+ from other plugins.
 #
 # = MainPlugin provides mainly client setup and the following services:
+# * The root html page, which includes the scripts and sets up client startup variables.
 # * The url of the client as a HValue, including the anchor.
 #   * Accessible via +msg.session[:main][:location_href]+
 # * The local time of the client's web browser as a HValue, as seconds since epoch.
@@ -18,38 +19,165 @@
 # * Provides the +#init_ui+ event for plugins that respond to it.
 class MainPlugin < Plugin
   
-  # @private Internal structures, binds configuration data as instance variables
+  # # Session-specific index page renderer (unused)
+  # def session_index_html( request, response )
+  #   
+  #   ses_key = @randgen.gen
+  #   sha_key = ''
+  #   
+  #   buffer = [
+  #     "var qP=function(cmd){COMM.Queue.push(cmd);};"
+  #   ]
+  #   
+  #   req_num = 0
+  #   
+  #   3.times do |req_num|
+  #     sha_key = Digest::SHA1.hexdigest( ses_key + sha_key )
+  #     msg = @plugins.transporter.xhr(
+  #       request, response, {
+  #         :servlet => true,
+  #         :cookie  => (req_num==0),
+  #         :query   => {
+  #           'ses_key' => "#{req_num}:.o.:#{sha_key}"
+  #         }
+  #       }
+  #     )
+  #     buffer += msg.value_buffer
+  #     msg.buffer.each do |buffer_item|
+  #       buffer.push( "qP(function(){#{buffer_item};});")
+  #     end
+  #     ses_key = msg.ses_key
+  #   end
+  #   
+  #   buffer.unshift( "COMM.Session.newKey(#{ses_key.to_json});" )
+  #   buffer.unshift( "COMM.Session.sha_key=#{sha_key.to_json};" )
+  #   buffer.unshift( "COMM.Session.req_num=#{req_num};" )
+  #   
+  #   index_html = render_index_html
+  #   
+  #   return index_html.gsub('__STARTUP_SEQUENCE__', buffer.join("\n") )
+  # end
+  
+  
+  # Index page renderer
+  def render_index_html
+    
+    index_html = @index_html_src.clone
+    
+    client_rev = client_pkg.client_cache.client_rev
+    deps_src = ''
+    @conf[:deps].each do |dep|
+      deps_src += %{<script src="#{dep}" type="text/javascript"></script>}
+    end
+    client_base = File.join(@bconf[:h],client_rev)
+    
+    index_html.gsub!( '__CLIENT_BASE__',   client_base       )
+    index_html.gsub!( '__DEFAULT_TITLE__', @conf[:title]     )
+    index_html.gsub!( '__CLIENT_REV__',    client_rev        )
+    index_html.gsub!( '__CLIENT_HELLO__',  @bconf[:hello]    )
+    index_html.gsub!( '__NOSCRIPT__',      @conf[:noscript]  )
+    index_html.gsub!( '__SCRIPT_DEPS__',   deps_src          )
+    
+    return index_html
+  end
+  
+  
+  
+  ### Top-level plugin events:
+  
+  
+  # Binds configuration data as instance variables
   def init
     super
+    @plugins.register_alias( :main, :index_html )
+    @randgen = RandGen.new( 40 )
+    ::RSence.config[:index_html][:instance] = self
     @conf  = ::RSence.config[:index_html]
     @bconf = ::RSence.config[:broker_urls]
     @goodbye_uri = File.join(@bconf[:hello],'goodbye')
   end
   
-  # @private Internal structures, matches the "hello/goodbye" session termination request
-  def match( uri, request_type )
-    if request_type == :post and uri == @goodbye_uri
+  # Opens and renders the index page template
+  def open
+    super
+    @index_html_src = file_read( ::RSence.config[:index_html][:index_tmpl] )
+    render_index_html
+  end
+  
+  # Frees the ticket resource id of the "loading" gif image.
+  def close
+    super
+    @plugins[:ticket].del_rsrc( @loading_gif_id )
+  end
+  
+  
+  
+  ### Servlet features; responds to GET / as well as POST /hello/goodbye
+  
+  
+  # @private Internal structures, matches the "hello/goodbye" session termination POST request and the "/" index html page GET request
+  def match( uri, method )
+    if uri == ::RSence.config[:index_html][:respond_address] and method == :get
       return true
+    elsif req_type == :post and uri == @goodbye_uri
+      return true
+    else
+      return false
     end
-    return false
   end
   
-  # @private Internal structures, score for the "hello/goodbye" session termination request
-  def score; 100; end
+  # @private Internal structures, score for the "hello/goodbye" session termination request and the default index html page
+  def score
+    return 1000 # allows overriding with anything with a score below 1000
+  end
+  
+  # Inspects the http request header to decide if the browser supports gzip compressed responses.
+  def support_gzip( header )
+    return false if not ::RSence.config[:no_gzip]
+    return false if not header.has_key?('accept-encoding')
+    return header['accept-encoding'].include?('gzip')
+  end
+  
+  # Outputs the startup web page.
+  def get( req, response, ses )
+    index_html = render_index_html
+    
+    response.status = 200
+    
+    response['Content-Type'] = 'text/html; charset=UTF-8'
+    response['Date'] = httime( Time.now )
+    response['Server'] = 'RSence'
+    response['Cache-Control'] = 'no-cache'
+    
+    if support_gzip( req.header )
+      index_gzip = GZString.new('')
+      gzwriter = Zlib::GzipWriter.new( index_gzip, 9 )
+      gzwriter.write( index_html )
+      gzwriter.close
+      response['Content-Length'] = index_gzip.length
+      response['Content-Encoding'] = 'gzip'
+      response.body = index_gzip
+    else
+      response['Content-Length'] = index_html.length
+      response.body = index_html
+    end
+  end
   
-  # @private Internal structures, handler for the "hello/goodbye" session termination request
+  # Returns the "hello/goodbye" session termination request
   def post( req, res, ses )
     @plugins.sessions.expire_ses_by_req( req, res )
   end
   
-  # @private url_responder gets called whenever the
-  #          page location.href changes, enabled virtual uris
-  #          to enable back/forward/bookmarking in browsers,
-  #          when software is coded to support it.
+  
+  
+  ### Features accessible from other plugins:
+  
+  # The +#url_responder+ gets called whenever the anchor (pound) of location.href changes.
+  # It enables virtual url events for back/forward buttons and bookmarking in browsers whenever utilized.
   #
   # Client-side support is included in js/url_responder.js
   #
-  # Also allows virtual-host -like behavior, if software is coded to support it.
+  # Also allows virtual-host -like behavior if utilized.
   def url_responder(msg,location_href)
     
     ses = get_ses( msg )
@@ -84,13 +212,30 @@ class MainPlugin < Plugin
   end
   
   
-  # @private new session initialization, called just once per session.
+  # Returns base url of browser (before the '#' sign)
+  def url( msg )
+    get_ses( msg )[:url][0]
+  end
+  
+  
+  # Returns pound url of browser (after the '#' sign)
+  def pound( msg )
+    get_ses( msg )[:url][1]
+  end
+  
+  
+  
+  ### Session events:
+  
+  
+  # New session initialization, called just once per session.
   def init_ses(msg)
     super
     restore_ses( msg )
   end
   
-  # @private called once when a session is restored using the cookie's ses_key
+  
+  # Called once when a session is restored or cloned using the cookie's ses_key
   def restore_ses(msg)
     super
     ## Resets session data to defaults
@@ -101,6 +246,7 @@ class MainPlugin < Plugin
     ses[:poll_mode] = true
   end
   
+  
   # Interface for adding delayed calls
   #
   # When adding a delayed call, use an Array to define a plugin/method with optional arguments that will be called on the next request. The client will call back immediately when a delayed call is pending. The first param of the method is a +msg+. Don't include the +msg+ of the current request in params, it will be inserted automatically for the delayed call.
@@ -125,6 +271,7 @@ class MainPlugin < Plugin
     get_ses( msg )[:delayed_calls].push( params )
   end
   
+  
   # @private Initializes the client-side COMM.urlResponder and sesWatcher
   def boot0( msg, ses )
     
@@ -148,18 +295,27 @@ class MainPlugin < Plugin
     
   end
   
+  
   # @private Calls the init_ui method of each loaded plugin and removes the loading -message
   def boot1( msg, ses )
     # Delegates the init_ui method to each plugin to signal bootstrap completion.
     msg.plugins.delegate( 'init_ui', msg ) unless ses[:dont_init_ui]
   end
   
-  # @private
+  
+  # Disables the init_ui event.
   def dont_init_ui( msg )
     get_ses( msg )[:dont_init_ui] = true
   end
   
-  # @private Flushes commands in the :delayed_calls array
+  
+  # Enables the init_ui event.
+  def do_init_ui( msg )
+    get_ses( msg )[:dont_init_ui] = false
+  end
+  
+  
+  # Flushes commands in the :delayed_calls array
   def flush_delayed( msg, ses )
     ## Limits the amount of delayed calls to process to 4.
     ## Prevents the client from choking even when the server
@@ -213,10 +369,10 @@ class MainPlugin < Plugin
     end
   end
   
-  # @private When nothing is delayed and the second poll has been made (init_ui called),
-  #          sets the client to non-polling-mode, having only HValue
-  #          changes trigger new requests. SesWatcher makes this happen
-  #          regularly.
+  # When nothing is delayed and the second poll has been made (init_ui called),
+  # sets the client to non-polling-mode, having only value synchronization trigger
+  # new requests. On the client, SesWatcher forces the change by sending the
+  # client time periodically.
   def end_polling( msg, ses )
     if ses[:poll_mode] == true
       msg.reply "COMM.Transporter.poll(0);"
@@ -224,7 +380,7 @@ class MainPlugin < Plugin
     end
   end
   
-  # @private Starts polling.
+  # Starts polling mode.
   def start_polling( msg, ses )
     if ses[:poll_mode] == false
       msg.reply( "COMM.Transporter.poll(#{::RSence.config[:transporter_conf][:client_poll_priority]});" )
@@ -232,7 +388,7 @@ class MainPlugin < Plugin
     end
   end
   
-  # @private called on every request of an active, valid session
+  # Called on every request of an active, valid session
   def idle(msg)
     
     ses = get_ses( msg )