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(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 field.options and 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                                 if field.options and value then
  84                                         form:tag("value"):text(value):up();
  85                                 end
  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();
  92                                                 end
  93                                         else
  94                                                 form:tag("option", { label= val }):tag("value"):text(tostring(val)):up():up();
  95                                         end
  96                                 end
  97                                 if field.options and value then
  98                                         for _, val in ipairs(value) do
  99                                                 form:tag("value"):text(val):up();
 100                                         end
 101                                 end
 102                         end
 103                 end
 104
 105                 local media = field.media;
 106                 if media then
 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()
 110                         end
 111                         form:up();
 112                 end
 113
 114                 if field.required then
 115                         form:tag("required"):up();
 116                 end
 117
 118                 -- Jump back up to list of fields
 119                 form:up();
 120         end
 121         return form;
 122 end
 123
 124 local field_readers = {};
 125
 126 function form_t.data(layout, stanza)
 127         local data = {};
 128         local errors = {};
 129         local present = {};
 130
 131         for _, field in ipairs(layout) do
 132                 local tag;
 133                 for field_tag in stanza:childtags("field") do
 134                         if field.name == field_tag.attr.var then
 135                                 tag = field_tag;
 136                                 break;
 137                         end
 138                 end
 139
 140                 if not tag then
 141                         if field.required then
 142                                 errors[field.name] = "Required value missing";
 143                         end
 144                 else
 145                         present[field.name] = true;
 146                         local reader = field_readers[field.type];
 147                         if reader then
 148                                 data[field.name], errors[field.name] = reader(tag, field.required);
 149                         end
 150                 end
 151         end
 152         if next(errors) then
 153                 return data, errors, present;
 154         end
 155         return data, nil, present;
 156 end
 157
 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";
 164         end
 165         return data; -- Return whatever get_child_text returned, even if empty string
 166 end
 167
 168 field_readers["text-single"] = simple_text;
 169
 170 field_readers["text-private"] = simple_text;
 171
 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);
 177                 if not data then
 178                         return nil, "Invalid JID: " .. raw_data;
 179                 end
 180                 return data;
 181         end
 182
 183 field_readers["jid-multi"] =
 184         function (field_tag, required)
 185                 local result = {};
 186                 local err = {};
 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);
 193                         end
 194                 end
 195                 if #result > 0 then
 196                         return result, (#err > 0 and t_concat(err, "\n") or nil);
 197                 elseif required then
 198                         return nil, "Required value missing";
 199                 end
 200         end
 201
 202 field_readers["list-multi"] =
 203         function (field_tag, required)
 204                 local result = {};
 205                 for value in field_tag:childtags("value") do
 206                         result[#result+1] = value:get_text();
 207                 end
 208                 if #result > 0 then
 209                         return result;
 210                 elseif required then
 211                         return nil, "Required value missing";
 212                 end
 213         end
 214
 215 field_readers["text-multi"] =
 216         function (field_tag, required)
 217                 local data, err = field_readers["list-multi"](field_tag, required);
 218                 if data then
 219                         data = t_concat(data, "\n");
 220                 end
 221                 return data, err;
 222         end
 223
 224 field_readers["list-single"] = simple_text;
 225
 226 local boolean_values = {
 227         ["1"] = true, ["true"] = true,
 228         ["0"] = false, ["false"] = false,
 229 };
 230
 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];
 236                 if value == nil then
 237                         return nil, "Invalid boolean representation:" .. raw_value;
 238                 end
 239                 return value;
 240         end
 241
 242 field_readers["hidden"] =
 243         function (field_tag)
 244                 return field_tag:get_child_text("value");
 245         end
 246
 247 return {
 248         new = new;
 249 };
 250
 251
 252 --[=[
 253
 254 Layout:
 255 {
 256
 257         title = "MUC Configuration",
 258         instructions = [[Use this form to configure options for this MUC room.]],
 259
 260         { name = "FORM_TYPE", type = "hidden", required = true };
 261         { name = "field-name", type = "field-type", required = false };
 262 }
 263
 264
 265 --]=]