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
  14 local st = require "util.stanza";
  15
  16 module "dataforms"
  17
  18 local xmlns_forms = 'jabber:x:data';
  19
  20 local form_t = {};
  21 local form_mt = { __index = form_t };
  22
  23 function new(layout)
  24         return setmetatable(layout, form_mt);
  25 end
  26
  27 function form_t.form(layout, data)
  28         local form = st.stanza("x", { xmlns = xmlns_forms, type = "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 n, 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                 -- 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                         elseif value then
  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                 end
  70
  71                 if field.required then
  72                         form:tag("required"):up();
  73                 end
  74
  75                 -- Jump back up to list of fields
  76                 form:up();
  77         end
  78         return form;
  79 end
  80
  81 local field_readers = {};
  82
  83 function form_t.data(layout, stanza)
  84         local data = {};
  85
  86         for field_tag in stanza:childtags() do
  87                 local field_type = field_tag.attr.type;
  88
  89                 local reader = field_readers[field_type];
  90                 if reader then
  91                         data[field_tag.attr.var] = reader(field_tag);
  92                 end
  93
  94         end
  95         return data;
  96 end
  97
  98 field_readers["text-single"] =
  99         function (field_tag)
 100                 local value = field_tag:child_with_name("value");
 101                 if value then
 102                         return value[1];
 103                 end
 104         end
 105
 106 field_readers["text-private"] =
 107         field_readers["text-single"];
 108
 109 field_readers["jid-single"] =
 110         field_readers["text-single"];
 111
 112 field_readers["text-multi"] =
 113         function (field_tag)
 114                 local result = {};
 115                 for value_tag in field_tag:childtags() do
 116                         if value_tag.name == "value" then
 117                                 result[#result+1] = value_tag[1];
 118                         end
 119                 end
 120                 return t_concat(result, "\n");
 121         end
 122
 123 field_readers["boolean"] =
 124         function (field_tag)
 125                 local value = field_tag:child_with_name("value");
 126                 if value then
 127                         if value[1] == "1" or value[1] == "true" then
 128                                 return true;
 129                         else
 130                                 return false;
 131                         end
 132                 end
 133         end
 134
 135 field_readers["hidden"] =
 136         function (field_tag)
 137                 local value = field_tag:child_with_name("value");
 138                 if value then
 139                         return value[1];
 140                 end
 141         end
 142
 143 return _M;
 144
 145
 146 --[=[
 147
 148 Layout:
 149 {
 150
 151         title = "MUC Configuration",
 152         instructions = [[Use this form to configure options for this MUC room.]],
 153
 154         { name = "FORM_TYPE", type = "hidden", required = true };
 155         { name = "field-name", type = "field-type", required = false };
 156 }
 157
 158
 159 --]=]