aboutsummaryrefslogtreecommitdiffstats
path: root/util/dataforms.lua
blob: 6bd44bdcbe2a9c8dec0c8415184dbe26d7343a2b (plain)
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
-- Prosody IM
-- Copyright (C) 2008-2010 Matthew Wild
-- Copyright (C) 2008-2010 Waqas Hussain
--
-- This project is MIT/X11 licensed. Please see the
-- COPYING file in the source package for more information.
--

local setmetatable = setmetatable;
local ipairs = ipairs;
local type, next = type, next;
local tonumber = tonumber;
local tostring = tostring;
local t_concat = table.concat;
local st = require "util.stanza";
local jid_prep = require "util.jid".prep;
local datetime = require "util.datetime";

local _ENV = nil;
-- luacheck: std none

local xmlns_forms = 'jabber:x:data';
local xmlns_validate = 'http://jabber.org/protocol/xdata-validate';

local form_t = {};
local form_mt = { __index = form_t };

local function new(layout)
	return setmetatable(layout, form_mt);
end

function form_t.form(layout, data, formtype)
	if not formtype then formtype = "form" end
	local form = st.stanza("x", { xmlns = xmlns_forms, type = formtype });
	if formtype == "cancel" then
		return form;
	end
	if formtype ~= "submit" then
		if layout.title then
			form:tag("title"):text(layout.title):up();
		end
		if layout.instructions then
			form:tag("instructions"):text(layout.instructions):up();
		end
	end
	for _, field in ipairs(layout) do
		local field_type = field.type or "text-single";
		-- Add field tag
		form:tag("field", { type = field_type, var = field.var or field.name, label = formtype ~= "submit" and field.label or nil });

		if formtype ~= "submit" then
			if field.desc then
				form:text_tag("desc", field.desc);
			end
		end

		if formtype == "form" and field.datatype then
			form:tag("validate", { xmlns = xmlns_validate, datatype = field.datatype });
			if field.range_min or field.range_max then
				form:tag("range", {
						min = field.range_min and tostring(field.range_min),
						max = field.range_max and tostring(field.range_max),
					}):up();
			end
			-- <basic/> assumed
			form:up();
		end


		local value = field.value;
		local options = field.options;

		if data and data[field.name] ~= nil then
			value = data[field.name];

			if formtype == "form" and type(value) == "table"
				and (field_type == "list-single" or field_type == "list-multi") then
				-- Allow passing dynamically generated options as values
				options, value = value, nil;
			end
		end

		if formtype == "form" and options then
			local defaults = {};
			for _, val in ipairs(options) do
				if type(val) == "table" then
					form:tag("option", { label = val.label }):tag("value"):text(val.value):up():up();
					if val.default then
						defaults[#defaults+1] = val.value;
					end
				else
					form:tag("option", { label= val }):tag("value"):text(val):up():up();
				end
			end
			if not value then
				if field_type == "list-single" then
					value = defaults[1];
				elseif field_type == "list-multi" then
					value = defaults;
				end
			end
		end

		if value ~= nil then
			if type(value) == "number" then
				if field.datatype == "xs:dateTime" then
					value = datetime.datetime(value);
				elseif field_type == "boolean" then
					value = value ~= 0;
				else
					value = ("%g"):format(value);
				end
			end
			-- Add value, depending on type
			if field_type == "hidden" then
				if type(value) == "table" then
					-- Assume an XML snippet
					form:tag("value")
						:add_child(value)
						:up();
				else
					form:tag("value"):text(value):up();
				end
			elseif field_type == "boolean" then
				form:tag("value"):text((value and "1") or "0"):up();
			elseif field_type == "fixed" then
				form:tag("value"):text(value):up();
			elseif field_type == "jid-multi" then
				for _, jid in ipairs(value) do
					form:tag("value"):text(jid):up();
				end
			elseif field_type == "jid-single" then
				form:tag("value"):text(value):up();
			elseif field_type == "text-single" or field_type == "text-private" then
				form:tag("value"):text(value):up();
			elseif field_type == "text-multi" then
				-- Split into multiple <value> tags, one for each line
				for line in value:gmatch("([^\r\n]+)\r?\n*") do
					form:tag("value"):text(line):up();
				end
			elseif field_type == "list-single" then
				form:tag("value"):text(value):up();
			elseif field_type == "list-multi" then
				for _, val in ipairs(value) do
					form:tag("value"):text(val):up();
				end
			end
		end

		local media = field.media;
		if media then
			form:tag("media", { xmlns = "urn:xmpp:media-element", height = ("%g"):format(media.height), width = ("%g"):format(media.width) });
			for _, val in ipairs(media) do
				form:tag("uri", { type = val.type }):text(val.uri):up()
			end
			form:up();
		end

		if formtype == "form" and field.required then
			form:tag("required"):up();
		end

		-- Jump back up to list of fields
		form:up();
	end
	return form;
end

local field_readers = {};
local data_validators = {};

function form_t.data(layout, stanza, current)
	local data = {};
	local errors = {};
	local present = {};

	for _, field in ipairs(layout) do
		local tag;
		for field_tag in stanza:childtags("field") do
			if (field.var or field.name) == field_tag.attr.var then
				tag = field_tag;
				break;
			end
		end

		if not tag then
			if current and current[field.name] ~= nil then
				data[field.name] = current[field.name];
			elseif field.required then
				errors[field.name] = "Required value missing";
			end
		elseif field.name then
			present[field.name] = true;
			local reader = field_readers[field.type];
			if reader then
				local value, err = reader(tag, field.required);
				local validator = field.datatype and data_validators[field.datatype];
				if value ~= nil and validator then
					local valid, ret = validator(value, field);
					if valid then
						value = ret;
					else
						value, err = nil, ret or ("Invalid value for data of type " .. field.datatype);
					end
				end
				data[field.name], errors[field.name] = value, err;
			end
		end
	end
	if next(errors) then
		return data, errors, present;
	end
	return data, nil, present;
end

local function simple_text(field_tag, required)
	local data = field_tag:get_child_text("value");
	-- XEP-0004 does not say if an empty string is acceptable for a required value
	-- so we will follow HTML5 which says that empty string means missing
	if required and (data == nil or data == "") then
		return nil, "Required value missing";
	end
	return data; -- Return whatever get_child_text returned, even if empty string
end

field_readers["text-single"] = simple_text;

field_readers["text-private"] = simple_text;

field_readers["jid-single"] =
	function (field_tag, required)
		local raw_data, err = simple_text(field_tag, required);
		if not raw_data then return raw_data, err; end
		local data = jid_prep(raw_data);
		if not data then
			return nil, "Invalid JID: " .. raw_data;
		end
		return data;
	end

field_readers["jid-multi"] =
	function (field_tag, required)
		local result = {};
		local err = {};
		for value_tag in field_tag:childtags("value") do
			local raw_value = value_tag:get_text();
			local value = jid_prep(raw_value);
			result[#result+1] = value;
			if raw_value and not value then
				err[#err+1] = ("Invalid JID: " .. raw_value);
			end
		end
		if #result > 0 then
			return result, (#err > 0 and t_concat(err, "\n") or nil);
		elseif required then
			return nil, "Required value missing";
		end
	end

field_readers["list-multi"] =
	function (field_tag, required)
		local result = {};
		for value in field_tag:childtags("value") do
			result[#result+1] = value:get_text();
		end
		if #result > 0 then
			return result;
		elseif required then
			return nil, "Required value missing";
		end
	end

field_readers["text-multi"] =
	function (field_tag, required)
		local data, err = field_readers["list-multi"](field_tag, required);
		if data then
			data = t_concat(data, "\n");
		end
		return data, err;
	end

field_readers["list-single"] = simple_text;

local boolean_values = {
	["1"] = true, ["true"] = true,
	["0"] = false, ["false"] = false,
};

field_readers["boolean"] =
	function (field_tag, required)
		local raw_value, err = simple_text(field_tag, required);
		if not raw_value then return raw_value, err; end
		local value = boolean_values[raw_value];
		if value == nil then
			return nil, "Invalid boolean representation:" .. raw_value;
		end
		return value;
	end

field_readers["hidden"] =
	function (field_tag)
		return field_tag:get_child_text("value");
	end

data_validators["xs:integer"] =
	function (data, field)
		local n = tonumber(data);
		if not n then
			return false, "not a number";
		elseif n % 1 ~= 0 then
			return false, "not an integer";
		end
		if field.range_max and n > field.range_max then
			return false, "out of bounds";
		elseif field.range_min and n < field.range_min then
			return false, "out of bounds";
		end
		return true, n;
	end

data_validators["pubsub:integer-or-max"] =
	function (data, field)
		if data == "max" then
			return true, data;
		else
			return data_validators["xs:integer"](data, field);
		end
	end

data_validators["xs:dateTime"] =
	function(data, field) -- luacheck: ignore 212/field
		local n = datetime.parse(data);
		if not n then return false, "invalid timestamp"; end
		return true, n;
	end


local function get_form_type(form)
	if not st.is_stanza(form) then
		return nil, "not a stanza object";
	elseif form.attr.xmlns ~= "jabber:x:data" or form.name ~= "x" then
		return nil, "not a dataform element";
	end
	for field in form:childtags("field") do
		if field.attr.var == "FORM_TYPE" then
			return field:get_child_text("value");
		end
	end
	return "";
end

return {
	new = new;
	get_type = get_form_type;
};


--[=[

Layout:
{

	title = "MUC Configuration",
	instructions = [[Use this form to configure options for this MUC room.]],

	{ name = "FORM_TYPE", type = "hidden", required = true };
	{ name = "field-name", type = "field-type", required = false };
}


--]=]