File indexing completed on 2024-05-12 05:09:33

0001 /***************************************************************************
0002     Copyright (C) 2022 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_FETCH_GAMINGHISTORYFETCHER_H
0026 #define TELLICO_FETCH_GAMINGHISTORYFETCHER_H
0027 
0028 #include "fetcher.h"
0029 #include "configwidget.h"
0030 
0031 #include <QPointer>
0032 
0033 class QUrl;
0034 class KJob;
0035 namespace KIO {
0036   class Job;
0037   class StoredTransferJob;
0038 }
0039 
0040 namespace Tellico {
0041   namespace Fetch {
0042 
0043 /**
0044  * A fetcher for arcade-history.com
0045  *
0046  * @author Robby Stephenson
0047  */
0048 class GamingHistoryFetcher : public Fetcher {
0049 Q_OBJECT
0050 
0051 public:
0052   GamingHistoryFetcher(QObject* parent);
0053   virtual ~GamingHistoryFetcher();
0054 
0055   virtual QString source() const Q_DECL_OVERRIDE;
0056   virtual bool isSearching() const Q_DECL_OVERRIDE { return m_started; }
0057   // only keyword search
0058   virtual bool canSearch(FetchKey k) const Q_DECL_OVERRIDE { return k == Keyword; }
0059   virtual void stop() Q_DECL_OVERRIDE;
0060   virtual Data::EntryPtr fetchEntryHook(uint uid) Q_DECL_OVERRIDE;
0061   virtual Type type() const Q_DECL_OVERRIDE { return GamingHistory; }
0062   virtual bool canFetch(int type) const Q_DECL_OVERRIDE;
0063   virtual void readConfigHook(const KConfigGroup& config) Q_DECL_OVERRIDE;
0064 
0065   virtual Fetch::ConfigWidget* configWidget(QWidget* parent) const Q_DECL_OVERRIDE;
0066 
0067   class ConfigWidget;
0068   friend class ConfigWidget;
0069 
0070   static QString defaultName();
0071   static QString defaultIcon();
0072   static StringHash allOptionalFields();
0073 
0074 private Q_SLOTS:
0075   void slotComplete(KJob* job);
0076 
0077 private:
0078   virtual void search() Q_DECL_OVERRIDE;
0079   virtual FetchRequest updateRequest(Data::EntryPtr entry) Q_DECL_OVERRIDE;
0080   void parseEntry(Data::EntryPtr entry, const QString& str);
0081   void parseSingleResult(Data::EntryPtr entry, const QUrl& url);
0082   void populatePlatform(Data::EntryPtr entry, const QString& platform);
0083   void populateYearIndex();
0084 
0085   QHash<uint, Data::EntryPtr> m_entries;
0086   QHash<uint, QUrl> m_matches;
0087   QHash<QString, int> m_yearIndex;
0088   QPointer<KIO::StoredTransferJob> m_job;
0089 
0090   bool m_started;
0091 };
0092 
0093 class GamingHistoryFetcher::ConfigWidget : public Fetch::ConfigWidget {
0094 Q_OBJECT
0095 
0096 public:
0097   explicit ConfigWidget(QWidget* parent, const GamingHistoryFetcher* fetcher = nullptr);
0098   virtual void saveConfigHook(KConfigGroup&) Q_DECL_OVERRIDE {}
0099   virtual QString preferredName() const Q_DECL_OVERRIDE;
0100 };
0101 
0102   } // end namespace
0103 } // end namespace
0104 #endif