Firefox-Marionette
view release on metacpan or search on metacpan
Makefile.PL view on Meta::CPAN
my $output = `$possible -version`;
if ($output) {
warn
"Version of $possible in PATH environment variable:$output";
}
else {
warn "No $possible in PATH environment variable";
}
}
}
my $glob_path = '/usr/share/applications/firefox*.desktop';
foreach my $path ( glob $glob_path ) {
warn
`$EXECUTABLE_NAME -nle 'print "\$ARGV:\$_" if (/(Exec|^\\[)/);' $path`;
}
return;
}
my $binary; # = 'firefox';
my $suffix =
( ( $OSNAME eq 'MSWin32' ) || ( $OSNAME eq 'cygwin' ) ) ? '.exe' : q[];
<https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension>.
This directory will be packaged up as an unsigned xpi file.
and an optional true/false second parameter to indicate if the xpi file
should be a temporary extension
<https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/>
(just for the existence of this browser instance). Unsigned xpi files
may only be loaded temporarily
<https://wiki.mozilla.org/Add-ons/Extension_Signing> (except for
nightly firefox installations
<https://www.mozilla.org/en-US/firefox/channel/desktop/#nightly>). It
returns the GUID for the addon which may be used as a parameter to the
uninstall method.
use Firefox::Marionette();
my $firefox = Firefox::Marionette->new();
my $extension_id = $firefox->install('/full/path/to/gnu_terry_pratchett-0.4-an+fx.xpi');
# OR downloading and installing source code
* kiosk - start the browser in kiosk
<https://support.mozilla.org/en-US/kb/firefox-enterprise-kiosk-mode>
mode.
* mime_types - any MIME types that Firefox will encounter during this
session. MIME types that are not specified will result in a hung
browser (the File Download popup will appear).
* nightly - only allow a nightly release
<https://www.mozilla.org/en-US/firefox/channel/desktop/#nightly> to
be launched. This defaults to "0" (off).
* port - if the "host" parameter is also set, use ssh
<https://man.openbsd.org/ssh.1> to create and automate firefox via
the specified port. See REMOTE AUTOMATION OF FIREFOX VIA SSH and
NETWORK ARCHITECTURE.
* page_load - a shortcut to allow directly providing the page_load
timeout, instead of needing to use timeouts from the capabilities
parameter. Overrides all longer ways.
<https://man.openbsd.org/ssh.1> to create and automate firefox with
the specified user. See REMOTE AUTOMATION OF FIREFOX VIA SSH and
NETWORK ARCHITECTURE. The user will default to the current user name.
Authentication should be via public keys loaded into the local
ssh-agent <https://man.openbsd.org/ssh-agent>.
* via - specifies a proxy jump box
<https://man.openbsd.org/ssh_config#ProxyJump> to be used to connect
to a remote host. See the host parameter.
* visible - should firefox be visible on the desktop. This defaults
to "0". When moving from a X11 platform to another X11 platform, you
can set visible to 'local' to enable X11 forwarding
<https://man.openbsd.org/ssh#X>. See X11 FORWARDING WITH FIREFOX.
* waterfox - only allow a binary that looks like a waterfox version
<https://www.waterfox.net/> to be launched.
* webauthn - a boolean parameter to determine whether or not to add a
webauthn authenticator after the connection is established. The
default is to add a webauthn authenticator for Firefox after version
new_session
creates a new WebDriver session. It is expected that the caller
performs the necessary checks on the requested capabilities to be
WebDriver conforming. The WebDriver service offered by Marionette does
not match or negotiate capabilities beyond type and bounds checks.
nightly
returns true if the current version of firefox is a nightly release
<https://www.mozilla.org/en-US/firefox/channel/desktop/#nightly> (does
the minor version number end with an 'a1'?)
paper_sizes
returns a list of all the recognised names for paper sizes, such as A4
or LEGAL.
pause
accepts a parameter in milliseconds and returns a corresponding action
win32_product_names
returns a hash of known Windows product names (such as 'Mozilla
Firefox') with priority orders. The lower the priority will determine
the order that this module will check for the existence of this
product. Only of interest when sub-classing.
window_handle
returns the current window's handle. On desktop this typically
corresponds to the currently selected tab. returns an opaque
server-assigned identifier to this window that uniquely identifies it
within this Marionette instance. This can be used to switch to this
window at a later point. This is the same as the window
<https://developer.mozilla.org/en-US/docs/Web/API/Window> object in
Javascript.
use Firefox::Marionette();
my $firefox = Firefox::Marionette->new();
my $original_window = $firefox->window_handle();
my $javascript_window = $firefox->script('return window'); # only works for Firefox 121 and later
if ($javascript_window ne $original_window) {
die "That was unexpected!!! What happened?";
}
window_handles
returns a list of top-level browsing contexts. On desktop this
typically corresponds to the set of open tabs for browser windows, or
the window itself for non-browser chrome windows. Each window handle is
assigned by the server and is guaranteed unique, however the return
array does not have a specified ordering.
use Firefox::Marionette();
use 5.010;
my $firefox = Firefox::Marionette->new();
my $original_window = $firefox->window_handle();
1. The addons parameter to the new method must be set. This will
disable -safe-mode
<http://kb.mozillazine.org/Command_line_arguments#List_of_command_line_arguments_.28incomplete.29>
2. The visible parameter to the new method must be set. This is due to
an existing bug in Firefox
<https://bugzilla.mozilla.org/show_bug.cgi?id=1375585>.
3. It can be tricky getting WebGL <https://en.wikipedia.org/wiki/WebGL>
to work with a Xvfb <https://en.wikipedia.org/wiki/Xvfb> instance.
glxinfo <https://dri.freedesktop.org/wiki/glxinfo/> can be useful to
help debug issues in this case. The mesa-dri-drivers rpm is also
required for Redhat systems.
With all those conditions being met, WebGL
<https://en.wikipedia.org/wiki/WebGL> can be enabled like so;
use Firefox::Marionette();
my $firefox = Firefox::Marionette->new( addons => 1, visible => 1 );
if ($firefox->script(q[let c = document.createElement('canvas'); return c.getContext('webgl2') ? true : c.getContext('experimental-webgl') ? true : false;])) {
At the very least, under these circumstances, it would be a good idea
to be aware that there's an ongoing arms race
<https://en.wikipedia.org/wiki/Web_scraping#Methods_to_prevent_web_scraping>,
and potential legal issues
<https://en.wikipedia.org/wiki/Web_scraping#Legal_issues> in this area.
X11 FORWARDING WITH FIREFOX
X11 Forwarding <https://man.openbsd.org/ssh#X> allows you to launch a
remote firefox via ssh and have it visually appear in your local X11
desktop. This can be accomplished with the following code;
use Firefox::Marionette();
my $firefox = Firefox::Marionette->new(
host => 'remote-x11.example.org',
visible => 'local',
debug => 1,
);
$firefox->go('https://metacpan.org');
Feedback is welcome on any odd X11 workarounds that might be required
for different platforms.
UBUNTU AND FIREFOX DELIVERED VIA SNAP
Ubuntu 22.04 LTS
<https://ubuntu.com/blog/ubuntu-22-04-lts-whats-new-linux-desktop> is
packaging firefox as a snap <https://ubuntu.com/blog/whats-in-a-snap>.
This breaks the way that this module expects to be able to run,
specifically, being able to setup a firefox profile in a systems
temporary directory (/tmp or $TMPDIR in most Unix based systems) and
allow the operating system to cleanup old directories caused by
exceptions / network failures / etc.
Because of this design decision, attempting to run a snap version of
firefox will simply result in firefox hanging, unable to read it's
custom profile directory and hence unable to read the marionette port
If no elements are found, this method will return undef.
## install
accepts the following as the first parameter;
- path to an [xpi file](https://developer.mozilla.org/en-US/docs/Mozilla/XPI).
- path to a directory containing [firefox extension source code](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension). This directory will be packaged up as an unsigned xpi file.
- path to a top level file (such as [manifest.json](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Anatomy_of_a_WebExtension#manifest.json)) in a directory containing [firefox extension source code](https://developer.mozilla.o...
and an optional true/false second parameter to indicate if the xpi file should be a [temporary extension](https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/) (just for the existence of this browser instance). Unsi...
use Firefox::Marionette();
my $firefox = Firefox::Marionette->new();
my $extension_id = $firefox->install('/full/path/to/gnu_terry_pratchett-0.4-an+fx.xpi');
# OR downloading and installing source code
system { 'git' } 'git', 'clone', 'https://github.com/kkapsner/CanvasBlocker.git';
- developer - only allow a [developer edition](https://www.mozilla.org/en-US/firefox/developer/) to be launched. This defaults to "0" (off).
- devtools - begin the session with the [devtools](https://developer.mozilla.org/en-US/docs/Tools) window opened in a separate window.
- geo - setup the browser [preferences](http://kb.mozillazine.org/About:config) to allow the [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API) to work. If the value for this key is a [URI](https://metacpan.org/pod/U...
- height - set the [height](http://kb.mozillazine.org/Command_line_arguments#List_of_command_line_arguments_.28incomplete.29) of the initial firefox window
- har - begin the session with the [devtools](https://developer.mozilla.org/en-US/docs/Tools) window opened in a separate window. The [HAR Export Trigger](https://addons.mozilla.org/en-US/firefox/addon/har-export-trigger/) addon will be loaded into ...
- host - use [ssh](https://man.openbsd.org/ssh.1) to create and automate firefox on the specified host. See [REMOTE AUTOMATION OF FIREFOX VIA SSH](#remote-automation-of-firefox-via-ssh) and [NETWORK ARCHITECTURE](#network-architecture). The user wi...
- implicit - a shortcut to allow directly providing the [implicit](https://metacpan.org/pod/Firefox::Marionette::Timeout#implicit) timeout, instead of needing to use timeouts from the capabilities parameter. Overrides all longer ways.
- index - a parameter to allow the user to specify a specific firefox instance to survive and reconnect to. It does not do anything else at the moment. See the survive parameter.
- kiosk - start the browser in [kiosk](https://support.mozilla.org/en-US/kb/firefox-enterprise-kiosk-mode) mode.
- mime\_types - any MIME types that Firefox will encounter during this session. MIME types that are not specified will result in a hung browser (the File Download popup will appear).
- nightly - only allow a [nightly release](https://www.mozilla.org/en-US/firefox/channel/desktop/#nightly) to be launched. This defaults to "0" (off).
- port - if the "host" parameter is also set, use [ssh](https://man.openbsd.org/ssh.1) to create and automate firefox via the specified port. See [REMOTE AUTOMATION OF FIREFOX VIA SSH](#remote-automation-of-firefox-via-ssh) and [NETWORK ARCHITECTURE...
- page\_load - a shortcut to allow directly providing the [page\_load](https://metacpan.org/pod/Firefox::Marionette::Timeouts#page_load) timeout, instead of needing to use timeouts from the capabilities parameter. Overrides all longer ways.
- profile - create a new profile based on the supplied [profile](https://metacpan.org/pod/Firefox::Marionette::Profile). NOTE: firefox ignores any changes made to the profile on the disk while it is running, instead, use the [set\_pref](#set_pref) a...
- profile\_name - pick a specific existing profile to automate, rather than creating a new profile. [Firefox](https://firefox.com) refuses to allow more than one instance of a profile to run at the same time. Profile names can be obtained by using ...
- the preference `security.webauth.webauthn_enable_softtoken` must be set to `true` in the profile OR
- the `webauth` parameter to this method must be set to `0`
NOTE: firefox ignores any changes made to the profile on the disk while it is running, instead, use the [set\_pref](#set_pref) and [clear\_pref](#clear_pref) methods to make changes while firefox is running.
- seer - this option is switched off "0" by default. When it is switched on "1", it will activate the various speculative and pre-fetch options for firefox. NOTE: that this option only works when profile\_name/profile is not specified.
- sleep\_time\_in\_ms - the amount of time (in milliseconds) that this module should sleep when unsuccessfully calling the subroutine provided to the [await](#await) or [bye](#bye) methods. This defaults to "1" millisecond.
- stealth - stops [navigator.webdriver](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/webdriver) from being accessible by the current web page. This is achieved by loading an [extension](https://developer.mozilla.org/en-US/docs/Mozilla/...
- survive - if this is set to a true value, firefox will not automatically exit when the object goes out of scope. See the reconnect parameter for an experimental technique for reconnecting.
- system\_access - firefox [after version 138](https://bugzilla.mozilla.org/show_bug.cgi?id=1944565) allows disabling system access for javascript. By default, this module will turn on system access.
- trust - give a path to a [root certificate](https://en.wikipedia.org/wiki/Root_certificate) encoded as a [PEM encoded X.509 certificate](https://datatracker.ietf.org/doc/html/rfc7468#section-5) that will be trusted for this session.
- timeouts - a shortcut to allow directly providing a [timeout](https://metacpan.org/pod/Firefox::Marionette::Timeout) object, instead of needing to use timeouts from the capabilities parameter. Overrides the timeouts provided (if any) in the capabi...
- trackable - if this is set, profile preferences will be [set](#set_pref) to make it harder to be tracked by the [browsers fingerprint](https://en.wikipedia.org/wiki/Device_fingerprint#Browser_fingerprint) across browser restarts. This is on by def...
- user - if the "host" parameter is also set, use [ssh](https://man.openbsd.org/ssh.1) to create and automate firefox with the specified user. See [REMOTE AUTOMATION OF FIREFOX VIA SSH](#remote-automation-of-firefox-via-ssh) and [NETWORK ARCHITECTUR...
- via - specifies a [proxy jump box](https://man.openbsd.org/ssh_config#ProxyJump) to be used to connect to a remote host. See the host parameter.
- visible - should firefox be visible on the desktop. This defaults to "0". When moving from a X11 platform to another X11 platform, you can set visible to 'local' to enable [X11 forwarding](https://man.openbsd.org/ssh#X). See [X11 FORWARDING WITH...
- waterfox - only allow a binary that looks like a [waterfox version](https://www.waterfox.net/) to be launched.
- webauthn - a boolean parameter to determine whether or not to [add a webauthn authenticator](#add_webauthn_authenticator) after the connection is established. The default is to add a webauthn authenticator for Firefox after version 118.
- width - set the [width](http://kb.mozillazine.org/Command_line_arguments#List_of_command_line_arguments_.28incomplete.29) of the initial firefox window
This method returns a new `Firefox::Marionette` object, connected to an instance of [firefox](https://firefox.com). In a non MacOS/Win32/Cygwin environment, if necessary (no DISPLAY variable can be found and the visible parameter to the new method h...
use Firefox::Marionette();
my $remote_darwin_firefox = Firefox::Marionette->new(
debug => 'timestamp,nsHttp:1',
my $window_handle = $firefox->new_window(type => 'tab');
$firefox->switch_to_window($window_handle);
## new\_session
creates a new WebDriver session. It is expected that the caller performs the necessary checks on the requested capabilities to be WebDriver conforming. The WebDriver service offered by Marionette does not match or negotiate capabilities beyond type...
## nightly
returns true if the [current version](#browser_version) of firefox is a [nightly release](https://www.mozilla.org/en-US/firefox/channel/desktop/#nightly) (does the minor version number end with an 'a1'?)
## paper\_sizes
returns a list of all the recognised names for paper sizes, such as A4 or LEGAL.
## pause
accepts a parameter in milliseconds and returns a corresponding action for the [perform](#perform) method that will cause a pause in the chain of actions given to the [perform](#perform) method.
## pdf
## win32\_organisation
accepts a parameter of a Win32 product name and returns the matching organisation. Only of interest when sub-classing.
## win32\_product\_names
returns a hash of known Windows product names (such as 'Mozilla Firefox') with priority orders. The lower the priority will determine the order that this module will check for the existence of this product. Only of interest when sub-classing.
## window\_handle
returns the [current window's handle](https://metacpan.org/pod/Firefox::Marionette::WebWindow). On desktop this typically corresponds to the currently selected tab. returns an opaque server-assigned identifier to this window that uniquely identifies...
use Firefox::Marionette();
my $firefox = Firefox::Marionette->new();
my $original_window = $firefox->window_handle();
my $javascript_window = $firefox->script('return window'); # only works for Firefox 121 and later
if ($javascript_window ne $original_window) {
die "That was unexpected!!! What happened?";
}
## window\_handles
returns a list of top-level [browsing contexts](https://metacpan.org/pod/Firefox::Marionette::WebWindow). On desktop this typically corresponds to the set of open tabs for browser windows, or the window itself for non-browser chrome windows. Each wi...
use Firefox::Marionette();
use 5.010;
my $firefox = Firefox::Marionette->new();
my $original_window = $firefox->window_handle();
$firefox->new_window( type => 'tab' );
$firefox->new_window( type => 'window' );
say "There are " . $firefox->window_handles() . " tabs open in total";
say "Across " . $firefox->chrome()->window_handles()->content() . " chrome windows";
This module uses [ControlMaster](https://man.openbsd.org/ssh_config#ControlMaster) functionality when using [ssh](https://man.openbsd.org/ssh), for a useful speedup of executing remote commands. Unfortunately, when using ssh to move from a [cygwin](...
The [NETWORK ARCHITECTURE](#network-architecture) section has an example of a more complicated network design.
# WEBGL
There are a number of steps to getting [WebGL](https://en.wikipedia.org/wiki/WebGL) to work correctly;
- 1. The `addons` parameter to the [new](#new) method must be set. This will disable [-safe-mode](http://kb.mozillazine.org/Command_line_arguments#List_of_command_line_arguments_.28incomplete.29)
- 2. The visible parameter to the [new](#new) method must be set. This is due to [an existing bug in Firefox](https://bugzilla.mozilla.org/show_bug.cgi?id=1375585).
- 3. It can be tricky getting [WebGL](https://en.wikipedia.org/wiki/WebGL) to work with a [Xvfb](https://en.wikipedia.org/wiki/Xvfb) instance. [glxinfo](https://dri.freedesktop.org/wiki/glxinfo/) can be useful to help debug issues in this case. The...
With all those conditions being met, [WebGL](https://en.wikipedia.org/wiki/WebGL) can be enabled like so;
use Firefox::Marionette();
my $firefox = Firefox::Marionette->new( addons => 1, visible => 1 );
if ($firefox->script(q[let c = document.createElement('canvas'); return c.getContext('webgl2') ? true : c.getContext('experimental-webgl') ? true : false;])) {
$firefox->go("https://get.webgl.org/");
} else {
die "WebGL is not supported";
# WEBSITES THAT BLOCK AUTOMATION
Marionette [by design](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/webdriver) allows web sites to detect that the browser is being automated. Firefox [no longer (since version 88)](https://bugzilla.mozilla.org/show_bug.cgi?id=1632821)...
If the web site you are trying to automate mysteriously fails when you are automating a workflow, but it works when you perform the workflow manually, you may be dealing with a web site that is hostile to automation. I would be very interested if yo...
At the very least, under these circumstances, it would be a good idea to be aware that there's an [ongoing arms race](https://en.wikipedia.org/wiki/Web_scraping#Methods_to_prevent_web_scraping), and potential [legal issues](https://en.wikipedia.org/w...
# X11 FORWARDING WITH FIREFOX
[X11 Forwarding](https://man.openbsd.org/ssh#X) allows you to launch a [remote firefox via ssh](#remote-automation-of-firefox-via-ssh) and have it visually appear in your local X11 desktop. This can be accomplished with the following code;
use Firefox::Marionette();
my $firefox = Firefox::Marionette->new(
host => 'remote-x11.example.org',
visible => 'local',
debug => 1,
);
$firefox->go('https://metacpan.org');
Feedback is welcome on any odd X11 workarounds that might be required for different platforms.
# UBUNTU AND FIREFOX DELIVERED VIA SNAP
[Ubuntu 22.04 LTS](https://ubuntu.com/blog/ubuntu-22-04-lts-whats-new-linux-desktop) is packaging firefox as a [snap](https://ubuntu.com/blog/whats-in-a-snap). This breaks the way that this module expects to be able to run, specifically, being able ...
Because of this design decision, attempting to run a snap version of firefox will simply result in firefox hanging, unable to read it's custom profile directory and hence unable to read the marionette port configuration entry.
Which would be workable except that; there does not appear to be \_any\_ way to detect that a snap firefox will run (/usr/bin/firefox is a bash shell which eventually runs the snap firefox), so there is no way to know (heuristics aside) if a normal f...
It seems the only way to fix this issue (as documented in more than a few websites) is;
- 1. sudo snap remove firefox
- 2. sudo add-apt-repository -y ppa:mozillateam/ppa
- 3. sudo apt update
lib/Firefox/Marionette.pm view on Meta::CPAN
=over 4
=item * path to an L<xpi file|https://developer.mozilla.org/en-US/docs/Mozilla/XPI>.
=item * path to a directory containing L<firefox extension source code|https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension>. This directory will be packaged up as an unsigned xpi file.
=item * path to a top level file (such as L<manifest.json|https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Anatomy_of_a_WebExtension#manifest.json>) in a directory containing L<firefox extension source code|https://developer.moz...
=back
and an optional true/false second parameter to indicate if the xpi file should be a L<temporary extension|https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/> (just for the existence of this browser instance). Unsi...
use Firefox::Marionette();
my $firefox = Firefox::Marionette->new();
my $extension_id = $firefox->install('/full/path/to/gnu_terry_pratchett-0.4-an+fx.xpi');
# OR downloading and installing source code
system { 'git' } 'git', 'clone', 'https://github.com/kkapsner/CanvasBlocker.git';
lib/Firefox/Marionette.pm view on Meta::CPAN
=item * host - use L<ssh|https://man.openbsd.org/ssh.1> to create and automate firefox on the specified host. See L<REMOTE AUTOMATION OF FIREFOX VIA SSH|/REMOTE-AUTOMATION-OF-FIREFOX-VIA-SSH> and L<NETWORK ARCHITECTURE|/NETWORK-ARCHITECTURE>. The u...
=item * implicit - a shortcut to allow directly providing the L<implicit|Firefox::Marionette::Timeout#implicit> timeout, instead of needing to use timeouts from the capabilities parameter. Overrides all longer ways.
=item * index - a parameter to allow the user to specify a specific firefox instance to survive and reconnect to. It does not do anything else at the moment. See the survive parameter.
=item * kiosk - start the browser in L<kiosk|https://support.mozilla.org/en-US/kb/firefox-enterprise-kiosk-mode> mode.
=item * mime_types - any MIME types that Firefox will encounter during this session. MIME types that are not specified will result in a hung browser (the File Download popup will appear).
=item * nightly - only allow a L<nightly release|https://www.mozilla.org/en-US/firefox/channel/desktop/#nightly> to be launched. This defaults to "0" (off).
=item * port - if the "host" parameter is also set, use L<ssh|https://man.openbsd.org/ssh.1> to create and automate firefox via the specified port. See L<REMOTE AUTOMATION OF FIREFOX VIA SSH|/REMOTE-AUTOMATION-OF-FIREFOX-VIA-SSH> and L<NETWORK ARCHI...
=item * page_load - a shortcut to allow directly providing the L<page_load|Firefox::Marionette::Timeouts#page_load> timeout, instead of needing to use timeouts from the capabilities parameter. Overrides all longer ways.
=item * profile - create a new profile based on the supplied L<profile|Firefox::Marionette::Profile>. NOTE: firefox ignores any changes made to the profile on the disk while it is running, instead, use the L<set_pref|/set_pref> and L<clear_pref|/cle...
=item * profile_name - pick a specific existing profile to automate, rather than creating a new profile. L<Firefox|https://firefox.com> refuses to allow more than one instance of a profile to run at the same time. Profile names can be obtained by u...
=over 8
lib/Firefox/Marionette.pm view on Meta::CPAN
=item * trust - give a path to a L<root certificate|https://en.wikipedia.org/wiki/Root_certificate> encoded as a L<PEM encoded X.509 certificate|https://datatracker.ietf.org/doc/html/rfc7468#section-5> that will be trusted for this session.
=item * timeouts - a shortcut to allow directly providing a L<timeout|Firefox::Marionette::Timeout> object, instead of needing to use timeouts from the capabilities parameter. Overrides the timeouts provided (if any) in the capabilities parameter.
=item * trackable - if this is set, profile preferences will be L<set|/set_pref> to make it harder to be tracked by the L<browsers fingerprint|https://en.wikipedia.org/wiki/Device_fingerprint#Browser_fingerprint> across browser restarts. This is on ...
=item * user - if the "host" parameter is also set, use L<ssh|https://man.openbsd.org/ssh.1> to create and automate firefox with the specified user. See L<REMOTE AUTOMATION OF FIREFOX VIA SSH|/REMOTE-AUTOMATION-OF-FIREFOX-VIA-SSH> and L<NETWORK ARCH...
=item * via - specifies a L<proxy jump box|https://man.openbsd.org/ssh_config#ProxyJump> to be used to connect to a remote host. See the host parameter.
=item * visible - should firefox be visible on the desktop. This defaults to "0". When moving from a X11 platform to another X11 platform, you can set visible to 'local' to enable L<X11 forwarding|https://man.openbsd.org/ssh#X>. See L<X11 FORWARDI...
=item * waterfox - only allow a binary that looks like a L<waterfox version|https://www.waterfox.net/> to be launched.
=item * webauthn - a boolean parameter to determine whether or not to L<add a webauthn authenticator|/add_webauthn_authenticator> after the connection is established. The default is to add a webauthn authenticator for Firefox after version 118.
=item * width - set the L<width|http://kb.mozillazine.org/Command_line_arguments#List_of_command_line_arguments_.28incomplete.29> of the initial firefox window
=back
This method returns a new C<Firefox::Marionette> object, connected to an instance of L<firefox|https://firefox.com>. In a non MacOS/Win32/Cygwin environment, if necessary (no DISPLAY variable can be found and the visible parameter to the new method ...
lib/Firefox/Marionette.pm view on Meta::CPAN
my $window_handle = $firefox->new_window(type => 'tab');
$firefox->switch_to_window($window_handle);
=head2 new_session
creates a new WebDriver session. It is expected that the caller performs the necessary checks on the requested capabilities to be WebDriver conforming. The WebDriver service offered by Marionette does not match or negotiate capabilities beyond type...
=head2 nightly
returns true if the L<current version|/browser_version> of firefox is a L<nightly release|https://www.mozilla.org/en-US/firefox/channel/desktop/#nightly> (does the minor version number end with an 'a1'?)
=head2 paper_sizes
returns a list of all the recognised names for paper sizes, such as A4 or LEGAL.
=head2 pause
accepts a parameter in milliseconds and returns a corresponding action for the L<perform|/perform> method that will cause a pause in the chain of actions given to the L<perform|/perform> method.
=head2 pdf
lib/Firefox/Marionette.pm view on Meta::CPAN
=head2 win32_organisation
accepts a parameter of a Win32 product name and returns the matching organisation. Only of interest when sub-classing.
=head2 win32_product_names
returns a hash of known Windows product names (such as 'Mozilla Firefox') with priority orders. The lower the priority will determine the order that this module will check for the existence of this product. Only of interest when sub-classing.
=head2 window_handle
returns the L<current window's handle|Firefox::Marionette::WebWindow>. On desktop this typically corresponds to the currently selected tab. returns an opaque server-assigned identifier to this window that uniquely identifies it within this Marionett...
use Firefox::Marionette();
my $firefox = Firefox::Marionette->new();
my $original_window = $firefox->window_handle();
my $javascript_window = $firefox->script('return window'); # only works for Firefox 121 and later
if ($javascript_window ne $original_window) {
die "That was unexpected!!! What happened?";
}
=head2 window_handles
returns a list of top-level L<browsing contexts|Firefox::Marionette::WebWindow>. On desktop this typically corresponds to the set of open tabs for browser windows, or the window itself for non-browser chrome windows. Each window handle is assigned b...
use Firefox::Marionette();
use 5.010;
my $firefox = Firefox::Marionette->new();
my $original_window = $firefox->window_handle();
$firefox->new_window( type => 'tab' );
$firefox->new_window( type => 'window' );
say "There are " . $firefox->window_handles() . " tabs open in total";
say "Across " . $firefox->chrome()->window_handles()->content() . " chrome windows";
lib/Firefox/Marionette.pm view on Meta::CPAN
=head1 WEBGL
There are a number of steps to getting L<WebGL|https://en.wikipedia.org/wiki/WebGL> to work correctly;
=over
=item 1. The C<addons> parameter to the L<new|/new> method must be set. This will disable L<-safe-mode|http://kb.mozillazine.org/Command_line_arguments#List_of_command_line_arguments_.28incomplete.29>
=item 2. The visible parameter to the L<new|/new> method must be set. This is due to L<an existing bug in Firefox|https://bugzilla.mozilla.org/show_bug.cgi?id=1375585>.
=item 3. It can be tricky getting L<WebGL|https://en.wikipedia.org/wiki/WebGL> to work with a L<Xvfb|https://en.wikipedia.org/wiki/Xvfb> instance. L<glxinfo|https://dri.freedesktop.org/wiki/glxinfo/> can be useful to help debug issues in this case. ...
=back
With all those conditions being met, L<WebGL|https://en.wikipedia.org/wiki/WebGL> can be enabled like so;
use Firefox::Marionette();
my $firefox = Firefox::Marionette->new( addons => 1, visible => 1 );
if ($firefox->script(q[let c = document.createElement('canvas'); return c.getContext('webgl2') ? true : c.getContext('experimental-webgl') ? true : false;])) {
$firefox->go("https://get.webgl.org/");
lib/Firefox/Marionette.pm view on Meta::CPAN
=head1 WEBSITES THAT BLOCK AUTOMATION
Marionette L<by design|https://developer.mozilla.org/en-US/docs/Web/API/Navigator/webdriver> allows web sites to detect that the browser is being automated. Firefox L<no longer (since version 88)|https://bugzilla.mozilla.org/show_bug.cgi?id=1632821>...
If the web site you are trying to automate mysteriously fails when you are automating a workflow, but it works when you perform the workflow manually, you may be dealing with a web site that is hostile to automation. I would be very interested if yo...
At the very least, under these circumstances, it would be a good idea to be aware that there's an L<ongoing arms race|https://en.wikipedia.org/wiki/Web_scraping#Methods_to_prevent_web_scraping>, and potential L<legal issues|https://en.wikipedia.org/w...
=head1 X11 FORWARDING WITH FIREFOX
L<X11 Forwarding|https://man.openbsd.org/ssh#X> allows you to launch a L<remote firefox via ssh|/REMOTE-AUTOMATION-OF-FIREFOX-VIA-SSH> and have it visually appear in your local X11 desktop. This can be accomplished with the following code;
use Firefox::Marionette();
my $firefox = Firefox::Marionette->new(
host => 'remote-x11.example.org',
visible => 'local',
debug => 1,
);
$firefox->go('https://metacpan.org');
Feedback is welcome on any odd X11 workarounds that might be required for different platforms.
=head1 UBUNTU AND FIREFOX DELIVERED VIA SNAP
L<Ubuntu 22.04 LTS|https://ubuntu.com/blog/ubuntu-22-04-lts-whats-new-linux-desktop> is packaging firefox as a L<snap|https://ubuntu.com/blog/whats-in-a-snap>. This breaks the way that this module expects to be able to run, specifically, being able ...
Because of this design decision, attempting to run a snap version of firefox will simply result in firefox hanging, unable to read it's custom profile directory and hence unable to read the marionette port configuration entry.
Which would be workable except that; there does not appear to be _any_ way to detect that a snap firefox will run (/usr/bin/firefox is a bash shell which eventually runs the snap firefox), so there is no way to know (heuristics aside) if a normal fir...
It seems the only way to fix this issue (as documented in more than a few websites) is;
=over
=item 1. sudo snap remove firefox
( run in 0.674 second using v1.01-cache-2.11-cpan-299005ec8e3 )