/* This file is part of Clementine. Copyright 2010, David Sansome Clementine is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. Clementine 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 Clementine. If not, see . */ #include "lastfmservice.h" #include "radioitem.h" #include "lastfmstationdialog.h" #include "radiomodel.h" #include "radioplaylistitem.h" #include "core/song.h" #include "core/taskmanager.h" #include "ui/iconloader.h" #include "ui/settingsdialog.h" #include #include #include #include #include #include #include #include using boost::scoped_ptr; using lastfm::XmlQuery; uint qHash(const lastfm::Track& track) { return qHash(track.title()) ^ qHash(track.artist().name()) ^ qHash(track.album().title()); } const char* LastFMService::kServiceName = "Last.fm"; const char* LastFMService::kSettingsGroup = "Last.fm"; const char* LastFMService::kAudioscrobblerClientId = "tng"; const char* LastFMService::kApiKey = "75d20fb472be99275392aefa2760ea09"; const char* LastFMService::kSecret = "d3072b60ae626be12be69448f5c46e70"; LastFMService::LastFMService(RadioModel* parent) : RadioService(kServiceName, parent), scrobbler_(NULL), station_dialog_(new LastFMStationDialog), context_menu_(new QMenu), initial_tune_(false), tune_task_id_(0), scrobbling_enabled_(false), artist_list_(NULL), tag_list_(NULL), custom_list_(NULL), friends_list_(NULL), neighbours_list_(NULL) { ReloadSettings(); play_action_ = context_menu_->addAction( IconLoader::Load("media-playback-start"), tr("Add to playlist"), this, SLOT(AddToPlaylist())); load_action_ = context_menu_->addAction( IconLoader::Load("media-playback-start"), tr("Load"), this, SLOT(LoadToPlaylist())); remove_action_ = context_menu_->addAction( IconLoader::Load("list-remove"), tr("Remove"), this, SLOT(Remove())); context_menu_->addSeparator(); add_artist_action_ = context_menu_->addAction( QIcon(":last.fm/icon_radio.png"), tr("Play artist radio..."), this, SLOT(AddArtistRadio())); add_tag_action_ = context_menu_->addAction( QIcon(":last.fm/icon_tag.png"), tr("Play tag radio..."), this, SLOT(AddTagRadio())); add_custom_action_ = context_menu_->addAction( QIcon(":last.fm/icon_radio.png"), tr("Play custom radio..."), this, SLOT(AddCustomRadio())); context_menu_->addAction( IconLoader::Load("configure"), tr("Configure Last.fm..."), this, SLOT(ShowConfig())); remove_action_->setEnabled(false); add_artist_action_->setEnabled(false); add_tag_action_->setEnabled(false); add_custom_action_->setEnabled(false); } LastFMService::~LastFMService() { } void LastFMService::ReloadSettings() { QSettings settings; settings.beginGroup(kSettingsGroup); lastfm::ws::Username = settings.value("Username").toString(); lastfm::ws::SessionKey = settings.value("Session").toString(); scrobbling_enabled_ = settings.value("ScrobblingEnabled", true).toBool(); buttons_visible_ = settings.value("ShowLoveBanButtons", true).toBool(); emit ScrobblingEnabledChanged(scrobbling_enabled_); emit ButtonVisibilityChanged(buttons_visible_); } void LastFMService::ShowConfig() { emit OpenSettingsAtPage(SettingsDialog::Page_Lastfm); } bool LastFMService::IsAuthenticated() const { return !lastfm::ws::SessionKey.isEmpty(); } RadioItem* LastFMService::CreateRootItem(RadioItem* parent) { RadioItem* item = new RadioItem(this, RadioItem::Type_Service, kServiceName, parent); item->icon = QIcon(":last.fm/as.png"); return item; } void LastFMService::LazyPopulate(RadioItem *item) { switch (item->type) { case RadioItem::Type_Service: // Normal radio types CreateStationItem(Type_MyRecommendations, tr("My Recommendations"), ":last.fm/recommended_radio.png", item); CreateStationItem(Type_MyRadio, tr("My Radio Station"), ":last.fm/personal_radio.png", item); CreateStationItem(Type_MyMix, tr("My Mix Radio"), ":last.fm/loved_radio.png", item); CreateStationItem(Type_MyNeighbourhood, tr("My Neighborhood"), ":last.fm/neighbour_radio.png", item); // Types that have children artist_list_ = new RadioItem(this, Type_ArtistRadio, tr("Artist radio"), item); artist_list_->icon = QIcon(":last.fm/icon_radio.png"); artist_list_->lazy_loaded = true; tag_list_ = new RadioItem(this, Type_TagRadio, tr("Tag radio"), item); tag_list_->icon = QIcon(":last.fm/icon_tag.png"); tag_list_->lazy_loaded = true; custom_list_ = new RadioItem(this, Type_CustomRadio, tr("Custom radio"), item); custom_list_->icon = QIcon(":last.fm/icon_radio.png"); custom_list_->lazy_loaded = true; RestoreList("artists", Type_Artist, QIcon(":last.fm/icon_radio.png"), artist_list_); RestoreList("tags", Type_Tag, QIcon(":last.fm/icon_tag.png"), tag_list_); RestoreList("custom", Type_Custom, QIcon(":last.fm/icon_radio.png"), custom_list_); friends_list_ = new RadioItem(this, Type_MyFriends, tr("Friends"), item); friends_list_->icon = QIcon(":last.fm/my_friends.png"); neighbours_list_ = new RadioItem(this, Type_MyNeighbours, tr("Neighbors"), item); neighbours_list_->icon = QIcon(":last.fm/my_neighbours.png"); if (!IsAuthenticated()) ShowConfig(); add_artist_action_->setEnabled(true); add_tag_action_->setEnabled(true); add_custom_action_->setEnabled(true); break; case Type_MyFriends: RefreshFriends(); break; case Type_MyNeighbours: RefreshNeighbours(); break; case Type_OtherUser: CreateStationItem(Type_OtherUserRadio, item->key, ":last.fm/recommended_radio.png", item) ->display_text = tr("Last.fm Radio Station - %1").arg(item->key); CreateStationItem(Type_OtherUserMix, item->key, ":last.fm/loved_radio.png", item) ->display_text = tr("Last.fm Mix Radio - %1").arg(item->key); CreateStationItem(Type_OtherUserNeighbourhood, item->key, ":last.fm/neighbour_radio.png", item) ->display_text = tr("Last.fm Neighbor Radio - %1").arg(item->key); break; default: break; } item->lazy_loaded = true; } RadioItem* LastFMService::CreateStationItem(ItemType type, const QString& name, const QString& icon, RadioItem* parent) { RadioItem* ret = new RadioItem(this, type, name, parent); ret->lazy_loaded = true; ret->icon = QIcon(icon); ret->playable = true; return ret; } void LastFMService::Authenticate(const QString& username, const QString& password) { QMap params; params["method"] = "auth.getMobileSession"; params["username"] = username; params["authToken"] = lastfm::md5((username + lastfm::md5(password.toUtf8())).toUtf8()); QNetworkReply* reply = lastfm::ws::post(params); connect(reply, SIGNAL(finished()), SLOT(AuthenticateReplyFinished())); } void LastFMService::SignOut() { lastfm::ws::Username.clear(); lastfm::ws::SessionKey.clear(); QSettings settings; settings.beginGroup(kSettingsGroup); settings.setValue("Username", QString()); settings.setValue("Session", QString()); } void LastFMService::AuthenticateReplyFinished() { QNetworkReply* reply = qobject_cast(sender()); if (!reply) { emit AuthenticationComplete(false); return; } // Parse the reply try { lastfm::XmlQuery const lfm = lastfm::ws::parse(reply); #ifdef Q_OS_WIN32 if (lastfm::ws::last_parse_error != lastfm::ws::NoError) throw std::runtime_error(""); #endif lastfm::ws::Username = lfm["session"]["name"].text(); lastfm::ws::SessionKey = lfm["session"]["key"].text(); } catch (std::runtime_error& e) { qDebug() << e.what(); emit AuthenticationComplete(false); return; } // Save the session key QSettings settings; settings.beginGroup(kSettingsGroup); settings.setValue("Username", lastfm::ws::Username); settings.setValue("Session", lastfm::ws::SessionKey); // Invalidate the scrobbler - it will get recreated later delete scrobbler_; scrobbler_ = NULL; emit AuthenticationComplete(true); } QUrl LastFMService::UrlForItem(const RadioItem* item) const { switch (item->type) { case Type_MyRecommendations: return "lastfm://user/" + lastfm::ws::Username + "/recommended"; case Type_MyMix: return QString("lastfm://rql/") + QString("adv:" + lastfm::ws::Username).toUtf8().toBase64(); case Type_MyNeighbourhood: return "lastfm://user/" + lastfm::ws::Username + "/neighbours"; case Type_MyRadio: return "lastfm://user/" + lastfm::ws::Username + "/library"; case Type_OtherUser: case Type_OtherUserRadio: return "lastfm://user/" + item->key + "/library"; case Type_OtherUserMix: return QString("lastfm://rql/") + QString("adv:" + item->key).toUtf8().toBase64(); case Type_OtherUserNeighbourhood: return "lastfm://user/" + item->key + "/neighbours"; case Type_Artist: return "lastfm://artist/" + item->key + "/similarartists"; case Type_Tag: return "lastfm://globaltags/" + item->key; case Type_Custom: return QString("lastfm://rql/" + item->key.toUtf8().toBase64()); } return QUrl(); } QString LastFMService::TitleForItem(const RadioItem* item) const { const QString me(lastfm::ws::Username); switch (item->type) { case Type_MyRecommendations: return tr("Last.fm Recommended Radio - %1").arg(me); case Type_MyMix: return tr("Last.fm Mix Radio - %1").arg(me); case Type_MyNeighbourhood: return tr("Last.fm Neighbor Radio - %1").arg(me); case Type_MyRadio: return tr("Last.fm Library - %1").arg(me); case Type_OtherUser: case Type_OtherUserRadio: return tr("Last.fm Library - %1").arg(item->key); case Type_OtherUserMix: return tr("Last.fm Mix Radio - %1").arg(item->key); case Type_OtherUserNeighbourhood: return tr("Last.fm Neighbor Radio - %1").arg(item->key); case Type_Artist: return tr("Last.fm Similar Artists to %1").arg(item->key); case Type_Tag: return tr("Last.fm Tag Radio: %1").arg(item->key); case Type_Custom: return tr("Last.fm Custom Radio: %1").arg(item->key); } return QString(); } PlaylistItem::SpecialLoadResult LastFMService::StartLoading(const QUrl& url) { if (url.scheme() != "lastfm") return PlaylistItem::SpecialLoadResult(); if (!IsAuthenticated()) return PlaylistItem::SpecialLoadResult(); if (!tune_task_id_) tune_task_id_ = model()->task_manager()->StartTask(tr("Loading Last.fm radio")); last_url_ = url; initial_tune_ = true; Tune(lastfm::RadioStation(url)); return PlaylistItem::SpecialLoadResult( PlaylistItem::SpecialLoadResult::WillLoadAsynchronously, url); } PlaylistItem::SpecialLoadResult LastFMService::LoadNext(const QUrl &) { if (playlist_.empty()) { return PlaylistItem::SpecialLoadResult(); } lastfm::MutableTrack track = playlist_.dequeue(); track.stamp(); last_track_ = track; if (playlist_.empty()) { FetchMoreTracks(); } next_metadata_ = track; StreamMetadataReady(); return PlaylistItem::SpecialLoadResult( PlaylistItem::SpecialLoadResult::TrackAvailable, last_url_, last_track_.url()); } void LastFMService::StreamMetadataReady() { Song metadata; metadata.InitFromLastFM(next_metadata_); if (art_urls_.contains(next_metadata_)) metadata.set_art_automatic(art_urls_[next_metadata_]); emit StreamMetadataFound(last_url_, metadata); } void LastFMService::TunerError(lastfm::ws::Error error) { qDebug() << "Last.fm error" << error; if (!initial_tune_) return; model()->task_manager()->SetTaskFinished(tune_task_id_); tune_task_id_ = 0; if (error == lastfm::ws::NotEnoughContent) { emit AsyncLoadFinished(PlaylistItem::SpecialLoadResult( PlaylistItem::SpecialLoadResult::NoMoreTracks, last_url_)); return; } emit StreamError(ErrorString(error)); } QString LastFMService::ErrorString(lastfm::ws::Error error) const { switch (error) { case lastfm::ws::InvalidService: return tr("Invalid service"); case lastfm::ws::InvalidMethod: return tr("Invalid method"); case lastfm::ws::AuthenticationFailed: return tr("Authentication failed"); case lastfm::ws::InvalidFormat: return tr("Invalid format"); case lastfm::ws::InvalidParameters: return tr("Invalid parameters"); case lastfm::ws::InvalidResourceSpecified: return tr("Invalid resource specified"); case lastfm::ws::OperationFailed: return tr("Operation failed"); case lastfm::ws::InvalidSessionKey: return tr("Invalid session key"); case lastfm::ws::InvalidApiKey: return tr("Invalid API key"); case lastfm::ws::ServiceOffline: return tr("Service offline"); case lastfm::ws::SubscribersOnly: return tr("This stream is for paid subscribers only"); case lastfm::ws::TryAgainLater: return tr("Last.fm is currently busy, please try again in a few minutes"); case lastfm::ws::NotEnoughContent: return tr("Not enough content"); case lastfm::ws::NotEnoughMembers: return tr("Not enough members"); case lastfm::ws::NotEnoughFans: return tr("Not enough fans"); case lastfm::ws::NotEnoughNeighbours: return tr("Not enough neighbors"); case lastfm::ws::MalformedResponse: return tr("Malformed response"); case lastfm::ws::UnknownError: default: return tr("Unknown error"); } } void LastFMService::TunerTrackAvailable() { if (initial_tune_) { emit AsyncLoadFinished(LoadNext(last_url_)); initial_tune_ = false; } } bool LastFMService::InitScrobbler() { if (!IsAuthenticated() || !IsScrobblingEnabled()) return false; if (!scrobbler_) scrobbler_ = new lastfm::Audioscrobbler(kAudioscrobblerClientId); return true; } lastfm::Track LastFMService::TrackFromSong(const Song &song) const { if (song.title() == last_track_.title() && song.artist() == last_track_.artist() && song.album() == last_track_.album()) return last_track_; lastfm::Track ret; song.ToLastFM(&ret); return ret; } void LastFMService::NowPlaying(const Song &song) { if (!InitScrobbler()) return; last_track_ = TrackFromSong(song); lastfm::MutableTrack mtrack(last_track_); mtrack.stamp(); last_track_ = mtrack; scrobbler_->nowPlaying(mtrack); } void LastFMService::Scrobble() { if (!InitScrobbler()) return; scrobbler_->cache(last_track_); scrobbler_->submit(); } void LastFMService::Love() { if (!IsAuthenticated()) ShowConfig(); lastfm::MutableTrack mtrack(last_track_); mtrack.love(); last_track_ = mtrack; } void LastFMService::Ban() { lastfm::MutableTrack mtrack(last_track_); mtrack.ban(); last_track_ = mtrack; Scrobble(); emit AsyncLoadFinished(LoadNext(last_url_)); } void LastFMService::ShowContextMenu(RadioItem* item, const QModelIndex&, const QPoint &global_pos) { context_item_ = item; switch (item->type) { case Type_Artist: case Type_Tag: case Type_Custom: remove_action_->setEnabled(true); break; default: remove_action_->setEnabled(false); break; } play_action_->setEnabled(item->playable); load_action_->setEnabled(item->playable); context_menu_->popup(global_pos); } void LastFMService::RefreshFriends() { if (!friends_list_ || !IsAuthenticated()) return; friends_list_->ClearNotify(); lastfm::AuthenticatedUser user; QNetworkReply* reply = user.getFriends(); connect(reply, SIGNAL(finished()), SLOT(RefreshFriendsFinished())); } void LastFMService::RefreshNeighbours() { if (!friends_list_ || !IsAuthenticated()) return; neighbours_list_->ClearNotify(); lastfm::AuthenticatedUser user; QNetworkReply* reply = user.getNeighbours(); connect(reply, SIGNAL(finished()), SLOT(RefreshNeighboursFinished())); } void LastFMService::RefreshFriendsFinished() { QNetworkReply* reply = qobject_cast(sender()); if (!reply) return; QList friends; try { friends = lastfm::User::list(reply); #ifdef Q_OS_WIN32 if (lastfm::ws::last_parse_error != lastfm::ws::NoError) throw std::runtime_error(""); #endif } catch (std::runtime_error& e) { qDebug() << e.what(); return; } foreach (const lastfm::User& f, friends) { RadioItem* item = new RadioItem(this, Type_OtherUser, f); item->icon = QIcon(":last.fm/icon_user.png"); item->playable = true; item->InsertNotify(friends_list_); } } void LastFMService::RefreshNeighboursFinished() { QNetworkReply* reply = qobject_cast(sender()); if (!reply) return; QList neighbours; try { neighbours = lastfm::User::list(reply); #ifdef Q_OS_WIN32 if (lastfm::ws::last_parse_error != lastfm::ws::NoError) throw std::runtime_error(""); #endif } catch (std::runtime_error& e) { qDebug() << e.what(); return; } foreach (const lastfm::User& n, neighbours) { RadioItem* item = new RadioItem(this, Type_OtherUser, n); item->icon = QIcon(":last.fm/user_purple.png"); item->playable = true; item->InsertNotify(neighbours_list_); } } void LastFMService::AddToPlaylist() { emit AddItemToPlaylist(context_item_, false); } void LastFMService::LoadToPlaylist() { emit AddItemToPlaylist(context_item_, true); } void LastFMService::AddArtistRadio() { AddArtistOrTag("artists", LastFMStationDialog::Artist, Type_Artist, QIcon(":last.fm/icon_radio.png"), artist_list_); } void LastFMService::AddTagRadio() { AddArtistOrTag("tags", LastFMStationDialog::Tag, Type_Tag, QIcon(":last.fm/icon_tag.png"), tag_list_); } void LastFMService::AddCustomRadio() { AddArtistOrTag("custom", LastFMStationDialog::Custom, Type_Custom, QIcon(":last.fm/icon_radio.png"), custom_list_); } void LastFMService::AddArtistOrTag(const QString& name, LastFMStationDialog::Type dialog_type, ItemType item_type, const QIcon& icon, RadioItem* list) { station_dialog_->SetType(dialog_type); if (station_dialog_->exec() == QDialog::Rejected) return; if (station_dialog_->content().isEmpty()) return; RadioItem* item = new RadioItem(this, item_type, station_dialog_->content()); item->icon = icon; item->playable = true; item->lazy_loaded = true; item->InsertNotify(list); emit AddItemToPlaylist(item, false); SaveList(name, list); } void LastFMService::SaveList(const QString& name, RadioItem* list) const { QSettings settings; settings.beginGroup(kSettingsGroup); settings.beginWriteArray(name, list->children.count()); for (int i=0 ; ichildren.count() ; ++i) { settings.setArrayIndex(i); settings.setValue("key", list->children[i]->key); } settings.endArray(); } void LastFMService::RestoreList(const QString &name, ItemType item_type, const QIcon& icon, RadioItem *list) { QSettings settings; settings.beginGroup(kSettingsGroup); list->ClearNotify(); int count = settings.beginReadArray(name); for (int i=0 ; iicon = icon; item->playable = true; item->lazy_loaded = true; } settings.endArray(); } void LastFMService::Remove() { int type = context_item_->type; context_item_->parent->DeleteNotify(context_item_->row); if (type == Type_Artist) SaveList("artists", artist_list_); else if (type == Type_Tag) SaveList("tags", tag_list_); else if (type == Type_Custom) SaveList("custom", custom_list_); } void LastFMService::FetchMoreTracks() { QMap params; params["method"] = "radio.getPlaylist"; params["rtp"] = "1"; QNetworkReply* reply = lastfm::ws::post(params); connect(reply, SIGNAL(finished()), SLOT(FetchMoreTracksFinished())); } void LastFMService::FetchMoreTracksFinished() { QNetworkReply* reply = qobject_cast(sender()); if (!reply) { qWarning() << "Invalid reply on radio.getPlaylist"; emit AsyncLoadFinished(PlaylistItem::SpecialLoadResult( PlaylistItem::SpecialLoadResult::NoMoreTracks, reply->url())); return; } reply->deleteLater(); model()->task_manager()->SetTaskFinished(tune_task_id_); tune_task_id_ = 0; try { const XmlQuery& query = lastfm::ws::parse(reply); #ifdef Q_OS_WIN32 if (lastfm::ws::last_parse_error != lastfm::ws::NoError) throw std::runtime_error(""); #endif const XmlQuery& playlist = query["playlist"]; foreach (const XmlQuery& q, playlist["trackList"].children("track")) { lastfm::MutableTrack t; t.setUrl(q["location"].text()); t.setExtra("trackauth", q["extension"]["trackauth"].text()); t.setTitle(q["title"].text()); t.setArtist(q["creator"].text()); t.setAlbum(q["album"].text()); t.setDuration(q["duration"].text().toInt() / 1000); t.setSource(lastfm::Track::LastFmRadio); art_urls_[t] = q["image"].text(); playlist_ << t; } } catch (std::runtime_error& e) { // For some reason a catch block that takes a lastfm::ws::ParseError& // doesn't get called, even when a lastfm::ws::ParseError is thrown... // Hacks like this remind me of Java... if (QString(typeid(e).name()).contains("ParseError")) { // dynamic_cast throws a std::bad_cast ... *boggle* emit StreamError(tr("Couldn't load the last.fm radio station") .arg(e.what())); } else { emit StreamError(tr("An unknown last.fm error occurred: %1").arg(e.what())); } return; } TunerTrackAvailable(); } void LastFMService::Tune(const lastfm::RadioStation& station) { playlist_.clear(); // Remove all the old album art URLs art_urls_.clear(); QMap params; params["method"] = "radio.tune"; params["station"] = station.url(); QNetworkReply* reply = lastfm::ws::post(params); connect(reply, SIGNAL(finished()), SLOT(TuneFinished())); } void LastFMService::TuneFinished() { QNetworkReply* reply = qobject_cast(sender()); if (!reply) { qWarning() << "Invalid reply on radio.tune"; emit AsyncLoadFinished(PlaylistItem::SpecialLoadResult( PlaylistItem::SpecialLoadResult::NoMoreTracks, reply->url())); return; } FetchMoreTracks(); reply->deleteLater(); } PlaylistItem::Options LastFMService::playlistitem_options() const { return PlaylistItem::SpecialPlayBehaviour | PlaylistItem::LastFMControls | PlaylistItem::PauseDisabled | PlaylistItem::ContainsMultipleTracks; } PlaylistItemPtr LastFMService::PlaylistItemForUrl(const QUrl& url) { // This is a bit of a hack, it's only used by the artist/song info tag // widgets for tag radio and similar artists radio. PlaylistItemPtr ret; if (url.scheme() != "lastfm") return ret; QStringList sections(url.path().split("/", QString::SkipEmptyParts)); if (sections.count() == 2 && url.host() == "artist" && sections[1] == "similarartists") { ret.reset(new RadioPlaylistItem(this, url, tr("Last.fm Similar Artists to %1").arg(sections[0]), QString())); } else if (sections.count() == 1 && url.host() == "globaltags") { ret.reset(new RadioPlaylistItem(this, url, tr("Last.fm Tag Radio: %1").arg(sections[0]), QString())); } return ret; }