File indexing completed on 2024-05-12 05:09:38
0001 /*************************************************************************** 0002 Copyright (C) 2019-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_MOBYGAMESFETCHER_H 0026 #define TELLICO_MOBYGAMESFETCHER_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 class MobyGamesFetcherTest; 0042 namespace Tellico { 0043 namespace GUI { 0044 class ComboBox; 0045 } 0046 namespace Fetch { 0047 0048 /** 0049 * A fetcher for mobygames.com 0050 * 0051 * @author Robby Stephenson 0052 */ 0053 class MobyGamesFetcher : public Fetcher { 0054 Q_OBJECT 0055 0056 friend class ::MobyGamesFetcherTest; 0057 0058 public: 0059 /** 0060 */ 0061 MobyGamesFetcher(QObject* parent); 0062 /** 0063 */ 0064 virtual ~MobyGamesFetcher(); 0065 0066 /** 0067 */ 0068 virtual QString source() const Q_DECL_OVERRIDE; 0069 virtual QString attribution() const Q_DECL_OVERRIDE; 0070 virtual bool isSearching() const Q_DECL_OVERRIDE { return m_started; } 0071 virtual bool canSearch(FetchKey k) const Q_DECL_OVERRIDE; 0072 virtual void stop() Q_DECL_OVERRIDE; 0073 virtual Data::EntryPtr fetchEntryHook(uint uid) Q_DECL_OVERRIDE; 0074 virtual Type type() const Q_DECL_OVERRIDE { return MobyGames; } 0075 virtual bool canFetch(int type) const Q_DECL_OVERRIDE; 0076 virtual void readConfigHook(const KConfigGroup& config) Q_DECL_OVERRIDE; 0077 virtual void continueSearch() Q_DECL_OVERRIDE; 0078 0079 /** 0080 * Returns a widget for modifying the fetcher's config. 0081 */ 0082 virtual Fetch::ConfigWidget* configWidget(QWidget* parent) const Q_DECL_OVERRIDE; 0083 0084 class ConfigWidget : public Fetch::ConfigWidget { 0085 public: 0086 explicit ConfigWidget(QWidget* parent_, const MobyGamesFetcher* fetcher = nullptr); 0087 virtual void saveConfigHook(KConfigGroup&) Q_DECL_OVERRIDE; 0088 virtual QString preferredName() const Q_DECL_OVERRIDE; 0089 0090 private: 0091 QLineEdit* m_apiKeyEdit; 0092 GUI::ComboBox* m_imageCombo; 0093 }; 0094 friend class ConfigWidget; 0095 0096 static QString defaultName(); 0097 static QString defaultIcon(); 0098 static StringHash allOptionalFields(); 0099 0100 private Q_SLOTS: 0101 void slotComplete(KJob* job); 0102 // read all cached data 0103 void populateHashes(); 0104 0105 private: 0106 virtual void search() Q_DECL_OVERRIDE; 0107 virtual FetchRequest updateRequest(Data::EntryPtr entry) Q_DECL_OVERRIDE; 0108 Data::EntryList createEntries(Data::CollPtr coll, const QVariantMap& resultMap); 0109 0110 // honor throttle limit for the API 0111 void markTime(); 0112 // update cached data 0113 void updatePlatforms(); 0114 0115 enum ImageSize { 0116 SmallImage=0, // small is really the thumb size 0117 MediumImage=1, 0118 LargeImage=2, 0119 NoImage=3 0120 }; 0121 0122 bool m_started; 0123 ImageSize m_imageSize; 0124 0125 QString m_apiKey; 0126 QHash<uint, Data::EntryPtr> m_entries; 0127 QPointer<KIO::StoredTransferJob> m_job; 0128 QElapsedTimer m_idleTime; 0129 int m_requestPlatformId; 0130 0131 QHash<int, QString> m_esrbHash; 0132 // key is the mobygames platform id 0133 QHash<int, QString> m_platforms; 0134 }; 0135 0136 } // end namespace 0137 } // end namespace 0138 #endif