NAME
    App::BrowserUtils - Utilities related to browsers, particularly modern
    GUI ones

VERSION
    This document describes version 0.008 of App::BrowserUtils (from Perl
    distribution App-BrowserUtils), released on 2020-06-13.

SYNOPSIS
DESCRIPTION
    This distribution includes several utilities related to browsers:

    *   browsers-are-paused

    *   kill-browsers

    *   pause-browsers

    *   ps-browsers

    *   restart-browsers

    *   start-browsers

    *   terminate-browsers

    *   unpause-browsers

    Supported browsers: Firefox on Linux, Opera on Linux, Chrome on Linux,
    and Vivaldi on Linux.

FUNCTIONS
  browsers_are_paused
    Usage:

     browsers_are_paused(%args) -> [status, msg, payload, meta]

    Check whether browsers are paused.

    Browser is defined as paused if *all* of its processes are in 'stop'
    state.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   quiet => *true*

    *   users => *array[unix::local_uid]*

        Kill browser processes that belong to certain user(s) only.

    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 (payload) is optional, the actual result. Fourth element (meta)
    is called result metadata and is optional, a hash that contains extra
    information.

    Return value: (any)

  pause_browsers
    Usage:

     pause_browsers(%args) -> [status, msg, payload, meta]

    Pause (kill -STOP) browsers.

    A modern browser now runs complex web pages and applications. Despite
    browser's power management feature, these pages/tabs on the browser
    often still eat considerable CPU cycles even though they only run in the
    background. Stopping (kill -STOP) the browser processes is a simple and
    effective way to stop CPU eating on Unix. It can be performed whenever
    you are not using your browser for a little while, e.g. when you are
    typing on an editor or watching a movie. When you want to use your
    browser again, simply unpause it.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   users => *array[unix::local_uid]*

        Kill browser processes that belong to certain user(s) only.

    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 (payload) is optional, the actual result. Fourth element (meta)
    is called result metadata and is optional, a hash that contains extra
    information.

    Return value: (any)

  ps_browsers
    Usage:

     ps_browsers(%args) -> [status, msg, payload, meta]

    List browser processes.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   users => *array[unix::local_uid]*

        Kill browser processes that belong to certain user(s) only.

    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 (payload) is optional, the actual result. Fourth element (meta)
    is called result metadata and is optional, a hash that contains extra
    information.

    Return value: (any)

  restart_browsers
    Usage:

     restart_browsers(%args) -> [status, msg, payload, meta]

    Restart browsers.

    For each of the requested browser, first check whether browser processes
    (that run the current user) exist. If they do then terminate the browser
    first. After that, start the browser again.

    Example on the CLI:

     % restart-browsers --restart-firefox

    To customize command:

     % restart-browsers --start-firefox --firefox-cmd 'firefox -P myprofile'

    when starting each browser, console output will be captured and returned
    in function metadata. Will wait for 2/5/10 seconds and check if the
    browsers have been started. If all browsers can't be started, will
    return 500; otherwise will return 200 but report the browsers that
    failed to start to the STDERR.

    This function is not exported.

    This function supports dry-run operation.

    Arguments ('*' denotes required arguments):

    *   chrome_cmd => *array[str]|str* (default: "google-chrome")

    *   firefox_cmd => *array[str]|str* (default: "firefox")

    *   opera_cmd => *array[str]|str* (default: "opera")

    *   quiet => *true*

    *   restart_chrome => *bool*

    *   restart_firefox => *bool*

    *   restart_opera => *bool*

    *   restart_vivaldi => *bool*

    *   vivaldi_cmd => *array[str]|str* (default: "vivaldi")

    Special arguments:

    *   -dry_run => *bool*

        Pass -dry_run=>1 to enable simulation mode.

    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 (payload) is optional, the actual result. Fourth element (meta)
    is called result metadata and is optional, a hash that contains extra
    information.

    Return value: (any)

  start_browsers
    Usage:

     start_browsers(%args) -> [status, msg, payload, meta]

    Start browsers.

    For each of the requested browser, check whether browser processes (that
    run as the current user) exist and if not then start the browser. If
    browser processes exist, even if all are paused, then no new instance of
    the browser will be started.

    when starting each browser, console output will be captured and returned
    in function metadata. Will wait for 2/5/10 seconds and check if the
    browsers have been started. If all browsers can't be started, will
    return 500; otherwise will return 200 but report the browsers that
    failed to start to the STDERR.

    Example on the CLI:

     % start-browsers --start-firefox

    To customize command to use to start:

     % start-browsers --start-firefox --firefox-cmd 'firefox -P myprofile'

    This function is not exported.

    This function supports dry-run operation.

    Arguments ('*' denotes required arguments):

    *   chrome_cmd => *array[str]|str* (default: "google-chrome")

    *   firefox_cmd => *array[str]|str* (default: "firefox")

    *   opera_cmd => *array[str]|str* (default: "opera")

    *   quiet => *true*

    *   start_chrome => *bool*

    *   start_firefox => *bool*

    *   start_opera => *bool*

    *   start_vivaldi => *bool*

    *   vivaldi_cmd => *array[str]|str* (default: "vivaldi")

    Special arguments:

    *   -dry_run => *bool*

        Pass -dry_run=>1 to enable simulation mode.

    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 (payload) is optional, the actual result. Fourth element (meta)
    is called result metadata and is optional, a hash that contains extra
    information.

    Return value: (any)

  terminate_browsers
    Usage:

     terminate_browsers(%args) -> [status, msg, payload, meta]

    Terminate (kill -KILL) browsers.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   users => *array[unix::local_uid]*

        Kill browser processes that belong to certain user(s) only.

    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 (payload) is optional, the actual result. Fourth element (meta)
    is called result metadata and is optional, a hash that contains extra
    information.

    Return value: (any)

  unpause_browsers
    Usage:

     unpause_browsers(%args) -> [status, msg, payload, meta]

    Unpause (resume, continue, kill -CONT) browsers.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   users => *array[unix::local_uid]*

        Kill browser processes that belong to certain user(s) only.

    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 (payload) is optional, the actual result. Fourth element (meta)
    is called result metadata and is optional, a hash that contains extra
    information.

    Return value: (any)

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-BrowserUtils>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-App-BrowserUtils>.

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

    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.

SEE ALSO
    Utilities using this distribution: App::FirefoxUtils, App::ChromeUtils,
    App::OperaUtils, App::VivaldiUtils

    App::BrowserOpenUtils

AUTHOR
    perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2020, 2019 by perlancar@cpan.org.

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

