rsence 2.0.0.6.pre → 2.0.0.7.pre

data/lib/plugins/plugins.rb

@@ -23,8 +23,9 @@ require 'plugins/plugin_plugins'
 module ::RSence
   module Plugins
     
-    # plugin.rb contains the Plugin skeleton class
     require 'plugins/plugin'
+    
+    # The PluginMaker mimic class creates the Plugin class from PluginTemplate
     def self.PluginMaker
       lambda do |ns|
         klass = Class.new( PluginTemplate ) do
@@ -39,9 +40,9 @@ module ::RSence
       end
     end
     
-    # gui_plugin.rb is an extension of Plugin that uses
-    # GUIParser to init the gui automatically.
     require 'plugins/gui_plugin'
+    
+    # The GUIPluginMaker mimic class creates the GUIPlugin class from GUIPluginTemplate
     def self.GUIPluginMaker
       lambda do |ns|
         klass = Class.new( GUIPluginTemplate ) do
@@ -56,8 +57,9 @@ module ::RSence
       end
     end
     
-    # servlet includes the Servlet class, for handling any requests / responses
     require 'plugins/servlet'
+    
+    # The ServletMaker mimic class creates the Servlet class from ServletTemplate
     def self.ServletMaker
       lambda do |ns|
         klass = Class.new( ServletTemplate ) do
@@ -72,6 +74,11 @@ module ::RSence
       end
     end
     
+    # Loads bundle according to the +params+ hash.
+    # Some essential params:
+    #  :src_path    => '/path/of/the_plugin/the_plugin.rb'
+    #  :bundle_path => '/path/of/the_plugin'
+    #  :bundle_name => :the_plugin
     def self.bundle_loader( params )
       src_path = params[:src_path]
       begin

data/lib/plugins/servlet.rb

@@ -6,15 +6,16 @@
  #   with this software package. If not, contact licensing@riassence.com
  ##
 
-## Register the Servlet with a regular expression that
-## should match its uri. Alternatively just a string, but
-## that needs to be an exact match.
 module ::RSence
   module Plugins
+    
+    ## Use the Servlet class to create responders for urls and methods.
     class ServletTemplate
+      
       include PluginUtil
+      
       def self.bundle_type; :Servlet; end
-      # Initializes and registers the ServletPlugin.
+      
       def initialize( bundle_name, bundle_info, bundle_path, plugin_manager )
         @info    = bundle_info
         @name    = bundle_name
@@ -24,8 +25,8 @@ module ::RSence
         @inited = false
       end
 
-      # Servlet ID
       attr_reader :name, :path, :info, :inited
+      
       def register # :nodoc
         @plugins.register_bundle( self, @name )
         @inited = true
@@ -44,15 +45,15 @@ module ::RSence
       def score
         return 100
       end
-
+      
       # Extend to do any GET request processing. Not doing anything by default.
       def get( req, res, ses )
-
+        
       end
-
+      
       # Extend to do any POST request processing. Not doing anything by default.
       def post( req, res, ses )
-
+        
       end
     end
   end

data/lib/session/msg.rb

@@ -7,285 +7,286 @@
  ##
 
 module RSence
-require 'util/gzstring'
+  require 'util/gzstring'
 
-## Due to the single instance architecture of +Plugin+, instances of Message 
-## class are used for communication between sessions and +Plugin+ instance. 
-## The +Message+ instance contains session and request-response related 
-## mappings and utility methods. 
-##
-## The Message object is initialized as 'msg' in SessionManager.
-## It's passed around the system as the user/session -object namespace,
-## much like 'self' is passed around in python methods.
-## 
-## Using the msg object saves considerate amounts of CPU cycles and memory,
-## because it allows single instances of any classes that handle user data.
-## 
-## == HValue Initialization Example
-## +HValue+ is closely related to +Message+ as instances of +HValue+ are
-## used to send data between sessions and the server. This is a small
-## code snippet about how to initialize several HValues as the session
-## is initialized. 
-## 
-## def init_ses( msg )
-##   msg.session[:session_name] = {    
-##     :hvalue1     => HValue.new( msg, @firstvalue ),
-##     :hvalue2     => HValue.new( msg, @secondvalue ),
-##     :hvalue3     => HValue.new( msg, @thirdvalue )
-##   }
-## end
-## 
-
-class Message
-  
-  # Session data placeholder, assigned by SessionManager.
-  attr_accessor :session 
-  
-  # New session flag, check it in your code to decide
-  # what to do, when a new session is encountered.
-  # In plugins, this usually means that some Values
-  # need to be created and bound or possibly that a
-  # user_id mapping needs to be done.
-  attr_accessor :new_session
-  
-  # Old session first xhr flag, check it in your code
-  # to decide what to do, when a restored session is
-  # encountered. The old Values are automatically present,
-  # so you should at least not re-create or re-bind them.
-  attr_accessor :restored_session
-  
-  # Contains the source ses on the first request after this
-  # session was cloned from another session.
-  attr_accessor :cloned_source 
-  
-  # Contains the target sessions packed in an array on
-  # the first request after another session was cloned
-  # from this session.
-  attr_accessor :cloned_targets
-  
-  # The session is not valid by default, it's set
-  # by SessionManager, if everything seems ok.
-  attr_accessor :ses_valid 
-  
-  # The http request object.
-  attr_accessor :request 
-  
-  # The http response object.
-  attr_accessor :response
-  
-  # Response output.
-  attr_accessor :buffer
-  
-  attr_accessor :value_buffer
-  
-  # The request success flag.
-  attr_accessor :response_success
-  
-  # Reference to Transporter
-  attr_accessor :transporter
-  
-  # Reference to ValueManager
-  attr_accessor :valuemanager
-  
-  # Reference to SessionManager
-  attr_accessor :sessions
-  
-  # Reference to PluginManager
-  attr_accessor :plugins
-  
-  # Message is initialized with a valid +Request+ and +Response+ objects. 
-  def initialize( transporter, request, response, options )
+  ## Due to the single instance architecture of +Plugin+, instances of Message 
+  ## class are used for communication between sessions and +Plugin+ instance. 
+  ## The +Message+ instance contains session and request-response related 
+  ## mappings and utility methods. 
+  ##
+  ## The Message object is initialized as 'msg' in SessionManager.
+  ## It's passed around the system as the user/session -object namespace,
+  ## much like 'self' is passed around in python methods.
+  ## 
+  ## Using the msg object saves considerate amounts of CPU cycles and memory,
+  ## because it allows single instances of any classes that handle user data.
+  ## 
+  ## == HValue Initialization Example
+  ## +HValue+ is closely related to +Message+ as instances of +HValue+ are
+  ## used to send data between sessions and the server. This is a small
+  ## code snippet about how to initialize several HValues as the session
+  ## is initialized. 
+  ## 
+  ## def init_ses( msg )
+  ##   msg.session[:session_name] = {    
+  ##     :hvalue1     => HValue.new( msg, @firstvalue ),
+  ##     :hvalue2     => HValue.new( msg, @secondvalue ),
+  ##     :hvalue3     => HValue.new( msg, @thirdvalue )
+  ##   }
+  ## end
+  ## 
+  class Message
     
-    @config = ::RSence.config
+    # Session data placeholder, assigned by SessionManager.
+    attr_accessor :session 
     
-    @request  = request
-    @response_success = false
-    @response = response
-    @session  = nil
-    @buffer = []
+    # New session flag, check it in your code to decide
+    # what to do, when a new session is encountered.
+    # In plugins, this usually means that some Values
+    # need to be created and bound or possibly that a
+    # user_id mapping needs to be done.
+    attr_accessor :new_session
     
-    @options = options
+    # Old session first xhr flag, check it in your code
+    # to decide what to do, when a restored session is
+    # encountered. The old Values are automatically present,
+    # so you should at least not re-create or re-bind them.
+    attr_accessor :restored_session
     
-    # Value response output.
-    @value_buffer = []
+    # Contains the source ses on the first request after this
+    # session was cloned from another session.
+    attr_accessor :cloned_source 
     
-    # The session key placeholder.
-    @ses_key = false
-    @new_session      = false
-    @restored_session = false
-    @cloned_source = false
-    @cloned_targets = false
-    @ses_valid = false
-    @error_js = ''
+    # Contains the target sessions packed in an array on
+    # the first request after another session was cloned
+    # from this session.
+    attr_accessor :cloned_targets
     
-    # global instances
-    @transporter    = transporter
-    @valuemanager   = @transporter.valuemanager
-    @sessions = @transporter.sessions
-    @plugins  = @transporter.plugins
+    # The session is not valid by default, it's set
+    # by SessionManager, if everything seems ok.
+    attr_accessor :ses_valid 
     
-    if options[:servlet]
-      @do_gzip = false
-    else
-      @response.content_type = 'text/javascript; charset=utf-8'
-      @response['cache-control'] = 'no-cache'
-      
-      # gnu-zipped responses:
-      if @request.header['accept-encoding'] and @request.header['accept-encoding'].include?('gzip') and not @config[:no_gzip]
-        @response['content-encoding'] = 'gzip'
-        @do_gzip = true
-      else
+    # The http request object.
+    attr_accessor :request 
+    
+    # The http response object.
+    attr_accessor :response
+    
+    # Response output.
+    attr_accessor :buffer
+    
+    attr_accessor :value_buffer
+    
+    # The request success flag.
+    attr_accessor :response_success
+    
+    # Reference to Transporter
+    attr_accessor :transporter
+    
+    # Reference to ValueManager
+    attr_accessor :valuemanager
+    
+    # Reference to SessionManager
+    attr_accessor :sessions
+    
+    # Reference to PluginManager
+    attr_accessor :plugins
+    
+    # Message is initialized with a valid +Request+ and +Response+ objects. 
+    def initialize( transporter, request, response, options )
+    
+      @config = ::RSence.config
+    
+      @request  = request
+      @response_success = false
+      @response = response
+      @session  = nil
+      @buffer = []
+    
+      @options = options
+    
+      # Value response output.
+      @value_buffer = []
+    
+      # The session key placeholder.
+      @ses_key = false
+      @new_session      = false
+      @restored_session = false
+      @cloned_source = false
+      @cloned_targets = false
+      @ses_valid = false
+      @error_js = ''
+    
+      # global instances
+      @transporter    = transporter
+      @valuemanager   = @transporter.valuemanager
+      @sessions = @transporter.sessions
+      @plugins  = @transporter.plugins
+    
+      if options[:servlet]
         @do_gzip = false
+      else
+        @response.content_type = 'text/javascript; charset=utf-8'
+        @response['cache-control'] = 'no-cache'
+      
+        # gnu-zipped responses:
+        if @request.header['accept-encoding'] and @request.header['accept-encoding'].include?('gzip') and not @config[:no_gzip]
+          @response['content-encoding'] = 'gzip'
+          @do_gzip = true
+        else
+          @do_gzip = false
+        end
       end
-    end
     
-    @response_sent = false
-  end
-  
-  # Returns true for Internet Explorer 6.0
-  def ie6;
-    (request.header.has_key?('user-agent') and request.header['user-agent'].include?('MSIE 6.0'))
-  end
-  
-  # Expire the session.
-  def expire_session
-    @sessions.expire_session( @ses_id )
-  end
-  
-  # Define the session key.
-  def ses_key=(ses_key)
-    @ses_key = ses_key
-  end
-  
-  # Getter for session key.
-  def ses_key
-    @ses_key
-  end
+      @response_sent = false
+    end
   
-  # Returns the user id
-  def user_id
-    @session[:user_id]
-  end
+    # Returns true for Internet Explorer 6.0
+    def ie6;
+      (request.header.has_key?('user-agent') and request.header['user-agent'].include?('MSIE 6.0'))
+    end
   
-  # Setter for the user id
-  def user_id=(user_id)
-    @session[:user_id] = user_id
-  end
+    # Expire the session.
+    def expire_session
+      @sessions.expire_session( @ses_id )
+    end
   
-  def ses_id
-    @session[:ses_id]
-  end
+    # Define the session key.
+    def ses_key=(ses_key)
+      @ses_key = ses_key
+    end
   
-  def ses_id=(ses_id)
-    @session[:ses_id] = ses_id
-  end
+    # Getter for session key.
+    def ses_key
+      @ses_key
+    end
   
-  def error_msg( error_js )
-    @error_js = error_js
-    # response_done
-  end
+    # Returns the user id
+    def user_id
+      @session[:user_id]
+    end
   
-  def buf_json(buffer)
-    buffer.to_json
-  end
+    # Setter for the user id
+    def user_id=(user_id)
+      @session[:user_id] = user_id
+    end
+    
+    # Returns the session id
+    def ses_id
+      @session[:ses_id]
+    end
+    
+    # Sets the session id
+    def ses_id=(ses_id)
+      @session[:ses_id] = ses_id
+    end
+    
+    # Sets the error message
+    def error_msg( error_js )
+      @error_js = error_js
+      # response_done
+    end
+    
+    # Converts the buffer to JSON
+    def buf_json(buffer)
+      buffer.to_json
+    end
   
-  # Called to flush buffer.
-  def response_done
-    return if @response_sent
-    if not @response_success
-      @response.status = 200
-      #@response.status = 503
+    # Called to flush buffer.
+    def response_done
+      return if @response_sent
+      if not @response_success
+        @response.status = 200
+        #@response.status = 503
+      
+        buffer = [
+          "" # empty session key will stop the syncing
+        ] + @error_js
+      else
+        ## The response status should always be 200 (OK)
+        @response.status = 200
       
-      buffer = [
-        "" # empty session key will stop the syncing
-      ] + @error_js
-    else
-      ## The response status should always be 200 (OK)
-      @response.status = 200
+        buffer = @value_buffer + @buffer
+        if @ses_key
+          buffer.unshift( @ses_key )
+        end
       
-      buffer = @value_buffer + @buffer
-      if @ses_key
-        buffer.unshift( @ses_key )
       end
-      
-    end
     
-    # flush the output
-    if @do_gzip
-      outp = GZString.new('')
-      gzwriter = Zlib::GzipWriter.new(outp,Zlib::BEST_SPEED)
-      gzwriter.write( buf_json(buffer) )
-      gzwriter.close
-    else
-      outp = buf_json(buffer)
-    end
+      # flush the output
+      if @do_gzip
+        outp = GZString.new('')
+        gzwriter = Zlib::GzipWriter.new(outp,Zlib::BEST_SPEED)
+        gzwriter.write( buf_json(buffer) )
+        gzwriter.close
+      else
+        outp = buf_json(buffer)
+      end
     
-    @response['content-length'] = outp.size
-    @response.body = outp
+      @response['content-length'] = outp.size
+      @response.body = outp
     
-    @response_sent = true
-  end
+      @response_sent = true
+    end
   
-  # Sends data to the client, usually
-  # javascript, but is valid for any data.
-  def reply(data,dont_squeeze=false)
-    data.strip!
-    data = @plugins[:client_pkg].squeeze( data ) unless dont_squeeze
-    puts data if @config[:trace]
-    @buffer.push( data )
-  end
+    # Sends data to the client, usually
+    # javascript, but is valid for any data.
+    def reply(data,dont_squeeze=false)
+      data.strip!
+      data = @plugins[:client_pkg].squeeze( data ) unless dont_squeeze
+      puts data if @config[:trace]
+      @buffer.push( data )
+    end
   
-  # For value manager; insert changed values BEFORE other js.
-  def reply_value(data)
-    puts data if @config[:trace]
-    @value_buffer.push( data )
-  end
+    # For value manager; insert changed values BEFORE other js.
+    def reply_value(data)
+      puts data if @config[:trace]
+      @value_buffer.push( data )
+    end
   
-  # Sends data to the client's console.
-  def console(data)
-    reply( "console.log(#{data.to_json});" )
-  end
+    # Sends data to the client's console.
+    def console(data)
+      reply( "console.log(#{data.to_json});" )
+    end
   
-  # Serves an image object +img_obj+ by returning its disposable URL. The 
-  # second optional parameter +img_format+ defaults to 'PNG' and defines 
-  # the format of served picture.
-  def serve_img( img_obj, img_format='PNG' )
-    call(:ticket,:serve_img, self, img_obj, img_format )
-  end
+    # Serves an image object +img_obj+ by returning its disposable URL. The 
+    # second optional parameter +img_format+ defaults to 'PNG' and defines 
+    # the format of served picture.
+    def serve_img( img_obj, img_format='PNG' )
+      call(:ticket,:serve_img, self, img_obj, img_format )
+    end
   
-  # Sends any binary to be served, returns a disposable uri. First parameter
-  # defines the file data, second optional defines content type and defaults
-  # to 'text/plain' and third, also optional defines the filename which 
-  # defaults to 'untitled.txt'.
-  def serve_file( file_data, content_type='text/plain', filename='untitled.txt' )
-    call(:ticket,:serve_file, self, file_data, content_type, filename )
-  end
+    # Sends any binary to be served, returns a disposable uri. First parameter
+    # defines the file data, second optional defines content type and defaults
+    # to 'text/plain' and third, also optional defines the filename which 
+    # defaults to 'untitled.txt'.
+    def serve_file( file_data, content_type='text/plain', filename='untitled.txt' )
+      call(:ticket,:serve_file, self, file_data, content_type, filename )
+    end
   
-  # Sends any binary to be served, returns a static uri.
-  #
-  # IMPORTANT: PLEASE call +release_rsrc+ manually, when you
-  # don't need the resource anymore! Otherwise TicketServe will
-  # keep on chugging more memory every time you serve something.
-  #
-  # HINT: Usually, it's a better idea to use serve_img or
-  # serve_file instead.
-  def serve_rsrc( rsrc_data, content_type='text/plain' )
-    call(:ticket,:serve_rsrc,self, rsrc_data, content_type )
-  end
+    # Sends any binary to be served, returns a static uri.
+    #
+    # IMPORTANT: PLEASE call +release_rsrc+ manually, when you
+    # don't need the resource anymore! Otherwise TicketServe will
+    # keep on chugging more memory every time you serve something.
+    #
+    # HINT: Usually, it's a better idea to use serve_img or
+    # serve_file instead.
+    def serve_rsrc( rsrc_data, content_type='text/plain' )
+      call(:ticket,:serve_rsrc,self, rsrc_data, content_type )
+    end
   
-  # Removes the uri served, you HAVE TO call this manually when
-  # you are done serving something! Takes the uri as its only parameter.
-  def release_rsrc( uri )
-    run(:ticket,:del_rsrc, uri[3..-1] )
-  end
-  alias unserve_rsrc release_rsrc
+    # Removes the uri served, you HAVE TO call this manually when
+    # you are done serving something! Takes the uri as its only parameter.
+    def release_rsrc( uri )
+      run(:ticket,:del_rsrc, uri[3..-1] )
+    end
+    alias unserve_rsrc release_rsrc
   
-  # Calls registered plugin +plugin+ method +plugin_method+ with any +args+
-  def call( plugin_name, plug_method, *args )
-    @plugins.call( plugin_name, plug_method, *args)
+    # Calls registered plugin +plugin+ method +plugin_method+ with any +args+
+    def call( plugin_name, plug_method, *args )
+      @plugins.call( plugin_name, plug_method, *args)
+    end
+    alias run call
   end
-  alias run call
-  
-end
-
 end