src/plugins/blogique/interfaces/blogique/iaccount.h
/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2010-2012  Oleg Linkin
 *
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE or copy at https://www.boost.org/LICENSE_1_0.txt)
 **********************************************************************/

#pragma once

#include <QMetaType>
#include <QVariant>
#include <QStringList>
#include <QDateTime>
#include <QUrl>

class QAction;
class QWidget;

namespace LC
{
namespace Blogique
{
	enum class EntryType
	{
		None,
		BlogEntry,
		Draft
	};


	struct Entry
	{
		QString Target_;
		QString Subject_;
		QString Content_;
		QDateTime Date_;
		QStringList Tags_;
		QVariantMap PostOptions_;
		QVariantMap CustomData_;
		qint64 EntryId_;
		QUrl EntryUrl_;
		EntryType EntryType_;

		Entry ()
		: EntryId_ (-1)
		, EntryType_ (EntryType::None)
		{
		}

		bool IsEmpty () const
		{
			return Content_.isEmpty ();
		};
	};

	struct CommentEntry
	{
		QByteArray AccountID_;

		qint64 EntryID_;
		QString EntrySubject_;
		QUrl EntryUrl_;

		qint64 CommentID_;
		QString CommentSubject_;
		QString CommentText_;
		QString CommentAuthor_;
		QDateTime CommentDateTime_;
		QUrl CommentUrl_;

		qint64 ParentCommentID_;

		CommentEntry ()
		: EntryID_ (-1)
		, CommentID_ (-1)
		, ParentCommentID_ (-1)
		{}

		bool isValid () const
		{
			return EntryID_ != -1 &&
					CommentID_ != -1;
		}

		bool operator== (const CommentEntry& newComment) const
		{
			return CommentID_ == newComment.CommentID_ &&
					AccountID_ == newComment.AccountID_;
		}
	};

	inline uint qHash (const CommentEntry& comment)
	{
		return qHash (comment.AccountID_) + ::qHash (comment.CommentID_);
	}

	struct Filter
	{
		bool CustomDate_;
		QDateTime BeginDate_;
		QDateTime EndDate_;
		QStringList Tags_;
		int Skip_;

		Filter ()
		: CustomDate_ (false)
		, Skip_ (0)
		{}
	};

	/** @brief Interface representing a single account.
	 *
	 **/
	class IAccount
	{
	public:
		virtual ~IAccount () {}

		/** @brief Returns the account object as a QObject.
		 *
		 * @return Account object as QObject.
		 */
		virtual QObject* GetQObject () = 0;

		/** @brief Returns the pointer to the parent blogging platform that this
		 * account belongs to.
		 *
		 * @return The parent blogging platforml of this account.
		 */
		virtual QObject* GetParentBloggingPlatform () const = 0;

		/** @brief Returns the human-readable name of this account.
		 *
		 * @return Human-readable name of this account.
		 *
		 * @sa RenameAccount()
		 */
		virtual QString GetAccountName () const = 0;

		/** @brief Returns the login of our user.
		 *
		 * @return Login name.
		 */
		virtual QString GetOurLogin () const = 0;

		/** @brief Sets the human-readable name of this account to the
		 * new name.
		 *
		 * @param[in] name The new name of the account.
		 *
		 * @sa GetAccountName()
		 */
		virtual void RenameAccount (const QString& name) = 0;

		/** @brief Returns the ID of this account.
		 *
		 * The returned ID should be unique among all accounts and
		 * should not depend on the value of GetAccountName()
		 * (the human-readable name of the account).
		 *
		 * @return The unique and persistent account ID.
		 */
		virtual QByteArray GetAccountID () const = 0;

		/** @brief Requests the account to open its configuration dialog.
		 */
		virtual void OpenConfigurationDialog () = 0;

		/** @brief Returns validation state of account.
		 *
		 * If account not valid it can't be used for blogging.
		 *
		 * @return Validation state of the account.
		 */
		virtual bool IsValid () const = 0;

		/** @brief Returns the pointer to account's profile.
		 *
		 * @return The account's profile.
		 */
		virtual QObject* GetProfile () = 0;

		/** @brief Requests entries by date;
		 *
		 * @param[in] date Specified date.
		 */
		virtual void GetEntriesByDate (const QDate& date) = 0;

		virtual void GetEntriesWithFilter (const Filter& filter) = 0;

		/** @brief Remove entry from blog.
		 *
		 * @param[in] entry Entry to remove.
		 */
		virtual void RemoveEntry (const Entry& entry) = 0;

		/** @brief Update entry in blog.
		 *
		 * @param[in] entry Entry to update.
		 */
		virtual void UpdateEntry (const Entry& entry) = 0;

		virtual QList<QAction*> GetUpdateActions () const = 0;

		/** @brief Requests the number of entries per day.
		 *
		 */
		virtual void RequestStatistics () = 0;

		/** @brief Requests tags.
		 *
		 */
		virtual void RequestTags () = 0;

		/** @brief Requests last entries.
		 *
		 */
		virtual void RequestLastEntries (int count = 0) = 0;

		/** @brief Requests recent comments.
		 *
		 */
		virtual void RequestRecentComments () = 0;

		/** @brief Add comment.
		 *
		 */
		virtual void AddComment (const CommentEntry& comment) = 0;

		/** @brief Delete comment.
		 *
		 */
		virtual void DeleteComment (qint64 id, bool threadDelete = false) = 0;

		/** @brief Submit post to blog.
		 *
		 * @param[in] event Posting event.
		 */
		virtual void submit (const Entry& event) = 0;

		/** @brief Preview post in blog stryle.
		 *
		 * @param[in] event Preview event.
		 */
		virtual void preview (const Entry& event) = 0;

		/** @brief Request updating profile data.
		 *
		 */
		virtual void updateProfile () = 0;

	protected:
		/** @brief This signal should be emitted when account is renamed.
		 *
		 * This signal should be emitted even after an explicit call to
		 * RenameAccount().
		 *
		 * @note This function is expected to be a signal.
		 *
		 * @param[out] newName The new name of this account.
		 */
		virtual void accountRenamed (const QString& newName) = 0;

		/** @brief This signal should be emitted when entry
		 * successfully posted to blog.
		 *
		 * @note This function is expected to be a signal.
		 */
		virtual void entryPosted (const QList<Entry>& entries) = 0;

		//TODO
		virtual void entryRemoved (int itemId) = 0;

		//TODO
		virtual void entryUpdated (const QList<Entry>& entries) = 0;

		//TODO
		virtual void gotBlogStatistics (const QMap<QDate, int>& statistics) = 0;

		//TODO
		virtual void tagsUpdated (const QHash<QString, int>& tags) = 0;

		//TODO
		virtual void requestEntriesBegin () = 0;

		//TODO
		virtual void gotEntries (const QList<Entry>& entries) = 0;

		/** @brief This signal should be emitted when account want to backup
		 * some amount of entries.
		 *
		 * @note This function is expected to be a signal.
		 */
		virtual void gotFilteredEntries (const QList<Entry>& entries) = 0;

		/** @brief This signal should be emitted all entries for backup were downloaded.
		 *
		 * @note This function is expected to be a signal.
		 */
		virtual void gettingFilteredEntriesFinished () = 0;

		/** @brief This signal should be emitted when recent comments are got.
		 *
		 * @note This function is expected to be a signal.
		 */
		virtual void gotRecentComments (const QList<CommentEntry>& comments) = 0;

		/** @brief This signal should be emitted when comments was deleted successfully.
		 *
		 * @note This function is expected to be a signal.
		 */
		virtual void commentsDeleted (const QList<qint64>& comments) = 0;

		virtual void gotError (int errorCode, const QString& errorString,
				const QString& localizedErrorString = QString ()) = 0;
	};
}
}

Q_DECLARE_INTERFACE (LC::Blogique::IAccount,
		"org.Deviant.LeechCraft.Blogique.IAccount/1.0")
