NAME

Firefox::Marionette::Profile - Represents a prefs.js Firefox Profile

VERSION

Version 1.17

SYNOPSIS

    use Firefox::Marionette();
    use v5.10;

    my $profile = Firefox::Marionette::Profile->new();

    $profile->set_value('browser.startup.homepage', 'https://duckduckgo.com');

    my $firefox = Firefox::Marionette->new(profile => $profile);
        
    $firefox->quit();
        
    foreach my $profile_name (Firefox::Marionette::Profile->names()) {
        # start firefox using a specific existing profile
        $firefox = Firefox::Marionette->new(profile_name => $profile_name);
        $firefox->quit();

        # OR start a new browser with a copy of a specific existing profile

        $profile = Firefox::Marionette::Profile->existing($profile_name);
        $firefox = Firefox::Marionette->new(profile => $profile);
        $firefox->quit();
    }

DESCRIPTION

This module handles the implementation of a "prefs.js" Firefox Profile

SUBROUTINES/METHODS

ANY_PORT

returns the port number for Firefox to listen on any port (0).

names

returns a list of existing profile names that this module can discover on the filesystem.

download_directory

accepts a directory path that will contain downloaded files. Returns the previous value for download directory.

existing

accepts a profile name and returns a profile object for that specified profile name.

parse

accepts a path as the parameter. This path should be to a "prefs.js" file. Parses the file and returns it as a profile.

parse_by_handle

accepts a filehandle as the parameter to a "prefs.js" file. Parses the file and returns it as a profile.

path

accepts a profile name and returns the corresponding path to the "prefs.js" file.

profile_ini_directory

returns the base directory for profiles.

save

accepts a path as the parameter. Saves the current profile to this location.

as_string

returns the contents of current profile as a string.

get_value

accepts a key name (such as "browser.startup.homepage") and returns the value of the key from the profile.

set_value

accepts a key name (such as "browser.startup.homepage") and a value (such as "https://duckduckgo.com") and sets this value in the profile. It returns itself to aid in chaining methods

clear_value

accepts a key name (such as "browser.startup.homepage") and removes the key from the profile. It returns the old value of the key (if any).

DIAGNOSTICS

"Failed to execute getpwuid for %s:%s": The module was unable to to execute "getpwuid" in perlfunc. This is probably a bug in this module's logic. Please report as described in the BUGS AND LIMITATIONS section below.
"Failed to open '%s' for writing:%s": The module was unable to open the named file. Maybe your disk is full or the file permissions need to be changed?
"Failed to write to '%s':%s": The module was unable to write to the named file. Maybe your disk is full?
"Failed to close '%s':%s": The module was unable to close a handle to the named file. Something is seriously wrong with your environment.
"Failed to rename '%s' to '%s':%s": The module was unable to rename the named file to the second file. Something is seriously wrong with your environment.
"Failed to open '%s' for reading:%s": The module was unable to open the named file. Maybe your disk is full or the file permissions need to be changed?
"Failed to parse line '%s'": The module was unable to parse the line for a Firefox prefs.js configuration. This is probably a bug in this module's logic. Please report as described in the BUGS AND LIMITATIONS section below.

CONFIGURATION AND ENVIRONMENT

Firefox::Marionette::Profile requires no configuration files or environment variables.

DEPENDENCIES

Firefox::Marionette::Profile requires the following non-core Perl modules

•: Config::INI::Reader

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

To report a bug, or view the current list of bugs, please visit <https://github.com/david-dick/firefox-marionette/issues>

AUTHOR

David Dick "<ddick@cpan.org>"

LICENSE AND COPYRIGHT

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See "perlartistic" in perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.