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

0001 /***************************************************************************
0002     Copyright (C) 2023 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_ADSSCHOLARFETCHER_H
0026 #define TELLICO_ADSSCHOLARFETCHER_H
0027 
0028 #include "fetcher.h"
0029 #include "configwidget.h"
0030 
0031 #include <QPointer>
0032 
0033 class QLineEdit;
0034 class KJob;
0035 namespace KIO {
0036   class StoredTransferJob;
0037 }
0038 
0039 namespace Tellico {
0040   namespace Fetch {
0041 
0042 /**
0043  * A fetcher for SAO/NASA Astrophysics Data System
0044  *
0045  * @author Robby Stephenson
0046  */
0047 class ADSFetcher : public Fetcher {
0048 Q_OBJECT
0049 
0050 public:
0051   /**
0052    */
0053   ADSFetcher(QObject* parent);
0054   /**
0055    */
0056   virtual ~ADSFetcher();
0057 
0058   /**
0059    */
0060   virtual QString source() const Q_DECL_OVERRIDE;
0061   virtual bool isSearching() const Q_DECL_OVERRIDE { return m_started; }
0062   virtual bool canSearch(FetchKey k) const Q_DECL_OVERRIDE;
0063   virtual void stop() Q_DECL_OVERRIDE;
0064   virtual Data::EntryPtr fetchEntryHook(uint uid) Q_DECL_OVERRIDE;
0065   virtual Type type() const Q_DECL_OVERRIDE { return ADS; }
0066   virtual bool canFetch(int type) const Q_DECL_OVERRIDE;
0067   virtual void readConfigHook(const KConfigGroup& config) Q_DECL_OVERRIDE;
0068   virtual void continueSearch() Q_DECL_OVERRIDE;
0069 
0070   /**
0071    * Returns a widget for modifying the fetcher's config.
0072    */
0073   virtual Fetch::ConfigWidget* configWidget(QWidget* parent) const Q_DECL_OVERRIDE;
0074 
0075   class ConfigWidget : public Fetch::ConfigWidget {
0076   public:
0077     explicit ConfigWidget(QWidget* parent_, const ADSFetcher* fetcher = nullptr);
0078     virtual void saveConfigHook(KConfigGroup&) Q_DECL_OVERRIDE;
0079     virtual QString preferredName() const Q_DECL_OVERRIDE;
0080   private:
0081     QLineEdit* m_apiKeyEdit;
0082   };
0083   friend class ConfigWidget;
0084 
0085   static QString defaultName();
0086   static QString defaultIcon();
0087   static StringHash allOptionalFields() { return StringHash(); }
0088 
0089 private Q_SLOTS:
0090   void slotComplete(KJob* job);
0091 
0092 private:
0093   virtual void search() Q_DECL_OVERRIDE;
0094   virtual FetchRequest updateRequest(Data::EntryPtr entry) Q_DECL_OVERRIDE;
0095   void doSearch();
0096   QPointer<KIO::StoredTransferJob> getJob(const QUrl& url);
0097 
0098   QHash<uint, QString> m_results; // search result id to bibcode id
0099   QHash<uint, Data::EntryPtr> m_entries;
0100   QPointer<KIO::StoredTransferJob> m_job;
0101 
0102   bool m_started;
0103   QString m_apiKey;
0104   int m_start;
0105   int m_total;
0106 };
0107 
0108   } // end namespace
0109 } // end namespace
0110 #endif