DeviceDetection.php

Go to the documentation of this file.

<?php
interface IDeviceProperties {
        function format();

        function supportsJavaScript();

        function supportsJQuery();

        function disableZoom();
}

interface IDeviceDetector {
        function detectDeviceProperties( $userAgent, $acceptHeader = '' );

        function getDeviceProperties( $deviceName );

        function detectDeviceName( $userAgent, $acceptHeader = '' );
}

final class DeviceProperties implements IDeviceProperties {
        private $device;

        public function __construct( array $deviceCapabilities ) {
                $this->device = $deviceCapabilities;
        }

        function format() {
                return $this->device['view_format'];
        }

        function supportsJavaScript() {
                return $this->device['supports_javascript'];
        }

        function supportsJQuery() {
                return $this->device['supports_jquery'];
        }

        function disableZoom() {
                return $this->device['disable_zoom'];
        }
}

class DeviceDetection implements IDeviceDetector {

        private static $formats = array (
                        'html' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'default',
                                'supports_javascript' => false,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                        'capable' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'default',
                                'supports_javascript' => true,
                                'supports_jquery' => true,
                                'disable_zoom' => true,
                        ),
                        'webkit' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'webkit',
                                'supports_javascript' => true,
                                'supports_jquery' => true,
                                'disable_zoom' => false,
                        ),
                        'ie' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'default',
                                'supports_javascript' => true,
                                'supports_jquery' => true,
                                'disable_zoom' => false,
                        ),
                        'android' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'android',
                                'supports_javascript' => true,
                                'supports_jquery' => true,
                                'disable_zoom' => false,
                        ),
                        'iphone' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'iphone',
                                'supports_javascript' => true,
                                'supports_jquery' => true,
                                'disable_zoom' => false,
                        ),
                        'iphone2' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'iphone2',
                                'supports_javascript' => true,
                                'supports_jquery' => true,
                                'disable_zoom' => true,
                        ),
                        'native_iphone' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'default',
                                'supports_javascript' => true,
                                'supports_jquery' => true,
                                'disable_zoom' => false,
                        ),
                        'palm_pre' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'palm_pre',
                                'supports_javascript' => true,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                        'kindle' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'kindle',
                                'supports_javascript' => false,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                        'kindle2' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'kindle',
                                'supports_javascript' => false,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                        'blackberry' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'blackberry',
                                'supports_javascript' => true,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                        'blackberry-lt5' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'blackberry',
                                'supports_javascript' => false,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                        'netfront' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'simple',
                                'supports_javascript' => false,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                        'wap2' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'simple',
                                'supports_javascript' => false,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                        'psp' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'psp',
                                'supports_javascript' => false,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                        'ps3' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'simple',
                                'supports_javascript' => false,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                        'wii' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'wii',
                                'supports_javascript' => true,
                                'supports_jquery' => true,
                                'disable_zoom' => true,
                        ),
                        'operamini' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'operamini',
                                'supports_javascript' => false,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                        'operamobile' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'operamobile',
                                'supports_javascript' => true,
                                'supports_jquery' => true,
                                'disable_zoom' => true,
                        ),
                        'nokia' => array (
                                'view_format' => 'html',
                                'css_file_name' => 'nokia',
                                'supports_javascript' => true,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                        'wml' => array (
                                'view_format' => 'wml',
                                'css_file_name' => null,
                                'supports_javascript' => false,
                                'supports_jquery' => false,
                                'disable_zoom' => true,
                        ),
                );

        public static function factory() {
                global $wgDeviceDetectionClass;

                static $instance = null;
                if ( !$instance ) {
                        $instance = new $wgDeviceDetectionClass();
                }
                return $instance;
        }

        public function detectDevice( $userAgent, $acceptHeader = '' ) {
                $formatName = $this->detectFormatName( $userAgent, $acceptHeader );
                return $this->getDevice( $formatName );
        }

        public function detectDeviceProperties( $userAgent, $acceptHeader = '' ) {
                $deviceName = $this->detectDeviceName( $userAgent, $acceptHeader );
                return $this->getDeviceProperties( $deviceName );
        }

        public function getDevice( $formatName ) {
                return ( isset( self::$formats[$formatName] ) ) ? self::$formats[$formatName] : array();
        }

        public function getDeviceProperties( $deviceName ) {
                if ( isset( self::$formats[$deviceName] ) ) {
                        return new DeviceProperties( self::$formats[$deviceName] );
                } else {
                        return new DeviceProperties( array(
                                'view_format' => 'html',
                                'css_file_name' => 'default',
                                'supports_javascript' => true,
                                'supports_jquery' => true,
                                'disable_zoom' => true,
                        ) );
                }
        }

        public function detectFormatName( $userAgent, $acceptHeader = '' ) {
                return $this->detectDeviceName( $userAgent, $acceptHeader );
        }

        public function detectDeviceName( $userAgent, $acceptHeader = '' ) {
                wfProfileIn( __METHOD__ );

                $deviceName = '';
                if ( preg_match( '/Android/', $userAgent ) ) {
                        $deviceName = 'android';
                        if ( strpos( $userAgent, 'Opera Mini' ) !== false ) {
                                $deviceName = 'operamini';
                        } elseif ( strpos( $userAgent, 'Opera Mobi' ) !== false ) {
                                $deviceName = 'operamobile';
                        }
                } elseif ( preg_match( '/MSIE 9.0/', $userAgent ) ||
                                preg_match( '/MSIE 8.0/', $userAgent ) ) {
                        $deviceName = 'ie';
                } elseif( preg_match( '/MSIE/', $userAgent ) ) {
                        $deviceName = 'html';
                } elseif ( strpos( $userAgent, 'Opera Mobi' ) !== false ) {
                        $deviceName = 'operamobile';
                } elseif ( preg_match( '/iPad.* Safari/', $userAgent ) ) {
                        $deviceName = 'iphone';
                } elseif ( preg_match( '/iPhone.* Safari/', $userAgent ) ) {
                        if ( strpos( $userAgent, 'iPhone OS 2' ) !== false ) {
                                $deviceName = 'iphone2';
                        } else {
                                $deviceName = 'iphone';
                        }
                } elseif ( preg_match( '/iPhone/', $userAgent ) ) {
                        if ( strpos( $userAgent, 'Opera' ) !== false ) {
                                $deviceName = 'operamini';
                        } else {
                                $deviceName = 'native_iphone';
                        }
                } elseif ( preg_match( '/WebKit/', $userAgent ) ) {
                        if ( preg_match( '/Series60/', $userAgent ) ) {
                                $deviceName = 'nokia';
                        } elseif ( preg_match( '/webOS/', $userAgent ) ) {
                                $deviceName = 'palm_pre';
                        } else {
                                $deviceName = 'webkit';
                        }
                } elseif ( preg_match( '/Opera/', $userAgent ) ) {
                        if ( strpos( $userAgent, 'Nintendo Wii' ) !== false ) {
                                $deviceName = 'wii';
                        } elseif ( strpos( $userAgent, 'Opera Mini' ) !== false ) {
                                $deviceName = 'operamini';
                        } else {
                                $deviceName = 'operamobile';
                        }
                } elseif ( preg_match( '/Kindle\/1.0/', $userAgent ) ) {
                        $deviceName = 'kindle';
                } elseif ( preg_match( '/Kindle\/2.0/', $userAgent ) ) {
                        $deviceName = 'kindle2';
                } elseif ( preg_match( '/Firefox/', $userAgent ) ) {
                        $deviceName = 'capable';
                } elseif ( preg_match( '/NetFront/', $userAgent ) ) {
                        $deviceName = 'netfront';
                } elseif ( preg_match( '/SEMC-Browser/', $userAgent ) ) {
                        $deviceName = 'wap2';
                } elseif ( preg_match( '/Series60/', $userAgent ) ) {
                        $deviceName = 'wap2';
                } elseif ( preg_match( '/PlayStation Portable/', $userAgent ) ) {
                        $deviceName = 'psp';
                } elseif ( preg_match( '/PLAYSTATION 3/', $userAgent ) ) {
                        $deviceName = 'ps3';
                } elseif ( preg_match( '/SAMSUNG/', $userAgent ) ) {
                        $deviceName = 'capable';
                } elseif ( preg_match( '/BlackBerry/', $userAgent ) ) {
                        if( preg_match( '/BlackBerry[^\/]*\/[1-4]\./', $userAgent ) ) {
                                $deviceName = 'blackberry-lt5';
                        } else {
                                $deviceName = 'blackberry';
                        }
                }

                if ( $deviceName === '' ) {
                        if ( strpos( $acceptHeader, 'application/vnd.wap.xhtml+xml' ) !== false ) {
                                // Should be wap2
                                $deviceName = 'html';
                        } elseif ( strpos( $acceptHeader, 'vnd.wap.wml' ) !== false ) {
                                $deviceName = 'wml';
                        } else {
                                $deviceName = 'html';
                        }
                }
                wfProfileOut( __METHOD__ );
                return $deviceName;
        }

        public function getCssFiles() {
                $files = array();

                foreach ( self::$formats as $dev ) {
                        if ( isset( $dev['css_file_name'] ) ) {
                                $files[] = $dev['css_file_name'];
                        }
                }
                return array_unique( $files );
        }
}