src/plugins/aggregator/interfaces/aggregator/item.h
/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * 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 <vector>
#include <memory>
#include <QString>
#include <QStringList>
#include <QDateTime>
#include <QMetaType>
#include <QVector>
#include "common.h"

namespace LC
{
namespace Aggregator
{
	struct ItemShort
	{
		IDType_t ItemID_;
		IDType_t ChannelID_;
		QString Title_;
		QString URL_;
		QStringList Categories_;
		QDateTime PubDate_;
		bool Unread_;
	};

	/** Describes an enclosure associated with an item.
		*/
	struct Enclosure
	{
		/** @brief Enclosure ID.
			*/
		IDType_t EnclosureID_ = IDNotFound;

		/** @brief Parent item's ID.
			*/
		IDType_t ItemID_ = IDNotFound;

		/** @brief The URL this enclosure refers to.
			*/
		QString URL_;

		/** @brief MIME type of the enclosure.
			*/
		QString Type_;

		/** @brief Length of the attached enclosure or -1 if unknown.
			*/
		qint64 Length_ = 0;

		/** @brief  For the Atom's hreflang attribute.
			*/
		QString Lang_;

		static Enclosure CreateForItem (IDType_t itemId);
	};

	bool operator== (const Enclosure&, const Enclosure&);

	struct MRSSThumbnail
	{
		IDType_t MRSSThumbnailID_ = IDNotFound;
		IDType_t MRSSEntryID_ = IDNotFound;
		QString URL_;
		int Width_ = 0;
		int Height_ = 0;
		QString Time_;

		static MRSSThumbnail CreateForEntry (IDType_t entryId);
	};

	bool operator== (const MRSSThumbnail&, const MRSSThumbnail&);

	struct MRSSCredit
	{
		IDType_t MRSSCreditID_ = IDNotFound;
		IDType_t MRSSEntryID_ = IDNotFound;
		QString Role_;
		QString Who_;

		static MRSSCredit CreateForEntry (IDType_t entryId);
	};

	bool operator== (const MRSSCredit&, const MRSSCredit&);

	struct MRSSComment
	{
		IDType_t MRSSCommentID_ = IDNotFound;
		IDType_t MRSSEntryID_ = IDNotFound;
		QString Type_;
		QString Comment_;

		static MRSSComment CreateForEntry (IDType_t entryId);
	};

	bool operator== (const MRSSComment&, const MRSSComment&);

	struct MRSSPeerLink
	{
		IDType_t MRSSPeerLinkID_ = IDNotFound;
		IDType_t MRSSEntryID_ = IDNotFound;
		QString Type_;
		QString Link_;

		static MRSSPeerLink CreateForEntry (IDType_t entryId);
	};

	bool operator== (const MRSSPeerLink&, const MRSSPeerLink&);

	struct MRSSScene
	{
		IDType_t MRSSSceneID_ = IDNotFound;
		IDType_t MRSSEntryID_ = IDNotFound;
		QString Title_;
		QString Description_;
		QString StartTime_;
		QString EndTime_;

		static MRSSScene CreateForEntry (IDType_t entryId);
	};

	bool operator== (const MRSSScene&, const MRSSScene&);

	struct MRSSEntry
	{
		IDType_t MRSSEntryID_ = IDNotFound;
		IDType_t ItemID_ = IDNotFound;
		QString URL_;
		qint64 Size_ = 0;
		QString Type_;
		QString Medium_;
		bool IsDefault_ = false;
		QString Expression_;
		int Bitrate_ = 0;
		double Framerate_ = 0;
		double SamplingRate_ = 0;
		int Channels_ = 0;
		int Duration_ = 0;
		int Width_ = 0;
		int Height_ = 0;
		QString Lang_;
		int Group_ = 0;
		QString Rating_;
		QString RatingScheme_;
		QString Title_;
		QString Description_;
		QString Keywords_;
		QString CopyrightURL_;
		QString CopyrightText_;
		int RatingAverage_ = 0;
		int RatingCount_ = 0;
		int RatingMin_ = 0;
		int RatingMax_ = 0;
		int Views_ = 0;
		int Favs_ = 0;
		QString Tags_;
		QList<MRSSThumbnail> Thumbnails_;
		QList<MRSSCredit> Credits_;
		QList<MRSSComment> Comments_;
		QList<MRSSPeerLink> PeerLinks_;
		QList<MRSSScene> Scenes_;

		static MRSSEntry CreateForItem (IDType_t itemId);
	};

	bool operator== (const MRSSEntry&, const MRSSEntry&);

	struct Item
	{
		/** The unique ID of the channel this item belongs to.
			*/
		IDType_t ChannelID_ = IDNotFound;

		/** The unique ID of the item.
			*/
		IDType_t ItemID_ = IDNotFound;

		/** The title of the item as showed in the item list.
			*/
		QString Title_;

		/** Link which should be opened when user activates the item, for
			* example, by double-clicking on the header or by clicking the
			* appropriate button.
			*/
		QString Link_;

		/** Main body of the item, showed in the main Aggregator area. Item
			* contents go here.
			*/
		QString Description_;

		/** Author of the item.
			*/
		QString Author_;

		/** Categories of this item.
			*/
		QStringList Categories_;

		/** Unique ID of the item, but it may be empty because at least
			* RSS 2.0 standard makes this field optional.
			*/
		QString Guid_;

		/** Publication datetime of the item. Should be set to invalid
			* datetime if it could not be determined from the item
			* representation in the feed.
			*/
		QDateTime PubDate_;

		/** Indicates whether this item is unread or not.
			*/
		bool Unread_ = false;

		/** Number of comments for this item. Should be set to -1 if it could
			* not be determined from the item representation in the feed.
			*/
		int NumComments_ = 0;

		/** Link to the comments RSS. Should be left blank if it could not
			* be determined from the item representation in the feed.
			*/
		QString CommentsLink_;

		/** Link to the page with comments. Should be left blank if it could
			* not be determined from the item representation in the feed.
			*/
		QString CommentsPageLink_;

		/** List of enclosures of the item.
			*/
		QList<Enclosure> Enclosures_;

		/** Latitude in the GeoRSS context.
			*/
		double Latitude_ = -1;

		/** Longitude in the GeoRSS context.
			*/
		double Longitude_ = -1;

		/* List of MediaRSS entries.
			*/
		QList<MRSSEntry> MRSSEntries_;

		static Item CreateForChannel (IDType_t channelId);

		/** Returns the simplified (short) representation of this item.
			*
			* @return The simplified (short) representation.
			*/
		ItemShort ToShort () const;

		/** @brief Fixes the date of the item.
		 *
		 * Sets the pubdate to current date if the pubdate is invalid.
		 */
		void FixDate ();
	};

	using Item_ptr = std::shared_ptr<Item>;
	using Item_cptr = std::shared_ptr<const Item>;

	using items_container_t = QVector<Item_ptr>;
	using items_shorts_t = QVector<ItemShort>;

	bool operator== (const Item&, const Item&);
	void Print (const Item&);
	void Diff (const Item&, const Item&);

	bool IsModified (const Item&, const Item&);
}
}

Q_DECLARE_METATYPE (LC::Aggregator::Item_ptr)
Q_DECLARE_METATYPE (LC::Aggregator::Item)
Q_DECLARE_METATYPE (LC::Aggregator::ItemShort)
