man SHARYANTO::HTTP::DetectUA::Simple (3): A very simple and generic browser detection library

VERSION

This document describes version 0.77 of SHARYANTO::HTTP::DetectUA::Simple (from Perl distribution SHARYANTO-Utils), released on 2015-09-04.

HOMEPAGE

Please visit the project's homepage at <https://metacpan.org/release/SHARYANTO-Utils>.

SOURCE

Source repository is at <https://github.com/perlancar/perl-SHARYANTO-Utils>.

BUGS

Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=SHARYANTO-Utils>

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <[email protected]>

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DESCRIPTION

I needed a simple and fast routine which can detect whether HTTP client is a GUI browser (like Chrome or Firefox), a text browser (like Lynx or Links), or neither (like curl, or LWP). Hence, this module.

FUNCTIONS

detect_http_ua_simple($env) -> [status, msg, result, meta]

Detect whether HTTP client is a GUI/TUI browser.

This function is a simple and fast routine to detect whether HTTP client is a GUI browser (like Chrome or Firefox), a text-based browser (like Lynx or Links), or neither (like curl or LWP). Extra information can be provided in the future.

Currently these heuristic rules are used:

check popular browser markers in User-Agent header (e.g. 'Chrome', 'Opera');
check Accept header for 'image/';

It is several times faster than the other equivalent Perl modules, this is because it does significantly less.

Arguments ('*' denotes required arguments):

env => any
CGI-compatible environment, e.g. \%ENV or PSGI's $env.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (hash)

'is_gui_browser' key will be set to true if HTTP client is a GUI browser.
'is_text_browser' key will be set to true if HTTP client is a text/TUI browser.
'is_browser' key will be set to true if either 'is_gui_browser' or 'is_text_browser' is set to true.