summaryrefslogtreecommitdiff
path: root/include/py/homekit/api/web_api_client.py
blob: 15c19158aaeec10b0bd4807bd02509ab9727448d (plain)
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
import requests
import json
import threading
import logging

from collections import namedtuple
from datetime import datetime
from enum import Enum, auto
from typing import Optional, Callable, Union, List, Tuple, Dict
from requests.auth import HTTPBasicAuth

from .config import WebApiConfig
from .errors import ApiResponseError
from .types import *
from ..config import config
from ..util import stringify
from ..media import RecordFile, MediaNodeClient

_logger = logging.getLogger(__name__)
_config = WebApiConfig()


RequestParams = namedtuple('RequestParams', 'params, files, method')


class HTTPMethod(Enum):
    GET = auto()
    POST = auto()


class WebApiClient:
    token: str
    timeout: Union[float, Tuple[float, float]]
    basic_auth: Optional[HTTPBasicAuth]
    do_async: bool
    async_error_handler: Optional[Callable]
    async_success_handler: Optional[Callable]

    def __init__(self, timeout: Union[float, Tuple[float, float]] = 5):
        self.token = config['token']
        self.timeout = timeout
        self.basic_auth = None
        self.do_async = False
        self.async_error_handler = None
        self.async_success_handler = None

        # if 'basic_auth' in config['api']:
        #     ba = config['api']['basic_auth']
        #     col = ba.index(':')
        #
        #     user = ba[:col]
        #     pw = ba[col+1:]
        #
        #     _logger.debug(f'enabling basic auth: {user}:{pw}')
        #     self.basic_auth = HTTPBasicAuth(user, pw)

    # api methods
    # -----------

    def log_bot_request(self,
                        bot: BotType,
                        user_id: int,
                        message: str):
        return self._post('log/bot_request/', {
            'bot': bot.value,
            'user_id': str(user_id),
            'message': message
        })

    def log_openwrt(self,
                    lines: List[Tuple[int, str]],
                    access_point: int):
        return self._post('log/openwrt/', {
            'logs': stringify(lines),
            'ap': access_point
        })

    def get_sensors_data(self,
                         sensor: TemperatureSensorLocation,
                         hours: int):
        data = self._get('sensors/data/', {
            'sensor': sensor.value,
            'hours': hours
        })
        return [(datetime.fromtimestamp(date), temp, hum) for date, temp, hum in data]

    def add_sound_sensor_hits(self,
                              hits: List[Tuple[str, int]]):
        return self._post('sound_sensors/hits/', {
            'hits': stringify(hits)
        })

    def get_sound_sensor_hits(self,
                              location: SoundSensorLocation,
                              after: datetime) -> List[dict]:
        return self._process_sound_sensor_hits_data(self._get('sound_sensors/hits/', {
            'after': int(after.timestamp()),
            'location': location.value
        }))

    def get_last_sound_sensor_hits(self, location: SoundSensorLocation, last: int):
        return self._process_sound_sensor_hits_data(self._get('sound_sensors/hits/', {
            'last': last,
            'location': location.value
        }))

    def recordings_list(self, extended=False, as_objects=False) -> Union[List[str], List[dict], List[RecordFile]]:
        files = self._get('recordings/list/', {'extended': int(extended)})['data']
        if as_objects:
            return MediaNodeClient.record_list_from_serialized(files)
        return files

    def inverter_get_consumed_energy(self, s_from: str, s_to: str):
        return self._get('inverter/consumed_energy/', {
            'from': s_from,
            'to': s_to
        })

    def inverter_get_grid_consumed_energy(self, s_from: str, s_to: str):
        return self._get('inverter/grid_consumed_energy/', {
            'from': s_from,
            'to': s_to
        })

    @staticmethod
    def _process_sound_sensor_hits_data(data: List[dict]) -> List[dict]:
        for item in data:
            item['time'] = datetime.fromtimestamp(item['time'])
        return data

    # internal methods
    # ----------------

    def _get(self, *args, **kwargs):
        return self._call(method=HTTPMethod.GET, *args, **kwargs)

    def _post(self, *args, **kwargs):
        return self._call(method=HTTPMethod.POST, *args, **kwargs)

    def _call(self,
              name: str,
              params: dict,
              method: HTTPMethod,
              files: Optional[Dict[str, str]] = None):
        if not self.do_async:
            return self._make_request(name, params, method, files)
        else:
            t = threading.Thread(target=self._make_request_in_thread, args=(name, params, method, files))
            t.start()
            return None

    def _make_request(self,
                      name: str,
                      params: dict,
                      method: HTTPMethod = HTTPMethod.GET,
                      files: Optional[Dict[str, str]] = None) -> Optional[any]:
        domain = config['host']
        kwargs = {}

        if self.basic_auth is not None:
            kwargs['auth'] = self.basic_auth

        if method == HTTPMethod.GET:
            if files:
                raise RuntimeError('can\'t upload files using GET, please use me properly')
            kwargs['params'] = params
            f = requests.get
        else:
            kwargs['data'] = params
            f = requests.post

        fd = {}
        if files:
            for fname, fpath in files.items():
                fd[fname] = open(fpath, 'rb')
            kwargs['files'] = fd

        try:
            r = f(f'https://{domain}/{name}',
                  headers={'X-Token': self.token},
                  timeout=self.timeout,
                  **kwargs)

            if not r.headers['content-type'].startswith('application/json'):
                raise ApiResponseError(r.status_code, 'TypeError', 'content-type is not application/json')

            data = json.loads(r.text)
            if r.status_code != 200:
                raise ApiResponseError(r.status_code,
                                       data['error'],
                                       data['message'],
                                       data['stacktrace'] if 'stacktrace' in data['error'] else None)

            return data['response'] if 'response' in data else True
        finally:
            for fname, f in fd.items():
                # logger.debug(f'closing file {fname} (fd={f})')
                try:
                    f.close()
                except Exception as exc:
                    _logger.exception(exc)
                    pass

    def _make_request_in_thread(self, name, params, method, files):
        try:
            result = self._make_request(name, params, method, files)
            self._report_async_success(result, name, RequestParams(params=params, method=method, files=files))
        except Exception as e:
            _logger.exception(e)
            self._report_async_error(e, name, RequestParams(params=params, method=method, files=files))

    def enable_async(self,
                     success_handler: Optional[Callable] = None,
                     error_handler: Optional[Callable] = None):
        self.do_async = True
        if error_handler:
            self.async_error_handler = error_handler
        if success_handler:
            self.async_success_handler = success_handler

    def _report_async_error(self, *args):
        if self.async_error_handler:
            self.async_error_handler(*args)

    def _report_async_success(self, *args):
        if self.async_success_handler:
            self.async_success_handler(*args)