Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Allow modules to create and send events into rooms #8479

Merged
merged 16 commits into from
Oct 9, 2020
Merged

Allow modules to create and send events into rooms #8479

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
56834af
Add ignore_spam_check option to event creation function
anoadragon453 Oct 6, 2020
e7ea5dd
Add ignore_third_party_event_rules option to event creation function
anoadragon453 Oct 6, 2020
0f8e5a1
Allow modules to create and send non-member events into a room
anoadragon453 Oct 6, 2020
cec0b57
Add a test for creating and sending events
anoadragon453 Oct 6, 2020
fc4d832
Changelog
anoadragon453 Oct 6, 2020
df81f68
Fix cyclic dependencies
anoadragon453 Oct 6, 2020
14d182f
Remove spam_check and ThirdPartyEventRules bypass options, fix cycle
anoadragon453 Oct 8, 2020
a8a2258
Test that ThirdPartyEventRules modules can send events into rooms
anoadragon453 Oct 8, 2020
05ae414
Fix typo
anoadragon453 Oct 8, 2020
82f50f1
mypy
anoadragon453 Oct 8, 2020
d61457d
fix accidental indentation
anoadragon453 Oct 8, 2020
7565d87
lint
anoadragon453 Oct 8, 2020
e16b50e
Fix cycles... again
anoadragon453 Oct 8, 2020
3140dbb
Mention that state events may be deduplicated when sent
anoadragon453 Oct 9, 2020
16f979c
Simply interface to create_and_send_event_into_room
anoadragon453 Oct 9, 2020
17208c2
Update tests to provide event dicts
anoadragon453 Oct 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 5 additions & 33 deletions synapse/module_api/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@

from twisted.internet import defer

from synapse.api.constants import EventTypes
from synapse.events import EventBase
from synapse.http.client import SimpleHttpClient
from synapse.http.site import SynapseRequest
Expand Down Expand Up @@ -322,22 +321,12 @@ def get_state_events_in_room(
state = yield defer.ensureDeferred(self._store.get_events(state_ids.values()))
return state.values()

async def create_and_send_event_into_room(
self,
sender: str,
room_id: str,
event_type: str,
content: JsonDict,
state_key: Optional[str] = None,
) -> EventBase:
"""Create and send an event into a room.
async def create_and_send_event_into_room(self, event_dict: JsonDict) -> EventBase:
"""Create and send an event into a room. Membership events are currently not supported.

Args:
sender: The user ID of the event sender.
room_id: The ID of the room to send the event into.
event_type: The type of the event.
content: The event content.
state_key: The event's state key. None if this is not a state event.
event_dict: A dictionary representing the event to send.
Required keys are `type`, `room_id`, `sender` and `content`.

Returns:
The event that was sent. If state event deduplication happened, then
Expand All @@ -346,25 +335,8 @@ async def create_and_send_event_into_room(
Raises:
SynapseError if the event was not allowed.
"""
if event_type == EventTypes.Member:
raise Exception(
"Synapse modules are not currently able to send m.room.member events"
)

# Build event dictionary
event_dict = {
"type": event_type,
"content": content,
"room_id": room_id,
"sender": sender,
}

# Check whether this is intended to be a state event
if state_key is not None:
event_dict["state_key"] = state_key

# Create a requester object
requester = create_requester(sender)
requester = create_requester(event_dict["sender"])

# Create and send the event
(
Expand Down