Bug 699256 - Part 1: Add telephony worker for dealing with RIL messages. r=gal

dom/telephony/worker-component/nsTelephonyWorker.js

@@ -0,0 +1,159 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is Telephony.
+ *
+ * The Initial Developer of the Original Code is
+ *   The Mozilla Foundation.
+ * Portions created by the Initial Developer are Copyright (C) 2011
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *   Ben Turner <bent.mozilla@gmail.com> (Original Author)
+ *   Philipp von Weitershausen <philipp@weitershausen.de>
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+const {classes: Cc, interfaces: Ci, utils: Cu, results: Cr} = Components;
+
+Cu.import("resource://gre/modules/XPCOMUtils.jsm");
+
+const DEBUG = true; // set to false to suppress debug messages
+
+const TELEPHONYWORKER_CONTRACTID = "@mozilla.org/telephony/worker;1";
+const TELEPHONYWORKER_CID        = Components.ID("{2d831c8d-6017-435b-a80c-e5d422810cea}");
+
+
+function nsTelephonyWorker() {
+  this.worker = new ChromeWorker("resource://gre/modules/ril_worker.js");
+  this.worker.onerror = this.onerror.bind(this);
+  this.worker.onmessage = this.onmessage.bind(this);
+
+  this._callbacks = [];
+  this.initialState = {};
+}
+nsTelephonyWorker.prototype = {
+
+  classID:   TELEPHONYWORKER_CID,
+  classInfo: XPCOMUtils.generateCI({classID: TELEPHONYWORKER_CID,
+                                    contractID: TELEPHONYWORKER_CONTRACTID,
+                                    classDescription: "TelephonyWorker",
+                                    interfaces: [Ci.nsITelephonyWorker,
+                                                 Ci.nsIRadioInterface]}),
+
+  QueryInterface: XPCOMUtils.generateQI([Ci.nsITelephonyWorker,
+                                         Ci.nsIRadioInterface]),
+
+  onerror: function onerror(event) {
+    // It is very important to call preventDefault on the event here.
+    // If an exception is thrown on the worker, it bubbles out to the
+    // component that created it. If that component doesn't have an
+    // onerror handler, the worker will try to call the error reporter
+    // on the context it was created on. However, That doesn't work
+    // for component contexts and can result in crashes. This onerror
+    // handler has to make sure that it calls preventDefault on the
+    // incoming event.
+    event.preventDefault();
+
+    debug("Got an error: " + event.filename + ":" +
+          event.lineno + ": " + event.message + "\n");
+  },
+
+  onmessage: function onmessage(event) {
+    let message = event.data;
+    debug("Received message: " + JSON.stringify(message));
+    let value;
+    switch (message.type) {
+      case "signalstrengthchange":
+        this.initialState.signalStrength = message.signalStrength;
+        value = message.signalStrength;
+        break;
+      case "operatorchange":
+        this.initialState.operator = message.operator;
+        value = message.operator;
+        break;
+      case "onradiostatechange":
+        this.initialState.radioState = message.radioState;
+        value = message.radioState;
+        break;
+      case "cardstatechange":
+        this.initialState.cardState = message.cardState;
+        value = message.cardState;
+        break;
+      case "callstatechange":
+        this.initialState.callState = message.callState;
+        value = message.callState;
+        break;
+      default:
+        // Got some message from the RIL worker that we don't know about.
+    }
+    this._callbacks.forEach(function (callback) {
+      let method = callback[methodname];
+      if (typeof method != "function") {
+        return;
+      }
+      method.call(callback, value);
+    });
+  },
+
+  // nsITelephonWorker
+
+  worker: null,
+
+  // nsIRadioInterface
+
+  initialState: null,
+
+  dial: function dial(number) {
+    debug("Dialing " + number);
+    this.worker.postMessage({type: "dial", number: number});
+  },
+
+  _callbacks: null,
+
+  registerCallback: function registerCallback(callback) {
+    this._callbacks.push(callback);
+  },
+
+  unregisterCallback: function unregisterCallback(callback) {
+    let index = this._callbacks.indexOf(callback);
+    if (index == -1) {
+      throw "Callback not registered!";
+    }
+    this._callbacks.splice(index, 1);
+  },
+
+};
+
+const NSGetFactory = XPCOMUtils.generateNSGetFactory([nsTelephonyWorker]);
+
+let debug;
+if (DEBUG) {
+  debug = function (s) {
+    dump("-*- TelephonyWorker component: " + s + "\n");
+  };
+} else {
+  debug = function (s) {};
+}

dom/telephony/worker-component/nsTelephonyWorker.manifest

@@ -0,0 +1 @@
+component {2d831c8d-6017-435b-a80c-e5d422810cea} nsTelephonyWorker.js

dom/telephony/worker-component/ril_consts.js

@@ -0,0 +1,189 @@
+/* ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is RIL JS Worker.
+ *
+ * The Initial Developer of the Original Code is
+ * the Mozilla Foundation.
+ * Portions created by the Initial Developer are Copyright (C) 2011
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *   Kyle Machulis <kyle@nonpolynomial.com>
+ *   Philipp von Weitershausen <philipp@weitershausen.de>
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 2 or later (the "GPL"), or
+ * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+const CARD_MAX_APPS = 8;
+
+const RADIO_STATE_OFF = 0;
+const RADIO_STATE_UNAVAILABLE = 1;
+const RADIO_STATE_SIM_NOT_READY = 2;
+const RADIO_STATE_SIM_LOCKED_OR_ABSENT = 3;
+const RADIO_STATE_SIM_READY = 4;
+const RADIO_STATE_RUIM_NOT_READY = 5;
+const RADIO_STATE_RUIM_READY = 6;
+const RADIO_STATE_RUIM_LOCKED_OR_ABSENT = 7;
+const RADIO_STATE_NV_NOT_READY = 8;
+const RADIO_STATE_NV_READY = 9;
+
+const REQUEST_GET_SIM_STATUS = 1;
+const REQUEST_ENTER_SIM_PIN = 2;
+const REQUEST_ENTER_SIM_PUK = 3;
+const REQUEST_ENTER_SIM_PIN2 = 4;
+const REQUEST_ENTER_SIM_PUK2 = 5;
+const REQUEST_CHANGE_SIM_PIN = 6;
+const REQUEST_CHANGE_SIM_PIN2 = 7;
+const REQUEST_ENTER_NETWORK_DEPERSONALIZATION = 8;
+const REQUEST_GET_CURRENT_CALLS = 9;
+const REQUEST_DIAL = 10;
+const REQUEST_GET_IMSI = 11;
+const REQUEST_HANGUP = 12;
+const REQUEST_HANGUP_WAITING_OR_BACKGROUND = 13;
+const REQUEST_HANGUP_FOREGROUND_RESUME_BACKGROUND = 14;
+const REQUEST_SWITCH_WAITING_OR_HOLDING_AND_ACTIVE = 15;
+const REQUEST_SWITCH_HOLDING_AND_ACTIVE = 15;
+const REQUEST_CONFERENCE = 16;
+const REQUEST_UDUB = 17;
+const REQUEST_LAST_CALL_FAIL_CAUSE = 18;
+const REQUEST_SIGNAL_STRENGTH = 19;
+const REQUEST_REGISTRATION_STATE = 20;
+const REQUEST_GPRS_REGISTRATION_STATE = 21;
+const REQUEST_OPERATOR = 22;
+const REQUEST_RADIO_POWER = 23;
+const REQUEST_DTMF = 24;
+const REQUEST_SEND_SMS = 25;
+const REQUEST_SEND_SMS_EXPECT_MORE = 26;
+const REQUEST_SETUP_DATA_CALL = 27;
+const REQUEST_SIM_IO = 28;
+const REQUEST_SEND_USSD = 29;
+const REQUEST_CANCEL_USSD = 30;
+const REQUEST_GET_CLIR = 31;
+const REQUEST_SET_CLIR = 32;
+const REQUEST_QUERY_CALL_FORWARD_STATUS = 33;
+const REQUEST_SET_CALL_FORWARD = 34;
+const REQUEST_QUERY_CALL_WAITING = 35;
+const REQUEST_SET_CALL_WAITING = 36;
+const REQUEST_SMS_ACKNOWLEDGE = 37;
+const REQUEST_GET_IMEI = 38;
+const REQUEST_GET_IMEISV = 39;
+const REQUEST_ANSWER = 40;
+const REQUEST_DEACTIVATE_DATA_CALL = 41;
+const REQUEST_QUERY_FACILITY_LOCK = 42;
+const REQUEST_SET_FACILITY_LOCK = 43;
+const REQUEST_CHANGE_BARRING_PASSWORD = 44;
+const REQUEST_QUERY_NETWORK_SELECTION_MODE = 45;
+const REQUEST_SET_NETWORK_SELECTION_AUTOMATIC = 46;
+const REQUEST_SET_NETWORK_SELECTION_MANUAL = 47;
+const REQUEST_QUERY_AVAILABLE_NETWORKS = 48;
+const REQUEST_DTMF_START = 49;
+const REQUEST_DTMF_STOP = 50;
+const REQUEST_BASEBAND_VERSION = 51;
+const REQUEST_SEPARATE_CONNECTION = 52;
+const REQUEST_SET_MUTE = 53;
+const REQUEST_GET_MUTE = 54;
+const REQUEST_QUERY_CLIP = 55;
+const REQUEST_LAST_DATA_CALL_FAIL_CAUSE = 56;
+const REQUEST_DATA_CALL_LIST = 57;
+const REQUEST_RESET_RADIO = 58;
+const REQUEST_OEM_HOOK_RAW = 59;
+const REQUEST_OEM_HOOK_STRINGS = 60;
+const REQUEST_SCREEN_STATE = 61;
+const REQUEST_SET_SUPP_SVC_NOTIFICATION = 62;
+const REQUEST_WRITE_SMS_TO_SIM = 63;
+const REQUEST_DELETE_SMS_ON_SIM = 64;
+const REQUEST_SET_BAND_MODE = 65;
+const REQUEST_QUERY_AVAILABLE_BAND_MODE = 66;
+const REQUEST_STK_GET_PROFILE = 67;
+const REQUEST_STK_SET_PROFILE = 68;
+const REQUEST_STK_SEND_ENVELOPE_COMMAND = 69;
+const REQUEST_STK_SEND_TERMINAL_RESPONSE = 70;
+const REQUEST_STK_HANDLE_CALL_SETUP_REQUESTED_FROM_SIM = 71;
+const REQUEST_EXPLICIT_CALL_TRANSFER = 72;
+const REQUEST_SET_PREFERRED_NETWORK_TYPE = 73;
+const REQUEST_GET_PREFERRED_NETWORK_TYPE = 74;
+const REQUEST_GET_NEIGHBORING_CELL_IDS = 75;
+const REQUEST_SET_LOCATION_UPDATES = 76;
+const REQUEST_CDMA_SET_SUBSCRIPTION = 77;
+const REQUEST_CDMA_SET_ROAMING_PREFERENCE = 78;
+const REQUEST_CDMA_QUERY_ROAMING_PREFERENCE = 79;
+const REQUEST_SET_TTY_MODE = 80;
+const REQUEST_QUERY_TTY_MODE = 81;
+const REQUEST_CDMA_SET_PREFERRED_VOICE_PRIVACY_MODE = 82;
+const REQUEST_CDMA_QUERY_PREFERRED_VOICE_PRIVACY_MODE = 83;
+const REQUEST_CDMA_FLASH = 84;
+const REQUEST_CDMA_BURST_DTMF = 85;
+const REQUEST_CDMA_VALIDATE_AND_WRITE_AKEY = 86;
+const REQUEST_CDMA_SEND_SMS = 87;
+const REQUEST_CDMA_SMS_ACKNOWLEDGE = 88;
+const REQUEST_GSM_GET_BROADCAST_SMS_CONFIG = 89;
+const REQUEST_GSM_SET_BROADCAST_SMS_CONFIG = 90;
+const REQUEST_GSM_SMS_BROADCAST_ACTIVATION = 91;
+const REQUEST_CDMA_GET_BROADCAST_SMS_CONFIG = 92;
+const REQUEST_CDMA_SET_BROADCAST_SMS_CONFIG = 93;
+const REQUEST_CDMA_SMS_BROADCAST_ACTIVATION = 94;
+const REQUEST_CDMA_SUBSCRIPTION = 95;
+const REQUEST_CDMA_WRITE_SMS_TO_RUIM = 96;
+const REQUEST_CDMA_DELETE_SMS_ON_RUIM = 97;
+const REQUEST_DEVICE_IDENTITY = 98;
+const REQUEST_EXIT_EMERGENCY_CALLBACK_MODE = 99;
+const REQUEST_GET_SMSC_ADDRESS = 100;
+const REQUEST_SET_SMSC_ADDRESS = 101;
+const REQUEST_REPORT_SMS_MEMORY_STATUS = 102;
+const REQUEST_REPORT_STK_SERVICE_IS_RUNNING = 103;
+
+const UNSOLICITED_RESPONSE_BASE = 1000;
+const UNSOLICITED_RESPONSE_RADIO_STATE_CHANGED = 1000;
+const UNSOLICITED_RESPONSE_CALL_STATE_CHANGED = 1001;
+const UNSOLICITED_RESPONSE_NETWORK_STATE_CHANGED = 1002;
+const UNSOLICITED_RESPONSE_NEW_SMS = 1003;
+const UNSOLICITED_RESPONSE_NEW_SMS_STATUS_REPORT = 1004;
+const UNSOLICITED_RESPONSE_NEW_SMS_ON_SIM = 1005;
+const UNSOLICITED_ON_USSD = 1006;
+const UNSOLICITED_ON_USSD_REQUEST = 1007;
+const UNSOLICITED_NITZ_TIME_RECEIVED = 1008;
+const UNSOLICITED_SIGNAL_STRENGTH = 1009;
+const UNSOLICITED_DATA_CALL_LIST_CHANGED = 1010;
+const UNSOLICITED_SUPP_SVC_NOTIFICATION = 1011;
+const UNSOLICITED_STK_SESSION_END = 1012;
+const UNSOLICITED_STK_PROACTIVE_COMMAND = 1013;
+const UNSOLICITED_STK_EVENT_NOTIFY = 1014;
+const UNSOLICITED_STK_CALL_SETUP = 1015;
+const UNSOLICITED_SIM_SMS_STORAGE_FULL = 1016;
+const UNSOLICITED_SIM_REFRESH = 1017;
+const UNSOLICITED_CALL_RING = 1018;
+const UNSOLICITED_RESPONSE_SIM_STATUS_CHANGED = 1019;
+const UNSOLICITED_RESPONSE_CDMA_NEW_SMS = 1020;
+const UNSOLICITED_RESPONSE_NEW_BROADCAST_SMS = 1021;
+const UNSOLICITED_CDMA_RUIM_SMS_STORAGE_FULL = 1022;
+const UNSOLICITED_RESTRICTED_STATE_CHANGED = 1023;
+const UNSOLICITED_ENTER_EMERGENCY_CALLBACK_MODE = 1024;
+const UNSOLICITED_CDMA_CALL_WAITING = 1025;
+const UNSOLICITED_CDMA_OTA_PROVISION_STATUS = 1026;
+const UNSOLICITED_CDMA_INFO_REC = 1027;
+const UNSOLICITED_OEM_HOOK_RAW = 1028;
+const UNSOLICITED_RINGBACK_TONE = 1029;
+const UNSOLICITED_RESEND_INCALL_MUTE = 1030;
+