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 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
|
"""Connection module.
This module handles the connection between the library and the router
as well as all the data transfer.
"""
from __future__ import annotations
import asyncio
import base64
from collections.abc import Awaitable, Callable
import contextlib
from enum import StrEnum
import json
import logging
import ssl
from typing import Any, Self, TypeVar
from urllib.parse import quote
import aiohttp
from asusrouter.config import (
ARConfig,
ARConfigKey as ARConfKey,
safe_int_config,
)
from asusrouter.connection_config import (
ARConnectionConfig,
ARConnectionConfigKey as ARCCKey,
)
from asusrouter.const import (
DEFAULT_PORT_HTTP,
DEFAULT_PORT_HTTPS,
DEFAULT_TIMEOUT,
DEFAULT_TIMEOUT_FALLBACK,
USER_AGENT,
HTTPStatus,
RequestType,
)
from asusrouter.error import (
AsusRouter404Error,
AsusRouterAccessError,
AsusRouterConnectionError,
AsusRouterError,
AsusRouterFallbackError,
AsusRouterFallbackForbiddenError,
AsusRouterFallbackLoopError,
AsusRouterLogoutError,
AsusRouterNotImplementedError,
AsusRouterSSLCertificateError,
AsusRouterTimeoutError,
)
from asusrouter.modules.endpoint import (
EndpointService,
EndpointType,
is_sensitive_endpoint,
)
from asusrouter.modules.endpoint.error import handle_access_error
from asusrouter.tools.connection import get_cookie_jar
from asusrouter.tools.converters import clean_string, safe_float
from asusrouter.tools.security import ARSecurityLevel
_LOGGER = logging.getLogger(__name__)
_T = TypeVar("_T")
class ConnectionFallback(StrEnum):
"""Connection fallback strategies."""
HTTP = "http"
HTTPS = "https"
HTTPS_UNSAFE = "https_unsafe"
def generate_credentials(
username: str, password: str
) -> tuple[str, dict[str, str]]:
"""Generate credentials for connection."""
auth = f"{username}:{password}".encode("ascii")
logintoken = base64.b64encode(auth).decode("ascii")
payload = f"login_authorization={logintoken}"
headers = {"user-agent": USER_AGENT}
return payload, headers
def sanitize_data(
value: str | None,
) -> str:
"""Sanitize data placeholder."""
return "[SANITIZED PLACEHOLDER]"
class Connection: # pylint: disable=too-many-instance-attributes
"""A connection between the library and the device."""
def __init__( # noqa: PLR0913
self,
hostname: str,
username: str,
password: str,
port: int | None = None,
use_ssl: bool = False,
session: aiohttp.ClientSession | None = None,
timeout: int | None = DEFAULT_TIMEOUT,
dumpback: Callable[..., Awaitable[None]] | None = None,
config: dict[ARCCKey, Any] | None = None,
):
"""Initialize connection."""
_LOGGER.debug("Initializing a new connection to `%s`", hostname)
# Initialize configs
self._config = ARConnectionConfig()
self._used_fallbacks: dict[ConnectionFallback, bool] = {}
# Initialize startup configs if any provided
if isinstance(config, dict):
_LOGGER.debug("Using provided connection config: %s", config)
for key, value in config.items():
self._config.set(key, value)
# Initialize parameters for connection
self._token: str | None = None
self._header: dict[str, str] | None = None
self._connected: bool = False
self._connection_lock: asyncio.Lock = asyncio.Lock()
self._timeout: int = timeout or DEFAULT_TIMEOUT
# Single in-flight connect task (serialize connection attempts)
self._connect_task: asyncio.Task[Any] | None = None
# Lock to guard creation of the connect task
self._connect_task_lock: asyncio.Lock = asyncio.Lock()
# Hostname and credentials
self._hostname = hostname
self._username = username
self._password = password
# Set the port and protocol based on the input
self.config.set(
ARCCKey.PORT,
port or (DEFAULT_PORT_HTTPS if use_ssl else DEFAULT_PORT_HTTP),
)
self.config.set(ARCCKey.USE_SSL, use_ssl)
_LOGGER.debug(
"Using `%s` and port `%s` with ssl flag `%s`",
self.http,
self.config.get(ARCCKey.PORT),
use_ssl,
)
# Callback for dumping data
self._dumpback = dumpback
# Client session
self._manage_session: bool = False
if session is not None:
_LOGGER.debug("Using provided session")
self._session = session
else:
_LOGGER.debug("No session provided. Will create a new one")
self._session = self._new_session()
async def __aenter__(self) -> Self:
"""Enter the connection."""
await self.async_connect()
return self
async def __aexit__(
self,
exc_type: object,
exc_value: object,
traceback: object,
) -> None:
"""Exit the connection."""
await self.async_close()
@classmethod
async def create( # noqa: PLR0913
cls,
hostname: str,
username: str,
password: str,
port: int | None = None,
use_ssl: bool = False,
session: aiohttp.ClientSession | None = None,
timeout: int | None = DEFAULT_TIMEOUT, # noqa: ASYNC109
dumpback: Callable[..., Awaitable[None]] | None = None,
config: dict[ARCCKey, Any] | None = None,
) -> Connection:
"""Create and initialize a connection."""
connection = cls(
hostname=hostname,
username=username,
password=password,
port=port,
use_ssl=use_ssl,
session=session,
timeout=timeout or DEFAULT_TIMEOUT,
dumpback=dumpback,
config=config,
)
await connection.async_connect()
return connection
def _new_session(self) -> aiohttp.ClientSession:
"""Create a new session."""
# If we create a new session, we will manage it
self._manage_session = True
# Timeout for the session
timeout = aiohttp.ClientTimeout(total=self._timeout)
# Create the session
return aiohttp.ClientSession(
connector=aiohttp.TCPConnector(),
cookie_jar=get_cookie_jar(),
timeout=timeout,
)
async def async_close(self) -> None:
"""Close the session."""
if self._manage_session and self._session:
if not self._session.closed:
_LOGGER.debug("Closing the session")
await self._session.close()
else:
_LOGGER.debug("Session already closed")
else:
_LOGGER.debug("No session to close or not managing the session")
async def async_connect(
self,
lock: asyncio.Lock | None = None,
t_overwrite: float | None = None,
block_error: bool = False,
) -> bool:
"""Connect to the device and get a new auth token."""
timeout = safe_float(t_overwrite) or self._timeout
# If already connected, return fast
if self._connected:
return True
# Ensure only one connect Task is created;
# reuse it for concurrent callers
async with self._connect_task_lock:
if self._connect_task is None or self._connect_task.done():
# start the connect attempt as a background task
self._connect_task = asyncio.create_task(
self._async_connect_with_lock(lock)
)
try:
# Await the in-flight connect but don't cancel it on
# outer timeout: use shield so that callers timing out
# won't cancel the actual attempt.
await asyncio.wait_for(
asyncio.shield(self._connect_task), timeout=timeout
)
return True
except TimeoutError:
if not block_error:
_LOGGER.error("Connection to %s timed out", self._hostname)
# do not cancel the underlying task here; let it finish
# and satisfy future callers
return False
except asyncio.CancelledError:
# Underlying connect was cancelled (e.g. by fallback).
# Treat as failed.
if not block_error:
_LOGGER.debug("Connection attempt was cancelled")
return False
finally:
# If the task finished, clear it to allow future retries.
if self._connect_task is not None and self._connect_task.done():
self._connect_task = None
async def _async_connect_with_lock(
self,
lock: asyncio.Lock | None = None,
) -> bool:
"""Connect to the device and get a new auth token.
Acquire the lock only for state checks/updates. Perform the actual
network login outside the lock to avoid deadlocks when fallback
triggers a nested connect attempt.
"""
_lock = lock or self._connection_lock
# Quick check / early exit while holding the lock
async with _lock:
if self._connected:
_LOGGER.debug("Already connected to %s", self._hostname)
return True
_LOGGER.debug("Initializing connection to %s", self._hostname)
# Prepare auth payload and headers (no lock held)
payload, headers = generate_credentials(self._username, self._password)
_LOGGER.debug("Requesting authorization")
try:
# Do the network login outside the lock to avoid deadlocks
_, _, resp_content = await self._send_request(
EndpointService.LOGIN, payload, headers
)
_LOGGER.debug("Received authorization response")
except AsusRouterSSLCertificateError as ex:
raise AsusRouterAccessError(
f"Cannot access {EndpointService.LOGIN}. "
"due to the SSL certificate error"
) from ex
except AsusRouterAccessError as ex:
raise AsusRouterAccessError(
f"Cannot access {EndpointService.LOGIN}. "
"Failed in `async_connect`"
) from ex
except AsusRouterError as ex:
_LOGGER.debug("Connection failed with error: %s", ex)
raise
except Exception as ex: # pylint: disable=broad-except
_LOGGER.debug(
"Unexpected error while connecting to %s: %s",
self._hostname,
ex,
)
raise
# Process response and update state while holding the lock
content = json.loads(resp_content)
token = content.get("asus_token")
if not token:
_LOGGER.error("No token received")
return False
async with _lock:
# Another task may have connected while we performed
# the network IO. If so, avoid overwriting state and return early.
if self._connected:
_LOGGER.debug(
"Connection already established to %s by another task",
self._hostname,
)
return True
# Store token and header
self._token = token
self._header = {
"user-agent": USER_AGENT,
"cookie": f"asus_token={self._token}",
}
# Mark as connected
self._connected = True
_LOGGER.debug("Connected to %s", self._hostname)
return True
async def async_disconnect(self) -> bool:
"""Disconnect from the device."""
_LOGGER.debug("Initializing disconnection from %s", self._hostname)
# Check that we are connected
if not self._connected:
_LOGGER.debug("Not connected to %s", self._hostname)
return True
# Request logout
try:
await self._send_request(EndpointService.LOGOUT)
except AsusRouterLogoutError:
# Loged out successfully
self.reset_connection()
_LOGGER.debug("Disconnected from %s", self._hostname)
return True
except AsusRouterError as ex:
_LOGGER.debug(
"Error while disconnecting from %s: %s", self._hostname, ex
)
return False
# Anything else would mean error when disconnecting
return False
def _payload_for_logging(
self, security_level: Any, endpoint: EndpointType, payload: str | None
) -> str | None:
"""Return the payload to log if any.
Rules:
- STRICT: never log payload
- DEFAULT: log only non-sensitive endpoints
- SANITIZED: log sensitive endpoints with automatic sanitization
- UNSAFE: log sensitive endpoints verbatim
"""
# Resolve security level safely
level = ARSecurityLevel.from_value(security_level)
# STRICT: never include payload | Never include
# login payload at any level
if (
level == ARSecurityLevel.STRICT
or endpoint == EndpointService.LOGIN
):
return None
# Clean from empty strings
payload = clean_string(payload)
if payload is None:
return None
# Sensitive endpoints: only allowed if explicitly set to
# UNSAFE by user or are SANITIZED
if is_sensitive_endpoint(endpoint):
if ARSecurityLevel.at_least_sanitized(level):
if level == ARSecurityLevel.SANITIZED:
# Automatically sanitized to remove sensitive data
return sanitize_data(payload)
# Only UNSAFE level is above SANITIZED, meaning
# Explicitly allowed as raw data by user
return payload
# Any other level should not log a possible sensitive payload
return None
# Non-sensitive endpoints: log (unless was blocked by STRICT config)
return payload
def _log_request(
self, endpoint: EndpointType, payload: str | None
) -> None:
"""Log the request details."""
security_level = ARConfig.get(ARConfKey.DEBUG_PAYLOAD)
# Prepare payload to log
payload_to_log = self._payload_for_logging(
security_level, endpoint, payload
)
if payload_to_log is None:
_LOGGER.debug("Sending request to `%s`", endpoint)
else:
_LOGGER.debug(
"Sending request to `%s` with payload: %s",
endpoint,
payload_to_log,
)
async def _send_request( # noqa: C901, PLR0912
self,
endpoint: EndpointType,
payload: str | None = None,
headers: dict[str, str] | None = None,
request_type: RequestType = RequestType.POST,
) -> tuple[int, dict[str, str], str]:
"""Send a request to the device."""
# Send request
try:
# Log request
self._log_request(endpoint, payload)
# Make the request
resp_status, resp_headers, resp_content = await self._make_request(
endpoint,
payload,
headers,
request_type,
)
# Raise exception on 404
if resp_status == HTTPStatus.NOT_FOUND:
raise AsusRouter404Error(f"Endpoint {endpoint} not found")
# Raise exception on non-200 status
if resp_status != HTTPStatus.OK:
raise AsusRouterAccessError(
f"Cannot access {endpoint}, status {resp_status}"
)
# Check for access errors
if "error_status" in resp_content:
handle_access_error(
endpoint, resp_status, resp_headers, resp_content
)
# Reset fallback tracker if multiple fallbacks are allowed
if self.config.get(ARCCKey.ALLOW_MULTIPLE_FALLBACKS):
self._used_fallbacks.clear()
# Return the response
return (resp_status, resp_headers, resp_content)
except ssl.SSLCertVerificationError as ex:
if self.config.get(
ARCCKey.STRICT_SSL
) is False and self.config.get(ARCCKey.ALLOW_FALLBACK):
_LOGGER.warning(
"Cannot verify SSL certificate. Since `STRICT_SSL` "
"configuration is disabled, falling back to HTTP "
"with a default port"
)
await self._fallback()
# Repeat the attempt
return await self._send_request(
endpoint, payload, headers, request_type
)
raise AsusRouterSSLCertificateError(
"SSL certificate verification failed. Your configuration "
"requires a strict SSL certificate verification."
) from ex
except aiohttp.ClientConnectorError as ex:
# Are automatic fallbacks allowed?
if self.config.get(ARCCKey.ALLOW_FALLBACK):
return await self._async_handle_fallback(
callback=self._send_request,
endpoint=endpoint,
payload=payload,
headers=headers,
request_type=request_type,
)
self.reset_connection()
raise AsusRouterConnectionError(
f"Cannot connect to `{self._hostname}` on port "
f"`{self.port}`. Failed in `_send_request` with error: `{ex}`"
) from ex
except (aiohttp.ClientConnectionError, aiohttp.ClientOSError) as ex:
raise AsusRouterConnectionError(
f"Cannot connect to `{self._hostname}` on port "
f"`{self.port}`. Failed in `_send_request` with error: `{ex}`"
) from ex
except (TimeoutError, asyncio.CancelledError) as ex:
raise AsusRouterTimeoutError(
f"Data cannot be retrieved due to an asyncio error. "
f"Connection failed: {ex}"
) from ex
except Exception as ex: # pylint: disable=broad-except
_LOGGER.debug(
"Unexpected error sending request to %s: %s",
endpoint,
ex,
)
raise ex
async def _async_handle_fallback(
self, callback: Callable[..., Awaitable[_T]], **kwargs: Any
) -> _T:
"""Handle fallbacks on sending requests.
The matrix for the automatic feedback is as follows:
| Con @ Port | New @ port | Required config |
| --------------- | --------------- | --------------------------- |
| HTTPS @ Custom | HTTPS @ Default | |
| HTTPS @ Default | HTTP @ Default | STRICT_SSL not set |
| HTTP @ Custom | HTTP @ Default | |
| HTTP @ Default | HTTPS @ Default | ALLOW_UPGRADE_HTTP_TO_HTTPS |
"""
if self.config.get(ARCCKey.USE_SSL):
# From custom HTTPS to default HTTPS
if self.port != DEFAULT_PORT_HTTPS:
if self._used_fallbacks.get(ConnectionFallback.HTTPS):
raise AsusRouterFallbackLoopError(
"Fallback loop detected trying to heal HTTPS "
f"connection with set port `{self.port}`"
)
_LOGGER.warning(
"Cannot connect on the provided HTTPS port `%d`. "
"Will fallback to the default port `%d`",
self.port,
DEFAULT_PORT_HTTPS,
)
await self._fallback(fallback_type=ConnectionFallback.HTTPS)
# Repeat the attempt
return await callback(**kwargs)
# From default HTTPS to default HTTP
if self.config.get(ARCCKey.STRICT_SSL):
raise AsusRouterFallbackForbiddenError(
"Fallback from HTTPS to HTTP connection is forbidden "
"by the `STRICT_SSL` configuration option"
)
if self._used_fallbacks.get(ConnectionFallback.HTTP):
raise AsusRouterFallbackLoopError(
"Fallback loop detected trying to heal HTTPS "
"by switching to HTTP"
)
_LOGGER.warning(
"Cannot connect on the default HTTPS port `%d`. "
"Will fallback to the HTTP connection "
"on default port `%d`",
DEFAULT_PORT_HTTPS,
DEFAULT_PORT_HTTP,
)
await self._fallback(fallback_type=ConnectionFallback.HTTP)
# Repeat the attempt
return await callback(**kwargs)
# From custom HTTP to default HTTP
if self.port != DEFAULT_PORT_HTTP:
if self._used_fallbacks.get(ConnectionFallback.HTTP):
raise AsusRouterFallbackLoopError(
"Fallback loop detected trying to heal HTTP "
"by upgrading to HTTPS"
)
_LOGGER.warning(
"Cannot connect on the custom HTTP port `%d`. "
"Will try using the default HTTP port `%d`",
self.port,
DEFAULT_PORT_HTTP,
)
await self._fallback(fallback_type=ConnectionFallback.HTTP)
# Repeat the attempt
return await callback(**kwargs)
# From default HTTP to default HTTPS
if self.config.get(ARCCKey.ALLOW_UPGRADE_HTTP_TO_HTTPS):
# Force certificate verification
self.config.set(ARCCKey.VERIFY_SSL, True)
if self._used_fallbacks.get(ConnectionFallback.HTTPS):
raise AsusRouterFallbackLoopError(
"Fallback loop detected trying to heal HTTP "
"by upgrading to HTTPS"
)
_LOGGER.warning(
"Cannot connect on the default HTTP port `%d`. "
"Will try upgrading to the default HTTPS port `%d`",
self.port,
DEFAULT_PORT_HTTPS,
)
await self._fallback(fallback_type=ConnectionFallback.HTTPS)
# Repeat the attempt
return await callback(**kwargs)
raise AsusRouterFallbackError(
"Automatic fallback failed. Consider disabling it."
)
async def _fallback(
self, fallback_type: ConnectionFallback | None = None
) -> None:
"""Perform connection fallback."""
if not fallback_type:
fallback_type = ConnectionFallback.HTTP
# Mark fallback type as used to avoid loops
self._used_fallbacks[fallback_type] = True
# Set fallback connection parameters
match fallback_type:
case ConnectionFallback.HTTP:
self.config.set(ARCCKey.USE_SSL, False)
self.config.set(ARCCKey.PORT, DEFAULT_PORT_HTTP)
# We should not change the VERIFY_SSL setting here
case ConnectionFallback.HTTPS:
self.config.set(ARCCKey.USE_SSL, True)
self.config.set(ARCCKey.PORT, DEFAULT_PORT_HTTPS)
# We should not change the VERIFY_SSL setting here
case ConnectionFallback.HTTPS_UNSAFE:
self.config.set(ARCCKey.USE_SSL, True)
self.config.set(ARCCKey.PORT, DEFAULT_PORT_HTTPS)
self.config.set(ARCCKey.VERIFY_SSL, False)
case _:
raise AsusRouterNotImplementedError(
f"Connection fallback not implemented: {fallback_type}"
)
# Reconnect with new parameters
# If there is an in-flight connect task, cancel it first so the
# fallback can start a fresh immediate connection attempt instead of
# awaiting the old (failing) task until its timeout.
old_task: asyncio.Task | None = None
async with self._connect_task_lock:
if (
self._connect_task is not None
and not self._connect_task.done()
):
_LOGGER.debug(
"Cancelling in-flight connect attempt to "
"allow fallback reconnect"
)
# Capture and cancel the in-flight connect task
# so we can await it later (outside the lock)
# and consume any exception it raises.
old_task = self._connect_task
with contextlib.suppress(Exception):
old_task.cancel()
# Clear reference so a new connect can be started by fallback
self._connect_task = None
# Await the cancelled task to consume its exception (if any).
# Do this outside the connect_task_lock to avoid deadlocks.
if old_task is not None:
try:
await old_task
except asyncio.CancelledError:
# expected due to cancel()
pass
except Exception as exc: # noqa: BLE001 - consume/log other errors
_LOGGER.debug(
"In-flight connect task finished after cancel with: %s",
exc,
)
# Reset connection state and perform a bounded reconnect
# for the fallback.
self.reset_connection()
await self.async_connect(
t_overwrite=DEFAULT_TIMEOUT_FALLBACK, block_error=True
)
async def async_query(
self,
endpoint: EndpointType,
payload: str | None = None,
headers: dict[str, str] | None = None,
request_type: RequestType = RequestType.POST,
) -> tuple[int, dict[str, str], str]:
"""Send a request to the device."""
# If not connected, try to connect
if not self._connected:
_LOGGER.debug("Not connected to %s. Connecting...", self._hostname)
await self.async_connect()
# If still not connected, raise an error
if not self._connected:
raise AsusRouterTimeoutError(
"Data cannot be retrieved. Connection failed"
)
# Send the request
_LOGGER.debug(
"Sending `%s` request to `%s`", request_type, self._hostname
)
return await self._send_request(
endpoint, payload, headers, request_type
)
async def _make_request(
self,
endpoint: EndpointType,
payload: str | None = None,
headers: dict[str, str] | None = None,
request_type: RequestType = RequestType.POST,
) -> Any:
"""Make a post request to the device."""
# Check if a session is available
if self._session is None or self._session.closed:
# If no session is available, we cannot be connected to the device
_LOGGER.debug("No session available. Creating a new one")
# We will create a new session and retry the request
self.reset_connection()
self._session = self._new_session()
# Reconnect
await self.async_connect()
# Retry the request
return await self._make_request(
endpoint, payload, headers, request_type
)
# Check headers
if not headers:
headers = self._header
# Generate the url
url = f"{self.webpanel}/{endpoint.value}"
# Add get parameters if needed
if request_type == RequestType.GET and payload:
url_payload = payload.replace(";", "&")
url = f"{url}?{url_payload}"
# Process the payload to be sent
payload_to_send = quote(payload) if payload else None
# Send the request
async with self._session.request(
request_type.value,
url,
data=payload_to_send if request_type == RequestType.POST else None,
headers=headers,
ssl=self.config.get(ARCCKey.VERIFY_SSL),
) as response:
# Read the status code
resp_status = response.status
# Read the response headers
resp_headers = response.headers
# Read the response
try:
resp_content = await response.text()
except UnicodeDecodeError:
_LOGGER.debug("Cannot decode response. Will ignore errors")
resp_content = await response.text(errors="ignore")
# Call the dumpback if available
if self._dumpback is not None:
await self._dumpback(
endpoint, payload, resp_status, resp_headers, resp_content
)
# Return the response
return (resp_status, resp_headers, resp_content)
def reset_connection(self) -> None:
"""Reset connection variables."""
if not self._connected:
return
_LOGGER.debug("Resetting connection to %s", self._hostname)
self._connected = False
self._token = None
self._header = None
@property
def config(self) -> ARConnectionConfig:
"""Return connection config."""
return self._config
@property
def connected(self) -> bool:
"""Return connection status."""
return self._connected
@property
def http(self) -> str:
"""Return HTTP scheme."""
return "https" if self._config.get(ARCCKey.USE_SSL) else "http"
@property
def port(self) -> int:
"""Return port number."""
return safe_int_config(self._config.get(ARCCKey.PORT))
@property
def webpanel(self) -> str:
"""Return web panel URL."""
return f"{self.http}://{self._hostname}:{self.port}"
|