summary refs log tree commit diff
path: root/synapse/storage/pusher.py
blob: 113cdc8a8e83a2171b28257cbed9086d8dc72712 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# -*- coding: utf-8 -*-
# Copyright 2014 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 collections

from ._base import SQLBaseStore, Table
from twisted.internet import defer

from synapse.api.errors import StoreError

import logging

logger = logging.getLogger(__name__)


class PusherStore(SQLBaseStore):
    @defer.inlineCallbacks
    def get_pushers_by_app_id_and_pushkey(self, app_id_and_pushkey):
        sql = (
            "SELECT id, user_name, kind, instance_handle, app_id,"
            "app_display_name, device_display_name, pushkey, ts, data, "
            "last_token, last_success, failing_since "
            "FROM pushers "
            "WHERE app_id = ? AND pushkey = ?"
        )

        rows = yield self._execute(
            None, sql, app_id_and_pushkey[0], app_id_and_pushkey[1]
        )

        ret = [
            {
                "id": r[0],
                "user_name": r[1],
                "kind": r[2],
                "instance_handle": r[3],
                "app_id": r[4],
                "app_display_name": r[5],
                "device_display_name": r[6],
                "pushkey": r[7],
                "pushkey_ts": r[8],
                "data": r[9],
                "last_token": r[10],
                "last_success": r[11],
                "failing_since": r[12]
            }
            for r in rows
        ]

        defer.returnValue(ret[0])

    @defer.inlineCallbacks
    def get_all_pushers(self):
        sql = (
            "SELECT id, user_name, kind, instance_handle, app_id,"
            "app_display_name, device_display_name, pushkey, ts, data, "
            "last_token, last_success, failing_since "
            "FROM pushers"
        )

        rows = yield self._execute(None, sql)

        ret = [
            {
                "id": r[0],
                "user_name": r[1],
                "kind": r[2],
                "instance_handle": r[3],
                "app_id": r[4],
                "app_display_name": r[5],
                "device_display_name": r[6],
                "pushkey": r[7],
                "pushkey_ts": r[8],
                "data": r[9],
                "last_token": r[10],
                "last_success": r[11],
                "failing_since": r[12]
            }
            for r in rows
        ]

        defer.returnValue(ret)

    @defer.inlineCallbacks
    def add_pusher(self, user_name, instance_handle, kind, app_id,
                   app_display_name, device_display_name,
                   pushkey, pushkey_ts, lang, data):
        try:
            yield self._simple_upsert(
                PushersTable.table_name,
                dict(
                    app_id=app_id,
                    pushkey=pushkey,
                ),
                dict(
                    user_name=user_name,
                    kind=kind,
                    instance_handle=instance_handle,
                    app_display_name=app_display_name,
                    device_display_name=device_display_name,
                    ts=pushkey_ts,
                    lang=lang,
                    data=data
                ))
        except Exception as e:
            logger.error("create_pusher with failed: %s", e)
            raise StoreError(500, "Problem creating pusher.")

    @defer.inlineCallbacks
    def delete_pusher_by_app_id_pushkey(self, app_id, pushkey):
        yield self._simple_delete_one(
            PushersTable.table_name,
            dict(app_id=app_id, pushkey=pushkey)
        )

    @defer.inlineCallbacks
    def update_pusher_last_token(self, user_name, pushkey, last_token):
        yield self._simple_update_one(
            PushersTable.table_name,
            {'user_name': user_name, 'pushkey': pushkey},
            {'last_token': last_token}
        )

    @defer.inlineCallbacks
    def update_pusher_last_token_and_success(self, user_name, pushkey,
                                             last_token, last_success):
        yield self._simple_update_one(
            PushersTable.table_name,
            {'user_name': user_name, 'pushkey': pushkey},
            {'last_token': last_token, 'last_success': last_success}
        )

    @defer.inlineCallbacks
    def update_pusher_failing_since(self, user_name, pushkey, failing_since):
        yield self._simple_update_one(
            PushersTable.table_name,
            {'user_name': user_name, 'pushkey': pushkey},
            {'failing_since': failing_since}
        )


class PushersTable(Table):
    table_name = "pushers"

    fields = [
        "id",
        "user_name",
        "kind",
        "instance_handle",
        "app_id",
        "app_display_name",
        "device_display_name",
        "pushkey",
        "pushkey_ts",
        "data",
        "last_token",
        "last_success",
        "failing_since"
    ]

    EntryType = collections.namedtuple("PusherEntry", fields)