[nfcd] Support for handling Text NDEF records. JB#43873

Its configuration looks like this in the config file:

  [Text-Handler]
  Service = my.service
  Method = my.interface.HandleText

plugins/Makefile

@@ -199,6 +199,7 @@ DBUS_HANDLERS_SRC = \
   dbus_handlers_tag.c \
   dbus_handlers_type_generic.c \
   dbus_handlers_type_mediatype.c \
+  dbus_handlers_type_text.c \
   dbus_handlers_type_uri.c \
   dbus_handlers.c
 

plugins/dbus_handlers/README

@@ -144,3 +144,34 @@ Example:
 Service = my.service
 Method = my.interface.HandleURI
 URI = https://*
+
+"T" (Text) NDEF record
+----------------------
+
+[Text-Handler]
+
+Method signature:
+
+  <method>
+    <arg name="text" type="s" direction="in"/>
+    <arg name="status" type="i" direction="out"/>
+  </method>
+
+[Text-Listener]
+
+Method signature:
+
+  <method>
+    <arg name="handled" type="b" direction="in"/>
+    <arg name="text" type="s" direction="in"/>
+  </method>
+
+If tag contains multiple Text records, the one with the language that
+matches default system locale is picked. If several records match, the
+first one is picked.
+
+Example:
+
+[Text-Handler]
+Service = my.service
+Method = my.interface.HandleText

plugins/dbus_handlers/dbus_handlers.h

@@ -96,6 +96,7 @@ typedef struct dbus_handlers_config {
 } DBusHandlersConfig;
 
 extern const DBusHandlerType dbus_handlers_type_uri;
+extern const DBusHandlerType dbus_handlers_type_text;
 extern const DBusHandlerType dbus_handlers_type_mediatype_wildcard;
 extern const DBusHandlerType dbus_handlers_type_mediatype_exact;
 extern const DBusHandlerType dbus_handlers_type_generic;

plugins/dbus_handlers/dbus_handlers_config.c

@@ -401,6 +401,7 @@ dbus_handlers_config_load(
          */
         static const DBusHandlerType* available_types[] = {
             &dbus_handlers_type_uri,
+            &dbus_handlers_type_text,
             &dbus_handlers_type_mediatype_exact
         };
         GSList* types = NULL;

plugins/dbus_handlers/dbus_handlers_type_text.c

@@ -0,0 +1,179 @@
+/*
+ * Copyright (C) 2019 Jolla Ltd.
+ * Copyright (C) 2019 Slava Monich <slava.monich@jolla.com>
+ *
+ * You may use this file under the terms of BSD license as follows:
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *   1. Redistributions of source code must retain the above copyright
+ *      notice, this list of conditions and the following disclaimer.
+ *   2. Redistributions in binary form must reproduce the above copyright
+ *      notice, this list of conditions and the following disclaimer in the
+ *      documentation and/or other materials provided with the distribution.
+ *   3. Neither the names of the copyright holders nor the names of its
+ *      contributors may be used to endorse or promote products derived from
+ *      this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
+ * THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "dbus_handlers.h"
+
+#include "nfc_system.h"
+
+#define dbus_handlers_type_text_find_record(rec) \
+    dbus_handlers_config_find_record(rec, \
+    dbus_handlers_type_text_supported_record)
+
+static
+gboolean
+dbus_handlers_type_text_supported_record(
+    NfcNdefRec* ndef)
+{
+    return G_TYPE_CHECK_INSTANCE_TYPE(ndef, NFC_TYPE_NDEF_REC_T);
+}
+
+static
+gint
+dbus_handlers_type_text_sort_records(
+    gconstpointer a,
+    gconstpointer b,
+    gpointer user_data)
+{
+    /*
+     * This function is passed the data from 2 elements of the GSList
+     * and should return 0 if they are equal, a negative value if the
+     * first element comes before the second, or a positive value if
+     * the first element comes after the second.
+     */
+    NfcNdefRecT* t1 = NFC_NDEF_REC_T(a);
+    NfcNdefRecT* t2 = NFC_NDEF_REC_T(b);
+    const NfcLanguage* system = user_data;
+    NFC_LANG_MATCH match1 = nfc_ndef_rec_t_lang_match(t1, system);
+    NFC_LANG_MATCH match2 = nfc_ndef_rec_t_lang_match(t2, system);
+
+    if (match1 != match2) {
+        return (gint)match2 - (gint)match1;
+    } else {
+        NfcNdefRec* r1 = &t1->rec;
+        NfcNdefRec* r2 = &t2->rec;
+
+        /* Otherwise preserve the natural order */
+        while (r1->next) {
+            r1 = r1->next;
+            if (r1 == r2) {
+                /* r2 goes after r1 */
+                return -1;
+            }
+        }
+
+        /* r1 goes after r2 */
+        return 1;
+    }
+}
+
+static
+NfcNdefRecT*
+dbus_handlers_type_text_pick_record(
+    NfcNdefRec* ndef)
+{
+    NfcNdefRec* next = dbus_handlers_type_text_find_record(ndef->next);
+
+    /* No need for anything complicated if there's only one record */
+    if (next) {
+        NfcLanguage* system = nfc_system_language();
+
+        if (system) {
+            GSList* list = g_slist_append(NULL, ndef);
+            NfcNdefRec* best;
+
+            do {
+                list = g_slist_append(list, next);
+                next = dbus_handlers_type_text_find_record(next->next);
+            } while (next);
+
+            list = g_slist_sort_with_data(list,
+                dbus_handlers_type_text_sort_records, system);
+
+            best = list->data;
+            g_slist_free(list);
+            g_free(system);
+            return NFC_NDEF_REC_T(best);
+        }
+    }
+
+    /* Just pick the first one */
+    return NFC_NDEF_REC_T(ndef);
+}
+
+static
+DBusHandlerConfig*
+dbus_handlers_type_text_new_handler_config(
+    GKeyFile* file,
+    NfcNdefRec* ndef)
+{
+    return dbus_handlers_new_handler_config(file, "Text-Handler");
+}
+
+static
+DBusListenerConfig*
+dbus_handlers_type_text_new_listener_config(
+    GKeyFile* file,
+    NfcNdefRec* ndef)
+{
+    return dbus_handlers_new_listener_config(file, "Text-Listener");
+}
+
+static
+GVariant*
+dbus_handlers_type_text_handler_args(
+    NfcNdefRec* ndef)
+{
+    NfcNdefRecT* t = dbus_handlers_type_text_pick_record(ndef);
+
+    return g_variant_new ("(s)", t->text);
+}
+
+static
+GVariant*
+dbus_handlers_type_text_listener_args(
+    gboolean handled,
+    NfcNdefRec* ndef)
+{
+    NfcNdefRecT* t = dbus_handlers_type_text_pick_record(ndef);
+
+    return g_variant_new ("(bs)", handled, t->text);
+}
+
+const DBusHandlerType dbus_handlers_type_text = {
+    .name = "Text",
+    .priority = DBUS_HANDLER_PRIORITY_DEFAULT,
+    .supported_record = dbus_handlers_type_text_supported_record,
+    .new_handler_config = dbus_handlers_type_text_new_handler_config,
+    .new_listener_config = dbus_handlers_type_text_new_listener_config,
+    .free_handler_config = dbus_handlers_free_handler_config,
+    .free_listener_config = dbus_handlers_free_listener_config,
+    .handler_args = dbus_handlers_type_text_handler_args,
+    .listener_args = dbus_handlers_type_text_listener_args
+};
+
+/*
+ * Local Variables:
+ * mode: C
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ */

unit/Makefile

@@ -18,6 +18,7 @@ all:
 	@$(MAKE) -C plugins_dbus_handlers_config $*
 	@$(MAKE) -C plugins_dbus_handlers_type_generic $*
 	@$(MAKE) -C plugins_dbus_handlers_type_mediatype $*
+	@$(MAKE) -C plugins_dbus_handlers_type_text $*
 	@$(MAKE) -C plugins_dbus_handlers_type_uri $*
 
 clean: unitclean

unit/coverage/run

@@ -20,6 +20,7 @@ core_util \
 plugins_dbus_handlers_config \
 plugins_dbus_handlers_type_generic \
 plugins_dbus_handlers_type_mediatype \
+plugins_dbus_handlers_type_text \
 plugins_dbus_handlers_type_uri"
 
 function err() {

unit/plugins_dbus_handlers_type_text/Makefile

@@ -0,0 +1,5 @@
+# -*- Mode: makefile-gmake -*-
+
+EXE = test_plugins_dbus_handlers_type_text
+
+include ../common/Makefile.plugins