rsence-pre 2.2.0.28 → 2.2.0.29

data/VERSION

@@ -1 +1 @@
-2.2.0.28.pre
+2.2.0.29.pre

data/conf/default_conf.yaml

@@ -54,6 +54,14 @@
     # network interfaces or the interfaces become available after
     # RSence is started.
     :http_delayed_start: 0
+    #
+    # Save plugin and session state every n seconds.
+    # Set to 0 or negative to disable.
+    :autosave_interval: 180 # once every 3 minutes
+    #
+    # Daemon helper files, leave empty for defaults.
+    #:pid_fn: /var/run/rsence.pid
+    #:log_fn: /var/log/rsence.log
   #
   # Switches on debug-mode:
   #  - Generates more output
@@ -180,12 +188,6 @@
     # Disposable keys, when enabled, changes the value id on each session restoration
     :disposable_keys:   true
   #
-  # Daemon helper files, leave empty for defaults.
-  :daemon: {
-    #:pid_fn: /var/run/rsence.pid
-    #:log_fn: /var/log/rsence.log
-  }
-  #
   # Entered by code, empty container
   :broker_urls: { }
 

data/conf/rsence_command_strings.yaml

@@ -63,14 +63,16 @@
     No PID file, unable to check process status.
   :no_pid_support: |
     No PID support, unable to check process status.
+  :something_responds:
+    Something responds on <%%= addr_descr %>
   :no_process_running_but_something_responds: |
-    No process running, but something responds on <%%= addr %>:<%%= port %>.
+    No process running, but something responds on <%%= addr_descr %>.
   :no_process_running_and_nothing_responds: |
-    No process running, and nothing responds on <%%= addr %>:<%%= port %>.
+    No process running, and nothing responds on <%%= addr_descr %>.
   :process_running_and_responds: |
-    Process ID <%%= pid %> is running and responds on <%%= addr %>:<%%= port %>.
+    Process ID <%%= pid %> is running and responds on <%%= addr_descr %>.
   :process_running_but_nothing_responds: |
-    Process ID <%%= pid %> is running, but does not respond on <%%= addr %>:<%%= port %>.
+    Process ID <%%= pid %> is running, but does not respond on <%%= addr_descr %>.
   :saving_message: <
     Saving session data...
   :no_pid_unable_to_save: |
@@ -214,7 +216,7 @@
 # Help for the ”rsence” command line tool.
 :help:
   :head: |+
-    RSence command-line tool, version <%= @@version %>
+    RSence command-line tool, version <%= @version %>
   
   :tail: |+
     RSence is a self-contained web app framework.
@@ -258,7 +260,7 @@
   
       --port <number>         The port number the http server listens to.
   
-      --addr <ip address>     The IP address or net mask the http server listens to.
+      --bind <ip address>     The IP address or net mask the http server listens to.
                               ”0.0.0.0” matches all interfaces.
                               ”127.0.0.1” matches the local loopback interface.
   

data/lib/rsence.rb

@@ -86,7 +86,7 @@ module RSence
   def self.startup
     puts "Loading configuration..." if self.args[:verbose]
     # Use the default configuration:
-    require 'conf/default'
+    require 'rsence/default_config'
     @@config = Configuration.new(self.args).config
     
     # RSence runtime configuration data
@@ -144,7 +144,7 @@ module RSence
     end
     
     ## Riassence Daemon controls
-    require 'daemon/daemon'
+    require 'rsence/daemon'
     puts "Starting RSence..." if self.args[:verbose]
     daemon = HTTPDaemon.new
     daemon.daemonize!
@@ -153,11 +153,11 @@ module RSence
   
   # Includes the Signal Communication utility.
   # Used to respond via special PID files in the run directory of the environment
-  require 'daemon/sigcomm'
+  require 'rsence/sigcomm'
 
 
   # Requires the ARGVParser that functions as the command-line user interface.
-  require 'conf/argv'
+  require 'rsence/argv'
   
 end
 

data/lib/rsence/argv.rb

@@ -0,0 +1,218 @@
+##   RSence
+ #   Copyright 2010 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 RSence
+
+  require 'erb'
+  require 'yaml'
+
+  # @private  ARGVParser is the "user interface" as a command-line argument parser.
+  #           It parses the command-line arguments and sets up things accordingly.
+  class ARGVParser
+
+    # Returns true if one of the 'start' -type commands were supplied
+    # and the environment seems valid.
+    def startable?; @startable; end
+    
+    # Parses an argument of the 'help' command
+    def parse_help_argv
+      if @argv.length >= 2
+        help_cmd = @argv[1].to_sym
+      else
+        help_cmd = :help_main
+      end
+      help( help_cmd )
+      exit
+    end
+    
+    # Creates the default and initial @args hash.
+    def init_args
+      @args = {
+        :env_path       => Dir.pwd,
+        :conf_files     => [ ], # --conf
+        :debug          => false, # -d --debug
+        :verbose        => false, # -v --verbose
+        :log_fg         => false, # -f --log-fg
+        :trace_js       => false, # --trace-js
+        :trace_delegate => false, # --trace-delegate
+        :port           => nil,   # --port
+        :addr           => nil,   # --addr --bind
+        :server         => nil,   # --server
+        :reset_ses      => false, # -r --reset-sessions
+        :autoupdate     => false, # -a --auto-update
+        :latency        => 0,     # --latency
+        :say            => false, # -S --say
+        :http_delayed_start => nil, # --http-delayed-start
+      
+        # client_pkg (not supported yet)
+        :client_pkg_no_gzip               => false, # --disable-gzip
+        :client_pkg_no_obfuscation        => false, # --disable-obfuscation
+        :client_pkg_no_whitespace_removal => false, # --disable-jsmin
+        :suppress_build_messages          => true,  # --build-report
+      
+      }
+    end
+    
+    # Sets various debug-related options on.
+    def set_debug
+      @args[:debug]      = true
+      @args[:verbose]    = true
+      @args[:autoupdate] = true
+      @args[:client_pkg_no_obfuscation] = true
+      @args[:client_pkg_no_whitespace_removal] = true
+      @args[:suppress_build_messages] = false
+    end
+    
+    # Set the verbose argument on
+    def set_verbose
+      @args[:verbose]    = true
+    end
+    
+    # Set the foreground logging argument on
+    def set_log_fg
+      @args[:log_fg]     = true
+    end
+    
+    # Sets the session reset argument on
+    def set_reset_ses
+      @args[:reset_ses]  = true
+    end
+    
+    # Sets the auto-update argument on
+    def set_autoupdate
+      @args[:autoupdate] = true
+    end
+    
+    # Sets the speech synthesis argument on
+    def set_say
+      @args[:say] = true
+    end
+    
+    # Error message when an invalid environment is encountered, exits.
+    def invalid_env( env_path=false )
+      env_path = @args[:env_path] unless env_path
+      puts ERB.new( @strs[:messages][:invalid_environment] ).result( binding )
+      exit
+    end
+    
+    # Error message when an invalid option is encountered, exits.
+    def invalid_option(arg,chr=false)
+      if chr
+        puts ERB.new( @strs[:messages][:invalid_option_chr] ).result( binding )
+      else
+        puts ERB.new( @strs[:messages][:invalid_option] ).result( binding )
+      end
+      exit
+    end
+    
+    require 'rsence/argv/startup_argv'
+    require 'rsence/argv/status_argv'
+    require 'rsence/argv/save_argv'
+    require 'rsence/argv/initenv_argv'
+    require 'rsence/argv/help_argv'
+    require 'rsence/argv/env_check'
+    require 'rsence/argv/test_port'
+    include ArgvUtil
+    
+    # Returns the version of RSence
+    def version; @version; end
+    
+    # Returns the command the process was started with.
+    def cmd; @cmd; end
+    
+    # Returns the parsed optional arguments
+    def args; @args; end
+    
+    # Top-level argument parser, checks for command and calls sub-parser, if valid command.
+    def parse_argv
+      if @argv.empty?
+        puts @strs[:help][:help_help]
+        exit
+      else
+        cmd = @argv[0].to_sym
+        cmd = :help if [:h, :'-h', :'--help', :'-help'].include? cmd
+      end
+      if @cmds.include?(cmd)
+        @cmd = cmd
+        unless [:help, :version].include?( cmd )
+          puts "RSence #{@version} -- Ruby #{RUBY_VERSION}"
+        end
+        if cmd == :help
+          parse_help_argv
+        elsif cmd == :version
+          puts version
+          exit
+        elsif [:run,:start,:stop,:restart].include? cmd
+          parse_startup_argv
+        elsif cmd == :status
+          parse_status_argv
+        elsif cmd == :save
+          parse_save_argv
+        elsif cmd == :initenv or cmd == :init
+          parse_initenv_argv
+        end
+      else
+        puts @strs[:help][:unknown] + cmd.to_s.inspect
+        puts @strs[:help][:help_help]
+        exit
+      end
+    end
+    
+    # The constructor sets the @startable flag as false. Use the #parse method with ARGV as the argument to start parsing the ARGV.
+    def initialize
+      @startable = false
+
+      # The RSence version string, read from the VERSION file in
+      # the root directory of RSence.
+      @version = File.read( File.join( SERVER_PATH, 'VERSION' ) ).strip
+      
+      # Makes various commands available depending on the platform.
+      # The status/start/stop/restart/save -commands depend on an operating
+      # system that fully implements POSIX standard signals.
+      # These are necessary to send signals to the background process.
+      if not RSence.pid_support?
+        @cmds = [ :run, :init, :initenv, :version, :help ]
+      else
+        @cmds = [ :run, :status, :start, :stop, :restart, :save,
+                  :init, :initenv, :version, :help ]
+      end
+      
+      help_avail_cmds = @cmds.map{|cmd|cmd.to_s}.join("\n       ")
+      
+      # Load the strings from the strings file.
+      strs_path = File.join( SERVER_PATH, 'conf', 
+                             'rsence_command_strings.yaml' )
+      strs_data = File.read( strs_path )
+      
+      strs_data = ERB.new( strs_data ).result( binding )
+      
+      @strs = YAML.load( strs_data )
+      
+      @strs[:help][:run] += @strs[:help][:path]+@strs[:help][:options]
+      @strs[:help][:start] += @strs[:help][:path]+@strs[:help][:options]
+      @strs[:help][:stop] += @strs[:help][:path]+@strs[:help][:options]
+      @strs[:help][:restart] += @strs[:help][:path]+@strs[:help][:options]
+      @strs[:help][:status] += @strs[:help][:path]
+      @strs[:help][:save] += @strs[:help][:path]
+    end
+
+    # Entry point for ARGV parsing
+    def parse( argv )
+      @argv = argv
+      parse_argv
+    end
+  
+  end
+  
+  # @private  The ARGVParser instance and its startup
+  @@argv_parser = ARGVParser.new
+  @@argv_parser.parse( ARGV )
+
+end
+

data/lib/rsence/argv/argv_util.rb

@@ -0,0 +1,58 @@
+module RSence
+module ArgvUtil
+  
+  # Tests for a valid environment
+  def valid_env?( arg, quiet=false )
+    
+    # Checks, if the top-level path exists and is a directory
+    path = File.expand_path( arg )
+    if not File.exists?( path )
+      puts ERB.new( @strs[:messages][:no_such_directory] ).result( binding ) unless quiet
+      return false
+    elsif not File.directory?( path )
+      puts ERB.new( @strs[:messages][:not_a_directory] ).result( binding ) unless quiet
+      return false
+    end
+    
+    # Checks, if the conf path exists and is a directory
+    conf_path = File.join( path, 'conf' )
+    if not File.exists?( conf_path )
+      puts ERB.new( @strs[:messages][:missing_conf_directory] ).result( binding ) unless quiet
+      return false
+    elsif not File.directory?( conf_path )
+      puts ERB.new( @strs[:messages][:invalid_conf_directory] ).result( binding ) unless quiet
+      return false
+    end
+    
+    # Checks, if the conf/config.yaml file exists and is a directory
+    conf_file = File.join( path, 'conf', 'config.yaml' )
+    if not File.exists?(conf_file)
+      puts ERB.new( @strs[:messages][:missing_conf_file] ).result( binding ) unless quiet
+      return false
+    elsif not File.file?( conf_file )
+      puts ERB.new( @strs[:messages][:invalid_conf_file_not_file] ).result( binding ) unless quiet
+      return false
+    end
+    
+    # Checks, if the plugins path exists and is a directory
+    plugin_path = File.join( path, 'plugins' )
+    if not File.exists?( plugin_path )
+      warn ERB.new( @strs[:messages][:warn_no_plugin_directory_in_project] ).result( binding ) if @args[:verbose]
+    elsif not File.directory?( plugin_path )
+      puts ERB.new( @strs[:messages][:plugin_directory_not_a_directory] ).result( binding ) unless quiet
+      return false
+    end
+    
+    # Checks (and automatically creates if missing) the run, db and log directories
+    ['run','log','db'].each do |dir_name|
+      dir_path = File.join( path, dir_name )
+      unless File.exists?( dir_path )
+        warn ERB.new( @strs[:messages][:warn_no_directory_creating] ).result( binding ) if @args[:verbose]
+        Dir.mkdir( dir_path )
+      end
+    end
+    return true
+  end
+
+end
+end

data/lib/rsence/argv/env_check.rb

@@ -0,0 +1,58 @@
+module RSence
+module ArgvUtil
+  
+  # Tests for a valid environment
+  def valid_env?( arg, quiet=false )
+    
+    # Checks, if the top-level path exists and is a directory
+    path = File.expand_path( arg )
+    if not File.exists?( path )
+      puts ERB.new( @strs[:messages][:no_such_directory] ).result( binding ) unless quiet
+      return false
+    elsif not File.directory?( path )
+      puts ERB.new( @strs[:messages][:not_a_directory] ).result( binding ) unless quiet
+      return false
+    end
+    
+    # Checks, if the conf path exists and is a directory
+    conf_path = File.join( path, 'conf' )
+    if not File.exists?( conf_path )
+      puts ERB.new( @strs[:messages][:missing_conf_directory] ).result( binding ) unless quiet
+      return false
+    elsif not File.directory?( conf_path )
+      puts ERB.new( @strs[:messages][:invalid_conf_directory] ).result( binding ) unless quiet
+      return false
+    end
+    
+    # Checks, if the conf/config.yaml file exists and is a directory
+    conf_file = File.join( path, 'conf', 'config.yaml' )
+    if not File.exists?(conf_file)
+      puts ERB.new( @strs[:messages][:missing_conf_file] ).result( binding ) unless quiet
+      return false
+    elsif not File.file?( conf_file )
+      puts ERB.new( @strs[:messages][:invalid_conf_file_not_file] ).result( binding ) unless quiet
+      return false
+    end
+    
+    # Checks, if the plugins path exists and is a directory
+    plugin_path = File.join( path, 'plugins' )
+    if not File.exists?( plugin_path )
+      warn ERB.new( @strs[:messages][:warn_no_plugin_directory_in_project] ).result( binding ) if @args[:verbose]
+    elsif not File.directory?( plugin_path )
+      puts ERB.new( @strs[:messages][:plugin_directory_not_a_directory] ).result( binding ) unless quiet
+      return false
+    end
+    
+    # Checks (and automatically creates if missing) the run, db and log directories
+    ['run','log','db'].each do |dir_name|
+      dir_path = File.join( path, dir_name )
+      unless File.exists?( dir_path )
+        warn ERB.new( @strs[:messages][:warn_no_directory_creating] ).result( binding ) if @args[:verbose]
+        Dir.mkdir( dir_path )
+      end
+    end
+    return true
+  end
+
+end
+end

data/lib/rsence/argv/help_argv.rb

@@ -0,0 +1,15 @@
+module RSence
+module ArgvUtil
+  # Main parser for the help command
+  def help( cmd )
+    cmd.to_sym! if cmd.class != Symbol
+    puts @strs[:help][:head]
+    if @strs[:help].has_key?(cmd)
+      puts @strs[:help][cmd]
+    else
+      puts @strs[:help][:help_main]
+    end
+    puts @strs[:help][:tail]
+  end
+end
+end