mirror of
https://github.com/matrix-construct/construct
synced 2024-09-13 03:58:55 +02:00
315 lines
7.2 KiB
C++
315 lines
7.2 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.
|
|
|
|
ircd::mapi::header
|
|
IRCD_MODULE
|
|
{
|
|
"Client Sync :Room Timeline"
|
|
};
|
|
|
|
namespace ircd::m::sync
|
|
{
|
|
static bool _room_timeline_append(data &, json::stack::array &, const m::event::idx &, const m::event &);
|
|
static event::id::buf _room_timeline_polylog_events(data &, const m::room &, bool &, bool &);
|
|
static bool room_timeline_polylog(data &);
|
|
|
|
static bool _room_timeline_linear_command(data &);
|
|
static bool room_timeline_linear(data &);
|
|
|
|
extern const string_view exposure_depth_description;
|
|
extern conf::item<int64_t> exposure_depth;
|
|
extern conf::item<bool> exposure_state;
|
|
extern conf::item<size_t> limit_default;
|
|
extern conf::item<size_t> limit_initial_default;
|
|
extern const event::keys::include default_keys;
|
|
extern item room_timeline;
|
|
}
|
|
|
|
decltype(ircd::m::sync::room_timeline)
|
|
ircd::m::sync::room_timeline
|
|
{
|
|
"rooms.timeline",
|
|
room_timeline_polylog,
|
|
room_timeline_linear,
|
|
{
|
|
{ "initial", true },
|
|
}
|
|
};
|
|
|
|
decltype(ircd::m::sync::default_keys)
|
|
ircd::m::sync::default_keys
|
|
{
|
|
"content",
|
|
"depth",
|
|
"event_id",
|
|
"origin_server_ts",
|
|
"prev_events",
|
|
"redacts",
|
|
"room_id",
|
|
"sender",
|
|
"state_key",
|
|
"type",
|
|
};
|
|
|
|
decltype(ircd::m::sync::limit_default)
|
|
ircd::m::sync::limit_default
|
|
{
|
|
{ "name", "ircd.client.sync.rooms.timeline.limit.default" },
|
|
{ "default", 10L },
|
|
};
|
|
|
|
decltype(ircd::m::sync::limit_initial_default)
|
|
ircd::m::sync::limit_initial_default
|
|
{
|
|
{ "name", "ircd.client.sync.rooms.timeline.limit_initial.default" },
|
|
{ "default", 1L },
|
|
};
|
|
|
|
decltype(ircd::m::sync::exposure_state)
|
|
ircd::m::sync::exposure_state
|
|
{
|
|
{ "name", "ircd.client.sync.rooms.timeline.exposure.state" },
|
|
{ "default", false },
|
|
};
|
|
|
|
decltype(ircd::m::sync::exposure_depth)
|
|
ircd::m::sync::exposure_depth
|
|
{
|
|
{ "name", "ircd.client.sync.rooms.timeline.exposure.depth" },
|
|
{ "default", 20L },
|
|
{ "description", exposure_depth_description },
|
|
};
|
|
|
|
decltype(ircd::m::sync::exposure_depth_description)
|
|
ircd::m::sync::exposure_depth_description
|
|
{R"(
|
|
Does not linear-sync timeline events whose distance from the room head
|
|
is greater than this value. This prevents past events from appearing at
|
|
the bottom of the timeline in clients which do not sort their timeline to
|
|
prevent an incoherent conversation when the server obtains past events.
|
|
)"};
|
|
|
|
bool
|
|
ircd::m::sync::room_timeline_linear(data &data)
|
|
{
|
|
if(!data.event_idx)
|
|
return false;
|
|
|
|
if(!data.room)
|
|
return false;
|
|
|
|
if(!data.membership && *data.room != data.user_room)
|
|
return false;
|
|
|
|
assert(data.event);
|
|
const bool command
|
|
{
|
|
*data.room == data.user_room &&
|
|
startswith(json::get<"type"_>(*data.event), "ircd.cmd") &&
|
|
(json::get<"sender"_>(*data.event) == m::me.user_id ||
|
|
json::get<"sender"_>(*data.event) == data.user.user_id)
|
|
};
|
|
|
|
json::stack::object rooms
|
|
{
|
|
*data.out, "rooms"
|
|
};
|
|
|
|
if(command)
|
|
return _room_timeline_linear_command(data);
|
|
|
|
if(int64_t(exposure_depth) > -1)
|
|
if(json::get<"depth"_>(*data.event) + int64_t(exposure_depth) < data.room_depth)
|
|
{
|
|
if(!json::get<"state_key"_>(*data.event))
|
|
return false;
|
|
|
|
if(!bool(exposure_state))
|
|
return false;
|
|
}
|
|
|
|
json::stack::object membership_
|
|
{
|
|
*data.out, data.membership
|
|
};
|
|
|
|
json::stack::object room_
|
|
{
|
|
*data.out, data.room->room_id
|
|
};
|
|
|
|
json::stack::object timeline
|
|
{
|
|
*data.out, "timeline"
|
|
};
|
|
|
|
json::stack::array array
|
|
{
|
|
*data.out, "events"
|
|
};
|
|
|
|
return _room_timeline_append(data, array, data.event_idx, *data.event);
|
|
}
|
|
|
|
bool
|
|
ircd::m::sync::_room_timeline_linear_command(data &data)
|
|
{
|
|
const m::room &room
|
|
{
|
|
unquote(json::get<"content"_>(*data.event).get("room_id"))
|
|
};
|
|
|
|
const scope_restore _room
|
|
{
|
|
data.room, &room
|
|
};
|
|
|
|
const scope_restore _membership
|
|
{
|
|
data.membership, "join"_sv
|
|
};
|
|
|
|
json::stack::object membership_
|
|
{
|
|
*data.out, data.membership
|
|
};
|
|
|
|
json::stack::object room_
|
|
{
|
|
*data.out, data.room->room_id
|
|
};
|
|
|
|
json::stack::object timeline
|
|
{
|
|
*data.out, "timeline"
|
|
};
|
|
|
|
json::stack::array array
|
|
{
|
|
*data.out, "events"
|
|
};
|
|
|
|
m::event event{*data.event};
|
|
json::get<"type"_>(event) = "m.room.message";
|
|
json::get<"room_id"_>(event) = room.room_id;
|
|
const scope_restore _event
|
|
{
|
|
data.event, &event
|
|
};
|
|
|
|
return _room_timeline_append(data, array, data.event_idx, event);
|
|
}
|
|
|
|
bool
|
|
ircd::m::sync::room_timeline_polylog(data &data)
|
|
{
|
|
if(!apropos(data, data.room_head))
|
|
return false;
|
|
|
|
// events
|
|
assert(data.room);
|
|
bool limited{false}, ret{false};
|
|
m::event::id::buf prev
|
|
{
|
|
_room_timeline_polylog_events(data, *data.room, limited, ret)
|
|
};
|
|
|
|
// prev_batch
|
|
json::stack::member
|
|
{
|
|
*data.out, "prev_batch", string_view{prev}
|
|
};
|
|
|
|
// limited
|
|
json::stack::member
|
|
{
|
|
*data.out, "limited", json::value{limited}
|
|
};
|
|
|
|
return ret;
|
|
}
|
|
|
|
ircd::m::event::id::buf
|
|
ircd::m::sync::_room_timeline_polylog_events(data &data,
|
|
const m::room &room,
|
|
bool &limited,
|
|
bool &ret)
|
|
{
|
|
static const event::fetch::opts fopts
|
|
{
|
|
default_keys
|
|
};
|
|
|
|
json::stack::array array
|
|
{
|
|
*data.out, "events"
|
|
};
|
|
|
|
// messages seeks to the newest event, but the client wants the oldest
|
|
// event first so we seek down first and then iterate back up. Due to
|
|
// an issue with rocksdb's prefix-iteration this iterator becomes
|
|
// toxic as soon as it becomes invalid. As a result we have to copy the
|
|
// event_id on the way down in case of renewing the iterator for the
|
|
// way back. This is not a big deal but rocksdb should fix their shit.
|
|
m::event::id::buf event_id;
|
|
m::room::messages it
|
|
{
|
|
room, &fopts
|
|
};
|
|
|
|
ssize_t i(0);
|
|
const ssize_t limit
|
|
{
|
|
data.phased && data.range.first == 0?
|
|
ssize_t(limit_initial_default): // phased + initial=true
|
|
ssize_t(limit_default)
|
|
};
|
|
|
|
for(; it && i <= limit; --it)
|
|
{
|
|
if(!i && it.event_idx() >= data.range.second)
|
|
continue;
|
|
|
|
event_id = it.event_id();
|
|
if(it.event_idx() < data.range.first)
|
|
break;
|
|
|
|
++i;
|
|
}
|
|
|
|
limited = i >= limit;
|
|
if(i > 0 && !it)
|
|
it.seek(event_id);
|
|
|
|
if(i > 0)
|
|
for(++it; it && i > -1; ++it, --i)
|
|
{
|
|
const m::event &event(*it);
|
|
const m::event::idx &event_idx(it.event_idx());
|
|
ret |= _room_timeline_append(data, array, event_idx, event);
|
|
}
|
|
|
|
return event_id;
|
|
}
|
|
|
|
bool
|
|
ircd::m::sync::_room_timeline_append(data &data,
|
|
json::stack::array &events,
|
|
const m::event::idx &event_idx,
|
|
const m::event &event)
|
|
{
|
|
m::event_append_opts opts;
|
|
opts.event_idx = &event_idx;
|
|
opts.client_txnid = &data.client_txnid;
|
|
opts.user_id = &data.user.user_id;
|
|
opts.user_room = &data.user_room;
|
|
opts.room_depth = &data.room_depth;
|
|
return m::append(events, event, opts);
|
|
}
|