util/dataforms.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2009 Matthew Wild
   3 -- Copyright (C) 2008-2009 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)
  27         local form = st.stanza("x", { xmlns = xmlns_forms, type = "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                                 for _, val in ipairs(value) do
  71                                         if type(val) == "table" then
  72                                                 form:tag("option", { label = val.label }):tag("value"):text(val.value):up():up();
  73                                         else
  74                                                 form:tag("option", { label= val }):tag("value"):text(tostring(val)):up():up();
  75                                         end
  76                                 end
  77                         end
  78                 end
  79
  80                 if field.required then
  81                         form:tag("required"):up();
  82                 end
  83
  84                 -- Jump back up to list of fields
  85                 form:up();
  86         end
  87         return form;
  88 end
  89
  90 local field_readers = {};
  91
  92 function form_t.data(layout, stanza)
  93         local data = {};
  94
  95         for field_tag in stanza:childtags() do
  96                 local field_type = field_tag.attr.type;
  97
  98                 local reader = field_readers[field_type];
  99                 if reader then
 100                         data[field_tag.attr.var] = reader(field_tag);
 101                 end
 102
 103         end
 104         return data;
 105 end
 106
 107 field_readers["text-single"] =
 108         function (field_tag)
 109                 local value = field_tag:child_with_name("value");
 110                 if value then
 111                         return value[1];
 112                 end
 113         end
 114
 115 field_readers["text-private"] =
 116         field_readers["text-single"];
 117
 118 field_readers["jid-single"] =
 119         field_readers["text-single"];
 120
 121 field_readers["jid-multi"] =
 122         function (field_tag)
 123                 local result = {};
 124                 for value_tag in field_tag:childtags() do
 125                         if value_tag.name == "value" then
 126                                 result[#result+1] = value_tag[1];
 127                         end
 128                 end
 129                 return result;
 130         end
 131
 132 field_readers["text-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 t_concat(result, "\n");
 141         end
 142
 143 field_readers["list-single"] =
 144         field_readers["text-single"];
 145
 146 field_readers["boolean"] =
 147         function (field_tag)
 148                 local value = field_tag:child_with_name("value");
 149                 if value then
 150                         if value[1] == "1" or value[1] == "true" then
 151                                 return true;
 152                         else
 153                                 return false;
 154                         end
 155                 end
 156         end
 157
 158 field_readers["hidden"] =
 159         function (field_tag)
 160                 local value = field_tag:child_with_name("value");
 161                 if value then
 162                         return value[1];
 163                 end
 164         end
 165
 166 return _M;
 167
 168
 169 --[=[
 170
 171 Layout:
 172 {
 173
 174         title = "MUC Configuration",
 175         instructions = [[Use this form to configure options for this MUC room.]],
 176
 177         { name = "FORM_TYPE", type = "hidden", required = true };
 178         { name = "field-name", type = "field-type", required = false };
 179 }
 180
 181
 182 --]=]