tdesktop/Telegram/SourceFiles/storage/storage_shared_media.h

/*
This file is part of Telegram Desktop,
the official desktop version of Telegram messaging app, see https://telegram.org

Telegram Desktop 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 3 of the License, or
(at your option) any later version.

It 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.

In addition, as a special exception, the copyright holders give permission
to link the code of portions of this program with the OpenSSL library.

Full license: https://github.com/telegramdesktop/tdesktop/blob/master/LICENSE
Copyright (c) 2014-2017 John Preston, https://desktop.telegram.org
*/
#pragma once

#include "storage/storage_facade.h"

namespace Storage {

// Allow forward declarations.
enum class SharedMediaType : char {
	Photo = 0,
	Video = 1,
	MusicFile = 2,
	File = 3,
	VoiceFile = 4,
	Link = 5,
	ChatPhoto = 6,
	RoundVoiceFile = 7,
	GIF = 8,

	kCount = 9,
};
constexpr auto kSharedMediaTypeCount = static_cast<int>(SharedMediaType::kCount);
constexpr bool IsValidSharedMediaType(SharedMediaType type) {
	return (static_cast<int>(type) >= 0)
		&& (static_cast<int>(type) < kSharedMediaTypeCount);
}

using SharedMediaTypesMask = base::enum_mask<SharedMediaType>;

struct SharedMediaAddNew {
	SharedMediaAddNew(PeerId peerId, SharedMediaTypesMask types, MsgId messageId)
		: peerId(peerId), messageId(messageId), types(types) {
	}

	PeerId peerId = 0;
	MsgId messageId = 0;
	SharedMediaTypesMask types;

};

struct SharedMediaAddExisting {
	SharedMediaAddExisting(
		PeerId peerId,
		SharedMediaTypesMask types,
		MsgId messageId,
		MsgRange noSkipRange)
		: peerId(peerId)
		, messageId(messageId)
		, noSkipRange(noSkipRange)
		, types(types) {
	}

	PeerId peerId = 0;
	MsgId messageId = 0;
	MsgRange noSkipRange;
	SharedMediaTypesMask types;

};

struct SharedMediaAddSlice {
	SharedMediaAddSlice(
		PeerId peerId,
		SharedMediaType type,
		std::vector<MsgId> &&messageIds,
		MsgRange noSkipRange,
		base::optional<int> count = base::none)
		: peerId(peerId)
		, messageIds(std::move(messageIds))
		, noSkipRange(noSkipRange)
		, type(type)
		, count(count) {
	}

	PeerId peerId = 0;
	std::vector<MsgId> messageIds;
	MsgRange noSkipRange;
	SharedMediaType type = SharedMediaType::kCount;
	base::optional<int> count;

};

struct SharedMediaRemoveOne {
	SharedMediaRemoveOne(
		PeerId peerId,
		SharedMediaTypesMask types,
		MsgId messageId)
		: peerId(peerId)
		, messageId(messageId)
		, types(types) {
	}

	PeerId peerId = 0;
	MsgId messageId = 0;
	SharedMediaTypesMask types;

};

struct SharedMediaRemoveAll {
	SharedMediaRemoveAll(PeerId peerId) : peerId(peerId) {
	}

	PeerId peerId = 0;

};

struct SharedMediaKey {
	SharedMediaKey(
		PeerId peerId,
		SharedMediaType type,
		MsgId messageId)
		: peerId(peerId)
		, type(type)
		, messageId(messageId) {
	}

	bool operator==(const SharedMediaKey &other) const {
		return (peerId == other.peerId)
			&& (type == other.type)
			&& (messageId == other.messageId);
	}
	bool operator!=(const SharedMediaKey &other) const {
		return !(*this == other);
	}

	PeerId peerId = 0;
	SharedMediaType type = SharedMediaType::kCount;
	MsgId messageId = 0;

};

struct SharedMediaQuery {
	SharedMediaQuery(
		SharedMediaKey key,
		int limitBefore,
		int limitAfter)
		: key(key)
		, limitBefore(limitBefore)
		, limitAfter(limitAfter) {
	}

	SharedMediaKey key;
	int limitBefore = 0;
	int limitAfter = 0;

};

struct SharedMediaResult {
	base::optional<int> count;
	base::optional<int> skippedBefore;
	base::optional<int> skippedAfter;
	base::flat_set<MsgId> messageIds;
};

struct SharedMediaSliceUpdate {
	SharedMediaSliceUpdate(
		PeerId peerId,
		SharedMediaType type,
		const base::flat_set<MsgId> *messages,
		MsgRange range,
		base::optional<int> count)
		: peerId(peerId)
		, type(type)
		, messages(messages)
		, range(range)
		, count(count) {
	}

	PeerId peerId = 0;
	SharedMediaType type = SharedMediaType::kCount;
	const base::flat_set<MsgId> *messages = nullptr;
	MsgRange range;
	base::optional<int> count;
};

class SharedMedia : private base::Subscriber {
public:
	using Type = SharedMediaType;

	void add(SharedMediaAddNew &&query);
	void add(SharedMediaAddExisting &&query);
	void add(SharedMediaAddSlice &&query);
	void remove(SharedMediaRemoveOne &&query);
	void remove(SharedMediaRemoveAll &&query);
	void query(
		const SharedMediaQuery &query,
		base::lambda_once<void(SharedMediaResult&&)> &&callback);

	base::Observable<SharedMediaSliceUpdate> sliceUpdated;
	base::Observable<SharedMediaRemoveOne> oneRemoved;
	base::Observable<SharedMediaRemoveAll> allRemoved;

private:
	class List {
	public:
		void addNew(MsgId messageId);
		void addExisting(MsgId messageId, MsgRange noSkipRange);
		void addSlice(
			std::vector<MsgId> &&messageIds,
			MsgRange noSkipRange,
			base::optional<int> count);
		void removeOne(MsgId messageId);
		void removeAll();
		void query(
			const SharedMediaQuery &query,
			base::lambda_once<void(SharedMediaResult&&)> &&callback);

		struct SliceUpdate {
			const base::flat_set<MsgId> *messages = nullptr;
			MsgRange range;
			base::optional<int> count;
		};
		base::Observable<SliceUpdate> sliceUpdated;

	private:
		struct Slice {
			Slice(base::flat_set<MsgId> &&messages, MsgRange range);

			template <typename Range>
			void merge(const Range &moreMessages, MsgRange moreNoSkipRange);

			base::flat_set<MsgId> messages;
			MsgRange range;

			inline bool operator<(const Slice &other) const {
				return range.from < other.range.from;
			}

		};

		template <typename Range>
		int uniteAndAdd(
			SliceUpdate &update,
			base::flat_set<Slice>::iterator uniteFrom,
			base::flat_set<Slice>::iterator uniteTill,
			const Range &messages,
			MsgRange noSkipRange);
		template <typename Range>
		int addRangeItemsAndCount(
			SliceUpdate &update,
			const Range &messages,
			MsgRange noSkipRange,
			base::optional<int> count);
		template <typename Range>
		void addRange(
			const Range &messages,
			MsgRange noSkipRange,
			base::optional<int> count,
			bool incrementCount = false);

		SharedMediaResult queryFromSlice(
			const SharedMediaQuery &query,
			const Slice &slice);

		base::optional<int> _count;
		base::flat_set<Slice> _slices;

	};
	using SliceUpdate = List::SliceUpdate;
	using Lists = std::array<List, kSharedMediaTypeCount>;

	std::map<PeerId, Lists>::iterator enforceLists(PeerId peerId);

	std::map<PeerId, Lists> _lists;

};

} // namespace Storage