nginxtra 1.2.0.1 → 1.2.1.2

data/VERSION

@@ -1 +1 @@
-1.2.0.1
+1.2.1.2

data/bin/nginxtra

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 require "rubygems"
-gem "nginxtra", "= 1.2.0.1"
+gem "nginxtra", "= 1.2.1.2"
 require "nginxtra"
 Nginxtra::CLI.start

data/lib/nginxtra.rb

@@ -1,5 +1,6 @@
 require "nginxtra/action"
 require "nginxtra/actions/compile"
+require "nginxtra/actions/convert"
 require "nginxtra/actions/install"
 require "nginxtra/actions/reload"
 require "nginxtra/actions/restart"
@@ -8,5 +9,6 @@ require "nginxtra/actions/status"
 require "nginxtra/actions/stop"
 require "nginxtra/cli"
 require "nginxtra/config"
+require "nginxtra/config_converter"
 require "nginxtra/error"
 require "nginxtra/status"

data/lib/nginxtra/action.rb

@@ -40,7 +40,7 @@ module Nginxtra
     end
 
     def sudo(force = false)
-      "sudo " if (force || @config.require_root?) && Process.uid != 0
+      "sudo " if (force || (@config && @config.require_root?)) && Process.uid != 0
     end
   end
 end

data/lib/nginxtra/actions/convert.rb

@@ -0,0 +1,67 @@
+require "stringio"
+
+module Nginxtra
+  module Actions
+    class Convert
+      include Nginxtra::Action
+
+      def convert
+        @streams_to_close = []
+        converter = Nginxtra::ConfigConverter.new output
+        converter.convert :config => config, :binary_status => binary_status
+        save_if_necessary!
+      ensure
+        close_streams!
+      end
+
+      private
+      def output
+        if @thor.options["output"]
+          STDOUT
+        elsif @thor.options["config"]
+          @output = @thor.options["config"]
+          @stringio = StringIO.new
+        else
+          @output = "nginxtra.conf.rb"
+          @stringio = StringIO.new
+        end
+      end
+
+      def save_if_necessary!
+        return unless @output && @stringio
+        @thor.create_file @output, @stringio.string
+      end
+
+      def config
+        if @thor.options["input"]
+          STDIN
+        elsif @thor.options["nginx-conf"]
+          open_file @thor.options["nginx-conf"]
+        end
+      end
+
+      def binary_status
+        return if @thor.options["ignore-nginx-bin"]
+
+        if @thor.options["nginx-bin"]
+          @thor.run "#{@thor.options["nginx-bin"]} -V 2>&1", :capture => true
+        else
+          # TODO: Figure out the nginx binary location and call -V
+          raise "The auto detection of nginx binary is not yet implemented.  Please use the --nginx-bin option for now."
+        end
+      end
+
+      def open_file(path)
+        raise "Missing config file #{path}" unless File.exists? path
+
+        File.open(path, "r").tap do |stream|
+          @streams_to_close << stream
+        end
+      end
+
+      def close_streams!
+        @streams_to_close.each &:close
+      end
+    end
+  end
+end

data/lib/nginxtra/actions/install.rb

@@ -11,6 +11,9 @@ module Nginxtra
       # if run with --non-interactive mode.
       def optional_install
         return installation_skipped if non_interactive?
+        # TODO: Raise an error if nginx is determined to be installed
+        # (via /etc/init.d/nginx perhaps... but allow ignoring this
+        # check).
         return up_to_date unless should_install?
         return unless requesting_install?
         install

data/lib/nginxtra/cli.rb

@@ -9,6 +9,26 @@ module Nginxtra
     class_option "config", :type => :string, :banner => "Specify the configuration file to use", :aliases => "-c"
     class_option "basedir", :type => :string, :banner => "Specify the directory to store nginx files", :aliases => "-b"
 
+    desc "convert", "Convert an nginx.conf file to an nginxtra.conf.rb"
+    long_desc "
+      Parse nginx.conf and convert it to an equivalent nginxtra.conf.rb file.  Expects
+      nginx.conf to be in the current folder, but a different file can be specified
+      with the --nginx-conf option.  Parses the compile time options using the nginx
+      binary parsed from /etc/init.d/nginx, which can be overridden with the
+      --nginx-bin option.  This task will fail if the binary cannot be determined,
+      unless the --ignore-nginx-bin option is used, which will cause the compile time
+      options to be ignored (and the defaults will be used in the resulting
+      nginxtra.conf.rb).  The result will be output to nginxtra.conf.rb in the current
+      directory, unless an override value is specified with the --config option."
+    method_option "nginx-bin", :type => :string, :banner => "Point to the compiled nginx to retrieve compile options", :aliases => "-n"
+    method_option "nginx-conf", :type => :string, :banner => "Point to the nginx.conf file to retrieve the existing configuration", :aliases => "-", :default => "nginx.conf"
+    method_option "ignore-nginx-bin", :type => :boolean, :banner => "Ignore the nginx binary, and assume default compile time options", :aliases => "-N"
+    method_option "output", :type => :boolean, :banner => "Output to standard out instead of to a file", :aliases => "-o"
+    method_option "input", :type => :boolean, :banner => "Read nginx.conf from standard in instead of a file", :aliases => "-i"
+    def convert
+      Nginxtra::Actions::Convert.new(self, nil).convert
+    end
+
     desc "compile", "Compiles nginx based on nginxtra.conf.rb"
     long_desc "
       Compile nginx with the compilation options specified in nginxtra.conf.rb.  If it

data/lib/nginxtra/config_converter.rb

@@ -0,0 +1,324 @@
+module Nginxtra
+  class ConfigConverter
+    def initialize(output)
+      @converted = false
+      @output = output
+      @indentation = Nginxtra::ConfigConverter::Indentation.new
+    end
+
+    def convert(options)
+      raise Nginxtra::Error::ConvertFailed.new("The convert method can only be called once!") if converted?
+      header
+      compile_options options[:binary_status]
+      config_file options[:config]
+      footer
+      converted!
+    end
+
+    private
+    def header
+      @output.puts "nginxtra.config do"
+      @indentation + 1
+    end
+
+    def compile_options(status)
+      return unless status
+      options = (status[/^configure arguments:\s*(.*)$/, 1] || "").strip
+      return if options.empty?
+      options = options.split /\s+/
+      process_passenger_compile_options! options
+
+      options.each do |option|
+        next if invalid_compile_option? option
+        @output.print @indentation
+        @output.puts %{compile_option "#{option}"}
+      end
+    end
+
+    def process_passenger_compile_options!(options)
+      return if options.select { |x| x =~ /^--add-module.*\/passenger.*/ }.empty?
+      @output.print @indentation
+      @output.puts "require_passenger!"
+
+      options.delete_if do |x|
+        next true if x =~ /^--add-module.*\/passenger.*/
+        ["--with-http_ssl_module", "--with-http_gzip_static_module", "--with-cc-opt=-Wno-error"].include? x
+      end
+    end
+
+    def invalid_compile_option?(option)
+      return true if option =~ /--prefix=/
+      return true if option =~ /--sbin-path=/
+      return true if option =~ /--conf-path=/
+      return true if option =~ /--pid-path=/
+      false
+    end
+
+    def config_file(input)
+      return unless input
+      @output.print @indentation
+      @output.puts %{file "nginx.conf" do}
+      @indentation + 1
+      line = Nginxtra::ConfigConverter::Line.new @indentation, @output
+
+      each_token(input) do |token|
+        line << token
+
+        if line.terminated?
+          line.puts
+          line = Nginxtra::ConfigConverter::Line.new @indentation, @output
+        end
+      end
+
+      raise Nginxtra::Error::ConvertFailed.new("Unexpected end of file!") unless line.empty?
+      @indentation - 1
+      @output.print @indentation
+      @output.puts "end"
+    end
+
+    def each_token(input)
+      token = Nginxtra::ConfigConverter::Token.new
+
+      while c = input.read(1)
+        if c == "#"
+          chomp_comment input
+        else
+          token << c
+        end
+
+        yield token.instance while token.ready?
+      end
+
+      yield token.instance while token.ready?
+      raise Nginxtra::Error::ConvertFailed.new("Unexpected end of file in mid token!") unless token.value.empty?
+    end
+
+    def chomp_comment(input)
+      while c = input.read(1)
+        break if c == "\n"
+      end
+    end
+
+    def footer
+      @indentation - 1
+      @output.puts "end"
+      raise Nginxtra::Error::ConvertFailed.new("Missing end blocks!") unless @indentation.done?
+    end
+
+    def converted!
+      @converted = true
+    end
+
+    def converted?
+      @converted
+    end
+
+    class Token
+      TERMINAL_CHARACTERS = ["{", "}", ";"].freeze
+      attr_reader :value
+
+      def initialize(value = nil)
+        @instance = true if value
+        @value = value || ""
+        @ready = false
+      end
+
+      def terminal_character?
+        TERMINAL_CHARACTERS.include? @value
+      end
+
+      def end?
+        @value == ";"
+      end
+
+      def block_start?
+        @value == "{"
+      end
+
+      def block_end?
+        @value == "}"
+      end
+
+      def instance
+        raise Nginxtra::Error::ConvertFailed.new("Whoops!") unless ready?
+        token = Nginxtra::ConfigConverter::Token.new @value
+        reset!
+        token
+      end
+
+      def <<(c)
+        return space! if c =~ /\s/
+        return terminal_character!(c) if TERMINAL_CHARACTERS.include? c
+        @value << c
+      end
+
+      def ready?
+        @instance || @ready || terminal_character?
+      end
+
+      def to_s
+        if @value =~ /^\d+$/
+          @value
+        else
+          %{"#{@value}"}
+        end
+      end
+
+      private
+      def space!
+        return if @value.empty?
+        @ready = true
+      end
+
+      def terminal_character!(c)
+        if @value.empty?
+          @value = c
+        else
+          @next = c
+        end
+
+        @ready = true
+      end
+
+      def reset!
+        if @next
+          @value = @next
+        else
+          @value = ""
+        end
+
+        @next = nil
+        @ready = false
+      end
+    end
+
+    class Line
+      def initialize(indentation, output)
+        @indentation = indentation
+        @output = output
+        @tokens = []
+      end
+
+      def <<(token)
+        @tokens << token
+      end
+
+      def empty?
+        @tokens.empty?
+      end
+
+      def terminated?
+        @tokens.last.terminal_character?
+      end
+
+      def puts
+        if @tokens.last.end?
+          puts_line
+        elsif @tokens.last.block_start?
+          puts_block_start
+        elsif @tokens.last.block_end?
+          puts_block_end
+        else
+          raise Nginxtra::Error::ConvertFailed.new "Can't puts invalid line!"
+        end
+      end
+
+      private
+      def passenger?
+        ["passenger_root", "passenger_ruby", "passenger_enabled"].include? @tokens.first.value
+      end
+
+      def puts_line
+        raise Nginxtra::Error::ConvertFailed.new("line must have a first label!") unless @tokens.length > 1
+        return puts_passenger if passenger?
+        print_indentation
+        print_first
+        print_args
+        print_newline
+      end
+
+      def puts_passenger
+        print_indentation
+
+        if @tokens.first.value == "passenger_root"
+          print_newline "passenger_root!"
+        elsif @tokens.first.value == "passenger_ruby"
+          print_newline "passenger_ruby!"
+        elsif @tokens.first.value == "passenger_enabled"
+          print_newline "passenger_on!"
+        else
+          raise Nginxtra::Error::ConvertFailed.new("Whoops!")
+        end
+      end
+
+      def puts_block_start
+        raise Nginxtra::Error::ConvertFailed.new("Block start must have a first label!") unless @tokens.length > 1
+        print_indentation
+        print_first
+        print_args
+        print_newline(" do")
+        indent
+      end
+
+      def puts_block_end
+        raise Nginxtra::Error::ConvertFailed.new("Block end can't have labels!") unless @tokens.length == 1
+        unindent
+        print_indentation
+        print_newline("end")
+      end
+
+      def print_indentation
+        @output.print @indentation.to_s
+      end
+
+      def print_first
+        @output.print @tokens.first.value
+      end
+
+      def print_args
+        args = @tokens[1..-2]
+        return if args.empty?
+        @output.print " "
+        @output.print args.map(&:to_s).join(", ")
+      end
+
+      def print_newline(value = "")
+        @output.puts value
+      end
+
+      def indent
+        @indentation + 1
+      end
+
+      def unindent
+        @indentation - 1
+      end
+    end
+
+    class Indentation
+      attr_reader :value
+
+      def initialize
+        @value = 0
+      end
+
+      def done?
+        @value == 0
+      end
+
+      def -(amount)
+        self + (-amount)
+      end
+
+      def +(amount)
+        @value += amount
+        raise Nginxtra::Error::ConvertFailed.new("Missing block end!") if @value < 0
+        @value
+      end
+
+      def to_s
+        "  " * @value
+      end
+    end
+  end
+end