2014-08-13 02:14:34 +00:00
|
|
|
#!/usr/bin/env python
|
2014-08-12 14:10:52 +00:00
|
|
|
# -*- coding: utf-8 -*-
|
2016-01-07 04:26:29 +00:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2019-02-14 17:10:36 +00:00
|
|
|
# Copyright 2019 New Vector Ltd
|
2014-08-12 14:10:52 +00:00
|
|
|
#
|
|
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
# you may not use this file except in compliance with the License.
|
|
|
|
# You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
2019-01-23 08:39:06 +00:00
|
|
|
|
2019-02-14 17:10:36 +00:00
|
|
|
from __future__ import print_function
|
|
|
|
|
2016-06-07 14:45:56 +00:00
|
|
|
import gc
|
2016-02-02 17:18:50 +00:00
|
|
|
import logging
|
|
|
|
import os
|
2015-02-17 10:54:06 +00:00
|
|
|
import sys
|
2017-03-10 15:16:50 +00:00
|
|
|
|
2018-07-21 05:47:18 +00:00
|
|
|
from six import iteritems
|
|
|
|
|
2018-10-19 20:49:26 +00:00
|
|
|
import psutil
|
2018-07-31 12:16:20 +00:00
|
|
|
from prometheus_client import Gauge
|
|
|
|
|
2018-07-09 06:09:20 +00:00
|
|
|
from twisted.application import service
|
|
|
|
from twisted.internet import defer, reactor
|
2019-02-14 17:10:36 +00:00
|
|
|
from twisted.python.failure import Failure
|
2018-07-09 06:09:20 +00:00
|
|
|
from twisted.web.resource import EncodingResourceWrapper, NoResource
|
|
|
|
from twisted.web.server import GzipEncoderFactory
|
|
|
|
from twisted.web.static import File
|
|
|
|
|
2017-08-15 14:57:46 +00:00
|
|
|
import synapse
|
2017-03-10 15:16:50 +00:00
|
|
|
import synapse.config.logger
|
2017-08-15 14:57:46 +00:00
|
|
|
from synapse import events
|
2018-07-09 06:09:20 +00:00
|
|
|
from synapse.api.urls import (
|
|
|
|
CONTENT_REPO_PREFIX,
|
|
|
|
FEDERATION_PREFIX,
|
|
|
|
LEGACY_MEDIA_PREFIX,
|
|
|
|
MEDIA_PREFIX,
|
|
|
|
SERVER_KEY_V2_PREFIX,
|
|
|
|
STATIC_PREFIX,
|
|
|
|
WEB_CLIENT_PREFIX,
|
|
|
|
)
|
2017-08-15 14:57:46 +00:00
|
|
|
from synapse.app import _base
|
2018-07-09 06:09:20 +00:00
|
|
|
from synapse.app._base import listen_ssl, listen_tcp, quit_with_error
|
Error if macaroon key is missing from config
Currently we store all access tokens in the DB, and fall back to that
check if we can't validate the macaroon, so our fallback works here, but
for guests, their macaroons don't get persisted, so we don't get to
find them in the database. Each restart, we generate a new ephemeral
key, so guests lose access after each server restart.
I tried to fix up the config stuff to be less insane, but gave up, so
instead I bolt on yet another piece of custom one-off insanity.
Also, add some basic tests for config generation and loading.
2016-02-05 01:58:23 +00:00
|
|
|
from synapse.config._base import ConfigError
|
2014-08-31 15:06:39 +00:00
|
|
|
from synapse.config.homeserver import HomeServerConfig
|
2017-08-15 14:57:46 +00:00
|
|
|
from synapse.federation.transport.server import TransportLayerServer
|
2017-11-02 14:18:24 +00:00
|
|
|
from synapse.http.additional_resource import AdditionalResource
|
2017-08-15 14:57:46 +00:00
|
|
|
from synapse.http.server import RootRedirect
|
|
|
|
from synapse.http.site import SynapseSite
|
2018-05-22 21:28:23 +00:00
|
|
|
from synapse.metrics import RegistryProxy
|
2018-07-25 08:41:12 +00:00
|
|
|
from synapse.metrics.background_process_metrics import run_as_background_process
|
2018-05-31 09:04:50 +00:00
|
|
|
from synapse.metrics.resource import METRICS_PREFIX, MetricsResource
|
2018-07-09 06:09:20 +00:00
|
|
|
from synapse.module_api import ModuleApi
|
2018-12-11 13:18:48 +00:00
|
|
|
from synapse.python_dependencies import check_requirements
|
2018-07-09 06:09:20 +00:00
|
|
|
from synapse.replication.http import REPLICATION_PREFIX, ReplicationRestResource
|
2017-03-30 12:31:10 +00:00
|
|
|
from synapse.replication.tcp.resource import ReplicationStreamProtocolFactory
|
2017-08-15 14:57:46 +00:00
|
|
|
from synapse.rest import ClientRestResource
|
2019-05-01 14:32:38 +00:00
|
|
|
from synapse.rest.admin import AdminRestResource
|
2017-08-15 14:57:46 +00:00
|
|
|
from synapse.rest.key.v2 import KeyApiV2Resource
|
|
|
|
from synapse.rest.media.v0.content_repository import ContentRepoResource
|
2018-12-05 13:38:58 +00:00
|
|
|
from synapse.rest.well_known import WellKnownResource
|
2017-08-15 14:57:46 +00:00
|
|
|
from synapse.server import HomeServer
|
2018-08-28 12:39:49 +00:00
|
|
|
from synapse.storage import DataStore, are_all_users_on_domain
|
2017-08-15 14:57:46 +00:00
|
|
|
from synapse.storage.engines import IncorrectDatabaseSetup, create_engine
|
|
|
|
from synapse.storage.prepare_database import UpgradeDatabaseException, prepare_database
|
2018-04-04 15:46:58 +00:00
|
|
|
from synapse.util.caches import CACHE_SIZE_FACTOR
|
2016-04-22 14:40:51 +00:00
|
|
|
from synapse.util.httpresourcetree import create_resource_tree
|
2017-08-15 14:57:46 +00:00
|
|
|
from synapse.util.logcontext import LoggingContext
|
2016-04-25 13:59:21 +00:00
|
|
|
from synapse.util.manhole import manhole
|
2017-11-02 14:18:24 +00:00
|
|
|
from synapse.util.module_loader import load_module
|
2017-08-15 14:57:46 +00:00
|
|
|
from synapse.util.rlimit import change_resource_limit
|
2018-09-17 16:37:56 +00:00
|
|
|
from synapse.util.versionstring import get_version_string
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2015-04-07 11:04:02 +00:00
|
|
|
logger = logging.getLogger("synapse.app.homeserver")
|
2014-08-12 14:10:52 +00:00
|
|
|
|
|
|
|
|
2015-05-14 15:39:19 +00:00
|
|
|
def gz_wrap(r):
|
|
|
|
return EncodingResourceWrapper(r, [GzipEncoderFactory()])
|
|
|
|
|
|
|
|
|
2016-01-26 13:52:29 +00:00
|
|
|
class SynapseHomeServer(HomeServer):
|
2018-08-28 12:39:49 +00:00
|
|
|
DATASTORE_CLASS = DataStore
|
|
|
|
|
2015-06-12 14:33:07 +00:00
|
|
|
def _listener_http(self, config, listener_config):
|
|
|
|
port = listener_config["port"]
|
2017-01-10 17:21:41 +00:00
|
|
|
bind_addresses = listener_config["bind_addresses"]
|
2015-06-12 14:33:07 +00:00
|
|
|
tls = listener_config.get("tls", False)
|
2015-06-15 16:11:44 +00:00
|
|
|
site_tag = listener_config.get("tag", port)
|
2015-06-12 14:33:07 +00:00
|
|
|
|
|
|
|
resources = {}
|
|
|
|
for res in listener_config["resources"]:
|
|
|
|
for name in res["names"]:
|
2019-01-20 23:54:43 +00:00
|
|
|
if name == "openid" and "federation" in res["names"]:
|
|
|
|
# Skip loading openid resource if federation is defined
|
|
|
|
# since federation resource will include openid
|
|
|
|
continue
|
2017-11-02 13:27:21 +00:00
|
|
|
resources.update(self._configure_named_resource(
|
|
|
|
name, res.get("compress", False),
|
|
|
|
))
|
2015-06-12 14:33:07 +00:00
|
|
|
|
2017-11-02 14:18:24 +00:00
|
|
|
additional_resources = listener_config.get("additional_resources", {})
|
|
|
|
logger.debug("Configuring additional resources: %r",
|
|
|
|
additional_resources)
|
|
|
|
module_api = ModuleApi(self, self.get_auth_handler())
|
|
|
|
for path, resmodule in additional_resources.items():
|
|
|
|
handler_cls, config = load_module(resmodule)
|
|
|
|
handler = handler_cls(config, module_api)
|
|
|
|
resources[path] = AdditionalResource(self, handler.handle_request)
|
|
|
|
|
2018-12-11 12:18:19 +00:00
|
|
|
# try to find something useful to redirect '/' to
|
2016-04-22 14:40:51 +00:00
|
|
|
if WEB_CLIENT_PREFIX in resources:
|
|
|
|
root_resource = RootRedirect(WEB_CLIENT_PREFIX)
|
2018-12-11 12:18:19 +00:00
|
|
|
elif STATIC_PREFIX in resources:
|
|
|
|
root_resource = RootRedirect(STATIC_PREFIX)
|
2016-04-22 14:40:51 +00:00
|
|
|
else:
|
2018-03-23 10:32:50 +00:00
|
|
|
root_resource = NoResource()
|
2016-04-22 14:40:51 +00:00
|
|
|
|
|
|
|
root_resource = create_resource_tree(resources, root_resource)
|
2016-12-18 19:42:43 +00:00
|
|
|
|
2015-06-12 14:33:07 +00:00
|
|
|
if tls:
|
2019-02-13 11:53:43 +00:00
|
|
|
ports = listen_ssl(
|
2017-09-06 15:48:49 +00:00
|
|
|
bind_addresses,
|
|
|
|
port,
|
|
|
|
SynapseSite(
|
|
|
|
"synapse.access.https.%s" % (site_tag,),
|
|
|
|
site_tag,
|
|
|
|
listener_config,
|
|
|
|
root_resource,
|
2018-05-10 17:46:59 +00:00
|
|
|
self.version_string,
|
2017-09-06 15:48:49 +00:00
|
|
|
),
|
|
|
|
self.tls_server_context_factory,
|
2019-01-18 08:02:08 +00:00
|
|
|
reactor=self.get_reactor(),
|
2017-09-06 15:48:49 +00:00
|
|
|
)
|
2019-02-13 11:53:43 +00:00
|
|
|
logger.info("Synapse now listening on TCP port %d (TLS)", port)
|
2017-09-02 15:26:40 +00:00
|
|
|
|
2015-06-12 14:33:07 +00:00
|
|
|
else:
|
2019-02-13 11:53:43 +00:00
|
|
|
ports = listen_tcp(
|
2017-09-06 15:48:49 +00:00
|
|
|
bind_addresses,
|
|
|
|
port,
|
|
|
|
SynapseSite(
|
|
|
|
"synapse.access.http.%s" % (site_tag,),
|
|
|
|
site_tag,
|
|
|
|
listener_config,
|
|
|
|
root_resource,
|
2018-05-10 17:46:59 +00:00
|
|
|
self.version_string,
|
2019-01-18 08:02:08 +00:00
|
|
|
),
|
|
|
|
reactor=self.get_reactor(),
|
2017-09-06 15:48:49 +00:00
|
|
|
)
|
2019-02-13 11:53:43 +00:00
|
|
|
logger.info("Synapse now listening on TCP port %d", port)
|
|
|
|
|
|
|
|
return ports
|
2014-08-14 08:52:20 +00:00
|
|
|
|
2017-11-02 13:27:21 +00:00
|
|
|
def _configure_named_resource(self, name, compress=False):
|
|
|
|
"""Build a resource map for a named resource
|
|
|
|
|
|
|
|
Args:
|
|
|
|
name (str): named resource: one of "client", "federation", etc
|
|
|
|
compress (bool): whether to enable gzip compression for this
|
|
|
|
resource
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
dict[str, Resource]: map from path to HTTP resource
|
|
|
|
"""
|
|
|
|
resources = {}
|
|
|
|
if name == "client":
|
|
|
|
client_resource = ClientRestResource(self)
|
|
|
|
if compress:
|
|
|
|
client_resource = gz_wrap(client_resource)
|
|
|
|
|
|
|
|
resources.update({
|
|
|
|
"/_matrix/client/api/v1": client_resource,
|
2019-06-06 16:34:07 +00:00
|
|
|
"/_synapse/password_reset": client_resource,
|
2017-11-02 13:27:21 +00:00
|
|
|
"/_matrix/client/r0": client_resource,
|
|
|
|
"/_matrix/client/unstable": client_resource,
|
|
|
|
"/_matrix/client/v2_alpha": client_resource,
|
|
|
|
"/_matrix/client/versions": client_resource,
|
2018-12-05 13:38:58 +00:00
|
|
|
"/.well-known/matrix/client": WellKnownResource(self),
|
2019-05-01 14:18:58 +00:00
|
|
|
"/_synapse/admin": AdminRestResource(self),
|
2017-11-02 13:27:21 +00:00
|
|
|
})
|
|
|
|
|
2018-12-07 12:11:11 +00:00
|
|
|
if self.get_config().saml2_enabled:
|
|
|
|
from synapse.rest.saml2 import SAML2Resource
|
|
|
|
resources["/_matrix/saml2"] = SAML2Resource(self)
|
|
|
|
|
2018-05-10 23:17:11 +00:00
|
|
|
if name == "consent":
|
2018-05-22 13:00:23 +00:00
|
|
|
from synapse.rest.consent.consent_resource import ConsentResource
|
2018-05-10 23:17:11 +00:00
|
|
|
consent_resource = ConsentResource(self)
|
|
|
|
if compress:
|
|
|
|
consent_resource = gz_wrap(consent_resource)
|
|
|
|
resources.update({
|
|
|
|
"/_matrix/consent": consent_resource,
|
|
|
|
})
|
|
|
|
|
2017-11-02 13:27:21 +00:00
|
|
|
if name == "federation":
|
|
|
|
resources.update({
|
|
|
|
FEDERATION_PREFIX: TransportLayerServer(self),
|
|
|
|
})
|
|
|
|
|
2019-01-20 23:54:43 +00:00
|
|
|
if name == "openid":
|
|
|
|
resources.update({
|
|
|
|
FEDERATION_PREFIX: TransportLayerServer(self, servlet_groups=["openid"]),
|
|
|
|
})
|
|
|
|
|
2017-11-02 13:27:21 +00:00
|
|
|
if name in ["static", "client"]:
|
|
|
|
resources.update({
|
|
|
|
STATIC_PREFIX: File(
|
|
|
|
os.path.join(os.path.dirname(synapse.__file__), "static")
|
|
|
|
),
|
|
|
|
})
|
|
|
|
|
|
|
|
if name in ["media", "federation", "client"]:
|
2017-11-21 13:29:39 +00:00
|
|
|
if self.get_config().enable_media_repo:
|
|
|
|
media_repo = self.get_media_repository_resource()
|
|
|
|
resources.update({
|
|
|
|
MEDIA_PREFIX: media_repo,
|
|
|
|
LEGACY_MEDIA_PREFIX: media_repo,
|
|
|
|
CONTENT_REPO_PREFIX: ContentRepoResource(
|
|
|
|
self, self.config.uploads_path
|
|
|
|
),
|
|
|
|
})
|
|
|
|
elif name == "media":
|
|
|
|
raise ConfigError(
|
|
|
|
"'media' resource conflicts with enable_media_repo=False",
|
|
|
|
)
|
2017-11-02 13:27:21 +00:00
|
|
|
|
|
|
|
if name in ["keys", "federation"]:
|
2018-10-31 11:29:02 +00:00
|
|
|
resources[SERVER_KEY_V2_PREFIX] = KeyApiV2Resource(self)
|
2017-11-02 13:27:21 +00:00
|
|
|
|
|
|
|
if name == "webclient":
|
2018-12-11 13:18:48 +00:00
|
|
|
webclient_path = self.get_config().web_client_location
|
|
|
|
|
|
|
|
if webclient_path is None:
|
|
|
|
logger.warning(
|
|
|
|
"Not enabling webclient resource, as web_client_location is unset."
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
# GZip is disabled here due to
|
|
|
|
# https://twistedmatrix.com/trac/ticket/7678
|
|
|
|
resources[WEB_CLIENT_PREFIX] = File(webclient_path)
|
2017-11-02 13:27:21 +00:00
|
|
|
|
|
|
|
if name == "metrics" and self.get_config().enable_metrics:
|
2018-05-31 09:04:50 +00:00
|
|
|
resources[METRICS_PREFIX] = MetricsResource(RegistryProxy)
|
2017-11-02 13:27:21 +00:00
|
|
|
|
2018-02-05 17:22:16 +00:00
|
|
|
if name == "replication":
|
|
|
|
resources[REPLICATION_PREFIX] = ReplicationRestResource(self)
|
|
|
|
|
2017-11-02 13:27:21 +00:00
|
|
|
return resources
|
|
|
|
|
2019-02-08 17:25:57 +00:00
|
|
|
def start_listening(self, listeners):
|
2015-06-12 14:33:07 +00:00
|
|
|
config = self.get_config()
|
|
|
|
|
2019-02-08 17:25:57 +00:00
|
|
|
for listener in listeners:
|
2015-06-12 14:33:07 +00:00
|
|
|
if listener["type"] == "http":
|
2019-01-30 11:00:02 +00:00
|
|
|
self._listening_services.extend(
|
|
|
|
self._listener_http(config, listener)
|
|
|
|
)
|
2015-06-12 14:33:07 +00:00
|
|
|
elif listener["type"] == "manhole":
|
2017-12-17 12:04:05 +00:00
|
|
|
listen_tcp(
|
2017-12-17 13:15:30 +00:00
|
|
|
listener["bind_addresses"],
|
2017-09-06 15:48:49 +00:00
|
|
|
listener["port"],
|
|
|
|
manhole(
|
|
|
|
username="matrix",
|
|
|
|
password="rabbithole",
|
|
|
|
globals={"hs": self},
|
|
|
|
)
|
|
|
|
)
|
2017-03-30 12:31:10 +00:00
|
|
|
elif listener["type"] == "replication":
|
2019-02-13 11:59:04 +00:00
|
|
|
services = listen_tcp(
|
|
|
|
listener["bind_addresses"],
|
|
|
|
listener["port"],
|
|
|
|
ReplicationStreamProtocolFactory(self),
|
|
|
|
)
|
|
|
|
for s in services:
|
2017-12-17 12:04:05 +00:00
|
|
|
reactor.addSystemEventTrigger(
|
2019-02-13 11:59:04 +00:00
|
|
|
"before", "shutdown", s.stopListening,
|
2017-12-17 12:04:05 +00:00
|
|
|
)
|
2018-05-31 09:04:50 +00:00
|
|
|
elif listener["type"] == "metrics":
|
|
|
|
if not self.get_config().enable_metrics:
|
|
|
|
logger.warn(("Metrics listener configured, but "
|
2018-06-12 18:51:31 +00:00
|
|
|
"enable_metrics is not True!"))
|
2018-05-31 09:04:50 +00:00
|
|
|
else:
|
|
|
|
_base.listen_metrics(listener["bind_addresses"],
|
|
|
|
listener["port"])
|
2015-06-12 14:33:07 +00:00
|
|
|
else:
|
|
|
|
logger.warn("Unrecognized listener type: %s", listener["type"])
|
2015-03-12 16:05:46 +00:00
|
|
|
|
2015-04-28 12:39:42 +00:00
|
|
|
def run_startup_checks(self, db_conn, database_engine):
|
2015-04-27 10:46:00 +00:00
|
|
|
all_users_native = are_all_users_on_domain(
|
2015-04-28 12:39:42 +00:00
|
|
|
db_conn.cursor(), database_engine, self.hostname
|
2015-04-24 17:11:21 +00:00
|
|
|
)
|
|
|
|
if not all_users_native:
|
2015-04-29 11:12:18 +00:00
|
|
|
quit_with_error(
|
2015-04-24 17:11:21 +00:00
|
|
|
"Found users in database not native to %s!\n"
|
2015-04-29 11:12:18 +00:00
|
|
|
"You cannot changed a synapse server_name after it's been configured"
|
|
|
|
% (self.hostname,)
|
2015-04-24 17:11:21 +00:00
|
|
|
)
|
|
|
|
|
2015-04-29 10:42:28 +00:00
|
|
|
try:
|
|
|
|
database_engine.check_database(db_conn.cursor())
|
|
|
|
except IncorrectDatabaseSetup as e:
|
2018-09-27 11:38:50 +00:00
|
|
|
quit_with_error(str(e))
|
2015-04-29 11:12:18 +00:00
|
|
|
|
|
|
|
|
2018-07-30 21:07:07 +00:00
|
|
|
# Gauges to expose monthly active user control metrics
|
2018-08-14 15:26:55 +00:00
|
|
|
current_mau_gauge = Gauge("synapse_admin_mau:current", "Current MAU")
|
|
|
|
max_mau_gauge = Gauge("synapse_admin_mau:max", "MAU Limit")
|
2018-09-12 15:22:15 +00:00
|
|
|
registered_reserved_users_mau_gauge = Gauge(
|
|
|
|
"synapse_admin_mau:registered_reserved_users",
|
|
|
|
"Registered users with reserved threepids"
|
|
|
|
)
|
2018-07-31 12:16:20 +00:00
|
|
|
|
2018-08-14 15:36:14 +00:00
|
|
|
|
2015-03-10 09:58:33 +00:00
|
|
|
def setup(config_options):
|
2015-03-10 09:39:42 +00:00
|
|
|
"""
|
|
|
|
Args:
|
|
|
|
config_options_options: The options passed to Synapse. Usually
|
|
|
|
`sys.argv[1:]`.
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
HomeServer
|
|
|
|
"""
|
Error if macaroon key is missing from config
Currently we store all access tokens in the DB, and fall back to that
check if we can't validate the macaroon, so our fallback works here, but
for guests, their macaroons don't get persisted, so we don't get to
find them in the database. Each restart, we generate a new ephemeral
key, so guests lose access after each server restart.
I tried to fix up the config stuff to be less insane, but gave up, so
instead I bolt on yet another piece of custom one-off insanity.
Also, add some basic tests for config generation and loading.
2016-02-05 01:58:23 +00:00
|
|
|
try:
|
2016-06-09 17:50:38 +00:00
|
|
|
config = HomeServerConfig.load_or_generate_config(
|
Error if macaroon key is missing from config
Currently we store all access tokens in the DB, and fall back to that
check if we can't validate the macaroon, so our fallback works here, but
for guests, their macaroons don't get persisted, so we don't get to
find them in the database. Each restart, we generate a new ephemeral
key, so guests lose access after each server restart.
I tried to fix up the config stuff to be less insane, but gave up, so
instead I bolt on yet another piece of custom one-off insanity.
Also, add some basic tests for config generation and loading.
2016-02-05 01:58:23 +00:00
|
|
|
"Synapse Homeserver",
|
|
|
|
config_options,
|
|
|
|
)
|
|
|
|
except ConfigError as e:
|
2018-09-27 11:38:50 +00:00
|
|
|
sys.stderr.write("\n" + str(e) + "\n")
|
Error if macaroon key is missing from config
Currently we store all access tokens in the DB, and fall back to that
check if we can't validate the macaroon, so our fallback works here, but
for guests, their macaroons don't get persisted, so we don't get to
find them in the database. Each restart, we generate a new ephemeral
key, so guests lose access after each server restart.
I tried to fix up the config stuff to be less insane, but gave up, so
instead I bolt on yet another piece of custom one-off insanity.
Also, add some basic tests for config generation and loading.
2016-02-05 01:58:23 +00:00
|
|
|
sys.exit(1)
|
|
|
|
|
|
|
|
if not config:
|
|
|
|
# If a config isn't returned, and an exception isn't raised, we're just
|
|
|
|
# generating config files and shouldn't try to continue.
|
|
|
|
sys.exit(0)
|
2014-11-18 15:57:00 +00:00
|
|
|
|
2019-01-30 11:00:02 +00:00
|
|
|
synapse.config.logger.setup_logging(
|
|
|
|
config,
|
2019-02-08 17:25:57 +00:00
|
|
|
use_worker_options=False
|
2019-01-30 11:00:02 +00:00
|
|
|
)
|
|
|
|
|
2015-05-29 11:17:33 +00:00
|
|
|
events.USE_FROZEN_DICTS = config.use_frozen_dicts
|
|
|
|
|
2016-04-06 13:08:18 +00:00
|
|
|
database_engine = create_engine(config.database_config)
|
2015-04-27 14:57:43 +00:00
|
|
|
config.database_config["args"]["cp_openfun"] = database_engine.on_new_connection
|
2015-04-01 13:12:33 +00:00
|
|
|
|
2014-08-12 14:10:52 +00:00
|
|
|
hs = SynapseHomeServer(
|
2014-08-31 15:06:39 +00:00
|
|
|
config.server_name,
|
2015-04-27 14:57:43 +00:00
|
|
|
db_config=config.database_config,
|
2014-09-02 16:57:04 +00:00
|
|
|
config=config,
|
2018-06-20 14:33:14 +00:00
|
|
|
version_string="Synapse/" + get_version_string(synapse),
|
2015-04-01 13:12:33 +00:00
|
|
|
database_engine=database_engine,
|
2014-08-12 14:10:52 +00:00
|
|
|
)
|
|
|
|
|
2015-08-29 21:23:21 +00:00
|
|
|
logger.info("Preparing database: %s...", config.database_config['name'])
|
2014-09-10 15:23:58 +00:00
|
|
|
|
2014-12-16 14:20:32 +00:00
|
|
|
try:
|
2018-08-28 12:39:49 +00:00
|
|
|
with hs.get_db_conn(run_new_connection=False) as db_conn:
|
|
|
|
prepare_database(db_conn, database_engine, config=config)
|
|
|
|
database_engine.on_new_connection(db_conn)
|
2016-04-06 13:08:18 +00:00
|
|
|
|
2018-08-28 12:39:49 +00:00
|
|
|
hs.run_startup_checks(db_conn, database_engine)
|
2015-04-01 13:12:33 +00:00
|
|
|
|
2018-08-28 12:39:49 +00:00
|
|
|
db_conn.commit()
|
2014-12-16 14:20:32 +00:00
|
|
|
except UpgradeDatabaseException:
|
|
|
|
sys.stderr.write(
|
|
|
|
"\nFailed to upgrade database.\n"
|
2015-01-19 15:30:48 +00:00
|
|
|
"Have you checked for version specific instructions in"
|
|
|
|
" UPGRADES.rst?\n"
|
2014-12-16 14:20:32 +00:00
|
|
|
)
|
|
|
|
sys.exit(1)
|
2014-09-10 15:23:58 +00:00
|
|
|
|
2015-08-29 21:23:21 +00:00
|
|
|
logger.info("Database prepared in %s.", config.database_config['name'])
|
2014-09-10 14:42:15 +00:00
|
|
|
|
2016-01-26 15:51:06 +00:00
|
|
|
hs.setup()
|
2019-03-11 10:13:35 +00:00
|
|
|
hs.setup_master()
|
2014-09-10 15:16:24 +00:00
|
|
|
|
2019-02-11 10:36:26 +00:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def do_acme():
|
|
|
|
"""
|
|
|
|
Reprovision an ACME certificate, if it's required.
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
Deferred[bool]: Whether the cert has been updated.
|
|
|
|
"""
|
|
|
|
acme = hs.get_acme_handler()
|
|
|
|
|
|
|
|
# Check how long the certificate is active for.
|
|
|
|
cert_days_remaining = hs.config.is_disk_cert_valid(
|
|
|
|
allow_self_signed=False
|
|
|
|
)
|
|
|
|
|
|
|
|
# We want to reprovision if cert_days_remaining is None (meaning no
|
|
|
|
# certificate exists), or the days remaining number it returns
|
|
|
|
# is less than our re-registration threshold.
|
|
|
|
provision = False
|
|
|
|
|
2019-02-14 17:10:36 +00:00
|
|
|
if (
|
|
|
|
cert_days_remaining is None or
|
|
|
|
cert_days_remaining < hs.config.acme_reprovision_threshold
|
|
|
|
):
|
2019-02-11 10:36:26 +00:00
|
|
|
provision = True
|
|
|
|
|
|
|
|
if provision:
|
|
|
|
yield acme.provision_certificate()
|
|
|
|
|
|
|
|
defer.returnValue(provision)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def reprovision_acme():
|
|
|
|
"""
|
|
|
|
Provision a certificate from ACME, if required, and reload the TLS
|
|
|
|
certificate if it's renewed.
|
|
|
|
"""
|
|
|
|
reprovisioned = yield do_acme()
|
|
|
|
if reprovisioned:
|
|
|
|
_base.refresh_certificate(hs)
|
|
|
|
|
2019-01-23 08:39:06 +00:00
|
|
|
@defer.inlineCallbacks
|
2016-01-26 15:51:06 +00:00
|
|
|
def start():
|
2019-01-23 08:39:06 +00:00
|
|
|
try:
|
2019-02-11 10:36:26 +00:00
|
|
|
# Run the ACME provisioning code, if it's enabled.
|
2019-01-23 08:39:06 +00:00
|
|
|
if hs.config.acme_enabled:
|
|
|
|
acme = hs.get_acme_handler()
|
|
|
|
# Start up the webservices which we will respond to ACME
|
2019-02-11 10:36:26 +00:00
|
|
|
# challenges with, and then provision.
|
2019-01-23 08:39:06 +00:00
|
|
|
yield acme.start_listening()
|
2019-02-11 10:36:26 +00:00
|
|
|
yield do_acme()
|
2019-01-23 08:39:06 +00:00
|
|
|
|
2019-02-11 10:36:26 +00:00
|
|
|
# Check if it needs to be reprovisioned every day.
|
|
|
|
hs.get_clock().looping_call(
|
|
|
|
reprovision_acme,
|
|
|
|
24 * 60 * 60 * 1000
|
|
|
|
)
|
2019-01-23 08:39:06 +00:00
|
|
|
|
2019-02-08 17:25:57 +00:00
|
|
|
_base.start(hs, config.listeners)
|
2019-01-23 08:39:06 +00:00
|
|
|
|
|
|
|
hs.get_pusherpool().start()
|
|
|
|
hs.get_datastore().start_doing_background_updates()
|
2019-02-11 10:36:26 +00:00
|
|
|
except Exception:
|
|
|
|
# Print the exception and bail out.
|
2019-02-14 17:10:36 +00:00
|
|
|
print("Error during startup:", file=sys.stderr)
|
|
|
|
|
|
|
|
# this gives better tracebacks than traceback.print_exc()
|
|
|
|
Failure().printTraceback(file=sys.stderr)
|
|
|
|
|
2019-02-11 10:36:26 +00:00
|
|
|
if reactor.running:
|
|
|
|
reactor.stop()
|
2019-01-23 08:39:06 +00:00
|
|
|
sys.exit(1)
|
2016-01-26 15:51:06 +00:00
|
|
|
|
|
|
|
reactor.callWhenRunning(start)
|
2015-02-06 16:52:22 +00:00
|
|
|
|
2015-03-10 09:39:42 +00:00
|
|
|
return hs
|
|
|
|
|
2014-11-20 17:26:36 +00:00
|
|
|
|
2015-01-07 13:46:37 +00:00
|
|
|
class SynapseService(service.Service):
|
2019-02-11 10:36:26 +00:00
|
|
|
"""
|
|
|
|
A twisted Service class that will start synapse. Used to run synapse
|
2015-03-10 09:39:42 +00:00
|
|
|
via twistd and a .tac.
|
|
|
|
"""
|
2015-01-07 13:46:37 +00:00
|
|
|
def __init__(self, config):
|
|
|
|
self.config = config
|
|
|
|
|
|
|
|
def startService(self):
|
2015-03-10 09:58:33 +00:00
|
|
|
hs = setup(self.config)
|
2015-03-10 09:39:42 +00:00
|
|
|
change_resource_limit(hs.config.soft_file_limit)
|
2016-06-07 14:45:56 +00:00
|
|
|
if hs.config.gc_thresholds:
|
|
|
|
gc.set_threshold(*hs.config.gc_thresholds)
|
2015-01-07 13:46:37 +00:00
|
|
|
|
|
|
|
def stopService(self):
|
|
|
|
return self._port.stopListening()
|
|
|
|
|
|
|
|
|
2015-03-10 09:58:33 +00:00
|
|
|
def run(hs):
|
2016-01-26 18:27:23 +00:00
|
|
|
PROFILE_SYNAPSE = False
|
2015-05-06 16:08:00 +00:00
|
|
|
if PROFILE_SYNAPSE:
|
|
|
|
def profile(func):
|
|
|
|
from cProfile import Profile
|
|
|
|
from threading import current_thread
|
|
|
|
|
|
|
|
def profiled(*args, **kargs):
|
|
|
|
profile = Profile()
|
|
|
|
profile.enable()
|
|
|
|
func(*args, **kargs)
|
|
|
|
profile.disable()
|
|
|
|
ident = current_thread().ident
|
|
|
|
profile.dump_stats("/tmp/%s.%s.%i.pstat" % (
|
|
|
|
hs.hostname, func.__name__, ident
|
|
|
|
))
|
|
|
|
|
|
|
|
return profiled
|
|
|
|
|
|
|
|
from twisted.python.threadpool import ThreadPool
|
|
|
|
ThreadPool._worker = profile(ThreadPool._worker)
|
|
|
|
reactor.run = profile(reactor.run)
|
2015-03-10 09:58:33 +00:00
|
|
|
|
2017-06-14 18:37:17 +00:00
|
|
|
clock = hs.get_clock()
|
|
|
|
start_time = clock.time()
|
2015-09-22 11:57:40 +00:00
|
|
|
|
2016-08-22 14:31:12 +00:00
|
|
|
stats = {}
|
2018-03-28 13:25:25 +00:00
|
|
|
|
|
|
|
# Contains the list of processes we will be monitoring
|
|
|
|
# currently either 0 or 1
|
2018-03-28 11:08:09 +00:00
|
|
|
stats_process = []
|
2016-08-22 14:31:12 +00:00
|
|
|
|
2018-07-25 08:41:12 +00:00
|
|
|
def start_phone_stats_home():
|
2018-07-26 10:44:26 +00:00
|
|
|
return run_as_background_process("phone_stats_home", phone_stats_home)
|
2018-07-25 08:41:12 +00:00
|
|
|
|
2015-09-22 11:57:40 +00:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def phone_stats_home():
|
2016-01-06 14:13:34 +00:00
|
|
|
logger.info("Gathering stats for reporting")
|
2015-09-22 11:57:40 +00:00
|
|
|
now = int(hs.get_clock().time())
|
|
|
|
uptime = int(now - start_time)
|
|
|
|
if uptime < 0:
|
|
|
|
uptime = 0
|
|
|
|
|
|
|
|
stats["homeserver"] = hs.config.server_name
|
2019-04-08 14:47:39 +00:00
|
|
|
stats["server_context"] = hs.config.server_context
|
2015-09-22 11:57:40 +00:00
|
|
|
stats["timestamp"] = now
|
|
|
|
stats["uptime_seconds"] = uptime
|
2018-09-17 15:35:18 +00:00
|
|
|
version = sys.version_info
|
2018-09-17 16:35:54 +00:00
|
|
|
stats["python_version"] = "{}.{}.{}".format(
|
|
|
|
version.major, version.minor, version.micro
|
|
|
|
)
|
2015-09-22 11:57:40 +00:00
|
|
|
stats["total_users"] = yield hs.get_datastore().count_all_users()
|
2017-06-15 09:49:10 +00:00
|
|
|
|
|
|
|
total_nonbridged_users = yield hs.get_datastore().count_nonbridged_users()
|
|
|
|
stats["total_nonbridged_users"] = total_nonbridged_users
|
2017-06-15 08:39:39 +00:00
|
|
|
|
2018-05-22 17:09:09 +00:00
|
|
|
daily_user_type_results = yield hs.get_datastore().count_daily_user_type()
|
2018-07-21 05:47:18 +00:00
|
|
|
for name, count in iteritems(daily_user_type_results):
|
2018-05-22 17:09:09 +00:00
|
|
|
stats["daily_user_type_" + name] = count
|
|
|
|
|
2017-06-15 08:39:39 +00:00
|
|
|
room_count = yield hs.get_datastore().get_room_count()
|
|
|
|
stats["total_room_count"] = room_count
|
|
|
|
|
2015-09-22 11:57:40 +00:00
|
|
|
stats["daily_active_users"] = yield hs.get_datastore().count_daily_users()
|
2019-06-10 22:33:59 +00:00
|
|
|
stats["monthly_active_users"] = yield hs.get_datastore().count_monthly_users()
|
2017-06-15 08:39:39 +00:00
|
|
|
stats["daily_active_rooms"] = yield hs.get_datastore().count_daily_active_rooms()
|
2017-06-14 18:37:17 +00:00
|
|
|
stats["daily_messages"] = yield hs.get_datastore().count_daily_messages()
|
2017-06-15 08:39:39 +00:00
|
|
|
|
2018-03-28 13:36:53 +00:00
|
|
|
r30_results = yield hs.get_datastore().count_r30_users()
|
2018-07-21 05:47:18 +00:00
|
|
|
for name, count in iteritems(r30_results):
|
2018-03-28 13:36:53 +00:00
|
|
|
stats["r30_users_" + name] = count
|
2018-03-28 09:39:13 +00:00
|
|
|
|
2017-06-14 18:37:17 +00:00
|
|
|
daily_sent_messages = yield hs.get_datastore().count_daily_sent_messages()
|
|
|
|
stats["daily_sent_messages"] = daily_sent_messages
|
2018-04-04 15:46:58 +00:00
|
|
|
stats["cache_factor"] = CACHE_SIZE_FACTOR
|
|
|
|
stats["event_cache_size"] = hs.config.event_cache_size
|
2018-03-28 13:25:25 +00:00
|
|
|
|
2018-03-28 11:08:09 +00:00
|
|
|
if len(stats_process) > 0:
|
|
|
|
stats["memory_rss"] = 0
|
|
|
|
stats["cpu_average"] = 0
|
|
|
|
for process in stats_process:
|
2018-03-28 13:25:25 +00:00
|
|
|
stats["memory_rss"] += process.memory_info().rss
|
|
|
|
stats["cpu_average"] += int(process.cpu_percent(interval=None))
|
2015-09-22 11:57:40 +00:00
|
|
|
|
2019-02-27 10:21:49 +00:00
|
|
|
stats["database_engine"] = hs.get_datastore().database_engine_name
|
|
|
|
stats["database_server_version"] = hs.get_datastore().get_server_version()
|
2015-09-22 11:57:40 +00:00
|
|
|
logger.info("Reporting stats to matrix.org: %s" % (stats,))
|
2015-09-22 12:34:29 +00:00
|
|
|
try:
|
|
|
|
yield hs.get_simple_http_client().put_json(
|
|
|
|
"https://matrix.org/report-usage-stats/push",
|
|
|
|
stats
|
|
|
|
)
|
|
|
|
except Exception as e:
|
|
|
|
logger.warn("Error reporting stats: %s", e)
|
2015-09-22 11:57:40 +00:00
|
|
|
|
2018-03-28 11:08:09 +00:00
|
|
|
def performance_stats_init():
|
2018-03-27 13:12:22 +00:00
|
|
|
try:
|
2018-03-28 11:08:09 +00:00
|
|
|
process = psutil.Process()
|
2018-03-27 13:12:22 +00:00
|
|
|
# Ensure we can fetch both, and make the initial request for cpu_percent
|
|
|
|
# so the next request will use this as the initial point.
|
2018-03-28 11:08:09 +00:00
|
|
|
process.memory_info().rss
|
|
|
|
process.cpu_percent(interval=None)
|
|
|
|
logger.info("report_stats can use psutil")
|
|
|
|
stats_process.append(process)
|
2018-10-19 20:49:26 +00:00
|
|
|
except (AttributeError):
|
|
|
|
logger.warning(
|
|
|
|
"Unable to read memory/cpu stats. Disabling reporting."
|
2018-03-27 13:12:22 +00:00
|
|
|
)
|
|
|
|
|
2018-04-25 16:37:29 +00:00
|
|
|
def generate_user_daily_visit_stats():
|
2018-07-26 10:44:26 +00:00
|
|
|
return run_as_background_process(
|
2018-07-25 08:41:12 +00:00
|
|
|
"generate_user_daily_visits",
|
|
|
|
hs.get_datastore().generate_user_daily_visits,
|
|
|
|
)
|
2018-04-25 16:37:29 +00:00
|
|
|
|
2018-05-15 16:01:33 +00:00
|
|
|
# Rather than update on per session basis, batch up the requests.
|
|
|
|
# If you increase the loop period, the accuracy of user_daily_visits
|
|
|
|
# table will decrease
|
|
|
|
clock.looping_call(generate_user_daily_visit_stats, 5 * 60 * 1000)
|
2018-08-07 16:49:43 +00:00
|
|
|
|
|
|
|
# monthly active user limiting functionality
|
2018-10-20 01:13:01 +00:00
|
|
|
def reap_monthly_active_users():
|
|
|
|
return run_as_background_process(
|
|
|
|
"reap_monthly_active_users",
|
|
|
|
hs.get_datastore().reap_monthly_active_users,
|
|
|
|
)
|
|
|
|
clock.looping_call(reap_monthly_active_users, 1000 * 60 * 60)
|
|
|
|
reap_monthly_active_users()
|
2018-05-14 12:50:58 +00:00
|
|
|
|
2018-08-01 15:17:42 +00:00
|
|
|
@defer.inlineCallbacks
|
2018-07-30 21:07:07 +00:00
|
|
|
def generate_monthly_active_users():
|
2018-09-12 10:58:52 +00:00
|
|
|
current_mau_count = 0
|
2018-09-12 15:22:15 +00:00
|
|
|
reserved_count = 0
|
|
|
|
store = hs.get_datastore()
|
2018-11-15 18:08:27 +00:00
|
|
|
if hs.config.limit_usage_by_mau or hs.config.mau_stats_only:
|
2018-09-12 15:22:15 +00:00
|
|
|
current_mau_count = yield store.get_monthly_active_count()
|
|
|
|
reserved_count = yield store.get_registered_reserved_users_count()
|
2018-09-12 10:58:52 +00:00
|
|
|
current_mau_gauge.set(float(current_mau_count))
|
2018-09-12 15:22:15 +00:00
|
|
|
registered_reserved_users_mau_gauge.set(float(reserved_count))
|
2018-08-14 15:26:55 +00:00
|
|
|
max_mau_gauge.set(float(hs.config.max_mau_value))
|
2018-07-30 21:07:07 +00:00
|
|
|
|
2018-10-20 01:13:01 +00:00
|
|
|
def start_generate_monthly_active_users():
|
|
|
|
return run_as_background_process(
|
|
|
|
"generate_monthly_active_users",
|
|
|
|
generate_monthly_active_users,
|
|
|
|
)
|
|
|
|
|
|
|
|
start_generate_monthly_active_users()
|
2018-12-18 14:36:11 +00:00
|
|
|
if hs.config.limit_usage_by_mau or hs.config.mau_stats_only:
|
2018-10-20 01:13:01 +00:00
|
|
|
clock.looping_call(start_generate_monthly_active_users, 5 * 60 * 1000)
|
2018-08-07 16:49:43 +00:00
|
|
|
# End of monthly active user settings
|
2018-07-30 21:07:07 +00:00
|
|
|
|
2018-03-28 11:08:09 +00:00
|
|
|
if hs.config.report_stats:
|
2017-06-14 18:37:17 +00:00
|
|
|
logger.info("Scheduling stats reporting for 3 hour intervals")
|
2018-07-25 08:41:12 +00:00
|
|
|
clock.looping_call(start_phone_stats_home, 3 * 60 * 60 * 1000)
|
2017-06-14 18:37:17 +00:00
|
|
|
|
2018-03-28 11:08:09 +00:00
|
|
|
# We need to defer this init for the cases that we daemonize
|
|
|
|
# otherwise the process ID we get is that of the non-daemon process
|
2018-03-28 13:25:25 +00:00
|
|
|
clock.call_later(0, performance_stats_init)
|
2018-03-28 11:08:09 +00:00
|
|
|
|
2017-06-14 18:37:17 +00:00
|
|
|
# We wait 5 minutes to send the first set of stats as the server can
|
|
|
|
# be quite busy the first few minutes
|
2018-07-25 08:41:12 +00:00
|
|
|
clock.call_later(5 * 60, start_phone_stats_home)
|
2015-09-22 11:57:40 +00:00
|
|
|
|
2017-08-15 14:57:46 +00:00
|
|
|
_base.start_reactor(
|
|
|
|
"synapse-homeserver",
|
2019-03-14 13:32:14 +00:00
|
|
|
soft_file_limit=hs.config.soft_file_limit,
|
|
|
|
gc_thresholds=hs.config.gc_thresholds,
|
|
|
|
pid_file=hs.config.pid_file,
|
|
|
|
daemonize=hs.config.daemonize,
|
|
|
|
cpu_affinity=hs.config.cpu_affinity,
|
|
|
|
print_pidfile=hs.config.print_pidfile,
|
|
|
|
logger=logger,
|
2017-08-15 14:57:46 +00:00
|
|
|
)
|
2014-10-30 01:21:33 +00:00
|
|
|
|
2014-11-20 17:26:36 +00:00
|
|
|
|
2014-11-18 15:57:00 +00:00
|
|
|
def main():
|
2014-10-30 11:15:39 +00:00
|
|
|
with LoggingContext("main"):
|
2015-03-17 11:45:37 +00:00
|
|
|
# check base requirements
|
2015-01-08 17:07:28 +00:00
|
|
|
check_requirements()
|
2015-03-10 09:58:33 +00:00
|
|
|
hs = setup(sys.argv[1:])
|
|
|
|
run(hs)
|
2014-08-12 14:10:52 +00:00
|
|
|
|
2014-11-20 17:26:36 +00:00
|
|
|
|
2014-08-12 14:10:52 +00:00
|
|
|
if __name__ == '__main__':
|
2014-11-18 15:57:00 +00:00
|
|
|
main()
|