forked from fossfreedom/coverart-browser
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcoverart_browser_source.py
1402 lines (1096 loc) · 52.4 KB
/
coverart_browser_source.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- 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_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 = 0
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,
'play_next_menu_item': self.play_next_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.paned.set_name('horizontal_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
activations = setting[self.gs.PluginKey.ACTIVATIONS]
activations = activations + 1
setting[self.gs.PluginKey.ACTIVATIONS] = activations
if activations > 4:
override = 'ui/gtkthemeoverride_min.css'
else:
override = 'ui/gtkthemeoverride_max.css'
cssProvider = Gtk.CssProvider()
css = rb.find_plugin_file(self.plugin, override)
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)
self.popup_menu.set_sensitive('play_next_menu_item', sensitive)
if not self._external_plugins:
# initialise external plugin menu support
self._external_plugins = \
CreateExternalPluginMenu("ca_covers_view",
9, 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, event):
self._from_paned_handle = 1
if event.type == Gdk.EventType._2BUTTON_PRESS:
self._from_paned_handle = 2
def artist_paned_button_release_callback(self, widget, *args):
'''
Callback when the artist paned handle is released from its mouse click.
'''
if self._from_paned_handle == 0:
return False
print("artist_paned_button_release_callback")
print(self.artist_paned.get_position())
child_width = self.artist_paned.get_position()
if child_width == 0 and self._from_paned_handle == 1:
return
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)
open_type = "closed"
if self._from_paned_handle == 2:
# we are dealing with a double click situation
new_width = child_width
if new_width == 0:
if int(found.split(':')[1]) == 0:
new_width = self.min_paned_pos + 1
else:
new_width = int(found.split(':')[1])
open_type = "opened"
child_width = new_width
else:
new_width = 0
self.artist_paned.set_position(new_width)
if child_width <= self.min_paned_pos and self._from_paned_handle == 1:
print(found)
print(found.split(':')[1])
if int(found.split(':')[1]) == 0:
child_width = self.min_paned_pos + 1
open_type = "opened"
else:
child_width = 0
print("smaller")
self.artist_paned.set_position(child_width)
if self._from_paned_handle == 1 and child_width != 0:
open_type = "opened"
print("Child Width2 %d" % child_width)
paned_positions.append(self.viewmgr.view_name + \
":" + \
str(child_width) + \
":" + \
open_type)
print("after paned positions %s" % paned_positions)
self.artist_paned_pos = repr(paned_positions)
print("artist_paned_pos %s" % self.artist_paned_pos)
self._from_paned_handle = 0
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
values = found.split(":")
child_width = int(values[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
open_type = "closed"
if len(values) > 2:
open_type = values[2]
elif child_width > 0:
open_type = "opened"
if open_type == "closed":
child_width = 0
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.
'''
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, index=-1):
'''
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, index)
if index != -1:
index = index + 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 play_next_menu_item_callback(self, *args):
'''
Callback called when the play next item from the cover view popup is
selected. It adds to the play queue immediately after the last track of the playing album
'''
print("CoverArtBrowser DEBUG - play_album_menu_item_callback")
entry = self.shell.props.shell_player.get_playing_entry()
if not entry:
return
index = 0
source = self.source_query_model
# the API doesnt provide a method to find the index position of the entry that is playing
# so lets reverse through the model calculating the position
while entry is not None:
index = index + 1
entry = source.get_previous_from_entry(entry)
entry = self.shell.props.shell_player.get_playing_entry()
# lets move forward from the current playing entry and find the last album entry
final_index = index
current_album = self.album_manager.model.get_from_dbentry(entry)
while entry is not None:
entry = source.get_next_from_entry(entry)
index = index + 1
if entry:
album = self.album_manager.model.get_from_dbentry(entry)
print(entry.get_string(RB.RhythmDBPropType.TITLE))
if album == current_album:
final_index = index
self.queue_selected_album(None, self.favourites, final_index)
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