src/main/js/probes.js

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/**
 * This file defines the default probes.
 */

/*global BrowserMap:false, Modernizr:false */
BrowserMap.addProbe('BrowserMap.version', function() {
    return BrowserMap.VERSION;
}).addProbe('Modernizr.touch', function() {
    return Modernizr.touch;
}).addProbe('Modernizr.csstransforms3d', function() {
    return Modernizr.csstransforms3d;
}).addProbe('window.devicePixelRatio', function() {
    return window.devicePixelRatio;
}).addProbe('window.orientation', function() {
    return window.orientation;
}).addProbe('navigator.vendor', function() {
    return navigator.vendor;
}).addProbe('navigator.platform', function() {
    return navigator.platform;
}).addProbe('navigator.appName', function() {
    return navigator.appName;
}).addProbe('navigator.appVersion', function() {
    return navigator.appVersion;
}).addProbe('navigator.appCodeName', function() {
    return navigator.appCodeName;
}).addProbe('navigator.userAgent', function() {
    return navigator.userAgent;
}).addProbe('screenWidth', function() {
    return screen.width;
}).addProbe('screenHeight', function() {
    return screen.height;
}).addProbe('clientWidth', function() {
    return document.documentElement.clientWidth;
}).addProbe('orientation', function() {
    var orientation = '';
    if (window.innerWidth > window.innerHeight) {
        orientation = 'landscape';
    }
    else {
        orientation = 'portrait';
    }
    return orientation;
}).addProbe('portrait', function() {
    return BrowserMap.probe('orientation') == 'portrait';
}).addProbe('landscape', function() {
    return BrowserMap.probe('orientation') == 'landscape';
}).addProbe('screenWidthDependingOnOrientation', function () {
    var widthDependingOnOrientation = 0;
    if (BrowserMap.probe('orientation') === 'portrait') {
        widthDependingOnOrientation = screen.width > screen.height ? screen.height : screen.width;
    } else {
        widthDependingOnOrientation = screen.width < screen.height ? screen.height : screen.width;
    }
    return widthDependingOnOrientation;
}).addProbe('clientWidthDependingOnOrientation', function () {
    var clientWidthDependingOnOrientation = 0;
    if (BrowserMap.probe('orientation') == 'portrait') {
        clientWidthDependingOnOrientation = document.documentElement.clientWidth <
            document.documentElement.clientHeight ? document.documentElement.clientWidth : document.documentElement.clientHeight;
    } else {
        clientWidthDependingOnOrientation = document.documentElement.clientWidth >
            document.documentElement.clientHeight ? document.documentElement.clientWidth : document.documentElement.clientHeight;
    }
    return clientWidthDependingOnOrientation;
}).addProbe('devicePixelRatio', function() {
    var mq = window.matchMedia,
        ratio = -1,
        userAgent;
    if (mq) {
        for (var i = 0.5; i <= 3; i+= 0.05) {
            var r = Math.round(i * 100)/100;
            if (mq(
                    '(max-resolution: ' + r + 'dppx), \
                    (max-resolution: ' + r * 96 + 'dpi), \
                    (-webkit-max-device-pixel-ratio: ' + r + '), \
                    (-o-device-pixel-ratio: ' + r + ')'
                ).matches) {
                ratio = r;
                break;
            }
        }
    }

    // hacks for browsers not returning correct answers to the above media queries
    userAgent = BrowserMap.probe('navigator.userAgent');
    if (userAgent.indexOf('BlackBerry') != -1 || userAgent.indexOf('Windows Phone') != -1) {
        ratio = Math.round(BrowserMap.probe('screenWidthDependingOnOrientation') /
                BrowserMap.probe('clientWidthDependingOnOrientation') * 100) /
                100;
    }
    return ratio;
}).addProbe('canResizeBrowserWindow', function() {
    /**
     * useful to detect a mobile browser (false) / a desktop browser (true)
     */
    return Math.round(BrowserMap.probe('screenWidthDependingOnOrientation') / BrowserMap.probe('devicePixelRatio')) -
                BrowserMap.THE_ANSWER_TO_LIFE_THE_UNIVERSE_AND_EVERYTHING > BrowserMap.probe('clientWidth');
});