# frozen_string_literal: true
# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
require 'async/container/controller'
module Falcon
module Controller
# A controller which mananages several virtual hosts.
# Spawns instances of {Proxy} and {Redirect} to handle incoming requests.
#
# A virtual host is an application bound to a specific authority (essentially a hostname). The virtual controller manages multiple hosts and allows a single server to host multiple applications easily.
class Virtual < Async::Container::Controller
# Initialize the virtual controller.
# @parameter command [Command::Virtual] The user-specified command-line options.
def initialize(command, **options)
@command = command
super(**options)
trap(SIGHUP, &self.method(:reload))
end
# Drop privileges according to the user and group of the specified path.
# @parameter path [String] The path to the application directory.
def assume_privileges(path)
stat = File.stat(path)
Process::GID.change_privilege(stat.gid)
Process::UID.change_privilege(stat.uid)
home = Etc.getpwuid(stat.uid).dir
return {
'HOME' => home,
}
end
# Spawn an application instance from the specified path.
# @parameter path [String] The path to the application directory.
# @parameter container [Async::Container::Generic] The container to spawn into.
# @parameter options [Options] The options which are passed to `exec`.
def spawn(path, container, **options)
container.spawn(name: "Falcon Application", restart: true, key: path) do |instance|
env = assume_privileges(path)
instance.exec(env,
"bundle", "exec", "--keep-file-descriptors",
path, ready: false, **options)
end
end
# The path to the falcon executable from this gem.
# @returns [String]
def falcon_path
File.expand_path("../../../bin/falcon", __dir__)
end
# Setup the container with {Redirect} and {Proxy} child processes.
# These processes are gracefully restarted if they are already running.
# @parameter container [Async::Container::Generic]
def setup(container)
if proxy = container[:proxy]
proxy.kill(:HUP)
end
if redirect = container[:redirect]
redirect.kill(:HUP)
end
container.reload do
@command.resolved_paths do |path|
path = File.expand_path(path)
root = File.dirname(path)
spawn(path, container, chdir: root)
end
container.spawn(name: "Falcon Redirector", restart: true, key: :redirect) do |instance|
instance.exec(falcon_path, "redirect",
"--bind", @command.bind_insecure,
"--timeout", @command.timeout.to_s,
"--redirect", @command.bind_secure,
*@command.paths, ready: false
)
end
container.spawn(name: "Falcon Proxy", restart: true, key: :proxy) do |instance|
instance.exec(falcon_path, "proxy",
"--bind", @command.bind_secure,
"--timeout", @command.timeout.to_s,
*@command.paths, ready: false
)
end
end
end
end
end
end