2010-09-26 16:21:23 +02:00
|
|
|
/* This file is part of Clementine.
|
2010-11-20 14:27:10 +01:00
|
|
|
Copyright 2010, David Sansome <me@davidsansome.com>
|
2010-09-26 16:21:23 +02:00
|
|
|
|
|
|
|
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 <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
2010-10-16 16:11:23 +02:00
|
|
|
#include "songinfotextview.h"
|
2010-10-10 18:09:20 +02:00
|
|
|
#include "ultimatelyricsprovider.h"
|
2010-10-16 19:20:54 +02:00
|
|
|
#include "core/network.h"
|
2010-09-26 16:21:23 +02:00
|
|
|
|
|
|
|
#include <QNetworkReply>
|
|
|
|
#include <QTextCodec>
|
|
|
|
|
|
|
|
#include <boost/scoped_ptr.hpp>
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
const int UltimateLyricsProvider::kRedirectLimit = 5;
|
2010-09-26 16:21:23 +02:00
|
|
|
|
|
|
|
|
2010-10-16 19:20:54 +02:00
|
|
|
UltimateLyricsProvider::UltimateLyricsProvider()
|
|
|
|
: network_(new NetworkAccessManager(this)),
|
2010-10-10 18:46:35 +02:00
|
|
|
relevance_(0),
|
2010-10-10 18:09:20 +02:00
|
|
|
redirect_count_(0)
|
2010-09-26 16:21:23 +02:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
void UltimateLyricsProvider::FetchInfo(int id, const Song& metadata) {
|
2010-09-26 16:21:23 +02:00
|
|
|
// Get the text codec
|
|
|
|
const QTextCodec* codec = QTextCodec::codecForName(charset_.toAscii().constData());
|
|
|
|
if (!codec) {
|
|
|
|
qWarning() << "Invalid codec" << charset_;
|
2010-10-10 18:09:20 +02:00
|
|
|
emit Finished(id);
|
|
|
|
return;
|
2010-09-26 16:21:23 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// Fill in fields in the URL
|
|
|
|
QString url_text(url_);
|
2010-09-26 19:30:17 +02:00
|
|
|
DoUrlReplace("{artist}", metadata.artist().toLower(), &url_text);
|
|
|
|
DoUrlReplace("{album}", metadata.album().toLower(), &url_text);
|
|
|
|
DoUrlReplace("{title}", metadata.title().toLower(), &url_text);
|
|
|
|
DoUrlReplace("{Artist}", metadata.artist(), &url_text);
|
|
|
|
DoUrlReplace("{Album}", metadata.album(), &url_text);
|
|
|
|
DoUrlReplace("{Title}", metadata.title(), &url_text);
|
|
|
|
DoUrlReplace("{Title2}", TitleCase(metadata.title()), &url_text);
|
|
|
|
DoUrlReplace("{a}", FirstChar(metadata.artist()), &url_text);
|
2010-09-26 16:21:23 +02:00
|
|
|
|
|
|
|
QUrl url(url_text);
|
|
|
|
|
|
|
|
// Fetch the URL, follow redirects
|
2010-10-10 18:09:20 +02:00
|
|
|
redirect_count_ = 0;
|
2010-10-16 19:20:54 +02:00
|
|
|
QNetworkReply* reply = network_->get(QNetworkRequest(url));
|
|
|
|
requests_[reply] = id;
|
|
|
|
connect(reply, SIGNAL(finished()), SLOT(LyricsFetched()));
|
2010-10-10 18:09:20 +02:00
|
|
|
}
|
2010-09-26 16:21:23 +02:00
|
|
|
|
2010-10-16 19:20:54 +02:00
|
|
|
void UltimateLyricsProvider::LyricsFetched() {
|
|
|
|
QNetworkReply* reply = qobject_cast<QNetworkReply*>(sender());
|
|
|
|
if (!reply)
|
|
|
|
return;
|
|
|
|
|
|
|
|
int id = requests_.take(reply);
|
2010-10-10 18:09:20 +02:00
|
|
|
reply->deleteLater();
|
2010-09-26 16:21:23 +02:00
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
if (reply->error() != QNetworkReply::NoError) {
|
|
|
|
emit Finished(id);
|
|
|
|
return;
|
|
|
|
}
|
2010-09-26 16:21:23 +02:00
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
// Handle redirects
|
|
|
|
QVariant redirect_target = reply->attribute(QNetworkRequest::RedirectionTargetAttribute);
|
|
|
|
if (redirect_target.isValid()) {
|
|
|
|
if (redirect_count_ >= kRedirectLimit) {
|
|
|
|
emit Finished(id);
|
|
|
|
return;
|
|
|
|
}
|
2010-09-26 19:30:17 +02:00
|
|
|
|
|
|
|
QUrl target = redirect_target.toUrl();
|
|
|
|
if (target.scheme().isEmpty() || target.host().isEmpty()) {
|
|
|
|
QString path = target.path();
|
2010-10-10 18:09:20 +02:00
|
|
|
target = reply->url();
|
2010-09-26 19:30:17 +02:00
|
|
|
target.setPath(path);
|
|
|
|
}
|
2010-10-10 18:09:20 +02:00
|
|
|
|
|
|
|
redirect_count_ ++;
|
2010-10-16 19:20:54 +02:00
|
|
|
QNetworkReply* reply = network_->get(QNetworkRequest(target));
|
|
|
|
requests_[reply] = id;
|
|
|
|
connect(reply, SIGNAL(finished()), SLOT(LyricsFetched()));
|
2010-10-10 18:09:20 +02:00
|
|
|
return;
|
2010-09-26 16:21:23 +02:00
|
|
|
}
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
const QTextCodec* codec = QTextCodec::codecForName(charset_.toAscii().constData());
|
2010-09-26 16:21:23 +02:00
|
|
|
const QString original_content = codec->toUnicode(reply->readAll());
|
2010-10-10 18:09:20 +02:00
|
|
|
QString lyrics;
|
2010-09-26 16:21:23 +02:00
|
|
|
|
|
|
|
// Check for invalid indicators
|
|
|
|
foreach (const QString& indicator, invalid_indicators_) {
|
2010-10-10 18:09:20 +02:00
|
|
|
if (original_content.contains(indicator)) {
|
|
|
|
emit Finished(id);
|
|
|
|
return;
|
|
|
|
}
|
2010-09-26 16:21:23 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// Apply extract rules
|
|
|
|
foreach (const Rule& rule, extract_rules_) {
|
|
|
|
QString content = original_content;
|
|
|
|
ApplyExtractRule(rule, &content);
|
|
|
|
|
|
|
|
if (!content.isEmpty())
|
2010-10-10 18:09:20 +02:00
|
|
|
lyrics = content;
|
2010-09-26 16:21:23 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// Apply exclude rules
|
|
|
|
foreach (const Rule& rule, exclude_rules_) {
|
2010-10-10 18:09:20 +02:00
|
|
|
ApplyExcludeRule(rule, &lyrics);
|
2010-09-26 16:21:23 +02:00
|
|
|
}
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
if (!lyrics.isEmpty()) {
|
|
|
|
CollapsibleInfoPane::Data data;
|
2010-10-11 21:49:12 +02:00
|
|
|
data.id_ = "ultimatelyrics/" + name_;
|
2010-10-10 18:09:20 +02:00
|
|
|
data.title_ = tr("Lyrics from %1").arg(name_);
|
|
|
|
data.type_ = CollapsibleInfoPane::Data::Type_Lyrics;
|
2010-10-16 14:56:58 +02:00
|
|
|
data.relevance_ = relevance();
|
2010-10-10 18:09:20 +02:00
|
|
|
|
2010-10-16 16:11:23 +02:00
|
|
|
SongInfoTextView* editor = new SongInfoTextView;
|
2010-10-16 18:16:22 +02:00
|
|
|
editor->SetHtml(lyrics);
|
2010-10-10 18:09:20 +02:00
|
|
|
data.contents_ = editor;
|
|
|
|
|
|
|
|
emit InfoReady(id, data);
|
|
|
|
}
|
|
|
|
emit Finished(id);
|
2010-09-26 16:21:23 +02:00
|
|
|
}
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
void UltimateLyricsProvider::ApplyExtractRule(const Rule& rule, QString* content) const {
|
2010-09-26 16:21:23 +02:00
|
|
|
foreach (const RuleItem& item, rule) {
|
|
|
|
if (item.second.isNull()) {
|
|
|
|
*content = ExtractXmlTag(*content, item.first);
|
|
|
|
} else {
|
|
|
|
*content = Extract(*content, item.first, item.second);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
QString UltimateLyricsProvider::ExtractXmlTag(const QString& source, const QString& tag) {
|
2010-09-26 19:30:17 +02:00
|
|
|
QRegExp re("<(\\w+).*>"); // ಠ_ಠ
|
2010-09-26 16:21:23 +02:00
|
|
|
if (re.indexIn(tag) == -1)
|
|
|
|
return QString();
|
|
|
|
|
|
|
|
return Extract(source, tag, "</" + re.cap(1) + ">");
|
|
|
|
}
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
QString UltimateLyricsProvider::Extract(const QString& source, const QString& begin, const QString& end) {
|
2010-09-26 16:21:23 +02:00
|
|
|
int begin_idx = source.indexOf(begin);
|
|
|
|
if (begin_idx == -1)
|
|
|
|
return QString();
|
|
|
|
begin_idx += begin.length();
|
|
|
|
|
|
|
|
int end_idx = source.indexOf(end, begin_idx);
|
|
|
|
if (end_idx == -1)
|
|
|
|
return QString();
|
|
|
|
|
|
|
|
return source.mid(begin_idx, end_idx - begin_idx - 1);
|
|
|
|
}
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
void UltimateLyricsProvider::ApplyExcludeRule(const Rule& rule, QString* content) const {
|
2010-09-26 16:21:23 +02:00
|
|
|
foreach (const RuleItem& item, rule) {
|
|
|
|
if (item.second.isNull()) {
|
|
|
|
*content = ExcludeXmlTag(*content, item.first);
|
|
|
|
} else {
|
|
|
|
*content = Exclude(*content, item.first, item.second);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
QString UltimateLyricsProvider::ExcludeXmlTag(const QString& source, const QString& tag) {
|
2010-09-26 19:30:17 +02:00
|
|
|
QRegExp re("<(\\w+).*>"); // ಠ_ಠ
|
2010-09-26 16:21:23 +02:00
|
|
|
if (re.indexIn(tag) == -1)
|
|
|
|
return source;
|
|
|
|
|
|
|
|
return Exclude(source, tag, "</" + re.cap(1) + ">");
|
|
|
|
}
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
QString UltimateLyricsProvider::Exclude(const QString& source, const QString& begin, const QString& end) {
|
2010-09-26 16:21:23 +02:00
|
|
|
int begin_idx = source.indexOf(begin);
|
|
|
|
if (begin_idx == -1)
|
|
|
|
return source;
|
|
|
|
|
|
|
|
int end_idx = source.indexOf(end, begin_idx + begin.length());
|
|
|
|
if (end_idx == -1)
|
|
|
|
return source;
|
|
|
|
|
|
|
|
return source.left(begin_idx) + source.right(source.length() - end_idx - end.length());
|
|
|
|
}
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
QString UltimateLyricsProvider::FirstChar(const QString& text) {
|
2010-09-26 16:21:23 +02:00
|
|
|
if (text.isEmpty())
|
|
|
|
return QString();
|
|
|
|
return text[0].toLower();
|
|
|
|
}
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
QString UltimateLyricsProvider::TitleCase(const QString& text) {
|
2010-09-26 16:21:23 +02:00
|
|
|
if (text.length() == 0)
|
|
|
|
return QString();
|
|
|
|
if (text.length() == 1)
|
|
|
|
return text[0].toUpper();
|
|
|
|
return text[0].toUpper() + text.right(text.length() - 1).toLower();
|
|
|
|
}
|
|
|
|
|
2010-10-10 18:09:20 +02:00
|
|
|
void UltimateLyricsProvider::DoUrlReplace(const QString& tag, const QString& value,
|
2010-09-26 19:30:17 +02:00
|
|
|
QString* url) const {
|
2010-09-26 16:21:23 +02:00
|
|
|
if (!url->contains(tag))
|
|
|
|
return;
|
|
|
|
|
|
|
|
// Apply URL character replacement
|
|
|
|
QString value_copy(value);
|
|
|
|
foreach (const UrlFormat& format, url_formats_) {
|
|
|
|
QRegExp re("[" + QRegExp::escape(format.first) + "]");
|
|
|
|
value_copy.replace(re, format.second);
|
|
|
|
}
|
|
|
|
|
|
|
|
url->replace(tag, value_copy, Qt::CaseInsensitive);
|
|
|
|
}
|