rsence-pre 2.1.0.1.pre

data/plugins/client_pkg/lib/client_pkg_serve.rb

@@ -0,0 +1,218 @@
+##   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
+    ::RSence.config[:broker_urls]
+  end
+  
+  def match( uri, request_type )
+    uri.match( /^#{broker_urls[:h]}/ )
+  end
+  
+  # Helper method to return the time formatted according to the HTTP RFC
+  def httime(time)
+    return time.gmtime.strftime('%a, %d %b %Y %H:%M:%S %Z')
+  end
+  
+  ## Responds to get-requests
+  def get( request, response, session )
+    
+    # Sets the response date header to the current time:
+    response['Date'] = httime( Time.now )
+    
+    # Controls caching with headers based on the configuration
+    if ::RSence.config[:cache_maximize]
+      response['Expires'] = httime(Time.now+::RSence.config[:cache_expire])
+    
+    else
+      response['Cache-Control'] = 'no-cache'
+    end
+    
+    support_gzip = (request.header.has_key?('accept-encoding') and request.header['accept-encoding'].include?('gzip'))
+    support_gzip = false if ::RSence.config[:no_gzip]
+    if request.header.has_key?('user-agent')
+      ua = request.header['user-agent']
+      is_symbian = ua.include?("SymbianOS")
+      is_safari  = ((not is_symbian) and ua.include?("WebKit"))
+      is_msie = ((not ua.include?("Opera")) and ua.include?("MSIE"))
+      is_msie6 = ((not ua.include?("Opera")) and ua.include?("MSIE 6.0"))
+    end
+    
+    ## Split path into an array for determining what to serve
+    request_uri = '/'+request.path.match( /^#{::RSence.config[:broker_urls][:h]}(.*)$/ )[1]
+    
+    request_path = request_uri.split( '/' )
+    
+    ## Requested type of client resource (js/themes)
+    req_type = request_path[2]
+    
+    if not ['js','themes'].include? req_type
+      req_rev = req_type
+      req_type = request_path[3]
+      request_path.delete_at(2)
+    end
+    
+    ## Special rules for the special browser
+    if request.path.include?('.htc')
+      req_file = request_path[3]
+      
+      # this file is a part of iefix, it injects calls to
+      # the ie rendering engine to override stupid behavior
+      # when changing element properties
+      if request_path.include?('ie_css_element.htc')
+        response.status = 200
+        response['Content-Type'] = 'text/x-component'
+        ## Usually, we don't need it, because the client framework does calls when needed
+        response.body = %{<PUBLIC:COMPONENT lightWeight="true"></PUBLIC:COMPONENT>}
+        
+        ## Enable it to call iefix automatically whenever element properties are changed
+        #response.body = %{<PUBLIC:COMPONENT lightWeight="true">\r\n<script type="text/javascript">\r\ntry{element.attachEvent("onpropertychange",iefix.htcElementEntry);}catch(e){}\r\n</script>\r\n</PUBLIC:COMPONENT>}
+      
+      # this file is a part of iefix, it injects calls to
+      # the ie rendering engine to override stupid behavior
+      # when changing style properties
+      elsif request_path.include?('ie_css_style.htc')
+        response.status = 200
+        response['Content-Type'] = 'text/x-component'
+        
+        ## Usually, we don't need it, because the client framework does calls when needed
+        response.body = %{<PUBLIC:COMPONENT lightWeight="true"></PUBLIC:COMPONENT>}
+        
+        ## Enable it to call iefix automatically whenever element properties are changed
+        #response.body = %{<PUBLIC:COMPONENT lightWeight="true">\r\n<script type="text/javascript">\r\ntry{element.attachEvent("onreadystatechange",iefix.htcStyleEntry);}catch(e){}\r\n</script>\r\n</PUBLIC:COMPONENT>}
+      
+      # Other htc requests are invalid
+      else
+        response.status = 503
+        response.body   = '503 - Invalid Request'
+      end
+      
+    ## Serve compiled client javascript component files:
+    elsif req_type == 'js'
+      
+      
+      # the file-specific identifier ('core', 'basic' etc)
+      req_file = request_path[3][0..-4]
+      
+      if not @client_cache.js_cache.has_key?( req_file )
+        response.status = 404
+        response.body   = '/* 404 - Not Found */'
+      else
+        
+        response.status = 200
+        response.content_type = 'text/javascript; charset=utf-8'
+        
+        # these browsers have issues with gzipped js content
+        support_gzip = false if (is_safari or is_msie or is_symbian)
+        
+        if support_gzip
+          #response['Transfer-Encoding'] = 'chunked,gzip'
+          response['Last-Modified'] = @client_cache.last_modified
+          body = @client_cache.gz_cache[ req_file ]+"\r\n\r\n"
+          response['Content-Length'] = body.length.to_s
+          response['Content-Encoding'] = 'gzip'
+          response.body   = body
+        else
+          
+          response['Last-Modified'] = @client_cache.last_modified
+          body = @client_cache.js_cache[ req_file ]
+          response['Content-Length'] = body.length.to_s
+          response.body = body
+          
+        end
+      end
+    
+    ## Serve client theme files
+    elsif req_type == 'themes'
+      
+      # Get the name of the theme
+      theme_name = request_path[3]
+      
+      # Get the theme resource type (html/css/gfx)
+      theme_part = request_path[4].to_sym
+      
+      # Get the theme resource identifier
+      req_file  = request_path[5]
+      
+      # checks for theme name
+      has_theme = @client_cache.theme_cache.has_key?( theme_name )
+      
+      # checks for theme part (css/html/gfx)
+      has_theme_part = has_theme and @client_cache.theme_cache[theme_name].has_key?( theme_part )
+      
+      
+      # puts "has_theme_part: #{@client_cache.theme_cache[theme_name][theme_part.to_sym].inspect}"
+      # checks for theme file
+      has_theme_file = has_theme_part and @client_cache.theme_cache[theme_name][theme_part].has_key?( req_file )
+      
+      
+      if not has_theme_file and req_file == 'common.css'
+        response.status = 200
+        response.content_type = 'text/css'
+        response.body = ''
+      end
+      
+      if not has_theme
+        response.status = 404
+        response.body   = '404 - Theme Not Found'
+        puts "Theme #{theme_name} not found, avail: #{@client_cache.theme_cache.keys.join(', ')}" if RSence.args[:verbose]
+      elsif not has_theme_part
+        response.status = 503
+        response.body   = '503 - Invalid Theme Part Request'
+      elsif not has_theme_file
+        response.status = 404
+        response.body   = '404 - Theme Resource Not Found'
+        puts "File not found, avail: #{@client_cache.theme_cache[theme_name][theme_part].keys.join(', ')}" if RSence.args[:verbose]
+      else
+        
+        response.status = 200
+        
+        file_ext = req_file.split('.')[-1]
+        response.content_type = {
+          'html' => 'text/html; charset=utf-8',
+          'css'  => 'text/css; charset=utf-8',
+          'png'  => 'image/png',
+          'jpg'  => 'image/jpeg',
+          'gif'  => 'image/gif',
+          'swf'  => 'application/x-shockwave-flash'
+        }[file_ext]
+        
+        support_gzip = false if theme_part == :gfx
+        support_gzip = false if (is_safari or is_msie or is_symbian)
+        
+        if support_gzip
+          response['Last-Modified'] = @client_cache.last_modified
+          body = @client_cache.theme_cache[theme_name][theme_part][ req_file+'.gz' ]
+          response['Content-Length'] = body.length.to_s
+          response['Content-Encoding'] = 'gzip'
+          response.body   = body
+        else
+          
+          # Special IE6 condition to serve gifs instead of png's, because it works much better
+          # than using the ActiveX alpha filter hack
+          if is_msie6 and req_file[-4..-1] == '.png'
+            ie6_req_png2gif = req_file.gsub('.png','-ie6.gif')
+            req_file = ie6_req_png2gif if @client_cache.theme_cache[theme_name][theme_part].include?(ie6_req_png2gif)
+          end
+        
+          response['Last-Modified'] = @client_cache.last_modified
+          body = @client_cache.theme_cache[theme_name][theme_part][ req_file ]
+          response['Content-Length'] = body.length.to_s
+          response.body = body
+          
+        end
+      end
+      
+    end
+    
+  end
+end
+
+

data/plugins/index_html/index_html.rb

@@ -0,0 +1,120 @@
+##   RSence
+ #   Copyright 2009 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
+ ##
+
+
+
+# @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 )
+    if uri == ::RSence.config[:index_html][:respond_address] and method == :get
+      return true
+    else
+      return false
+    end
+  end
+  
+  def score
+    return 1000 # allows overriding with anything with a score below 1000
+  end
+  
+  def init
+    @randgen = RandGen.new( 40 )
+    ::RSence.config[:index_html][:instance] = self
+  end
+  
+  def open
+    @index_html_src = file_read( ::RSence.config[:index_html][:index_tmpl] )
+    render_index_html
+  end
+  
+  def close
+    @plugins[:ticket].del_rsrc( @loading_gif_id )
+  end
+  
+  def render_index_html
+    
+    index_html = @index_html_src.clone
+    
+    index_html.gsub!('__DEFAULT_TITLE__',::RSence.config[:index_html][:title])
+    client_rev = @plugins[:client_pkg].client_cache.client_rev
+    index_html.gsub!('__CLIENT_REV__',client_rev)
+    index_html.gsub!('__CLIENT_BASE__',File.join(::RSence.config[:broker_urls][:h],client_rev))
+    index_html.gsub!('__CLIENT_HELLO__',::RSence.config[:broker_urls][:hello])
+    index_html.gsub!('__NOSCRIPT__',::RSence.config[:index_html][:noscript])
+    
+    deps_src = ''
+    ::RSence.config[:index_html][:deps].each do |dep|
+      deps_src += %{<script src="#{dep}" type="text/javascript"></script>}
+    end
+    index_html.gsub!('__SCRIPT_DEPS__',deps_src)
+    
+    return index_html
+  end
+  
+  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
+  
+  ## Outputs a static web page.
+  def get( request, response, ses )
+    index_html = render_index_html
+    support_gzip = (request.header.has_key?('accept-encoding') and \
+                    request.header['accept-encoding'].include?('gzip')) \
+                    and not ::RSence.config[:no_gzip]
+    
+    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
+      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
+  
+end
+

data/plugins/index_html/info.yaml

@@ -0,0 +1,18 @@
+
+# The human-readable product name of the package
+title: Index HTML Page
+
+# The human-readable version of the package
+version: 2.0.0
+
+# A brief description of the package (rdoc formatting supported)
+description: |
+  This plugin serves the initial html page.
+
+# System version requirement.
+sys_version: '>= 2.0.0'
+
+category: :system
+
+depends_on: :client_pkg
+

data/plugins/index_html/tmpl/index.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html><head>
+<!-- This page is served to you by RSence - http://rsence.org/ -->
+<title>__DEFAULT_TITLE__</title>
+<style type="text/css">body{margin:0;padding:0;background-color:#ddd;font-family:Arial,sans-serif;}</style>
+__SCRIPT_DEPS__
+<script src="__CLIENT_BASE__/js/core.js"></script>
+<!--[if lt IE 7]><script src="__CLIENT_BASE__/js/iefix.js"></script><![endif]-->
+
+<script>
+
+/** Runtime configuration: **/
+RSence.serverConf('__CLIENT_BASE__','__CLIENT_HELLO__');
+
+</script></head><body id="body"><noscript>__NOSCRIPT__</noscript></body></html>

data/plugins/main/info.yaml

@@ -0,0 +1,18 @@
+
+# The human-readable product name of the package
+title: Main Plugin
+
+# The human-readable version of the package
+version: 2.0.0
+
+# A brief description of the package (rdoc formatting supported)
+description: |
+  The main plugin manages the flow of communication between client and server.
+
+# System version requirement.
+sys_version: '>= 2.0.0'
+
+category: :system
+
+depends_on: :index_html
+

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();
+    
+  }
+  
+});
+