123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312 |
- # -*- coding: utf-8 -*-
- # Copyright 2015, 2016 OpenMarket Ltd
- #
- # 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.
- from twisted.internet import defer
- from six import itervalues
- import synapse
- from synapse.api.constants import EventTypes
- from synapse.util.metrics import Measure
- from synapse.util.logcontext import (
- make_deferred_yieldable, run_in_background,
- )
- from prometheus_client import Counter
- import logging
- logger = logging.getLogger(__name__)
- events_processed_counter = Counter("synapse_handlers_appservice_events_processed", "")
- def log_failure(failure):
- logger.error(
- "Application Services Failure",
- exc_info=(
- failure.type,
- failure.value,
- failure.getTracebackObject()
- )
- )
- class ApplicationServicesHandler(object):
- def __init__(self, hs):
- self.store = hs.get_datastore()
- self.is_mine_id = hs.is_mine_id
- self.appservice_api = hs.get_application_service_api()
- self.scheduler = hs.get_application_service_scheduler()
- self.started_scheduler = False
- self.clock = hs.get_clock()
- self.notify_appservices = hs.config.notify_appservices
- self.current_max = 0
- self.is_processing = False
- @defer.inlineCallbacks
- def notify_interested_services(self, current_id):
- """Notifies (pushes) all application services interested in this event.
- Pushing is done asynchronously, so this method won't block for any
- prolonged length of time.
- Args:
- current_id(int): The current maximum ID.
- """
- services = self.store.get_app_services()
- if not services or not self.notify_appservices:
- return
- self.current_max = max(self.current_max, current_id)
- if self.is_processing:
- return
- with Measure(self.clock, "notify_interested_services"):
- self.is_processing = True
- try:
- limit = 100
- while True:
- upper_bound, events = yield self.store.get_new_events_for_appservice(
- self.current_max, limit
- )
- if not events:
- break
- events_by_room = {}
- for event in events:
- events_by_room.setdefault(event.room_id, []).append(event)
- @defer.inlineCallbacks
- def handle_event(event):
- # Gather interested services
- services = yield self._get_services_for_event(event)
- if len(services) == 0:
- return # no services need notifying
- # Do we know this user exists? If not, poke the user
- # query API for all services which match that user regex.
- # This needs to block as these user queries need to be
- # made BEFORE pushing the event.
- yield self._check_user_exists(event.sender)
- if event.type == EventTypes.Member:
- yield self._check_user_exists(event.state_key)
- if not self.started_scheduler:
- self.scheduler.start().addErrback(log_failure)
- self.started_scheduler = True
- # Fork off pushes to these services
- for service in services:
- self.scheduler.submit_event_for_as(service, event)
- @defer.inlineCallbacks
- def handle_room_events(events):
- for event in events:
- yield handle_event(event)
- yield make_deferred_yieldable(defer.gatherResults([
- run_in_background(handle_room_events, evs)
- for evs in itervalues(events_by_room)
- ], consumeErrors=True))
- yield self.store.set_appservice_last_pos(upper_bound)
- now = self.clock.time_msec()
- ts = yield self.store.get_received_ts(events[-1].event_id)
- synapse.metrics.event_processing_positions.labels(
- "appservice_sender").set(upper_bound)
- events_processed_counter.inc(len(events))
- synapse.metrics.event_processing_lag.labels(
- "appservice_sender").set(now - ts)
- synapse.metrics.event_processing_last_ts.labels(
- "appservice_sender").set(ts)
- finally:
- self.is_processing = False
- @defer.inlineCallbacks
- def query_user_exists(self, user_id):
- """Check if any application service knows this user_id exists.
- Args:
- user_id(str): The user to query if they exist on any AS.
- Returns:
- True if this user exists on at least one application service.
- """
- user_query_services = yield self._get_services_for_user(
- user_id=user_id
- )
- for user_service in user_query_services:
- is_known_user = yield self.appservice_api.query_user(
- user_service, user_id
- )
- if is_known_user:
- defer.returnValue(True)
- defer.returnValue(False)
- @defer.inlineCallbacks
- def query_room_alias_exists(self, room_alias):
- """Check if an application service knows this room alias exists.
- Args:
- room_alias(RoomAlias): The room alias to query.
- Returns:
- namedtuple: with keys "room_id" and "servers" or None if no
- association can be found.
- """
- room_alias_str = room_alias.to_string()
- services = self.store.get_app_services()
- alias_query_services = [
- s for s in services if (
- s.is_interested_in_alias(room_alias_str)
- )
- ]
- for alias_service in alias_query_services:
- is_known_alias = yield self.appservice_api.query_alias(
- alias_service, room_alias_str
- )
- if is_known_alias:
- # the alias exists now so don't query more ASes.
- result = yield self.store.get_association_from_room_alias(
- room_alias
- )
- defer.returnValue(result)
- @defer.inlineCallbacks
- def query_3pe(self, kind, protocol, fields):
- services = yield self._get_services_for_3pn(protocol)
- results = yield make_deferred_yieldable(defer.DeferredList([
- run_in_background(
- self.appservice_api.query_3pe,
- service, kind, protocol, fields,
- )
- for service in services
- ], consumeErrors=True))
- ret = []
- for (success, result) in results:
- if success:
- ret.extend(result)
- defer.returnValue(ret)
- @defer.inlineCallbacks
- def get_3pe_protocols(self, only_protocol=None):
- services = self.store.get_app_services()
- protocols = {}
- # Collect up all the individual protocol responses out of the ASes
- for s in services:
- for p in s.protocols:
- if only_protocol is not None and p != only_protocol:
- continue
- if p not in protocols:
- protocols[p] = []
- info = yield self.appservice_api.get_3pe_protocol(s, p)
- if info is not None:
- protocols[p].append(info)
- def _merge_instances(infos):
- if not infos:
- return {}
- # Merge the 'instances' lists of multiple results, but just take
- # the other fields from the first as they ought to be identical
- # copy the result so as not to corrupt the cached one
- combined = dict(infos[0])
- combined["instances"] = list(combined["instances"])
- for info in infos[1:]:
- combined["instances"].extend(info["instances"])
- return combined
- for p in protocols.keys():
- protocols[p] = _merge_instances(protocols[p])
- defer.returnValue(protocols)
- @defer.inlineCallbacks
- def _get_services_for_event(self, event):
- """Retrieve a list of application services interested in this event.
- Args:
- event(Event): The event to check. Can be None if alias_list is not.
- Returns:
- list<ApplicationService>: A list of services interested in this
- event based on the service regex.
- """
- services = self.store.get_app_services()
- # we can't use a list comprehension here. Since python 3, list
- # comprehensions use a generator internally. This means you can't yield
- # inside of a list comprehension anymore.
- interested_list = []
- for s in services:
- if (yield s.is_interested(event, self.store)):
- interested_list.append(s)
- defer.returnValue(interested_list)
- def _get_services_for_user(self, user_id):
- services = self.store.get_app_services()
- interested_list = [
- s for s in services if (
- s.is_interested_in_user(user_id)
- )
- ]
- return defer.succeed(interested_list)
- def _get_services_for_3pn(self, protocol):
- services = self.store.get_app_services()
- interested_list = [
- s for s in services if s.is_interested_in_protocol(protocol)
- ]
- return defer.succeed(interested_list)
- @defer.inlineCallbacks
- def _is_unknown_user(self, user_id):
- if not self.is_mine_id(user_id):
- # we don't know if they are unknown or not since it isn't one of our
- # users. We can't poke ASes.
- defer.returnValue(False)
- return
- user_info = yield self.store.get_user_by_id(user_id)
- if user_info:
- defer.returnValue(False)
- return
- # user not found; could be the AS though, so check.
- services = self.store.get_app_services()
- service_list = [s for s in services if s.sender == user_id]
- defer.returnValue(len(service_list) == 0)
- @defer.inlineCallbacks
- def _check_user_exists(self, user_id):
- unknown_user = yield self._is_unknown_user(user_id)
- if unknown_user:
- exists = yield self.query_user_exists(user_id)
- defer.returnValue(exists)
- defer.returnValue(True)
|