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

0001 /***************************************************************************
0002     Copyright (C) 2012 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_ALLOCINEFETCHER_H
0026 #define TELLICO_ALLOCINEFETCHER_H
0027 
0028 #include "xmlfetcher.h"
0029 #include "configwidget.h"
0030 #include "../datavectors.h"
0031 
0032 #include <QPointer>
0033 
0034 class QSpinBox;
0035 
0036 class KJob;
0037 namespace KIO {
0038   class StoredTransferJob;
0039 }
0040 
0041 namespace Tellico {
0042 
0043   namespace Fetch {
0044 
0045 /**
0046  * An abstract fetcher for the Allocine family of web sites
0047  *
0048  * @author Robby Stephenson
0049  */
0050 class AbstractAllocineFetcher : public Fetcher {
0051 Q_OBJECT
0052 
0053 public:
0054   /**
0055    */
0056   AbstractAllocineFetcher(QObject* parent, const QString& baseUrl);
0057   /**
0058    */
0059   virtual ~AbstractAllocineFetcher();
0060 
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 bool canFetch(int type) const Q_DECL_OVERRIDE;
0066   virtual void readConfigHook(const KConfigGroup& config) Q_DECL_OVERRIDE;
0067 
0068   class ConfigWidget : public Fetch::ConfigWidget {
0069   public:
0070     explicit ConfigWidget(QWidget* parent_, const AbstractAllocineFetcher* fetcher = nullptr);
0071     virtual void saveConfigHook(KConfigGroup&) Q_DECL_OVERRIDE;
0072     virtual QString preferredName() const Q_DECL_OVERRIDE = 0;
0073   private:
0074     QSpinBox* m_numCast;
0075   };
0076   friend class ConfigWidget;
0077 
0078 private Q_SLOTS:
0079   void slotComplete(KJob* job);
0080 
0081 private:
0082   static QByteArray calculateSignature(const QString& method, const QList<QPair<QString, QString> >& params);
0083 
0084   virtual void search() Q_DECL_OVERRIDE;
0085   virtual FetchRequest updateRequest(Data::EntryPtr entry) Q_DECL_OVERRIDE;
0086   Data::CollPtr createCollection() const;
0087   void populateEntry(Data::EntryPtr entry, const QVariantMap& resultMap);
0088   void configureJob(KIO::StoredTransferJob* job);
0089 
0090   QHash<uint, Data::EntryPtr> m_entries;
0091   QPointer<KIO::StoredTransferJob> m_job;
0092 
0093   bool m_started;
0094   QString m_apiKey;
0095   QString m_baseUrl;
0096   int m_numCast;
0097 };
0098 
0099 /**
0100  * A fetcher for allocine.fr
0101  *
0102  * @author Robby Stephenson
0103  */
0104 class AllocineFetcher : public AbstractAllocineFetcher {
0105 Q_OBJECT
0106 
0107 public:
0108   /**
0109    */
0110   AllocineFetcher(QObject* parent);
0111   ~AllocineFetcher();
0112 
0113   virtual QString source() const Q_DECL_OVERRIDE;
0114   virtual Type type() const Q_DECL_OVERRIDE { return Allocine; }
0115 
0116   /**
0117    * Returns a widget for modifying the fetcher's config.
0118    */
0119   virtual Fetch::ConfigWidget* configWidget(QWidget* parent) const Q_DECL_OVERRIDE;
0120 
0121   class ConfigWidget : public AbstractAllocineFetcher::ConfigWidget {
0122   public:
0123     explicit ConfigWidget(QWidget* parent_, const AbstractAllocineFetcher* fetcher = nullptr);
0124     virtual QString preferredName() const Q_DECL_OVERRIDE;
0125   };
0126 
0127   static QString defaultName();
0128   static QString defaultIcon();
0129   static StringHash allOptionalFields();
0130 };
0131 
0132   } // end namespace
0133 } // end namespace
0134 #endif