File: ultimatelyrics.cpp

package info (click to toggle)
cantata 3.3.1.ds1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 38,300 kB
  • sloc: cpp: 105,773; perl: 1,366; xml: 723; python: 139; lex: 110; sh: 105; yacc: 78; makefile: 8
file content (218 lines) | stat: -rw-r--r-- 5,844 bytes parent folder | download
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
/*
 * Cantata
 *
 * Copyright (c) 2011-2022 Craig Drummond <craig.p.drummond@gmail.com>
 *
 */
/* This file is part of Clementine.
   Copyright 2010, David Sansome <me@davidsansome.com>

   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/>.
*/

#include "ultimatelyrics.h"
#include "gui/settings.h"
#include "support/globalstatic.h"
#include "ultimatelyricsprovider.h"
#include <QDir>
#include <QFile>
#include <QFileInfoList>
#include <QSet>
#include <QXmlStreamReader>
#include <algorithm>

GLOBAL_STATIC(UltimateLyrics, instance)

static bool compareLyricProviders(const UltimateLyricsProvider* a, const UltimateLyricsProvider* b)
{
	return a->getRelevance() < b->getRelevance();
}

static QString parseInvalidIndicator(QXmlStreamReader* reader)
{
	QString ret = reader->attributes().value("value").toString();
	reader->skipCurrentElement();
	return ret;
}

static UltimateLyricsProvider::Rule parseRule(QXmlStreamReader* reader)
{
	UltimateLyricsProvider::Rule ret;

	while (!reader->atEnd()) {
		reader->readNext();

		if (QXmlStreamReader::EndElement == reader->tokenType()) {
			break;
		}

		if (QXmlStreamReader::StartElement == reader->tokenType()) {
			if (QLatin1String("item") == reader->name()) {
				QXmlStreamAttributes attr = reader->attributes();
				if (attr.hasAttribute("tag")) {
					ret << UltimateLyricsProvider::RuleItem(attr.value("tag").toString(), QString());
				}
				else if (attr.hasAttribute("begin")) {
					ret << UltimateLyricsProvider::RuleItem(attr.value("begin").toString(), attr.value("end").toString());
				}
			}
			reader->skipCurrentElement();
		}
	}
	return ret;
}

static UltimateLyricsProvider* parseProvider(QXmlStreamReader* reader)
{
	QXmlStreamAttributes attributes = reader->attributes();

	UltimateLyricsProvider* scraper = new UltimateLyricsProvider;
	scraper->setName(attributes.value("name").toString());
	scraper->setCharset(attributes.value("charset").toString());
	scraper->setUrl(attributes.value("url").toString());

	while (!reader->atEnd()) {
		reader->readNext();

		if (QXmlStreamReader::EndElement == reader->tokenType()) {
			break;
		}

		if (QXmlStreamReader::StartElement == reader->tokenType()) {
			if (QLatin1String("extract") == reader->name()) {
				scraper->addExtractRule(parseRule(reader));
			}
			else if (QLatin1String("exclude") == reader->name()) {
				scraper->addExcludeRule(parseRule(reader));
			}
			else if (QLatin1String("invalidIndicator") == reader->name()) {
				scraper->addInvalidIndicator(parseInvalidIndicator(reader));
			}
			else if (QLatin1String("urlFormat") == reader->name()) {
				scraper->addUrlFormat(reader->attributes().value("replace").toString(), reader->attributes().value("with").toString());
				reader->skipCurrentElement();
			}
			else {
				reader->skipCurrentElement();
			}
		}
	}
	return scraper;
}

void UltimateLyrics::release()
{
	for (UltimateLyricsProvider* provider : providers) {
		delete provider;
	}
	providers.clear();
}

const QList<UltimateLyricsProvider*> UltimateLyrics::getProviders()
{
	load();
	return providers;
}

UltimateLyricsProvider* UltimateLyrics::providerByName(const QString& name) const
{
	for (UltimateLyricsProvider* provider : providers) {
		if (provider->getName() == name) {
			return provider;
		}
	}
	return nullptr;
}

UltimateLyricsProvider* UltimateLyrics::getNext(int& index)
{
	load();
	index++;
	if (index > -1 && index < providers.count()) {
		for (int i = index; i < providers.count(); ++i) {
			if (providers.at(i)->isEnabled()) {
				index = i;
				return providers.at(i);
			}
		}
	}
	return nullptr;
}

void UltimateLyrics::load()
{
	if (!providers.isEmpty()) {
		return;
	}

	QStringList files;
	QString userDir = Utils::dataDir();

	if (!userDir.isEmpty()) {
		QFileInfoList files = QDir(userDir).entryInfoList(QStringList() << QLatin1String("lyrics_*.xml"), QDir::NoDotAndDotDot | QDir::Files);
		for (const QFileInfo& f : files) {
			files.append(QFileInfo(f.absoluteFilePath()));
		}
	}

	files.append(":lyrics_providers.xml");

	QSet<QString> providerNames;

	for (const auto& f : files) {
		QFile file(f);
		if (file.open(QIODevice::ReadOnly)) {
			QXmlStreamReader reader(&file);
			while (!reader.atEnd()) {
				reader.readNext();

				if (QLatin1String("provider") == reader.name()) {
					QString name = reader.attributes().value("name").toString();

					if (!providerNames.contains(name)) {
						UltimateLyricsProvider* provider = parseProvider(&reader);
						if (provider) {
							providers << provider;
							connect(provider, SIGNAL(lyricsReady(int, QString)), this, SIGNAL(lyricsReady(int, QString)));
							providerNames.insert(name);
						}
					}
				}
			}
		}
	}

	setEnabled(Settings::self()->lyricProviders());
}

void UltimateLyrics::setEnabled(const QStringList& enabled)
{
	for (UltimateLyricsProvider* provider : providers) {
		provider->setEnabled(false);
		provider->setRelevance(0xFFFF);
	}

	int relevance = 0;
	for (const QString& p : enabled) {
		UltimateLyricsProvider* provider = providerByName(p);
		if (provider) {
			provider->setEnabled(true);
			provider->setRelevance(relevance++);
		}
	}
	std::sort(providers.begin(), providers.end(), compareLyricProviders);
	Settings::self()->saveLyricProviders(enabled);
}

#include "moc_ultimatelyrics.cpp"