aboutsummaryrefslogtreecommitdiff
path: root/src/music-player-bridge.vala
blob: 606b129e5103dc62092137620b239f3162da99f6 (plain)
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
/*
Copyright 2010 Canonical Ltd.

Authors:
    Conor Curran <conor.curran@canonical.com>

This program is free software: you can redistribute it and/or modify it 
under the terms of the GNU General Public License version 3, as published 
by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranties of 
MERCHANTABILITY, SATISFACTORY QUALITY, 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, see <http://www.gnu.org/licenses/>.
*/

using Dbusmenu;
using Gee;
using GLib;

public class MusicPlayerBridge : GLib.Object
{
  const int DEVICE_ITEMS_COUNT = 3;

  private SettingsManager settings_manager;
  private Dbusmenu.Menuitem root_menu;
  private HashMap<string, PlayerController> registered_clients;
  private HashMap<string, string> file_monitors;
  private Mpris2Watcher watcher;

  public MusicPlayerBridge()
  {
  }
  
  construct{
    this.registered_clients = new HashMap<string, PlayerController> ();
    this.file_monitors = new HashMap<string, string> ();
    this.settings_manager = new SettingsManager();
    this.settings_manager.blacklist_updates.connect ( this.on_blacklist_update );
    this.settings_manager.preferred_updates.connect ( this.on_preferred_update );
  }
  
  private void on_blacklist_update ( string[] blacklist )
  {
    debug("some blacklist update");

    foreach(var s in blacklist){
      string key = this.determine_key (s);
      if (this.registered_clients.has_key (key)){
        debug ("Apparently %s is now blacklisted - remove thy self", key);
        this.registered_clients[key].remove_from_menu();
        this.registered_clients.unset (key);
      }
    }
    // double check present players to ensure dynamic removal/addition 
    this.watcher.check_for_active_clients.begin();
  }

  private void on_preferred_update ( Gee.ArrayList<string> preferred )
  {
    debug ("Preferred players update. Clearing current preferred players...");

    foreach (var player_controller in this.registered_clients.values) {
      player_controller.set_as_preferred (false);
    }

    foreach (var s in preferred) {
      string key = this.determine_key (s);
      if (this.registered_clients.has_key (key)) {
        debug ("Setting %s as preferred player", key);
        this.registered_clients[key].set_as_preferred (true);
      }
    }
  }

  private void try_to_add_inactive_familiar_clients()
  {
    var preferred_players = this.settings_manager.fetch_preferred ();
    foreach ( string desktop in this.settings_manager.fetch_interested()){
      debug ( "interested client found : %s", desktop );
      AppInfo? app_info = create_app_info ( desktop.concat( ".desktop" ) );
      if ( app_info == null ){
        warning ( "Could not create app_info for path %s \n Getting out of here ",
                   desktop );
        continue;
      }
      bool is_preferred = desktop in preferred_players;
      PlayerController ctrl = new PlayerController ( this.root_menu, 
                                                     app_info,
                                                     null,
                                                     this.fetch_icon_name(desktop),
                                                     calculate_menu_position(),
                                                     null,
                                                     PlayerController.state.OFFLINE,
                                                     is_preferred );
      var mpris_key = determine_key ( desktop );
      this.registered_clients.set(mpris_key, ctrl);  
      this.establish_file_monitoring (app_info, mpris_key);
    }
  }
  
  private void establish_file_monitoring (AppInfo info, string mpris_key){
      DesktopAppInfo desktop_info = info as DesktopAppInfo;
      var file_path = desktop_info.get_filename ();
      File f = File.new_for_path (file_path);
      try {
        FileMonitor monitor = f.monitor (FileMonitorFlags.SEND_MOVED, null);
        unowned FileMonitor weak_monitor = monitor;
        monitor.changed.connect ((desktop_file, other_file, event_type) => {
          this.relevant_desktop_file_changed (desktop_file, other_file, event_type, weak_monitor);
        });
        monitor.ref(); // will be unref()ed by relevant_desktop_file_changed()
        GLib.debug ("monitoring file '%s'", file_path);
        this.file_monitors.set (file_path, mpris_key);
      }
      catch (Error e){
        warning ("Unable to create a file monitor for %s", info.get_name());
        return;
      }
  }
  
  private void relevant_desktop_file_changed (File desktop_file,
                                              File? other_file,
                                              FileMonitorEvent event_type,
                                              FileMonitor monitor)
  {
    if (event_type != FileMonitorEvent.DELETED)
      return;
      
    string? path = desktop_file.get_path ();
    if (path == null){
      warning ("relevant_desktop_file_changed is returning a file with no path !");
      return;
    }
    if (!this.file_monitors.has_key (path)){
      warning ("relevant_desktop_file_changed is returning a file which we know nothing about - %s",
                path);
      return;
    }

    var mpris_key = this.file_monitors[path];
    GLib.debug ("file \"%s\" was removed; stopping monitoring \"%s\"", path, mpris_key);
    this.registered_clients[mpris_key].remove_from_menu();
    this.settings_manager.remove_interested (mpris_key);
    this.registered_clients.unset (mpris_key);
    monitor.cancel ();
    monitor.unref();
  }                                              

  private int calculate_menu_position()
  {
    if(this.registered_clients.size == 0){
      return DEVICE_ITEMS_COUNT;
    }
    else{
      return (DEVICE_ITEMS_COUNT + (this.registered_clients.size * PlayerController.WIDGET_QUANTITY));
    }
  }

  public void client_has_become_available ( string desktop,
                                            string dbus_name,
                                            bool use_playlists )
  {
    if (desktop == null || desktop == ""){
      warning("Client %s attempting to register without desktop entry being set on the mpris root",
               dbus_name);
      return;
    }
    if (desktop in this.settings_manager.fetch_blacklist()) {
      debug ("Client %s attempting to register but I'm afraid it is blacklisted",
             desktop);
      return;
    }
    
    debug ( "client_has_become_available %s", desktop );
    AppInfo? app_info = create_app_info ( desktop.concat( ".desktop" ) );
    if ( app_info == null ){
      warning ( "Could not create app_info for path %s \n Getting out of here ",
                 desktop );
      return;
    }
    
    var mpris_key = determine_key ( desktop );
    bool is_preferred = desktop in this.settings_manager.fetch_preferred ();    
    
    if ( this.registered_clients.has_key (mpris_key) == false ){
      debug("New client has registered that we have not seen before: %s", dbus_name );
      PlayerController ctrl = new PlayerController ( this.root_menu,
                                                     app_info,
                                                     dbus_name,
                                                     this.fetch_icon_name(desktop),                                                    
                                                     this.calculate_menu_position(),
                                                     use_playlists,
                                                     PlayerController.state.READY,
                                                     is_preferred);
      this.registered_clients.set ( mpris_key, ctrl );
      debug ( "Have not seen this %s before, new controller created.", desktop );        
      this.settings_manager.add_interested ( desktop );
      this.establish_file_monitoring (app_info, mpris_key);      
      debug ( "application added to the interested list" );
    }
    else{
      this.registered_clients[mpris_key].use_playlists = use_playlists;
      this.registered_clients[mpris_key].update_state ( PlayerController.state.READY );
      this.registered_clients[mpris_key].activate ( dbus_name );
      debug("Application has already registered - awaken the hibernation: %s with playlists %s \n", dbus_name, use_playlists.to_string() );
    }
  }
  
  public void client_has_vanished ( string mpris_root_interface )
  {
    debug("\n MusicPlayerBridge -> client with dbus interface %s has vanished",
           mpris_root_interface );
    if (root_menu != null){
      debug("\n attempt to remove %s", mpris_root_interface);
      var mpris_key = determine_key ( mpris_root_interface );
      if ( mpris_key != null && this.registered_clients.has_key(mpris_key)){
        registered_clients[mpris_key].hibernate();
        debug("\n Successively offlined client %s", mpris_key);       
      }
    }
  }
 
  public void set_root_menu_item ( Dbusmenu.Menuitem menu )
  {
    this.root_menu = menu;
    this.try_to_add_inactive_familiar_clients();
    this.watcher = new Mpris2Watcher ();
    this.watcher.client_appeared.connect (this.client_has_become_available);
    this.watcher.client_disappeared.connect (this.client_has_vanished);
  }

  public void enable_player_specific_items_for_client (string object_path,
                                                       string desktop_id)
  {
    var mpris_key = determine_key ( desktop_id );
    if (this.registered_clients.has_key (mpris_key) == false){
      warning ("we don't have a client with desktop id %s registered", desktop_id);
      return;
    }
    this.registered_clients[mpris_key].enable_player_specific_items(object_path);
  }

  public void enable_track_specific_items_for_client (string object_path,
                                                      string desktop_id)
  {
    var mpris_key = determine_key ( desktop_id );
    if (this.registered_clients.has_key (mpris_key) == false){
      warning ("we don't have a client with desktop id %s registered", desktop_id);
      return;
    }
    this.registered_clients[mpris_key].enable_track_specific_items(object_path);
  }

  private static AppInfo? create_app_info ( string desktop )
  {
    DesktopAppInfo info = new DesktopAppInfo ( desktop );
    if ( desktop == null || info == null ){
      warning ( "Could not create a desktopappinfo instance from app: %s", desktop );
      return null;
    }
    GLib.AppInfo app_info = info as GLib.AppInfo;
    return app_info;
  }
 
  private static string? fetch_icon_name(string desktop)
  {
    // We know the appinfo is good because it was loaded in the previous reg step.
    DesktopAppInfo info = new DesktopAppInfo ( desktop.concat( ".desktop" ) ) ;
    KeyFile desktop_keyfile = new KeyFile ();
    try{
      desktop_keyfile.load_from_file (info.get_filename(), KeyFileFlags.NONE);
    }
    catch(GLib.FileError error){
      warning("Error loading keyfile - FileError");
      return null;
    }
    catch(GLib.KeyFileError error){
      warning("Error loading keyfile - KeyFileError");      
      return null;
    } 
    
    try{
      return desktop_keyfile.get_string (KeyFileDesktop.GROUP,
                                         KeyFileDesktop.KEY_ICON);              
    }
    catch(GLib.KeyFileError error){
      warning("Error trying to fetch the icon name from the keyfile");      
      return null;
    } 
  }

  /*
    Messy but necessary method to consolidate desktop filesnames and mpris dbus
    names into the one single word string (used as the key in the players hash).
    So this means that we can determine the key for the players_hash from the 
    dbus interface name or the desktop file name, at startup offline/online and 
    shutdown.
   */
  private static string? determine_key(owned string desktop_or_interface)
  {
    // handle the special case of amarok, (kde4-amarok desktop file name) 
    if (desktop_or_interface.contains("amarok")){
      return "amarok";
    }
    
    var result = desktop_or_interface;

    var tokens = desktop_or_interface.split( "." );
    if (tokens != null && tokens.length > 1){
      result = tokens[tokens.length - 1];  
    }    
    var temp = result.split("-");
    if (temp != null && temp.length > 1){
      result = temp[0];
    }    
    return result;        
  }
  
}