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 bind_interfaces = set.new(config.get("*", service_name.."_interfaces")
  73                 or config.get("*", service_name.."_interface") -- COMPAT w/pre-0.9
  74                 or (service_info.private and default_local_interfaces)
  75                 or config.get("*", "interfaces")
  76                 or config.get("*", "interface") -- COMPAT w/pre-0.9
  77                 or service_info.default_interface -- COMPAT w/pre0.9
  78                 or default_interfaces);
  79
  80         local bind_ports = set.new(config.get("*", service_name.."_ports")
  81                 or (service_info.multiplex and config.get("*", "ports"))
  82                 or service_info.default_ports
  83                 or {service_info.default_port});
  84
  85         local listener = service_info.listener;
  86         local mode = listener.default_mode or "*a";
  87         local ssl;
  88         if service_info.encryption == "ssl" then
  89                 ssl = prosody.global_ssl_ctx;
  90                 if not ssl then
  91                         return nil, "global-ssl-context-required";
  92                 end
  93         end
  94
  95         for interface in bind_interfaces do
  96                 for port in bind_ports do
  97                         if not service_info.multiplex and #active_services:search(nil, interface, port) > 0 then
  98                                 log("error", "Multiple services configured to listen on the same port: %s, %s", table.concat(active_services:search(nil, interface, port), ", "), service_name);
  99                         else
 100                                 local handler, err = server.addserver(interface, port, listener, mode, ssl);
 101                                 if not handler then
 102                                         log("error", "Failed to open server port %d on %s, %s", port, interface, error_to_friendly_message(service_name, port, err));
 103                                 else
 104                                         log("debug", "Added listening service %s to [%s]:%d", service_name, interface, port);
 105                                         active_services:add(service_name, interface, port, {
 106                                                 server = handler;
 107                                                 service = service_info;
 108                                         });
 109                                 end
 110                         end
 111                 end
 112         end
 113         log("info", "Activated service '%s'", service_name);
 114         return true;
 115 end
 116
 117 function deactivate(service_name)
 118         local active = active_services:search(service_name)[1];
 119         if not active then return; end
 120         for interface, ports in pairs(active) do
 121                 for port, active_service in pairs(ports) do
 122                         active_service:close();
 123                         active_services:remove(service_name, interface, port, active_service);
 124                         log("debug", "Removed listening service %s from [%s]:%d", service_name, interface, port);
 125                 end
 126         end
 127         log("info", "Deactivated service '%s'", service_name);
 128 end
 129
 130 function register_service(service_name, service_info)
 131         table.insert(services[service_name], service_info);
 132
 133         if not active_services:get(service_name) then
 134                 log("debug", "No active service for %s, activating...", service_name);
 135                 local ok, err = activate_service(service_name);
 136                 if not ok then
 137                         log("error", "Failed to activate service '%s': %s", service_name, err or "unknown error");
 138                 end
 139         end
 140
 141         fire_event("service-added", { name = service_name, service = service_info });
 142         return true;
 143 end
 144
 145 function unregister_service(service_name, service_info)
 146         local service_info_list = services[service_name];
 147         for i, service in ipairs(service_info_list) do
 148                 if service == service_info then
 149                         table.remove(service_info_list, i);
 150                 end
 151         end
 152         if active_services[service_name] == service_info then
 153                 deactivate(service_name);
 154                 if #service_info_list > 0 then -- Other services registered with this name
 155                         activate(service_name); -- Re-activate with the next available one
 156                 end
 157         end
 158 end
 159
 160 function get_service(service_name)
 161         return services[service_name];
 162 end
 163
 164 function get_active_services(...)
 165         return active_services;
 166 end
 167
 168 return _M;