net/httpserver.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2009 Matthew Wild
   3 -- Copyright (C) 2008-2009 Waqas Hussain
   4 --
   5 -- This project is MIT/X11 licensed. Please see the
   6 -- COPYING file in the source package for more information.
   7 --
   8
   9
  10 local socket = require "socket"
  11 local server = require "net.server"
  12 local url_parse = require "socket.url".parse;
  13
  14 local connlisteners_start = require "net.connlisteners".start;
  15 local connlisteners_get = require "net.connlisteners".get;
  16 local listener;
  17
  18 local t_insert, t_concat = table.insert, table.concat;
  19 local s_match, s_gmatch = string.match, string.gmatch;
  20 local tonumber, tostring, pairs, ipairs, type = tonumber, tostring, pairs, ipairs, type;
  21
  22 local urlencode = function (s) return s and (s:gsub("%W", function (c) return string.format("%%%02x", c:byte()); end)); end
  23
  24 local log = require "util.logger".init("httpserver");
  25
  26 local http_servers = {};
  27
  28 module "httpserver"
  29
  30 local default_handler;
  31
  32 local function expectbody(reqt)
  33     return reqt.method == "POST";
  34 end
  35
  36 local function send_response(request, response)
  37         -- Write status line
  38         local resp;
  39         if response.body or response.headers then
  40                 local body = response.body and tostring(response.body);
  41                 log("debug", "Sending response to %s", request.id);
  42                 resp = { "HTTP/1.0 "..(response.status or "200 OK").."\r\n" };
  43                 local h = response.headers;
  44                 if h then
  45                         for k, v in pairs(h) do
  46                                 t_insert(resp, k..": "..v.."\r\n");
  47                         end
  48                 end
  49                 if body and not (h and h["Content-Length"]) then
  50                         t_insert(resp, "Content-Length: "..#body.."\r\n");
  51                 end
  52                 t_insert(resp, "\r\n");
  53
  54                 if body and request.method ~= "HEAD" then
  55                         t_insert(resp, body);
  56                 end
  57                 request.write(t_concat(resp));
  58         else
  59                 -- Response we have is just a string (the body)
  60                 log("debug", "Sending 200 response to %s", request.id or "<none>");
  61
  62                 local resp = "HTTP/1.0 200 OK\r\n"
  63                         .. "Connection: close\r\n"
  64                         .. "Content-Type: text/html\r\n"
  65                         .. "Content-Length: "..#response.."\r\n"
  66                         .. "\r\n"
  67                         .. response;
  68
  69                 request.write(resp);
  70         end
  71         if not request.stayopen then
  72                 request:destroy();
  73         end
  74 end
  75
  76 local function call_callback(request, err)
  77         if request.handled then return; end
  78         request.handled = true;
  79         local callback = request.callback;
  80         if not callback and request.path then
  81                 local path = request.url.path;
  82                 local base = path:match("^/([^/?]+)");
  83                 if not base then
  84                         base = path:match("^http://[^/?]+/([^/?]+)");
  85                 end
  86
  87                 callback = (request.server and request.server.handlers[base]) or default_handler;
  88         end
  89         if callback then
  90                 if err then
  91                         log("debug", "Request error: "..err);
  92                         if not callback(nil, err, request) then
  93                                 destroy_request(request);
  94                         end
  95                         return;
  96                 end
  97
  98                 local response = callback(request.method, request.body and t_concat(request.body), request);
  99                 if response then
 100                         if response == true and not request.destroyed then
 101                                 -- Keep connection open, we will reply later
 102                                 log("debug", "Request %s left open, on_destroy is %s", request.id, tostring(request.on_destroy));
 103                         elseif response ~= true then
 104                                 -- Assume response
 105                                 send_response(request, response);
 106                                 destroy_request(request);
 107                         end
 108                 else
 109                         log("debug", "Request handler provided no response, destroying request...");
 110                         -- No response, close connection
 111                         destroy_request(request);
 112                 end
 113         end
 114 end
 115
 116 local function request_reader(request, data, startpos)
 117         if not data then
 118                 if request.body then
 119                         call_callback(request);
 120                 else
 121                         -- Error.. connection was closed prematurely
 122                         call_callback(request, "connection-closed");
 123                 end
 124                 -- Here we force a destroy... the connection is gone, so we can't reply later
 125                 destroy_request(request);
 126                 return;
 127         end
 128         if request.state == "body" then
 129                 log("debug", "Reading body...")
 130                 if not request.body then request.body = {}; request.havebodylength, request.bodylength = 0, tonumber(request.headers["content-length"]); end
 131                 if startpos then
 132                         data = data:sub(startpos, -1)
 133                 end
 134                 t_insert(request.body, data);
 135                 if request.bodylength then
 136                         request.havebodylength = request.havebodylength + #data;
 137                         if request.havebodylength >= request.bodylength then
 138                                 -- We have the body
 139                                 call_callback(request);
 140                         end
 141                 end
 142         elseif request.state == "headers" then
 143                 log("debug", "Reading headers...")
 144                 local pos = startpos;
 145                 local headers, headers_complete = request.headers;
 146                 if not headers then
 147                         headers = {};
 148                         request.headers = headers;
 149                 end
 150
 151                 for line in data:gmatch("(.-)\r\n") do
 152                         startpos = (startpos or 1) + #line + 2;
 153                         local k, v = line:match("(%S+): (.+)");
 154                         if k and v then
 155                                 headers[k:lower()] = v;
 156                                 --log("debug", "Header: '"..k:lower().."' = '"..v.."'");
 157                         elseif #line == 0 then
 158                                 headers_complete = true;
 159                                 break;
 160                         else
 161                                 log("debug", "Unhandled header line: "..line);
 162                         end
 163                 end
 164
 165                 if not headers_complete then return; end
 166
 167                 if not expectbody(request) then
 168                         call_callback(request);
 169                         return;
 170                 end
 171
 172                 -- Reached the end of the headers
 173                 request.state = "body";
 174                 if #data > startpos then
 175                         return request_reader(request, data:sub(startpos, -1));
 176                 end
 177         elseif request.state == "request" then
 178                 log("debug", "Reading request line...")
 179                 local method, path, http, linelen = data:match("^(%S+) (%S+) HTTP/(%S+)\r\n()", startpos);
 180                 if not method then
 181                         log("warn", "Invalid HTTP status line, telling callback then closing");
 182                         local ret = call_callback(request, "invalid-status-line");
 183                         request:destroy();
 184                         return ret;
 185                 end
 186
 187                 request.method, request.path, request.httpversion = method, path, http;
 188
 189                 request.url = url_parse(request.path);
 190
 191                 log("debug", method.." request for "..tostring(request.path) .. " on port "..request.handler:serverport());
 192
 193                 if request.onlystatus then
 194                         if not call_callback(request) then
 195                                 return;
 196                         end
 197                 end
 198
 199                 request.state = "headers";
 200
 201                 if #data > linelen then
 202                         return request_reader(request, data:sub(linelen, -1));
 203                 end
 204         end
 205 end
 206
 207 -- The default handler for requests
 208 default_handler = function (method, body, request)
 209         log("debug", method.." request for "..tostring(request.path) .. " on port "..request.handler:serverport());
 210         return { status = "404 Not Found",
 211                         headers = { ["Content-Type"] = "text/html" },
 212                         body = "<html><head><title>Page Not Found</title></head><body>Not here :(</body></html>" };
 213 end
 214
 215
 216 function new_request(handler)
 217         return { handler = handler, conn = handler,
 218                         write = function (...) return handler:write(...); end, state = "request",
 219                         server = http_servers[handler:serverport()],
 220                         send = send_response,
 221                         destroy = destroy_request,
 222                         id = tostring{}:match("%x+$")
 223                          };
 224 end
 225
 226 function destroy_request(request)
 227         log("debug", "Destroying request %s", request.id);
 228         listener = listener or connlisteners_get("httpserver");
 229         if not request.destroyed then
 230                 request.destroyed = true;
 231                 if request.on_destroy then
 232                         log("debug", "Request has destroy callback");
 233                         request.on_destroy(request);
 234                 else
 235                         log("debug", "Request has no destroy callback");
 236                 end
 237                 request.handler:close()
 238                 if request.conn then
 239                         listener.ondisconnect(request.conn, "closed");
 240                 end
 241         end
 242 end
 243
 244 function new(params)
 245         local http_server = http_servers[params.port];
 246         if not http_server then
 247                 http_server = { handlers = {} };
 248                 http_servers[params.port] = http_server;
 249                 -- We weren't already listening on this port, so start now
 250                 connlisteners_start("httpserver", params);
 251         end
 252         if params.base then
 253                 http_server.handlers[params.base] = params.handler;
 254         end
 255 end
 256
 257 function set_default_handler(handler)
 258         default_handler = handler;
 259 end
 260
 261 function new_from_config(ports, handle_request, default_options)
 262         if type(handle_request) == "string" then -- COMPAT with old plugins
 263                 log("warn", "Old syntax of httpserver.new_from_config being used to register %s", handle_request);
 264                 handle_request, default_options = default_options, { base = handle_request };
 265         end
 266         for _, options in ipairs(ports) do
 267                 local port = default_options.port or 5280;
 268                 local base = default_options.base;
 269                 local ssl = default_options.ssl or false;
 270                 local interface = default_options.interface;
 271                 if type(options) == "number" then
 272                         port = options;
 273                 elseif type(options) == "table" then
 274                         port = options.port or port;
 275                         base = options.path or base;
 276                         ssl = options.ssl or ssl;
 277                         interface = options.interface or interface;
 278                 elseif type(options) == "string" then
 279                         base = options;
 280                 end
 281
 282                 if ssl then
 283                         ssl.mode = "server";
 284                         ssl.protocol = "sslv23";
 285                         ssl.options = "no_sslv2";
 286                 end
 287
 288                 new{ port = port, interface = interface,
 289                         base = base, handler = handle_request,
 290                         ssl = ssl, type = (ssl and "ssl") or "tcp" };
 291         end
 292 end
 293
 294 _M.request_reader = request_reader;
 295 _M.send_response = send_response;
 296 _M.urlencode = urlencode;
 297
 298 return _M;