core/portmanager.lua

   1
   2 local multitable = require "util.multitable";
   3 local fire_event = prosody.events.fire_event;
   4
   5 --- Config
   6
   7 local default_interfaces = { "*" };
   8 local default_local_interfaces = { "127.0.0.1" };
   9 if config.get("*", "use_ipv6") then
  10         table.insert(default_interfaces, "::");
  11         table.insert(default_local_interfaces, "::1");
  12 end
  13
  14 --- Private state
  15
  16 -- service_name -> { service_info, ... }
  17 local services = setmetatable({}, { __index = function (t, k) rawset(t, k, {}); return rawget(t, k); end });
  18
  19 -- service_name, interface (string), port (number)
  20 local active_services = multitable.new();
  21
  22 --- Private helpers
  23
  24 local function error_to_friendly_message(service_name, port, err)
  25         local friendly_message = err;
  26         if err:match(" in use") then
  27                 -- FIXME: Use service_name here
  28                 if port == 5222 or port == 5223 or port == 5269 then
  29                         friendly_message = "check that Prosody or another XMPP server is "
  30                                 .."not already running and using this port";
  31                 elseif port == 80 or port == 81 then
  32                         friendly_message = "check that a HTTP server is not already using "
  33                                 .."this port";
  34                 elseif port == 5280 then
  35                         friendly_message = "check that Prosody or a BOSH connection manager "
  36                                 .."is not already running";
  37                 else
  38                         friendly_message = "this port is in use by another application";
  39                 end
  40         elseif err:match("permission") then
  41                 friendly_message = "Prosody does not have sufficient privileges to use this port";
  42         elseif err == "no ssl context" then
  43                 if not config.get("*", "core", "ssl") then
  44                         friendly_message = "there is no 'ssl' config under Host \"*\" which is "
  45                                 .."require for legacy SSL ports";
  46                 else
  47                         friendly_message = "initializing SSL support failed, see previous log entries";
  48                 end
  49         end
  50         return friendly_message;
  51 end
  52
  53 module("portmanager", package.seeall);
  54
  55 prosody.events.add_handler("item-added/net-provider", function (event)
  56         local item = event.item;
  57         register_service(item.name, item);
  58 end);
  59 prosody.events.add_handler("item-removed/net-provider", function (event)
  60         local item = event.item;
  61         unregister_service(item.name, item);
  62 end);
  63
  64 --- Public API
  65
  66 function activate_service(service_name)
  67         local service_info = services[service_name][1];
  68         if not service_info then
  69                 return nil, "Unknown service: "..service_name;
  70         end
  71
  72         local listener = service_info.listener;
  73
  74         local config_prefix = (service_info.config_prefix or service_name).."_";
  75         if config_prefix == "_" then
  76                 config_prefix = "";
  77         end
  78
  79         local bind_interfaces = set.new(config.get("*", config_prefix.."interfaces")
  80                 or config.get("*", config_prefix.."interface") -- COMPAT w/pre-0.9
  81                 or (service_info.private and default_local_interfaces)
  82                 or config.get("*", "interfaces")
  83                 or config.get("*", "interface") -- COMPAT w/pre-0.9
  84                 or listener.default_interface -- COMPAT w/pre0.9
  85                 or default_interfaces);
  86
  87         local bind_ports = set.new(config.get("*", config_prefix.."ports")
  88                 or service_info.default_ports
  89                 or {listener.default_port}); -- COMPAT w/pre-0.9
  90
  91         local mode = listener.default_mode or "*a";
  92         local ssl;
  93         if service_info.encryption == "ssl" then
  94                 ssl = prosody.global_ssl_ctx;
  95                 if not ssl then
  96                         return nil, "global-ssl-context-required";
  97                 end
  98         end
  99
 100         for interface in bind_interfaces do
 101                 for port in bind_ports do
 102                         if #active_services:search(nil, interface, port) > 0 then
 103                                 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>");
 104                         else
 105                                 local handler, err = server.addserver(interface, port, listener, mode, ssl);
 106                                 if not handler then
 107                                         log("error", "Failed to open server port %d on %s, %s", port, interface, error_to_friendly_message(service_name, port, err));
 108                                 else
 109                                         log("debug", "Added listening service %s to [%s]:%d", service_name, interface, port);
 110                                         active_services:add(service_name, interface, port, {
 111                                                 server = handler;
 112                                                 service = service_info;
 113                                         });
 114                                 end
 115                         end
 116                 end
 117         end
 118         log("info", "Activated service '%s'", service_name);
 119         return true;
 120 end
 121
 122 function deactivate(service_name)
 123         local active = active_services:search(service_name)[1];
 124         if not active then return; end
 125         for interface, ports in pairs(active) do
 126                 for port, active_service in pairs(ports) do
 127                         active_service:close();
 128                         active_services:remove(service_name, interface, port, active_service);
 129                         log("debug", "Removed listening service %s from [%s]:%d", service_name, interface, port);
 130                 end
 131         end
 132         log("info", "Deactivated service '%s'", service_name);
 133 end
 134
 135 function register_service(service_name, service_info)
 136         table.insert(services[service_name], service_info);
 137
 138         if not active_services:get(service_name) then
 139                 log("debug", "No active service for %s, activating...", service_name);
 140                 local ok, err = activate_service(service_name);
 141                 if not ok then
 142                         log("error", "Failed to activate service '%s': %s", service_name, err or "unknown error");
 143                 end
 144         end
 145
 146         fire_event("service-added", { name = service_name, service = service_info });
 147         return true;
 148 end
 149
 150 function unregister_service(service_name, service_info)
 151         local service_info_list = services[service_name];
 152         for i, service in ipairs(service_info_list) do
 153                 if service == service_info then
 154                         table.remove(service_info_list, i);
 155                 end
 156         end
 157         if active_services[service_name] == service_info then
 158                 deactivate(service_name);
 159                 if #service_info_list > 0 then -- Other services registered with this name
 160                         activate(service_name); -- Re-activate with the next available one
 161                 end
 162         end
 163         fire_event("service-removed", { name = service_name, service = service_info });
 164 end
 165
 166 function get_service(service_name)
 167         return services[service_name];
 168 end
 169
 170 function get_active_services(...)
 171         return active_services;
 172 end
 173
 174 function get_registered_services()
 175         return services;
 176 end
 177
 178 return _M;