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 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
|
"""QNAP QSW API."""
from __future__ import annotations
import asyncio
from asyncio import Lock, Semaphore
import base64
from dataclasses import dataclass
from datetime import datetime, timezone
import json
import logging
from typing import Any, cast
from aiohttp import ClientSession, ClientTimeout, ContentTypeError
from aiohttp.client_exceptions import ClientError
from aiohttp.client_reqrep import ClientResponse
from aioqsw.device import (
FirmwareCheck,
FirmwareCondition,
FirmwareInfo,
LACPInfo,
PortsStatistics,
PortsStatus,
SystemBoard,
SystemSensor,
SystemTime,
)
from .const import (
API_AUTHORIZATION,
API_COMMAND,
API_DONE,
API_DOWNLOAD_SIZE,
API_FIRMWARE_SIZE,
API_NONE,
API_PASSWORD,
API_PATH,
API_PATH_V1,
API_PROGRESS,
API_QSW_ID,
API_QSW_LANG,
API_REBOOT,
API_RESULT,
API_USERNAME,
HTTP_CALL_TIMEOUT,
HTTP_MAX_REQUESTS,
QSD_FIRMWARE_CHECK,
QSD_FIRMWARE_CONDITION,
QSD_FIRMWARE_INFO,
QSD_PORTS_STATISTICS,
QSD_PORTS_STATUS,
QSD_SYSTEM_BOARD,
QSD_SYSTEM_SENSOR,
QSD_SYSTEM_TIME,
RAW_FIRMWARE_CHECK,
RAW_FIRMWARE_CONDITION,
RAW_FIRMWARE_INFO,
RAW_LACP_INFO,
RAW_PORTS_STATISTICS,
RAW_PORTS_STATUS,
RAW_SYSTEM_BOARD,
RAW_SYSTEM_SENSOR,
RAW_SYSTEM_TIME,
)
from .exceptions import (
APIError,
APITimeout,
InternalServerError,
InvalidHost,
InvalidResponse,
LoginError,
QswError,
)
_LOGGER = logging.getLogger(__name__)
@dataclass
class ConnectionOptions:
"""QNAP QSW options for connection."""
url: str
user: str
password: str
class QnapQswApi:
"""QNAP QSW API class."""
def __init__(
self,
aiohttp_session: ClientSession,
options: ConnectionOptions,
):
"""Device init."""
self._api_raw_data: dict[str, Any] = {
RAW_FIRMWARE_CHECK: {},
RAW_FIRMWARE_CONDITION: {},
RAW_FIRMWARE_INFO: {},
RAW_LACP_INFO: {},
RAW_PORTS_STATISTICS: {},
RAW_PORTS_STATUS: {},
RAW_SYSTEM_BOARD: {},
RAW_SYSTEM_SENSOR: {},
RAW_SYSTEM_TIME: {},
}
self._api_raw_data_lock = Lock()
self._api_semaphore: Semaphore = Semaphore(HTTP_MAX_REQUESTS)
self._api_timeout: ClientTimeout = ClientTimeout(total=HTTP_CALL_TIMEOUT)
self._first_update: bool = True
self.aiohttp_session = aiohttp_session
self.api_key: str | None = None
self.cookies: dict[str, str] = {
API_QSW_LANG: "ENG",
}
self.firmware_check: FirmwareCheck | None = None
self.firmware_condition: FirmwareCondition | None = None
self.firmware_info: FirmwareInfo | None = None
self.firmware_progress: float = 0.0
self.headers: dict[str, str] = {}
self.lacp_info: LACPInfo | None = None
self.options = options
self.ports_statistics: PortsStatistics | None = None
self.ports_status: PortsStatus | None = None
self.system_board: SystemBoard | None = None
self.system_sensor: SystemSensor | None = None
self.system_time: SystemTime | None = None
async def http_request_bytes(
self, method: str, path: str, data: Any | None = None
) -> bytes:
"""Device HTTP request."""
_LOGGER.debug("aiohttp request: /%s (params=%s)", path, data)
async with self._api_semaphore:
try:
resp: ClientResponse = await self.aiohttp_session.request(
method,
f"{self.options.url}/{path}",
cookies=self.cookies,
data=json.dumps(data),
headers=self.headers,
timeout=self._api_timeout,
)
except ClientError as err:
raise InvalidHost(err) from err
except asyncio.TimeoutError as err:
raise APITimeout(err) from err
resp_bytes = await resp.read()
if resp.status == 401:
raise LoginError(f"Login error @ {method} /{path}")
if resp.status != 200:
raise APIError(f"API error @ {method} /{path} HTTP={resp.status}")
return resp_bytes
async def http_request(
self, method: str, path: str, data: Any | None = None
) -> dict[str, Any]:
"""Device HTTP request."""
_LOGGER.debug("aiohttp request: /%s (params=%s)", path, data)
async with self._api_semaphore:
try:
resp: ClientResponse = await self.aiohttp_session.request(
method,
f"{self.options.url}/{path}",
cookies=self.cookies,
data=json.dumps(data),
headers=self.headers,
timeout=self._api_timeout,
)
except ClientError as err:
raise InvalidHost(err) from err
except asyncio.TimeoutError as err:
raise APITimeout(err) from err
resp_json = None
try:
resp_json = await resp.json()
_LOGGER.debug("aiohttp response: %s", resp_json)
except ContentTypeError as err:
raise InvalidResponse(err) from err
if resp.status == 401:
raise LoginError("Login error @ {method} /{path}")
if resp.status != 200:
if resp.status == 500:
raise InternalServerError(
f"Internal server error @ {method} /{path} HTTP={resp.status}"
f"Resp={resp_json}"
)
raise APIError(
f"API error @ {method} /{path} HTTP={resp.status} Resp={resp_json}"
)
return cast(dict[str, Any], resp_json)
def lacp_start(self) -> int | None:
"""Return LACP start."""
if self.lacp_info is not None:
return self.lacp_info.get_start_id()
if self.system_board is not None:
port_num = self.system_board.get_port_num()
if port_num is not None:
return port_num + 1
return None
async def get_about(self) -> dict[str, Any]:
"""API GET about."""
return await self.http_request("GET", f"{API_PATH}/about")
async def get_firmware_condition(self) -> dict[str, Any]:
"""API GET firmware condition."""
return await self.http_request("GET", f"{API_PATH_V1}/firmware/condition")
async def get_firmware_info(self) -> dict[str, Any]:
"""API GET firmware info."""
return await self.http_request("GET", f"{API_PATH_V1}/firmware/info")
async def get_firmware_status(self) -> dict[str, Any]:
"""API GET firmware status."""
return await self.http_request("GET", f"{API_PATH_V1}/firmware/status")
async def get_firmware_update(self) -> dict[str, Any]:
"""API GET firmware update."""
return await self.http_request("GET", f"{API_PATH_V1}/firmware/update")
async def get_firmware_update_check(self) -> dict[str, Any]:
"""API GET firmware update check."""
return await self.http_request("GET", f"{API_PATH_V1}/firmware/update/check")
async def get_lacp_info(self) -> dict[str, Any]:
"""API GET LACP info."""
return await self.http_request("GET", f"{API_PATH_V1}/lacp/info")
async def get_live(self) -> dict[str, Any]:
"""API GET live."""
return await self.http_request("GET", f"{API_PATH}/live")
async def get_ports_statistics(self) -> dict[str, Any]:
"""API GET ports status."""
return await self.http_request("GET", f"{API_PATH_V1}/ports/statistics")
async def get_ports_status(self) -> dict[str, Any]:
"""API GET ports status."""
return await self.http_request("GET", f"{API_PATH_V1}/ports/status")
async def get_users_verification(self) -> dict[str, Any]:
"""API GET users verification."""
return await self.http_request("GET", f"{API_PATH_V1}/users/verification")
async def get_system_board(self) -> dict[str, Any]:
"""API GET system board."""
return await self.http_request("GET", f"{API_PATH_V1}/system/board")
async def get_system_config(self) -> bytes:
"""API GET system config."""
return await self.http_request_bytes("GET", f"{API_PATH_V1}/system/config")
async def get_system_sensor(self) -> dict[str, Any]:
"""API GET system sensor."""
return await self.http_request("GET", f"{API_PATH_V1}/system/sensor")
async def get_system_time(self) -> dict[str, Any]:
"""API GET system time."""
return await self.http_request("GET", f"{API_PATH_V1}/system/time")
async def post_system_command(self, command: str) -> dict[str, Any]:
"""API POST system command."""
params = {
API_COMMAND: command,
}
return await self.http_request("POST", f"{API_PATH_V1}/system/command", params)
async def post_firmware_update_live(self) -> dict[str, Any]:
"""API POST live firmware update."""
return await self.http_request(
"POST", f"{API_PATH_V1}/firmware/update/live", {}
)
async def post_users_exit(self) -> dict[str, Any]:
"""API POST users exit."""
return await self.http_request("POST", f"{API_PATH_V1}/users/exit", {})
async def post_users_login(self, params: dict[str, Any]) -> dict[str, Any]:
"""API POST users login."""
return await self.http_request("POST", f"{API_PATH_V1}/users/login", params)
async def set_api_raw_data(self, key: str, data: dict[str, Any] | None) -> None:
"""Save API raw data if not empty."""
if data is not None:
async with self._api_raw_data_lock:
self._api_raw_data[key] = data
async def check_firmware(self) -> FirmwareCheck:
"""Check QNAP QSW firmware version."""
await self.login()
fw_check = await self.get_firmware_update_check()
await self.set_api_raw_data(RAW_FIRMWARE_CHECK, fw_check)
if self.firmware_check is None:
self.firmware_check = FirmwareCheck(fw_check)
else:
self.firmware_check.update_data(fw_check)
return self.firmware_check
async def config_backup(self) -> bytes:
"""Create a QNAP QSW config backup."""
await self.login()
return await self.get_system_config()
async def live_update(self) -> bool:
"""Update QNAP QSW to live firmware."""
await self.login()
self.firmware_progress = 0.0
response = await self.post_firmware_update_live()
result = response.get(API_RESULT)
if API_RESULT not in response or result != API_NONE:
raise APIError(f"Error when updating: {response}")
return True
async def reboot(self) -> bool:
"""Reboot QNAP QSW."""
await self.login()
response = await self.post_system_command(API_REBOOT)
result = response.get(API_RESULT)
if API_RESULT not in response or result != API_NONE:
raise APIError(f"Error when rebooting: {response}")
return True
async def update_progress(self) -> float:
"""Get QNAP QSW update progress."""
response = await self.get_firmware_update()
result = response.get(API_RESULT)
if result is dict:
if result.keys() >= {API_DOWNLOAD_SIZE, API_FIRMWARE_SIZE}:
dl_size = float(result[API_DOWNLOAD_SIZE])
fw_size = float(result[API_FIRMWARE_SIZE])
self.firmware_progress = dl_size * 100.0 / fw_size
return self.firmware_progress
async def update_status(self) -> bool:
"""Get QNAP QSW update status."""
response = await self.get_firmware_status()
result = response.get(API_RESULT)
if API_RESULT in response and result == API_NONE:
return False
if result is dict:
if API_PROGRESS in result and result[API_PROGRESS] == API_DONE:
return False
return True
async def validate(self) -> SystemBoard:
"""Validate QNAP QSW."""
self._first_update = True
self.ports_statistics = None
try:
await self.get_live()
except APIError as err:
raise InvalidHost(err) from err
try:
await self._login()
except APIError as err:
raise LoginError(err) from err
res = await self.get_system_board()
return SystemBoard(res)
async def update_firmware_condition(self) -> None:
"""Update firmware/condition."""
firmware_condition = await self.get_firmware_condition()
await self.set_api_raw_data(RAW_FIRMWARE_CONDITION, firmware_condition)
if self.firmware_condition is None:
self.firmware_condition = FirmwareCondition(firmware_condition)
else:
self.firmware_condition.update_data(firmware_condition)
async def update_firmware_info(self) -> None:
"""Update firmware/info."""
if self.firmware_info is None:
firmware_info = await self.get_firmware_info()
await self.set_api_raw_data(RAW_FIRMWARE_INFO, firmware_info)
self.firmware_info = FirmwareInfo(firmware_info)
async def update_lacp_info(self) -> None:
"""Update lacp/info."""
if self.lacp_info is None:
lacp_info = await self.get_lacp_info()
await self.set_api_raw_data(RAW_LACP_INFO, lacp_info)
self.lacp_info = LACPInfo(lacp_info)
async def update_ports_statistics(self, lacp_start: int | None) -> None:
"""Update ports/statistics."""
ports_statistics_data = await self.get_ports_statistics()
cur_datetime = datetime.now(tz=timezone.utc).replace(tzinfo=None)
await self.set_api_raw_data(RAW_PORTS_STATISTICS, ports_statistics_data)
if self.ports_statistics is None:
self.ports_statistics = PortsStatistics(
ports_statistics_data, lacp_start, cur_datetime
)
else:
self.ports_statistics.update_data(
ports_statistics_data, lacp_start, cur_datetime
)
async def update_ports_status(self, lacp_start: int | None) -> None:
"""Update ports/status."""
ports_status_data = await self.get_ports_status()
await self.set_api_raw_data(RAW_PORTS_STATUS, ports_status_data)
if self.ports_status is None:
self.ports_status = PortsStatus(ports_status_data, lacp_start)
else:
self.ports_status.update_data(ports_status_data, lacp_start)
async def update_system_board(self) -> None:
"""Update system/board."""
if self.system_board is None:
system_board = await self.get_system_board()
await self.set_api_raw_data(RAW_SYSTEM_BOARD, system_board)
self.system_board = SystemBoard(system_board)
async def update_system_sensor(self) -> None:
"""Update system/sensor."""
try:
system_sensor = await self.get_system_sensor()
await self.set_api_raw_data(RAW_SYSTEM_SENSOR, system_sensor)
if self.system_sensor is None:
self.system_sensor = SystemSensor(system_sensor)
else:
self.system_sensor.update_data(system_sensor)
except InternalServerError as err:
if self._first_update:
raise err
_LOGGER.warning(err)
async def update_system_time(self) -> None:
"""Update system/time."""
system_time = await self.get_system_time()
cur_datetime = datetime.now(tz=timezone.utc).replace(microsecond=0)
await self.set_api_raw_data(RAW_SYSTEM_TIME, system_time)
if self.system_time is None:
self.system_time = SystemTime(system_time, cur_datetime)
else:
self.system_time.update_data(system_time, cur_datetime)
async def update(self) -> None:
"""Update QNAP QSW."""
await self.login()
# Call system/sensor first since it takes a lot of time (~5s)
system_sensor_task = asyncio.create_task(self.update_system_sensor())
try:
tasks = [
asyncio.create_task(self.update_lacp_info()),
asyncio.create_task(self.update_system_board()),
]
await asyncio.gather(*tasks)
lacp_start = self.lacp_start()
tasks = [
asyncio.create_task(self.update_firmware_condition()),
asyncio.create_task(self.update_firmware_info()),
asyncio.create_task(self.update_ports_statistics(lacp_start)),
asyncio.create_task(self.update_ports_status(lacp_start)),
asyncio.create_task(self.update_system_time()),
]
await asyncio.gather(*tasks)
except QswError as err:
system_sensor_task.cancel()
raise err
await system_sensor_task
self._first_update = False
def _login_clear(self) -> None:
"""Clear login data."""
self.api_key = None
if API_QSW_ID in self.cookies:
del self.cookies[API_QSW_ID]
if API_AUTHORIZATION in self.headers:
del self.headers[API_AUTHORIZATION]
self.firmware_info = None
self.lacp_info = None
self.system_board = None
self.system_time = None
def _login_required(self) -> bool:
"""Check if login is required."""
return (
not self.api_key
or API_QSW_ID not in self.cookies
or API_AUTHORIZATION not in self.headers
)
async def _login(self) -> None:
"""Perform a new user login."""
self._login_clear()
pass_utf8 = self.options.password.encode("utf-8")
b64_pass = base64.b64encode(pass_utf8).decode("utf-8")
params = {
API_USERNAME: self.options.user,
API_PASSWORD: b64_pass,
}
try:
login = await self.post_users_login(params)
except APIError as err:
raise LoginError(err) from err
if API_RESULT not in login:
raise LoginError("Invalid login response")
self.api_key = str(login[API_RESULT])
self.cookies[API_QSW_ID] = self.api_key
self.headers[API_AUTHORIZATION] = f"Bearer {self.api_key}"
async def login(self) -> None:
"""User login."""
if self._login_required():
await self._login()
else:
try:
await self.get_users_verification()
except LoginError:
await self._login()
async def logout(self) -> None:
"""User logout."""
if not self._login_required():
try:
await self.post_users_exit()
except APIError:
pass
self._login_clear()
def raw_data(self) -> dict[str, Any]:
"""Return raw QNAP QSW API data."""
return self._api_raw_data
def data(self) -> dict[str, Any]:
"""Return QNAP QSW device data."""
data: dict[str, Any] = {}
if self.firmware_check is not None:
firmware_check_data = self.firmware_check.data()
if len(firmware_check_data) > 0:
data[QSD_FIRMWARE_CHECK] = firmware_check_data
if self.firmware_condition is not None:
firmware_condition_data = self.firmware_condition.data()
if len(firmware_condition_data) > 0:
data[QSD_FIRMWARE_CONDITION] = firmware_condition_data
if self.firmware_info is not None:
firmware_info_data = self.firmware_info.data()
if len(firmware_info_data) > 0:
data[QSD_FIRMWARE_INFO] = firmware_info_data
if self.ports_statistics is not None:
ports_statistics_data = self.ports_statistics.data()
if len(ports_statistics_data) > 0:
data[QSD_PORTS_STATISTICS] = ports_statistics_data
if self.ports_status is not None:
ports_status_data = self.ports_status.data()
if len(ports_status_data) > 0:
data[QSD_PORTS_STATUS] = ports_status_data
if self.system_board is not None:
system_board_data = self.system_board.data()
if len(system_board_data) > 0:
data[QSD_SYSTEM_BOARD] = system_board_data
if self.system_sensor is not None:
system_sensor_data = self.system_sensor.data()
if len(system_sensor_data) > 0:
data[QSD_SYSTEM_SENSOR] = system_sensor_data
if self.system_time is not None:
system_time_data = self.system_time.data()
if len(system_time_data) > 0:
data[QSD_SYSTEM_TIME] = system_time_data
return data
|