mirror of
https://github.com/matrix-construct/construct
synced 2024-12-27 07:54:05 +01:00
616 lines
12 KiB
C++
616 lines
12 KiB
C++
// 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.
|
|
|
|
namespace ircd::m::typing
|
|
{
|
|
static system_point calc_timesout(milliseconds relative);
|
|
static bool update_state(const edu &);
|
|
static m::event::id::buf set_typing(const edu &);
|
|
static void _handle_edu(const m::event &, const edu &);
|
|
static void handle_edu(const m::event &, m::vm::eval &);
|
|
static void timeout_timeout(const typist &);
|
|
static void timeout_check();
|
|
static void timeout_worker();
|
|
|
|
extern log::log log;
|
|
extern ctx::dock dock;
|
|
extern ctx::mutex mutex;
|
|
extern std::set<typist, typist> typists;
|
|
extern conf::item<milliseconds> timeout_max;
|
|
extern conf::item<milliseconds> timeout_min;
|
|
extern conf::item<milliseconds> timeout_int;
|
|
extern hookfn<vm::eval &> on_eval;
|
|
extern context timeout_context;
|
|
}
|
|
|
|
decltype(ircd::m::typing::log)
|
|
ircd::m::typing::log
|
|
{
|
|
"m.typing"
|
|
};
|
|
|
|
decltype(ircd::m::typing::dock)
|
|
ircd::m::typing::dock;
|
|
|
|
decltype(ircd::m::typing::mutex)
|
|
ircd::m::typing::mutex;
|
|
|
|
decltype(ircd::m::typing::typists)
|
|
ircd::m::typing::typists;
|
|
|
|
decltype(ircd::m::typing::timeout_max)
|
|
ircd::m::typing::timeout_max
|
|
{
|
|
{ "name", "ircd.typing.timeout.max" },
|
|
{ "default", 90 * 1000L },
|
|
};
|
|
|
|
decltype(ircd::m::typing::timeout_min)
|
|
ircd::m::typing::timeout_min
|
|
{
|
|
{ "name", "ircd.typing.timeout.min" },
|
|
{ "default", 15 * 1000L },
|
|
};
|
|
|
|
decltype(ircd::m::typing::timeout_int)
|
|
ircd::m::typing::timeout_int
|
|
{
|
|
{ "name", "ircd.typing.timeout.int" },
|
|
{ "default", 5 * 1000L },
|
|
};
|
|
|
|
decltype(ircd::m::typing::timeout_context)
|
|
ircd::m::typing::timeout_context
|
|
{
|
|
"typing",
|
|
768_KiB,
|
|
context::POST,
|
|
timeout_worker,
|
|
};
|
|
|
|
static const ircd::run::changed
|
|
timeout_context_terminate
|
|
{
|
|
ircd::run::level::QUIT, []
|
|
{
|
|
ircd::m::typing::timeout_context.terminate();
|
|
}
|
|
};
|
|
|
|
/// Hooks all federation typing edus from remote servers as well as
|
|
/// the above commit from local clients. This hook rewrites the edu into
|
|
/// a new event formatted for client /sync and then runs that through eval
|
|
/// so our clients can receive the typing events.
|
|
///
|
|
decltype(ircd::m::typing::on_eval)
|
|
ircd::m::typing::on_eval
|
|
{
|
|
handle_edu,
|
|
{
|
|
{ "_site", "vm.eval" },
|
|
{ "type", "m.typing" },
|
|
}
|
|
};
|
|
|
|
void
|
|
ircd::m::typing::timeout_worker()
|
|
try
|
|
{
|
|
for(;; ctx::sleep(milliseconds(timeout_int)))
|
|
{
|
|
dock.wait([]
|
|
{
|
|
return !typists.empty();
|
|
});
|
|
|
|
const std::lock_guard lock
|
|
{
|
|
mutex
|
|
};
|
|
|
|
timeout_check();
|
|
}
|
|
}
|
|
catch(const std::exception &e)
|
|
{
|
|
log::critical
|
|
{
|
|
log, "Typing timeout worker fatal :%s",
|
|
e.what()
|
|
};
|
|
}
|
|
|
|
void
|
|
ircd::m::typing::timeout_check()
|
|
try
|
|
{
|
|
const ctx::uninterruptible ui;
|
|
const auto now
|
|
{
|
|
ircd::now<system_point>()
|
|
};
|
|
|
|
for(auto it(begin(typists)); it != end(typists); )
|
|
{
|
|
if(it->timesout < now)
|
|
{
|
|
timeout_timeout(*it);
|
|
it = typists.erase(it);
|
|
ctx::interruption_point();
|
|
}
|
|
else ++it;
|
|
}
|
|
}
|
|
catch(const std::exception &e)
|
|
{
|
|
log::critical
|
|
{
|
|
log, "Typing timeout check :%s",
|
|
e.what(),
|
|
};
|
|
}
|
|
|
|
void
|
|
ircd::m::typing::timeout_timeout(const typist &t)
|
|
try
|
|
{
|
|
assert(run::level == run::level::RUN);
|
|
|
|
const edu edu
|
|
{
|
|
{ "user_id", t.user_id },
|
|
{ "room_id", t.room_id },
|
|
{ "typing", false },
|
|
};
|
|
|
|
log::debug
|
|
{
|
|
log, "Typing timeout for %s in %s",
|
|
string_view{t.user_id},
|
|
string_view{t.room_id}
|
|
};
|
|
|
|
m::event event;
|
|
json::get<"origin"_>(event) = my_host();
|
|
json::get<"type"_>(event) = "m.typing"_sv;
|
|
|
|
// Call this manually because it currently composes the event
|
|
// sent to clients to stop the typing for this timed out user.
|
|
_handle_edu(event, edu);
|
|
}
|
|
catch(const std::exception &e)
|
|
{
|
|
log::error
|
|
{
|
|
log, "Typing timeout for %s in %s :%s",
|
|
string_view{t.user_id},
|
|
string_view{t.room_id},
|
|
e.what(),
|
|
};
|
|
}
|
|
|
|
void
|
|
ircd::m::typing::handle_edu(const m::event &event,
|
|
m::vm::eval &eval)
|
|
try
|
|
{
|
|
const json::object &content
|
|
{
|
|
at<"content"_>(event)
|
|
};
|
|
|
|
_handle_edu(event, content);
|
|
}
|
|
catch(const ctx::interrupted &)
|
|
{
|
|
throw;
|
|
}
|
|
catch(const std::exception &e)
|
|
{
|
|
log::derror
|
|
{
|
|
log, "m.typing from %s :%s",
|
|
json::get<"origin"_>(event),
|
|
e.what(),
|
|
};
|
|
|
|
throw;
|
|
}
|
|
|
|
void
|
|
ircd::m::typing::_handle_edu(const m::event &event,
|
|
const edu &edu)
|
|
{
|
|
// This check prevents interference between the two competing edu formats;
|
|
// The federation edu has a room_id field while the client edu only has a
|
|
// user_id's array. We don't need to hook on the client edu here.
|
|
if(!json::get<"room_id"_>(edu))
|
|
return;
|
|
|
|
const auto &origin
|
|
{
|
|
at<"origin"_>(event)
|
|
};
|
|
|
|
const m::room::id &room_id
|
|
{
|
|
at<"room_id"_>(edu)
|
|
};
|
|
|
|
const m::user::id &user_id
|
|
{
|
|
at<"user_id"_>(edu)
|
|
};
|
|
|
|
// Check if this server can send an edu for this user. We make an exception
|
|
// for our server to allow the timeout worker to use this codepath.
|
|
if(!my_host(origin) && user_id.host() != origin)
|
|
{
|
|
log::dwarning
|
|
{
|
|
log, "Ignoring %s from %s for alien %s",
|
|
at<"type"_>(event),
|
|
origin,
|
|
string_view{user_id}
|
|
};
|
|
|
|
return;
|
|
}
|
|
|
|
// Check if this server can write to the room based on the m.room.server_acl.
|
|
if(!my_host(origin))
|
|
if(m::room::server_acl::enable_write && !m::room::server_acl::check(room_id, origin))
|
|
{
|
|
log::dwarning
|
|
{
|
|
log, "Ignoring %s from '%s' in %s :denied by m.room.server_acl.",
|
|
at<"type"_>(event),
|
|
origin,
|
|
string_view{room_id},
|
|
};
|
|
|
|
return;
|
|
}
|
|
|
|
// Update the typing state map for edu's from other servers only; the
|
|
// state map was already updated for our clients in the committer. Also
|
|
// condition for skipping redundant updates here too based on the state.
|
|
if(!my_host(origin))
|
|
{
|
|
// Check if the user is actually in the room. The check is in this
|
|
// branch for remote servers only because our committer above did this
|
|
// already for our client.
|
|
const m::room room{room_id};
|
|
if(!membership(room, user_id, "join"))
|
|
{
|
|
log::dwarning
|
|
{
|
|
log, "Ignoring %s from %s for user %s because not in room '%s'",
|
|
at<"type"_>(event),
|
|
origin,
|
|
string_view{user_id},
|
|
string_view{room_id},
|
|
};
|
|
|
|
return;
|
|
}
|
|
|
|
// Set the (non-spec) timeout field of the edu which remote servers
|
|
// don't/can't set and then update the state. Use the maximum timeout
|
|
// value here because the minimum might unfairly time them out.
|
|
auto _edu(edu);
|
|
const milliseconds max(timeout_max), min(timeout_min);
|
|
json::get<"timeout"_>(_edu) = std::clamp(json::get<"timeout"_>(_edu), min.count(), max.count());
|
|
if(!update_state(_edu))
|
|
return;
|
|
}
|
|
|
|
set_typing(edu);
|
|
}
|
|
|
|
ircd::m::event::id::buf
|
|
ircd::m::typing::set_typing(const edu &edu)
|
|
{
|
|
assert(json::get<"room_id"_>(edu));
|
|
const m::user::id &user_id
|
|
{
|
|
at<"user_id"_>(edu)
|
|
};
|
|
|
|
const m::user user
|
|
{
|
|
user_id
|
|
};
|
|
|
|
if(!exists(user))
|
|
create(user);
|
|
|
|
const m::user::room user_room
|
|
{
|
|
user
|
|
};
|
|
|
|
const auto &timeout
|
|
{
|
|
json::get<"timeout"_>(edu)?
|
|
json::get<"timeout"_>(edu):
|
|
json::get<"typing"_>(edu)?
|
|
milliseconds(timeout_max).count():
|
|
0L
|
|
};
|
|
|
|
const auto evid
|
|
{
|
|
send(user_room, user_id, "ircd.typing",
|
|
{
|
|
{ "room_id", at<"room_id"_>(edu) },
|
|
{ "typing", json::get<"typing"_>(edu) },
|
|
{ "timeout", timeout },
|
|
})
|
|
};
|
|
|
|
char pbuf[32];
|
|
log::info
|
|
{
|
|
log, "%s %s typing in %s timeout:%s",
|
|
string_view{user_id},
|
|
json::get<"typing"_>(edu)?
|
|
"started"_sv:
|
|
"stopped"_sv,
|
|
at<"room_id"_>(edu),
|
|
util::pretty(pbuf, milliseconds(timeout), 1),
|
|
};
|
|
|
|
return evid;
|
|
}
|
|
|
|
bool
|
|
ircd::m::typing::update_state(const edu &object)
|
|
try
|
|
{
|
|
const auto &user_id
|
|
{
|
|
at<"user_id"_>(object)
|
|
};
|
|
|
|
const auto &room_id
|
|
{
|
|
at<"room_id"_>(object)
|
|
};
|
|
|
|
const auto &typing
|
|
{
|
|
at<"typing"_>(object)
|
|
};
|
|
|
|
const milliseconds timeout
|
|
{
|
|
at<"timeout"_>(object)
|
|
};
|
|
|
|
const std::lock_guard lock
|
|
{
|
|
mutex
|
|
};
|
|
|
|
auto it
|
|
{
|
|
typists.lower_bound(user_id)
|
|
};
|
|
|
|
const bool was_typing
|
|
{
|
|
it != end(typists) && it->user_id == user_id
|
|
};
|
|
|
|
if(typing && !was_typing)
|
|
{
|
|
typists.emplace_hint(it, typist
|
|
{
|
|
calc_timesout(timeout), user_id, room_id
|
|
});
|
|
|
|
dock.notify_one();
|
|
}
|
|
else if(typing && was_typing)
|
|
{
|
|
auto &t(const_cast<typist &>(*it));
|
|
t.timesout = calc_timesout(timeout);
|
|
}
|
|
else if(!typing && was_typing)
|
|
{
|
|
typists.erase(it);
|
|
}
|
|
|
|
const bool transmit
|
|
{
|
|
(typing && !was_typing) || (!typing && was_typing)
|
|
};
|
|
|
|
log::debug
|
|
{
|
|
log, "Typing %s in %s now[%b] was[%b] xmit[%b]",
|
|
string_view{at<"user_id"_>(object)},
|
|
string_view{at<"room_id"_>(object)},
|
|
json::get<"typing"_>(object),
|
|
was_typing,
|
|
transmit
|
|
};
|
|
|
|
return transmit;
|
|
}
|
|
catch(const std::exception &e)
|
|
{
|
|
log::error
|
|
{
|
|
log, "Failed to update state :%s",
|
|
e.what(),
|
|
};
|
|
|
|
throw;
|
|
}
|
|
|
|
ircd::system_point
|
|
ircd::m::typing::calc_timesout(milliseconds timeout)
|
|
{
|
|
timeout = std::max(timeout, milliseconds(timeout_min));
|
|
timeout = std::min(timeout, milliseconds(timeout_max));
|
|
return now<system_point>() + timeout;
|
|
}
|
|
|
|
/// typing commit handler stack (local user)
|
|
///
|
|
/// This function is called via ircd::m::typing linkage to create a typing
|
|
/// event originating from our client. This event takes the form of the
|
|
/// federation edu and is broadcast to servers. Unfortunately the matrix
|
|
/// client spec has a different edu format for typing; so to propagate this
|
|
/// event to clients we hook it during eval and create a new event formatted
|
|
/// for clients and then run that through eval too. (see below).
|
|
///
|
|
ircd::m::typing::commit::commit(const edu &edu)
|
|
{
|
|
using json::at;
|
|
|
|
// Check if the user is actually in the room.
|
|
const m::room room
|
|
{
|
|
at<"room_id"_>(edu)
|
|
};
|
|
|
|
// Only allow user to send typing events to rooms they are joined...
|
|
if(!membership(room, at<"user_id"_>(edu), "join"))
|
|
throw m::FORBIDDEN
|
|
{
|
|
"Cannot type in a room %s to which you are not joined",
|
|
string_view{room.room_id}
|
|
};
|
|
|
|
// If the user does not want to transmit typing events to this room,
|
|
// bail out here.
|
|
if(!allow(at<"user_id"_>(edu), room, "send"))
|
|
return;
|
|
|
|
// Clients like Riot will send erroneous and/or redundant typing requests
|
|
// for example requesting typing=false when the state already =false.
|
|
// We don't want to tax the vm::eval for this noise so we try to update
|
|
// state first and if that returns false it indicates we should ignore.
|
|
if(!update_state(edu))
|
|
return;
|
|
|
|
json::iov event, content;
|
|
const json::iov::push push[]
|
|
{
|
|
{ event, { "type", "m.typing" } },
|
|
{ event, { "room_id", at<"room_id"_>(edu) } },
|
|
{ content, { "user_id", at<"user_id"_>(edu) } },
|
|
{ content, { "room_id", at<"room_id"_>(edu) } },
|
|
{ content, { "typing", json::get<"typing"_>(edu) } },
|
|
};
|
|
|
|
m::vm::copts opts;
|
|
opts.edu = true;
|
|
opts.prop_mask.reset();
|
|
opts.prop_mask.set("origin");
|
|
m::vm::eval
|
|
{
|
|
event, content, opts
|
|
};
|
|
}
|
|
|
|
bool
|
|
ircd::m::typing::allow(const user::id &user_id,
|
|
const room::id &room_id,
|
|
const string_view &allow_type)
|
|
{
|
|
const user::room user_room
|
|
{
|
|
user_id
|
|
};
|
|
|
|
const room::state state
|
|
{
|
|
user_room
|
|
};
|
|
|
|
char buf[event::TYPE_MAX_SIZE+1]
|
|
{
|
|
"ircd.typing.disable."
|
|
};
|
|
|
|
const string_view &type
|
|
{
|
|
strlcat{buf, allow_type}
|
|
};
|
|
|
|
const string_view &state_key
|
|
{
|
|
room_id
|
|
};
|
|
|
|
return !state.has(type, state_key);
|
|
}
|
|
|
|
bool
|
|
ircd::m::typing::for_each(const closure &closure)
|
|
{
|
|
const std::lock_guard lock
|
|
{
|
|
mutex
|
|
};
|
|
|
|
for(const auto &t : typists)
|
|
{
|
|
const time_t timeout
|
|
{
|
|
system_clock::to_time_t(t.timesout)
|
|
};
|
|
|
|
const edu event
|
|
{
|
|
{ "user_id", t.user_id },
|
|
{ "room_id", t.room_id },
|
|
{ "typing", true },
|
|
{ "timeout", timeout },
|
|
};
|
|
|
|
if(!closure(event))
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
//
|
|
// typist struct
|
|
//
|
|
|
|
bool
|
|
ircd::m::typing::typist::operator()(const typist &a,
|
|
const string_view &b)
|
|
const noexcept
|
|
{
|
|
return a.user_id < b;
|
|
}
|
|
|
|
bool
|
|
ircd::m::typing::typist::operator()(const string_view &a,
|
|
const typist &b)
|
|
const noexcept
|
|
{
|
|
return a < b.user_id;
|
|
}
|
|
|
|
bool
|
|
ircd::m::typing::typist::operator()(const typist &a,
|
|
const typist &b)
|
|
const noexcept
|
|
{
|
|
return a.user_id < b.user_id;
|
|
}
|