Bug 749856 - Part 2: Add MmsPduHelper, r=philikon

dom/mms/src/Makefile.in

@@ -13,6 +13,8 @@ include $(DEPTH)/config/autoconf.mk
 
 ifdef MOZ_B2G_RIL
 EXTRA_JS_MODULES = \
+  ril/mms_consts.js \
+  ril/MmsPduHelper.jsm \
   ril/wap_consts.js \
   ril/WapPushManager.js \
   ril/WspPduHelper.jsm \

dom/mms/src/ril/mms_consts.js

@@ -0,0 +1,47 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+// Encoded X-Mms-Message-Type values
+// @see OMA-TS-MMS_ENC-V1_3-20110913-A clause 7.3.30
+const MMS_PDU_TYPE_SEND_REQ = 128;
+const MMS_PDU_TYPE_SEND_CONF = 129;
+const MMS_PDU_TYPE_NOTIFICATION_IND = 130;
+const MMS_PDU_TYPE_NOTIFYRESP_IND = 131;
+const MMS_PDU_TYPE_RETRIEVE_CONF = 132;
+const MMS_PDU_TYPE_ACKNOWLEDGE_IND = 133;
+const MMS_PDU_TYPE_DELIVERY_IND = 134;
+const MMS_PDU_TYPE_READ_REC_IND = 135;
+const MMS_PDU_TYPE_READ_ORIG_IND = 136;
+const MMS_PDU_TYPE_FORWARD_REQ = 137;
+const MMS_PDU_TYPE_FORWARD_CONF = 138;
+const MMS_PDU_TYPE_MBOX_STORE_REQ = 139;
+const MMS_PDU_TYPE_MBOX_STORE_CONF = 140;
+const MMS_PDU_TYPE_MBOX_VIEW_REQ = 141;
+const MMS_PDU_TYPE_MBOX_VIEW_CONF = 142;
+const MMS_PDU_TYPE_MBOX_UPLOAD_REQ = 143;
+const MMS_PDU_TYPE_MBOX_UPLOAD_CONF = 144;
+const MMS_PDU_TYPE_MBOX_DELETE_REQ = 145;
+const MMS_PDU_TYPE_MBOX_DELETE_CONF = 146;
+const MMS_PDU_TYPE_MBOX_DESCR = 147;
+const MMS_PDU_TYPE_DELETE_REQ = 148;
+const MMS_PDU_TYPE_DELETE_CONF = 149;
+const MMS_PDU_TYPE_CANCEL_REQ = 150;
+const MMS_PDU_TYPE_CANCEL_CONF = 151;
+
+// X-Mms-Retrieve-Status values
+// @see OMA-TS-MMS_ENC-V1_3-20110913-A clause 7.3.50
+const MMS_PDU_ERROR_OK                            = 128;
+const MMS_PDU_ERROR_TRANSIENT_FAILURE             = 192;
+const MMS_PDU_ERROR_TRANSIENT_MESSAGE_NOT_FOUND   = 193;
+const MMS_PDU_ERROR_TRANSIENT_NETWORK_PROBLEM     = 194;
+const MMS_PDU_ERROR_PERMANENT_FAILURE             = 224;
+const MMS_PDU_ERROR_PERMANENT_SERVICE_DENIED      = 225;
+const MMS_PDU_ERROR_PERMANENT_MESSAGE_NOT_FOUND   = 226;
+const MMS_PDU_ERROR_PERMANENT_CONTENT_UNSUPPORTED = 227;
+
+const ALL_CONST_SYMBOLS = Object.keys(this);
+
+// Allow this file to be imported via Components.utils.import().
+const EXPORTED_SYMBOLS = ALL_CONST_SYMBOLS;
+

dom/mms/tests/test_mms_pdu_helper.js

@@ -0,0 +1,484 @@
+/* Any copyright is dedicated to the Public Domain.
+   http://creativecommons.org/publicdomain/zero/1.0/ */
+
+let MMS = {};
+subscriptLoader.loadSubScript("resource://gre/modules/MmsPduHelper.jsm", MMS);
+MMS.debug = do_print;
+
+function run_test() {
+  run_next_test();
+}
+
+//
+// Test target: BooleanValue
+//
+
+//// BooleanValue.decode ////
+
+add_test(function test_BooleanValue_decode() {
+  for (let i = 0; i < 256; i++) {
+    if (i == 128) {
+      wsp_decode_test(MMS.BooleanValue, [128], true);
+    } else if (i == 129) {
+      wsp_decode_test(MMS.BooleanValue, [129], false);
+    } else {
+      wsp_decode_test(MMS.BooleanValue, [i], null, "CodeError");
+    }
+  }
+
+  run_next_test();
+});
+
+//
+// Test target: Address
+//
+
+//// Address.decode ////
+
+add_test(function test_Address_decode() {
+  // Test for PLMN address
+  wsp_decode_test(MMS.Address, strToCharCodeArray("+123.456-789/TYPE=PLMN"),
+                      {address: "+123.456-789", type: "PLMN"});
+  wsp_decode_test(MMS.Address, strToCharCodeArray("123456789/TYPE=PLMN"),
+                      {address: "123456789", type: "PLMN"});
+  // Test for IPv4
+  wsp_decode_test(MMS.Address, strToCharCodeArray("1.2.3.4/TYPE=IPv4"),
+                      {address: "1.2.3.4", type: "IPv4"});
+  // Test for IPv6
+  wsp_decode_test(MMS.Address,
+    strToCharCodeArray("1111:AAAA:bbbb:CdEf:1ABC:2cde:3Def:0000/TYPE=IPv6"),
+    {address: "1111:AAAA:bbbb:CdEf:1ABC:2cde:3Def:0000", type: "IPv6"}
+  );
+  // Test for other device-address
+  wsp_decode_test(MMS.Address, strToCharCodeArray("+H-e.l%l_o/TYPE=W0r1d_"),
+                      {address: "+H-e.l%l_o", type: "W0r1d_"});
+  // Test for num-shortcode
+  wsp_decode_test(MMS.Address, strToCharCodeArray("+123"),
+                      {address: "+123", type: "num"});
+  wsp_decode_test(MMS.Address, strToCharCodeArray("*123"),
+                      {address: "*123", type: "num"});
+  wsp_decode_test(MMS.Address, strToCharCodeArray("#123"),
+                      {address: "#123", type: "num"});
+  // Test for alphanum-shortcode
+  wsp_decode_test(MMS.Address, strToCharCodeArray("H0wD0Y0uTurnTh1s0n"),
+                      {address: "H0wD0Y0uTurnTh1s0n", type: "alphanum"});
+  // Test for other unknown typed sequence
+  wsp_decode_test(MMS.Address, strToCharCodeArray("Joe User <joe@user.org>"),
+                      {address: "Joe User <joe@user.org>", type: "unknown"});
+
+  run_next_test();
+});
+
+//
+// Test target: HeaderField
+//
+
+//// HeaderField.decode ////
+
+add_test(function test_HeaderField_decode() {
+  wsp_decode_test(MMS.HeaderField, [65, 0, 66, 0], {name: "a", value: "B"});
+  wsp_decode_test(MMS.HeaderField, [0x80 | 0x27, 128],
+                      {name: "x-mms-stored", value: true});
+
+  run_next_test();
+});
+
+//
+// Test target: MmsHeader
+//
+
+//// MmsHeader.decode ////
+
+add_test(function test_MmsHeader_decode() {
+  wsp_decode_test(MMS.MmsHeader, [0x80 | 0x00], null, "NotWellKnownEncodingError");
+  wsp_decode_test(MMS.MmsHeader, [0x80 | 0x27, 128],
+                      {name: "x-mms-stored", value: true});
+  wsp_decode_test(MMS.MmsHeader, [0x80 | 0x27, 255], null);
+
+  run_next_test();
+});
+
+//
+// Test target: ContentClassValue
+//
+
+//// ContentClassValue.decode ////
+
+add_test(function test_ContentClassValue_decode() {
+  for (let i = 0; i < 256; i++) {
+    if ((i >= 128) && (i <= 135)) {
+      wsp_decode_test(MMS.ContentClassValue, [i], i);
+    } else {
+      wsp_decode_test(MMS.ContentClassValue, [i], null, "CodeError");
+    }
+  }
+
+  run_next_test();
+});
+
+//
+// Test target: ContentLocationValue
+//
+
+//// ContentLocationValue.decode ////
+
+add_test(function test_ContentLocationValue_decode() {
+  // Test for MMS_PDU_TYPE_MBOX_DELETE_CONF & MMS_PDU_TYPE_DELETE_CONF
+  wsp_decode_test_ex(function (data) {
+      data.array[0] = data.array.length - 1;
+
+      let options = {};
+      options["x-mms-message-type"] = /*MMS.MMS_PDU_TYPE_MBOX_DELETE_CONF*/146;
+      return MMS.ContentLocationValue.decode(data, options);
+    }, [0, 0x80 | 0x00].concat(strToCharCodeArray("http://no.such.com/path")),
+    {statusCount: 0, uri: "http://no.such.com/path"}
+  );
+  wsp_decode_test_ex(function (data) {
+      data.array[0] = data.array.length - 1;
+
+      let options = {};
+      options["x-mms-message-type"] = /*MMS.MMS_PDU_TYPE_DELETE_CONF*/149;
+      return MMS.ContentLocationValue.decode(data, options);
+    }, [0, 0x80 | 0x00].concat(strToCharCodeArray("http://no.such.com/path")),
+    {statusCount: 0, uri: "http://no.such.com/path"}
+  );
+
+  run_next_test();
+});
+
+//
+// Test target: ElementDescriptorValue
+//
+
+//// ElementDescriptorValue.decode ////
+
+add_test(function test_ElementDescriptorValue_decode() {
+  wsp_decode_test(MMS.ElementDescriptorValue, [2, 97, 0], {contentReference: "a"});
+  wsp_decode_test(MMS.ElementDescriptorValue, [4, 97, 0, 0x80 | 0x02, 0x80],
+                      {contentReference: "a", params: {type: 0}});
+
+  run_next_test();
+});
+
+//
+// Test target: Parameter
+//
+
+//// Parameter.decodeParameterName ////
+
+add_test(function test_Parameter_decodeParameterName() {
+  wsp_decode_test_ex(function (data) {
+      return MMS.Parameter.decodeParameterName(data);
+    }, [0x80 | 0x02], "type"
+  );
+  wsp_decode_test_ex(function (data) {
+      return MMS.Parameter.decodeParameterName(data);
+    }, strToCharCodeArray("type"), "type"
+  );
+
+  run_next_test();
+});
+
+//// Parameter.decode ////
+
+add_test(function test_Parameter_decode() {
+  wsp_decode_test(MMS.Parameter, [0x80 | 0x02, 0x80 | 0x00], {name: "type", value: 0});
+
+  run_next_test();
+});
+
+//// Parameter.decodeMultiple ////
+
+add_test(function test_Parameter_decodeMultiple() {
+  // FIXME: The following test case falls because Parameter-value decoding of
+  //        "type" parameters utilies WSP.ConstrainedEncoding, which in turn
+  //        utilies WSP.TextString, and TextString is not matual exclusive to
+  //        each other.
+  //wsp_decode_test_ex(function (data) {
+  //    return MMS.Parameter.decodeMultiple(data, data.array.length);
+  //  }, [0x80 | 0x02, 0x80 | 0x00].concat(strToCharCodeArray("good")).concat([0x80 | 0x01]),
+  //  {type: 0, good: 1}
+  //);
+
+  run_next_test();
+});
+
+//
+// Test target: EncodedStringValue
+//
+
+//// EncodedStringValue.decode ////
+
+add_test(function test_EncodedStringValue_decode() {
+  // Test for normal TextString
+  wsp_decode_test(MMS.EncodedStringValue, strToCharCodeArray("Hello"), "Hello");
+  // Test for non-well-known charset
+  wsp_decode_test(MMS.EncodedStringValue, [1, 0x80], null, "NotWellKnownEncodingError");
+  // Test for utf-8
+  let (entry = MMS.WSP.WSP_WELL_KNOWN_CHARSETS["utf-8"]) {
+    // "Mozilla" in full width.
+    let str = "\uff2d\uff4f\uff5a\uff49\uff4c\uff4c\uff41";
+
+    let conv = Cc["@mozilla.org/intl/scriptableunicodeconverter"]
+               .createInstance(Ci.nsIScriptableUnicodeConverter);
+    conv.charset = entry.converter;
+
+    let raw;
+    try {
+      let raw = conv.convertToByteArray(str);
+      if (raw[0] >= 128) {
+        wsp_decode_test(MMS.EncodedStringValue,
+                            [raw.length + 2, 0x80 | entry.number, 127].concat(raw), str);
+      } else {
+        wsp_decode_test(MMS.EncodedStringValue,
+                            [raw.length + 1, 0x80 | entry.number].concat(raw), str);
+      }
+    } catch (e) {
+      do_print("Can't convert test string to byte array with " + entry.converter);
+    }
+  }
+
+  run_next_test();
+});
+
+//
+// Test target: ExpiryValue
+//
+
+//// ExpiryValue.decode ////
+
+add_test(function test_ExpiryValue_decode() {
+  // Test for Absolute-token Date-value
+  wsp_decode_test(MMS.ExpiryValue, [3, 128, 1, 0x80], new Date(0x80 * 1000));
+  // Test for Relative-token Delta-seconds-value
+  wsp_decode_test(MMS.ExpiryValue, [3, 129, 0x80], 0);
+
+  run_next_test();
+});
+
+//
+// Test target: PreviouslySentByValue
+//
+
+//// PreviouslySentByValue.decode ////
+
+add_test(function test_PreviouslySentByValue_decode() {
+  wsp_decode_test(MMS.PreviouslySentByValue, [3, 0x80 | 0x03, 65, 0],
+                      {forwardedCount: 3, originator: {address: "A",
+                                                       type: "alphanum"}});
+
+  run_next_test();
+});
+
+//
+// Test target: PreviouslySentDateValue
+//
+
+//// PreviouslySentDateValue.decode ////
+
+add_test(function test_PreviouslySentDateValue_decode() {
+  wsp_decode_test(MMS.PreviouslySentDateValue, [3, 0x80 | 0x03, 1, 4],
+                      {forwardedCount: 3, timestamp: new Date(4 * 1000)});
+
+  run_next_test();
+});
+
+//
+// Test target: FromValue
+//
+
+//// FromValue.decode ////
+
+add_test(function test_FromValue_decode() {
+  // Test for Insert-address-token:
+  wsp_decode_test(MMS.FromValue, [1, 129], null);
+  // Test for Address-present-token:
+  let (addr = strToCharCodeArray("+123/TYPE=PLMN")) {
+    wsp_decode_test(MMS.FromValue, [addr.length + 2, 128].concat(addr),
+                        {address: "+123", type: "PLMN"});
+  }
+
+  run_next_test();
+});
+
+//
+// Test target: MessageClassValue
+//
+
+//// MessageClassValue.decode ////
+
+add_test(function test_MessageClassValue_decode() {
+  wsp_decode_test(MMS.MessageClassValue, [65, 0], "A");
+  wsp_decode_test(MMS.MessageClassValue, [128], "personal");
+
+  run_next_test();
+});
+
+//
+// Test target: ClassIdentifier
+//
+
+//// ClassIdentifier.decode ////
+
+add_test(function test_ClassIdentifier_decode() {
+  let (IDs = ["personal", "advertisement", "informational", "auto"]) {
+    for (let i = 0; i < 256; i++) {
+      if ((i >= 128) && (i <= 131)) {
+        wsp_decode_test(MMS.ClassIdentifier, [i], IDs[i - 128]);
+      } else {
+        wsp_decode_test(MMS.ClassIdentifier, [i], null, "CodeError");
+      }
+    }
+  }
+
+  run_next_test();
+});
+
+//
+// Test target: MessageTypeValue
+//
+
+//// MessageTypeValue.decode ////
+
+add_test(function test_MessageTypeValue_decode() {
+  for (let i = 0; i < 256; i++) {
+    if ((i >= 128) && (i <= 151)) {
+      wsp_decode_test(MMS.MessageTypeValue, [i], i);
+    } else {
+      wsp_decode_test(MMS.MessageTypeValue, [i], null, "CodeError");
+    }
+  }
+
+  run_next_test();
+});
+
+//
+// Test target: MmFlagsValue
+//
+
+//// MmFlagsValue.decode ////
+
+add_test(function test_MmFlagsValue_decode() {
+  for (let i = 0; i < 256; i++) {
+    if ((i >= 128) && (i <= 130)) {
+      wsp_decode_test(MMS.MmFlagsValue, [3, i, 65, 0], {type: i, text: "A"});
+    } else {
+      wsp_decode_test(MMS.MmFlagsValue, [3, i, 65, 0], null, "CodeError");
+    }
+  }
+
+  run_next_test();
+});
+
+//
+// Test target: MmStateValue
+//
+
+//// MmStateValue.decode ////
+
+add_test(function test_MmStateValue_decode() {
+  for (let i = 0; i < 256; i++) {
+    if ((i >= 128) && (i <= 132)) {
+      wsp_decode_test(MMS.MmStateValue, [i, 0], i);
+    } else {
+      wsp_decode_test(MMS.MmStateValue, [i, 0], null, "CodeError");
+    }
+  }
+
+  run_next_test();
+});
+
+//
+// Test target: PriorityValue
+//
+
+//// PriorityValue.decode ////
+
+add_test(function test_PriorityValue_decode() {
+  for (let i = 0; i < 256; i++) {
+    if ((i >= 128) && (i <= 130)) {
+      wsp_decode_test(MMS.PriorityValue, [i], i);
+    } else {
+      wsp_decode_test(MMS.PriorityValue, [i], null, "CodeError");
+    }
+  }
+
+  run_next_test();
+});
+
+//
+// Test target: RecommendedRetrievalModeValue
+//
+
+//// RecommendedRetrievalModeValue.decode ////
+
+add_test(function test_RecommendedRetrievalModeValue_decode() {
+  for (let i = 0; i < 256; i++) {
+    if (i == 128) {
+      wsp_decode_test(MMS.RecommendedRetrievalModeValue, [i], i);
+    } else {
+      wsp_decode_test(MMS.RecommendedRetrievalModeValue, [i], null, "CodeError");
+    }
+  }
+
+  run_next_test();
+});
+
+//
+// Test target: ReplyChargingValue
+//
+
+//// ReplyChargingValue.decode ////
+
+add_test(function test_ReplyChargingValue_decode() {
+  for (let i = 0; i < 256; i++) {
+    if ((i >= 128) && (i <= 131)) {
+      wsp_decode_test(MMS.ReplyChargingValue, [i], i);
+    } else {
+      wsp_decode_test(MMS.ReplyChargingValue, [i], null, "CodeError");
+    }
+  }
+
+  run_next_test();
+});
+
+//
+// Test target: RetrieveStatusValue
+//
+
+//// RetrieveStatusValue.decode ////
+
+add_test(function test_RetrieveStatusValue_decode() {
+  for (let i = 0; i < 256; i++) {
+    if ((i == 128)
+        || ((i >= 192) && (i <= 194))
+        || ((i >= 224) && (i <= 227))) {
+      wsp_decode_test(MMS.RetrieveStatusValue, [i], i);
+    } else if ((i >= 195) && (i <= 223)) {
+      wsp_decode_test(MMS.RetrieveStatusValue, [i], 192);
+    } else {
+      wsp_decode_test(MMS.RetrieveStatusValue, [i], 224);
+    }
+  }
+
+  run_next_test();
+});
+
+//
+// Test target: StatusValue
+//
+
+//// StatusValue.decode ////
+
+add_test(function test_StatusValue_decode() {
+  for (let i = 0; i < 256; i++) {
+    if ((i >= 128) && (i <= 135)) {
+      wsp_decode_test(MMS.StatusValue, [i], i);
+    } else {
+      wsp_decode_test(MMS.StatusValue, [i], null, "CodeError");
+    }
+  }
+
+  run_next_test();
+});
+

dom/mms/tests/xpcshell.ini

@@ -3,3 +3,4 @@ head = header_helpers.js
 tail =
 
 [test_wsp_pdu_helper.js]
+[test_mms_pdu_helper.js]