1 local config = require "core.configmanager";
2 local certmanager = require "core.certmanager";
3 local server = require "net.server";
4 local socket = require "socket";
6 local log = require "util.logger".init("portmanager");
7 local multitable = require "util.multitable";
8 local set = require "util.set";
11 local setmetatable, rawset, rawget = setmetatable, rawset, rawget;
12 local type, tonumber, ipairs = type, tonumber, ipairs;
14 local prosody = prosody;
15 local fire_event = prosody.events.fire_event;
21 local default_interfaces = { };
22 local default_local_interfaces = { };
23 if config.get("*", "use_ipv4") ~= false then
24 table.insert(default_interfaces, "*");
25 table.insert(default_local_interfaces, "127.0.0.1");
27 if socket.tcp6 and config.get("*", "use_ipv6") ~= false then
28 table.insert(default_interfaces, "::");
29 table.insert(default_local_interfaces, "::1");
34 -- service_name -> { service_info, ... }
35 local services = setmetatable({}, { __index = function (t, k) rawset(t, k, {}); return rawget(t, k); end });
37 -- service_name, interface (string), port (number)
38 local active_services = multitable.new();
42 local function error_to_friendly_message(service_name, port, err)
43 local friendly_message = err;
44 if err:match(" in use") then
45 -- FIXME: Use service_name here
46 if port == 5222 or port == 5223 or port == 5269 then
47 friendly_message = "check that Prosody or another XMPP server is "
48 .."not already running and using this port";
49 elseif port == 80 or port == 81 then
50 friendly_message = "check that a HTTP server is not already using "
52 elseif port == 5280 then
53 friendly_message = "check that Prosody or a BOSH connection manager "
54 .."is not already running";
56 friendly_message = "this port is in use by another application";
58 elseif err:match("permission") then
59 friendly_message = "Prosody does not have sufficient privileges to use this port";
61 return friendly_message;
64 prosody.events.add_handler("item-added/net-provider", function (event)
65 local item = event.item;
66 register_service(item.name, item);
68 prosody.events.add_handler("item-removed/net-provider", function (event)
69 local item = event.item;
70 unregister_service(item.name, item);
75 function activate(service_name)
76 local service_info = services[service_name][1];
77 if not service_info then
78 return nil, "Unknown service: "..service_name;
81 local listener = service_info.listener;
83 local config_prefix = (service_info.config_prefix or service_name).."_";
84 if config_prefix == "_" then
88 local bind_interfaces = config.get("*", config_prefix.."interfaces")
89 or config.get("*", config_prefix.."interface") -- COMPAT w/pre-0.9
90 or (service_info.private and (config.get("*", "local_interfaces") or default_local_interfaces))
91 or config.get("*", "interfaces")
92 or config.get("*", "interface") -- COMPAT w/pre-0.9
93 or listener.default_interface -- COMPAT w/pre0.9
95 bind_interfaces = set.new(type(bind_interfaces)~="table" and {bind_interfaces} or bind_interfaces);
97 local bind_ports = config.get("*", config_prefix.."ports")
98 or service_info.default_ports
99 or {service_info.default_port
100 or listener.default_port -- COMPAT w/pre-0.9
102 bind_ports = set.new(type(bind_ports) ~= "table" and { bind_ports } or bind_ports );
104 local mode, ssl = listener.default_mode or "*a";
106 for interface in bind_interfaces do
107 for port in bind_ports do
108 port = tonumber(port);
109 if #active_services:search(nil, interface, port) > 0 then
110 log("error", "Multiple services configured to listen on the same port ([%s]:%d): %s, %s", interface, port, active_services:search(nil, interface, port)[1][1].service.name or "<unnamed>", service_name or "<unnamed>");
113 -- Create SSL context for this service/port
114 if service_info.encryption == "ssl" then
115 local ssl_config = config.get("*", config_prefix.."ssl");
116 ssl, err = certmanager.create_context(service_info.name.." port "..port, "server", ssl_config and (ssl_config[port]
117 or (ssl_config.certificate and ssl_config)));
119 log("error", "Error binding encrypted port for %s: %s", service_info.name, error_to_friendly_message(service_name, port, err) or "unknown error");
123 -- Start listening on interface+port
124 local handler, err = server.addserver(interface, port, listener, mode, ssl);
126 log("error", "Failed to open server port %d on %s, %s", port, interface, error_to_friendly_message(service_name, port, err));
128 log("debug", "Added listening service %s to [%s]:%d", service_name, interface, port);
129 active_services:add(service_name, interface, port, {
131 service = service_info;
138 log("info", "Activated service '%s'", service_name);
142 function deactivate(service_name, service_info)
143 for name, interface, port, n, active_service
144 in active_services:iter(service_name or service_info and service_info.name, nil, nil, nil) do
145 if service_info == nil or active_service.service == service_info then
146 close(interface, port);
149 log("info", "Deactivated service '%s'", service_name or service_info.name);
152 function register_service(service_name, service_info)
153 table.insert(services[service_name], service_info);
155 if not active_services:get(service_name) then
156 log("debug", "No active service for %s, activating...", service_name);
157 local ok, err = activate(service_name);
159 log("error", "Failed to activate service '%s': %s", service_name, err or "unknown error");
163 fire_event("service-added", { name = service_name, service = service_info });
167 function unregister_service(service_name, service_info)
168 log("debug", "Unregistering service: %s", service_name);
169 local service_info_list = services[service_name];
170 for i, service in ipairs(service_info_list) do
171 if service == service_info then
172 table.remove(service_info_list, i);
175 deactivate(nil, service_info);
176 if #service_info_list > 0 then -- Other services registered with this name
177 activate(service_name); -- Re-activate with the next available one
179 fire_event("service-removed", { name = service_name, service = service_info });
182 function close(interface, port)
183 local service, server = get_service_at(interface, port);
185 return false, "port-not-open";
188 active_services:remove(service.name, interface, port);
189 log("debug", "Removed listening service %s from [%s]:%d", service.name, interface, port);
193 function get_service_at(interface, port)
194 local data = active_services:search(nil, interface, port)[1][1];
195 return data.service, data.server;
198 function get_service(service_name)
199 return (services[service_name] or {})[1];
202 function get_active_services(...)
203 return active_services;
206 function get_registered_services()