Merge branch 'caps-hash'

Conflicts:
	docs/reference/wocky-docs.sgml
	wocky/Makefile.am

Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk>

2 files changed, 647 insertions, 2 deletions

diff --git a/tests/Makefile.am b/tests/Makefile.am
index f2ff173..c2d5c0a 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -61,8 +61,8 @@ TEST_PROGS = wocky-xmpp-reader-test \
   wocky-jid-validation-test \
   wocky-sasl-utils-test \
   wocky-utils-test \
-  wocky-scram-sha1-test
-
+  wocky-scram-sha1-test \
+  wocky-caps-hash-test
 
 wocky_tls_test_DEPENDENCIES = $(LIBWOCKY)
 wocky_tls_test_SOURCES = \
@@ -235,6 +235,11 @@ wocky_http_proxy_test_SOURCES = wocky-http-proxy-test.c \
   wocky-test-helper.c wocky-test-helper.h \
   wocky-test-stream.c wocky-test-stream.h
 
+wocky_caps_hash_test_DEPENDENCIES = $(LIBWOCKY)
+wocky_caps_hash_test_SOURCES = wocky-caps-hash-test.c \
+  wocky-test-helper.c wocky-test-helper.h \
+  wocky-test-stream.c wocky-test-stream.h
+
 if HAVE_GIO_PROXY
   TEST_PROGS += wocky-http-proxy-test
 endif
diff --git a/tests/wocky-caps-hash-test.c b/tests/wocky-caps-hash-test.c
new file mode 100644
index 0000000..8aa463c
--- /dev/null
+++ b/tests/wocky-caps-hash-test.c
@@ -0,0 +1,640 @@
+#include <glib.h>
+
+#include <wocky/wocky-caps-hash.h>
+#include <wocky/wocky-stanza.h>
+
+#include "wocky-test-helper.h"
+
+static gboolean
+check_hash (WockyStanza *stanza,
+  const gchar *expected)
+{
+  gchar *hash;
+
+  hash = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_assert_cmpstr (hash, ==, expected);
+  g_object_unref (stanza);
+  g_free (hash);
+  return TRUE;
+}
+
+static void
+test_simple (void)
+{
+  /* Simple example from XEP-0115 */
+  WockyStanza *stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_RESULT, NULL, NULL,
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Exodus 0.9.1",
+        '@', "type", "pc",
+      ')',
+      '(', "feature",
+          '@', "var", "http://jabber.org/protocol/disco#info", ')',
+      '(', "feature",
+          '@', "var", "http://jabber.org/protocol/disco#items", ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/muc", ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/caps", ')',
+      NULL);
+
+  check_hash (stanza, "QgayPKawpkPSDYmwT/WM94uAlu0=");
+}
+
+static void
+test_complex (void)
+{
+  /* Complex example from XEP-0115 */
+  WockyStanza *stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Psi 0.11",
+        '@', "type", "pc",
+        '#', "en",
+      ')',
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Ψ 0.11",
+        '@', "type", "pc",
+        '#', "el",
+      ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/disco#info", ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/disco#items", ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/muc", ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/caps", ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "FORM_TYPE",
+          '@', "type", "hidden",
+          '(', "value", '$', "urn:xmpp:dataforms:softwareinfo", ')',
+        ')',
+        '(', "field",
+          '@', "var", "ip_version",
+          '(', "value", '$', "ipv4", ')',
+          '(', "value", '$', "ipv6", ')',
+        ')',
+        '(', "field",
+          '@', "var", "os",
+          '(', "value", '$', "Mac", ')',
+        ')',
+        '(', "field",
+          '@', "var", "os_version",
+          '(', "value", '$', "10.5.1", ')',
+        ')',
+        '(', "field",
+          '@', "var", "software",
+          '(', "value", '$', "Psi", ')',
+        ')',
+        '(', "field",
+          '@', "var", "software_version",
+          '(', "value", '$', "0.11", ')',
+        ')',
+      ')',
+      NULL);
+
+  check_hash (stanza, "q07IKJEyjvHSyhy//CH0CxmKi8w=");
+}
+
+static void
+test_sorting_simple (void)
+{
+  WockyStanza *stanza;
+  gchar *one, *two;
+
+  stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Psi 0.11",
+        '@', "type", "pc",
+        '#', "en",
+      ')',
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Ψ 0.11",
+        '@', "type", "pc",
+        '#', "el",
+      ')',
+      NULL);
+
+  one = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_object_unref (stanza);
+
+  stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Ψ 0.11",
+        '@', "type", "pc",
+        '#', "el",
+      ')',
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Psi 0.11",
+        '@', "type", "pc",
+        '#', "en",
+      ')',
+      NULL);
+
+  two = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_object_unref (stanza);
+
+  g_assert_cmpstr (one, ==, two);
+
+  g_free (one);
+  g_free (two);
+}
+
+static void
+test_sorting_complex (void)
+{
+  WockyStanza *stanza;
+  gchar *one, *two;
+
+  stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Psi 0.11",
+        '@', "type", "pc",
+        '#', "en",
+      ')',
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Ψ 0.11",
+        '@', "type", "pc",
+        '#', "el",
+      ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/disco#info", ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/disco#items", ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/muc", ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/caps", ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "FORM_TYPE",
+          '@', "type", "hidden",
+          '(', "value", '$', "urn:xmpp:dataforms:softwareinfo", ')',
+        ')',
+        '(', "field",
+          '@', "var", "ip_version",
+          '(', "value", '$', "ipv4", ')',
+          '(', "value", '$', "ipv6", ')',
+        ')',
+        '(', "field",
+          '@', "var", "os",
+          '(', "value", '$', "Mac", ')',
+        ')',
+        '(', "field",
+          '@', "var", "os_version",
+          '(', "value", '$', "10.5.1", ')',
+        ')',
+        '(', "field",
+          '@', "var", "software",
+          '(', "value", '$', "Psi", ')',
+        ')',
+        '(', "field",
+          '@', "var", "software_version",
+          '(', "value", '$', "0.11", ')',
+        ')',
+      ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "FORM_TYPE",
+          '@', "type", "hidden",
+          '(', "value", '$', "urn:xmpp:dataforms:somethingelse", ')',
+        ')',
+        '(', "field",
+          '@', "var", "foo",
+          '(', "value", '$', "bananas", ')',
+          '(', "value", '$', "cheese", ')',
+        ')',
+        '(', "field",
+          '@', "var", "wheeeeee",
+          '(', "value", '$', "I'm on a rollercoster", ')',
+        ')',
+        '(', "field",
+          '@', "var", "loldongz",
+          '@', "type", "boolean",
+          '(', "value", '$', "1", ')',
+        ')',
+      ')',
+      NULL);
+
+  one = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_object_unref (stanza);
+
+  stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "feature", '@', "var", "http://jabber.org/protocol/disco#items", ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "FORM_TYPE",
+          '@', "type", "hidden",
+          '(', "value", '$', "urn:xmpp:dataforms:somethingelse", ')',
+        ')',
+        '(', "field",
+          '@', "var", "wheeeeee",
+          '(', "value", '$', "I'm on a rollercoster", ')',
+        ')',
+        '(', "field",
+          '@', "var", "loldongz",
+          '@', "type", "boolean",
+          '(', "value", '$', "1", ')',
+        ')',
+        '(', "field",
+          '@', "var", "foo",
+          '(', "value", '$', "cheese", ')',
+          '(', "value", '$', "bananas", ')',
+        ')',
+      ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/muc", ')',
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Ψ 0.11",
+        '@', "type", "pc",
+        '#', "el",
+      ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/disco#info", ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "FORM_TYPE",
+          '@', "type", "hidden",
+          '(', "value", '$', "urn:xmpp:dataforms:softwareinfo", ')',
+        ')',
+        '(', "field",
+          '@', "var", "software",
+          '(', "value", '$', "Psi", ')',
+        ')',
+        '(', "field",
+          '@', "var", "os",
+          '(', "value", '$', "Mac", ')',
+        ')',
+        '(', "field",
+          '@', "var", "os_version",
+          '(', "value", '$', "10.5.1", ')',
+        ')',
+        '(', "field",
+          '@', "var", "software_version",
+          '(', "value", '$', "0.11", ')',
+        ')',
+        '(', "field",
+          '@', "var", "ip_version",
+          '(', "value", '$', "ipv4", ')',
+          '(', "value", '$', "ipv6", ')',
+        ')',
+      ')',
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Psi 0.11",
+        '@', "type", "pc",
+        '#', "en",
+      ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/caps", ')',
+      NULL);
+
+  two = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_object_unref (stanza);
+
+  g_assert_cmpstr (one, ==, two);
+
+  g_free (one);
+  g_free (two);
+}
+
+static void
+test_dataforms_invalid (void)
+{
+  gchar *out;
+  /* this stanza has a bad data form type */
+  WockyStanza *stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Psi 0.11",
+        '@', "type", "pc",
+        '#', "en",
+      ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "lol",
+      ')',
+      NULL);
+
+  out = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_object_unref (stanza);
+
+  /* should have failed, so no output. of course if the test fails
+   * then the string won't be freed! oh no!  */
+  g_assert (out == NULL);
+
+  /* now with no FORM_TYPE field but fine otherwise */
+  stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Psi 0.11",
+        '@', "type", "pc",
+        '#', "en",
+      ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "ip_version",
+          '(', "value", '$', "ipv4", ')',
+          '(', "value", '$', "ipv6", ')',
+        ')',
+      ')',
+      NULL);
+
+  out = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_object_unref (stanza);
+
+  g_assert (out == NULL);
+
+  /* now with <field var='blah'><value/></field> but fine otherwise;
+   * this will fail because we have everything about the field but the
+   * actual value */
+  stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Psi 0.11",
+        '@', "type", "pc",
+        '#', "en",
+      ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "FORM_TYPE",
+          '@', "type", "hidden",
+          '(', "value", '$', "urn:xmpp:dataforms:softwareinfo", ')',
+        ')',
+        '(', "field",
+          '@', "var", "lol_version",
+          '(', "value", ')',
+        ')',
+      ')',
+      NULL);
+
+  out = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_object_unref (stanza);
+
+  g_assert (out == NULL);
+
+  /* now with <field var='blah' /> but fine otherwise; this will fail
+   * because we have everything about the field but the actual
+   * value */
+  stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Psi 0.11",
+        '@', "type", "pc",
+        '#', "en",
+      ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "FORM_TYPE",
+          '@', "type", "hidden",
+          '(', "value", '$', "urn:xmpp:dataforms:softwareinfo", ')',
+        ')',
+        '(', "field",
+          '@', "var", "lol_version",
+        ')',
+      ')',
+      NULL);
+
+  out = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_object_unref (stanza);
+
+  g_assert (out == NULL);
+
+  /* now with <field /> but fine otherwise; the data form parser will
+   * ignore fields with no var='' attribute so this will succeed */
+  stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Psi 0.11",
+        '@', "type", "pc",
+        '#', "en",
+      ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "FORM_TYPE",
+          '@', "type", "hidden",
+          '(', "value", '$', "urn:xmpp:dataforms:softwareinfo", ')',
+        ')',
+        '(', "field",
+        ')',
+      ')',
+      NULL);
+
+  out = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_object_unref (stanza);
+
+  g_assert_cmpstr (out, ==, "wMFSetHbIiscGZgVgx4CZMaYIBQ=");
+  g_free (out);
+}
+
+static void
+test_dataforms_same_type (void)
+{
+  gchar *out;
+  /* stanza has two data forms both with the same FORM_TYPE value */
+  WockyStanza *stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Psi 0.11",
+        '@', "type", "pc",
+        '#', "en",
+      ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/caps", ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "FORM_TYPE",
+          '@', "type", "hidden",
+          '(', "value", '$', "urn:xmpp:dataforms:softwareinfo", ')',
+        ')',
+        '(', "field",
+          '@', "var", "ip_version",
+          '(', "value", '$', "ipv4", ')',
+          '(', "value", '$', "ipv6", ')',
+        ')',
+        '(', "field",
+          '@', "var", "os",
+          '(', "value", '$', "Mac", ')',
+        ')',
+        '(', "field",
+          '@', "var", "os_version",
+          '(', "value", '$', "10.5.1", ')',
+        ')',
+        '(', "field",
+          '@', "var", "software",
+          '(', "value", '$', "Psi", ')',
+        ')',
+        '(', "field",
+          '@', "var", "software_version",
+          '(', "value", '$', "0.11", ')',
+        ')',
+      ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "FORM_TYPE",
+          '@', "type", "hidden",
+          '(', "value", '$', "urn:xmpp:dataforms:softwareinfo", ')',
+        ')',
+        '(', "field",
+          '@', "var", "ip_version",
+          '(', "value", '$', "ipv4", ')',
+          '(', "value", '$', "ipv6", ')',
+        ')',
+        '(', "field",
+          '@', "var", "os",
+          '(', "value", '$', "Mac", ')',
+        ')',
+        '(', "field",
+          '@', "var", "os_version",
+          '(', "value", '$', "10.5.1", ')',
+        ')',
+        '(', "field",
+          '@', "var", "software",
+          '(', "value", '$', "Psi", ')',
+        ')',
+        '(', "field",
+          '@', "var", "software_version",
+          '(', "value", '$', "0.11", ')',
+        ')',
+      ')',
+      NULL);
+
+  out = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_object_unref (stanza);
+
+  g_assert (out == NULL);
+}
+
+static void
+test_dataforms_boolean_values (void)
+{
+  WockyStanza *stanza;
+  gchar *one, *two;
+
+  stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Ψ 0.11",
+        '@', "type", "pc",
+        '#', "el",
+      ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/disco#info", ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "FORM_TYPE",
+          '@', "type", "hidden",
+          '(', "value", '$', "urn:xmpp:dataforms:softwareinfo", ')',
+        ')',
+        '(', "field",
+          '@', "var", "software",
+          '@', "type", "boolean",
+          '(', "value", '$', "1", ')',
+        ')',
+      ')',
+      NULL);
+
+  one = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_object_unref (stanza);
+
+  stanza = wocky_stanza_build (WOCKY_STANZA_TYPE_IQ,
+      WOCKY_STANZA_SUB_TYPE_NONE, NULL, "badger",
+      '(', "identity",
+        '@', "category", "client",
+        '@', "name", "Ψ 0.11",
+        '@', "type", "pc",
+        '#', "el",
+      ')',
+      '(', "feature", '@', "var", "http://jabber.org/protocol/disco#info", ')',
+      '(', "x",
+        ':', "jabber:x:data",
+        '@', "type", "result",
+        '(', "field",
+          '@', "var", "FORM_TYPE",
+          '@', "type", "hidden",
+          '(', "value", '$', "urn:xmpp:dataforms:softwareinfo", ')',
+        ')',
+        '(', "field",
+          '@', "var", "software",
+          '@', "type", "boolean",
+          '(', "value", '$', "true", ')',
+        ')',
+      ')',
+      NULL);
+
+  two = wocky_caps_hash_compute_from_node (
+      wocky_stanza_get_top_node (stanza));
+  g_object_unref (stanza);
+
+  g_assert (one != NULL);
+  g_assert (two != NULL);
+  g_assert_cmpstr (one, !=, two);
+
+  g_free (one);
+  g_free (two);
+}
+
+int
+main (int argc, char **argv)
+{
+  int result;
+
+  test_init (argc, argv);
+  g_test_add_func ("/caps-hash/simple", test_simple);
+  g_test_add_func ("/caps-hash/complex", test_complex);
+  g_test_add_func ("/caps-hash/sorting/simple", test_sorting_simple);
+  g_test_add_func ("/caps-hash/sorting/complex", test_sorting_complex);
+  g_test_add_func ("/caps-hash/dataforms/invalid", test_dataforms_invalid);
+  g_test_add_func ("/caps-hash/dataforms/same-type", test_dataforms_same_type);
+  g_test_add_func ("/caps-hash/dataforms/boolean-values",
+      test_dataforms_boolean_values);
+
+  result = g_test_run ();
+  test_deinit ();
+
+  return result;
+}