typo 3.99.2 → 3.99.3

data/doc/Installer.txt

@@ -47,6 +47,15 @@ Installing Typo
    installer/apache.conf.example to run your Typo installation under Apache.
 
 
+Upgrading Typo
+--------------
+
+The Typo installer can upgrade an existing installer-created Typo install by 
+simple running 'typo install DIRECTORY'.  The installer will automatically
+detect that it's upgrading an existing install and will attempt to preserve
+the existing configuration as much as possible.
+
+
 Starting and Stopping Typo
 --------------------------
 
@@ -55,10 +64,18 @@ To stop Typo from running, run `typo stop /path/to/typo`. To restart it, run
 you can't depend on your web server restarting it automatically on reboot.  You'll need to either create an init script or cron reboot entry to restart it, depending on your host and/or privilege level.
 
 
+Configuration Variables
+-----------------------
+
+Each Typo installation maintains a list of configuration variables.  To see
+the list for an existing install, run 'typo config DIRECTORY'.  You can change
+them via 'typo config DIRECTORY name1=value1 name2=value2...'  For example:
+
+  typo config /var/www/typo web-server=mongrel_cluster
+
+
 TODO
 ----
 
-1.  Actually write the Apache HTTP proxy instructions (for 1.3 and 2.x)
-2.  Add lighttpd proxy directions.
-3.  Figure out how to best have Typo restart on reboot.
-4.  Handle the "missing swig" problem better.
+1.  Figure out how to best have Typo restart on reboot.
+2.  Handle the "missing swig" problem better.

data/installer/rails-installer.rb

@@ -4,6 +4,9 @@ require 'rubygems'
 require 'yaml'
 require 'digest/sha1'
 
+require 'installer/rails-installer/web-servers'
+require 'installer/rails-installer/commands'
+
 class RailsInstaller
   include FileUtils
   attr_accessor :install_directory, :source_directory, :config
@@ -24,10 +27,16 @@ class RailsInstaller
   def self.rails_version(svn_tag)
     @@rails_version = svn_tag
   end
+  
+  def app_name
+    @@app_name
+  end
 
   def initialize(install_directory)
     # use an absolute path, not a relative path.
-    @install_directory = File.expand_path(install_directory)
+    if install_directory
+      @install_directory = File.expand_path(install_directory)
+    end
     
     @config = read_yml(config_file) rescue nil
     @config ||= Hash.new
@@ -45,10 +54,9 @@ class RailsInstaller
   # Install Application
   def install(version=nil)
     @source_directory = find_source_directory(@@app_name,version)
-    
-    if config.size == 0
-      @config = read_yml(backup_config_file)
-    end
+
+    # Merge default configuration settings
+    @config = read_yml(backup_config_file).merge(config)
     
     install_sequence
     
@@ -84,36 +92,24 @@ class RailsInstaller
   
   # Start application in the background
   def start(foreground = false)
-    return unless config['web-server'] == 'mongrel'
-    
-    args = {}
-    args['-p'] = config['port-number']
-    args['-a'] = config['bind-address']
-    args['-e'] = config['rails-environment']
-    args['-d'] = foreground
-    args['-P'] = pid_file
-    
-    # Remove keys with nil values
-    args.delete_if {|k,v| v==nil}
+    server_class = RailsInstaller::WebServer.servers[config['web-server']]
+    if not server_class
+      message "** warning: web-server #{config['web-server']} unknown.  Use 'web-server=external' to disable."
+    end
     
-    args_array = args.to_a.flatten.map {|e| e.to_s}
-    args_array = ['mongrel_rails', 'start', install_directory] + args_array
-    message "Starting #{@@app_name.capitalize} on port #{config['port-number']}"
-    system(args_array.join(' '))
+    server_class.start(self,foreground)
   end
   
   # Stop application
   def stop
-    return unless File.exists? pid_file
-    return unless config['web-server'] == 'mongrel'
+    return unless File.directory?(install_directory)
     
-    args = {}
-    args['-P'] = pid_file
+    server_class = RailsInstaller::WebServer.servers[config['web-server']]
+    if not server_class
+      message "** warning: web-server #{config['web-server']} unknown.  Use 'web-server=external' to disable."
+    end
     
-    args_array = args.to_a.flatten.map {|e| e.to_s}
-    args_array = ['mongrel_rails', 'stop', install_directory] + args_array
-    message "Stopping #{@@app_name.capitalize}"
-    system(args_array.join(' '))
+    server_class.stop(self)
   end
   
 #  private
@@ -126,7 +122,6 @@ class RailsInstaller
   # Backup the database
   def backup_database
     return unless File.exists? db_file
-    Dir.chdir(install_directory)
 
     return unless config['database'] == 'sqlite'
     new_db_file = db_file+"-#{Time.now.strftime('%Y%m%d-%H%M')}.sql"
@@ -184,7 +179,6 @@ class RailsInstaller
     end
     
     write_yml(files_yml,new_files)
-    Dir.chdir(install_directory)
   end
 
   # Copy one file from source_directory to install_directory, creating directories as needed.
@@ -295,11 +289,14 @@ class RailsInstaller
   # Create the default database.yml
   def create_default_database_yml
     database_yml = File.join(install_directory,'config','database.yml')
-    return if File.exist?(database_yml)
-    return unless config['database'] == 'sqlite'
     
+    if File.exist?(database_yml)
+      message "Preserving database.yml"
+      return
+    end
+        
     message "Creating default database configuration file"
-    cp("#{database_yml}.sqlite",database_yml)
+    cp("#{database_yml}.#{config['database']}",database_yml)
   end
   
   # Create required directories, like tmp
@@ -353,10 +350,11 @@ class RailsInstaller
     # Are we downgrading?
     if old_schema_version > new_schema_version
       message "Downgrading schema from #{old_schema_version} to #{new_schema_version}"
-      status = system("rake -s migrate VERSION=#{new_schema_version}")
       
-      unless status
-        raise InstallFailed, "Downgrade migrating from #{old_schema_version} to #{new_schema_version} failed."
+      in_directory install_directory do
+        unless system("rake -s migrate VERSION=#{new_schema_version}")
+          raise InstallFailed, "Downgrade migrating from #{old_schema_version} to #{new_schema_version} failed."
+        end
       end
     end
   end
@@ -364,25 +362,27 @@ class RailsInstaller
   # Migrate the database
   def migrate
     message "Migrating #{@@app_name.capitalize}'s database to newest release"
-    status = system("rake -s migrate")
     
-    unless status
-      raise InstallFailed, "Migration failed"
+    in_directory install_directory do
+      unless system("rake -s migrate")
+        raise InstallFailed, "Migration failed"
+      end
     end
   end
 
   # Sweep the cache
   def run_rails_tests
     message "Running tests.  This may take a minute or two"
-    status = system_silently("rake -s test")
     
-    if status
-      message "All tests pass.  Congratulations."
-    else
-      message "***** Tests failed *****"
-      message "** Please run 'rake test' by hand in your install directory."
-      message "** Report problems to #{@@support_location}."
-      message "***** Tests failed *****"
+    in_directory install_directory do
+      if system_silently("rake -s test")
+        message "All tests pass.  Congratulations."
+      else
+        message "***** Tests failed *****"
+        message "** Please run 'rake test' by hand in your install directory."
+        message "** Report problems to #{@@support_location}."
+        message "***** Tests failed *****"
+      end
     end
   end
 
@@ -414,10 +414,6 @@ class RailsInstaller
     end
   end
   
-  def pid_file
-    File.join(install_directory,'tmp','pid.txt')
-  end
-  
   # Locate the source directory for a specific Version
   def find_source_directory(gem_name, version)
     if version == 'cwd'
@@ -471,50 +467,42 @@ class RailsInstaller
       exit(1)
     end
     
-    case args[0]
-    when 'install'
-      install(args[2])
-    when 'upgrade'
-      install(args[2])
-    when 'start'
-      start
-    when 'stop'
-      stop
-    when 'run'
-      start(true)
-    when 'config'
-      if args.size < 3
-        config.keys.sort.each do |k|
-          puts "#{k}=#{config[k]}"
-        end
-      else
-        args[2..-1].each do |arg|
-          if(arg=~/^([^=]+)=(.*)$/)
-            config[$1.to_s]=$2.to_s
-          else
-            STDERR.puts "Unknown config command: #{arg}"
-          end
-        end
-        save
-      end
+    command_class = Command.commands[args.first]
+    
+    if command_class
+      command_class.command(self,*(args[2..-1]))
     else
-      display_help('Unknown command')
+      display_help
+      exit(1)
     end
   end
   
   def display_help(error=nil)
     STDERR.puts error if error
-    STDERR.puts "Commands:"
-    STDERR.puts "  typo install DIRECTORY [VERSION]"
-    STDERR.puts "     Installs Typo into DIRECTORY.  If there's an existing Typo install in"
-    STDERR.puts "     DIRECTORY, then the installer will upgrade the installation instead."
-    STDERR.puts "  typo start DIRECTORY"
-    STDERR.puts "     Starts a Typo server in DIRECTORY."
-    STDERR.puts "  typo stop DIRECTORY"
-    STDERR.puts "     Shuts down a Typo server in DIRECTORY."
-    STDERR.puts "  typo config DIRECTORY"
-    STDERR.puts "     Shows configuration variables for Typo."
-    STDERR.puts "  typo config DIRECTORY NAME=VALUE..."
-    STDERR.puts "     Sets configuration variables for Typo."
+    
+    commands = Command.commands.keys.sort
+    commands.each do |cmd|
+      cmd_class = Command.commands[cmd]
+      cmd_help = cmd_class.help(self)
+      
+      STDERR.puts "  #{app_name} #{cmd} DIRECTORY #{cmd_help.first}"
+      STDERR.puts "    #{cmd_help.last}"
+    end
   end
 end
+
+# Run a block inside of a specific directory.  Chdir into the directory
+# before executing the block, then chdir back to the original directory
+# when the block exits.
+def in_directory(directory)
+  begin
+    old_dir = Dir.pwd
+    Dir.chdir(directory)
+    value = yield
+  ensure
+    Dir.chdir(old_dir)
+  end
+  
+  return value
+end
+

data/installer/rails-installer/commands.rb

@@ -0,0 +1,117 @@
+class RailsInstaller
+  
+  # Parent class for webserver plugins for the installer.  To create a new 
+  # webserver handler, subclass this class and define a 'start' and 'stop'
+  # class method.
+  class Command
+    @@command_map = {}
+    
+    def self.command(installer, *args)
+      raise "Not Implemented"
+    end
+    
+    def self.help(installer)
+    end
+  
+    def self.inherited(sub)
+      name = sub.to_s.gsub(/^.*::/,'').gsub(/([A-Z])/) do |match|
+        "_#{match.downcase}"
+      end.gsub(/^_/,'')
+
+      @@command_map[name] = sub
+    end
+    
+    def self.commands
+      @@command_map
+    end
+    
+    class Install < RailsInstaller::Command
+      def self.command(installer, *args)
+        version = nil
+        args.each do |arg|
+          if(arg =~ /^([^=]+)=(.*)$/)
+            installer.config[$1.to_s] = $2.to_s
+          else
+            version = arg
+          end
+        end
+        
+        installer.install(version)
+      end
+      
+      def self.help(installer)
+        ['',"Install or upgrade #{installer.app_name} in PATH."]
+      end
+    end
+    
+    class Config < RailsInstaller::Command
+      def self.command(installer, *args)
+        if args.size == 0
+          installer.config.keys.sort.each do |k|
+            puts "#{k}=#{installer.config[k]}"
+          end
+        else
+          args.each do |arg|
+            if(arg=~/^([^=]+)=(.*)$/)
+              if $2.to_s.empty?
+                installer.config.delete($1.to_s)
+              else
+                installer.config[$1.to_s]=$2.to_s
+              end
+            else
+              puts installer.config[arg]
+            end
+          end
+          installer.save
+        end
+        
+      end
+      
+      def self.help(installer)
+        ['[KEY=VALUE]...',"Read or set a #{installer.app_name} configuration variable"]
+      end
+    end
+    
+    class Start < RailsInstaller::Command
+      def self.command(installer, *args)
+        installer.start
+      end
+      
+      def self.help(installer)
+        ['',"Start the web server for #{installer.app_name} in the background"]
+      end
+    end
+
+    class Run < RailsInstaller::Command
+      def self.command(installer, *args)
+        installer.start(true)
+      end
+      
+      def self.help(installer)
+        ['',"Start the web server for #{installer.app_name} in the foreground"]
+      end
+    end
+
+    class Restart < RailsInstaller::Command
+      def self.command(installer, *args)
+        installer.stop
+        installer.start
+      end
+      
+      def self.help(installer)
+        ['',"Stop and restart the web server for #{installer.app_name}."]
+      end
+    end
+    
+    class Stop < RailsInstaller::Command
+      def self.command(installer, *args)
+        installer.stop
+      end
+
+      def self.help(installer)
+        ['',"Stop the web server for #{installer.app_name}"]
+      end
+    end
+  end
+end
+  

data/installer/rails-installer/web-server.rb

@@ -0,0 +1,108 @@
+class RailsInstaller
+  
+  # Parent class for webserver plugins for the installer.  To create a new 
+  # webserver handler, subclass this class and define a 'start' and 'stop'
+  # class method.
+  class WebServer
+    @@server_map = {}
+    
+    def self.start(installer, foreground)
+      raise "Not Implemented"
+    end
+  
+    def self.stop(installer, foreground)
+      raise "Not Implemented"
+    end
+
+    def self.inherited(sub)
+      name = sub.to_s.gsub(/^.*::/,'').gsub(/([A-Z])/) do |match|
+        "_#{match.downcase}"
+      end.gsub(/^_/,'')
+
+      @@server_map[name] = sub
+    end
+    
+    def self.servers
+      @@server_map
+    end
+
+    class Mongrel < RailsInstaller::WebServer
+      def self.start(installer, foreground)
+        args = {}
+        args['-p'] = installer.config['port-number']
+        args['-a'] = installer.config['bind-address']
+        args['-e'] = installer.config['rails-environment']
+        args['-d'] = foreground
+        args['-P'] = pid_file(installer)
+
+        # Remove keys with nil values
+        args.delete_if {|k,v| v==nil}
+
+        args_array = args.to_a.flatten.map {|e| e.to_s}
+        args_array = ['mongrel_rails', 'start', installer.install_directory] + args_array
+        installer.message "Starting #{installer.app_name.capitalize} on port #{installer.config['port-number']}"
+        in_directory installer.install_directory do
+          system(args_array.join(' '))
+        end
+      end
+  
+      def self.stop(installer)
+        args = {}
+        args['-P'] = pid_file(installer)
+
+        args_array = args.to_a.flatten.map {|e| e.to_s}
+        args_array = ['mongrel_rails', 'stop', installer.install_directory] + args_array
+        installer.message "Stopping #{installer.app_name.capitalize}"
+        in_directory installer.install_directory do
+          system(args_array.join(' '))
+        end
+        
+      end
+      
+      def self.pid_file(installer)
+        File.join(installer.install_directory,'tmp','pid.txt')
+      end
+    end
+    
+    class MongrelCluster < RailsInstaller::WebServer
+      def self.start(installer, foreground)
+        args = {}
+        args['-p'] = installer.config['port-number']
+        args['-a'] = installer.config['bind-address']
+        args['-e'] = installer.config['rails-environment']
+        args['-N'] = installer.config['threads']
+
+        # Remove keys with nil values
+        args.delete_if {|k,v| v==nil}
+
+        args_array = args.to_a.flatten.map {|e| e.to_s}
+        args_array = ['mongrel_rails', 'cluster::configure'] + args_array
+        installer.message "Configuring mongrel_cluster for #{installer.app_name.capitalize}"
+        in_directory installer.install_directory do
+          system(args_array.join(' '))
+        end
+        installer.message "Starting #{installer.app_name.capitalize} on port #{installer.config['port-number']}"
+        in_directory installer.install_directory do
+          system('mongrel_rails cluster::start')
+        end
+        
+      end
+  
+      def self.stop(installer)
+        installer.message "Stopping #{installer.app_name.capitalize}"
+        in_directory installer.install_directory do
+          system('mongrel_rails cluster::stop')
+        end
+      end
+    end
+
+    # Do-nothing webserver class.  Used when the installer doesn't control the web server.
+    class External < RailsInstaller::WebServer
+      def self.start(installer, foreground)
+      end
+      
+      def self.stop(installer)
+      end
+    end
+  end
+end