282 lines
11 KiB
Ruby
282 lines
11 KiB
Ruby
# Phusion Passenger - https://www.phusionpassenger.com/
|
|
# Copyright (c) 2013-2025 Asynchronous B.V.
|
|
#
|
|
# "Passenger", "Phusion Passenger" and "Union Station" are registered
|
|
# trademarks of Asynchronous B.V.
|
|
#
|
|
# 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 'optparse'
|
|
require 'net/http'
|
|
require 'socket'
|
|
require 'json'
|
|
PhusionPassenger.require_passenger_lib 'constants'
|
|
PhusionPassenger.require_passenger_lib 'admin_tools/instance_registry'
|
|
PhusionPassenger.require_passenger_lib 'config/command'
|
|
PhusionPassenger.require_passenger_lib 'config/utils'
|
|
PhusionPassenger.require_passenger_lib 'utils/json'
|
|
PhusionPassenger.require_passenger_lib 'utils/ansi_colors'
|
|
PhusionPassenger.require_passenger_lib 'utils/terminal_choice_menu'
|
|
|
|
module PhusionPassenger
|
|
module Config
|
|
|
|
class RestartAppCommand < Command
|
|
include PhusionPassenger::Config::Utils
|
|
|
|
def run
|
|
parse_options
|
|
select_passenger_instance
|
|
select_app_group_name
|
|
perform_restart
|
|
end
|
|
|
|
private
|
|
def self.create_option_parser(options)
|
|
OptionParser.new do |opts|
|
|
nl = "\n" + ' ' * 37
|
|
opts.banner =
|
|
"Usage 1: passenger-config restart-app <APP PATH PREFIX> [OPTIONS]\n" +
|
|
"Usage 2: passenger-config restart-app . [OPTIONS]\n" +
|
|
"Usage 3: passenger-config restart-app --name <APP GROUP NAME> [OPTIONS]"
|
|
opts.separator ""
|
|
opts.separator " Restart an application. The syntax determines how the application that is to"
|
|
opts.separator " be restarted, will be selected."
|
|
opts.separator ""
|
|
opts.separator " 1. Selects all applications whose paths begin with the given prefix."
|
|
opts.separator ""
|
|
opts.separator " Example: passenger-config restart-app /webapps"
|
|
opts.separator " Restarts all apps whose path begin with /webapps, such as /webapps/foo,"
|
|
opts.separator " /webapps/bar and /webapps123."
|
|
opts.separator ""
|
|
opts.separator " 2. Selects all application whose paths fall under the current working"
|
|
opts.separator " directory."
|
|
opts.separator " Example: passenger-config restart-app ."
|
|
opts.separator " If the current working directory is /webapps, restarts all apps whose path"
|
|
opts.separator " begin with /webapps, such as /webapps/foo, /webapps/bar and /webapps123."
|
|
opts.separator ""
|
|
opts.separator " 3. Selects a specific application based on an exact match of its app group"
|
|
opts.separator " name."
|
|
opts.separator ""
|
|
opts.separator " Example: passenger-config restart-app --name /webapps/foo"
|
|
opts.separator " Restarts only /webapps/foo, but not for example /webapps/foo/bar or"
|
|
opts.separator " /webapps/foo123."
|
|
opts.separator ""
|
|
|
|
opts.separator "Options:"
|
|
opts.on("--name APP_GROUP_NAME", String, "The app group name to select") do |value|
|
|
options[:app_group_name] = value
|
|
end
|
|
opts.on("--rolling-restart", "Perform a rolling restart instead of a#{nl}" +
|
|
"regular restart (Enterprise only). The#{nl}" +
|
|
"default is a blocking restart") do |value|
|
|
if Config::Utils.is_enterprise?
|
|
options[:rolling_restart] = true
|
|
else
|
|
abort "--rolling-restart is only available in #{PROGRAM_NAME} Enterprise: #{ENTERPRISE_URL}"
|
|
end
|
|
end
|
|
opts.on("--ignore-app-not-running", "Exit successfully if the specified#{nl}" +
|
|
"application is not currently running. The#{nl}" +
|
|
"default is to exit with an error") do
|
|
options[:ignore_app_not_running] = true
|
|
end
|
|
opts.on("--ignore-passenger-not-running", "Exit successfully if #{PROGRAM_NAME}#{nl}" +
|
|
"is not currently running. The default is to#{nl}" +
|
|
"exit with an error") do
|
|
options[:ignore_passenger_not_running] = true
|
|
end
|
|
opts.on("--instance NAME", String, "The #{PROGRAM_NAME} instance to select") do |value|
|
|
options[:instance] = value
|
|
end
|
|
opts.on("-h", "--help", "Show this help") do
|
|
options[:help] = true
|
|
end
|
|
end
|
|
end
|
|
|
|
def help
|
|
puts @parser
|
|
end
|
|
|
|
def parse_options
|
|
super
|
|
case @argv.size
|
|
when 0
|
|
if !@options[:app_group_name] && !STDIN.tty?
|
|
abort "Please pass either an app path prefix or an app group name. " +
|
|
"See --help for more information."
|
|
end
|
|
when 1
|
|
if @options[:app_group_name]
|
|
abort "You've passed an app path prefix, but you cannot also pass an " +
|
|
"app group name. Please use only either one of them. See --help " +
|
|
"for more information."
|
|
end
|
|
else
|
|
help
|
|
abort
|
|
end
|
|
end
|
|
|
|
def select_app_group_name
|
|
@groups = []
|
|
if app_group_name = @options[:app_group_name]
|
|
select_app_group_name_exact(app_group_name)
|
|
elsif @argv.empty?
|
|
# STDIN is guaranteed to be a TTY thanks to the check in #parse_options.
|
|
select_app_group_name_interactively
|
|
else
|
|
select_app_group_name_by_app_root_regex(@argv.first)
|
|
end
|
|
end
|
|
|
|
def select_app_group_name_exact(name)
|
|
query_pool_json.each do |group|
|
|
if group[:name] == name
|
|
@groups << group
|
|
end
|
|
end
|
|
if @groups.empty?
|
|
abort_app_not_found "There is no #{PROGRAM_NAME}-served application running " +
|
|
"with the app group name '#{name}'."
|
|
end
|
|
end
|
|
|
|
def query_group_names
|
|
result = []
|
|
query_pool_json.each do |group|
|
|
result << group[:name]
|
|
end
|
|
result << "Cancel"
|
|
result
|
|
end
|
|
|
|
def select_app_group_name_interactively
|
|
colors = PhusionPassenger::Utils::AnsiColors.new
|
|
|
|
choices = query_group_names
|
|
if choices.size == 1
|
|
# No running apps
|
|
abort_app_not_found "#{PROGRAM_NAME} is currently not serving any applications."
|
|
end
|
|
|
|
puts "Please select the application to restart."
|
|
puts colors.ansi_colorize("<gray>Tip: re-run this command with --help to learn how to automate it.</gray>")
|
|
puts colors.ansi_colorize("<dgray>If the menu doesn't display correctly, press '!'</dgray>")
|
|
puts
|
|
menu = PhusionPassenger::Utils::TerminalChoiceMenu.new(choices, :single_choice)
|
|
begin
|
|
index, name = menu.query
|
|
rescue Interrupt
|
|
abort
|
|
ensure
|
|
STDOUT.write(colors.reset)
|
|
STDOUT.flush
|
|
end
|
|
|
|
if index == choices.size - 1
|
|
abort
|
|
else
|
|
puts
|
|
select_app_group_name_exact(name)
|
|
end
|
|
end
|
|
|
|
def select_app_group_name_by_app_root_regex(app_root)
|
|
if app_root == "."
|
|
app_root = Dir.pwd
|
|
end
|
|
regex = /^#{Regexp.escape(app_root)}/
|
|
query_pool_json.each do |group|
|
|
if group[:app_root] =~ regex
|
|
@groups << group
|
|
end
|
|
end
|
|
if @groups.empty?
|
|
abort_app_not_found "There are no #{PROGRAM_NAME}-served applications running " +
|
|
"whose paths begin with '#{app_root}'."
|
|
end
|
|
end
|
|
|
|
def perform_restart
|
|
restart_method = @options[:rolling_restart] ? "rolling" : "blocking"
|
|
@groups.each do |group|
|
|
group_name = group[:name]
|
|
puts "Restarting #{group_name}"
|
|
request = Net::HTTP::Post.new("/pool/restart_app_group.json")
|
|
try_performing_full_admin_basic_auth(request, @instance)
|
|
request.content_type = "application/json"
|
|
request.body = PhusionPassenger::Utils::JSON.generate(
|
|
:name => group_name,
|
|
:restart_method => restart_method)
|
|
response = @instance.http_request("agents.s/core_api", request)
|
|
if response.code.to_i / 100 == 2
|
|
response.body
|
|
elsif response.code.to_i == 401
|
|
print_full_admin_command_permission_error
|
|
abort
|
|
else
|
|
STDERR.puts "*** An error occured while communicating with the #{PROGRAM_NAME} server:"
|
|
STDERR.puts response.body
|
|
abort
|
|
end
|
|
end
|
|
end
|
|
|
|
def abort_app_not_found(message)
|
|
if @options[:ignore_app_not_running]
|
|
STDERR.puts(message)
|
|
exit
|
|
else
|
|
abort(message)
|
|
end
|
|
end
|
|
|
|
def query_pool_json
|
|
request = Net::HTTP::Get.new("/pool.json")
|
|
try_performing_ro_admin_basic_auth(request, @instance)
|
|
response = @instance.http_request("agents.s/core_api", request)
|
|
if response.code.to_i / 100 == 2
|
|
if RUBY_VERSION >= '2.3'
|
|
JSON.parse(response.body, symbolize_names: true).to_a.map{|(key,value)| {name: key.to_s, app_root: value.dig(:app_root,0,:value)}}
|
|
else
|
|
JSON.parse(response.body, symbolize_names: true).to_a.map{|(key,value)| {name: key.to_s, app_root: value[:app_root][0][:value]}}
|
|
end
|
|
elsif response.code.to_i == 401
|
|
if response["pool-empty"] == "true"
|
|
[]
|
|
elsif @options[:ignore_app_not_running]
|
|
print_instance_querying_permission_error
|
|
exit
|
|
else
|
|
print_instance_querying_permission_error
|
|
abort
|
|
end
|
|
else
|
|
STDERR.puts "*** An error occured while querying the #{PROGRAM_NAME} server:"
|
|
STDERR.puts response.body
|
|
abort
|
|
end
|
|
end
|
|
end
|
|
|
|
end # module Config
|
|
end # module PhusionPassenger
|