construct/modules/client/presence.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.

using namespace ircd;

mapi::header
IRCD_MODULE
{
	"Client 11.6 :Presence"
};

ircd::resource
presence_resource
{
	"/_matrix/client/r0/presence/", resource::opts
	{
		"(11.6.2) Presence",
		resource::DIRECTORY,
	}
};

//
// put
//

const string_view
valid_states[]
{
	"online", "offline", "unavailable"
};

static bool
valid_state(const string_view &state);

extern "C" m::event::id::buf
set__user_presence_status(const m::user::id &user_id,
                          const string_view &presence,
                          const string_view &status_msg);

static resource::response
put__presence_status(client &client,
                     const resource::request &request,
                     const m::user::id &user_id);

static resource::response
put__presence(client &client,
              const resource::request &request);

resource::method
method_put
{
	presence_resource, "PUT", put__presence,
	{
		method_put.REQUIRES_AUTH
	}
};

resource::response
put__presence(client &client,
              const resource::request &request)
{
	if(request.parv.size() < 1)
		throw m::NEED_MORE_PARAMS
		{
			"user_id required"
		};

	m::user::id::buf user_id
	{
		url::decode(request.parv[0], user_id)
	};

	if(user_id != request.user_id)
		throw m::FORBIDDEN
		{
			"You cannot set the presence of '%s' when you are '%s'",
			user_id,
			request.user_id
		};

	if(request.parv.size() < 2)
		throw m::NEED_MORE_PARAMS
		{
			"command required"
		};

	const auto &cmd
	{
		request.parv[1]
	};

	if(cmd == "status")
		return put__presence_status(client, request, user_id);

	throw m::NOT_FOUND
	{
		"Presence command not found"
	};
}

resource::response
put__presence_status(client &client,
                     const resource::request &request,
                     const m::user::id &user_id)
{
	const string_view &presence
	{
		unquote(request.at("presence"))
	};

	const string_view &status_msg
	{
		trunc(unquote(request["status_msg"]), 390)
	};

	set__user_presence_status(request.user_id, presence, status_msg);

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

m::event::id::buf
set__user_presence_status(const m::user::id &user_id,
                          const string_view &presence,
                          const string_view &status_msg)
{
	if(!valid_state(presence))
		throw m::UNSUPPORTED
		{
			"That presence state is not supported"
		};

	json::iov content;
	const json::iov::push _presence[]
	{
		{ content, { "presence", presence } },
		{ content, { "user_id",  user_id  } },
	};

	const json::iov::set_if _status_msg
	{
		content, !empty(status_msg),
		{
			"status_msg", status_msg
		}
	};

	const m::user::room user_room
	{
		user_id
	};

	return send(user_room, user_id, "m.presence", content);
}

bool
valid_state(const string_view &state)
{
	return std::any_of(begin(valid_states), end(valid_states), [&state]
	(const string_view &valid)
	{
		return state == valid;
	});
}

//
// get
//

static resource::response
get__presence_status(client &client,
                     const resource::request &request,
                     const m::user::id &user_id)
{
	const m::user::room user_room
	{
		user_id
	};

	user_room.get("m.presence", [&client]
	(const m::event &event)
	{
		const auto &content
		{
			at<"content"_>(event)
		};

		json::iov response;
		const json::iov::push _presence
		{
			response, { "presence", content.at("presence") }
		};

		const json::iov::set_if _status_msg
		{
			response, content.has("status_msg"),
			{
				"status_msg", content.at("status_msg")
			}
		};

		//TODO: better last_active_ago
		const auto last_active_ago
		{
			ircd::now<milliseconds>() - milliseconds(at<"origin_server_ts"_>(event))
		};

		const json::iov::push _last_active_ago
		{
			response, { "last_active_ago", last_active_ago.count() }
		};

		//TODO: better currently_active
		const bool currently_active
		{
			content.at("presence") == "online"
		};

		const json::iov::push _currently_active
		{
			response, { "currently_active", currently_active }
		};

		resource::response
		{
			client, response
		};
	});

	return {}; // responded from closure
}

static resource::response
get__presence_list(client &client,
                   const resource::request &request)
{
	if(request.parv.size() < 2)
		throw m::NEED_MORE_PARAMS
		{
			"user_id required"
		};

	m::user::id::buf user_id
	{
		url::decode(request.parv[1], user_id)
	};

	const m::user::room user_room
	{
		user_id
	};

	//TODO: reuse composition from /status
	std::vector<json::value> list;
	return resource::response
	{
		client, json::value
		{
			list.data(), list.size()
		}
	};
}

resource::response
get__presence(client &client,
              const resource::request &request)
{
	if(request.parv.size() < 1)
		throw m::NEED_MORE_PARAMS
		{
			"user_id or command required"
		};

	if(request.parv[0] == "list")
		return get__presence_list(client, request);

	m::user::id::buf user_id
	{
		url::decode(request.parv[0], user_id)
	};

	if(request.parv.size() < 2)
		throw m::NEED_MORE_PARAMS
		{
			"command required"
		};

	const auto &cmd
	{
		request.parv[1]
	};

	if(cmd == "status")
		return get__presence_status(client, request, user_id);

	throw m::NOT_FOUND
	{
		"Presence command not found"
	};
}

resource::method
method_get
{
	presence_resource, "GET", get__presence
};

static resource::response
post__presence_list(client &client,
                    const resource::request &request)
{
	if(request.parv.size() < 2)
		throw m::NEED_MORE_PARAMS
		{
			"user_id required"
		};

	m::user::id::buf user_id
	{
		url::decode(request.parv[1], user_id)
	};

	const m::user::room user_room
	{
		user_id
	};

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

resource::response
post__presence(client &client,
               const resource::request &request)
{
	if(request.parv.size() < 1)
		throw m::NEED_MORE_PARAMS
		{
			"command required"
		};

	if(request.parv[0] == "list")
		return get__presence_list(client, request);

	throw m::NOT_FOUND
	{
		"Presence command not found"
	};
}

resource::method
method_post
{
	presence_resource, "POST", post__presence,
	{
		method_post.REQUIRES_AUTH
	}
};