airplane_mode_service_helper.js

/* global BaseModule */
'use strict';

(function() {
  var AirplaneModeServiceHelper = function() {};
  /**
   * AirplaneModeServiceHelper should be deprecated in the future.
   * We should let each API handler to observe airplane mode
   * status change to turn on/off each API on their own.
   */
  AirplaneModeServiceHelper.SETTINGS = [
    'ril.data.enabled',
    'ril.data.suspended',
    'bluetooth.enabled',
    'bluetooth.suspended',
    'wifi.enabled',
    'wifi.suspended',
    'geolocation.enabled',
    'geolocation.suspended',
    'nfc.enabled',
    'nfc.suspended'
  ];
  BaseModule.create(AirplaneModeServiceHelper, {
    name: 'AirplaneModeServiceHelper',
    '_observe_ril.data.enabled': function(value) {
      if (value) {
        this._unsuspend('ril.data.suspended');
      }
    },
    '_observe_bluetooth.enabled': function(value) {
      if (value) {
        this._unsuspend('bluetooth.suspended');
      }
    },
    '_observe_geolocation.enabled': function(value) {
      if (value) {
        this._unsuspend('geolocation.suspended');
      }
    },
    '_observe_wifi.enabled': function(value) {
      if (value) {
        this._unsuspend('wifi.suspended');
      }
    },
    '_observe_nfc.enabled': function(value) {
      if (value) {
        this._unsuspend('nfc.suspended');
      }
    },
    // turn off the mozSetting corresponding to `key'
    // and remember its initial state by storing it in another setting
    _suspend: function(key) {
      this.debug('suspending: ' + key);
      var enabled = this._settings[key + '.enabled'];
      var suspended = this._settings[key + '.suspended'];

      if (suspended) {
        this.debug('already suspended.');
        return;
      }

      // remember the state before switching it to false
      var sset = {};
      sset[key + '.suspended'] = enabled;
      this.writeSetting(sset);

      // switch the state to false if necessary
      if (enabled) {
        // make sure both BT API and settings key are handled
        if ('bluetooth' === key) {
          window.dispatchEvent(new CustomEvent('request-disable-bluetooth'));
        } else {
          var eset = {};
          eset[key + '.enabled'] = false;
          this.writeSetting(eset);
        }
      }
    },
    // turn on the mozSetting corresponding to `key'
    // if it has been suspended by the airplane mode
    _restore: function(key) {
      this.debug('restoring: ' + key);
      var suspended = this._settings[key + '.suspended'];

      // clear the 'suspended' state
      var sset = {};
      sset[key + '.suspended'] = false;
      this.writeSetting(sset);

      // switch the state to true if it was suspended
      if (suspended) {
        // make sure both BT API and settings key are handled
        if ('bluetooth' === key) {
          window.dispatchEvent(new CustomEvent('request-enable-bluetooth'));
        } else {
          var rset = {};
          rset[key + '.enabled'] = true;
          this.writeSetting(rset);
        }
      }
    },
    _unsuspend: function(settingSuspendedID) {
      this.debug('unsuspending: ' + settingSuspendedID);
      // clear the 'suspended' state
      var sset = {};
      sset[settingSuspendedID] = false;
      this.writeSetting(sset);
    },
    isEnabled: function(key) {
      return this._settings[key + '.enabled'];
    },
    isSuspended: function(key) {
      return this._settings[key + '.suspended'];
    },
    updateStatus: function(value) {
      this.debug('updating status.');
      // FM Radio will be turned off in Gecko, more detailed about why we do
      // this in Gecko instead, please check bug 997064.
      var bluetooth = window.navigator.mozBluetooth;
      var wifiManager = window.navigator.mozWifiManager;
      var nfc = window.navigator.mozNfc;

      this.publish(value ? 'airplanemode-enabled' : 'airplanemode-disabled');

      if (value) {

        // Turn off mobile data:
        // we toggle the mozSettings value here just for the sake of UI,
        // platform RIL disconnects mobile data when
        // 'ril.radio.disabled' is true.
        this._suspend('ril.data');

        // Turn off Bluetooth.
        if (bluetooth) {
          this._suspend('bluetooth');
        }

        // Turn off Wifi and Wifi tethering.
        if (wifiManager) {
          this._suspend('wifi');
          this.writeSetting({
            'tethering.wifi.enabled': false
          });
        }

        // Turn off Geolocation.
        this._suspend('geolocation');

        // Turn off NFC
        if (nfc) {
          this._suspend('nfc');
        }
      } else {
        // Note that we don't restore Wifi tethering when leaving airplane mode
        // because Wifi tethering can't be switched on before data connection is
        // established.

        // Don't attempt to turn on mobile data if it's already on
        if (!this._settings['ril.data.enabled']) {
          this._restore('ril.data');
        }

        // Don't attempt to turn on Bluetooth if it's already on
        if (bluetooth && !this._settings['bluetooth.enabled']) {
          this._restore('bluetooth');
        }

        // Don't attempt to turn on Wifi if it's already on
        if (wifiManager && !this._settings['wifi.enabled']) {
          this._restore('wifi');
        }

        // Don't attempt to turn on Geolocation if it's already on
        if (!this._settings['geolocation.enabled']) {
          this._restore('geolocation');
        }

        // Don't attempt to turn on NFC if it's already on
        if (nfc && !this._settings['nfc.enabled']) {
          this._restore('nfc');
        }
      }
    }
  });
}());