core/portmanager.lua

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