mirror of
https://github.com/element-hq/synapse.git
synced 2024-12-22 12:44:30 +03:00
456 lines
40 KiB
HTML
456 lines
40 KiB
HTML
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="sidebar-visible no-js light">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Third-party rules callbacks - Synapse</title>
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
|
|
<meta name="description" content="">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff" />
|
||
|
|
|
||
|
|
<link rel="icon" href="../favicon.svg">
|
||
|
|
<link rel="shortcut icon" href="../favicon.png">
|
||
|
|
<link rel="stylesheet" href="../css/variables.css">
|
||
|
|
<link rel="stylesheet" href="../css/general.css">
|
||
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
||
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" href="../highlight.css">
|
||
|
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
<link rel="stylesheet" href="../docs/website_files/table-of-contents.css">
|
||
|
|
<link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css">
|
||
|
|
<link rel="stylesheet" href="../docs/website_files/indent-section-headers.css">
|
||
|
|
<link rel="stylesheet" href="../docs/website_files/version-picker.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Provide site root to javascript -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var path_to_root = "../";
|
||
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
try {
|
||
|
|
var theme = localStorage.getItem('mdbook-theme');
|
||
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
html.classList.remove('no-js')
|
||
|
|
html.classList.remove('light')
|
||
|
|
html.classList.add(theme);
|
||
|
|
html.classList.add('js');
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
var sidebar = 'hidden';
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
}
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<div class="sidebar-scrollbox">
|
||
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><li class="part-title">Introduction</li><li class="chapter-item expanded "><a href="../welcome_and_overview.html">Welcome and Overview</a></li><li class="chapter-item expanded affix "><li class="part-title">Setup</li><li class="chapter-item expanded "><a href="../setup/installation.html">Installation</a></li><li class="chapter-item expanded "><a href="../postgres.html">Using Postgres</a></li><li class="chapter-item expanded "><a href="../reverse_proxy.html">Configuring a Reverse Proxy</a></li><li class="chapter-item expanded "><a href="../setup/forward_proxy.html">Configuring a Forward/Outbound Proxy</a></li><li class="chapter-item expanded "><a href="../turn-howto.html">Configuring a Turn Server</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../setup/turn/coturn.html">coturn TURN server</a></li><li class="chapter-item expanded "><a href="../setup/turn/eturnal.html">eturnal TURN server</a></li></ol></li><li class="chapter-item expanded "><a href="../delegate.html">Delegation</a></li><li class="chapter-item expanded affix "><li class="part-title">Upgrading</li><li class="chapter-item expanded "><a href="../upgrade.html">Upgrading between Synapse Versions</a></li><li class="chapter-item expanded affix "><li class="part-title">Usage</li><li class="chapter-item expanded "><a href="../federate.html">Federation</a></li><li class="chapter-item expanded "><a href="../usage/configuration/index.html">Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/configuration/config_documentation.html">Configuration Manual</a></li><li class="chapter-item expanded "><a href="../usage/configuration/homeserver_sample_config.html">Homeserver Sample Config File</a></li><li class="chapter-item expanded "><a href="../usage/configuration/logging_sample_config.html">Logging Sample Config File</a></li><li class="chapter-item expanded "><a href="../structured_logging.html">Structured Logging</a></li><li class="chapter-item expanded "><a href="../templates.html">Templates</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/index.html">User Authentication</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/single_sign_on/index.html">Single-Sign On</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../openid.html">OpenID Connect</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/single_sign_on/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/single_sign_on/cas.html">CAS</a></li><li class="chapter-item expanded "><a href="../sso_mapping_providers.html">SSO Mapping Providers</a></li></ol></li><li class="chapter-item expanded "><a href="../password_auth_providers.html">Password Auth Providers</a></li><li class="chapter-item expanded "><a href="../jwt.html">JSON Web Tokens</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/refresh_tokens.html">Refresh Tokens</a></li></ol></li><li class="chapter-item expanded "><a href="../CAPTCHA_SETUP.html">Registration Captcha</a></li><li class="chapter-item expanded "><a href="../application_services.html">Application Services</a></li><li class="chapter-item expanded "><a href="../server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="../consent_tracking.html">Consent Tracking</a></li><li class="chapter-item expanded "><a href="../user_directory.html">User Directory</a></li><li class="chapter-item expanded "><a href="../message_retention_policies.html">Message Retention Policies</a></li><li class="chapter-item expanded "><a href="../modules/index.html">Pluggable Modules</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../modules/writing_a_module.html">Writing a module</a></li><li><ol class="section"><li class="chapter-item expanded "
|
||
|
|
</div>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</button>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
</ul>
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
<div class="version-picker">
|
||
|
|
<div class="dropdown">
|
||
|
|
<div class="select">
|
||
|
|
<span></span>
|
||
|
|
<i class="fa fa-chevron-down"></i>
|
||
|
|
</div>
|
||
|
|
<input type="hidden" name="version">
|
||
|
|
<ul class="dropdown-menu">
|
||
|
|
<!-- Versions will be added dynamically in version-picker.js -->
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title">Synapse</h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/element-hq/synapse/edit/develop/docs/modules/third_party_rules_callbacks.md" title="Suggest an edit" aria-label="Suggest an edit">
|
||
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<!-- Page table of contents -->
|
||
|
|
<div class="sidetoc">
|
||
|
|
<nav class="pagetoc"></nav>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 id="third-party-rules-callbacks"><a class="header" href="#third-party-rules-callbacks">Third party rules callbacks</a></h1>
|
||
|
|
<p>Third party rules callbacks allow module developers to add extra checks to verify the
|
||
|
|
validity of incoming events. Third party event rules callbacks can be registered using
|
||
|
|
the module API's <code>register_third_party_rules_callbacks</code> method.</p>
|
||
|
|
<h2 id="callbacks"><a class="header" href="#callbacks">Callbacks</a></h2>
|
||
|
|
<p>The available third party rules callbacks are:</p>
|
||
|
|
<h3 id="check_event_allowed"><a class="header" href="#check_event_allowed"><code>check_event_allowed</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.39.0</em></p>
|
||
|
|
<pre><code class="language-python">async def check_event_allowed(
|
||
|
|
event: "synapse.events.EventBase",
|
||
|
|
state_events: "synapse.types.StateMap",
|
||
|
|
) -> Tuple[bool, Optional[dict]]
|
||
|
|
</code></pre>
|
||
|
|
<p><strong><span style="color:red">
|
||
|
|
This callback is very experimental and can and will break without notice. Module developers
|
||
|
|
are encouraged to implement <code>check_event_for_spam</code> from the spam checker category instead.
|
||
|
|
</span></strong></p>
|
||
|
|
<p>Called when processing any incoming event, with the event and a <code>StateMap</code>
|
||
|
|
representing the current state of the room the event is being sent into. A <code>StateMap</code> is
|
||
|
|
a dictionary that maps tuples containing an event type and a state key to the
|
||
|
|
corresponding state event. For example retrieving the room's <code>m.room.create</code> event from
|
||
|
|
the <code>state_events</code> argument would look like this: <code>state_events.get(("m.room.create", ""))</code>.
|
||
|
|
The module must return a boolean indicating whether the event can be allowed.</p>
|
||
|
|
<p>Note that this callback function processes incoming events coming via federation
|
||
|
|
traffic (on top of client traffic). This means denying an event might cause the local
|
||
|
|
copy of the room's history to diverge from that of remote servers. This may cause
|
||
|
|
federation issues in the room. It is strongly recommended to only deny events using this
|
||
|
|
callback function if the sender is a local user, or in a private federation in which all
|
||
|
|
servers are using the same module, with the same configuration.</p>
|
||
|
|
<p>If the boolean returned by the module is <code>True</code>, it may also tell Synapse to replace the
|
||
|
|
event with new data by returning the new event's data as a dictionary. In order to do
|
||
|
|
that, it is recommended the module calls <code>event.get_dict()</code> to get the current event as a
|
||
|
|
dictionary, and modify the returned dictionary accordingly.</p>
|
||
|
|
<p>If <code>check_event_allowed</code> raises an exception, the module is assumed to have failed.
|
||
|
|
The event will not be accepted but is not treated as explicitly rejected, either.
|
||
|
|
An HTTP request causing the module check will likely result in a 500 Internal
|
||
|
|
Server Error.</p>
|
||
|
|
<p>When the boolean returned by the module is <code>False</code>, the event is rejected.
|
||
|
|
(Module developers should not use exceptions for rejection.)</p>
|
||
|
|
<p>Note that replacing the event only works for events sent by local users, not for events
|
||
|
|
received over federation.</p>
|
||
|
|
<p>If multiple modules implement this callback, they will be considered in order. If a
|
||
|
|
callback returns <code>True</code>, Synapse falls through to the next one. The value of the first
|
||
|
|
callback that does not return <code>True</code> will be used. If this happens, Synapse will not call
|
||
|
|
any of the subsequent implementations of this callback.</p>
|
||
|
|
<h3 id="on_create_room"><a class="header" href="#on_create_room"><code>on_create_room</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.39.0</em></p>
|
||
|
|
<pre><code class="language-python">async def on_create_room(
|
||
|
|
requester: "synapse.types.Requester",
|
||
|
|
request_content: dict,
|
||
|
|
is_requester_admin: bool,
|
||
|
|
) -> None
|
||
|
|
</code></pre>
|
||
|
|
<p>Called when processing a room creation request, with the <code>Requester</code> object for the user
|
||
|
|
performing the request, a dictionary representing the room creation request's JSON body
|
||
|
|
(see <a href="https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-createroom">the spec</a>
|
||
|
|
for a list of possible parameters), and a boolean indicating whether the user performing
|
||
|
|
the request is a server admin.</p>
|
||
|
|
<p>Modules can modify the <code>request_content</code> (by e.g. adding events to its <code>initial_state</code>),
|
||
|
|
or deny the room's creation by raising a <code>module_api.errors.SynapseError</code>.</p>
|
||
|
|
<p>If multiple modules implement this callback, they will be considered in order. If a
|
||
|
|
callback returns without raising an exception, Synapse falls through to the next one. The
|
||
|
|
room creation will be forbidden as soon as one of the callbacks raises an exception. If
|
||
|
|
this happens, Synapse will not call any of the subsequent implementations of this
|
||
|
|
callback.</p>
|
||
|
|
<h3 id="check_threepid_can_be_invited"><a class="header" href="#check_threepid_can_be_invited"><code>check_threepid_can_be_invited</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.39.0</em></p>
|
||
|
|
<pre><code class="language-python">async def check_threepid_can_be_invited(
|
||
|
|
medium: str,
|
||
|
|
address: str,
|
||
|
|
state_events: "synapse.types.StateMap",
|
||
|
|
) -> bool:
|
||
|
|
</code></pre>
|
||
|
|
<p>Called when processing an invite via a third-party identifier (i.e. email or phone number).
|
||
|
|
The module must return a boolean indicating whether the invite can go through.</p>
|
||
|
|
<p>If multiple modules implement this callback, they will be considered in order. If a
|
||
|
|
callback returns <code>True</code>, Synapse falls through to the next one. The value of the first
|
||
|
|
callback that does not return <code>True</code> will be used. If this happens, Synapse will not call
|
||
|
|
any of the subsequent implementations of this callback.</p>
|
||
|
|
<h3 id="check_visibility_can_be_modified"><a class="header" href="#check_visibility_can_be_modified"><code>check_visibility_can_be_modified</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.39.0</em></p>
|
||
|
|
<pre><code class="language-python">async def check_visibility_can_be_modified(
|
||
|
|
room_id: str,
|
||
|
|
state_events: "synapse.types.StateMap",
|
||
|
|
new_visibility: str,
|
||
|
|
) -> bool:
|
||
|
|
</code></pre>
|
||
|
|
<p>Called when changing the visibility of a room in the local public room directory. The
|
||
|
|
visibility is a string that's either "public" or "private". The module must return a
|
||
|
|
boolean indicating whether the change can go through.</p>
|
||
|
|
<p>If multiple modules implement this callback, they will be considered in order. If a
|
||
|
|
callback returns <code>True</code>, Synapse falls through to the next one. The value of the first
|
||
|
|
callback that does not return <code>True</code> will be used. If this happens, Synapse will not call
|
||
|
|
any of the subsequent implementations of this callback.</p>
|
||
|
|
<h3 id="on_new_event"><a class="header" href="#on_new_event"><code>on_new_event</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.47.0</em></p>
|
||
|
|
<pre><code class="language-python">async def on_new_event(
|
||
|
|
event: "synapse.events.EventBase",
|
||
|
|
state_events: "synapse.types.StateMap",
|
||
|
|
) -> None:
|
||
|
|
</code></pre>
|
||
|
|
<p>Called after sending an event into a room. The module is passed the event, as well
|
||
|
|
as the state of the room <em>after</em> the event. This means that if the event is a state event,
|
||
|
|
it will be included in this state.</p>
|
||
|
|
<p>The state map may not be complete if Synapse hasn't yet loaded the full state
|
||
|
|
of the room. This can happen for events in rooms that were just joined from
|
||
|
|
a remote server.</p>
|
||
|
|
<p>Note that this callback is called when the event has already been processed and stored
|
||
|
|
into the room, which means this callback cannot be used to deny persisting the event. To
|
||
|
|
deny an incoming event, see <a href="spam_checker_callbacks.html#check_event_for_spam"><code>check_event_for_spam</code></a> instead.</p>
|
||
|
|
<p>For any given event, this callback will be called on every worker process, even if that worker will not end up
|
||
|
|
acting on that event. This callback will not be called for events that are marked as rejected.</p>
|
||
|
|
<p>If multiple modules implement this callback, Synapse runs them all in order.</p>
|
||
|
|
<h3 id="check_can_shutdown_room"><a class="header" href="#check_can_shutdown_room"><code>check_can_shutdown_room</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.55.0</em></p>
|
||
|
|
<pre><code class="language-python">async def check_can_shutdown_room(
|
||
|
|
user_id: str, room_id: str,
|
||
|
|
) -> bool:
|
||
|
|
</code></pre>
|
||
|
|
<p>Called when an admin user requests the shutdown of a room. The module must return a
|
||
|
|
boolean indicating whether the shutdown can go through. If the callback returns <code>False</code>,
|
||
|
|
the shutdown will not proceed and the caller will see a <code>M_FORBIDDEN</code> error.</p>
|
||
|
|
<p>If multiple modules implement this callback, they will be considered in order. If a
|
||
|
|
callback returns <code>True</code>, Synapse falls through to the next one. The value of the first
|
||
|
|
callback that does not return <code>True</code> will be used. If this happens, Synapse will not call
|
||
|
|
any of the subsequent implementations of this callback.</p>
|
||
|
|
<h3 id="check_can_deactivate_user"><a class="header" href="#check_can_deactivate_user"><code>check_can_deactivate_user</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.55.0</em></p>
|
||
|
|
<pre><code class="language-python">async def check_can_deactivate_user(
|
||
|
|
user_id: str, by_admin: bool,
|
||
|
|
) -> bool:
|
||
|
|
</code></pre>
|
||
|
|
<p>Called when the deactivation of a user is requested. User deactivation can be
|
||
|
|
performed by an admin or the user themselves, so developers are encouraged to check the
|
||
|
|
requester when implementing this callback. The module must return a
|
||
|
|
boolean indicating whether the deactivation can go through. If the callback returns <code>False</code>,
|
||
|
|
the deactivation will not proceed and the caller will see a <code>M_FORBIDDEN</code> error.</p>
|
||
|
|
<p>The module is passed two parameters, <code>user_id</code> which is the ID of the user being deactivated, and <code>by_admin</code> which is <code>True</code> if the request is made by a serve admin, and <code>False</code> otherwise.</p>
|
||
|
|
<p>If multiple modules implement this callback, they will be considered in order. If a
|
||
|
|
callback returns <code>True</code>, Synapse falls through to the next one. The value of the first
|
||
|
|
callback that does not return <code>True</code> will be used. If this happens, Synapse will not call
|
||
|
|
any of the subsequent implementations of this callback.</p>
|
||
|
|
<h3 id="on_profile_update"><a class="header" href="#on_profile_update"><code>on_profile_update</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.54.0</em></p>
|
||
|
|
<pre><code class="language-python">async def on_profile_update(
|
||
|
|
user_id: str,
|
||
|
|
new_profile: "synapse.module_api.ProfileInfo",
|
||
|
|
by_admin: bool,
|
||
|
|
deactivation: bool,
|
||
|
|
) -> None:
|
||
|
|
</code></pre>
|
||
|
|
<p>Called after updating a local user's profile. The update can be triggered either by the
|
||
|
|
user themselves or a server admin. The update can also be triggered by a user being
|
||
|
|
deactivated (in which case their display name is set to an empty string (<code>""</code>) and the
|
||
|
|
avatar URL is set to <code>None</code>). The module is passed the Matrix ID of the user whose profile
|
||
|
|
has been updated, their new profile, as well as a <code>by_admin</code> boolean that is <code>True</code> if the
|
||
|
|
update was triggered by a server admin (and <code>False</code> otherwise), and a <code>deactivated</code>
|
||
|
|
boolean that is <code>True</code> if the update is a result of the user being deactivated.</p>
|
||
|
|
<p>Note that the <code>by_admin</code> boolean is also <code>True</code> if the profile change happens as a result
|
||
|
|
of the user logging in through Single Sign-On, or if a server admin updates their own
|
||
|
|
profile.</p>
|
||
|
|
<p>Per-room profile changes do not trigger this callback to be called. Synapse administrators
|
||
|
|
wishing this callback to be called on every profile change are encouraged to disable
|
||
|
|
per-room profiles globally using the <code>allow_per_room_profiles</code> configuration setting in
|
||
|
|
Synapse's configuration file.
|
||
|
|
This callback is not called when registering a user, even when setting it through the
|
||
|
|
<a href="https://element-hq.github.io/synapse/latest/modules/password_auth_provider_callbacks.html#get_displayname_for_registration"><code>get_displayname_for_registration</code></a>
|
||
|
|
module callback.</p>
|
||
|
|
<p>If multiple modules implement this callback, Synapse runs them all in order.</p>
|
||
|
|
<h3 id="on_user_deactivation_status_changed"><a class="header" href="#on_user_deactivation_status_changed"><code>on_user_deactivation_status_changed</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.54.0</em></p>
|
||
|
|
<pre><code class="language-python">async def on_user_deactivation_status_changed(
|
||
|
|
user_id: str, deactivated: bool, by_admin: bool
|
||
|
|
) -> None:
|
||
|
|
</code></pre>
|
||
|
|
<p>Called after deactivating a local user, or reactivating them through the admin API. The
|
||
|
|
deactivation can be triggered either by the user themselves or a server admin. The module
|
||
|
|
is passed the Matrix ID of the user whose status is changed, as well as a <code>deactivated</code>
|
||
|
|
boolean that is <code>True</code> if the user is being deactivated and <code>False</code> if they're being
|
||
|
|
reactivated, and a <code>by_admin</code> boolean that is <code>True</code> if the deactivation was triggered by
|
||
|
|
a server admin (and <code>False</code> otherwise). This latter <code>by_admin</code> boolean is always <code>True</code>
|
||
|
|
if the user is being reactivated, as this operation can only be performed through the
|
||
|
|
admin API.</p>
|
||
|
|
<p>If multiple modules implement this callback, Synapse runs them all in order.</p>
|
||
|
|
<h3 id="on_threepid_bind"><a class="header" href="#on_threepid_bind"><code>on_threepid_bind</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.56.0</em></p>
|
||
|
|
<p><strong><span style="color:red">
|
||
|
|
This callback is deprecated in favour of the <code>on_add_user_third_party_identifier</code> callback, which
|
||
|
|
features the same functionality. The only difference is in name.
|
||
|
|
</span></strong></p>
|
||
|
|
<pre><code class="language-python">async def on_threepid_bind(user_id: str, medium: str, address: str) -> None:
|
||
|
|
</code></pre>
|
||
|
|
<p>Called after creating an association between a local user and a third-party identifier
|
||
|
|
(email address, phone number). The module is given the Matrix ID of the user the
|
||
|
|
association is for, as well as the medium (<code>email</code> or <code>msisdn</code>) and address of the
|
||
|
|
third-party identifier.</p>
|
||
|
|
<p>Note that this callback is <em>not</em> called after a successful association on an <em>identity
|
||
|
|
server</em>.</p>
|
||
|
|
<p>If multiple modules implement this callback, Synapse runs them all in order.</p>
|
||
|
|
<h3 id="on_add_user_third_party_identifier"><a class="header" href="#on_add_user_third_party_identifier"><code>on_add_user_third_party_identifier</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.79.0</em></p>
|
||
|
|
<pre><code class="language-python">async def on_add_user_third_party_identifier(user_id: str, medium: str, address: str) -> None:
|
||
|
|
</code></pre>
|
||
|
|
<p>Called after successfully creating an association between a user and a third-party identifier
|
||
|
|
(email address, phone number). The module is given the Matrix ID of the user the
|
||
|
|
association is for, as well as the medium (<code>email</code> or <code>msisdn</code>) and address of the
|
||
|
|
third-party identifier (i.e. an email address).</p>
|
||
|
|
<p>Note that this callback is <em>not</em> called if a user attempts to bind their third-party identifier
|
||
|
|
to an identity server (via a call to <a href="https://spec.matrix.org/v1.5/client-server-api/#post_matrixclientv3account3pidbind"><code>POST /_matrix/client/v3/account/3pid/bind</code></a>).</p>
|
||
|
|
<p>If multiple modules implement this callback, Synapse runs them all in order.</p>
|
||
|
|
<h3 id="on_remove_user_third_party_identifier"><a class="header" href="#on_remove_user_third_party_identifier"><code>on_remove_user_third_party_identifier</code></a></h3>
|
||
|
|
<p><em>First introduced in Synapse v1.79.0</em></p>
|
||
|
|
<pre><code class="language-python">async def on_remove_user_third_party_identifier(user_id: str, medium: str, address: str) -> None:
|
||
|
|
</code></pre>
|
||
|
|
<p>Called after successfully removing an association between a user and a third-party identifier
|
||
|
|
(email address, phone number). The module is given the Matrix ID of the user the
|
||
|
|
association is for, as well as the medium (<code>email</code> or <code>msisdn</code>) and address of the
|
||
|
|
third-party identifier (i.e. an email address).</p>
|
||
|
|
<p>Note that this callback is <em>not</em> called if a user attempts to unbind their third-party
|
||
|
|
identifier from an identity server (via a call to <a href="https://spec.matrix.org/v1.5/client-server-api/#post_matrixclientv3account3pidunbind"><code>POST /_matrix/client/v3/account/3pid/unbind</code></a>).</p>
|
||
|
|
<p>If multiple modules implement this callback, Synapse runs them all in order.</p>
|
||
|
|
<h2 id="example"><a class="header" href="#example">Example</a></h2>
|
||
|
|
<p>The example below is a module that implements the third-party rules callback
|
||
|
|
<code>check_event_allowed</code> to censor incoming messages as dictated by a third-party service.</p>
|
||
|
|
<pre><code class="language-python">from typing import Optional, Tuple
|
||
|
|
|
||
|
|
from synapse.module_api import ModuleApi
|
||
|
|
|
||
|
|
_DEFAULT_CENSOR_ENDPOINT = "https://my-internal-service.local/censor-event"
|
||
|
|
|
||
|
|
class EventCensorer:
|
||
|
|
def __init__(self, config: dict, api: ModuleApi):
|
||
|
|
self.api = api
|
||
|
|
self._endpoint = config.get("endpoint", _DEFAULT_CENSOR_ENDPOINT)
|
||
|
|
|
||
|
|
self.api.register_third_party_rules_callbacks(
|
||
|
|
check_event_allowed=self.check_event_allowed,
|
||
|
|
)
|
||
|
|
|
||
|
|
async def check_event_allowed(
|
||
|
|
self,
|
||
|
|
event: "synapse.events.EventBase",
|
||
|
|
state_events: "synapse.types.StateMap",
|
||
|
|
) -> Tuple[bool, Optional[dict]]:
|
||
|
|
event_dict = event.get_dict()
|
||
|
|
new_event_content = await self.api.http_client.post_json_get_json(
|
||
|
|
uri=self._endpoint, post_json=event_dict,
|
||
|
|
)
|
||
|
|
event_dict["content"] = new_event_content
|
||
|
|
return event_dict
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="../modules/spam_checker_callbacks.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
<a rel="next" href="../modules/presence_router_callbacks.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
<a rel="prev" href="../modules/spam_checker_callbacks.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
<a rel="next" href="../modules/presence_router_callbacks.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
window.playground_copyable = true;
|
||
|
|
</script>
|
||
|
|
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
<script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script>
|
||
|
|
<script type="text/javascript" src="../docs/website_files/version-picker.js"></script>
|
||
|
|
<script type="text/javascript" src="../docs/website_files/version.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|