KDE/danbooru-client
1
0
Fork 0
Code Issues Pull requests Releases Activity

First semi-working implementation in c++ of remote Danbooru calls

Browse source
This commit is contained in:
Luca Beltrame 2013-02-24 18:28:37 +01:00
parent c0cf369b92
commit fc691a9301
9 changed files with 1341 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

265
src/libdanbooru/danbooruservice.h Normal file
View file

@ -0,0 +1,265 @@
/*
* This file is part of libdanbooru.
* Copyright 2013 Luca Beltrame <lbeltrame@kde.org>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License or (at your option) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*
*/
#ifndef DANBOORUSERVICE_H
#define DANBOORUSERVICE_H
/**
* @brief Classes to interact with Danbooru boards
* @file danbooruservice.h
*
**/
#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtCore/QStringList>
#include <KUrl>
#include <KIO/JobClasses>
class QPixmap;
class KUrl;
class KJob;
/**
* @brief The Danbooru namespace.
*
**/
namespace Danbooru {
/**
* @brief Types of tags
*
* A Danbooru tag is not simply a string, but carries some (limited)
* semantic information. In particular, tags are organized in what they
* refer to, either something related to the image itself, or to the
* artist that drew it, or the copyrights associated to the image, or even
* the characters that are represented in it.
*
**/
enum TagType {
General, /**< Generic tags **/
Artist, /**< Tags related to artists **/
Copyright, /**<Tags related to copyrights **/
Character /**<Tags related to characters **/
};
class DanbooruPost;
class DanbooruPool;
using KIO::StoredTransferJob;
/**
* @brief A class which provides a wrapper around Danbooru's RESTful API.
*
* This class provides access to Danbooru-based image boards
* by making the appropriate RESTful calls to the service and then
* retrieving and parsing the reuslts.
*
* @author Luca Beltrame (lbeltrame@kde.org)
*
*
**/
class DanbooruService : public QObject
{
Q_OBJECT
private:
// URL fragments
static const QString POST_URL;
static const QString TAG_URL;
static const QString POOL_URL;
static const QString ARTIST_URL;
static const QString POOL_DATA_URL;
static const QString RELATED_TAG_URL;
// Ratings
static const QMap<QString, QStringList> RATINGS;
// member variables
KUrl m_url;
QString m_username;
QString m_password;
QStringList m_blacklist;
QString m_maxRating;
unsigned int m_currentPosts; // To tell when to quit
// private functions
/**
* @internal
*
**/
static const QMap< QString, QStringList > initRatings();
public:
/**
* @brief Construct a default instance of the service.
*
* @param boardUrl The URL to connect to.
* @param username Username to use (optional)
* @param password Password to use (optional)
* @param parent The parent QObject
*
**/
DanbooruService(KUrl& boardUrl, QString username = QString(),
QString password = QString(), QObject* parent = 0);
/**
* Default destructor.
**/
~DanbooruService();
/**
*@brief Get posts from a the board.
*
* @param page The page containing posts (default: 1)
* @param tags The specific tags to query for (default: all tags)
* @param limit The number of posts to fetch (maximum 100)
*
**/
void getPostList(int page=1, QStringList tags=QStringList(),
int limit=100);
/**
* @brief Get a list of pools from the board.
*
* @param page The page to get pools from (default: 1)
*
**/
void getPoolList(int page = 1);
/**
* @brief Get the posts associated with a specific pool ID.
*
* @param poolId The ID of the pool to fetch posts from.
* @param page The page of the pool posts (if > 100)
*
**/
void getPool(int poolId, int page=1);
/**
* @brief Get a list of tags from the board
*
* The tagDownloaded signal is emitted every time a tag has been
* retrieved.
*
* @param limit The number of tags to get.
*
**/
void getTagList(int limit=10, QString name="");
/**
* @brief Get tags related to a specific, user supplied list.
*
* @param tags The tags to query for related terms
* @param tagType The type of tag to query for
**/
void getRelatedTags(QStringList tags=QStringList(),
TagType tagType=General);
/**
* @return The currently allowed ratings when downloading posts.
**/
const QStringList allowedRatings() const;
/**
* @return The maximum allowed rating for a post.
**/
const QString maximumAllowedRating() const;
/**
* @return The currently blacklisted tags.
**/
QStringList blacklist() const;
/**
* @brief Set the maximum allowed rating for the board.
*
* Posts whose rating is higher than the maximuk allowed will not be
* downloaded.
*
**/
void setMaximumAllowedRating(QString rating);
/**
* @brief Set the tag blacklist.
*
* If a tag is in the blacklist, posts tagged with it will not be downloaded.
*
**/
void setBlackList(QStringList blacklist);
private Q_SLOTS:
void processPostList(KJob* job);
void processPoolList(KJob* job);
void processRelatedTagList(KJob* job);
void downloadThumbnail(KJob* job);
void downloadAllTags(KJob* job);
Q_SIGNALS:
/**
* Emitted when there are no more posts to download.
*
* Connect to this signal to know when downloading is complete.
*
**/
void postDownloadFinished();
/**
* Emitted when there are no more pools to download.
**/
void poolDownloadFinished();
/**
* Emitted when a download error occurred.
*
* The parameter contains the error string.
*
**/
void downloadError(QString error);
/**
* Emitted when a post has been downloaded.
*
* The parameter contains a pointer to the post that has been
* downloaded.
**/
void postDownloaded(Danbooru::DanbooruPost* post);
void poolDownloaded(Danbooru::DanbooruPool* pool);
// TODO: Tags and similar
};
};
#endif // DANBOORUSERVICE_H