File: apikeys.cpp

package info (click to toggle)
cantata 3.4.0.ds1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 20,428 kB
  • sloc: cpp: 109,584; perl: 1,366; xml: 722; python: 139; lex: 110; sh: 105; yacc: 78; makefile: 8
file content (162 lines) | stat: -rw-r--r-- 3,954 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
/*
 * Cantata
 *
 * Copyright (c) 2018-2022 Craig Drummond <craig.p.drummond@gmail.com>
 *
 * ----
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#include "apikeys.h"
#include "support/configuration.h"
#include "support/globalstatic.h"
#include <QNetworkReply>

GLOBAL_STATIC(ApiKeys, instance)

static const int constMaxLimitAge = 30 * 60;

ApiKeys::ApiKeys()
{
	defaultKeys[LastFm] = "5a854b839b10f8d46e630e8287c2299b";
	defaultKeys[FanArt] = "ee86404cb429fa27ac32a1a3c117b006";
	defaultKeys[ShoutCast] = "fa1669MuiRPorUBw";
	//defaultKeys[SoundCloud]="0cb23dce473528973ce74815bd36a334";

	queryItems[LastFm] = "api_key";
	queryItems[FanArt] = "api_key";
	queryItems[ShoutCast] = "k";
	//queryItems[SoundCloud]="client_id";
	load();
}

void ApiKeys::load()
{
	Configuration cfg("ApiKeys");
	QList<Details> keys = getDetails();

	for (const auto& k : keys) {
		set(k.srv, cfg.get(k.name, QString()));
	}
}

void ApiKeys::save()
{
	Configuration cfg("ApiKeys");
	QList<Details> keys = getDetails();

	for (const auto& k : keys) {
		if (k.key.isEmpty()) {
			cfg.remove(k.name);
		}
		else {
			cfg.set(k.name, k.key);
		}
	}
}

QList<ApiKeys::Details> ApiKeys::getDetails()
{
	QList<Details> list;
	list.append(Details(LastFm, "LastFM", userKeys[LastFm], "https://www.last.fm/api"));
	list.append(Details(FanArt, "FanArt", userKeys[FanArt], "https://fanart.tv/get-an-api-key/"));
	list.append(Details(ShoutCast, "SHOUTcast", userKeys[ShoutCast], "https://shoutcast.com/Developer"));
	//list.append(Details(SoundCloud, "Soundcloud", userKeys[SoundCloud], "https://developers.soundcloud.com/"));
	return list;
}

const QString& ApiKeys::get(Service srv)
{
	if (srv >= 0 && srv < NumServices) {
		return userKeys[srv].isEmpty() ? defaultKeys[srv] : userKeys[srv];
	}
	else {
		return defaultKeys[0];
	}
}

void ApiKeys::set(Service srv, const QString& key)
{
	if (srv >= 0 && srv < NumServices) {
		userKeys[srv] = key.trimmed();
	}
}

void ApiKeys::addKey(QUrlQuery& query, Service srv)
{
	if (srv >= 0 && srv < NumServices) {
		query.addQueryItem(queryItems[srv], get(srv));
	}
}

QString ApiKeys::addKey(const QString& url, Service srv)
{
	if (srv >= 0 && srv < NumServices) {
		if (-1 == url.indexOf("?")) {
			return url + "?" + queryItems[srv] + "=" + get(srv);
		}
		else {
			return url + "&" + queryItems[srv] + "=" + get(srv);
		}
	}
	return url;
}

void ApiKeys::setLimitReached(Service srv)
{
	limitReached.insert(get(srv), time(nullptr));
}

bool ApiKeys::isLimitReached(Service srv)
{
	time_t now = time(nullptr);

	const auto it = limitReached.find(get(srv));
	if (it != limitReached.constEnd()) {
		if ((now - it.value()) > constMaxLimitAge) {
			limitReached.erase(it);
			return false;
		}
		return true;
	}
	return false;
}

bool ApiKeys::isLimitReached(const QNetworkReply* job, Service srv)
{
	if (isLimitReached(srv)) {
		return true;
	}
	if (!job) {
		return false;
	}

	bool reached = false;
	// TODO: Error codes for services???
	// switch (srv) {
	// default:
	//     break;
	// }

	if (reached) {
		setLimitReached(srv);
		emit error(tr("The API call limit has been exceeded for %1, please try again later or register for your own API key.").arg(getDetails().at(srv).name));
	}
	return reached;
}

#include "moc_apikeys.cpp"