passenger 5.1.10 → 5.1.11

data/src/ruby_supportlib/phusion_passenger/config/api_call_command.rb

@@ -94,7 +94,7 @@ module PhusionPassenger
           opts.on("-a", "--agent NAME", String, "The name of the socket to send the command#{nl}" +
             "to. This specifies which agent the request#{nl}" +
             "is sent to. Choices: watchdog_api,#{nl}" +
-            "core_api, ust_router_api.#{nl}" +
+            "core_api.#{nl}" +
             "Default: core_api") do |val|
             options[:agent_name] = val
           end

data/src/ruby_supportlib/phusion_passenger/config/reopen_logs_command.rb

@@ -71,7 +71,6 @@ module PhusionPassenger
       def perform_reopen_logs
         perform_reopen_logs_on("watchdog", "watchdog_api")
         perform_reinherit_logs_on("core", "core_api")
-        perform_reinherit_logs_on("UstRouter", "ust_router_api")
         if using_standalone_nginx_engine?
           perform_reopen_logs_on_nginx
         end

data/src/ruby_supportlib/phusion_passenger/config/validate_install_command.rb

@@ -379,7 +379,12 @@ module PhusionPassenger
         checking "whether Apache is installed"
 
         if PlatformInfo.httpd
-          if PlatformInfo.apxs2
+          # macOS >= 10.13 High Sierra no longer includes apxs2, but that's
+          # okay because we know Apache is installed
+          if PlatformInfo.apxs2 ||
+            (PlatformInfo.os_name_simple == 'macosx' &&
+             PlatformInfo.os_version >= '10.13' &&
+             PlatformInfo.httpd == '/usr/sbin/httpd')
             check_ok
             true
           else
@@ -436,7 +441,9 @@ module PhusionPassenger
             You are about to validate #{PROGRAM_NAME} against the following
             Apache installation:
 
-               apxs2: #{PlatformInfo.apxs2}
+               apxs2     : #{PlatformInfo.apxs2 || 'OS-provided installation'}
+               Executable: #{PlatformInfo.httpd || 'unknown'}
+               Version   : #{PlatformInfo.httpd_version || 'unknown'}
 
             However, this Apache installation appears to be broken, so this program
             cannot continue. To find out why this program thinks the above Apache
@@ -567,7 +574,7 @@ module PhusionPassenger
               for Apache is not installed or not active. Please run the
               #{PROGRAM_NAME} Apache module installer:
 
-                 #{ruby_command} #{installer_command} --apxs2=#{PlatformInfo.apxs2}
+                 #{ruby_command} #{installer_command} --apxs2=#{PlatformInfo.apxs2 || 'none'}
             }
           end
         else

data/src/ruby_supportlib/phusion_passenger/console_text_template.rb

@@ -33,7 +33,9 @@ module PhusionPassenger
       @buffer = ''
       if input[:file]
         filename = "#{PhusionPassenger.resources_dir}/templates/#{input[:file]}.txt.erb"
-        data = File.read(filename)
+        data = File.open(filename, 'r:utf-8') do |f|
+          f.read
+        end
       else
         data = input[:text]
       end

data/src/ruby_supportlib/phusion_passenger/constants.rb

@@ -72,7 +72,6 @@ module PhusionPassenger
     DEFAULT_UNION_STATION_GATEWAY_ADDRESS = "gateway.unionstationapp.com"
     DEFAULT_UNION_STATION_GATEWAY_PORT = 443
     DEFAULT_HTTP_SERVER_LISTEN_ADDRESS = "tcp://127.0.0.1:3000"
-    DEFAULT_UST_ROUTER_LISTEN_ADDRESS = "tcp://127.0.0.1:9344"
     DEFAULT_LVE_MIN_UID = 500
 
     # Size limits

data/src/ruby_supportlib/phusion_passenger/debug_logging.rb

@@ -112,7 +112,7 @@ module PhusionPassenger
           output = @@stderr_evaluator.call
         end
         location = caller[nesting_level].sub(/.*phusion_passenger\//, '')
-        location.sub!(/(.*):.*/, '\1')
+        location.sub!(/(.*?):.*/, '\1')
         now = Time.now
         time_str = now.strftime("%Y-%m-%d %H:%M:%S.")
         time_str << sprintf("%04d", now.usec / 100)

data/src/ruby_supportlib/phusion_passenger/loader_shared_helpers.rb

@@ -27,6 +27,8 @@ PhusionPassenger.require_passenger_lib 'constants'
 PhusionPassenger.require_passenger_lib 'public_api'
 PhusionPassenger.require_passenger_lib 'ruby_core_enhancements'
 PhusionPassenger.require_passenger_lib 'debug_logging'
+PhusionPassenger.require_passenger_lib 'platform_info/ruby'
+PhusionPassenger.require_passenger_lib 'platform_info/operating_system'
 PhusionPassenger.require_passenger_lib 'utils/shellwords'
 
 module PhusionPassenger
@@ -42,7 +44,8 @@ module PhusionPassenger
       # unlikely to be changed.
       dump_ruby_environment
       check_rvm_using_wrapper_script(options)
-      return sanitize_spawn_options(options)
+      load_macos_foundation
+      sanitize_spawn_options(options)
     end
 
     def check_rvm_using_wrapper_script(options)
@@ -78,6 +81,29 @@ module PhusionPassenger
       puts
     end
 
+    def load_macos_foundation
+      # Apple added an assertion in 10.13 that prevents anything Obj-C related
+      # from occuring between fork and exec. This workaround prevents the assertion.
+      # http://www.sealiesoftware.com/blog/archive/2017/6/5/Objective-C_and_fork_in_macOS_1013.html
+      # https://github.com/puma/puma/issues/1421
+      if PlatformInfo::RUBY_ENGINE == 'ruby' && PlatformInfo.os_name_simple == "macosx"
+        # Eager-load Foundation.framework, to ensure the Objective-C runtime
+        # exists well before any forking happens
+        begin
+          require 'fiddle'
+        rescue LoadError
+          return
+        end
+        if Fiddle.respond_to?(:dlopen)
+          begin
+            Fiddle.dlopen '/System/Library/Frameworks/Foundation.framework/Foundation'
+          rescue Fiddle::DLError => e
+            STDERR.puts "WARNING: #{e}"
+          end
+        end
+      end
+    end
+
     def to_boolean(value)
       return !(value.nil? || value == false || value == "false")
     end
@@ -267,8 +293,8 @@ module PhusionPassenger
         require File.expand_path('config/setup_load_paths')
 
       # Older versions of Bundler use .bundle/environment.rb as the Bundler
-      # environment lock file. This has been replaced by Gemfile.lock in later
-      # versions, but we still support the older mechanism.
+      # environment lock file. This has been replaced by Gemfile.lock/gems.locked
+      # in later versions, but we still support the older mechanism.
       # If the Bundler environment lock file exists then load that. If it
       # exists then there's a 99.9% chance that loading it is the correct
       # thing to do.
@@ -284,9 +310,9 @@ module PhusionPassenger
       #    or the gems are not locked. In either case, we're supposed to call
       #    Bundler.setup.
       #
-      # The existence of Gemfile indicates whether (2) is true:
-      elsif File.exist?('Gemfile')
-        # In case of Rails 3, config/boot.rb already calls Bundler.setup.
+      # The existence of Gemfile/gems.rb indicates whether (2) is true:
+      elsif File.exist?('Gemfile') || File.exist?('gems.rb')
+        # In case of Rails 3+, config/boot.rb already calls Bundler.setup.
         # However older versions of Rails may not so loading boot.rb might
         # not be the correct thing to do. To be on the safe side we
         # call Bundler.setup ourselves; calling Bundler.setup twice is

data/src/ruby_supportlib/phusion_passenger/nginx/config_options.rb

@@ -116,7 +116,6 @@ LOCATION_CONFIGURATION_OPTIONS = [
   },
   {
     :name     => 'passenger_enabled',
-    :context  => [:srv, :loc, :lif],
     :type     => :flag,
     :function => 'passenger_enabled',
     :field    => 'enabled',

data/src/ruby_supportlib/phusion_passenger/packaging.rb

@@ -27,10 +27,7 @@ module PhusionPassenger
   module Packaging
     # Files that must be generated before packaging.
     PREGENERATED_FILES = [
-      'src/cxx_supportlib/Constants.h',
-      'doc/Packaging.html',
-      'doc/CloudLicensingConfiguration.html',
-      'doc/ServerOptimizationGuide.html'
+      'src/cxx_supportlib/Constants.h'
     ]
 
     USER_EXECUTABLES = [
@@ -90,6 +87,7 @@ module PhusionPassenger
       '.github/*',
       '.settings/*',
       '.externalToolBuilders/*',
+      '.vscode/*',
       '.cproject',
       '.project',
       'Gemfile',

data/src/ruby_supportlib/phusion_passenger/platform_info/apache.rb

@@ -48,7 +48,17 @@ module PhusionPassenger
     # The absolute path to the 'apxs' or 'apxs2' executable, or nil if not found.
     def self.apxs2
       if env_defined?("APXS2")
-        return ENV["APXS2"]
+        if ENV['APXS2'] == 'none'
+          # This is a special value indicating that we should pretend as if
+          # apxs2 is not found. It is applicable when the user is running
+          # macOS >= 10.13 High Sierra, where apxs2 is not included in the OS.
+          # When the user runs 'passenger-config about detect-apache2',
+          # that command will tell the way to install against this specific
+          # Apache is to run passenger-install-apache2-module --apxs2-path='none'
+          return nil
+        else
+          return ENV["APXS2"]
+        end
       end
       ['apxs2', 'apxs'].each do |name|
         command = find_command(name)
@@ -70,7 +80,7 @@ module PhusionPassenger
     # The absolute path to the Apache binary (that is, 'httpd', 'httpd2', 'apache'
     # or 'apache2'), or nil if not found.
     def self.httpd(options = {})
-      apxs2 = options[:apxs2] || self.apxs2
+      apxs2 = options.fetch(:apxs2, self.apxs2)
       if env_defined?('HTTPD')
         return ENV['HTTPD']
       elsif apxs2.nil?
@@ -401,36 +411,42 @@ module PhusionPassenger
 
     # The absolute path to the 'a2enmod' executable.
     def self.a2enmod(options = {})
-      apxs2 = options[:apxs2] || self.apxs2
-      dir = File.dirname(apxs2)
+      apxs2 = options.fetch(:apxs2, self.apxs2)
+      dir = File.dirname(apxs2) if apxs2
       # a2enmod is supposed to be a Debian extension that only works
       # on the APT-installed Apache, so only return non-nil if we're
       # working against the APT-installed Apache.
       if dir == "/usr/bin" || dir == "/usr/sbin"
         if env_defined?('A2ENMOD')
+          log "Using $A2ENMOD (= #{ENV['A2ENMOD']})"
           return ENV['A2ENMOD']
         else
           return find_apache2_executable("a2enmod", options)
         end
       else
-        return nil
+        log "Not applicable"
+        nil
       end
     end
     memoize :a2enmod
 
     # The absolute path to the 'a2enmod' executable.
     def self.a2dismod(options = {})
-      apxs2 = options[:apxs2] || self.apxs2
-      dir = File.dirname(apxs2)
+      apxs2 = options.fetch(:apxs2, self.apxs2)
+      dir = File.dirname(apxs2) if apxs2
       # a2dismod is supposed to be a Debian extension that only works
       # on the APT-installed Apache, so only return non-nil if we're
       # working against the APT-installed Apache.
       if dir == "/usr/bin" || dir == "/usr/sbin"
         if env_defined?('A2DISMOD')
+          log "Using $A2DISMOD (= #{ENV['A2DISMOD']})"
           return ENV['A2DISMOD']
         else
           return find_apache2_executable("a2dismod", options)
         end
+      else
+        log "Not applicable"
+        nil
       end
     end
     memoize :a2dismod
@@ -527,9 +543,16 @@ module PhusionPassenger
 
     # The absolute path to the Apache 2 'bin' directory, or nil if unknown.
     def self.apache2_bindir(options = {})
-      apxs2 = options[:apxs2] || self.apxs2
+      apxs2 = options.fetch(:apxs2, self.apxs2)
       if apxs2.nil?
-        return nil
+        # macOS >= 10.13 High Sierra no longer ships apxs2, so we'll use
+        # a hardcoded default.
+        if os_name_simple == 'macosx' && os_version >= '10.13' \
+          && httpd(:apxs2 => apxs2) == '/usr/sbin/httpd'
+          '/usr/bin'
+        else
+          nil
+        end
       else
         return `#{apxs2} -q BINDIR 2>/dev/null`.strip
       end
@@ -538,9 +561,16 @@ module PhusionPassenger
 
     # The absolute path to the Apache 2 'sbin' directory, or nil if unknown.
     def self.apache2_sbindir(options = {})
-      apxs2 = options[:apxs2] || self.apxs2
+      apxs2 = options.fetch(:apxs2, self.apxs2)
       if apxs2.nil?
-        return nil
+        # macOS >= 10.13 High Sierra no longer ships apxs2, so we'll use
+        # a hardcoded default.
+        if os_name_simple == 'macosx' && os_version >= '10.13' \
+          && httpd(:apxs2 => apxs2) == '/usr/sbin/httpd'
+          '/usr/sbin'
+        else
+          nil
+        end
       else
         return `#{apxs2} -q SBINDIR`.strip
       end
@@ -578,7 +608,14 @@ module PhusionPassenger
           flags << apu_cxxflags
         end
       end
-      if !apxs2.nil?
+      if apxs2.nil?
+        # macOS >= 10.13 High Sierra no longer includes apxs2
+        # so we'll use hardcoded paths here.
+        if os_name_simple == 'macosx' && os_version >= '10.13' && httpd == '/usr/sbin/httpd'
+          xcode_prefix = `/usr/bin/xcode-select -p`.strip
+          flags << "-I#{xcode_prefix}/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/include/apache2"
+        end
+      else
         apxs2_flags = `#{apxs2} -q CFLAGS`.strip << " -I" << `#{apxs2} -q INCLUDEDIR`.strip
         apxs2_flags.gsub!(/-O\d? /, '')
 
@@ -613,6 +650,12 @@ module PhusionPassenger
         # https://github.com/phusion/passenger/issues/1756
         apxs2_flags.gsub!('-pie', '')
 
+        # macOS >= 10.12 Sierra no longer includes apr-config
+        # so we'll use a hardcoded path here.
+        if os_name_simple == 'macosx' && os_version >= '10.12' && httpd == '/usr/sbin/httpd'
+          apxs2_flags << ' -I/usr/include/apr-1'
+        end
+
         apxs2_flags.strip!
         flags << apxs2_flags
       end
@@ -728,24 +771,54 @@ module PhusionPassenger
 
     ################ Miscellaneous information ################
 
+    # Returns whether it is necessary to use information outputted by 'apxs2'
+    # in order to compile an Apache module.
+    #
+    # Since macOS 10.13 High Sierra apxs2 is no longer included in the
+    # operating system, so we return false in that case. We'll fallback
+    # to hardcoded paths.
+    def self.apxs2_needed_for_building_apache_modules?
+      !(os_name_simple == 'macosx' &&
+        os_version >= '10.13' &&
+        httpd == '/usr/sbin/httpd')
+    end
+
     # Returns whether it is necessary to use information outputted by
     # 'apr-config' and 'apu-config' in order to compile an Apache module.
+    #
     # When Apache is installed with --with-included-apr, the APR/APU
     # headers are placed into the same directory as the Apache headers,
     # and so 'apr-config' and 'apu-config' won't be necessary in that case.
+    #
+    # Also, since macOS 10.12 Sierra apr-config is no longer included
+    # in the operating system, so we also return false in that case.
+    # We'll fallback to hardcoded paths.
     def self.apr_config_needed_for_building_apache_modules?
-      return !try_compile("whether APR is needed for building Apache modules",
-        :c, "#include <apr.h>\n", apache2_module_cflags(false))
+      !(
+        os_name_simple == 'macosx' &&
+        os_version >= '10.13' &&
+        httpd == '/usr/sbin/httpd'
+      ) &&
+        !try_compile("whether APR is needed for building Apache modules",
+          :c, "#include <apr.h>\n", apache2_module_cflags(false))
     end
     memoize :apr_config_needed_for_building_apache_modules?, true
 
   private
     def self.determine_apr_info(language)
       if apr_config.nil?
-        if os_name_simple == 'macosx' && apxs2 == '/usr/sbin/apxs'
-          # macOS 10.12 Sierra does not supply apr-config, so
+        if os_name_simple == 'macosx' && httpd == '/usr/sbin/httpd'
+          # macOS >= 10.12 Sierra does not supply apr-config, so
           # we use hardcoded defaults.
-          ['-I/usr/include/apr-1', '-lapr-1']
+          if os_version >= '10.13'
+            # On macOS >= 10.13 High Sierra /usr/include no longer
+            # exists.
+            xcode_prefix = `/usr/bin/xcode-select -p`.strip
+            ["-I#{xcode_prefix}/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/include/apr-1",
+              '-lapr-1']
+          else
+            ['-I/usr/include/apr-1', '-lapr-1']
+          end
         else
           [nil, nil]
         end
@@ -783,10 +856,18 @@ module PhusionPassenger
 
     def self.determine_apu_info(language)
       if apu_config.nil?
-        if os_name_simple == 'macosx' && apxs2 == '/usr/sbin/apxs'
-          # macOS 10.12 Sierra does not supply apu-config, so
+        if os_name_simple == 'macosx' && httpd == '/usr/sbin/httpd'
+          # macOS >= 10.12 Sierra does not supply apu-config, so
           # we use hardcoded defaults.
-          ['-I/usr/include/apr-1', '-laprutil-1']
+          if os_version >= '10.13'
+            # On macOS >= 10.13 High Sierra /usr/include no longer
+            # exists.
+            xcode_prefix = `/usr/bin/xcode-select -p`.strip
+            ["-I#{xcode_prefix}/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/include/apr-1",
+              '-laprutil-1']
+          else
+            ['-I/usr/include/apr-1', '-laprutil-1']
+          end
         else
           [nil, nil]
         end

data/src/ruby_supportlib/phusion_passenger/platform_info/apache_detector.rb

@@ -63,7 +63,7 @@ module PhusionPassenger
         def report
           log " <b>* Found Apache #{version}!</b>"
           log "   Information:"
-          log "      apxs2          : #{apxs2}"
+          log "      apxs2          : #{apxs2 || 'N/A'}"
           log "      Main executable: #{httpd}"
           log "      Control command: #{ctl}"
           log "      Config file    : #{config_file || 'unknown'}"
@@ -76,7 +76,7 @@ module PhusionPassenger
           end
           log ""
           log "   To install #{PROGRAM_NAME} against this specific Apache version:"
-          log "      #{PlatformInfo.ruby_command} #{PhusionPassenger.bin_dir}/passenger-install-apache2-module --apxs2-path='#{apxs2}'"
+          log "      #{PlatformInfo.ruby_command} #{PhusionPassenger.bin_dir}/passenger-install-apache2-module --apxs2-path='#{apxs2 || 'none'}'"
           log ""
           log "   To start, stop or restart this specific Apache version:"
           log "      #{ctl} start"
@@ -121,7 +121,7 @@ module PhusionPassenger
         log "<banner>Looking for possible Apache installations...</banner>"
         apxses = PlatformInfo.find_all_commands("apxs2") +
           PlatformInfo.find_all_commands("apxs")
-        if !apxses.include?(PlatformInfo.apxs2)
+        if PlatformInfo.apxs2 && !apxses.include?(PlatformInfo.apxs2)
           PlatformInfo.send(:log, "Looking for #{PlatformInfo.apxs2}: found")
           apxses << PlatformInfo.apxs2
         end
@@ -130,10 +130,17 @@ module PhusionPassenger
         apxses.each do |apxs2|
           detect_one(apxs2)
         end
+        # macOS >= 10.13 High Sierra no longer ships apxs2, but we'll want to perform
+        # an autodetection run against the OS-provided Apache installation anyway.
+        if PlatformInfo.os_name_simple == 'macosx' && PlatformInfo.os_version >= '10.13'
+          detect_one(nil)
+        end
       end
 
       def detect_one(apxs2)
-        log "<banner>Analyzing #{apxs2}...</banner>"
+        # Note: apxs2 is nil on macOS 10.13 High Sierra. See comment in #detect_all.
+        apxs2_description = apxs2 || 'OS-default Apache installation'
+        log "<banner>Analyzing #{apxs2_description}...</banner>"
         add_result do |result|
           result.apxs2 = apxs2
           log "Detecting main Apache executable..."
@@ -154,7 +161,9 @@ module PhusionPassenger
           end
           if result.httpd
             log "Detecting configuration file location..."
-            result.config_file = PlatformInfo.httpd_default_config_file(:httpd => result.httpd)
+            result.config_file = PlatformInfo.httpd_default_config_file(
+              :httpd => result.httpd,
+              :apache2ctl => result.ctl)
             if result.config_file
               log " --> #{result.config_file}"
             else
@@ -163,7 +172,9 @@ module PhusionPassenger
           end
           if result.httpd
             log "Detecting error log file..."
-            result.error_log = PlatformInfo.httpd_actual_error_log(:httpd => result.httpd)
+            result.error_log = PlatformInfo.httpd_actual_error_log(
+              :httpd => result.httpd,
+              :apache2ctl => result.ctl)
             if result.error_log
               log " --> #{result.error_log}"
             else
@@ -176,13 +187,14 @@ module PhusionPassenger
             result.a2dismod = PlatformInfo.a2dismod(:apxs2 => apxs2)
           end
           if result.httpd
-            result.config_file_broken = PlatformInfo.apache2ctl_V(:apxs2 => apxs2).nil?
+            result.config_file_broken = PlatformInfo.apache2ctl_V(:apxs2 => apxs2,
+              :apache2ctl => result.ctl).nil?
           end
           if result.httpd
-            log "<green>Found a usable Apache installation using #{apxs2}.</green>"
+            log "<green>Found a usable Apache installation using #{apxs2_description}.</green>"
             true
           else
-            log "<yellow>Cannot find a usable Apache installation using #{apxs2}.</yellow>"
+            log "<yellow>Cannot find a usable Apache installation using #{apxs2_description}.</yellow>"
             false
           end
         end