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 pairs, ipairs = pairs, ipairs;
  11 local tostring, type = tostring, type;
  12 local t_concat = table.concat;
  13 local st = require "util.stanza";
  14
  15 module "dataforms"
  16
  17 local xmlns_forms = 'jabber:x:data';
  18
  19 local form_t = {};
  20 local form_mt = { __index = form_t };
  21
  22 function new(layout)
  23         return setmetatable(layout, form_mt);
  24 end
  25
  26 function form_t.form(layout, data, formtype)
  27         local form = st.stanza("x", { xmlns = xmlns_forms, type = formtype or "form" });
  28         if layout.title then
  29                 form:tag("title"):text(layout.title):up();
  30         end
  31         if layout.instructions then
  32                 form:tag("instructions"):text(layout.instructions):up();
  33         end
  34         for n, field in ipairs(layout) do
  35                 local field_type = field.type or "text-single";
  36                 -- Add field tag
  37                 form:tag("field", { type = field_type, var = field.name, label = field.label });
  38
  39                 local value = (data and data[field.name]) or field.value;
  40
  41                 if value then
  42                         -- Add value, depending on type
  43                         if field_type == "hidden" then
  44                                 if type(value) == "table" then
  45                                         -- Assume an XML snippet
  46                                         form:tag("value")
  47                                                 :add_child(value)
  48                                                 :up();
  49                                 else
  50                                         form:tag("value"):text(tostring(value)):up();
  51                                 end
  52                         elseif field_type == "boolean" then
  53                                 form:tag("value"):text((value and "1") or "0"):up();
  54                         elseif field_type == "fixed" then
  55
  56                         elseif field_type == "jid-multi" then
  57                                 for _, jid in ipairs(value) do
  58                                         form:tag("value"):text(jid):up();
  59                                 end
  60                         elseif field_type == "jid-single" then
  61                                 form:tag("value"):text(value):up();
  62                         elseif field_type == "text-single" or field_type == "text-private" then
  63                                 form:tag("value"):text(value):up();
  64                         elseif field_type == "text-multi" then
  65                                 -- Split into multiple <value> tags, one for each line
  66                                 for line in value:gmatch("([^\r\n]+)\r?\n*") do
  67                                         form:tag("value"):text(line):up();
  68                                 end
  69                         elseif field_type == "list-single" then
  70                                 local has_default = false;
  71                                 for _, val in ipairs(value) do
  72                                         if type(val) == "table" then
  73                                                 form:tag("option", { label = val.label }):tag("value"):text(val.value):up():up();
  74                                                 if val.default and (not has_default) then
  75                                                         form:tag("value"):text(val.value):up();
  76                                                         has_default = true;
  77                                                 end
  78                                         else
  79                                                 form:tag("option", { label= val }):tag("value"):text(tostring(val)):up():up();
  80                                         end
  81                                 end
  82                         end
  83                 end
  84
  85                 if field.required then
  86                         form:tag("required"):up();
  87                 end
  88
  89                 -- Jump back up to list of fields
  90                 form:up();
  91         end
  92         return form;
  93 end
  94
  95 local field_readers = {};
  96
  97 function form_t.data(layout, stanza)
  98         local data = {};
  99
 100         for field_tag in stanza:childtags() do
 101                 local field_type;
 102                 for n, field in ipairs(layout) do
 103                         if field.name == field_tag.attr.var then
 104                                 field_type = field.type;
 105                                 break;
 106                         end
 107                 end
 108
 109                 local reader = field_readers[field_type];
 110                 if reader then
 111                         data[field_tag.attr.var] = reader(field_tag);
 112                 end
 113
 114         end
 115         return data;
 116 end
 117
 118 field_readers["text-single"] =
 119         function (field_tag)
 120                 local value = field_tag:child_with_name("value");
 121                 if value then
 122                         return value[1];
 123                 end
 124         end
 125
 126 field_readers["text-private"] =
 127         field_readers["text-single"];
 128
 129 field_readers["jid-single"] =
 130         field_readers["text-single"];
 131
 132 field_readers["jid-multi"] =
 133         function (field_tag)
 134                 local result = {};
 135                 for value_tag in field_tag:childtags() do
 136                         if value_tag.name == "value" then
 137                                 result[#result+1] = value_tag[1];
 138                         end
 139                 end
 140                 return result;
 141         end
 142
 143 field_readers["text-multi"] =
 144         function (field_tag)
 145                 local result = {};
 146                 for value_tag in field_tag:childtags() do
 147                         if value_tag.name == "value" then
 148                                 result[#result+1] = value_tag[1];
 149                         end
 150                 end
 151                 return t_concat(result, "\n");
 152         end
 153
 154 field_readers["list-single"] =
 155         field_readers["text-single"];
 156
 157 field_readers["boolean"] =
 158         function (field_tag)
 159                 local value = field_tag:child_with_name("value");
 160                 if value then
 161                         if value[1] == "1" or value[1] == "true" then
 162                                 return true;
 163                         else
 164                                 return false;
 165                         end
 166                 end
 167         end
 168
 169 field_readers["hidden"] =
 170         function (field_tag)
 171                 local value = field_tag:child_with_name("value");
 172                 if value then
 173                         return value[1];
 174                 end
 175         end
 176
 177 return _M;
 178
 179
 180 --[=[
 181
 182 Layout:
 183 {
 184
 185         title = "MUC Configuration",
 186         instructions = [[Use this form to configure options for this MUC room.]],
 187
 188         { name = "FORM_TYPE", type = "hidden", required = true };
 189         { name = "field-name", type = "field-type", required = false };
 190 }
 191
 192
 193 --]=]