use MMC/MNC to determine region/carrier (bug 867793)

Author: cvan

hearth/media/js/cat-dropdown.js

@@ -1,5 +1,7 @@
 define('cat-dropdown',
-    ['underscore', 'helpers', 'jquery', 'l10n', 'models', 'requests', 'templates', 'urls', 'z'],
+    // We require `user` here to initialize carrier/region detection so that gets
+    // set before we pass those values to the API to get the list of categories.
+    ['underscore', 'helpers', 'jquery', 'l10n', 'models', 'requests', 'templates', 'urls', 'z', 'user'],
     function(_, helpers, $, l10n, models, requests, nunjucks, urls, z) {
     'use strict';
 

hearth/media/js/marketplace.js

@@ -41,6 +41,7 @@ require.config({
             'lightbox',
             'log',
             'login',
+            'mobilenetwork',
             'navigation',
             'outgoing_links',
             'overlay',
@@ -67,11 +68,6 @@ require.config({
 
         nunjucks.env.dev = true;
 
-        // Get mobile region and carrier information.
-        var GET = require('utils').getVars();
-        settings.mcc = GET.mcc;
-        settings.mnc = GET.mnc;
-
         z.body.addClass('html-' + require('l10n').getDirection());
         if (settings.body_classes) {
             z.body.addClass(settings.body_classes);

hearth/media/js/mobilenetwork.js

@@ -0,0 +1,202 @@
+define('mobilenetwork', [], function() {
+    var regions = {
+        // United States
+        310: 'us',
+
+        // United Kingdom
+        235: 'uk',
+
+        // Brazil
+        724: 'br',
+
+        // Spain
+        214: 'es',
+
+        // Colombia
+        732: 'co',
+
+        // Venezuela
+        734: 've',
+
+        // Poland
+        260: 'pl',
+
+        // Mexico
+        334: 'mx',
+
+        // Hungary
+        216: 'hu',
+
+        // Germany
+        262: 'de'
+    };
+
+    var carriers = {
+        // United States
+        310: {
+            26: 'deutsche_telekom',
+            160: 'deutsche_telekom',
+            170: 'deutsche_telekom',
+            200: 'deutsche_telekom',
+            210: 'deutsche_telekom',
+            220: 'deutsche_telekom',
+            230: 'deutsche_telekom',
+            240: 'deutsche_telekom',
+            250: 'deutsche_telekom',
+            260: 'deutsche_telekom',
+            270: 'deutsche_telekom',
+            280: 'deutsche_telekom',
+            290: 'deutsche_telekom',
+            330: 'deutsche_telekom',
+            490: 'deutsche_telekom',
+            580: 'deutsche_telekom',
+            660: 'deutsche_telekom',
+            800: 'deutsche_telekom'
+        },
+
+        // United Kingdom
+        235: {
+            2: 'telefonica',
+            10: 'telefonica',
+            11: 'telefonica',
+            30: 'deutsche_telekom'
+        },
+
+        // Brazil
+        724: {
+            6: 'telefonica',
+            10: 'telefonica',
+            11: 'telefonica',
+            23: 'telefonica'
+        },
+
+        // Spain
+        214: {
+            5: 'telefonica',
+            7: 'telefonica'
+        },
+
+        // Colombia
+        732: {
+            123: 'telefonica'
+        },
+
+        // Venezuela
+        734: {
+            4: 'telefonica'
+        },
+
+        // Poland
+        260: {
+            2: 'deutsche_telekom'
+        },
+
+        // Mexico
+        334: {
+            2: 'america_movil',
+            20: 'america_movil',
+            300: 'telefonica'
+        },
+
+        // Hungary
+        216: {
+            30: 'deutsche_telekom'
+        },
+
+        // Germany
+        262: {
+            1: 'deutsche_telekom',
+            6: 'deutsche_telekom'
+        },
+
+        // Slovakia
+        231: {
+            2: 'deutsche_telekom',
+            4: 'deutsche_telekom',
+            6: 'telefonica'
+        },
+
+        // Czech Republic
+        232: {
+            2: 'telefonica'
+        },
+
+        // Austria
+        232: {
+            8: 'telefonica'
+        },
+
+        // Guatemala
+        704: {
+            3: 'telefonica'
+        },
+
+        // El Salvador
+        706: {
+            4: 'telefonica'
+        },
+
+        // Nicaragua
+        710: {
+            3: 'telefonica'
+        },
+
+        // Costa Rica
+        712: {
+            4: 'telefonica'
+        },
+
+        // Panama
+        714: {
+            2: 'telefonica',
+            3: 'america_movil'
+        },
+
+        // Chile
+        730: {
+            2: 'telefonica'
+        },
+
+        // Ecuador
+        740: {
+            1: 'america_movil'
+        },
+
+        // Paraguay
+        744: {
+            4: 'telefonica',
+        },
+
+        // Peru
+        716: {
+            6: 'telefonica',
+            10: 'america_movil'
+        },
+
+        // Argentina
+        722: {
+            10: 'telefonica',
+            70: 'telefonica'
+        },
+
+        // Uruguay
+        748: {
+            7: 'telefonica'
+        }
+    };
+
+    function getNetwork(mcc, mnc) {
+        // Look up region and carrier from MCC (Mobile Country Code)
+        // and MNC (Mobile Network Code).
+        mcc = +mcc || 0;
+        mnc = +mnc || 0;
+        return {
+            region: regions[mcc] || null,
+            carrier: carriers[mcc] && carriers[mcc][mnc] || null
+        };
+    }
+
+    return {
+        getNetwork: getNetwork
+    };
+});

hearth/media/js/settings.js

@@ -30,12 +30,6 @@ define('settings', ['settings_local', 'underscore'], function(settings_local, _)
         persona: 'https://login.persona.org/include.js',
 
         title_suffix: 'Firefox Marketplace',
-        carrier: null,
-
-        // `MCC`: Mobile Country Code
-        mcc: null,
-
-        // `MNC`: Mobile Network Code
-        mnc: null
+        carrier: null
     });
 });

hearth/media/js/urls.js

@@ -1,6 +1,6 @@
 define('urls',
     ['buckets', 'capabilities', 'format', 'settings', 'underscore', 'user', 'utils'],
-    function(buckets, caps, format, settings, _) {
+    function(buckets, caps, format, settings, _, user) {
 
     var group_pattern = /\(.+\)/;
     var reverse = function(view_name, args) {
@@ -63,13 +63,14 @@ define('urls',
         }
     };
 
-    var user = require('user');
+
     function _userArgs(func) {
         return function() {
             var out = func.apply(this, arguments);
             var args = {
                 lang: navigator.language,
                 region: user.get_setting('region') || '',
+                carrier: user.get_setting('carrier') || '',
                 //scr: caps.widescreen() ? 'wide' : 'mobile',
                 //tch: caps.touch,
                 dev: _device(),
@@ -78,9 +79,6 @@ define('urls',
             if (user.logged_in()) {
                 args._user = user.get_token();
             }
-            if (settings.carrier) {
-                args.carrier = settings.carrier.slug;
-            }
             return require('utils').urlparams(out, args);
         };
     }

hearth/media/js/user.js

@@ -1,4 +1,6 @@
-define('user', ['capabilities', 'log'], function(capabilities, log) {
+define('user',
+    ['capabilities', 'log', 'mobilenetwork', 'settings', 'utils'],
+    function(capabilities, log, mobilenetwork, site_settings, utils) {
 
     var console = log('user');
 
@@ -15,6 +17,76 @@ define('user', ['capabilities', 'log'], function(capabilities, log) {
         permissions = JSON.parse(localStorage.getItem('permissions') || '{}');
     }
 
+    function detect_mobile_network(navigator) {
+        navigator = navigator || window.navigator;
+
+        var GET = utils.getVars();
+        var mcc;
+        var mnc;
+        var region;
+
+        // Hardcoded carrier should never get overridden.
+        var carrier = site_settings.carrier;
+        if (carrier && typeof carrier === 'object') {
+            carrier = carrier.slug;
+        }
+        carrier = carrier || GET.carrier || null;
+
+        if (!carrier) {
+            // Get mobile region and carrier information passed via querystring.
+            mcc = GET.mcc;
+            mnc = GET.mnc;
+        }
+
+        try {
+            // When Fireplace is served as a privileged packaged app (and not
+            // served via Yulelog) our JS will have direct access to this API.
+            var conn = navigator.mozMobileConnection;
+            if (conn) {
+                // `MCC`: Mobile Country Code
+                // `MNC`: Mobile Network Code
+                // `lastKnownNetwork`: `{MCC}-{MNC}`
+                var network = (conn.lastKnownNetwork || conn.lastKnownHomeNetwork || '-').split('-');
+                mcc = network[0];
+                mnc = network[1];
+                console.log('MCC = ' + mcc + ', MNC = ' + mnc);
+            } else {
+                console.warn('Error accessing navigator.mozMobileConnection');
+            }
+        } catch(e) {
+            // Fail gracefully if `navigator.mozMobileConnection` gives us problems.
+            console.warn('Error accessing navigator.mozMobileConnection:', e);
+        }
+
+        if (mcc || mnc) {
+            // Look up region and carrier from MCC (Mobile Country Code)
+            // and MNC (Mobile Network Code).
+            var network = mobilenetwork.getNetwork(mcc, mnc);
+            region = network.region;
+            carrier = network.carrier;
+        }
+
+        // Get region from settings saved to localStorage.
+        region = settings.region || region;
+
+        // If it turns out the region is null, when we get a response from an
+        // API request, we look at the `API-Filter` header to determine the region
+        // in which Zamboni geolocated the user.
+
+        settings.carrier = carrier || null;
+        settings.region = region || null;
+    }
+
+    detect_mobile_network(navigator);
+
+    if (save_to_ls) {
+        save_settings();
+    }
+
+    function clear_settings() {
+        settings = {};
+    }
+
     function clear_token() {
         console.log('Clearing user token');
 
@@ -29,7 +101,7 @@ define('user', ['capabilities', 'log'], function(capabilities, log) {
     }
 
     function get_setting(setting) {
-        return settings[setting];
+        return settings[setting] || null;
     }
 
     function get_permission(setting) {
@@ -96,7 +168,9 @@ define('user', ['capabilities', 'log'], function(capabilities, log) {
     }
 
     return {
+        clear_settings: clear_settings,
         clear_token: clear_token,
+        detect_mobile_network: detect_mobile_network,
         get_setting: get_setting,
         get_permission: get_permission,
         get_settings: get_settings,

hearth/templates/tests.html

@@ -21,8 +21,10 @@ <h2>Unit Tests</h2>
 <script type="text/javascript" src="/tests/apps.js"></script>
 <script type="text/javascript" src="/tests/cache.js"></script>
 <script type="text/javascript" src="/tests/l10n.js"></script>
+<script type="text/javascript" src="/tests/mobilenetwork.js"></script>
 <script type="text/javascript" src="/tests/models.js"></script>
 <script type="text/javascript" src="/tests/requests.js"></script>
 <script type="text/javascript" src="/tests/rewriters.js"></script>
 <script type="text/javascript" src="/tests/urls.js"></script>
+<script type="text/javascript" src="/tests/user.js"></script>
 <script type="text/javascript" src="/tests/utils.js"></script>