/
phusion_passenger.rb
334 lines (291 loc) · 11.1 KB
/
phusion_passenger.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
# encoding: utf-8
# Phusion Passenger - https://www.phusionpassenger.com/
# Copyright (c) 2010-2015 Phusion
#
# "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.
#
# 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.
module PhusionPassenger
FILE_LOCATION = File.expand_path(__FILE__)
###### Names and version numbers ######
PACKAGE_NAME = 'passenger'
# Run 'rake ext/common/Constants.h' after changing this number.
VERSION_STRING = '5.0.13'
PREFERRED_NGINX_VERSION = '1.8.0'
NGINX_SHA256_CHECKSUM = '23cca1239990c818d8f6da118320c4979aadf5386deda691b1b7c2c96b9df3d5'
PREFERRED_PCRE_VERSION = '8.34'
PCRE_SHA256_CHECKSUM = '1dd78994c81e44ac41cf30b2a21d4b4cc6d76ccde7fc6e77713ed51d7bddca47'
STANDALONE_INTERFACE_VERSION = 1
###### Directories ######
GLOBAL_NAMESPACE_DIRNAME_ = "passenger"
# Subdirectory under $HOME to use for storing stuff.
USER_NAMESPACE_DIRNAME_ = ".passenger"
# The name for the /etc/apache2/mods-available/*.{load,conf} file.
APACHE2_MODULE_CONF_NAME = "passenger"
# Directories in which to look for plugins.
PLUGIN_DIRS = [
"/usr/share/#{GLOBAL_NAMESPACE_DIRNAME_}/plugins",
"/usr/local/share/#{GLOBAL_NAMESPACE_DIRNAME_}/plugins",
"~/#{USER_NAMESPACE_DIRNAME_}/plugins"
]
REQUIRED_LOCATIONS_INI_FIELDS = [
# User-invoked commands
:bin_dir,
# Support binaries
:support_binaries_dir,
# Library files like libboost_oxt.a and various .o files
:lib_dir,
# Scripts not directly invoked by users
:helper_scripts_dir,
# Various non-executable resources
:resources_dir,
# C header files, necessary for compiling Nginx
:include_dir,
# Documentation
:doc_dir,
# Ruby support libraries
:ruby_libdir,
# Node.js support libraries
:node_libdir,
# Path to the compiled Apache module
:apache2_module_path,
# Directory containing the source code of our Ruby extension
:ruby_extension_source_dir,
# Directory containing the source code of our Nginx module
:nginx_module_source_dir
].freeze
OPTIONAL_LOCATIONS_INI_FIELDS = [
# Directory which contains the main Phusion Passenger Rakefile. Only
# available when originally packaged,
:build_system_dir,
# Directory in which downloaded Phusion Passenger binaries are cached.
:download_cache_dir
].freeze
# Follows the logic of ext/common/ResourceLocator.h, so don't forget to modify that too.
def self.locate_directories(install_spec = nil)
@install_spec = install_spec || infer_install_spec
if @install_spec && File.file?(@install_spec)
filename = @install_spec
options = parse_ini_file(filename)
@custom_packaged = true
@packaging_method = get_option(filename, options, 'packaging_method')
REQUIRED_LOCATIONS_INI_FIELDS.each do |field|
value = get_option(filename, options, field.to_s)
value.freeze unless value.nil?
instance_variable_set("@#{field}", value)
end
OPTIONAL_LOCATIONS_INI_FIELDS.each do |field|
value = get_option(filename, options, field.to_s, false)
value.freeze unless value.nil?
instance_variable_set("@#{field}", value)
end
else
source_root = File.dirname(File.dirname(FILE_LOCATION))
@install_spec = source_root
@custom_packaged = false
@bin_dir = "#{source_root}/bin".freeze
@support_binaries_dir = "#{source_root}/buildout/support-binaries".freeze
@lib_dir = "#{source_root}/buildout".freeze
@helper_scripts_dir = "#{source_root}/helper-scripts".freeze
@resources_dir = "#{source_root}/resources".freeze
@include_dir = "#{source_root}/ext".freeze
@doc_dir = "#{source_root}/doc".freeze
@ruby_libdir = File.dirname(FILE_LOCATION).freeze
@node_libdir = "#{source_root}/node_lib".freeze
@apache2_module_path = "#{source_root}/buildout/apache2/mod_passenger.so".freeze
@ruby_extension_source_dir = "#{source_root}/ext/ruby".freeze
@nginx_module_source_dir = "#{source_root}/ext/nginx".freeze
@download_cache_dir = "#{source_root}/download_cache".freeze
@build_system_dir = source_root.dup.freeze
REQUIRED_LOCATIONS_INI_FIELDS.each do |field|
if instance_variable_get("@#{field}").nil?
raise "BUG: @#{field} not set"
end
end
end
end
# Returns whether this Phusion Passenger installation is in the 'originally packaged'
# configuration (as opposed to the 'custom packaged' configuration.
def self.originally_packaged?
return !@custom_packaged
end
def self.custom_packaged?
return @custom_packaged
end
# If Phusion Passenger is custom packaged, returns which packaging
# method was used. Can be 'deb', 'rpm', 'homebrew', 'test'
# or 'unknown'.
def self.packaging_method
return @packaging_method
end
def self.packaging_method_description
case packaging_method
when "deb"
"Debian packages"
when "rpm"
"RPM packages"
when "homebrew"
"Homebrew"
else
"gem or tarball"
end
end
# Whether the current Phusion Passenger installation is installed
# from a release package, e.g. an official gem or official tarball.
# Retruns false if e.g. the gem was built by the user, or if this
# install is from a git repository.
def self.installed_from_release_package?
File.exist?("#{resources_dir}/release.txt")
end
# The installation specification string, as passed to #locate_directories.
def self.install_spec
return @install_spec
end
# Generate getters for the directory types in locations.ini.
getters_code = ""
(REQUIRED_LOCATIONS_INI_FIELDS + OPTIONAL_LOCATIONS_INI_FIELDS).each do |field|
getters_code << %Q{
def self.#{field}
return @#{field}
end
}
end
eval(getters_code, binding, __FILE__, __LINE__)
def self.user_support_binaries_dir
return "#{home_dir}/#{USER_NAMESPACE_DIRNAME_}/support-binaries/#{VERSION_STRING}"
end
def self.find_support_binary(name)
all_support_binary_dirs = [
support_binaries_dir,
user_support_binaries_dir
]
all_support_binary_dirs.each do |dir|
result = "#{dir}/#{name}"
if File.exist?(result)
return result
end
end
return nil
end
def self.index_doc_path
return "#{doc_dir}/#{INDEX_DOC_NAME}"
end
def self.apache2_doc_path
return "#{doc_dir}/#{APACHE2_DOC_NAME}"
end
def self.nginx_doc_path
return "#{doc_dir}/#{NGINX_DOC_NAME}"
end
def self.standalone_doc_path
return "#{doc_dir}/#{STANDALONE_DOC_NAME}"
end
###### Other resource locations ######
INDEX_DOC_NAME = "Users guide.html".freeze
APACHE2_DOC_NAME = "Users guide Apache.html".freeze
NGINX_DOC_NAME = "Users guide Nginx.html".freeze
STANDALONE_DOC_NAME = "Users guide Standalone.html".freeze
def self.binaries_sites
return [
{ :url => "https://oss-binaries.phusionpassenger.com/binaries/passenger/by_release".freeze,
:cacert => "#{resources_dir}/oss-binaries.phusionpassenger.com.crt".freeze },
{ :url => "https://s3.amazonaws.com/phusion-passenger/binaries/passenger/by_release".freeze }
]
end
# Instead of calling `require 'phusion_passenger/foo'`, you should call
# `PhusionPassenger.require_passenger_lib 'foo'`. This is because when Phusion
# Passenger is natively packaged, it may still be run with arbitrary Ruby
# interpreters. Adding ruby_libdir to $LOAD_PATH is then dangerous because ruby_libdir
# may be the distribution's Ruby's vendor_ruby directory, which may be incompatible
# with the active Ruby interpreter. This method looks up the exact filename directly.
#
# Using this method also has two more advantages:
#
# 1. It is immune to Bundler's load path mangling code.
# 2. It is faster than plan require() because it doesn't need to
# scan the entire load path.
def self.require_passenger_lib(name)
require("#{ruby_libdir}/phusion_passenger/#{name}")
end
private
def self.infer_install_spec
filename = ENV['PASSENGER_LOCATION_CONFIGURATION_FILE']
return filename if filename && !filename.empty?
filename = File.dirname(FILE_LOCATION) + "/phusion_passenger/locations.ini"
return filename if filename && File.exist?(filename)
require 'etc' if !defined?(Etc)
begin
home_dir = Etc.getpwuid(Process.uid).dir
rescue ArgumentError
# Unknown user.
home_dir = ENV['HOME']
end
if home_dir && !home_dir.empty?
filename = "#{home_dir}/#{USER_NAMESPACE_DIRNAME_}/locations.ini"
return filename if File.exist?(filename)
end
filename = "/etc/#{GLOBAL_NAMESPACE_DIRNAME_}/locations.ini"
return filename if File.exist?(filename)
return nil
end
def self.parse_ini_file(filename)
options = {}
in_locations_section = false
File.open(filename, 'r') do |f|
while !f.eof?
line = f.readline
line.strip!
next if line.empty?
if line =~ /\A\[(.+)\]\Z/
in_locations_section = $1 == 'locations'
elsif in_locations_section && line =~ /=/
key, value = line.split(/ *= */, 2)
options[key.freeze] = value.freeze
end
end
end
return options
end
def self.get_option(filename, options, key, required = true)
value = options[key]
if value
return value
elsif required
raise "Option '#{key}' missing in file '#{filename}'"
else
return nil
end
end
def self.get_bool_option(filename, options, key)
value = get_option(filename, options, key)
return value == 'yes' || value == 'true' || value == 'on' || value == '1'
end
# The HOME environment variable is often unreliable, because for
# example `sudo` preserves it. That's why we don't respect it by
# default.
def self.home_dir(respect_home_env = false)
if respect_home_env
home = ENV['HOME'].to_s
end
if home.nil? || home.empty?
require 'etc' if !defined?(Etc)
home = Etc.getpwuid(Process.uid).dir
end
return home
end
end if !defined?(PhusionPassenger::VERSION_STRING)