util/dataforms.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2010 Matthew Wild
   3 -- Copyright (C) 2008-2010 Waqas Hussain
   4 --
   5 -- This project is MIT/X11 licensed. Please see the
   6 -- COPYING file in the source package for more information.
   7 --
   8
   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;
  15
  16 local _ENV = nil;
  17
  18 local xmlns_forms = 'jabber:x:data';
  19
  20 local form_t = {};
  21 local form_mt = { __index = form_t };
  22
  23 local function new(layout)
  24         return setmetatable(layout, form_mt);
  25 end
  26
  27 function form_t.form(layout, data, formtype)
  28         local form = st.stanza("x", { xmlns = xmlns_forms, type = formtype or "form" });
  29         if layout.title then
  30                 form:tag("title"):text(layout.title):up();
  31         end
  32         if layout.instructions then
  33                 form:tag("instructions"):text(layout.instructions):up();
  34         end
  35         for _, field in ipairs(layout) do
  36                 local field_type = field.type or "text-single";
  37                 -- Add field tag
  38                 form:tag("field", { type = field_type, var = field.name, label = field.label });
  39
  40                 local value = (data and data[field.name]) or field.value;
  41
  42                 if value then
  43                         -- Add value, depending on type
  44                         if field_type == "hidden" then
  45                                 if type(value) == "table" then
  46                                         -- Assume an XML snippet
  47                                         form:tag("value")
  48                                                 :add_child(value)
  49                                                 :up();
  50                                 else
  51                                         form:tag("value"):text(tostring(value)):up();
  52                                 end
  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();
  60                                 end
  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();
  69                                 end
  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();
  77                                                         has_default = true;
  78                                                 end
  79                                         else
  80                                                 form:tag("option", { label= val }):tag("value"):text(tostring(val)):up():up();
  81                                         end
  82                                 end
  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();
  87                                                 if val.default then
  88                                                         form:tag("value"):text(val.value):up();
  89                                                 end
  90                                         else
  91                                                 form:tag("option", { label= val }):tag("value"):text(tostring(val)):up():up();
  92                                         end
  93                                 end
  94                         end
  95                 end
  96
  97                 local media = field.media;
  98                 if media then
  99                         form:tag("media", { xmlns = "urn:xmpp:media-element", height = media.height, width = media.width });
 100                         for _, val in ipairs(media) do
 101                                 form:tag("uri", { type = val.type }):text(val.uri):up()
 102                         end
 103                         form:up();
 104                 end
 105
 106                 if field.required then
 107                         form:tag("required"):up();
 108                 end
 109
 110                 -- Jump back up to list of fields
 111                 form:up();
 112         end
 113         return form;
 114 end
 115
 116 local field_readers = {};
 117
 118 function form_t.data(layout, stanza)
 119         local data = {};
 120         local errors = {};
 121
 122         for _, field in ipairs(layout) do
 123                 local tag;
 124                 for field_tag in stanza:childtags("field") do
 125                         if field.name == field_tag.attr.var then
 126                                 tag = field_tag;
 127                                 break;
 128                         end
 129                 end
 130
 131                 if not tag then
 132                         if field.required then
 133                                 errors[field.name] = "Required value missing";
 134                         end
 135                 else
 136                         local reader = field_readers[field.type];
 137                         if reader then
 138                                 data[field.name], errors[field.name] = reader(tag, field.required);
 139                         end
 140                 end
 141         end
 142         if next(errors) then
 143                 return data, errors;
 144         end
 145         return data;
 146 end
 147
 148 local function simple_text(field_tag, required)
 149         local data = field_tag:get_child_text("value");
 150         -- XEP-0004 does not say if an empty string is acceptable for a required value
 151         -- so we will follow HTML5 which says that empty string means missing
 152         if required and (data == nil or data == "") then
 153                 return nil, "Required value missing";
 154         end
 155         return data; -- Return whatever get_child_text returned, even if empty string
 156 end
 157
 158 field_readers["text-single"] = simple_text;
 159
 160 field_readers["text-private"] = simple_text;
 161
 162 field_readers["jid-single"] =
 163         function (field_tag, required)
 164                 local raw_data, err = simple_text(field_tag, required);
 165                 if not raw_data then return raw_data, err; end
 166                 local data = jid_prep(raw_data);
 167                 if not data then
 168                         return nil, "Invalid JID: " .. raw_data;
 169                 end
 170                 return data;
 171         end
 172
 173 field_readers["jid-multi"] =
 174         function (field_tag, required)
 175                 local result = {};
 176                 local err = {};
 177                 for value_tag in field_tag:childtags("value") do
 178                         local raw_value = value_tag:get_text();
 179                         local value = jid_prep(raw_value);
 180                         result[#result+1] = value;
 181                         if raw_value and not value then
 182                                 err[#err+1] = ("Invalid JID: " .. raw_value);
 183                         end
 184                 end
 185                 if #result > 0 then
 186                         return result, (#err > 0 and t_concat(err, "\n") or nil);
 187                 elseif required then
 188                         return nil, "Required value missing";
 189                 end
 190         end
 191
 192 field_readers["list-multi"] =
 193         function (field_tag, required)
 194                 local result = {};
 195                 for value in field_tag:childtags("value") do
 196                         result[#result+1] = value:get_text();
 197                 end
 198                 if #result > 0 then
 199                         return result;
 200                 elseif required then
 201                         return nil, "Required value missing";
 202                 end
 203         end
 204
 205 field_readers["text-multi"] =
 206         function (field_tag, required)
 207                 local data, err = field_readers["list-multi"](field_tag, required);
 208                 if data then
 209                         data = t_concat(data, "\n");
 210                 end
 211                 return data, err;
 212         end
 213
 214 field_readers["list-single"] = simple_text;
 215
 216 local boolean_values = {
 217         ["1"] = true, ["true"] = true,
 218         ["0"] = false, ["false"] = false,
 219 };
 220
 221 field_readers["boolean"] =
 222         function (field_tag, required)
 223                 local raw_value, err = simple_text(field_tag, required);
 224                 if not raw_value then return raw_value, err; end
 225                 local value = boolean_values[raw_value];
 226                 if value == nil then
 227                         return nil, "Invalid boolean representation:" .. raw_value;
 228                 end
 229                 return value;
 230         end
 231
 232 field_readers["hidden"] =
 233         function (field_tag)
 234                 return field_tag:get_child_text("value");
 235         end
 236
 237 return {
 238         new = new;
 239 };
 240
 241
 242 --[=[
 243
 244 Layout:
 245 {
 246
 247         title = "MUC Configuration",
 248         instructions = [[Use this form to configure options for this MUC room.]],
 249
 250         { name = "FORM_TYPE", type = "hidden", required = true };
 251         { name = "field-name", type = "field-type", required = false };
 252 }
 253
 254
 255 --]=]