Matrix-Mirrors/synapse-product
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse-product.git synced 2024-12-12 03:44:20 -05:00
Code Issues Packages Projects Releases Wiki Activity
8ca79613e6
synapse-product/synapse/server.pyi

136 lines
4.7 KiB
Python
Raw Normal View History

Wake up transaction queue when remote server comes back online (#6706) This will be used to retry outbound transactions to a remote server if we think it might have come back up.
2020-01-17 05:27:19 -05:00
import twisted.internet
Fix login with m.login.token login with token (as used by CAS auth) was broken by 067596d, such that it always returned a 401.
2016-08-08 11:34:07 -04:00
import synapse.api.auth
Infrastructure for a server notices room Server Notices use a special room which the user can't dismiss. They are created on demand when some other bit of the code calls send_notice. (This doesn't actually do much yet becuse we don't call send_notice anywhere)
2018-05-17 06:34:28 -04:00
import synapse.config.homeserver
Fix sending server up commands from workers (#6811) Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2020-01-30 11:42:11 -05:00
import synapse.crypto.keyring
Port PresenceHandler to async/await (#6991)
2020-02-26 10:33:26 -05:00
import synapse.federation.federation_server
Rename and move the classes
2019-03-13 16:02:56 -04:00
import synapse.federation.sender
Doc some more dynamic Homeserver methods
2017-10-17 14:46:56 -04:00
import synapse.federation.transport.client
Type annotations Add some type annotations to help PyCharm (in particular) to figure out the types of a bunch of things.
2016-07-19 05:21:42 -04:00
import synapse.handlers
import synapse.handlers.auth
Move deactivate_account into its own handler Non-functional refactoring to move deactivate_account. This means that we'll be able to properly deactivate devices and access tokens without introducing a dependency loop.
2017-11-29 06:48:43 -05:00
import synapse.handlers.deactivate_account
Type annotations Add some type annotations to help PyCharm (in particular) to figure out the types of a bunch of things.
2016-07-19 05:21:42 -04:00
import synapse.handlers.device
Move e2e query logic into a handler
2016-08-01 13:02:07 -04:00
import synapse.handlers.e2e_keys
Move from TravisCI to BuildKite (#4752)
2019-02-27 16:03:14 -05:00
import synapse.handlers.message
Wake up transaction queue when remote server comes back online (#6706) This will be used to retry outbound transactions to a remote server if we think it might have come back up.
2020-01-17 05:27:19 -05:00
import synapse.handlers.presence
Implement OpenID Connect-based login (#7256)
2020-05-08 08:30:40 -04:00
import synapse.handlers.register
Basic initial support for room upgrades Currently just creates a new, empty, room, and sends a tombstone in the old room.
2018-08-22 05:57:54 -04:00
import synapse.handlers.room
import synapse.handlers.room_member
Move set_password into its own handler Non-functional refactoring to move set_password. This means that we'll be able to properly deactivate devices and access tokens without introducing a dependency loop.
2017-11-29 09:10:46 -05:00
import synapse.handlers.set_password
Support for routing outbound HTTP requests via a proxy (#6239) The `http_proxy` and `HTTPS_PROXY` env vars can be set to a `host[:port]` value which should point to a proxy. The address of the proxy should be excluded from IP blacklists such as the `url_preview_ip_range_blacklist`. The proxy will then be used for * push * url previews * phone-home stats * recaptcha validation * CAS auth validation It will *not* be used for: * Application Services * Identity servers * Outbound federation * In worker configurations, connections from workers to masters Fixes #4198.
2019-11-01 10:07:44 -04:00
import synapse.http.client
Wake up transaction queue when remote server comes back online (#6706) This will be used to retry outbound transactions to a remote server if we think it might have come back up.
2020-01-17 05:27:19 -05:00
import synapse.notifier
Fix sending server up commands from workers (#6811) Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2020-01-30 11:42:11 -05:00
import synapse.replication.tcp.client
Move client command handling out of TCP protocol (#7185) The aim here is to move the command handling out of the TCP protocol classes and to also merge the client and server command handling (so that we can reuse them for redis protocol). This PR simply moves the client paths to the new `ReplicationCommandHandler`, a future PR will move the server paths too.
2020-04-06 04:58:42 -04:00
import synapse.replication.tcp.handler
Build MediaRepositoryResource as a homeserver dependency This avoids the scenario where we have four different PreviewUrlResources configured on a single app, each of which have their own caches and cache clearing jobs.
2017-11-21 06:08:08 -05:00
import synapse.rest.media.v1.media_repository
Infrastructure for a server notices room Server Notices use a special room which the user can't dismiss. They are created on demand when some other bit of the code calls send_notice. (This doesn't actually do much yet becuse we don't call send_notice anywhere)
2018-05-17 06:34:28 -04:00
import synapse.server_notices.server_notices_manager
Send users a server notice about consent When a user first syncs, we will send them a server notice asking them to consent to the privacy policy if they have not already done so.
2018-05-17 12:35:31 -04:00
import synapse.server_notices.server_notices_sender
Type annotations Add some type annotations to help PyCharm (in particular) to figure out the types of a bunch of things.
2016-07-19 05:21:42 -04:00
import synapse.state
Move deactivate_account into its own handler Non-functional refactoring to move deactivate_account. This means that we'll be able to properly deactivate devices and access tokens without introducing a dependency loop.
2017-11-29 06:48:43 -05:00
import synapse.storage
Fix limit logic for EventsStream (#7358) * Factor out functions for injecting events into database I want to add some more flexibility to the tools for injecting events into the database, and I don't want to clutter up HomeserverTestCase with them, so let's factor them out to a new file. * Rework TestReplicationDataHandler This wasn't very easy to work with: the mock wrapping was largely superfluous, and it's useful to be able to inspect the received rows, and clear out the received list. * Fix AssertionErrors being thrown by EventsStream Part of the problem was that there was an off-by-one error in the assertion, but also the limit logic was too simple. Fix it all up and add some tests.
2020-04-29 07:30:36 -04:00
from synapse.events.builder import EventBuilderFactory
Move deactivate_account into its own handler Non-functional refactoring to move deactivate_account. This means that we'll be able to properly deactivate devices and access tokens without introducing a dependency loop.
2017-11-29 06:48:43 -05:00
Type annotations Add some type annotations to help PyCharm (in particular) to figure out the types of a bunch of things.
2016-07-19 05:21:42 -04:00
class HomeServer(object):
Infrastructure for a server notices room Server Notices use a special room which the user can't dismiss. They are created on demand when some other bit of the code calls send_notice. (This doesn't actually do much yet becuse we don't call send_notice anywhere)
2018-05-17 06:34:28 -04:00
@property
def config(self) -> synapse.config.homeserver.HomeServerConfig:
pass
Fix sending server up commands from workers (#6811) Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2020-01-30 11:42:11 -05:00
@property
def hostname(self) -> str:
pass
Fix login with m.login.token login with token (as used by CAS auth) was broken by 067596d, such that it always returned a 401.
2016-08-08 11:34:07 -04:00
def get_auth(self) -> synapse.api.auth.Auth:
pass
Type annotations Add some type annotations to help PyCharm (in particular) to figure out the types of a bunch of things.
2016-07-19 05:21:42 -04:00
def get_auth_handler(self) -> synapse.handlers.auth.AuthHandler:
pass
def get_datastore(self) -> synapse.storage.DataStore:
pass
def get_device_handler(self) -> synapse.handlers.device.DeviceHandler:
pass
Move e2e query logic into a handler
2016-08-01 13:02:07 -04:00
def get_e2e_keys_handler(self) -> synapse.handlers.e2e_keys.E2eKeysHandler:
pass
Type annotations Add some type annotations to help PyCharm (in particular) to figure out the types of a bunch of things.
2016-07-19 05:21:42 -04:00
def get_handlers(self) -> synapse.handlers.Handlers:
pass
def get_state_handler(self) -> synapse.state.StateHandler:
pass
Factor out resolve_state_groups to a separate handler We extract the storage-independent bits of the state group resolution out to a separate functiom, and stick it in a new handler, in preparation for its use from the storage layer.
2018-01-27 04:15:45 -05:00
def get_state_resolution_handler(self) -> synapse.state.StateResolutionHandler:
pass
Support for routing outbound HTTP requests via a proxy (#6239) The `http_proxy` and `HTTPS_PROXY` env vars can be set to a `host[:port]` value which should point to a proxy. The address of the proxy should be excluded from IP blacklists such as the `url_preview_ip_range_blacklist`. The proxy will then be used for * push * url previews * phone-home stats * recaptcha validation * CAS auth validation It will *not* be used for: * Application Services * Identity servers * Outbound federation * In worker configurations, connections from workers to masters Fixes #4198.
2019-11-01 10:07:44 -04:00
def get_simple_http_client(self) -> synapse.http.client.SimpleHttpClient:
"""Fetch an HTTP client implementation which doesn't do any blacklisting
or support any HTTP_PROXY settings"""
pass
def get_proxied_http_client(self) -> synapse.http.client.SimpleHttpClient:
"""Fetch an HTTP client implementation which doesn't do any blacklisting
but does support HTTP_PROXY settings"""
pass
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
def get_deactivate_account_handler(
Update black to 19.10b0 (#6304) * update version of black and also fix the mypy config being overridden
2019-10-31 11:43:24 -04:00
self,
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
) -> synapse.handlers.deactivate_account.DeactivateAccountHandler:
Move deactivate_account into its own handler Non-functional refactoring to move deactivate_account. This means that we'll be able to properly deactivate devices and access tokens without introducing a dependency loop.
2017-11-29 06:48:43 -05:00
pass
Move RoomCreationHandler out of synapse.handlers.Handlers Handlers is deprecated nowadays, so let's move this out before I add a new dependency on it. Also fix the docstrings on create_room.
2018-05-17 04:01:09 -04:00
def get_room_creation_handler(self) -> synapse.handlers.room.RoomCreationHandler:
pass
Basic initial support for room upgrades Currently just creates a new, empty, room, and sends a tombstone in the old room.
2018-08-22 05:57:54 -04:00
def get_room_member_handler(self) -> synapse.handlers.room_member.RoomMemberHandler:
pass
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
def get_event_creation_handler(
Update black to 19.10b0 (#6304) * update version of black and also fix the mypy config being overridden
2019-10-31 11:43:24 -04:00
self,
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
) -> synapse.handlers.message.EventCreationHandler:
Infrastructure for a server notices room Server Notices use a special room which the user can't dismiss. They are created on demand when some other bit of the code calls send_notice. (This doesn't actually do much yet becuse we don't call send_notice anywhere)
2018-05-17 06:34:28 -04:00
pass
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
def get_set_password_handler(
Update black to 19.10b0 (#6304) * update version of black and also fix the mypy config being overridden
2019-10-31 11:43:24 -04:00
self,
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
) -> synapse.handlers.set_password.SetPasswordHandler:
Move set_password into its own handler Non-functional refactoring to move set_password. This means that we'll be able to properly deactivate devices and access tokens without introducing a dependency loop.
2017-11-29 09:10:46 -05:00
pass
Rename and move the classes
2019-03-13 16:02:56 -04:00
def get_federation_sender(self) -> synapse.federation.sender.FederationSender:
Doc some more dynamic Homeserver methods
2017-10-17 14:46:56 -04:00
pass
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
def get_federation_transport_client(
Update black to 19.10b0 (#6304) * update version of black and also fix the mypy config being overridden
2019-10-31 11:43:24 -04:00
self,
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
) -> synapse.federation.transport.client.TransportLayerClient:
Doc some more dynamic Homeserver methods
2017-10-17 14:46:56 -04:00
pass
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
def get_media_repository_resource(
Update black to 19.10b0 (#6304) * update version of black and also fix the mypy config being overridden
2019-10-31 11:43:24 -04:00
self,
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
) -> synapse.rest.media.v1.media_repository.MediaRepositoryResource:
Build MediaRepositoryResource as a homeserver dependency This avoids the scenario where we have four different PreviewUrlResources configured on a single app, each of which have their own caches and cache clearing jobs.
2017-11-21 06:08:08 -05:00
pass
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
def get_media_repository(
Update black to 19.10b0 (#6304) * update version of black and also fix the mypy config being overridden
2019-10-31 11:43:24 -04:00
self,
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
) -> synapse.rest.media.v1.media_repository.MediaRepository:
Build MediaRepositoryResource as a homeserver dependency This avoids the scenario where we have four different PreviewUrlResources configured on a single app, each of which have their own caches and cache clearing jobs.
2017-11-21 06:08:08 -05:00
pass
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
def get_server_notices_manager(
Update black to 19.10b0 (#6304) * update version of black and also fix the mypy config being overridden
2019-10-31 11:43:24 -04:00
self,
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
) -> synapse.server_notices.server_notices_manager.ServerNoticesManager:
Infrastructure for a server notices room Server Notices use a special room which the user can't dismiss. They are created on demand when some other bit of the code calls send_notice. (This doesn't actually do much yet becuse we don't call send_notice anywhere)
2018-05-17 06:34:28 -04:00
pass
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
def get_server_notices_sender(
Update black to 19.10b0 (#6304) * update version of black and also fix the mypy config being overridden
2019-10-31 11:43:24 -04:00
self,
Run Black. (#5482)
2019-06-20 05:32:02 -04:00
) -> synapse.server_notices.server_notices_sender.ServerNoticesSender:
Send users a server notice about consent When a user first syncs, we will send them a server notice asking them to consent to the privacy policy if they have not already done so.
2018-05-17 12:35:31 -04:00
pass
Wake up transaction queue when remote server comes back online (#6706) This will be used to retry outbound transactions to a remote server if we think it might have come back up.
2020-01-17 05:27:19 -05:00
def get_notifier(self) -> synapse.notifier.Notifier:
pass
Stop the master relaying USER_SYNC for other workers (#7318) Long story short: if we're handling presence on the current worker, we shouldn't be sending USER_SYNC commands over replication. In an attempt to figure out what is going on here, I ended up refactoring some bits of the presencehandler code, so the first 4 commits here are non-functional refactors to move this code slightly closer to sanity. (There's still plenty to do here :/). Suggest reviewing individual commits. Fixes (I hope) #7257.
2020-04-22 17:39:04 -04:00
def get_presence_handler(self) -> synapse.handlers.presence.BasePresenceHandler:
Wake up transaction queue when remote server comes back online (#6706) This will be used to retry outbound transactions to a remote server if we think it might have come back up.
2020-01-17 05:27:19 -05:00
pass
def get_clock(self) -> synapse.util.Clock:
pass
def get_reactor(self) -> twisted.internet.base.ReactorBase:
pass
Fix sending server up commands from workers (#6811) Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2020-01-30 11:42:11 -05:00
def get_keyring(self) -> synapse.crypto.keyring.Keyring:
pass
def get_tcp_replication(
self,
Move client command handling out of TCP protocol (#7185) The aim here is to move the command handling out of the TCP protocol classes and to also merge the client and server command handling (so that we can reuse them for redis protocol). This PR simply moves the client paths to the new `ReplicationCommandHandler`, a future PR will move the server paths too.
2020-04-06 04:58:42 -04:00
) -> synapse.replication.tcp.handler.ReplicationCommandHandler:
pass
def get_replication_data_handler(
self,
) -> synapse.replication.tcp.client.ReplicationDataHandler:
Fix sending server up commands from workers (#6811) Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2020-01-30 11:42:11 -05:00
pass
Port PresenceHandler to async/await (#6991)
2020-02-26 10:33:26 -05:00
def get_federation_registry(
self,
) -> synapse.federation.federation_server.FederationHandlerRegistry:
pass
Add typing to synapse.federation.sender (#6871)
2020-02-07 08:56:38 -05:00
def is_mine_id(self, domain_id: str) -> bool:
pass
Remove usage of "conn_id" for presence. (#7128) * Remove `conn_id` usage for UserSyncCommand. Each tcp replication connection is assigned a "conn_id", which is used to give an ID to a remotely connected worker. In a redis world, there will no longer be a one to one mapping between connection and instance, so instead we need to replace such usages with an ID generated by the remote instances and included in the replicaiton commands. This really only effects UserSyncCommand. * Add CLEAR_USER_SYNCS command that is sent on shutdown. This should help with the case where a synchrotron gets restarted gracefully, rather than rely on 5 minute timeout.
2020-03-30 11:37:24 -04:00
def get_instance_id(self) -> str:
pass
Add instance name to RDATA/POSITION commands (#7364) This is primarily for allowing us to send those commands from workers, but for now simply allows us to ignore echoed RDATA/POSITION commands that we sent (we get echoes of sent commands when using redis). Currently we log a WARNING on the master process every time we receive an echoed RDATA.
2020-04-29 11:23:08 -04:00
def get_instance_name(self) -> str:
pass
Fix limit logic for EventsStream (#7358) * Factor out functions for injecting events into database I want to add some more flexibility to the tools for injecting events into the database, and I don't want to clutter up HomeserverTestCase with them, so let's factor them out to a new file. * Rework TestReplicationDataHandler This wasn't very easy to work with: the mock wrapping was largely superfluous, and it's useful to be able to inspect the received rows, and clear out the received list. * Fix AssertionErrors being thrown by EventsStream Part of the problem was that there was an off-by-one error in the assertion, but also the limit logic was too simple. Fix it all up and add some tests.
2020-04-29 07:30:36 -04:00
def get_event_builder_factory(self) -> EventBuilderFactory:
pass
def get_storage(self) -> synapse.storage.Storage:
pass
Implement OpenID Connect-based login (#7256)
2020-05-08 08:30:40 -04:00
def get_registration_handler(self) -> synapse.handlers.register.RegistrationHandler:
pass
def get_macaroon_generator(self) -> synapse.handlers.auth.MacaroonGenerator:
pass
Reference in New Issue Copy Permalink