construct/modules/client/rooms/receipt.cc

// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.

#include "rooms.h"

using namespace ircd;

void
handle_receipt_m_read(client &client,
                      const resource::request &request,
                      const m::room::id &room_id,
                      const m::event::id &event_id);

resource::response
post__receipt(client &client,
              const resource::request &request,
              const m::room::id &room_id)
{
	if(request.parv.size() < 3)
		throw m::NEED_MORE_PARAMS
		{
			"receipt type required"
		};

	const string_view &receipt_type
	{
		request.parv[2]
	};

	if(receipt_type == "m.read")
	{
		if(request.parv.size() < 4)
			throw m::NEED_MORE_PARAMS
			{
				"event_id required"
			};

		m::event::id::buf event_id
		{
			url::decode(event_id, request.parv[3])
		};

		handle_receipt_m_read(client, request, room_id, event_id);
	}
	else throw m::UNSUPPORTED
	{
		"Sorry, receipt type '%s' is not supported here.",
		receipt_type
	};

	return resource::response
	{
		client, http::OK
	};
}

void
handle_receipt_m_read(client &client,
                      const resource::request &request,
                      const m::room::id &room_id,
                      const m::event::id &event_id)
{
	// Check if event_id is more recent than the last receipt's event_id.
	// We currently don't do anything with receipts targeting the past.
	if(!m::receipt::freshest(room_id, request.user_id, event_id))
		return;

	const bool ignoring
	{
		// Check if user wants to prevent sending receipts to this room.
		m::receipt::ignoring(request.user_id, room_id)

		// Check if user wants to prevent based on this event's specifics.
		|| m::receipt::ignoring(request.user_id, event_id)
	};

	// The options object starts with anything in the request content, which
	// differs depending on whether this is being called from a /receipt or
	// /read_markers resource handler. The receipt::read() implementation
	// looks for properties knowing this call pattern, thus it's best to just
	// convey the whole content here for forward compat.
	json::object options
	{
		request
	};

	// Ignoring still involves creating a receipt in all respects except
	// transmitting it to local and remote parties. This behavior is achieved
	// by the m.hidden tag. If the options do not contain this tag we add it.
	std::string options_buf;
	if(ignoring && !options.get("m.hidden", false))
	{
		options_buf = json::insert(options, {"m.hidden", true});
		options = options_buf;
	}

	m::receipt::read(room_id, request.user_id, event_id, options);
}