Name

lua-resty-mobile - This library parses HTTP headers and detects mobile devices

Table of Contents

• Name
• Status
• Requirements
• Synopsis
• Methods
  • init
  • detect
• Installation
• Authors
• Copyright and License

Status

This library is production ready.

Requirements

This library requires lua-resty-cookie and cjson
Also, this library uses definitions json file from (http://mobiledetect.net/)

Synopsis

    lua_package_path "/path/to/lua-resty-mobile/lib/?.lua;;";

    lua_shared_dict mobile 5m;

    init_by_lua '
      require("resty.mobile").init("/path/to/Mobile_Detect.json")
    ';


    server {
        location /test {
            set $mobile_detected 'false';
            set $mobile_device 'computer';

            set_by_lua $mobile_detected '
              return require("resty.mobile").detect("mobile")
            ';

            if ($mobile_detected = 'true')
            {
              # set cookie or smth
              add_header Set-Cookie "mobile=$mobile_device;path=/";
            }
            # tell backend about device
            proxy_set_header X-Mobile $mobile_device;
        }
    }

Methods

Back to TOC

init

syntax: require("resty.mobile").init(path)

Parses json definitions file and populates shared dict.

Back to TOC

detect

syntax: require("resty.mobile").detect(cookiename)

Detects mobile device.
Returns 'false' if detection done via cookie or 'true' if detection done via rules
Returns 'false' (and logs error) on any error.
If parameter is ommited, library will parse headers every time.
If parameter is a string - cookie with this name will be checked, and, if exists, check will be skipped.

This method also requires (and sets) nginx variable $mobile_device, which will be set to string 'computer', 'phone' or 'tablet' depending on device.

Back to TOC

Installation

You need to compile ngx_lua with your Nginx.

You need to configure the lua_package_path directive to add the path of your lua-resty-mobile source tree to ngx_lua's Lua module search path, as in

# nginx.conf
http {
    lua_package_path "/path/to/lua-resty-mobile/lib/?.lua;;";
    ...
}

Back to TOC

Authors

Epifanov Ivan [email protected]

Back to TOC

Copyright and License

This module is licensed under the BSD license.

Copyright (C) 2015, by Epifanov Ivan [email protected]

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Back to TOC