Merge pull request #396 from rerobins/add_xep_0122

XEP_0122: Add support for form validation

6 files changed, 315 insertions, 0 deletions

diff --git a/setup.py b/setup.py
index 566683b7..1cd245aa 100755
--- a/setup.py
+++ b/setup.py
@@ -93,6 +93,7 @@ packages     = [ 'sleekxmpp',
                  'sleekxmpp/plugins/xep_0108',
                  'sleekxmpp/plugins/xep_0115',
                  'sleekxmpp/plugins/xep_0118',
+                 'sleekxmpp/plugins/xep_0122',
                  'sleekxmpp/plugins/xep_0128',
                  'sleekxmpp/plugins/xep_0131',
                  'sleekxmpp/plugins/xep_0152',
diff --git a/sleekxmpp/plugins/__init__.py b/sleekxmpp/plugins/__init__.py
index 2c90d357..f501687b 100644
--- a/sleekxmpp/plugins/__init__.py
+++ b/sleekxmpp/plugins/__init__.py
@@ -47,6 +47,7 @@ __all__ = [
     'xep_0108',  # User Activity
     'xep_0115',  # Entity Capabilities
     'xep_0118',  # User Tune
+    'xep_0122',  # Data Forms Validation
     'xep_0128',  # Extended Service Discovery
     'xep_0131',  # Standard Headers and Internet Metadata
     'xep_0133',  # Service Administration
diff --git a/sleekxmpp/plugins/xep_0122/__init__.py b/sleekxmpp/plugins/xep_0122/__init__.py
new file mode 100644
index 00000000..4b3e9483
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0122/__init__.py
@@ -0,0 +1,11 @@
+
+from sleekxmpp.plugins.base import register_plugin
+from sleekxmpp.plugins.xep_0122.stanza import FormValidation
+from sleekxmpp.plugins.xep_0122.data_validation import XEP_0122
+
+
+register_plugin(XEP_0122)
+
+
+# Retain some backwards compatibility
+xep_0122 = XEP_0122
diff --git a/sleekxmpp/plugins/xep_0122/data_validation.py b/sleekxmpp/plugins/xep_0122/data_validation.py
new file mode 100644
index 00000000..ec2cdfcc
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0122/data_validation.py
@@ -0,0 +1,19 @@
+from sleekxmpp.xmlstream import register_stanza_plugin
+from sleekxmpp.plugins import BasePlugin
+from sleekxmpp.plugins.xep_0004 import stanza
+from sleekxmpp.plugins.xep_0004.stanza import FormField
+from sleekxmpp.plugins.xep_0122.stanza import FormValidation
+
+
+class XEP_0122(BasePlugin):
+    """
+    XEP-0004: Data Forms
+    """
+
+    name = 'xep_0122'
+    description = 'XEP-0122: Data Forms Validation'
+    dependencies = set(['xep_0004'])
+    stanza = stanza
+
+    def plugin_init(self):
+        register_stanza_plugin(FormField, FormValidation)
diff --git a/sleekxmpp/plugins/xep_0122/stanza.py b/sleekxmpp/plugins/xep_0122/stanza.py
new file mode 100644
index 00000000..bc3c177a
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0122/stanza.py
@@ -0,0 +1,94 @@
+
+from sleekxmpp.xmlstream import ElementBase, ET
+
+
+class FormValidation(ElementBase):
+    """
+    Validation values for form fields.
+
+    Example:
+
+    <field var='evt.date' type='text-single' label='Event Date/Time'>
+      <validate xmlns='http://jabber.org/protocol/xdata-validate'
+                datatype='xs:dateTime'/>
+      <value>2003-10-06T11:22:00-07:00</value>
+    </field>
+
+    Questions:
+      Should this look at the datatype value and convert the range values as appropriate?
+      Should this stanza provide a pass/fail for a value from the field, or convert field value to datatype?
+    """
+
+    namespace = 'http://jabber.org/protocol/xdata-validate'
+    name = 'validate'
+    plugin_attrib = 'validate'
+    interfaces = {'datatype', 'basic', 'open', 'range', 'regex', }
+    sub_interfaces = {'basic', 'open', 'range', 'regex', }
+    plugin_attrib_map = {}
+    plugin_tag_map = {}
+
+    def _add_field(self, name):
+        self.remove_all()
+        item_xml = ET.Element('{%s}%s' % (self.namespace, name))
+        self.xml.append(item_xml)
+        return item_xml
+
+    def set_basic(self, value):
+        if value:
+            self._add_field('basic')
+        else:
+            del self['basic']
+
+    def set_open(self, value):
+        if value:
+            self._add_field('open')
+        else:
+            del self['open']
+
+    def set_regex(self, regex):
+        if regex:
+            _regex = self._add_field('regex')
+            _regex.text = regex
+        else:
+            del self['regex']
+
+    def set_range(self, value, minimum=None, maximum=None):
+        if value:
+            _range = self._add_field('range')
+            _range.attrib['min'] = str(minimum)
+            _range.attrib['max'] = str(maximum)
+        else:
+            del self['range']
+
+    def remove_all(self, except_tag=None):
+        for a in self.sub_interfaces:
+            if a != except_tag:
+                del self[a]
+
+    def get_basic(self):
+        present = self.xml.find('{%s}basic' % self.namespace)
+        return present is not None
+
+    def get_open(self):
+        present = self.xml.find('{%s}open' % self.namespace)
+        return present is not None
+
+    def get_regex(self):
+        present = self.xml.find('{%s}regex' % self.namespace)
+        if present is not None:
+            return present.text
+
+        return False
+
+    def get_range(self):
+        present = self.xml.find('{%s}range' % self.namespace)
+        if present is not None:
+            attributes = present.attrib
+            return_value = dict()
+            if 'min' in attributes:
+                return_value['minimum'] = attributes['min']
+            if 'max' in attributes:
+                return_value['maximum'] = attributes['max']
+            return return_value
+
+        return False
diff --git a/tests/test_stanza_xep_0122.py b/tests/test_stanza_xep_0122.py
new file mode 100644
index 00000000..fca49bbb
--- /dev/null
+++ b/tests/test_stanza_xep_0122.py
@@ -0,0 +1,189 @@
+import unittest
+
+from sleekxmpp import Message
+from sleekxmpp.test import SleekTest
+import sleekxmpp.plugins.xep_0004 as xep_0004
+import sleekxmpp.plugins.xep_0122 as xep_0122
+from sleekxmpp.xmlstream import register_stanza_plugin
+
+
+class TestDataForms(SleekTest):
+
+    def setUp(self):
+        register_stanza_plugin(Message, xep_0004.Form)
+        register_stanza_plugin(xep_0004.Form, xep_0004.FormField, iterable=True)
+        register_stanza_plugin(xep_0004.FormField, xep_0004.FieldOption, iterable=True)
+        register_stanza_plugin(xep_0004.FormField, xep_0122.FormValidation)
+
+    def test_basic_validation(self):
+        """Testing basic validation setting and getting."""
+        msg = self.Message()
+        form = msg['form']
+        field = form.addField(var='f1',
+                              ftype='text-single',
+                              label='Text',
+                              desc='A text field',
+                              required=True,
+                              value='Some text!')
+
+        validation = field['validate']
+        validation['datatype'] = 'xs:string'
+        validation.set_basic(True)
+
+        self.check(msg, """
+          <message>
+            <x xmlns="jabber:x:data" type="form">
+              <field var="f1" type="text-single" label="Text">
+                <desc>A text field</desc>
+                <required />
+                <value>Some text!</value>
+                <validate xmlns="http://jabber.org/protocol/xdata-validate" datatype="xs:string">
+                    <basic/>
+                </validate>
+              </field>
+            </x>
+          </message>
+        """)
+
+        self.assertTrue(validation.get_basic())
+        self.assertFalse(validation.get_open())
+        self.assertFalse(validation.get_range())
+        self.assertFalse(validation.get_regex())
+
+    def test_open_validation(self):
+        """Testing open validation setting and getting."""
+        msg = self.Message()
+        form = msg['form']
+        field = form.addField(var='f1',
+                              ftype='text-single',
+                              label='Text',
+                              desc='A text field',
+                              required=True,
+                              value='Some text!')
+
+        validation = field['validate']
+        validation.set_open(True)
+
+        self.check(msg, """
+          <message>
+            <x xmlns="jabber:x:data" type="form">
+              <field var="f1" type="text-single" label="Text">
+                <desc>A text field</desc>
+                <required />
+                <value>Some text!</value>
+                <validate xmlns="http://jabber.org/protocol/xdata-validate">
+                    <open />
+                </validate>
+              </field>
+            </x>
+          </message>
+        """)
+
+        self.assertFalse(validation.get_basic())
+        self.assertTrue(validation.get_open())
+        self.assertFalse(validation.get_range())
+        self.assertFalse(validation.get_regex())
+
+    def test_regex_validation(self):
+        """Testing regex validation setting and getting."""
+        msg = self.Message()
+        form = msg['form']
+        field = form.addField(var='f1',
+                              ftype='text-single',
+                              label='Text',
+                              desc='A text field',
+                              required=True,
+                              value='Some text!')
+
+        regex_value = '[0-9]+'
+
+        validation = field['validate']
+        validation.set_regex(regex_value)
+
+        self.check(msg, """
+          <message>
+            <x xmlns="jabber:x:data" type="form">
+              <field var="f1" type="text-single" label="Text">
+                <desc>A text field</desc>
+                <required />
+                <value>Some text!</value>
+                <validate xmlns="http://jabber.org/protocol/xdata-validate">
+                    <regex>[0-9]+</regex>
+                </validate>
+              </field>
+            </x>
+          </message>
+        """)
+
+        self.assertFalse(validation.get_basic())
+        self.assertFalse(validation.get_open())
+        self.assertFalse(validation.get_range())
+        self.assertTrue(validation.get_regex())
+
+        self.assertEqual(regex_value, validation.get_regex())
+
+    def test_range_validation(self):
+        """Testing range validation setting and getting."""
+        msg = self.Message()
+        form = msg['form']
+        field = form.addField(var='f1',
+                              ftype='text-single',
+                              label='Text',
+                              desc='A text field',
+                              required=True,
+                              value='Some text!')
+
+        validation = field['validate']
+        validation.set_range(True, minimum=0, maximum=10)
+
+        self.check(msg, """
+          <message>
+            <x xmlns="jabber:x:data" type="form">
+              <field var="f1" type="text-single" label="Text">
+                <desc>A text field</desc>
+                <required />
+                <value>Some text!</value>
+                <validate xmlns="http://jabber.org/protocol/xdata-validate">
+                    <range min="0" max="10" />
+                </validate>
+              </field>
+            </x>
+          </message>
+        """)
+
+        self.assertDictEqual(dict(minimum=str(0), maximum=str(10)), validation.get_range())
+
+    def test_reported_field_validation(self):
+        """
+        Testing adding validation to the field when it's stored in the reported.
+        :return:
+        """
+        msg = self.Message()
+        form = msg['form']
+        field = form.addReported(var='f1', ftype='text-single', label='Text')
+        validation = field['validate']
+        validation.set_basic(True)
+
+        form.addItem({'f1': 'Some text!'})
+
+        self.check(msg, """
+          <message>
+            <x xmlns="jabber:x:data" type="form">
+              <reported>
+                <field var="f1" type="text-single" label="Text">
+                  <validate xmlns="http://jabber.org/protocol/xdata-validate">
+                    <basic />
+                  </validate>
+                </field>
+              </reported>
+              <item>
+                <field var="f1">
+                  <value>Some text!</value>
+                </field>
+              </item>
+            </x>
+          </message>
+        """)
+
+
+suite = unittest.TestLoader().loadTestsFromTestCase(TestDataForms)