Merge pull request #66 from monich/response_text

Added text details to the send state change notifications

mms-handler-dbus/spec/org.nemomobile.MmsHandler.xml

@@ -225,6 +225,14 @@
           6 (Refused):   Operator refused to accept the message
       -->
       <arg direction="in" type="i" name="state"/>
+      <!--
+          Optional detail string. In most cases it's empty by in case
+          if the message was refused by the operator it contains the
+          value of X-Mms-Response-Text header from M-Send.conf PDU.
+          It could explain the reason for the failure and should be
+          displayed to the user.
+      -->
+      <arg direction="in" type="s" name="details"/>
     </method>
 
     <!--

mms-handler-dbus/src/mms_handler_dbus.c

@@ -369,15 +369,17 @@ gboolean
 mms_handler_dbus_message_send_state_changed(
     MMSHandler* handler,
     const char* id,
-    MMS_SEND_STATE state)
+    MMS_SEND_STATE state,
+    const char* details)
 {
     OrgNemomobileMmsHandler* proxy = mms_handler_dbus_connect(handler);
     MMS_ASSERT(id && id[0]);
     if (id && id[0] && proxy) {
         mms_handler_ref(handler);
         mms_handler_busy_inc(handler);
         org_nemomobile_mms_handler_call_message_send_state_changed(proxy, id,
-            state, NULL, mms_handler_dbus_call_done, handler);
+            state, details ? details : "", NULL, mms_handler_dbus_call_done,
+            handler);
         return TRUE;
     }
     return FALSE;

mms-lib/include/mms_handler.h

@@ -140,7 +140,8 @@ typedef struct mms_handler_class {
     gboolean (*fn_message_send_state_changed)(
         MMSHandler* handler,        /* Handler instance */
         const char* id,             /* Handler record id */
-        MMS_SEND_STATE state);      /* Receive state */
+        MMS_SEND_STATE state,       /* Receive state */
+        const char* details);       /* Optional details */
 
     /* Message has been sent */
     gboolean (*fn_message_sent)(
@@ -221,7 +222,8 @@ gboolean
 mms_handler_message_send_state_changed(
     MMSHandler* handler,            /* Handler instance */
     const char* id,                 /* Handler record id */
-    MMS_SEND_STATE state);          /* Receive state */
+    MMS_SEND_STATE state,           /* Receive state */
+    const char* details);           /* Optional details */
 
 gboolean
 mms_handler_message_sent(

mms-lib/src/mms_codec.c

@@ -1443,6 +1443,8 @@ static gboolean decode_send_conf(struct wsp_header_iter *iter,
 				&out->version,
 				MMS_HEADER_RESPONSE_STATUS,
 				HEADER_FLAG_MANDATORY, &out->sc.rsp_status,
+				MMS_HEADER_RESPONSE_TEXT,
+				0, &out->sc.rsp_text,
 				MMS_HEADER_MESSAGE_ID,
 				0, &out->sc.msgid,
 				MMS_HEADER_INVALID);
@@ -1551,6 +1553,7 @@ void mms_message_free(struct mms_message *msg)
 		g_free(msg->sr.content_type);
 		break;
 	case MMS_MESSAGE_TYPE_SEND_CONF:
+		g_free(msg->sc.rsp_text);
 		g_free(msg->sc.msgid);
 		break;
 	case MMS_MESSAGE_TYPE_NOTIFICATION_IND:

mms-lib/src/mms_codec.h

@@ -153,6 +153,7 @@ struct mms_send_req {
 
 struct mms_send_conf {
 	enum mms_message_rsp_status rsp_status;
+	char *rsp_text;
 	char *msgid;
 };
 

mms-lib/src/mms_handler.c

@@ -199,12 +199,13 @@ gboolean
 mms_handler_message_send_state_changed(
     MMSHandler* h,
     const char* id,
-    MMS_SEND_STATE state)
+    MMS_SEND_STATE state,
+    const char* details)
 {
     if (h) {
         MMSHandlerClass* klass = MMS_HANDLER_GET_CLASS(h);
         if (klass->fn_message_send_state_changed) {
-            return klass->fn_message_send_state_changed(h, id, state);
+            return klass->fn_message_send_state_changed(h, id, state, details);
         }
         MMS_ERR("mms_handler_message_send_state_changed not implemented");
     }

mms-lib/src/mms_task_encode.c

@@ -326,7 +326,8 @@ mms_task_encode_job_done(
         } else {
             mms_handler_message_send_state_changed(task->handler, task->id,
                 (job->state == MMS_ENCODE_STATE_TOO_BIG) ?
-                MMS_SEND_STATE_TOO_BIG : MMS_SEND_STATE_SEND_ERROR);
+                MMS_SEND_STATE_TOO_BIG : MMS_SEND_STATE_SEND_ERROR,
+                NULL);
         }
         mms_task_set_state(&enc->task, MMS_TASK_STATE_DONE);
         mms_encode_job_unref(job);
@@ -350,7 +351,7 @@ mms_task_encode_run(
     if (thread) {
         g_thread_unref(thread);
         mms_handler_message_send_state_changed(task->handler, task->id,
-            MMS_SEND_STATE_ENCODING);
+            MMS_SEND_STATE_ENCODING, NULL);
         mms_task_set_state(task, MMS_TASK_STATE_WORKING);
         MMS_ASSERT(!enc->active_job);
         enc->active_job = job;
@@ -361,7 +362,7 @@ mms_task_encode_run(
         mms_encode_job_unref(job);
         mms_handler_message_send_state_changed(task->handler, task->id,
             mms_task_retry(task) ? MMS_SEND_STATE_DEFERRED :
-            MMS_SEND_STATE_SEND_ERROR);
+            MMS_SEND_STATE_SEND_ERROR, NULL);
     }
 }
 

mms-lib/src/mms_task_send.c

@@ -1,5 +1,6 @@
 /*
- * Copyright (C) 2013-2014 Jolla Ltd.
+ * Copyright (C) 2013-2015 Jolla Ltd.
+ * Contact: Slava Monich <slava.monich@jolla.com>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 2 as
@@ -39,7 +40,7 @@ mms_task_send_started(
     MMSTaskHttp* http)
 {
     mms_handler_message_send_state_changed(http->task.handler,
-        http->task.id, MMS_SEND_STATE_SENDING);
+        http->task.id, MMS_SEND_STATE_SENDING, NULL);
 }
 
 static
@@ -48,7 +49,7 @@ mms_task_send_paused(
     MMSTaskHttp* http)
 {
     mms_handler_message_send_state_changed(http->task.handler,
-        http->task.id, MMS_SEND_STATE_DEFERRED);
+        http->task.id, MMS_SEND_STATE_DEFERRED, NULL);
 }
 
 static
@@ -61,6 +62,7 @@ mms_task_send_done(
     MMSPdu* pdu = NULL;
     MMS_SEND_STATE state = MMS_SEND_STATE_SEND_ERROR;
     const char* msgid = NULL;
+    const char* details = NULL;
     if (SOUP_STATUS_IS_SUCCESSFUL(status)) {
         /* Decode the result */
         GError* error = NULL;
@@ -81,6 +83,7 @@ mms_task_send_done(
                         }
                     } else {
                         MMS_ERR("MMSC responded with %u", pdu->sc.rsp_status);
+                        details = pdu->sc.rsp_text;
                         switch (pdu->sc.rsp_status) {
                         case MMS_MESSAGE_RSP_STATUS_ERR_SERVICE_DENIED:
                         case MMS_MESSAGE_RSP_STATUS_ERR_CONTENT_NOT_ACCEPTED:
@@ -110,7 +113,7 @@ mms_task_send_done(
         mms_handler_message_sent(http->task.handler, http->task.id, msgid);
     } else {
         mms_handler_message_send_state_changed(http->task.handler,
-            http->task.id, state);
+            http->task.id, state, details);
     }
     if (pdu) mms_message_free(pdu);
 }

mms-lib/test/common/test_handler.c

@@ -53,6 +53,7 @@ typedef struct mms_handler_record_send {
     MMS_DELIVERY_STATUS delivery_status;
     MMS_READ_STATUS read_status;
     char* msgid;
+    char* details;
 } MMSHandlerRecordSend;
 
 typedef struct mms_handler_record_receive {
@@ -205,6 +206,16 @@ mms_handler_test_send_state(
     return send ? send->state : MMS_SEND_STATE_INVALID;
 }
 
+const char*
+mms_handler_test_send_details(
+    MMSHandler* handler,
+    const char* id)
+{
+    MMSHandlerRecordSend* send =
+    mms_handler_test_get_send_record(MMS_HANDLER_TEST(handler), id);
+    return send ? send->details : NULL;
+}
+
 MMS_RECEIVE_STATE
 mms_handler_test_receive_state(
     MMSHandler* handler,
@@ -365,6 +376,7 @@ mms_handler_test_hash_remove_record(
         g_free(recv);
     } else {
         MMSHandlerRecordSend* send = mms_handler_test_record_send(rec);
+        g_free(send->details);
         g_free(send->msgid);
         g_free(send);
     }
@@ -615,13 +627,20 @@ gboolean
 mms_handler_test_message_send_state_changed(
     MMSHandler* handler,
     const char* id,
-    MMS_SEND_STATE state)
+    MMS_SEND_STATE state,
+    const char* details)
 {
     MMSHandlerRecordSend* send =
     mms_handler_test_get_send_record(MMS_HANDLER_TEST(handler), id);
     if (send) {
         send->state = state;
-        MMS_DEBUG("Message %s send state %d", id, state);
+        g_free(send->details);
+        send->details = g_strdup(details);
+        if (details) {
+            MMS_DEBUG("Message %s send state %d: %s", id, state, details);
+        } else {
+            MMS_DEBUG("Message %s send state %d", id, state);
+        }
         return TRUE;
     } else {
         MMS_ERR("No such outbound message: %s", id);

mms-lib/test/common/test_handler.h

@@ -41,6 +41,11 @@ mms_handler_test_send_state(
     MMSHandler* handler,
     const char* id);
 
+const char*
+mms_handler_test_send_details(
+    MMSHandler* handler,
+    const char* id);
+
 MMS_RECEIVE_STATE
 mms_handler_test_receive_state(
     MMSHandler* handler,

mms-lib/test/test_send/test_send.c

@@ -1,5 +1,6 @@
 /*
- * Copyright (C) 2013-2014 Jolla Ltd.
+ * Copyright (C) 2013-2015 Jolla Ltd.
+ * Contact: Slava Monich <slava.monich@jolla.com>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 2 as
@@ -48,6 +49,7 @@ typedef struct test_desc {
     const char* resp_type;
     unsigned int resp_status;
     MMS_SEND_STATE expected_state;
+    const char* details;
     const char* msgid;
 } TestDesc;
 
@@ -118,6 +120,7 @@ static const TestDesc send_tests[] = {
         MMS_CONTENT_TYPE,
         SOUP_STATUS_OK,
         MMS_SEND_STATE_SENDING,
+        NULL,
         "TestMessageId"
     },{
         "AcceptNoExt",
@@ -133,6 +136,7 @@ static const TestDesc send_tests[] = {
         MMS_CONTENT_TYPE,
         SOUP_STATUS_OK,
         MMS_SEND_STATE_SENDING,
+        NULL,
         "TestMessageId"
     },{
         "ServiceDenied",
@@ -148,6 +152,7 @@ static const TestDesc send_tests[] = {
         MMS_CONTENT_TYPE,
         SOUP_STATUS_OK,
         MMS_SEND_STATE_REFUSED,
+        "Unable to send",
         NULL
     },{
         "Failure",
@@ -163,6 +168,7 @@ static const TestDesc send_tests[] = {
         MMS_CONTENT_TYPE,
         SOUP_STATUS_OK,
         MMS_SEND_STATE_SEND_ERROR,
+        NULL,
         NULL
     },{
         "UnparsableResp",
@@ -178,6 +184,7 @@ static const TestDesc send_tests[] = {
         MMS_CONTENT_TYPE,
         SOUP_STATUS_OK,
         MMS_SEND_STATE_SEND_ERROR,
+        NULL,
         NULL
     },{
         "UnexpectedResp",
@@ -193,6 +200,7 @@ static const TestDesc send_tests[] = {
         MMS_CONTENT_TYPE,
         SOUP_STATUS_OK,
         MMS_SEND_STATE_SEND_ERROR,
+        NULL,
         NULL
     },{
         "EmptyMessageID",
@@ -208,6 +216,7 @@ static const TestDesc send_tests[] = {
         MMS_CONTENT_TYPE,
         SOUP_STATUS_OK,
         MMS_SEND_STATE_SEND_ERROR,
+        NULL,
         NULL
     },{
         "Cancel",
@@ -223,6 +232,7 @@ static const TestDesc send_tests[] = {
         NULL,
         SOUP_STATUS_INTERNAL_SERVER_ERROR,
         MMS_SEND_STATE_SEND_ERROR,
+        NULL,
         NULL
     },{
         "TooBig",
@@ -238,6 +248,7 @@ static const TestDesc send_tests[] = {
         NULL,
         SOUP_STATUS_INTERNAL_SERVER_ERROR,
         MMS_SEND_STATE_TOO_BIG,
+        NULL,
         NULL
     }
 };
@@ -251,11 +262,17 @@ test_finish(
     const char* name = desc->name;
     if (test->ret == RET_OK) {
         MMS_SEND_STATE state;
+        const char* details;
         state = mms_handler_test_send_state(test->handler, test->id);
+        details = mms_handler_test_send_details(test->handler, test->id);
         if (state != desc->expected_state) {
             test->ret = RET_ERR;
             MMS_ERR("%s state %d, expected %d", name, state,
                 desc->expected_state);
+        } else if (g_strcmp0(details, desc->details)) {
+            test->ret = RET_ERR;
+            MMS_ERR("%s details '%s', expected '%s'", name, details,
+                desc->details);
         } else if (desc->msgid) {
             const char* msgid =
             mms_handler_test_send_msgid(test->handler, test->id);