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 ipairs = 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 };
23 local function new(layout)
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 _, 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
56 form:tag("value"):text(value):up();
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(field.options or value) do
73 if type(val) == "table" then
74 form:tag("option", { label = val.label }):tag("value"):text(val.value):up():up();
75 if value == val.value or 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 if field.options and value then
84 form:tag("value"):text(value):up();
86 elseif field_type == "list-multi" then
87 for _, val in ipairs(field.options or value) do
88 if type(val) == "table" then
89 form:tag("option", { label = val.label }):tag("value"):text(val.value):up():up();
90 if not field.options and val.default then
91 form:tag("value"):text(val.value):up();
94 form:tag("option", { label= val }):tag("value"):text(tostring(val)):up():up();
97 if field.options and value then
98 for _, val in ipairs(value) do
99 form:tag("value"):text(val):up();
105 local media = field.media;
107 form:tag("media", { xmlns = "urn:xmpp:media-element", height = media.height, width = media.width });
108 for _, val in ipairs(media) do
109 form:tag("uri", { type = val.type }):text(val.uri):up()
114 if field.required then
115 form:tag("required"):up();
118 -- Jump back up to list of fields
124 local field_readers = {};
126 function form_t.data(layout, stanza)
131 for _, field in ipairs(layout) do
133 for field_tag in stanza:childtags("field") do
134 if field.name == field_tag.attr.var then
141 if field.required then
142 errors[field.name] = "Required value missing";
145 present[field.name] = true;
146 local reader = field_readers[field.type];
148 data[field.name], errors[field.name] = reader(tag, field.required);
153 return data, errors, present;
155 return data, nil, present;
158 local function simple_text(field_tag, required)
159 local data = field_tag:get_child_text("value");
160 -- XEP-0004 does not say if an empty string is acceptable for a required value
161 -- so we will follow HTML5 which says that empty string means missing
162 if required and (data == nil or data == "") then
163 return nil, "Required value missing";
165 return data; -- Return whatever get_child_text returned, even if empty string
168 field_readers["text-single"] = simple_text;
170 field_readers["text-private"] = simple_text;
172 field_readers["jid-single"] =
173 function (field_tag, required)
174 local raw_data, err = simple_text(field_tag, required);
175 if not raw_data then return raw_data, err; end
176 local data = jid_prep(raw_data);
178 return nil, "Invalid JID: " .. raw_data;
183 field_readers["jid-multi"] =
184 function (field_tag, required)
187 for value_tag in field_tag:childtags("value") do
188 local raw_value = value_tag:get_text();
189 local value = jid_prep(raw_value);
190 result[#result+1] = value;
191 if raw_value and not value then
192 err[#err+1] = ("Invalid JID: " .. raw_value);
196 return result, (#err > 0 and t_concat(err, "\n") or nil);
198 return nil, "Required value missing";
202 field_readers["list-multi"] =
203 function (field_tag, required)
205 for value in field_tag:childtags("value") do
206 result[#result+1] = value:get_text();
211 return nil, "Required value missing";
215 field_readers["text-multi"] =
216 function (field_tag, required)
217 local data, err = field_readers["list-multi"](field_tag, required);
219 data = t_concat(data, "\n");
224 field_readers["list-single"] = simple_text;
226 local boolean_values = {
227 ["1"] = true, ["true"] = true,
228 ["0"] = false, ["false"] = false,
231 field_readers["boolean"] =
232 function (field_tag, required)
233 local raw_value, err = simple_text(field_tag, required);
234 if not raw_value then return raw_value, err; end
235 local value = boolean_values[raw_value];
237 return nil, "Invalid boolean representation:" .. raw_value;
242 field_readers["hidden"] =
244 return field_tag:get_child_text("value");
257 title = "MUC Configuration",
258 instructions = [[Use this form to configure options for this MUC room.]],
260 { name = "FORM_TYPE", type = "hidden", required = true };
261 { name = "field-name", type = "field-type", required = false };