File indexing completed on 2024-05-12 05:09:40
0001 /*************************************************************************** 0002 Copyright (C) 2017 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_OMDBFETCHER_H 0026 #define TELLICO_OMDBFETCHER_H 0027 0028 #include "fetcher.h" 0029 #include "configwidget.h" 0030 #include "../datavectors.h" 0031 0032 #include <QPointer> 0033 #include <QDate> 0034 0035 class QLineEdit; 0036 0037 class KJob; 0038 namespace KIO { 0039 class StoredTransferJob; 0040 } 0041 class OMDBFetcherTest; 0042 0043 namespace Tellico { 0044 0045 namespace GUI { 0046 class ComboBox; 0047 } 0048 0049 namespace Fetch { 0050 0051 /** 0052 * A fetcher for omdbapi.com 0053 * 0054 * @author Robby Stephenson 0055 */ 0056 class OMDBFetcher : public Fetcher { 0057 Q_OBJECT 0058 0059 public: 0060 /** 0061 */ 0062 OMDBFetcher(QObject* parent); 0063 /** 0064 */ 0065 virtual ~OMDBFetcher(); 0066 0067 /** 0068 */ 0069 virtual QString source() 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 OMDB; } 0075 virtual bool canFetch(int type) const Q_DECL_OVERRIDE; 0076 virtual void readConfigHook(const KConfigGroup& config) Q_DECL_OVERRIDE; 0077 virtual void saveConfigHook(KConfigGroup& config) Q_DECL_OVERRIDE; 0078 virtual void continueSearch() Q_DECL_OVERRIDE; 0079 0080 /** 0081 * Returns a widget for modifying the fetcher's config. 0082 */ 0083 virtual Fetch::ConfigWidget* configWidget(QWidget* parent) const Q_DECL_OVERRIDE; 0084 0085 class ConfigWidget : public Fetch::ConfigWidget { 0086 public: 0087 explicit ConfigWidget(QWidget* parent_, const OMDBFetcher* fetcher = nullptr); 0088 virtual void saveConfigHook(KConfigGroup&) Q_DECL_OVERRIDE; 0089 virtual QString preferredName() const Q_DECL_OVERRIDE; 0090 private: 0091 QLineEdit* m_apiKeyEdit; 0092 }; 0093 friend class ConfigWidget; 0094 0095 static QString defaultName(); 0096 static QString defaultIcon(); 0097 static StringHash allOptionalFields(); 0098 0099 private Q_SLOTS: 0100 void slotComplete(KJob* job); 0101 0102 private: 0103 friend class ::OMDBFetcherTest; 0104 virtual void search() Q_DECL_OVERRIDE; 0105 virtual FetchRequest updateRequest(Data::EntryPtr entry) Q_DECL_OVERRIDE; 0106 void populateEntry(Data::EntryPtr entry, const QVariantMap& resultMap, bool fullData); 0107 0108 bool m_started; 0109 QString m_apiKey; 0110 0111 QHash<uint, Data::EntryPtr> m_entries; 0112 QPointer<KIO::StoredTransferJob> m_job; 0113 }; 0114 0115 } // end namespace 0116 } // end namespace 0117 #endif