yodel 0.0.1

data/lib/yodel/command/dns_server.rb

@@ -0,0 +1,16 @@
+require 'rubydns'
+
+class DNSServer
+  def self.start
+    @resolv = Resolv::DNS.new
+    RubyDNS::run_server(:listen => [[:udp, "0.0.0.0", Yodel.config.dns_port], [:tcp, "0.0.0.0", Yodel.config.dns_port]]) do
+      match(/yodel/) do |match_data, transaction|
+        transaction.respond!("127.0.0.1")
+      end
+
+      otherwise do |transaction|
+        transaction.passthrough!(@resolv)
+      end
+    end
+  end
+end

data/lib/yodel/command/installer.rb

@@ -0,0 +1,229 @@
+require 'highline'
+require 'tempfile'
+require 'ember'
+require 'etc'
+
+class Installer
+  # ----------------------------------------
+  # Template variables
+  # ----------------------------------------
+  attr_reader :database_hostname, :database_port, :database_name,
+              :sites_root, :ruby_path, :web_port, :dns_port,
+              :user, :group, :public_directory
+  
+  def default_sites_root
+    if `uname -a` =~ /Darwin/
+      File.expand_path('~/Sites')
+    else
+      '/var/www'
+    end
+  end
+  
+  def default_ruby_path
+    if Config.ruby =~ /rubies\/(.*)\/bin/
+      `rvm wrapper #{$1} yodel`
+      `which yodel_ruby`.strip
+    else
+      Config.ruby
+    end
+  end
+  
+  def assign_default_user_and_group
+    pwnam   = Etc.getpwnam(Etc.getlogin)
+    @user   = pwnam.uid
+    @group  = pwnam.gid
+  end
+  
+  def default_group
+  end
+  
+  def initialize
+    # assign default values; not all values have associated questions
+    # presented to the user depen
+    @database_hostname  = 'localhost'
+    @database_port      = 27017
+    @database_name      = 'yodel'
+    @web_port           = 80
+    @dns_port           = 2828
+    @public_directory   = '/var/www'
+    @sites_root         = default_sites_root
+    @ruby_path          = default_ruby_path
+    assign_default_user_and_group
+  end
+  
+  
+  # ----------------------------------------
+  # Helpers
+  # ----------------------------------------
+  def system_path
+    @system_path ||= File.join(File.dirname(__FILE__), '..', '..', '..', 'system')
+  end
+  
+  def report(verb, noun)
+    @h.say "<%= color('#{verb}', GREEN) %>\t#{noun}"
+  end
+  
+  def escape_quotes(str)
+    str.gsub("'", "\\\\'")
+  end
+  
+  def install(file, permissions='0644', file_name=nil)
+    if file_name
+      dest_path = File.join('/', File.dirname(file), file_name)
+    else
+      dest_path = File.join('/', file)
+    end
+    source_path = File.join(system_path, file)
+    temp_file   = Tempfile.new('yodel')
+    report('installing', dest_path)
+    
+    # render the file template
+    temp_file.write Ember::Template.new(IO.read(source_path), {source_file: source_path}).render(binding)
+    temp_file.close
+    
+    # create parent directories, copy the rendered file and set permissions
+    `sudo mkdir -p #{File.dirname(dest_path)}`
+    `sudo cp #{temp_file.path} #{dest_path}`
+    `sudo chmod #{permissions} #{dest_path}`
+    
+    # delete the temp file used for rendering
+    temp_file.unlink
+  end
+  
+  
+  # ----------------------------------------
+  # Q & A
+  # ----------------------------------------
+  def install_system_files
+    @h = h = HighLine.new
+    h.say "\n<%= color('Welcome to Yodel', BOLD) %>\n\n"
+    
+    # environment
+    h.say "<%= color('Environment', BOLD) %>"
+    h.say "Yodel can run in development (local) mode or as a production server. Press"
+    h.say "enter to setup Yodel in development mode, or enter 'production' to setup"
+    h.say "a production server."
+    @environment = h.ask("Environment: ") do |q|
+      q.default = 'development'
+      q.in = %w{development production}
+      q.responses[:ask_on_error] = :question
+    end
+    
+    # local sites directory
+    h.say "\n<%= color('1/3', RED) %> <%= color('Sites Directory', BOLD) %>"
+    h.say "Yodel stores each of your sites in a single directory. You may place this directory"
+    h.say "anywhere, but all sites created by Yodel must be accessible from it. Press enter to"
+    h.say "accept the default directory, or enter a new path."
+    @sites_root = h.ask("Sites directory: ") do |q|
+      q.default = @sites_root
+      q.responses[:ask_on_error] = :question
+    end
+    @sites_root = escape_quotes(@sites_root)
+    
+    # web server port
+    if @environment == 'development'
+      h.say "\n<%= color('2/3', RED) %> <%= color('Local Server', BOLD) %>"
+      h.say "By default the yodel server will run on port 80, meaning you can access yodel"
+      h.say "sites by visiting <http://sitename.yodel/>. If you already have Apache or"
+      h.say "another web server running on this port, enter a different port (such as 8080)"
+      @web_port = h.ask("Use port: ", Integer) do |q|
+        q.default = @web_port
+        q.responses[:ask_on_error] = :question
+      end
+    else
+      h.say "\n<%= color('2/3', RED) %> <%= color('Public Directory', BOLD) %>"
+      h.say "Yodel symlinks the public directory of sites served by the production server"
+      h.say "to a directory visible to the fronting web server. The domain of a site is"
+      h.say "used as the link name, meaning /var/www/domain.com could e.g link to"
+      h.say "/var/git/ID/public. This makes serving public assets from a fronting server"
+      h.say "possible by rewriting the request path to include the domain of the request."
+      @public_directory = h.ask("Public directory: ") do |q|
+        q.default = @public_directory
+        q.responses[:ask_on_error] = :question
+      end
+      @public_directory = escape_quotes(@public_directory)
+    end
+    
+    h.say "\n<%= color('3/3', RED) %> <%= color('Installing files', BOLD) %>"
+    h.say "Yodel will now install the necessary system files. You may be asked to enter"
+    h.say "your local user password.\n\n"
+    h.say "-----------------------------------------------------------------------------\n\n"
+    
+    # install system files
+    if `uname -a` =~ /Darwin/
+      install_mac_files
+    else
+      install_linux_files
+    end
+    
+    # start yodel for environment installation
+    report('starting', 'yodel')
+    require '../../yodel'
+    Yodel.config.extensions_folder = $extensions_folder if $extensions_folder
+    Yodel.load_extensions
+    
+    # install an environment support site
+    report('installing', "#{@environment} environment support site")
+    site = Site.new
+    site.name = "yodel"
+    site.domains = ['yodel', 'localhost', '127.0.0.1']
+    extension = Yodel.extensions["yodel_#{@environment}_environment"]
+    puts "Installation environment (#{@environment}) not found" and exit(1) if extension.nil?
+    site.root_directory = extension.lib_dir
+    site.save
+    Migration.run_migrations(site)
+    
+    h.say "\n-----------------------------------------------------------------------------"
+    h.say "\n<%= color('Installation complete', BOLD) %>"
+    h.say "Visit http://yodel#{":#{@web_port}" if @web_port != 80}/ to setup accounts you have on a remote Yodel server."
+    h.say "You can create a new site by visiting <http://sitename.yodel#{":#{@web_port}" if @web_port != 80}/> and"
+    h.say "following the instructions\n\n"
+  end
+  
+  
+  # ----------------------------------------
+  # OS X
+  # ----------------------------------------
+  def install_mac_files
+    install 'etc/resolver/yodel'
+    install 'Library/LaunchDaemons/com.yodelcms.dns.plist'
+    install 'Library/LaunchDaemons/com.yodelcms.server.plist'
+    install 'usr/local/bin/yodel_command_runner', '0777'
+    install 'var/log/yodel.log', '0666'
+    
+    case @environment
+    when 'development'
+      install 'usr/local/etc/yodel/development_settings.rb', '0644', 'settings.rb'
+    when 'production'
+      install 'usr/local/etc/yodel/production_settings.rb', '0644', 'settings.rb'
+    end
+    
+    report('starting', 'dns server')
+    if `sudo launchctl list` =~ /\d+.+com.yodelcms.dns$/
+      `sudo launchctl unload /Library/LaunchDaemons/com.yodelcms.dns.plist`
+    end
+    `sudo launchctl load /Library/LaunchDaemons/com.yodelcms.dns.plist`
+    
+    report('starting', 'web server')
+    if `sudo launchctl list` =~ /\d+.+com.yodelcms.server$/
+      `sudo launchctl unload /Library/LaunchDaemons/com.yodelcms.server.plist`
+    end
+    `sudo launchctl load /Library/LaunchDaemons/com.yodelcms.server.plist`
+  end
+  
+  
+  # ----------------------------------------
+  # Linux
+  # ----------------------------------------
+  def install_linux_files
+    install 'usr/local/bin/yodel_command_runner', '0777'
+    install 'var/log/yodel.log', '0666'
+    
+    case @environment
+    when 'development'
+      install 'usr/local/etc/yodel/development_settings.rb', '0644', 'settings.rb'
+    when 'production'
+      install 'usr/local/etc/yodel/production_settings.rb', '0644', 'settings.rb'
+    end
+  end
+end

data/lib/yodel/config/config.rb

@@ -0,0 +1,30 @@
+Dir.chdir(File.dirname(__FILE__)) do
+  require './environment'
+  require './yodel'
+end
+
+class YodelConfig
+  def initialize
+    @options = {
+      'yodel_migration_directory' => File.join(File.dirname(__FILE__), '..', 'models', 'migrations'),
+      'public_directories' => [File.join(File.dirname(__FILE__), '..', 'public')],
+      'layout_directories' => [],
+      'extensions' => []
+    }
+  end
+  
+  def method_missing(method, *args)
+    method = method.to_s
+    if method[-1] == '='
+      @options[method[0...-1]] = args[0]
+    elsif method[-1] == '?'
+      @options.has_key?(method[0...-1])
+    else
+      @options[method]
+    end
+  end
+  
+  def define(&block)
+    yield self
+  end
+end

data/lib/yodel/config/environment.rb

@@ -0,0 +1,16 @@
+class Environment
+  def initialize
+    @env = ENV['YODEL_ENV'] || 'development'
+  end
+  
+  def method_missing(sym, *args)
+    sym = sym.to_s
+    if sym.end_with?('!')
+      @env = sym[0..-2]
+    elsif sym.end_with?('?')
+      @env == sym[0..-2]
+    else
+      super
+    end
+  end
+end

data/lib/yodel/config/yodel.rb

@@ -0,0 +1,21 @@
+module Yodel
+  MODELS_DIRECTORY_NAME               = 'models'
+  PUBLIC_DIRECTORY_NAME               = 'public'
+  LAYOUTS_DIRECTORY_NAME              = 'layouts'
+  PARTIALS_DIRECTORY_NAME             = 'partials'
+  MIGRATIONS_DIRECTORY_NAME           = 'migrations'
+  ATTACHMENTS_DIRECTORY_NAME          = 'attachments'
+  EXTENSION_LIB_DIRECTORY_NAME        = 'lib'
+  YODEL_MIGRATIONS_DIRECTORY_NAME     = 'yodel'
+  EXTENSION_MIGRATIONS_DIRECTORY_NAME = 'extensions'
+  SITE_MIGRATIONS_DIRECTORY_NAME      = 'site'
+  SITE_YML_FILE_NAME                  = 'site.yml'
+  
+  def self.config
+    @config ||= YodelConfig.new
+  end
+  
+  def self.env
+    @env ||= Environment.new
+  end
+end

data/lib/yodel/exceptions/destroyed_record.rb

@@ -0,0 +1,2 @@
+class DestroyedRecord < StandardError
+end

data/lib/yodel/exceptions/domain_not_found.rb

@@ -0,0 +1,16 @@
+class DomainNotFound < StandardError
+  attr_reader :domain
+  def initialize(domain, port)
+    @domain = domain
+    @port = (port == 80 ? nil : port)
+    super()
+  end
+  
+  def error
+    ["The site '#{@domain.gsub('.yodel', '')}' has not been created yet"]
+  end
+  
+  def description
+    "<form action='http://yodel#{':' if @port}#{@port}/sites' method='post' class='inline'><input type='hidden' name='name'' value='#{@domain}'><a href='#' onclick='submit()'>Create a new site</a></form> or try a different address."
+  end
+end

data/lib/yodel/exceptions/duplicate_layout.rb

@@ -0,0 +1,2 @@
+class DuplicateLayout < StandardError
+end

data/lib/yodel/exceptions/exceptions.rb

@@ -0,0 +1,3 @@
+Dir[File.join(File.dirname(__FILE__), '*.rb')].each do |path|
+  require path
+end

data/lib/yodel/exceptions/inconsistent_lock_state.rb

@@ -0,0 +1,2 @@
+class InconsistentLockState < StandardError
+end

data/lib/yodel/exceptions/invalid_field.rb

@@ -0,0 +1,2 @@
+class InvalidField < StandardError
+end

data/lib/yodel/exceptions/invalid_index.rb

@@ -0,0 +1,2 @@
+class InvalidIndex < StandardError
+end

data/lib/yodel/exceptions/invalid_mixin.rb

@@ -0,0 +1,2 @@
+class InvalidMixin < StandardError
+end

data/lib/yodel/exceptions/invalid_model_field.rb

@@ -0,0 +1,2 @@
+class InvalidModelField < StandardError
+end

data/lib/yodel/exceptions/layout_not_found.rb

@@ -0,0 +1,2 @@
+class LayoutNotFound < StandardError
+end

data/lib/yodel/exceptions/mass_assignment.rb

@@ -0,0 +1,2 @@
+class MassAssignment < StandardError
+end

data/lib/yodel/exceptions/missing_migration.rb

@@ -0,0 +1,2 @@
+class MissingMigration < StandardError
+end

data/lib/yodel/exceptions/missing_root_directory.rb

@@ -0,0 +1,15 @@
+class MissingRootDirectory < StandardError
+  def initialize(site, port)
+    @port = (port == 80 ? nil : port)
+    @site = site
+    super()
+  end
+  
+  def error
+    ["The root directory for #{@site.name} is missing"]
+  end
+  
+  def description
+    "You can <a href='http://yodel#{':' if @port}#{@port}/sites?id=#{@site.id}'>select a new root directory</a>, or rename the existing directory back to '#{File.basename(@site.root_directory)}'."
+  end
+end

data/lib/yodel/exceptions/unable_to_acquire_lock.rb

@@ -0,0 +1,2 @@
+class UnableToAcquireLock < StandardError
+end

data/lib/yodel/exceptions/unauthorised.rb

@@ -0,0 +1,2 @@
+class Unauthorised < StandardError
+end

data/lib/yodel/exceptions/unknown_field.rb

@@ -0,0 +1,2 @@
+class UnknownField < StandardError
+end

data/lib/yodel/middleware/development_server.rb

@@ -0,0 +1,180 @@
+require 'rack/utils'
+require 'rack/mime'
+require 'thread'
+
+class StreamClosed < StandardError
+end
+
+class DevelopmentServer
+  SEPARATORS = Regexp.union(*[::File::SEPARATOR, ::File::ALT_SEPARATOR].compact)
+  
+  class Message
+    attr_accessor :status, :headers, :body, :env, :data, :message_type
+    MESSAGE_TYPES = {request: 0, response: 1, restart: 2, exit: 3}
+    
+    def request?; @message_type == :request; end
+    def response?; @message_type == :response; end
+    def restart?; @message_type == :restart; end
+    def exit?; @message_type == :exit; end
+    
+    def initialize(message_type)
+      @message_type = message_type
+    end
+    
+    def self.read(socket)
+      message = Message.new(nil)
+      message.message_type = MESSAGE_TYPES.keys[read_int(socket)]
+      
+      if message.request? || message.response?
+        length = read_int(socket)
+        message.data = Marshal.load(socket.read(length))
+        
+        if message.request?
+          message.data['rack.input'] = StringIO.new(message.data['rack.input'])
+          message.data['rack.errors'] = STDERR
+        elsif message.response?
+          message.data[2] = [message.data[2]]
+        end
+      end
+      
+      message
+    end
+    
+    def write(socket)
+      write_int(MESSAGE_TYPES[@message_type], socket)
+      payload = nil
+      
+      if request?
+        # convert input (StringIO) to a normal string, and
+        # remove the reference to STDERR for transmission
+        @env['rack.input'] = @env['rack.input'].read if @env['rack.input'].is_a?(StringIO)
+        @env['rack.errors'] = nil
+        payload = Marshal.dump(@env)
+      elsif response?
+        body = ''
+        @body.each {|chunk| body << chunk.to_s}
+        payload = Marshal.dump([@status, @headers, body])
+      end
+      
+      if payload
+        write_int(payload.length, socket)
+        socket.write(payload)
+      end
+    end
+    
+    private
+      def self.read_int(socket)
+        int = socket.read(4)
+        raise StreamClosed if int.nil?
+        int.unpack('L').first
+      end
+      
+      def write_int(int, socket)
+        socket.write([int].pack('L'))
+      end
+  end
+  
+  def initialize
+    spawn_server
+    @mutex = Mutex.new
+    @pid = nil
+    Signal.trap("SIGTERM") do
+      self.kill_child
+      Process.kill("SIGINT", Process.pid)
+    end
+  end
+  
+  def kill_child
+    begin
+      Process.kill("SIGTERM", @pid) if @pid
+      @pid = nil
+      @client_socket.close
+    rescue
+    end
+  end
+  
+  def call(env)
+    @mutex.lock
+    parts = Rack::Utils.unescape(env["PATH_INFO"]).split(SEPARATORS)
+    return [403, {"Content-Type" => "text/plain"}, "Forbidden"] if parts.include? ".."
+    
+    # pass the request through to a yodel server. if the server
+    # responds with a restart message (yodel source files have
+    # changed and need to be re-loaded) spawn a new server and
+    # write the request again (assume the request is successful)
+    request = Message.new(:request)
+    request.env = env
+    request.write(@client_socket)
+    response = Message.read(@client_socket)
+    
+    if response.restart?
+      spawn_server
+      request.write(@client_socket)
+      response = Message.read(@client_socket)
+    end
+    
+    # response data is a valid rack response
+    response.data
+  ensure
+    @mutex.unlock
+  end
+  
+  protected
+    def spawn_server
+      # http requests are passed between the client (development server)
+      # and the server (yodel server) over a socket pair. Pipe's aren't
+      # used because the server may be forked for a long time and respond
+      # to multiple requests before being reaped
+      @client_socket.close unless @client_socket.nil?
+      @client_socket, @server_socket = UNIXSocket.pair
+      
+      # child process loads yodel and responds to the request; if any
+      # source files have been modified since the server was started, send
+      # a restart message to the client and exit
+      @pid = Process.fork
+      if @pid.nil?
+        @client_socket.close
+        require File.join(File.dirname(__FILE__), '..', '..', 'yodel')
+        closed = false
+        
+        @application = Application.new
+        @modification_times = $LOADED_FEATURES.each_with_object({}) do |path, mtimes|
+          mtimes[path] = File.mtime(path) if File.exist?(path)
+        end
+        
+        loop do
+          begin
+            # block until a new request is received
+            request = Message.read(@server_socket)
+          
+            # check for modified files
+            @modification_times.each do |path, modified_time|
+              if File.exist?(path) && File.mtime(path) > modified_time
+                message = Message.new(:restart)
+                message.write(@server_socket)
+                @server_socket.close
+                closed = true
+                break
+              end
+            end
+          
+            # kill the server if a file was changed
+            break if closed
+          
+            # otherwise respond to the request
+            if request.request?
+              response = Message.new(:response)
+              response.status, response.headers, response.body = @application.call(request.data)
+              response.write(@server_socket)
+            end
+          rescue Interrupt, StreamClosed
+            exit
+          end
+        end
+      
+      else
+        Process.detach(@pid)
+        @server_socket.close
+      end
+    end
+end