2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
9 local setmetatable = setmetatable;
10 local pairs, ipairs = pairs, ipairs;
11 local tostring, type, next = tostring, type, next;
12 local t_concat = table.concat;
13 local st = require "util.stanza";
14 local jid_prep = require "util.jid".prep;
18 local xmlns_forms = 'jabber:x:data';
21 local form_mt = { __index = form_t };
24 return setmetatable(layout, form_mt);
27 function form_t.form(layout, data, formtype)
28 local form = st.stanza("x", { xmlns = xmlns_forms, type = formtype or "form" });
30 form:tag("title"):text(layout.title):up();
32 if layout.instructions then
33 form:tag("instructions"):text(layout.instructions):up();
35 for n, field in ipairs(layout) do
36 local field_type = field.type or "text-single";
38 form:tag("field", { type = field_type, var = field.name, label = field.label });
40 local value = (data and data[field.name]) or field.value;
43 -- Add value, depending on type
44 if field_type == "hidden" then
45 if type(value) == "table" then
46 -- Assume an XML snippet
51 form:tag("value"):text(tostring(value)):up();
53 elseif field_type == "boolean" then
54 form:tag("value"):text((value and "1") or "0"):up();
55 elseif field_type == "fixed" then
57 elseif field_type == "jid-multi" then
58 for _, jid in ipairs(value) do
59 form:tag("value"):text(jid):up();
61 elseif field_type == "jid-single" then
62 form:tag("value"):text(value):up();
63 elseif field_type == "text-single" or field_type == "text-private" then
64 form:tag("value"):text(value):up();
65 elseif field_type == "text-multi" then
66 -- Split into multiple <value> tags, one for each line
67 for line in value:gmatch("([^\r\n]+)\r?\n*") do
68 form:tag("value"):text(line):up();
70 elseif field_type == "list-single" then
71 local has_default = false;
72 for _, val in ipairs(value) do
73 if type(val) == "table" then
74 form:tag("option", { label = val.label }):tag("value"):text(val.value):up():up();
75 if val.default and (not has_default) then
76 form:tag("value"):text(val.value):up();
80 form:tag("option", { label= val }):tag("value"):text(tostring(val)):up():up();
83 elseif field_type == "list-multi" then
84 for _, val in ipairs(value) do
85 if type(val) == "table" then
86 form:tag("option", { label = val.label }):tag("value"):text(val.value):up():up();
88 form:tag("value"):text(val.value):up();
91 form:tag("option", { label= val }):tag("value"):text(tostring(val)):up():up();
97 if field.required then
98 form:tag("required"):up();
101 -- Jump back up to list of fields
107 local field_readers = {};
108 local field_verifiers = {};
110 function form_t.data(layout, stanza)
114 for _, field in ipairs(layout) do
116 for field_tag in stanza:childtags() do
117 if field.name == field_tag.attr.var then
124 if field.required then
125 errors[field.name] = "Required value missing";
128 local reader = field_readers[field.type];
129 local verifier = field.verifier or field_verifiers[field.type];
131 data[field.name] = reader(tag);
133 errors[field.name] = verifier(data[field.name], tag, field.required);
144 field_readers["text-single"] =
146 local value = field_tag:child_with_name("value");
152 field_verifiers["text-single"] =
153 function (data, field_tag, required)
154 if ((not data) or (#data == 0)) and required then
155 return "Required value missing";
159 field_readers["text-private"] =
160 field_readers["text-single"];
162 field_verifiers["text-private"] =
163 field_verifiers["text-single"];
165 field_readers["jid-single"] =
166 field_readers["text-single"];
168 field_verifiers["jid-single"] =
169 function (data, field_tag, required)
170 if ((not data) or (#data == 0)) and required then
171 return "Required value missing";
173 if not jid_prep(data) then
174 return "Invalid JID";
178 field_readers["jid-multi"] =
181 for value_tag in field_tag:childtags() do
182 if value_tag.name == "value" then
183 result[#result+1] = value_tag[1];
189 field_verifiers["jid-multi"] =
190 function (data, field_tag, required)
191 if #data == 0 and required then
192 return "Required value missing";
195 for _, jid in ipairs(data) do
196 if not jid_prep(jid) then
197 return "Invalid JID";
202 field_readers["text-multi"] =
205 for value_tag in field_tag:childtags() do
206 if value_tag.name == "value" then
207 result[#result+1] = value_tag[1];
210 return t_concat(result, "\n");
213 field_verifiers["text-multi"] =
214 field_verifiers["text-single"];
216 field_readers["list-single"] =
217 field_readers["text-single"];
219 field_verifiers["list-single"] =
220 field_verifiers["text-single"];
222 field_readers["list-multi"] =
225 for value_tag in field_tag:childtags() do
226 if value_tag.name == "value" then
227 result[#result+1] = value_tag[1];
233 field_verifiers["list-multi"] =
234 function (data, field_tag, required)
235 if #data == 0 and required then
236 return "Required value missing";
240 field_readers["boolean"] =
242 local value = field_tag:child_with_name("value");
244 if value[1] == "1" or value[1] == "true" then
252 field_verifiers["boolean"] =
253 function (data, field_tag, required)
254 data = field_readers["text-single"](field_tag);
255 if ((not data) or (#data == 0)) and required then
256 return "Required value missing";
258 if data ~= "1" and data ~= "true" and data ~= "0" and data ~= "false" then
259 return "Invalid boolean representation";
263 field_readers["hidden"] =
265 local value = field_tag:child_with_name("value");
271 field_verifiers["hidden"] =
272 function (data, field_tag, required)
284 title = "MUC Configuration",
285 instructions = [[Use this form to configure options for this MUC room.]],
287 { name = "FORM_TYPE", type = "hidden", required = true };
288 { name = "field-name", type = "field-type", required = false };