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                 -- Add value, depending on type
  42                 if field_type == "hidden" then
  43                         if type(value) == "table" then
  44                                 -- Assume an XML snippet
  45                                 form:tag("value")
  46                                         :add_child(value)
  47                                         :up();
  48                         elseif value then
  49                                 form:tag("value"):text(tostring(value)):up();
  50                         end
  51                 elseif field_type == "boolean" then
  52                         form:tag("value"):text((value and "1") or "0"):up();
  53                 elseif field_type == "fixed" then
  54
  55                 elseif field_type == "jid-multi" then
  56                         for _, jid in ipairs(value) do
  57                                 form:tag("value"):text(jid):up();
  58                         end
  59                 elseif field_type == "jid-single" then
  60                         form:tag("value"):text(value):up();
  61                 elseif field_type == "text-single" or field_type == "text-private" then
  62                         form:tag("value"):text(value):up();
  63                 elseif field_type == "text-multi" then
  64                         -- Split into multiple <value> tags, one for each line
  65                         for line in value:gmatch("([^\r\n]+)\r?\n*") do
  66                                 form:tag("value"):text(line):up();
  67                         end
  68                 elseif field_type == "list-single" then
  69                         for _, val in ipairs(value) do
  70                                 if type(val) == "table" then
  71                                         form:tag("option", { label = val.label }):tag("value"):text(val.value):up():up();
  72                                 else
  73                                         form:tag("option", { label= val }):tag("value"):text(tostring(val)):up():up();
  74                                 end
  75                         end
  76                 end
  77
  78                 if field.required then
  79                         form:tag("required"):up();
  80                 end
  81
  82                 -- Jump back up to list of fields
  83                 form:up();
  84         end
  85         return form;
  86 end
  87
  88 local field_readers = {};
  89
  90 function form_t.data(layout, stanza)
  91         local data = {};
  92
  93         for field_tag in stanza:childtags() do
  94                 local field_type = field_tag.attr.type;
  95
  96                 local reader = field_readers[field_type];
  97                 if reader then
  98                         data[field_tag.attr.var] = reader(field_tag);
  99                 end
 100
 101         end
 102         return data;
 103 end
 104
 105 field_readers["text-single"] =
 106         function (field_tag)
 107                 local value = field_tag:child_with_name("value");
 108                 if value then
 109                         return value[1];
 110                 end
 111         end
 112
 113 field_readers["text-private"] =
 114         field_readers["text-single"];
 115
 116 field_readers["jid-single"] =
 117         field_readers["text-single"];
 118
 119 field_readers["text-multi"] =
 120         function (field_tag)
 121                 local result = {};
 122                 for value_tag in field_tag:childtags() do
 123                         if value_tag.name == "value" then
 124                                 result[#result+1] = value_tag[1];
 125                         end
 126                 end
 127                 return t_concat(result, "\n");
 128         end
 129
 130 field_readers["list-single"] =
 131         field_readers["text-single"];
 132
 133 field_readers["boolean"] =
 134         function (field_tag)
 135                 local value = field_tag:child_with_name("value");
 136                 if value then
 137                         if value[1] == "1" or value[1] == "true" then
 138                                 return true;
 139                         else
 140                                 return false;
 141                         end
 142                 end
 143         end
 144
 145 field_readers["hidden"] =
 146         function (field_tag)
 147                 local value = field_tag:child_with_name("value");
 148                 if value then
 149                         return value[1];
 150                 end
 151         end
 152
 153 return _M;
 154
 155
 156 --[=[
 157
 158 Layout:
 159 {
 160
 161         title = "MUC Configuration",
 162         instructions = [[Use this form to configure options for this MUC room.]],
 163
 164         { name = "FORM_TYPE", type = "hidden", required = true };
 165         { name = "field-name", type = "field-type", required = false };
 166 }
 167
 168
 169 --]=]