NAME¶

Firefox::Marionette::Bookmark - Represents a Firefox bookmark retrieved using the Marionette protocol

VERSION¶

Version 1.57

SYNOPSIS¶

    use Firefox::Marionette();
    use Firefox::Marionette::Bookmark qw(:all);
    use Encode();
    use v5.10;
    my $firefox = Firefox::Marionette->new();
    $firefox->import_bookmarks("/path/to/bookmarks.html");
    foreach my $bookmark (reverse $firefox->bookmarks()) {
        say "Bookmark guid is          :" . $bookmark->guid();
        say "Bookmark parent guid is   :" . $bookmark->parent_guid();
        say "Bookmark date added is    :" . localtime($bookmark->date_added());
        say "Bookmark last modified is :" . localtime($bookmark->last_modified());
        say "Bookmark index is         :" . $bookmark->idx();
        if ($bookmark->type() == BOOKMARK()) {
            say "Bookmark url              :" . $bookmark->url();
            say "Bookmark title is         :" . Encode::encode('UTF-8', $bookmark->title(), 1) if ($bookmark->title());
            say "Bookmark icon is          :" . $bookmark->icon() if ($bookmark->icon());
            say "Bookmark icon url is      :" . $bookmark->icon_url() if ($bookmark->icon_url());
            say "Bookmark keyword is       :" . Encode::encode('UTF-8', $bookmark->keyword(), 1) if ($bookmark->keyword());
            say "Bookmark tags are         :" . Encode::encode('UTF-8', (join q[, ], $bookmark->tags())) if ($bookmark->tags());
        } elsif ($bookmark->type() == FOLDER()) {
            given ($bookmark->guid()) {
                when (MENU() . q[])    { say "This is the menu folder" }
                when (ROOT() . q[])    { say "This is the root folder" }
                when (TAGS() . q[])    { say "This is the tags folder" }
                when (TOOLBAR() . q[]) { say "This is the toolbar folder" }
                when (UNFILED() . q[]) { say "This is the unfiled folder" }
                when (MOBILE() . q[])  { say "This is the mobile folder" }
                default                { say "Folder title is           :" . $bookmark->title() }
            }
        } else {
            say "-" x 50;
        }
    }

DESCRIPTION¶

This module handles the implementation of a single Firefox bookmark using the Marionette protocol.

CONSTANTS¶

Constants are sourced from toolkit/components/places/Bookmarks.sys.mjs <https://hg.mozilla.org/mozilla-central/file/tip/toolkit/components/places/Bookmarks.sys.mjs>.

SUBROUTINES/METHODS¶

DIAGNOSTICS¶

None.

CONFIGURATION AND ENVIRONMENT¶

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

DEPENDENCIES¶

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

• URI::data
• URI::URL

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¶

Copyright (c) 2024, David Dick "<ddick@cpan.org>". All rights reserved.

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.