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

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_DBCFETCHER_H
0026 #define TELLICO_DBCFETCHER_H
0027 
0028 #include "xmlfetcher.h"
0029 #include "configwidget.h"
0030 #include "../datavectors.h"
0031 
0032 namespace Tellico {
0033   namespace Fetch {
0034 
0035 /**
0036  * A fetcher for https://opensource.dbc.dk/services/open-search-web-service
0037  *
0038  * @author Robby Stephenson
0039  */
0040 class DBCFetcher : public XMLFetcher {
0041 Q_OBJECT
0042 
0043 public:
0044   /**
0045    */
0046   DBCFetcher(QObject* parent);
0047   /**
0048    */
0049   virtual ~DBCFetcher();
0050 
0051   /**
0052    */
0053   virtual QString source() const Q_DECL_OVERRIDE;
0054   virtual bool canSearch(FetchKey k) const Q_DECL_OVERRIDE;
0055   virtual Type type() const Q_DECL_OVERRIDE { return DBC; }
0056   virtual bool canFetch(int type) const Q_DECL_OVERRIDE;
0057   virtual void readConfigHook(const KConfigGroup& config) Q_DECL_OVERRIDE;
0058 
0059   /**
0060    * Returns a widget for modifying the fetcher's config.
0061    */
0062   virtual Fetch::ConfigWidget* configWidget(QWidget* parent) const Q_DECL_OVERRIDE;
0063 
0064   class ConfigWidget : public Fetch::ConfigWidget {
0065   public:
0066     explicit ConfigWidget(QWidget* parent_, const DBCFetcher* fetcher = nullptr);
0067     virtual void saveConfigHook(KConfigGroup&) Q_DECL_OVERRIDE;
0068     virtual QString preferredName() const Q_DECL_OVERRIDE;
0069   };
0070   friend class ConfigWidget;
0071 
0072   static QString defaultName();
0073   static QString defaultIcon();
0074   static StringHash allOptionalFields();
0075 
0076 private:
0077   virtual FetchRequest updateRequest(Data::EntryPtr entry) Q_DECL_OVERRIDE;
0078   virtual void resetSearch() Q_DECL_OVERRIDE;
0079   virtual QUrl searchUrl() Q_DECL_OVERRIDE;
0080   virtual void parseData(QByteArray& data) Q_DECL_OVERRIDE;
0081   virtual Data::EntryPtr fetchEntryHookData(Data::EntryPtr entry) Q_DECL_OVERRIDE;
0082 };
0083 
0084   } // end namespace
0085 } // end namespace
0086 #endif