rsence 2.0.0.10.pre → 2.0.0.11

data/lib/values/valuemanager.rb

@@ -7,6 +7,7 @@
  ##
 
 
+
 # Require needed value types (hvalue supports bool/float/int/string)
 require 'values/hvalue'
 
@@ -15,82 +16,90 @@ require 'randgen'
 
 module RSence
 
-  ## ValueManager provides automagic, transparent syncronization of values between client and server.
+  # @private ValueManager provides automatic, transparent synchronization of values
+  #          between client and server by keeping track of session value ids that
+  #          need to be synchronized to the client and to pass on the incoming data
+  #          for validation.
   class ValueManager
-  
-    attr_accessor :randgen
-  
-    # Initializes the member value handler objects.
-    def initialize
     
-      @config = ::RSence.config[:session_conf]
+    # @private Accessor for the {RandGen} instance used.
+    # @return [RandGen]
+    attr_accessor :randgen
     
+    def initialize
+      # Initializes the member value handler objects.
+      @config = RSence.config[:session_conf]
+      
       ## 'Unique' Random String generator for HValue keys (passed on to the client)
       @randgen = RandGen.new( @config[:key_length] )
-    
+      
     end
-  
-    # Re-constructs all stored values and sends them to the client
-    def resend_session_values( msg )
     
+    # @private Re-constructs all stored values and sends them to the client.
+    #          Used for restoring and cloning session values.
+    def resend_session_values( msg )
+      
       # with disposable keys enabled,
       # sessions restored from cookie_key replace
       # all val_id:s with new ones
       if @config[:disposable_keys]
-      
+        
         # get the session values
         ses_values = msg.session[:values]
-      
+        
         # loop through the value id:s
         old_ids = ses_values[:by_id].keys
         old_ids.each do |old_id|
-        
-          # make a new id
-          new_id = @randgen.gen
-          new_id = @randgen.gen while id_exists?( msg, new_id )
-        
+          
           # get the hvalue
           val_obj = ses_values[:by_id][old_id]
-        
-          # replace the old id in the hvalue itself
-          val_obj.val_id = new_id
-        
-          # re-associate the value with the new id
-          ses_values[:by_id][new_id] = val_obj
-          ses_values[:by_id].delete(old_id)
-        
-          # replace the id in the unvalidated values (:check) array
-          if ses_values[:check].include?(old_id)
-            old_idx = ses_values[:check].index(old_id)
-            ses_values[:check][old_idx] = new_id
-          end
-        
-          # replace the id in the unsynchronized values (:sync) array
-          if ses_values[:sync].include?(old_id)
-            old_idx = ses_values[:sync].index(old_id)
-            ses_values[:sync][old_idx] = new_id
+          
+          # make a new id
+          unless RSence.args[:debug] and val_obj.meta[:name]
+            new_id = @randgen.gen
+            new_id = @randgen.gen while id_exists?( msg, new_id )
+            
+            # replace the old id in the hvalue itself
+            val_obj.val_id = new_id
+            
+            # re-associate the value with the new id
+            ses_values[:by_id][new_id] = val_obj
+            ses_values[:by_id].delete(old_id)
+            
+            # replace the id in the unvalidated values (:check) array
+            if ses_values[:check].include?(old_id)
+              old_idx = ses_values[:check].index(old_id)
+              ses_values[:check][old_idx] = new_id
+            end
+            
+            # replace the id in the unsynchronized values (:sync) array
+            if ses_values[:sync].include?(old_id)
+              old_idx = ses_values[:sync].index(old_id)
+              ses_values[:sync][old_idx] = new_id
+            end
+            
           end
-        
+          
           # tell the hvalue to send its client-side initialization
           val_obj.restore( msg )
         
         end
-    
+      
       ## keeping the id:s between page reloads is faster, but less tamper-proof
       else
         msg.session[:values][:by_id].each_key do |val_id|
           msg.session[:values][:by_id][val_id].restore( msg )
         end
       end
-    
+      
     end
-  
-    # Verifies an 
+    
+    # @private Verifies new_id is unique.
     def id_exists?( msg, new_id )
       return msg.session[:values][:by_id].has_key?(new_id)
     end
   
-    # Parses the json from the client and passes it on to associated values
+    # @private Parses the json from the client and passes it on to associated values
     def xhr( msg, syncdata_str )
     
       # parses the json data sent by the client
@@ -107,7 +116,7 @@ module RSence
       end
     end
   
-    # Sets a value by id
+    # @private Sets a value by id
     def set( msg, val_id, val_data )
     
       # get the session data of this session
@@ -118,7 +127,7 @@ module RSence
       val_obj.set( msg, val_data )
     end
   
-    # Validates the new data of all client-side-modified session-bound values
+    # @private Validates the new data of all client-side-modified session-bound values
     def validate( msg )
     
       # get the session data of this session
@@ -132,7 +141,7 @@ module RSence
     
     end
   
-    # Sends the new data of all server-side-modified session-bound values to the client
+    # @private Sends the new data of all server-side-modified session-bound values to the client
     def sync_client( msg )
     
       # get the session data of this session
@@ -143,7 +152,12 @@ module RSence
       
         # the sync-array will return the value id
         val_id = session_values[:sync].shift
-      
+        
+        unless session_values[:by_id].has_key? val_id
+          warn "ValueManager#sync_client -- Invalid value id: #{val_id.inspect}"
+          next
+        end
+        
         # tell the value of that id to report its state to the client
         session_values[:by_id][val_id].to_client( msg )
       

data/plugins/client_pkg/client_pkg.rb

@@ -6,6 +6,7 @@
  #   with this software package. If not, contact licensing@riassence.com
  ##
 
+
 # the library path of this plugin
 lib_path = File.join( bundle_path, 'lib' )
 
@@ -19,8 +20,8 @@ require File.join( lib_path, 'client_pkg_serve' )
 require File.join( lib_path, 'client_pkg_build' )
 
 
-## The ClientPkg plugin builds and serves the client packages.
-class ClientPkg < Servlet
+# @private The ClientPkgPlugin builds and serves the client packages. It's not intended to be a part of the public API at this time.
+class ClientPkgPlugin < Servlet
   
   include ClientPkgServe
   
@@ -31,7 +32,7 @@ class ClientPkg < Servlet
       @log_file = nil
     end
     def log( str )
-      if ::RSence.args[:verbose]
+      if RSence.args[:verbose]
         puts str
         return
       else
@@ -140,10 +141,10 @@ class ClientPkg < Servlet
     
     @thr = false
     
-    @build_logger = BuildLogger.new( File.join(::RSence.args[:env_path],'log','build_log') )
+    @build_logger = BuildLogger.new( File.join(RSence.args[:env_path],'log','build_log') )
     @build_logger.open
     
-    @client_build = ClientPkgBuild.new( ::RSence.config[:client_pkg], @build_logger )
+    @client_build = ClientPkgBuild.new( RSence.config[:client_pkg], @build_logger )
     @client_cache = ClientPkgCache.new
     
     @build_busy = false

data/plugins/client_pkg/lib/client_pkg_build.rb

@@ -7,13 +7,13 @@
  ##
 
 
+require 'jsmin_c'
+require 'jscompress'
+require 'html_min'
+
+
 class ClientPkgBuild
   
-  require 'jsmin_c'
-  require 'jscompress'
-  require 'html_min'
-  require 'util/gzstring'
-  
   def read_file( path )
     filehandle = open( path, 'rb' )
     filedata   = filehandle.read

data/plugins/client_pkg/lib/client_pkg_serve.rb

@@ -1,3 +1,11 @@
+##   RSence
+ #   Copyright 2007 Riassence Inc.
+ #   http://riassence.com/
+ #
+ #   You should have received a copy of the GNU General Public License along
+ #   with this software package. If not, contact licensing@riassence.com
+ ##
+
 
 module ClientPkgServe
   def broker_urls

data/plugins/index_html/index_html.rb

@@ -6,7 +6,9 @@
  #   with this software package. If not, contact licensing@riassence.com
  ##
 
-# IndexHtmlPlugin is the servlet plugin that is responsible for initializing the "boot-strap page".
+
+
+# @private IndexHtmlPlugin is the servlet plugin that is responsible for initializing the "boot-strap page". It's not intended as a part of the public API at this time.
 class IndexHtmlPlugin < Servlet
   
   def match( uri, method )

data/plugins/index_html/tmpl/index.html

@@ -12,9 +12,8 @@ __SCRIPT_DEPS__
 <script>
 
 /** Runtime configuration: **/
-HCLIENT_REV='__CLIENT_REV__';
-HCLIENT_BASE='__CLIENT_BASE__';
-HCLIENT_HELLO='__CLIENT_HELLO__';
+COMM.ClientPrefix='__CLIENT_BASE__';
+COMM.Transporter.HelloUrl='__CLIENT_HELLO__';
 HThemeManager.themePath='__CLIENT_BASE__/themes';
 
 </script>

data/plugins/main/js/main.js

@@ -0,0 +1,84 @@
+// List of apps initialized utilizing GUITrees, by GUIPlugin name
+RSence.apps = { };
+
+// Subview that utilizes GUITrees
+RSence.GUIView = HControl.extend({
+  
+});
+
+// Application that handles GUITrees, populates its values dynamically
+RSence.GUIApp = HApplication.extend({
+  constructor: function(_options){
+    
+    var
+    _this      = this,
+    
+    // Application priority
+    _priority  = _options.priority?_options.priority:100,
+    
+    // Application label / title
+    _label     = _options.label?_options.label:'Untitled Application',
+    
+    // Application description (multiline)
+    _descr     = _options.descr?_options.descr:'No Description',
+    
+    // Allow multiple instances?
+    _allowMulti = _options.allowMulti?_options.allowMulti:false,
+    
+    // The GUI Tree
+    _valueObj   = _options.valueObj?_options.valueObj:false,
+    
+    // Signal input (from server to client)
+    _sigInput   = _options.sigInput?COMM.Values.values[_options.sigInput]:false,
+    
+    // Signal output (from client to server)
+    _sigOutput  = _options.sigOutput?COMM.Values.values[_options.sigOutput]:false,
+    
+    // Icon image url.
+    // Minimum size is 16x16 and multiple sizes are stacked on top of each other,
+    // largest topmost, smaller versions aligned left below in size order.
+    // Image formats supported are: SVG (except for IE), PNG (all), GIF (all), JPG (all).
+    // Recommended formats are: SVG and PNG24 with transparency / translucency.
+    // Size has to be a factor of two; 16,32,64,128,256,512 are valid dimensions:
+    // 32x32   -> 32x32 single icon
+    // 32x48   -> 32x32 and 16x16
+    // 512x512 -> 512x512 single icon
+    // 512x768 -> 512x512, 256x256
+    // 512x640 -> 512x512, 128x128
+    // 512x896 -> 512x512, 256x256 and 128x128
+    // etc..
+    _iconUrl    = _options.iconUrl?COMM.Values.values[_options.iconUrl]:false;
+    
+    // Construct the application base:
+    _this.base( _priority, _label );
+    
+    // Options combined from vars above
+    _this.options = HClass.extend(_options).extend({
+      label: _label,
+      descr: _descr,
+      allowMulti: _allowMulti,
+      sigInput: _sigInput,
+      sigOutput: _sigOutput,
+      icon: { url: _iconUrl, width: null, height: null },
+      pid: this.appId,
+      views: []
+    }).nu();
+    
+    _this.valueObj = _valueObj;
+    _this.value = _valueObj.value;
+    
+    // _this.app = _this;
+    
+    // 
+    // _this.renderer = COMM.JSONRenderer.extend({
+    //   
+    // }).nu( _this.value, _this );
+  },
+  
+  die: function(){
+    this.base();
+    
+  }
+  
+});
+

data/plugins/main/main.rb

@@ -1,4 +1,3 @@
-#--
 ##   RSence
  #   Copyright 2008 Riassence Inc.
  #   http://riassence.com/
@@ -6,16 +5,27 @@
  #   You should have received a copy of the GNU General Public License along
  #   with this software package. If not, contact licensing@riassence.com
  ##
- #++
 
-class Main < Plugin
+
+# The MainPlugin is accessible as +@plugins.main+ from other plugins.
+#
+# = MainPlugin provides mainly client setup and the following services:
+# * 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.
+#   * Accessible via +msg.session[:main][:client_time]+
+# * Sequential loading. See {#delayed_call #delayed_call}
+# * Provides the +#init_ui+ event for plugins that respond to it.
+class MainPlugin < Plugin
   
+  # @private Internal structures, binds configuration data as instance variables
   def init
     super
     @conf  = ::RSence.config[:index_html]
     @bconf = ::RSence.config[:broker_urls]
   end
   
+  # @private Internal structures, matches the "hello/goodbye" session termination request
   def match( uri, request_type )
     if request_type == :post and
        uri == File.join(@bconf[:hello],'goodbye')
@@ -24,23 +34,24 @@ class Main < Plugin
     return false
   end
   
+  # @private Internal structures, score for the "hello/goodbye" session termination request
   def score; 100; end
   
+  # @private Internal structures, handler for the "hello/goodbye" session termination request
   def post( req, res, ses )
     msg = @plugins.sessions.init_msg( req, res, { :cookies => true } )
     msg.expire_session()
     msg.response_done
   end
   
-  # 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.
+  # @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.
   #
   # 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 software is coded to support it.
   def url_responder(msg,location_href)
     
     ses = get_ses( msg )
@@ -75,15 +86,13 @@ class Main < Plugin
   end
   
   
-  # new session initialization,
-  # called just once per session.
+  # @private new session initialization, called just once per session.
   def init_ses(msg)
     super
     restore_ses( msg )
   end
   
-  # called once when a session is 
-  # restored using the cookie's ses_key
+  # @private called once when a session is restored using the cookie's ses_key
   def restore_ses(msg)
     super
     ## Resets session data to defaults
@@ -95,14 +104,33 @@ class Main < Plugin
   end
   
   # Interface for adding delayed calls
-  def delayed_call( msg, args )
-    get_ses( msg )[:delayed_calls].push( args )
+  #
+  # 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.
+  #
+  # It can also be used for loading sequences to the client, when using a String as the +params+.
+  #
+  # == Format of +params+ for plugin callback:
+  # Array:: [ plugin_name, method_name, *args ]
+  #
+  # == Format of +params+ for javascript sequences:
+  # String:: Javascript to send
+  #
+  # Calls will be flushed per request with the following conditions:
+  # * At most four (4) delayed calls will be processed at a time
+  # * If the calls use more than 200ms combined, even less will be processed at a time
+  #
+  # @param [Message] msg The message instance.
+  # @param [Array, String] params The params of the delayed call.
+  #
+  # @return [nil]
+  def delayed_call( msg, params )
+    get_ses( msg )[:delayed_calls].push( params )
   end
   
-  # Initializes the client-side COMM.urlResponder and sesWatcher
+  # @private Initializes the client-side COMM.urlResponder and sesWatcher
   def boot0( msg, ses )
     
-    msg.reply read_js( 'riassence_ns' )
+    msg.reply read_js( 'main' )
 
     msg.reply("ELEM.setStyle(0,'background-color','#{::RSence.config[:main_plugin][:bg_color]}');")
     
@@ -120,20 +148,20 @@ class Main < Plugin
     poll_interval = ::RSence.config[:main_plugin][:server_poll_interval]
     msg.reply "sesWatcher = COMM.SessionWatcher.nu(#{poll_interval},#{client_time_id});"
     
-    
   end
   
-  # Calls the init_ui method of each loaded plugin and removes the loading -message
+  # @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
   def dont_init_ui( msg )
     get_ses( msg )[:dont_init_ui] = true
   end
   
-  # Flushes commands in the :delayed_calls array
+  # @private 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
@@ -187,10 +215,10 @@ class Main < Plugin
     end
   end
   
-  # 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.
+  # @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.
   def end_polling( msg, ses )
     if ses[:poll_mode] == true
       msg.reply "COMM.Transporter.poll(0);"
@@ -198,7 +226,7 @@ class Main < Plugin
     end
   end
   
-  # Starts polling.
+  # @private Starts polling.
   def start_polling( msg, ses )
     if ses[:poll_mode] == false
       msg.reply( "COMM.Transporter.poll(#{::RSence.config[:transporter_conf][:client_poll_priority]});" )
@@ -206,8 +234,7 @@ class Main < Plugin
     end
   end
   
-  # called on every request of an
-  # active, valid session
+  # @private called on every request of an active, valid session
   def idle(msg)
     
     ses = get_ses( msg )