Repository navigation
Expand file tree
/
Copy pathrestserver.lua
More file actions
250 lines (227 loc) · 7.56 KB
/
Copy pathrestserver.lua
File metadata and controls
250 lines (227 loc) · 7.56 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
local restserver = {}
local request = require("wsapi.request")
local response = require("wsapi.response")
local json = require("dkjson")
local unpack = unpack or table.unpack
local function add_resource(self, name, entries, authfunc)
for _, entry in ipairs(entries) do
local path = ("^/" .. name .. "/" .. entry.path):gsub("([^{]+)(%b{})", function (literal,pattern) return literal:gsub("%-", "%%-")..pattern end):gsub("/+", "/"):gsub("/$", "") .. "$"
entry.rest_path = path
entry.match_path = path:gsub("{[^:]*:([^}]*)}", "(%1)"):gsub("{[^}]*}", "([^/]+)")
-- set up auth (if not already present) for all entries of this resource
if not entry.auth and authfunc then entry.auth = authfunc end
path = path:gsub("{[^:]*:([^}]*)}", "%1"):gsub("{[^}]*}", "[^/]+")
local methods = self.config.paths[path]
if not methods then
methods = {}
self.config.paths[path] = methods
table.insert(self.config.path_list, path)
end
if methods[entry.method] then
local ui_path = "/" .. name .. "/" .. entry.path
error("A handler for method "..entry.method.." in path "..ui_path.." is already defined.")
end
methods[entry.method] = entry
end
end
local function set_error_handler(self, entry)
self.error_handler = function(_, code, msg)
return {
response = entry.handler(code, msg),
headers = { ["Content-Type"] = entry.produces or "text/plain" }
}
end
self.error_schema = entry.output_schema
end
local function type_check(tbl, schema)
for k, s in pairs(schema) do
if not tbl[k] then
if not s.optional then
return nil, "missing field '"..k.."'"
end
elseif type(tbl[k]) ~= s.type then
return nil, "in field '"..k.."', expected type "..s.type..", got "..type(tbl[k])
elseif s.array and next(tbl[k]) and not tbl[k][1] then
return nil, "in field '"..k.."', expected an array"
end
end
return true
end
local function decode(data, mimetype, schema)
if mimetype == "application/json" then
local tbl = json.decode(data)
if schema then
local ok, err = type_check(tbl, schema)
if not ok then
return nil, err
end
end
return tbl
elseif mimetype == "text/plain" then
return data or ""
elseif not mimetype or mimetype == "*/*" then
return data or ""
else
error("Mimetype "..mimetype.." not supported.")
end
end
local function encode(data, mimetype, schema)
if mimetype == "application/json" then
if schema then
local ok, err = type_check(data, schema)
if not ok then
return nil, err
end
end
return json.encode(data)
elseif mimetype == "text/plain" then
return data or ""
elseif not mimetype then
return data or ""
else
error("Mimetype "..mimetype.." not supported.")
end
end
local function get_error_response(self, code, msg, wreq)
local res = self.error_handler(wreq, code, msg)
res.headers = res.headers or { ["Content-Type"] = "text/plain" }
local output, err = encode(res.response, res.headers["Content-Type"], self.error_schema)
if not output then
return nil, err
end
res.content = output
return res
end
local function fail(self, wreq, code, msg)
local res, err = get_error_response(self, code, msg, wreq)
local wres = response.new(code, res.headers)
local output
if err then
wres = response.new(500, { ["Content-Type"] = "text/plain" })
output = "Internal Server Error - Server built a response that fails schema validation: "..err
else
output = res.content
end
wres:write(output)
return wres:finish()
end
local function match_path(self, path_info)
for _, path in ipairs(self.config.path_list) do
if path_info:match(path) then
return self.config.paths[path]
end
end
end
local function wsapi_handler_with_self(self, wsapi_env, rs_api)
local wreq = request.new(wsapi_env)
local input_path = wsapi_env.PATH_INFO:gsub("/$", "")
local methods = self.config.paths["^" .. input_path .. "$"] or match_path(self, wsapi_env.PATH_INFO)
local entry = methods and methods[wreq.method]
if not entry then
return fail(self, wreq, 405, "Method Not Allowed")
end
local input, err
if wreq.method == "POST" then
input, err = decode(wreq.POST.post_data, entry.consumes, entry.input_schema)
elseif wreq.method == "GET" then
input = wreq.GET
elseif wreq.method == "DELETE" then
input = ""
else
error("Other methods not implemented yet.")
end
if not input then
return fail(self, wreq, 400, "Bad Request - Your request fails schema validation: "..("" or err) )
end
local placeholder_matches = (entry.rest_path ~= entry.match_path) and { input_path:match(entry.match_path) } or {}
local ok, res
local handler
local pass_wreq = false
if rs_api == "0.3" then
handler = entry.handler
pass_wreq = true
elseif entry.handle_req then
handler = entry.handle_req
pass_wreq = true
else
handler = entry.handler
pass_wreq = false
end
local auth_result = entry.auth and entry.auth(wsapi_env) -- return { errorcode = 401|403, user = 'alice' } or nil
if auth_result and auth_result.errorcode then
return fail(self, wreq, auth_result.errorcode, "Authentication error: "..(auth_result.message or ""))
end
if pass_wreq then
if auth_result then
ok, res = pcall(handler, wreq, input, auth_result.user, unpack(placeholder_matches))
else
ok, res = pcall(handler, wreq, input, unpack(placeholder_matches))
end
else
if auth_result then
ok, res = pcall(handler, input, auth_result.user, unpack(placeholder_matches))
else
ok, res = pcall(handler, input, unpack(placeholder_matches))
end
end
if not ok then
return fail(self, wreq, 500, "Application error: "..res)
end
if not res then
return fail(self, wreq, 500, "Server failed to produce a response.")
end
local output, err = encode(res.config.entity, entry.produces, entry.output_schema)
if not output then
return fail(self, wreq, 500, "Server built a response that fails schema validation: "..err)
end
local headers = { ["Content-Type"] = entry.produces or "text/plain" }
if res.config.headers then
for k,v in pairs(res.config.headers) do
headers[k] = v
end
end
local wres = response.new(res.config.status,headers)
wres:write(output)
return wres:finish()
end
local function add_setter(self, var)
self[var] = function (self, val)
self.config[var] = val
return self
end
end
function restserver.new(rs_api)
local server = {
config = {
paths = {},
path_list = {},
},
enable = function(self, plugin_name)
local mod = require(plugin_name)
mod.extend(self)
return self
end,
add_resource = add_resource,
set_error_handler = set_error_handler,
get_error_response = get_error_response, -- To be used by server plugins
}
add_setter(server, "host")
add_setter(server, "port")
server.wsapi_handler = function(wsapi_env)
return wsapi_handler_with_self(server, wsapi_env, rs_api)
end
server.error_handler = function(wreq, code, msg)
return { response = tostring(code).." "..msg }
end
return server
end
function restserver.response()
local res = {
config = {},
}
add_setter(res, "status")
add_setter(res, "entity")
add_setter(res, "headers")
return res
end
return restserver