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 = {};
109 function form_t.data(layout, stanza)
113 for _, field in ipairs(layout) do
115 for field_tag in stanza:childtags() do
116 if field.name == field_tag.attr.var then
123 if field.required then
124 errors[field.name] = "Required value missing";
127 local reader = field_readers[field.type];
129 data[field.name], errors[field.name] = reader(tag, field.required);
139 field_readers["text-single"] =
140 function (field_tag, required)
141 local data = field_tag:get_child_text("value");
142 if data and #data > 0 then
145 return nil, "Required value missing";
149 field_readers["text-private"] =
150 field_readers["text-single"];
152 field_readers["jid-single"] =
153 function (field_tag, required)
154 local raw_data = field_tag:get_child_text("value")
155 local data = jid_prep(raw_data);
156 if data and #data > 0 then
159 return nil, "Invalid JID: " .. raw_data;
161 return nil, "Required value missing";
165 field_readers["jid-multi"] =
166 function (field_tag, required)
169 for value_tag in field_tag:childtags("value") do
170 local raw_value = value_tag:get_text();
171 local value = jid_prep(raw_value);
172 result[#result+1] = value;
173 if raw_value and not value then
174 err[#err+1] = ("Invalid JID: " .. raw_value);
178 return result, (#err > 0 and t_concat(err, "\n") or nil);
180 return nil, "Required value missing";
184 field_readers["list-multi"] =
185 function (field_tag, required)
187 for value in field_tag:childtags("value") do
188 result[#result+1] = value:get_text();
190 return result, (required and #result == 0 and "Required value missing" or nil);
193 field_readers["text-multi"] =
194 function (field_tag, required)
195 local data, err = field_readers["list-multi"](field_tag, required);
197 data = t_concat(data, "\n");
202 field_readers["list-single"] =
203 field_readers["text-single"];
205 local boolean_values = {
206 ["1"] = true, ["true"] = true,
207 ["0"] = false, ["false"] = false,
210 field_readers["boolean"] =
211 function (field_tag, required)
212 local raw_value = field_tag:get_child_text("value");
213 local value = boolean_values[raw_value ~= nil and raw_value];
216 elseif raw_value then
217 return nil, "Invalid boolean representation";
219 return nil, "Required value missing";
223 field_readers["hidden"] =
225 return field_tag:get_child_text("value");
236 title = "MUC Configuration",
237 instructions = [[Use this form to configure options for this MUC room.]],
239 { name = "FORM_TYPE", type = "hidden", required = true };
240 { name = "field-name", type = "field-type", required = false };