File indexing completed on 2024-05-12 05:09:35
0001 /*************************************************************************** 0002 Copyright (C) 2017-2020 Robby Stephenson <robby@periapsis.org> 0003 ***************************************************************************/ 0004 0005 /*************************************************************************** 0006 * * 0007 * This program is free software; you can redistribute it and/or * 0008 * modify it under the terms of the GNU General Public License as * 0009 * published by the Free Software Foundation; either version 2 of * 0010 * the License or (at your option) version 3 or any later version * 0011 * accepted by the membership of KDE e.V. (or its successor approved * 0012 * by the membership of KDE e.V.), which shall act as a proxy * 0013 * defined in Section 14 of version 3 of the license. * 0014 * * 0015 * This program is distributed in the hope that it will be useful, * 0016 * but WITHOUT ANY WARRANTY; without even the implied warranty of * 0017 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * 0018 * GNU General Public License for more details. * 0019 * * 0020 * You should have received a copy of the GNU General Public License * 0021 * along with this program. If not, see <http://www.gnu.org/licenses/>. * 0022 * * 0023 ***************************************************************************/ 0024 0025 #ifndef TELLICO_IGDBFETCHER_H 0026 #define TELLICO_IGDBFETCHER_H 0027 0028 #include "fetcher.h" 0029 #include "configwidget.h" 0030 #include "../datavectors.h" 0031 0032 #include <QLineEdit> 0033 #include <QPointer> 0034 #include <QElapsedTimer> 0035 0036 class KJob; 0037 namespace KIO { 0038 class StoredTransferJob; 0039 } 0040 0041 namespace Tellico { 0042 namespace Fetch { 0043 0044 /** 0045 * A fetcher for igdb.com 0046 * 0047 * @author Robby Stephenson 0048 */ 0049 class IGDBFetcher : public Fetcher { 0050 Q_OBJECT 0051 0052 public: 0053 /** 0054 */ 0055 IGDBFetcher(QObject* parent); 0056 /** 0057 */ 0058 virtual ~IGDBFetcher(); 0059 0060 /** 0061 */ 0062 virtual QString source() const Q_DECL_OVERRIDE; 0063 virtual QString attribution() const Q_DECL_OVERRIDE; 0064 virtual bool isSearching() const Q_DECL_OVERRIDE { return m_started; } 0065 virtual bool canSearch(FetchKey k) const Q_DECL_OVERRIDE; 0066 virtual void stop() Q_DECL_OVERRIDE; 0067 virtual Data::EntryPtr fetchEntryHook(uint uid) Q_DECL_OVERRIDE; 0068 virtual Type type() const Q_DECL_OVERRIDE { return IGDB; } 0069 virtual bool canFetch(int type) const Q_DECL_OVERRIDE; 0070 virtual void readConfigHook(const KConfigGroup& config) Q_DECL_OVERRIDE; 0071 virtual void saveConfigHook(KConfigGroup& config) Q_DECL_OVERRIDE; 0072 virtual void continueSearch() Q_DECL_OVERRIDE; 0073 0074 /** 0075 * Returns a widget for modifying the fetcher's config. 0076 */ 0077 virtual Fetch::ConfigWidget* configWidget(QWidget* parent) const Q_DECL_OVERRIDE; 0078 0079 class ConfigWidget; 0080 friend class ConfigWidget; 0081 0082 static QString defaultName(); 0083 static QString defaultIcon(); 0084 static StringHash allOptionalFields(); 0085 0086 private Q_SLOTS: 0087 void slotComplete(KJob* job); 0088 void populateHashes(); 0089 0090 private: 0091 virtual void search() Q_DECL_OVERRIDE; 0092 virtual FetchRequest updateRequest(Data::EntryPtr entry) Q_DECL_OVERRIDE; 0093 void populateEntry(Data::EntryPtr entry, const QVariantMap& resultMap); 0094 void markTime() const; 0095 void checkAccessToken(); 0096 0097 QPointer<KIO::StoredTransferJob> igdbJob(const QUrl& url, const QString& query); 0098 0099 // IGDB has three data types for which the whole list must be read at once 0100 enum IgdbDataType { Genre, Platform, Company }; 0101 static QString dataFileName(IgdbDataType dataType); 0102 0103 // update cached data 0104 void updateData(IgdbDataType dataType, const QByteArray& data); 0105 // download data list from Tgdb and update cache 0106 void readDataList(IgdbDataType dataType, const QList<int>& idList=QList<int>()); 0107 0108 bool m_started; 0109 mutable QElapsedTimer m_requestTimer; 0110 0111 QString m_accessToken; 0112 QDateTime m_accessTokenExpires; 0113 QHash<uint, Data::EntryPtr> m_entries; 0114 QPointer<KIO::StoredTransferJob> m_job; 0115 0116 QHash<int, QString> m_genreHash; 0117 QHash<int, QString> m_platformHash; 0118 QHash<int, QString> m_esrbHash; 0119 QHash<int, QString> m_pegiHash; 0120 QHash<int, QString> m_companyHash; 0121 }; 0122 0123 class IGDBFetcher::ConfigWidget : public Fetch::ConfigWidget { 0124 Q_OBJECT 0125 0126 public: 0127 explicit ConfigWidget(QWidget* parent_, const IGDBFetcher* fetcher = nullptr); 0128 virtual void saveConfigHook(KConfigGroup&) Q_DECL_OVERRIDE; 0129 virtual QString preferredName() const Q_DECL_OVERRIDE; 0130 }; 0131 0132 } // end namespace 0133 } // end namespace 0134 #endif