123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145 |
- # -*- coding: utf-8 -*-
- # Copyright 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.
- import logging
- from twisted.internet import defer
- from ._base import Cache
- from . import background_updates
- logger = logging.getLogger(__name__)
- # Number of msec of granularity to store the user IP 'last seen' time. Smaller
- # times give more inserts into the database even for readonly API hits
- # 120 seconds == 2 minutes
- LAST_SEEN_GRANULARITY = 120 * 1000
- class ClientIpStore(background_updates.BackgroundUpdateStore):
- def __init__(self, hs):
- self.client_ip_last_seen = Cache(
- name="client_ip_last_seen",
- keylen=4,
- )
- super(ClientIpStore, self).__init__(hs)
- self.register_background_index_update(
- "user_ips_device_index",
- index_name="user_ips_device_id",
- table="user_ips",
- columns=["user_id", "device_id", "last_seen"],
- )
- @defer.inlineCallbacks
- def insert_client_ip(self, user, access_token, ip, user_agent, device_id):
- now = int(self._clock.time_msec())
- key = (user.to_string(), access_token, ip)
- try:
- last_seen = self.client_ip_last_seen.get(key)
- except KeyError:
- last_seen = None
- # Rate-limited inserts
- if last_seen is not None and (now - last_seen) < LAST_SEEN_GRANULARITY:
- defer.returnValue(None)
- self.client_ip_last_seen.prefill(key, now)
- # It's safe not to lock here: a) no unique constraint,
- # b) LAST_SEEN_GRANULARITY makes concurrent updates incredibly unlikely
- yield self._simple_upsert(
- "user_ips",
- keyvalues={
- "user_id": user.to_string(),
- "access_token": access_token,
- "ip": ip,
- "user_agent": user_agent,
- "device_id": device_id,
- },
- values={
- "last_seen": now,
- },
- desc="insert_client_ip",
- lock=False,
- )
- @defer.inlineCallbacks
- def get_last_client_ip_by_device(self, devices):
- """For each device_id listed, give the user_ip it was last seen on
- Args:
- devices (iterable[(str, str)]): list of (user_id, device_id) pairs
- Returns:
- defer.Deferred: resolves to a dict, where the keys
- are (user_id, device_id) tuples. The values are also dicts, with
- keys giving the column names
- """
- res = yield self.runInteraction(
- "get_last_client_ip_by_device",
- self._get_last_client_ip_by_device_txn,
- retcols=(
- "user_id",
- "access_token",
- "ip",
- "user_agent",
- "device_id",
- "last_seen",
- ),
- devices=devices
- )
- ret = {(d["user_id"], d["device_id"]): d for d in res}
- defer.returnValue(ret)
- @classmethod
- def _get_last_client_ip_by_device_txn(cls, txn, devices, retcols):
- where_clauses = []
- bindings = []
- for (user_id, device_id) in devices:
- if device_id is None:
- where_clauses.append("(user_id = ? AND device_id IS NULL)")
- bindings.extend((user_id, ))
- else:
- where_clauses.append("(user_id = ? AND device_id = ?)")
- bindings.extend((user_id, device_id))
- inner_select = (
- "SELECT MAX(last_seen) mls, user_id, device_id FROM user_ips "
- "WHERE %(where)s "
- "GROUP BY user_id, device_id"
- ) % {
- "where": " OR ".join(where_clauses),
- }
- sql = (
- "SELECT %(retcols)s FROM user_ips "
- "JOIN (%(inner_select)s) ips ON"
- " user_ips.last_seen = ips.mls AND"
- " user_ips.user_id = ips.user_id AND"
- " (user_ips.device_id = ips.device_id OR"
- " (user_ips.device_id IS NULL AND ips.device_id IS NULL)"
- " )"
- ) % {
- "retcols": ",".join("user_ips." + c for c in retcols),
- "inner_select": inner_select,
- }
- txn.execute(sql, bindings)
- return cls.cursor_to_dict(txn)
|