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

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