/home/foss/Downloads/coverart-browser/coverart_browser_source.py

# -*- Mode: python; coding: utf-8; tab-width: 4; indent-tabs-mode: nil; -*-
#
# Copyright (C) 2012 - fossfreedom
# Copyright (C) 2012 - Agustin Carrasco
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of thie GNU General Public License as published by
# the Free Software Foundation; either version 2, or (at your option)
# any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA.

import random
from collections import OrderedDict
import unicodedata
import re

from gi.repository import GObject
from gi.repository import GLib
from gi.repository import Gio
from gi.repository import Gdk
from gi.repository import Gtk
from gi.repository import RB

import rb
from coverart_album import AlbumManager
from coverart_browser_prefs import GSetting
from coverart_browser_prefs import CoverLocale
from coverart_browser_prefs import Preferences
from coverart_widgets import PanedCollapsible
from coverart_controllers import AlbumQuickSearchController
from coverart_controllers import ViewController
from coverart_export import CoverArtExport
from coverart_rb3compat import Menu
from coverart_rb3compat import ActionGroup
from coverart_covericonview import CoverIconView
from coverart_coverflowview import CoverFlowView
from coverart_artistview import ArtistView
from coverart_listview import ListView
from coverart_queueview import QueueView
from coverart_playsourceview import PlaySourceView
from coverart_toolbar import ToolbarManager
from coverart_artistinfo import ArtistInfoPane
from coverart_external_plugins import CreateExternalPluginMenu
from coverart_playlists import EchoNestPlaylist
from coverart_entryview import EntryViewPane
from coverart_play_source import CoverArtPlaySource
import coverart_rb3compat as rb3compat


class CoverArtBrowserSource(RB.Source):
    '''
    Source utilized by the plugin to show all it's ui.
    '''
    rating_threshold = GObject.property(type=float, default=0)
    artist_paned_pos = GObject.property(type=str)
    min_paned_pos = 80

    # unique instance of the source
    instance = None

    def __init__(self, **kargs):
        '''
        Initializes the source.
        '''
        super(CoverArtBrowserSource, self).__init__(**kargs)

        # create source_source_settings and connect the source's properties
        self.gs = GSetting()

        self._connect_properties()

        self.hasActivated = False
        self.last_width = 0
        self.last_selected_album = None
        self.click_count = 0
        self.favourites = False
        self.follow_song = False
        self.task_progress = None
        self._from_paned_handle = False

    def _connect_properties(self):
        '''
        Connects the source properties to the saved preferences.
        '''
        print("CoverArtBrowser DEBUG - _connect_properties")
        setting = self.gs.get_setting(self.gs.Path.PLUGIN)

        setting.bind(
            self.gs.PluginKey.RATING,
            self,
            'rating_threshold',
            Gio.SettingsBindFlags.GET)

        print("CoverArtBrowser DEBUG - end _connect_properties")

    def do_get_status(self, *args):
        '''
        Method called by Rhythmbox to figure out what to show on this source
        statusbar.
        If the custom statusbar is disabled, the source will
        show the selected album info.
        Also, it makes sure to show the progress on the album loading
        '''

        if not self.task_progress:

            self.task_progress = RB.TaskProgressSimple.new()

        try:
            progress = self.album_manager.progress
            progress_text = _('Loading...') if progress < 1 else ''

            if progress < 1:
                if self.props.shell.props.task_list.get_model().n_items() == 0:
                    self.props.shell.props.task_list.add_task(self.task_progress)

                self.task_progress.props.task_progress = progress
                self.task_progress.props.task_label = progress_text
            else:
                self.task_progress.props.task_outcome = RB.TaskOutcome.COMPLETE

        except:
            progress = 1
            progress_text = ''

            self.task_progress.props.task_outcome = RB.TaskOutcome.COMPLETE

        return (self.status, progress_text, progress)

    def do_selected(self):
        '''
        Called by Rhythmbox when the source is selected. It makes sure to
        create the ui the first time the source is showed.
        '''
        print("CoverArtBrowser DEBUG - do_selected")

        # first time of activation -> add graphical stuff
        if not self.hasActivated:
            self.do_impl_activate()

            # indicate that the source was activated before
            self.hasActivated = True

        print("CoverArtBrowser DEBUG - end do_selected")

    def do_impl_activate(self):
        '''
        Called by do_selected the first time the source is activated.
        It creates all the source ui and connects the necessary signals for it
        correct behavior.
        '''
        print("CoverArtBrowser DEBUG - do_impl_activate")

        # initialise some variables
        self.plugin = self.props.plugin
        self.shell = self.props.shell
        self.status = ''
        self.search_text = ''
        self.actiongroup = ActionGroup(self.shell, 'coverplaylist_submenu')
        self._browser_preferences = None
        self._search_preferences = None

        # indicate that the source was activated before
        self.hasActivated = True

        # define a query model that we'll use for playing
        self.source_query_model = RB.RhythmDBQueryModel.new_empty(self.shell.props.db)

        # define the associated playsource so we can interact with this query model
        self.playlist_source = GObject.new(
                CoverArtPlaySource,
                name=_("CoverArt Playlist"),
                shell=self.shell,
                plugin=self.plugin,
                entry_type=self.plugin.entry_type)
        self.playlist_source.initialise(self.plugin, self.shell, self)
        self.shell.append_display_page(self.playlist_source, self.plugin.source)

        self._create_ui()
        self._setup_source()
        self._apply_settings()

        print("CoverArtBrowser DEBUG - end do_impl_activate")

    def _create_ui(self):
        '''
        Creates the ui for the source and saves the important widgets onto
        properties.
        '''
        print("CoverArtBrowser DEBUG - _create_ui")

        # dialog has not been created so lets do so.
        cl = CoverLocale()
        ui = Gtk.Builder()
        ui.set_translation_domain(cl.Locale.LOCALE_DOMAIN)
        ui.add_from_file(rb.find_plugin_file(self.plugin,
                                             'ui/coverart_browser.ui'))
        ui.connect_signals(self)

        # load the page and put it in the source
        # first setup the notification stuff

        def hide_infobar(widget, *args):
            widget.hide()

        overlay = Gtk.Overlay()
        overlay.show_all()
        self.notification_infobar = Gtk.InfoBar.new()

        self.notification_infobar.set_message_type(Gtk.MessageType.INFO)
        self.notification_infobar.set_valign(Gtk.Align.START)
        self.notification_infobar.connect('response', hide_infobar)

        self.notification_text = Gtk.Label.new("")
        area = self.notification_infobar.get_content_area()
        area.props.halign = Gtk.Align.CENTER
        area.add(self.notification_text)

        self.notification_infobar.show_all()
        self.notification_infobar.set_visible(False)

        self.page = ui.get_object('main_box')
        overlay.add(self.page)
        overlay.add_overlay(self.notification_infobar)

        self.pack_start(overlay, True, True, 0)
        self.page.reorder_child(overlay, 0)

        # get widgets for main icon-view
        self.status_label = ui.get_object('status_label')
        window = ui.get_object('scrolled_window')

        self.viewmgr = ViewManager(self, window)

        # get widgets for the artist paned
        self.artist_paned = ui.get_object('vertical_paned')
        self.artist_paned.set_name('vertical_paned')
        Gdk.threads_add_timeout(GLib.PRIORITY_DEFAULT_IDLE, 50, self._change_artist_paned_pos, self.viewmgr.view_name)
        self.viewmgr.connect('new-view', self.on_view_changed)
        self.artist_treeview = ui.get_object('artist_treeview')
        self.artist_scrolledwindow = ui.get_object('artist_scrolledwindow')

        # define menu's
        self.popup_menu = Menu(self.plugin, self.shell)
        self.popup_menu.load_from_file('ui/coverart_browser_pop_rb2.ui',
                                       'ui/coverart_browser_pop_rb3.ui')
        self._external_plugins = None

        signals = \
            {'play_album_menu_item': self.play_album_menu_item_callback,
             'queue_album_menu_item': self.queue_album_menu_item_callback,
             'add_to_playing_menu_item': self.add_to_playing_menu_item_callback,
             'new_playlist': self.add_playlist_menu_item_callback,
             'cover_search_menu_item': self.cover_search_menu_item_callback,
             'export_embed_menu_item': self.export_embed_menu_item_callback,
             'show_properties_menu_item': self.show_properties_menu_item_callback,
             'play_similar_artist_menu_item': self.play_similar_artist_menu_item_callback}

        self.popup_menu.connect_signals(signals)
        self.popup_menu.connect('pre-popup', self.pre_popup_menu_callback)

        self.status_label = ui.get_object('status_label')
        self.request_status_box = ui.get_object('request_status_box')
        self.request_spinner = ui.get_object('request_spinner')
        self.request_statusbar = ui.get_object('request_statusbar')
        self.request_cancel_button = ui.get_object('request_cancel_button')
        self.paned = ui.get_object('paned')
        self.entry_view_grid = ui.get_object('bottom_grid')

        #setup Track Pane
        setting = self.gs.get_setting(self.gs.Path.PLUGIN)
        setting.bind(self.gs.PluginKey.PANED_POSITION,
                     self.paned, 'collapsible-y', Gio.SettingsBindFlags.DEFAULT)
        self.entryviewpane = EntryViewPane(self.shell,
                                           self.plugin,
                                           self,
                                           self.entry_view_grid,
                                           self.viewmgr)

        #---- set up info pane -----#
        info_stack = ui.get_object('info_stack')
        info_button_box = ui.get_object('info_button_box')
        artist_info_paned = ui.get_object('vertical_info_paned')
        artist_info_paned.set_name('vertical_paned')

        self.artist_info = ArtistInfoPane(info_button_box,
                                          info_stack,
                                          artist_info_paned,
                                          self)

        # quick search
        self.quick_search = ui.get_object('quick_search_entry')

        # theme override option
        cssProvider = Gtk.CssProvider()
        css = rb.find_plugin_file(self.plugin, 'ui/gtkthemeoverride.css')
        cssProvider.load_from_path(css)
        screen = Gdk.Screen.get_default()
        styleContext = Gtk.StyleContext()
        styleContext.add_provider_for_screen(screen, cssProvider,
                                             Gtk.STYLE_PROVIDER_PRIORITY_USER)

        print("CoverArtBrowser DEBUG - end _create_ui")

    def _setup_source(self):
        '''
        Setup the different parts of the source so they are ready to be used
        by the user. It also creates and configure some custom widgets.
        '''
        print("CoverArtBrowser DEBUG - _setup_source")

        cl = CoverLocale()
        cl.switch_locale(cl.Locale.LOCALE_DOMAIN)

        # setup iconview popup
        self.viewmgr.current_view.set_popup_menu(self.popup_menu)

        # create an album manager
        self.album_manager = AlbumManager(self.plugin, self.viewmgr.current_view)

        self.viewmgr.current_view.initialise(self)
        # setup cover search pane
        self.entryviewpane.setup_source()
        self.entry_view = self.entryviewpane.get_entry_view()

        # connect a signal to when the info of albums is ready
        self.load_fin_id = self.album_manager.loader.connect(
            'model-load-finished', self.load_finished_callback)

        # prompt the loader to load the albums
        self.album_manager.loader.load_albums(self.props.base_query_model)

        # initialise the variables of the quick search
        self.quick_search_controller = AlbumQuickSearchController(
            self.album_manager)
        self.quick_search_controller.connect_quick_search(self.quick_search)

        # set sensitivity of export menu item for iconview
        self.popup_menu.set_sensitive('export_embed_menu_item',
                                      CoverArtExport(self.plugin,
                                                     self.shell, self.album_manager).is_search_plugin_enabled())

        # setup the statusbar component
        self.statusbar = Statusbar(self)

        # initialise the toolbar manager
        self.toolbar_manager = ToolbarManager(self.plugin, self.page,
                                              self.viewmgr)
        self.viewmgr.current_view.emit('update-toolbar')

        cl.switch_locale(cl.Locale.RB)
        # setup the artist paned
        artist_pview = None
        for view in self.shell.props.library_source.get_property_views():
            print(view.props.title)
            print(_("Artist"))
            if view.props.title == _("Artist"):
                artist_pview = view
                break

        assert artist_pview, "cannot find artist property view"

        self.artist_treeview.set_model(artist_pview.get_model())
        setting = self.gs.get_setting(self.gs.Path.PLUGIN)
        setting.bind(self.gs.PluginKey.ARTIST_PANED_POSITION,
                     self, 'artist-paned-pos', Gio.SettingsBindFlags.DEFAULT)

        self.artist_paned.connect('button-press-event',
                                  self.artist_paned_button_press_callback)
        self.artist_paned.connect('button-release-event',
                                  self.artist_paned_button_release_callback)

        # intercept JumpToPlaying Song action so that we can scroll to the playing album
        appshell = rb3compat.ApplicationShell(self.shell)
        action = appshell.lookup_action("", "jump-to-playing", "win")
        action.action.connect("activate", self.jump_to_playing, None)

        # connect to the playing song event so that if we are following a song, the album
        # should be automatically selected

        self.shell.props.shell_player.connect('playing-song-changed', self.playing_song_callback)

        self.echonest_similar_playlist = None

        print("CoverArtBrowser DEBUG - end _setup_source")

    def playing_song_callback(self, *args):
        if not self.follow_song:
            return

        self.jump_to_playing()

    def pre_popup_menu_callback(self, *args):
        '''
        Callback when the popup menu is about to be displayed
        '''

        state, sensitive = self.shell.props.shell_player.get_playing()
        if not state:
            sensitive = False

        #self.popup_menu.get_menu_object('add_to_playing_menu_item')
        self.popup_menu.set_sensitive('add_to_playing_menu_item', sensitive)

        if not self._external_plugins:
            # initialise external plugin menu support
            self._external_plugins = \
                CreateExternalPluginMenu("ca_covers_view",
                                         8, self.popup_menu)
            self._external_plugins.create_menu('popup_menu', True)

        self.playlist_menu_item_callback()

    def jump_to_playing(self, *args):
        '''
        Callback when the JumpToPlaying action is invoked
        This will scroll the view to the playing song
        '''

        if not self.shell.props.selected_page.props.name == self.props.name:
            # if the source page that was played from is not the plugin then
            # nothing to do
            return

        album = None

        entry = self.shell.props.shell_player.get_playing_entry()

        if entry:
            album = self.album_manager.model.get_from_dbentry(entry)

        self.viewmgr.current_view.scroll_to_album(album)

    def artist_paned_button_press_callback(self, widget, *args):
        self._from_paned_handle = True

    def artist_paned_button_release_callback(self, widget, *args):
        '''
        Callback when the artist paned handle is released from its mouse click.
        '''
        if not self._from_paned_handle:
            return False
        else:
            self._from_paned_handle = False

        print ("artist_paned_button_release_callback")
        child_width = self._get_child_width()
        print (child_width)
        print (self.artist_paned.get_position())
        child_width = self.artist_paned.get_position()
        paned_positions = eval(self.artist_paned_pos)

        found = None
        for viewpos in paned_positions:
            if self.viewmgr.view_name in viewpos:
                found = viewpos
                break

        if not found:
            print ("not found %s" % self.viewmgr.view_name)
            return True

        print ("current paned_positions %s" % paned_positions)
        paned_positions.remove(found)
        print ("Child Width %d" % child_width)
        if child_width <= self.min_paned_pos:
            print (found)
            print (found.split(':')[1])
            if int(found.split(':')[1]) == 0:
                child_width = self.min_paned_pos + 1
                print ("opening")
            else:
                child_width = 0
                print ("smaller")
            self.artist_paned.set_position(child_width)


        print ("Child Width2 %d" % child_width)

        paned_positions.append(self.viewmgr.view_name + ":" + str(child_width))

        print ("after paned positions %s" % paned_positions)
        self.artist_paned_pos = repr(paned_positions)
        print ("artist_paned_pos %s" % self.artist_paned_pos)

    def on_view_changed(self, widget, view_name):
        self._change_artist_paned_pos(view_name)

    def _change_artist_paned_pos(self, view_name):
        print ("change artist paned")
        paned_positions = eval(self.artist_paned_pos)
        print(paned_positions)
        found = None
        for viewpos in paned_positions:
            if view_name in viewpos:
                found = viewpos
                break
        print(found)
        if not found:
            print ("not found %s" % view_name)
            return

        child_width = int(found.split(":")[1])
        print(child_width)

        # odd case - if the pane is not visible but the position is zero
        # then the paned position on visible=true is some large arbitary value
        # hence - set it to be 1 px larger than the real value, then set it back
        # to its expected value
        self.artist_paned.set_position(child_width + 1)
        self.artist_paned.set_visible(True)
        self.artist_paned.set_position(child_width)

    def _get_child_width(self):
        child = self.artist_paned.get_child1()
        return child.get_allocated_width()

    def on_artist_treeview_selection_changed(self, view):
        model, artist_iter = view.get_selected()
        if artist_iter:
            artist = model[artist_iter][0]

            cl = CoverLocale()
            cl.switch_locale(cl.Locale.RB)
            #. TRANSLATORS - "All" is used in the context of "All artist names"
            if artist == _('All'):
                self.album_manager.model.remove_filter('quick_artist')
            else:
                self.album_manager.model.replace_filter('quick_artist', artist)

            cl.switch_locale(cl.Locale.LOCALE_DOMAIN)

    def _apply_settings(self):
        '''
        Applies all the settings related to the source and connects those that
        must be updated when the preferences dialog changes it's values. Also
        enables differents parts of the ui if the settings says so.
        '''
        print("CoverArtBrowser DEBUG - _apply_settings")

        # connect some signals to the loader to keep the source informed
        self.album_mod_id = self.album_manager.model.connect('album-updated',
                                                             self.on_album_updated)

        self.notify_prog_id = self.album_manager.connect(
            'notify::progress', lambda *args: self.notify_status_changed())

        print("CoverArtBrowser DEBUG - end _apply_settings")

    def load_finished_callback(self, _):
        '''
        Callback called when the loader finishes loading albums into the
        covers view model.
        '''
        print("CoverArtBrowser DEBUG - load_finished_callback")

        #if not self.request_status_box.get_visible():
        # it should only be enabled if no cover request is going on
        #self.source_menu_search_all_item.set_sensitive(True)

        # enable sorting on the entryview
        self.entry_view.set_columns_clickable(True)
        self.shell.props.library_source.get_entry_view().set_columns_clickable(
            True)

        print("CoverArtBrowser DEBUG - end load_finished_callback")

    def get_entry_view(self):
        return self.entry_view

    def on_album_updated(self, model, path, tree_iter):
        '''
        Callback called by the album loader when one of the albums managed
        by him gets modified in some way.
        '''
        album = model.get_from_path(path)
        selected = self.viewmgr.current_view.get_selected_objects()

        if album in selected:
            # update the selection since it may have changed
            self.viewmgr.current_view.selectionchanged_callback()

            if album is selected[0]:
                self.entryviewpane.update_cover(album,
                                                self.album_manager)

    def play_similar_artist_menu_item_callback(self, *args):
        '''
        Callback called when the play similar artist option is selected from
        the cover view popup. It plays similar artists music.
        '''

    def play_similar_artist_menu_item_callback(self, *args):
        if not self.echonest_similar_playlist:
            self.echonest_similar_playlist = \
                EchoNestPlaylist(self.shell,
                                 self.shell.props.queue_source)

        selected_albums = self.viewmgr.current_view.get_selected_objects()
        album = selected_albums[0]
        tracks = album.get_tracks()

        entry = tracks[0].entry
        self.echonest_similar_playlist.start(entry, reinitialise=True)

    def show_properties_menu_item_callback(self, *args):
        '''
        Callback called when the show album properties option is selected from
        the cover view popup. It shows a SongInfo dialog showing the selected
        albums' entries info, which can be modified.
        '''
        print("CoverArtBrowser DEBUG - show_properties_menu_item_callback")

        self.entry_view.select_all()

        info_dialog = RB.SongInfo(source=self, entry_view=self.entry_view)

        info_dialog.show_all()

        print("CoverArtBrowser DEBUG - end show_properties_menu_item_callback")

    def play_selected_album(self, favourites=False):
        '''
        Utilitary method that plays all entries from an album into the play
        queue.
        '''
        # callback when play an album
        print("CoverArtBrowser DEBUG - play_selected_album")

        for row in self.source_query_model:
            self.source_query_model.remove_entry(row[0])

        self.queue_selected_album(self.source_query_model, favourites)

        if len(self.source_query_model) > 0:
            self.props.query_model = self.source_query_model

            # Start the music
            player = self.shell.props.shell_player

            player.play_entry(self.source_query_model[0][0], self)

        print("CoverArtBrowser DEBUG - end play_selected_album")

    def queue_selected_album(self, source, favourites=False):
        '''
        Utilitary method that queues all entries from an album into the play
        queue.
        '''
        print("CoverArtBrowser DEBUG - queue_selected_album")

        if source == None:
            source = self.source_query_model

        selected_albums = self.viewmgr.current_view.get_selected_objects()
        threshold = self.rating_threshold if favourites else 0

        total = 0
        for album in selected_albums:
            # Retrieve and sort the entries of the album
            tracks = album.get_tracks(threshold)
            total = total + len(tracks)
            # Add the songs to the play queue
            for track in tracks:
                source.add_entry(track.entry, -1)

        if total == 0 and threshold:
            dialog = Gtk.MessageDialog(None,
                                       Gtk.DialogFlags.MODAL,
                                       Gtk.MessageType.INFO,
                                       Gtk.ButtonsType.OK,
                                       _(
                                           "No tracks have been added because no tracks meet the favourite rating threshold"))

            dialog.run()
            dialog.destroy()
        print("CoverArtBrowser DEBUG - end queue_select_album")

    def play_album_menu_item_callback(self, *args):
        '''
        Callback called when the play album item from the cover view popup is
        selected. It cleans the play queue and queues the selected album.
        '''
        print("CoverArtBrowser DEBUG - play_album_menu_item_callback")

        self.play_selected_album(self.favourites)

        print("CoverArtBrowser DEBUG - end play_album_menu_item_callback")

    def add_to_playing_menu_item_callback(self, *args):
        '''
        Callback called when the add-to-playing item from the cover view popup is
        selected. It adds the selected album at the end of the currently playing source.
        '''

        self.queue_selected_album(None, self.favourites)

    def queue_album_menu_item_callback(self, *args):
        '''
        Callback called when the queue album item from the cover view popup is
        selected. It queues the selected album at the end of the play queue.
        '''
        print("CoverArtBrowser DEBUG - queue_album_menu_item_callback()")
        self.queue_selected_album(self.shell.props.queue_source, self.favourites)

        print("CoverArtBrowser DEBUG - end queue_album_menu_item_callback()")

    def playlist_menu_item_callback(self, *args):
        print("CoverArtBrowser DEBUG - playlist_menu_item_callback")

        self.playlist_fillmenu(self.popup_menu, 'playlist_submenu', 'playlist_section',
                               self.actiongroup,
                               self.add_to_static_playlist_menu_item_callback,
                               self.favourites)

    def playlist_fillmenu(self, popup_menu, menubar, section_name,
                          actiongroup, func, favourite=False):
        print("CoverArtBrowser DEBUG - playlist_fillmenu")

        playlist_manager = self.shell.props.playlist_manager
        playlists_entries = playlist_manager.get_playlists()

        # tidy up old playlists menu items before recreating the list
        actiongroup.remove_actions()
        popup_menu.remove_menu_items(menubar, section_name)

        if playlists_entries:
            for playlist in playlists_entries:
                if playlist.props.is_local and \
                        isinstance(playlist, RB.StaticPlaylistSource):
                    args = (playlist, favourite)

                    # take the name of the playlist, strip out non-english characters and reduce the string
                    # to just a-to-z characters i.e. this will make the action_name valid in RB3

                    ascii_name = unicodedata.normalize('NFKD', \
                                                       rb3compat.unicodestr(playlist.props.name, 'utf-8')).encode(
                        'ascii', 'ignore')
                    ascii_name = ascii_name.decode(encoding='UTF-8')
                    ascii_name = re.sub(r'[^a-zA-Z]', '', ascii_name)
                    action = actiongroup.add_action(func=func,
                                                    action_name=ascii_name,
                                                    playlist=playlist, favourite=favourite,
                                                    label=playlist.props.name)

                    popup_menu.add_menu_item(menubar, section_name,
                                             action)

    def add_to_static_playlist_menu_item_callback(self, action, param, args):
        print('''CoverArtBrowser DEBUG -
            add_to_static_playlist_menu_item_callback''')

        playlist = args['playlist']
        favourite = args['favourite']

        self.queue_selected_album(playlist, favourite)

    def add_playlist_menu_item_callback(self, *args):
        print('''CoverArtBrowser DEBUG - add_playlist_menu_item_callback''')
        playlist_manager = self.shell.props.playlist_manager
        playlist = playlist_manager.new_playlist(_('New Playlist'), False)

        self.queue_selected_album(playlist, self.favourites)

    def play_random_album_menu_item_callback(self, favourites=False):
        print('''CoverArtBrowser DEBUG - play_random_album_menu_item_callback''')
        query_model = RB.RhythmDBQueryModel.new_empty(self.shell.props.db)

        num_albums = len(self.album_manager.model.store)

        #random_list = []
        selected_albums = []

        gs = GSetting()
        settings = gs.get_setting(gs.Path.PLUGIN)
        to_queue = settings[gs.PluginKey.RANDOM]

        if num_albums <= to_queue:
            dialog = Gtk.MessageDialog(None,
                                       Gtk.DialogFlags.MODAL,
                                       Gtk.MessageType.INFO,
                                       Gtk.ButtonsType.OK,
                                       _("The number of albums to randomly play is less than that displayed."))

            dialog.run()
            dialog.destroy()
            return

        album_col = self.album_manager.model.columns['album']

        chosen = {}

        # now loop through finding unique random albums
        # i.e. ensure we dont queue the same album twice

        for loop in range(0, to_queue):
            while True:
                pos = random.randint(0, num_albums - 1)
                if pos not in chosen:
                    chosen[pos] = None
                    selected_albums.append(self.album_manager.model.store[pos][album_col])
                    break

        threshold = self.rating_threshold if favourites else 0

        total = 0
        for album in selected_albums:
            # Retrieve and sort the entries of the album
            tracks = album.get_tracks(threshold)
            total = total + len(tracks)
            # Add the songs to the play queue
            for track in tracks:
                query_model.add_entry(track.entry, -1)

        if total == 0 and threshold:
            dialog = Gtk.MessageDialog(None,
                                       Gtk.DialogFlags.MODAL,
                                       Gtk.MessageType.INFO,
                                       Gtk.ButtonsType.OK,
                                       _(
                                           "No tracks have been added because no tracks meet the favourite rating threshold"))

            dialog.run()
            dialog.destroy()

        self.props.query_model = query_model

        # Start the music
        player = self.shell.props.shell_player

        player.play_entry(query_model[0][0], self)

        print("CoverArtBrowser DEBUG - end play_selected_album")

    def cover_search_menu_item_callback(self, *args):
        '''
        Callback called when the search cover option is selected from the
        cover view popup. It prompts the album loader to retrieve the selected
        album cover
        '''
        print("CoverArtBrowser DEBUG - cover_search_menu_item_callback()")
        selected_albums = self.viewmgr.current_view.get_selected_objects()

        self.request_status_box.show_all()

        self.album_manager.cover_man.search_covers(selected_albums,
                                                   self.update_request_status_bar)

        print("CoverArtBrowser DEBUG - end cover_search_menu_item_callback()")

    def export_embed_menu_item_callback(self, *args):
        '''
        Callback called when the export and embed coverart option
        is selected from the cover view popup.
        It prompts the exporter to copy and embed art for the albums chosen
        '''
        print("CoverArtBrowser DEBUG - export_embed_menu_item_callback()")
        selected_albums = self.viewmgr.current_view.get_selected_objects()

        CoverArtExport(self.plugin,
                       self.shell, self.album_manager).embed_albums(selected_albums)

        print("CoverArtBrowser DEBUG - export_embed_menu_item_callback()")

    def update_request_status_bar(self, coverobject):
        '''
        Callback called by the album loader starts performing a new cover
        request. It prompts the source to change the content of the request
        statusbar.
        '''
        print("CoverArtBrowser DEBUG - update_request_status_bar")

        if coverobject:
            # for example "Requesting the picture cover for the music artist Michael Jackson"
            tranlation_string = _('Requesting cover for %s...')
            self.request_statusbar.set_text(
                rb3compat.unicodedecode(_('Requesting cover for %s...') % (coverobject.name), 'UTF-8'))
        else:
            self.request_status_box.hide()
            self.popup_menu.set_sensitive('cover_search_menu_item', True)
            self.request_cancel_button.set_sensitive(True)
        print("CoverArtBrowser DEBUG - end update_request_status_bar")

    def cancel_request_callback(self, _):
        '''
        Callback connected to the cancel button on the request statusbar.
        When called, it prompts the album loader to cancel the full cover
        search after the current cover.
        '''
        print("CoverArtBrowser DEBUG - cancel_request_callback")

        self.request_cancel_button.set_sensitive(False)
        self._cover_search_manager.cover_man.cancel_cover_request()

        print("CoverArtBrowser DEBUG - end cancel_request_callback")

    def show_hide_pane(self, params):
        '''
        helper function - if the entry is manually expanded
        then if necessary scroll the view to the last selected album
        params is "album" or a tuple of "album" and "force_expand" boolean
        '''
        print ('show_hide_pane')
        if isinstance(params, tuple):
            album, force = params
        else:
            album = params
            force = PanedCollapsible.Paned.DEFAULT

        if (album and self.click_count == 1 \
                    and self.last_selected_album is album) or force != PanedCollapsible.Paned.DEFAULT:
            # check if it's a second or third click on the album and expand
            # or collapse the entry view accordingly
            self.paned.expand(force)

        # update the selected album
        selected = self.viewmgr.current_view.get_selected_objects()
        self.last_selected_album = selected[0] if len(selected) == 1 else None

        # clear the click count
        self.click_count = 0

        print ('show_hide_pane end')

    def update_with_selection(self):
        self.last_selected_album, self.click_count = \
            self.entryviewpane.update_selection(self.last_selected_album,
                                                self.click_count)

        self.statusbar.emit('display-status', self.viewmgr.current_view)

    def propertiesbutton_callback(self, choice):
        print ("properties chosen: %s" % choice)

        if choice == 'download':
            self.request_status_box.show_all()
            self._cover_search_manager = self.viewmgr.current_view.get_default_manager()
            self._cover_search_manager.cover_man.search_covers(
                callback=self.update_request_status_bar)
        elif choice == 'random':
            self.play_random_album_menu_item_callback()
        elif choice == 'random favourite':
            self.play_random_album_menu_item_callback(True)
        elif choice == 'favourite':
            self.favourites = not self.favourites
            self.viewmgr.current_view.set_popup_menu(self.popup_menu)
        elif choice == 'follow':
            self.follow_song = not self.follow_song
        elif choice == 'browser prefs':
            if not self._browser_preferences:
                self._browser_preferences = Preferences()

            self._browser_preferences.display_preferences_dialog(self.plugin)
        elif choice == 'search prefs':
            try:
                if not self._search_preferences:
                    from gi.repository import Peas

                    peas = Peas.Engine.get_default()
                    plugin_info = peas.get_plugin_info('coverart_search_providers')
                    module_name = plugin_info.get_module_name()
                    mod = __import__(module_name)
                    sp = getattr(mod, "SearchPreferences")
                    self._search_preferences = sp()
                    self._search_preferences.plugin_info = plugin_info

                self._search_preferences.display_preferences_dialog(self._search_preferences)
            except:
                dialog = Gtk.MessageDialog(None,
                                           Gtk.DialogFlags.MODAL,
                                           Gtk.MessageType.INFO,
                                           Gtk.ButtonsType.OK,
                                           _(
                                               "Please install and activate the latest version of the Coverart Search Providers plugin"))

                dialog.run()
                dialog.destroy()
        else:
            assert 1 == 2, ("unknown choice %s", choice)

    @classmethod
    def get_instance(cls, **kwargs):
        '''
        Returns the unique instance of the manager.
        '''
        if not cls.instance:
            cls.instance = CoverArtBrowserSource(**kwargs)

        return cls.instance


class Statusbar(GObject.Object):
    # signals
    __gsignals__ = {
        'display-status': (GObject.SIGNAL_RUN_LAST, None, (object,))
    }

    custom_statusbar_enabled = GObject.property(type=bool, default=False)

    def __init__(self, source):
        super(Statusbar, self).__init__()

        self.status = ''

        self._source_statusbar = SourceStatusBar(source)
        self._custom_statusbar = CustomStatusBar(source.status_label)
        self.current_statusbar = self._source_statusbar

        self._connect_signals(source)
        self._connect_properties()

    def _connect_properties(self):
        gs = GSetting()
        settings = gs.get_setting(gs.Path.PLUGIN)

        settings.bind(gs.PluginKey.CUSTOM_STATUSBAR, self,
                      'custom_statusbar_enabled', Gio.SettingsBindFlags.GET)

    def _connect_signals(self, source):
        self.connect('notify::custom-statusbar-enabled',
                     self._custom_statusbar_enabled_changed)
        self.connect('display-status', self._update)

    def _custom_statusbar_enabled_changed(self, *args):
        self.current_statusbar.hide()

        if self.custom_statusbar_enabled:
            self.current_statusbar = self._custom_statusbar
        else:
            self.current_statusbar = self._source_statusbar

        self.current_statusbar.show()
        self.current_statusbar.update(self.status)

    def _generate_status(self, albums=None):
        self.status = ''

        if albums:
            track_count = 0
            duration = 0

            for album in albums:
                # Calculate duration and number of tracks from that album
                track_count += album.track_count
                duration += album.duration / 60

            # now lets build up a status label containing some
            # 'interesting stuff' about the album
            if len(albums) == 1:
                #. TRANSLATORS - for example "abba's greatest hits by ABBA"
                self.status = rb3compat.unicodedecode(_('%s by %s') %
                                                      (album.name, album.artist), 'UTF-8')
            else:
                #. TRANSLATORS - the number of albums that have been selected/highlighted
                self.status = rb3compat.unicodedecode(_('%d selected albums') %
                                                      (len(albums)), 'UTF-8')

            if track_count == 1:
                self.status += rb3compat.unicodedecode(_(' with 1 track'), 'UTF-8')
            else:
                self.status += rb3compat.unicodedecode(_(' with %d tracks') %
                                                       track_count, 'UTF-8')

            if duration == 1:
                self.status += rb3compat.unicodedecode(_(' and a duration of 1 minute'), 'UTF-8')
            else:
                self.status += rb3compat.unicodedecode(_(' and a duration of %d minutes') %
                                                       duration, 'UTF-8')

    def _update(self, widget, current_view):
        albums = current_view.get_selected_objects()
        self._generate_status(albums)
        self.current_statusbar.update(self.status)


class SourceStatusBar(object):
    def __init__(self, source):
        self._source = source

    def show(self):
        pass

    def hide(self):
        self.update('')

    def update(self, status):
        self._source.status = status
        self._source.notify_status_changed()


class CustomStatusBar(object):
    def __init__(self, status_label):
        self._label = status_label

    def show(self):
        self._label.show()

    def hide(self):
        self._label.hide()

    def update(self, status):
        self._label.set_text(status)


class Views:
    '''
    This class describes the different views available
    '''
    # storage for the instance reference
    __instance = None

    class _impl(GObject.Object):
        """ Implementation of the singleton interface """

        # below public variables and methods that can be called for Views
        def __init__(self, shell):
            '''
            Initializes the singleton interface, assigning all the constants
            used to access the plugin's settings.
            '''
            super(Views._impl, self).__init__()

            from coverart_covericonview import CoverIconView
            from coverart_coverflowview import CoverFlowView
            from coverart_artistview import ArtistView
            from coverart_listview import ListView
            from coverart_queueview import QueueView
            from coverart_playsourceview import PlaySourceView
            from coverart_browser_prefs import webkit_support

            library_name = shell.props.library_source.props.name
            queue_name = shell.props.queue_source.props.name

            self._values = OrderedDict()

            cl = CoverLocale()
            cl.switch_locale(cl.Locale.LOCALE_DOMAIN)

            self._values[CoverIconView.name] = [_('Tiles'),
                                                GLib.Variant.new_string('coverart-browser-tile')]
            if webkit_support():
                self._values[CoverFlowView.name] = [_('Flow'),
                                                    GLib.Variant.new_string('coverart-browser-coverflow')]
            self._values[ArtistView.name] = [_('Artist'),
                                             GLib.Variant.new_string('coverart-browser-artist')]
            self._values[ListView.name] = [library_name,
                                           GLib.Variant.new_string('coverart-browser-list')]
            self._values[QueueView.name] = [queue_name,
                                            GLib.Variant.new_string('coverart-browser-queue')]
            #self._values[PlaySourceView.name] = [_('CoverArt Playlist'),
            #                                GLib.Variant.new_string('coverart-browser-playsource')]
            cl.switch_locale(cl.Locale.RB)
            print(self._values)

        def get_view_names(self):
            return list(self._values.keys())

        def get_view_name_for_action(self, action_name):
            for view_name in self.get_view_names():
                if self.get_action_name(view_name) == action_name:
                    return view_name

            return None

        def get_menu_name(self, view_name):
            return self._values[view_name][0]

        def get_action_name(self, view_name):
            return self._values[view_name][1]

    def __init__(self, plugin):
        """ Create singleton instance """
        # Check whether we already have an instance
        if Views.__instance is None:
            # Create and remember instance
            Views.__instance = Views._impl(plugin)

        # Store instance reference as the only member in the handle
        self.__dict__['_Views__instance'] = Views.__instance

    def __getattr__(self, attr):
        """ Delegate access to implementation """
        return getattr(self.__instance, attr)

    def __setattr__(self, attr, value):
        """ Delegate access to implementation """
        return setattr(self.__instance, attr, value)


class ViewManager(GObject.Object):
    # signals
    __gsignals__ = {
        'new-view': (GObject.SIGNAL_RUN_LAST, None, (str,))
    }

    # properties
    view_name = GObject.property(type=str, default=CoverIconView.name)

    def __init__(self, source, window):
        super(ViewManager, self).__init__()

        self.source = source
        self.window = window

        # initialize views
        self._views = {}
        ui = Gtk.Builder()
        ui.add_from_file(rb.find_plugin_file(source.plugin,
                                             'ui/coverart_iconview.ui'))
        self._views[CoverIconView.name] = ui.get_object('covers_view')
        self._views[CoverFlowView.name] = CoverFlowView()
        self._views[ListView.name] = ListView()
        self._views[QueueView.name] = QueueView()
        #self._views[PlaySourceView.name] = PlaySourceView()
        ui.add_from_file(rb.find_plugin_file(source.plugin,
                                             'ui/coverart_artistview.ui'))
        self._views[ArtistView.name] = ui.get_object('artist_view')
        self._lastview = None

        self.controller = ViewController(source.shell, self)

        # connect signal and properties
        self._connect_signals()
        self._connect_properties()
        self._lastview = self.view_name
        if self.current_view.use_plugin_window:
            window.add(self.current_view.view)
            window.show_all()

    @property
    def current_view(self):
        return self._views[self.view_name]

    def get_view(self, view_name):
        return self._views[view_name]

    def _connect_signals(self):
        self.connect('notify::view-name', self.on_notify_view_name)

    def _connect_properties(self):
        gs = GSetting()
        setting = gs.get_setting(gs.Path.PLUGIN)
        setting.bind(gs.PluginKey.VIEW_NAME, self, 'view_name',
                     Gio.SettingsBindFlags.DEFAULT)

    def on_notify_view_name(self, *args):
        if self._lastview and self.view_name != self._lastview:
            selected = self._views[self._lastview].get_selected_objects()
            current_album = None
            if len(selected) > 0:
                current_album = self._views[self._lastview].get_selected_objects()[0]

            if self._views[self.view_name].use_plugin_window:
                child = self.window.get_child()

                if child:
                    self.window.remove(child)
                self.window.add(self._views[self.view_name].view)
                self.window.show_all()
                self.click_count = 0

                self._views[self._lastview].panedposition = self.source.paned.get_expansion_status()

            self._views[self.view_name].switch_to_view(self.source, current_album)
            self._views[self.view_name].emit('update-toolbar')
            self._views[self.view_name].get_default_manager().emit('sort', None)

            if self._views[self.view_name].use_plugin_window:
                self.source.paned.expand(self._views[self.view_name].panedposition)

            self.current_view.set_popup_menu(self.source.popup_menu)
            self.source.album_manager.current_view = self.current_view

            if self._views[self.view_name].use_plugin_window:
                # we only ever save plugin views not external views
                saved_view = self.view_name
            else:
                saved_view = self._lastview

            self._lastview = self.view_name

            gs = GSetting()
            setting = gs.get_setting(gs.Path.PLUGIN)
            setting[gs.PluginKey.VIEW_NAME] = saved_view

        self.emit('new-view', self.view_name)

    def get_view_icon_name(self, view_name):
        return self._views[view_name].get_view_icon_name()

    def get_selection_colour(self):
        try:
            colour = self._views[CoverIconView.name].view.get_style_context().get_background_color(
                Gtk.StateFlags.SELECTED)
            colour = '#%s%s%s' % (
                str(hex(int(colour.red * 255))).replace('0x', ''),
                str(hex(int(colour.green * 255))).replace('0x', ''),
                str(hex(int(colour.blue * 255))).replace('0x', ''))
        except:
            colour = '#0000FF'

        return colour


GObject.type_register(CoverArtBrowserSource)