NAME

App::OperaUtils - Utilities related to the Opera browser

VERSION

This document describes version 0.006 of App::OperaUtils (from Perl distribution App-OperaUtils), released on 2020-08-18.

SYNOPSIS

DESCRIPTION

This distribution includes several utilities related to the Opera browser:

FUNCTIONS

opera_has_processes

Usage:

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

Check whether Opera has processes.

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)

opera_is_paused

Usage:

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

Check whether Opera is paused.

Opera 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)

opera_is_running

Usage:

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

Check whether Opera is running.

Opera is defined as running if there are some Opera processes that are not in 'stop' state. In other words, if Opera has been started but is currently paused, we do not say that it's running. If you want to check if Opera process exists, you can use ps_opera.

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_opera

Usage:

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

Pause (kill -STOP) Opera.

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_opera

Usage:

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

List Opera 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_opera

Usage:

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

Restart opera.

This function is not exported.

This function supports dry-run operation.

Arguments ('*' denotes required arguments):

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

  • quiet => true

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_opera

Usage:

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

Start opera if not already started.

This function is not exported.

This function supports dry-run operation.

Arguments ('*' denotes required arguments):

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

  • quiet => true

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_opera

Usage:

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

Terminate (kill -KILL) Opera.

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_opera

Usage:

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

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

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-OperaUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-OperaUtils.

BUGS

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

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

Some other CLI utilities related to Opera: dump-opera-history (from App::DumpOperaHistory).

App::ChromeUtils

App::FirefoxUtils

App::VivaldiUtils

App::BrowserUtils

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.