Merge lp:~minchal/nuvola-player/integration-deezer into lp:nuvola-player/2.5.x

[Michał Pawłowski]

[lp:~minchal/nuvola-player/integration-deezer]

574. By Michał Pawłowski on 2012-09-25

Added album art support in radio mode

[Jiří Janoušek (fenryxo)]

Well, I have finally some time for the review. First of all, some boring legal stuff.

data/nuvolaplayer/services/deezer/icon.png:
Is this icon your original work? Is the PNG format preferred form for modification or is it an exported image from GIMP/Inkscape? What is its license?

data/nuvolaplayer/services/deezer/integration.js:
You chose GNU GPL 3 for your work, whereas the main program of Nuvola Player is licensed under 2-Clause BSD license. Since the license of the main program is compatible with GNU GPL, I believe it's OK to use GPL-licensed integration scripts as described in the GPL FAQ (cited bellow). However, I'm not a lawyer and if my interpretation would be found invalid, all GPL-covered scripts would be removed from the project. Therefore, I would appreciate if you would relicense your work under 2-Clause BSD license.

"If the program dynamically links plug-ins, and they make function calls to each other and share data structures, we believe they form a single program, which must be treated as an extension of both the main program and the plug-ins. In order to use the GPL-covered plug-ins, the main program must be released under the GPL or a GPL-compatible free software license, and that the terms of the GPL must be followed when the main program is distributed for use with these plug-ins." http://www.gnu.org/licenses/gpl-faq.html#NFUseGPLPlugins

data/nuvolaplayer/services/deezer/metadata.conf:
You want your work to be distributed with Nuvola Player, but you didn't set maintainer_link to your Launchpad account. It's mandatory condition.

"maintainer_link - link to page with contact to maintainer (including http:// or https://) or email address prefixed by mailto:. If you want to have your service integration shipped with Nuvola Player, you must use link to your Launchpad profile." http://nuvolaplayer.fenryxo.cz/contribute/development/service_integration.html

Finally, code review: Great, no fixes necessary.

review: Needs Information

[lp:~minchal/nuvola-player/integration-deezer]

575. By Michał Pawłowski on 2012-10-02

legal stuff

[Michał Pawłowski (minchal)]

data/nuvolaplayer/services/deezer/icon.png:
I made it quickly from /usr/share/nuvolaplayer/services/grooveshark/icon.png
and http://www.deezer.com/favicon.ico, so I don't know what is its license. I have not saved source file from GIMP.

data/nuvolaplayer/services/deezer/integration.js:
I copied file header form grooveshark/integration.js. Ofcourse, it can be BSD license. I made commit with new header to repo.

data/nuvolaplayer/services/deezer/metadata.conf:
fixed.

[Jiří Janoušek (fenryxo)]

> data/nuvolaplayer/services/deezer/icon.png:
> I made it quickly from /usr/share/nuvolaplayer/services/grooveshark/icon.png
> and http://www.deezer.com/favicon.ico, so I don't know what is its license. I have not saved source file from GIMP.

I cannot accept files with unclear copyright and license information,
so the icon has to be removed. I'll ask Alexander King - author of
other service icons - to create a new icon for Deezer then.

  review needs-fixing

review: Needs Fixing

[Jiří Janoušek (fenryxo)]

Could you remove data/nuvolaplayer/services/deezer/icon.png so I can merge your branch?

[lp:~minchal/nuvola-player/integration-deezer]

576. By Michał Pawłowski on 2012-10-13

removed icon

[Jiří Janoušek (fenryxo)]

Thanks for your work. I suggest you to subscribe to Nuvola Player Develompment mailing list to be notified about changes in Nuvola Player API and other announcements related to development.

https://launchpad.net/~nuvola-player-devel

review: Approve

=== added directory 'data/nuvolaplayer/services/deezer'
=== added file 'data/nuvolaplayer/services/deezer/description.html'
--- data/nuvolaplayer/services/deezer/description.html	1970-01-01 00:00:00 +0000
+++ data/nuvolaplayer/services/deezer/description.html	2012-10-13 12:01:22 +0000
@@ -0,0 +1,13 @@
+<div id="thumbnails">
+
+</div>
+<p><strong>Deezer</strong> is a French web-based music streaming service. 
+It allows users to listen to music on various devices online or offline. 
+It currently has 18 million licensed tracks, over 30,000 radio channels 
+and 22 million users (1.5 million subscribers).
+</p>
+<p style="text-align: center">
+<em>Source:
+<a href="http://en.wikipedia.org/wiki/Deezer">Grooveshark on Wikipedia</a>,
+<a href="http://deezer.com">Official website</a></em>
+</p>

=== added file 'data/nuvolaplayer/services/deezer/integration.js'
--- data/nuvolaplayer/services/deezer/integration.js	1970-01-01 00:00:00 +0000
+++ data/nuvolaplayer/services/deezer/integration.js	2012-10-13 12:01:22 +0000
@@ -0,0 +1,149 @@
+/**
+ * Nuvola Player :: Deezer integration
+ * 
+ * This script uses jQuery, that is already included on Deezer website.
+ * 
+ * Copyright 2012 Michał Pawłowski <[e-mail]>
+ * 
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met: 
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer. 
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution. 
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/* Anonymous function is used not to pollute environment */
+(function(Nuvola){
+	var Integration = function(){
+		this.name = "deezer";
+		this.can_thumbs_down = null;
+		this.can_prev = null;
+		this.can_next = null;
+		this.last_art = null;
+		this.last_song = null;
+		this.update();
+		Nuvola.onMessageReceived = Nuvola.bind(this, this.messageHandler);
+	};
+	
+	Integration.prototype.update = function() {
+		var state = Nuvola.STATE_NONE;
+		var can_prev;
+		var can_next;
+		var can_thumbs_down;
+		
+		try{
+			var play  = $('#h_play a');
+			var pause = $('#h_pause a');
+			
+			if (play.is(':visible')) {
+				state = Nuvola.STATE_PAUSED;
+			} else if (pause.is(':visible')) {
+				state = Nuvola.STATE_PLAYING;
+			}
+			
+			if(state != Nuvola.STATE_NONE){
+				can_prev = !$('#h_previous a').hasClass('disabled');
+				can_next = !$('#h_next a').hasClass('disabled');
+				
+				var td_btn = $('#like_track.bad-song');
+				can_thumbs_down = td_btn.length>0 && td_btn.is(':visible');
+			} else{
+				can_prev = can_next = can_thumbs_down = false;
+			}
+			
+		} catch(e){
+			state = Nuvola.STATE_NONE;
+			can_prev = can_next = can_thumbs_down = false;
+		}
+		
+		var song   = $('#current-track').text();
+		var artist = $('#current-artist').text();
+		var last_song = song + '-' + artist;
+		
+		// album art - only on radio mode
+		// remembered to next song change, when user changes tabs 
+		// in main menu, album art shouldn't change to null
+		if (this.last_song != last_song) {
+			this.last_art = null;
+		}
+		
+		this.last_song = last_song;
+		
+		try {
+			var img = $('#radio_thumbs li img').first();
+			
+			if (img.length) {
+				this.last_art = img.attr('src');
+			}
+		} catch (e) {}
+		
+		// Submit data to Nuvola backend
+		Nuvola.updateSong(song, artist, null, this.last_art, state);
+		
+		// Update actions (previous song, next song)
+		if(this.can_prev !== can_prev){
+			this.can_prev = can_prev;
+			Nuvola.updateAction(Nuvola.ACTION_PREV_SONG, can_prev);
+		}
+		if(this.can_next !== can_next){
+			this.can_next = can_next;
+			Nuvola.updateAction(Nuvola.ACTION_NEXT_SONG, can_next);
+		}
+		if(this.can_thumbs_down !== can_thumbs_down){
+			this.can_thumbs_down = can_thumbs_down;
+			Nuvola.updateAction(Nuvola.ACTION_THUMBS_DOWN, can_thumbs_down);
+		}
+		
+		setTimeout(Nuvola.bind(this, this.update), 1000);
+	}
+	
+	Integration.prototype.messageHandler = function(message) {
+		try {
+			switch(message){
+				case Nuvola.ACTION_TOGGLE_PLAY:
+					if ($('#h_play a').is(':visible')) {
+						window.playercontrol.doAction('play');
+					} else {
+						window.playercontrol.doAction('pause');
+					}
+					break;
+				case Nuvola.ACTION_PLAY:
+					window.playercontrol.doAction('play');
+					break;
+				case Nuvola.ACTION_PAUSE:
+					window.playercontrol.doAction('pause');
+					break;
+				case Nuvola.ACTION_PREV_SONG:
+					window.playercontrol.doAction('prev');
+					break;
+				case Nuvola.ACTION_NEXT_SONG:
+					window.playercontrol.doAction('next');
+					break;
+				case Nuvola.ACTION_THUMBS_DOWN:
+					window.playercontrol.doAction('smartNotLike');
+					break;
+				default:
+					// Other commands are not supported
+					throw {"message": "Not supported."};
+			}
+		} catch(e){
+			throw (this.name + ": " + e.message);
+		}
+	}
+	
+	Nuvola.integration = new Integration(); // Singleton
+})(this);

=== added file 'data/nuvolaplayer/services/deezer/metadata.conf'
--- data/nuvolaplayer/services/deezer/metadata.conf	1970-01-01 00:00:00 +0000
+++ data/nuvolaplayer/services/deezer/metadata.conf	2012-10-13 12:01:22 +0000
@@ -0,0 +1,8 @@
+name = Deezer
+home_page = http://www.deezer.com
+sandbox_pattern = https?://[A-Za-z0-9_-]*\.deezer.com/
+maintainer_name = Michał Pawłowski
+maintainer_link = https://launchpad.net/~minchal
+version = 1
+flash_plugin = yes
+api_major = 2