webroar 0.3.1 → 0.4.0

data/doc/user-guide.txt

@@ -24,13 +24,15 @@ Ruby on Rails applications.
 * Provides run time performance data for the deployed applications. 
 * Generates notifications in case any exceptions occur in any of the deployed
  applications.
+* Zero Downtime Application Upgrades.
+* Static assets encoding.
 * SSL support. 
 
 == Supported Operating Systems ==
 
-WebROaR has been tested on Ubuntu 8.10/9.04/9.10, Debian 5 (64 Bit), Mac OS X 
-(v10.5 & v10.6), Arch Linux 2009.08 and Cent OS 5.2. Basically, it should be 
-able to run on any *IX OS.  
+WebROaR has been tested on Ubuntu 8.10/9.04/9.10/10.04, Debian 5 (64 Bit), 
+Mac OS X (v10.5 & v10.6), Arch Linux 2009.08 and Cent OS 5.2. Basically, it 
+should be able to run on any *IX OS.
 
 Currently it does not support Microsoft(R) Windows.
 
@@ -51,16 +53,6 @@ Currently it does not support Microsoft(R) Windows.
 - gnutls 2.4.1 or later (Only necessary in case SSL support is required) 
 - gnutls-dev 2.4.1 or later (Only necessary in case SSL support is required) 
 
-[NOTE]
-.Ruby Shared Library
-===============================
-The server needs the shared library - libruby.so to run the ruby web 
-applications.
-
-If you are building ruby from source, please ensure you pass the flag 
-*--enable-shared* while executing its ./configure script.
-
-===============================
 
 === Procedure ===
 
@@ -244,6 +236,10 @@ directory. This can be used to troubleshoot the issues, if any.
 in */var/log/webroar*. In the unfortunate event of the server crashing, a core 
 dump file would be created in /tmp if 'gcore' is available on that machine.
 
+=== Know Issue ===
+ 
+* WebROaR with SSL build crashes on Ubuntu 10.04 upon execution of 
+*gnutls_handshake* by secure connection.
 
 === Setting up database for server admin panel ===
 

data/lib/command_runner.rb

@@ -283,6 +283,7 @@ class CommandRunner
 
     opts.on( '-D', '--path DIR', 'Path for the web application root directory') do |value|
       @options[:path] = value.lstrip.gsub(/^=/,"")
+      @options[:path] = File.expand_path(@options[:path])
     end
 
     opts.on( '-T', '--type APPTYPE', 'Type of the application either rack or rails') do |value|

data/lib/dependencies.rb

@@ -34,10 +34,10 @@ module Webroar
       @options = options
       case (@name)
       when File.basename(Config::CONFIG['CC']), "make", Config::CONFIG['RUBY_INSTALL_NAME'], "starling"; flag = find_command
-      when "libsqlite3.so"; flag = find_so
-      when "sqlite3.h", "gnutls/gnutls.h"; flag = find_header_file
+      when "libsqlite3.so"; flag = find_lib
+      when "sqlite3.h", "gnutls/gnutls.h", "zlib.h", "regex.h"; flag = find_header_file
       when "ruby_headers"; flag = find_header_file("ruby.h")
-      when Config::CONFIG['LIBRUBY_SO']; flag = find_shared_lib
+      when Config::CONFIG['LIBRUBY']; flag = find_ruby_lib
       when "rubygems"; flag = find_gem
       when "openssl-ruby"; flag = find_gem("openssl")
       when "zlib-ruby"; flag = find_gem("zlib")
@@ -49,15 +49,15 @@ module Webroar
 
     private
 
-    def find_shared_lib
-      if File.exist?(File.join(Config::CONFIG['libdir'],Config::CONFIG['LIBRUBY_SO']))
+    def find_ruby_lib
+      if File.exist?(File.join(Config::CONFIG['libdir'],Config::CONFIG['LIBRUBY']))
         flag = "\e[32mfound\e[0m  at #{Config::CONFIG['libdir']}."
       elsif Config::CONFIG['ENABLE_SHARED'] == 'yes'
         flag = "\e[32mfound\e[0m."
       else
-        flag = find_so(Config::CONFIG['LIBRUBY_SO'])
+        flag = find_lib(Config::CONFIG['LIBRUBY'])
 #      else
-#        flag="\e[31mnot found\e[0m.\nUnable to find #{Config::CONFIG['LIBRUBY_SO']} at #{Config::CONFIG['libdir']}."
+#        flag="\e[31mnot found\e[0m.\nUnable to find #{Config::CONFIG['LIBRUBY']} at #{Config::CONFIG['libdir']}."
       end
       return flag
     end
@@ -84,11 +84,11 @@ module Webroar
       check_file(arr, name)
     end
 
-    def find_so(name = @name)
-      arr = []
-      arr += ENV['LD_LIBRARY_PATH'].split(File::PATH_SEPARATOR) if ENV['LD_LIBRARY_PATH']
-      arr += ["/usr/lib"]
-      arr += @options[:library_paths].gsub(' -L','').gsub("''",":").gsub("'",'').split(File::PATH_SEPARATOR) if @options[:library_paths]
+    def find_lib(name = @name)
+      arr = ["/usr/lib"]
+      arr << ENV['LD_LIBRARY_PATH'].split(File::PATH_SEPARATOR) if ENV['LD_LIBRARY_PATH']
+      arr << Config::CONFIG['libdir'] if Config::CONFIG['libdir']
+      arr << @options[:library_paths].gsub(' -L','').gsub("''",":").gsub("'",'').split(File::PATH_SEPARATOR) if @options[:library_paths]
       arr.delete("")
 
       check_file(arr, name)
@@ -100,7 +100,8 @@ module Webroar
       begin
         require 'rbconfig'
         require 'mkmf'
-        arr += [Config::CONFIG['archdir'], Config::CONFIG['sitearchdir']]
+        arr += [Config::CONFIG['includedir'], Config::CONFIG['archdir'], Config::CONFIG['sitearchdir']]
+        arr << Config::CONFIG['rubyhdrdir'] if Config::CONFIG['rubyhdrdir']
       end
 
       arr += ["/usr/include"]
@@ -125,7 +126,7 @@ module Webroar
     GCC = Dependency.new(File.basename(Config::CONFIG['CC']))
     Gnutls = Dependency.new('gnutls/gnutls.h')
     Make = Dependency.new('make')
-    LibRuby = Dependency.new(Config::CONFIG['LIBRUBY_SO'])
+    LibRuby = Dependency.new(Config::CONFIG['LIBRUBY'])
     LibSqlite = Dependency.new('libsqlite3.so')
     Ruby_OpenSSL = Dependency.new('openssl-ruby')
     Ruby = Dependency.new(Config::CONFIG['RUBY_INSTALL_NAME'])
@@ -134,6 +135,8 @@ module Webroar
     Sqlite_DevHeaders = Dependency.new('sqlite3.h')
     Starling = Dependency.new('starling')
     Xcode = Dependency.new('Xcode.app')
-    Zlib = Dependency.new('zlib-ruby')
+    RubyZlib = Dependency.new('zlib-ruby')
+    Zlib = Dependency.new('zlib.h')
+    Regex = Dependency.new('regex.h')
   end
 end # module Webroar

data/lib/installer.rb

@@ -73,6 +73,9 @@ class Installer
 #          9) Logging level(optional)(default is 'Server Specification/log_level')
 #         10) Run as user (mandatory)
 #         11) Hostnames(optional)
+#         12) Environment Variable(optional)
+#             It defines environment variables which can be used in the deployed application. It take following parameter.
+#               I) set_env(optional)(Value is key-value pair separated by equal sign('=') e.g. LOG_DIR=/var/log/webroar)             
 #        Order of the above elements does not matter.
 #        Base-uri 'admin-panel' is reserved for 'Admin Panel'.
 #        Either host_names or baseuri(not both) must present to resolve HTTP request.
@@ -91,6 +94,9 @@ class Installer
 #              min_worker: 2
 #              max_worker: 5
 #              log_level: SEVERE
+#              environment_variables: 
+#                - set_env: LOG_DIR=/var/log/webroar
+#                - set_env: TMP_DIR=/tmp
 #        Example with host_names:
 #          Application Specification:
 #            - name: Mephisto
@@ -103,21 +109,42 @@ class Installer
 #              min_worker: 2
 #              max_worker: 5
 #              log_level: SEVERE
-#  (c)  Headers (optional)
-#         It allows adding or changing the Expires and Cache-Control in the response headers for static assets (e.g. *.js, *.gif etc).
-#         Elements:
-#           1) Expires header for all static assets (optional) (default is 'off')
-#           2) Specific expires header for specific file types (optional)
-#              Elements:
-#                 I) File Extensions(mandatory)
-#                II) Expires value(mandatory) (No of seconds)
-#         Possible value for expires is off or no. of seconds.
-#         Example:
-#           Headers:
-#             expires: 3600
-#             expires_by_type:
-#             - ext: png, jpg, gif
-#               expires: 31536000
+#              environment_variables: 
+#                - set_env: LOG_DIR=/var/log/webroar
+#                - set_env: TMP_DIR=/tmp
+#
+#  (c) Headers (optional)
+#        It allows adding or changing the Expires and Cache-Control in the response headers for static assets (e.g. *.js, *.gif etc). 
+#        Elements:
+#          1) Expires header for all static assets (optional) (default is 'off')
+#          2) Specific expires header for specific file types (optional)
+#             Elements:
+#                I) File Extensions(mandatory)
+#               II) Expires value(mandatory) (No of seconds)
+#        Possible value for expires is off or no. of seconds. 
+#        Example:
+#          Headers:
+#            expires: 3600
+#            expires_by_type:
+#            - ext: png, jpg, gif
+#              expires: 31536000
+#
+#  (d) Encoding (optional)
+#        It allows (deflate) encoding of static assets.
+#        Elements:
+#          1) Regex value for supported Content-Type (optional) (default is 'text|xml')
+#          2) Regex value for supported Used-Agent (optional) (default is '.*')
+#          3) Range of Content-Length (optional)
+#             Elements:
+#                I) Lower limit of Content-Length (optional) (default is 1024 i.e. 1KB) 
+#               II) Upper limit of Content-Length (optional) (default is 12328960 i.e. 10MB)
+#        Example:
+#          Encoding:
+#            Content-Type: text|xml|javascript
+#            User-Agent: .*
+#            Size Limit:
+#              lower_limit: 2094
+#              upper_limit: 12328960
 #
 ######################################################################################
   }
@@ -130,7 +157,7 @@ class Installer
       Dependencies::Ruby,
       Dependencies::LibRuby,
       Dependencies::Ruby_OpenSSL,
-      Dependencies::Zlib,
+      Dependencies::RubyZlib,
       Dependencies::Ruby_DevHeaders,
       Dependencies::RubyGems,
       Dependencies::GCC,
@@ -138,7 +165,9 @@ class Installer
       Dependencies::LibSqlite,
       Dependencies::Sqlite_DevHeaders,
       Dependencies::Starling,
-      Dependencies::Gnutls
+      Dependencies::Gnutls,
+      Dependencies::Zlib,
+      Dependencies::Regex
     ]
   end
   
@@ -147,14 +176,16 @@ class Installer
       Dependencies::Ruby,
       Dependencies::LibRuby,
       Dependencies::Ruby_OpenSSL,
-      Dependencies::Zlib,
+      Dependencies::RubyZlib,
       Dependencies::Ruby_DevHeaders,
       Dependencies::RubyGems,
       Dependencies::GCC,
       Dependencies::Make,
       Dependencies::Starling,
       Dependencies::Xcode,
-      Dependencies::Gnutls
+      Dependencies::Gnutls,
+      Dependencies::Zlib,
+      Dependencies::Regex
     ]
   end
 
@@ -164,36 +195,48 @@ class Installer
     @import = false
     @port = 0
     @err_msg = nil
+    @zlib = true
+    @regex = true
   end
 
   # Install the server
   def install(options)
-    return -1 unless CheckUser.check
-    @options = options
-
-    str = set_install_options
-      
     
-    check_dependencies || exit(1)
+    begin
+      return -1 unless CheckUser.check
+      @options = options
       
-    @port, @import, gem_name = UserInteraction.new(@options).user_input
-    @port = import_files(gem_name) if @import
-    write_server_port if !@import
+      str = set_install_options
+  
+      check_dependencies || exit(1)
       
-    create_dirs
-    return -1 unless compile_code(str)
-    return -1 unless install_server
-    
-
-    # Stop WebROaR if already running.
-    WebroarCommand.new.operation(nil, "stop") if File.exist?(PIDFILE)
-
-    # Start WebROaR
-    puts"Starting WebROaR ... "
-    WebroarCommand.new.operation(nil, "start")
-    
-    install_msg(false)
-    puts "Warning: " + @err_msg if @err_msg
+      str << " zlib=yes" if @zlib
+      str << " regex=yes" if(@zlib and @regex)
+        
+      @port, @import, gem_name = UserInteraction.new(@options).user_input
+      @port = import_files(gem_name) if @import
+      write_server_port if !@import
+        
+      create_dirs
+      return -1 unless compile_code(str)
+      return -1 unless install_server
+      
+  
+      # Stop WebROaR if already running.
+      WebroarCommand.new.operation(nil, "stop") if File.exist?(PIDFILE)
+  
+      # Start WebROaR
+      puts"Starting WebROaR ... "
+      WebroarCommand.new.operation(nil, "start")
+      
+      install_msg(false)
+      puts "Warning: " + @err_msg if @err_msg
+    rescue Exception=>e
+      File.open(File.join(WEBROAR_ROOT, "install.log"), "a+") do |f|
+        f.puts e.class.name
+        f.puts e.backtrace
+      end
+    end
   end
 
   # Start test cases
@@ -391,8 +434,8 @@ class Installer
   # Check the dependency
   def check_dependencies
     puts "Checking for the dependencies ..."
-    failed_dependencies =[]
-
+    failed_dependencies = []
+    
     REQUIRED_DEPENDENCIES.each do |dep|
       if (dep.name=="gnutls/gnutls.h" and @ssl) or dep.name != "gnutls/gnutls.h"
         print "Checking for #{dep.name}........"
@@ -407,6 +450,12 @@ class Installer
         end
       end
     end
+    
+    @zlib = false if failed_dependencies.include?(Dependencies::Zlib.name)
+    failed_dependencies.delete(Dependencies::Zlib.name)
+
+    @regex = false if failed_dependencies.include?(Dependencies::Regex.name)
+    failed_dependencies.delete(Dependencies::Regex.name)
 
     if( failed_dependencies.size > 0)
       puts "The following dependencies required for installation could not be found:"
@@ -414,13 +463,24 @@ class Installer
       failed_dependencies.each do |dependency|
         puts dependency
       end
+      
       puts "\e[0mPlease refer the user guide for the list of prerequisites."
       puts "Sorry, WebROaR could not be installed on this machine."
       return false
     end
+    
+    unless @zlib
+      puts "\n\e[31mThe installation continue without supporting static assets encoding.\e[0m"
+      puts ""
+    else
+      unless @regex
+        puts "\n\e[31mThe static asstes endcoding supported without Regex validations.\e[0m"
+        puts ""
+      end
+    end
 
     return true
-  end
+  end 
 
   def check_exe_file(file)
     paths = ENV['PATH'].split(":")
@@ -434,7 +494,6 @@ class Installer
     return flag
   end
 
-
   def create_service_links(script_file)
     create_service_link("0", 'K15webroar', script_file)
     create_service_link("1", 'K15webroar', script_file)
@@ -581,6 +640,12 @@ exit 0"
   end
   
   def import_server_configuration(import_dir)
+    unless File.exist?(File.join(import_dir,"conf","config.yml"))
+      @port = 3000
+      write_server_port
+      return
+    end
+
     info = YAML.load(File.open(File.join(import_dir,"conf","config.yml")))
     ssl = info['Server Specification']['SSL Specification'] if info and info['Server Specification'] and info['Server Specification']['SSL Specification']
 
@@ -626,11 +691,11 @@ exit 0"
 
     if @options[:ssl]
       @ssl = true
-      str = "ssl=yes "
+      str << "ssl=yes "
     end
 
-    str += " include_flags=\"#{@options[:include_paths]}\"" if @options[:include_paths].length > 0
-    str += " library_flags=\"#{@options[:library_paths]}\"" if @options[:library_paths].length > 0
+    str << " include_flags=\"#{@options[:include_paths]}\"" if @options[:include_paths].length > 0
+    str << " library_flags=\"#{@options[:library_paths]}\"" if @options[:library_paths].length > 0
     str
   end
 
@@ -702,7 +767,7 @@ exit 0"
   def create_dirs
     print 'Creating directory structure ...'
     Dir.chdir(WEBROAR_ROOT)
-    system("ln -s  #{ADMIN_PANEL_DIR} #{File.join(WEBROAR_ROOT)}>install.log 2>>install.log")
+    system("ln -s  #{ADMIN_PANEL_DIR} #{WEBROAR_ROOT}>install.log 2>>install.log")
     system("chmod ugo+x #{File.join(WEBROAR_BIN_DIR,'webroar-analyzer')}")
     puts " done."
   end

data/src/admin_panel/app/controllers/admin_controller.rb

@@ -138,7 +138,7 @@ class AdminController < ApplicationController
     end
     if password_changed
       flash[:notice] = PASSWORD_CHANGED
-      YAMLWriter.write(users,USERS_FILE_PATH,"user")
+      YAMLWriter.write(users, USERS_FILE_PATH, YAMLConfig::USER)
     else
       if params[:password][:new].length < 6
         flash[:notice] = WRONG_PASSWORD2
@@ -155,20 +155,6 @@ class AdminController < ApplicationController
     set_application_name
   end
   
-  #This method is to add div for changing the server specifications.
-  #This action is called as a ajax call when user click on the edit button of the server specification block in the configuration page.
-  def add_text_box
-    @path = CONFIG_FILE_PATH
-    render :partial => 'add_div'
-  end
-  
-  #This method is to close the edit box for the server specification.
-  #This is called if user doesnot wants to made the changes in the server specification.	 
-  def cancel_edit
-    text = params[:old_value].to_s		
-    render :text => 	text
-  end
-  
   #This method is to return the server time.
   #The method refreshes the time after every minute.	
   def get_latest_time

data/src/admin_panel/app/controllers/application_controller.rb

@@ -95,9 +95,9 @@ private
     info = YAML::load_file(CONFIG_FILE_PATH) rescue nil
     if info and info['Application Specification']	
       while(info['Application Specification'][i])
-        if info['Application Specification'][i]['analytics'].downcase == "enabled".downcase
+        #if info['Application Specification'][i]['analytics'].downcase == "enabled".downcase
           apps << info['Application Specification'][i]['name'].gsub("<","&lt;").gsub(">","&gt;")
-        end	
+        #end	
         i += 1
       end	
     end

data/src/admin_panel/app/controllers/application_specification_controller.rb

@@ -121,8 +121,9 @@ class ApplicationSpecificationController < ApplicationController
   end
 
   def set_error(reply, err_log)
+    # flash data is being stored in Session, and causing cookie overflow error when total session data exceeds 4K
     flash[:error] = reply if reply
-    flash[:error] += "<br/><br/><div align='left'><font color='red'" + err_log.gsub("\n","<br/>") + "</font></div>" if err_log
+    flash[:error] += "<br/><br/><div align='left'><font color='red'>" + err_log.gsub("\n","<br/>") + "</font></div>" if err_log    
   end
 
 end

data/src/admin_panel/app/controllers/headers_controller.rb

@@ -0,0 +1,73 @@
+#--
+# WebROaR - Ruby Application Server - http://webroar.in/
+# Copyright (C) 2009  Goonj LLC
+#
+# This file is part of WebROaR.
+#
+# WebROaR is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# WebROaR is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with WebROaR.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+class HeadersController < ApplicationController
+  before_filter :login_required
+  before_filter :check_session_timeout
+  
+  def add_expires_text_box        
+    render :partial => 'add_expires_text_box'
+  end
+       
+  def cancel_expires_value_edit
+    text = params[:old_value].to_s    
+    render :text =>   text
+  end
+  
+  def save_expires_value
+    text = params[:old_value].to_s    
+    if params[:data][:value]
+      text, error_message = Headers.validate_and_write_expires_value(text, params[:data][:value])
+      if error_message.length > 0
+        render :text =>   text.to_s + " <span id='error_div'>#{error_message}</span>"
+      else
+        render :text =>   text.to_s + " <span id='error_div'>#{RESTART_SERVER_MESSAGE}</span>"
+      end
+    end
+  end
+  
+  def add_expires_by_type_form
+    render :partial => 'expires_by_type_form'
+  end
+  
+  def save_expires_by_type_value    
+    @error_message = Headers.validate_and_write_expires_by_type(params[:data][:ext], params[:data][:expires])
+    if @error_message.length > 0
+      update_div = 'expires_by_type_form'
+      partial_name = 'expires_by_type_form'
+    else
+      update_div = 'headers_div'
+      partial_name = 'headers_table'
+      @restart_server_message = RESTART_SERVER_MESSAGE
+    end   
+    render :update do |page|
+      page.replace_html update_div, :partial => partial_name  
+    end  
+  end
+  
+  def delete_expires_by_type
+    Headers.delete_expires_by_type(params[:id].to_i) if params[:id]
+    render :partial => 'headers_table'
+  end
+  
+  def cancel_expires_by_type_value
+    render :text => ''
+  end
+end

data/src/admin_panel/app/controllers/mail_specification_controller.rb

@@ -70,4 +70,14 @@ class MailSpecificationController < ApplicationController
     redirect_to :controller => 'admin', :action => 'configuration', :smtp => smtp
   end
   
+  def enable_notification
+    MailSpecification.update_notification_status(:enable)
+    render :partial => 'current_spec'
+  end
+  
+  def disable_notification
+    MailSpecification.update_notification_status(:disable)
+    render :partial => 'current_spec'
+  end
+  
 end

data/src/admin_panel/app/controllers/server_specification_controller.rb

@@ -83,6 +83,20 @@ class ServerSpecificationController < ApplicationController
     end
   end
   
+  #This method is to add div for changing the server specifications.
+  #This action is called as a ajax call when user click on the edit button of the server specification block in the configuration page.
+  def add_text_box
+    @path = CONFIG_FILE_PATH
+    render :partial => 'add_div'
+  end
+  
+  #This method is to close the edit box for the server specification.
+  #This is called if user doesnot wants to made the changes in the server specification.   
+  def cancel_edit
+    text = params[:old_value].to_s    
+    render :text =>   text
+  end
+  
   private
   
   #Method is to check for the various constarins for ssl supports