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         local present = {};
 122
 123         for _, field in ipairs(layout) do
 124                 local tag;
 125                 for field_tag in stanza:childtags("field") do
 126                         if field.name == field_tag.attr.var then
 127                                 tag = field_tag;
 128                                 break;
 129                         end
 130                 end
 131
 132                 if not tag then
 133                         if field.required then
 134                                 errors[field.name] = "Required value missing";
 135                         end
 136                 else
 137                         present[field.name] = true;
 138                         local reader = field_readers[field.type];
 139                         if reader then
 140                                 data[field.name], errors[field.name] = reader(tag, field.required);
 141                         end
 142                 end
 143         end
 144         if next(errors) then
 145                 return data, errors, present;
 146         end
 147         return data, nil, present;
 148 end
 149
 150 local function simple_text(field_tag, required)
 151         local data = field_tag:get_child_text("value");
 152         -- XEP-0004 does not say if an empty string is acceptable for a required value
 153         -- so we will follow HTML5 which says that empty string means missing
 154         if required and (data == nil or data == "") then
 155                 return nil, "Required value missing";
 156         end
 157         return data; -- Return whatever get_child_text returned, even if empty string
 158 end
 159
 160 field_readers["text-single"] = simple_text;
 161
 162 field_readers["text-private"] = simple_text;
 163
 164 field_readers["jid-single"] =
 165         function (field_tag, required)
 166                 local raw_data, err = simple_text(field_tag, required);
 167                 if not raw_data then return raw_data, err; end
 168                 local data = jid_prep(raw_data);
 169                 if not data then
 170                         return nil, "Invalid JID: " .. raw_data;
 171                 end
 172                 return data;
 173         end
 174
 175 field_readers["jid-multi"] =
 176         function (field_tag, required)
 177                 local result = {};
 178                 local err = {};
 179                 for value_tag in field_tag:childtags("value") do
 180                         local raw_value = value_tag:get_text();
 181                         local value = jid_prep(raw_value);
 182                         result[#result+1] = value;
 183                         if raw_value and not value then
 184                                 err[#err+1] = ("Invalid JID: " .. raw_value);
 185                         end
 186                 end
 187                 if #result > 0 then
 188                         return result, (#err > 0 and t_concat(err, "\n") or nil);
 189                 elseif required then
 190                         return nil, "Required value missing";
 191                 end
 192         end
 193
 194 field_readers["list-multi"] =
 195         function (field_tag, required)
 196                 local result = {};
 197                 for value in field_tag:childtags("value") do
 198                         result[#result+1] = value:get_text();
 199                 end
 200                 if #result > 0 then
 201                         return result;
 202                 elseif required then
 203                         return nil, "Required value missing";
 204                 end
 205         end
 206
 207 field_readers["text-multi"] =
 208         function (field_tag, required)
 209                 local data, err = field_readers["list-multi"](field_tag, required);
 210                 if data then
 211                         data = t_concat(data, "\n");
 212                 end
 213                 return data, err;
 214         end
 215
 216 field_readers["list-single"] = simple_text;
 217
 218 local boolean_values = {
 219         ["1"] = true, ["true"] = true,
 220         ["0"] = false, ["false"] = false,
 221 };
 222
 223 field_readers["boolean"] =
 224         function (field_tag, required)
 225                 local raw_value, err = simple_text(field_tag, required);
 226                 if not raw_value then return raw_value, err; end
 227                 local value = boolean_values[raw_value];
 228                 if value == nil then
 229                         return nil, "Invalid boolean representation:" .. raw_value;
 230                 end
 231                 return value;
 232         end
 233
 234 field_readers["hidden"] =
 235         function (field_tag)
 236                 return field_tag:get_child_text("value");
 237         end
 238
 239 return {
 240         new = new;
 241 };
 242
 243
 244 --[=[
 245
 246 Layout:
 247 {
 248
 249         title = "MUC Configuration",
 250         instructions = [[Use this form to configure options for this MUC room.]],
 251
 252         { name = "FORM_TYPE", type = "hidden", required = true };
 253         { name = "field-name", type = "field-type", required = false };
 254 }
 255
 256
 257 --]=]