tplinkrouterc6u 5.3.0__py3-none-any.whl → 5.4.0__py3-none-any.whl

test/test_client_c1200.py

@@ -3,41 +3,45 @@ from json import loads
 from tplinkrouterc6u import (
     TplinkC1200Router,
     Connection,
-    ClientException
+    ClientException,
 )
+from tplinkrouterc6u.common.package_enum import VPN
 
 
 class TestTPLinkC1200Client(TestCase):
-
     def test_set_led_on(self) -> None:
-
-        response_led_general_read = '''
+        response_led_general_read = """
         {
             "enable": "off",
             "time_set": "yes",
             "ledpm_support": "yes"
         }
-        '''
+        """
 
-        response_led_general_write = '''
+        response_led_general_write = """
         {
             "enable": "on",
             "time_set": "yes",
             "ledpm_support": "yes"
         }
-        '''
+        """
 
         class TPLinkRouterTest(TplinkC1200Router):
-            def request(self, path: str, data: str,
-                        ignore_response: bool = False, ignore_errors: bool = False) -> dict | None:
-                if path == 'admin/ledgeneral?form=setting&operation=read':
+            def request(
+                self,
+                path: str,
+                data: str,
+                ignore_response: bool = False,
+                ignore_errors: bool = False,
+            ) -> dict | None:
+                if path == "admin/ledgeneral?form=setting&operation=read":
                     return loads(response_led_general_read)
-                if path == 'admin/ledgeneral?form=setting&operation=write':
+                if path == "admin/ledgeneral?form=setting&operation=write":
                     self.captured_path = path
                     return loads(response_led_general_write)
                 raise ClientException()
 
-        client = TPLinkRouterTest('', '')
+        client = TPLinkRouterTest("", "")
 
         client.set_led(True)
 
@@ -46,34 +50,38 @@ class TestTPLinkC1200Client(TestCase):
         self.assertEqual(client.captured_path, expected_path)
 
     def test_set_led_off(self) -> None:
-
-        response_led_general_read = '''
+        response_led_general_read = """
         {
             "enable": "on",
             "time_set": "yes",
             "ledpm_support": "yes"
         }
-        '''
+        """
 
-        response_led_general_write = '''
+        response_led_general_write = """
         {
             "enable": "off",
             "time_set": "yes",
             "ledpm_support": "yes"
         }
-        '''
+        """
 
         class TPLinkRouterTest(TplinkC1200Router):
-            def request(self, path: str, data: str,
-                        ignore_response: bool = False, ignore_errors: bool = False) -> dict | None:
-                if path == 'admin/ledgeneral?form=setting&operation=read':
+            def request(
+                self,
+                path: str,
+                data: str,
+                ignore_response: bool = False,
+                ignore_errors: bool = False,
+            ) -> dict | None:
+                if path == "admin/ledgeneral?form=setting&operation=read":
                     return loads(response_led_general_read)
-                elif path == 'admin/ledgeneral?form=setting&operation=write':
+                if path == "admin/ledgeneral?form=setting&operation=write":
                     self.captured_path = path
                     return loads(response_led_general_write)
                 raise ClientException()
 
-        client = TPLinkRouterTest('', '')
+        client = TPLinkRouterTest("", "")
 
         client.set_led(False)
 
@@ -82,37 +90,44 @@ class TestTPLinkC1200Client(TestCase):
         self.assertEqual(client.captured_path, expected_path)
 
     def test_led_status(self) -> None:
-
-        response_led_general_read = '''
+        response_led_general_read = """
         {
             "enable": "on",
             "time_set": "yes",
             "ledpm_support": "yes"
         }
-        '''
+        """
 
         class TPLinkRouterTest(TplinkC1200Router):
-            def request(self, path: str, data: str,
-                        ignore_response: bool = False, ignore_errors: bool = False) -> dict | None:
-                if path == 'admin/ledgeneral?form=setting&operation=read':
+            def request(
+                self,
+                path: str,
+                data: str,
+                ignore_response: bool = False,
+                ignore_errors: bool = False,
+            ) -> dict | None:
+                if path == "admin/ledgeneral?form=setting&operation=read":
                     return loads(response_led_general_read)
                 raise ClientException()
 
-        client = TPLinkRouterTest('', '')
+        client = TPLinkRouterTest("", "")
 
         led_status = client.get_led()
         self.assertTrue(led_status)
 
     def test_set_wifi(self) -> None:
-
         class TPLinkRouterTest(TplinkC1200Router):
-            def request(self, path: str, data: str,
-                        ignore_response: bool = False, ignore_errors: bool = False) -> dict | None:
-
+            def request(
+                self,
+                path: str,
+                data: str,
+                ignore_response: bool = False,
+                ignore_errors: bool = False,
+            ) -> dict | None:
                 self.captured_path = path
                 self.captured_data = data
 
-        client = TPLinkRouterTest('', '')
+        client = TPLinkRouterTest("", "")
         client.set_wifi(
             Connection.HOST_5G,
             enable=True,
@@ -126,17 +141,119 @@ class TestTPLinkC1200Client(TestCase):
             htmode="VHT20",
             channel=36,
             txpower="20",
-            disabled_all="no"
+            disabled_all="no",
         )
 
-        expected_data = ("operation=write&enable=on&ssid=TestSSID&hidden=no&encryption=WPA3-PSK&"
-                         "psk_version=2&psk_cipher=AES&psk_key=testkey123&hwmode=11ac&"
-                         "htmode=VHT20&channel=36&txpower=20&disabled_all=no")
+        expected_data = (
+            "operation=write&enable=on&ssid=TestSSID&hidden=no&encryption=WPA3-PSK&"
+            "psk_version=2&psk_cipher=AES&psk_key=testkey123&hwmode=11ac&"
+            "htmode=VHT20&channel=36&txpower=20&disabled_all=no"
+        )
         expected_path = f"admin/wireless?form=wireless_5g&{expected_data}"
 
         self.assertEqual(client.captured_path, expected_path)
         self.assertEqual(client.captured_data, expected_data)
 
+    def test_vpn_status(self) -> None:
+        response_openvpn_read = """
+        {
+            "enabled": "on",
+            "proto": "udp",
+            "access": "home",
+            "cert_exist": true,
+            "mask": "255.255.255.0",
+            "port": "1194",
+            "serverip": "10.8.0.0"
+        }
+        """
+
+        response_pptp_read = """
+        {
+            "enabled": "off",
+            "unencrypted_access": "on",
+            "samba_access": "on",
+            "netbios_pass": "on",
+            "remoteip": "10.0.0.11-20"
+        }
+        """
+
+        respone_vpnconn_openvpn = """[
+            {"username": "admin", "remote_ip": "192.168.0.200", "ipaddr": "10.0.0.11",
+             "extra": "7450", "vpntype": "openvpn", "key": "7450"},
+            {"username": "admin", "remote_ip": "192.168.0.200", "ipaddr": "10.0.0.11",
+             "extra": "7450", "vpntype": "openvpn", "key": "7450"}
+        ]"""
+
+        respone_vpnconn_pptpvpn = """[
+            {"username": "admin", "remote_ip": "192.168.0.200", "ipaddr": "10.0.0.11",
+             "extra": "7450", "vpntype": "pptp", "key": "7450"},
+            {"username": "admin", "remote_ip": "192.168.0.200", "ipaddr": "10.0.0.11",
+             "extra": "7450", "vpntype": "pptp", "key": "7450"},
+            {"username": "admin", "remote_ip": "192.168.0.200", "ipaddr": "10.0.0.11",
+             "extra": "7450", "vpntype": "pptp", "key": "7450"}
+        ]"""
+
+        class TPLinkRouterTest(TplinkC1200Router):
+            def request(
+                self,
+                path: str,
+                data: str,
+                ignore_response: bool = False,
+                ignore_errors: bool = False,
+            ) -> dict | None:
+                if path == "/admin/openvpn?form=config&operation=read":
+                    return loads(response_openvpn_read)
+                if path == "/admin/pptpd?form=config&operation=read":
+                    return loads(response_pptp_read)
+                if path == "/admin/vpnconn?form=config&operation=list&vpntype=openvpn":
+                    return loads(respone_vpnconn_openvpn)
+                if path == "/admin/vpnconn?form=config&operation=list&vpntype=pptp":
+                    return loads(respone_vpnconn_pptpvpn)
+                raise ClientException()
+
+        client = TPLinkRouterTest("", "")
+
+        vpn_status = client.get_vpn_status()
+        self.assertTrue(vpn_status.openvpn_enable)
+        self.assertFalse(vpn_status.pptpvpn_enable)
+        self.assertEqual(vpn_status.openvpn_clients_total, 2)
+        self.assertEqual(vpn_status.pptpvpn_clients_total, 3)
+
+    def test_set_vpn(self) -> None:
+        response_openvpn_read = """
+        {
+            "enabled": "on",
+            "proto": "udp",
+            "access": "home",
+            "cert_exist": true,
+            "mask": "255.255.255.0",
+            "port": "1194",
+            "serverip": "10.8.0.0"
+        }
+        """
+
+        class TPLinkRouterTest(TplinkC1200Router):
+            def request(
+                self,
+                path: str,
+                data: str,
+                ignore_response: bool = False,
+                ignore_errors: bool = False,
+            ) -> dict | None:
+                if path == "/admin/openvpn?form=config&operation=read":
+                    return loads(response_openvpn_read)
+                self.captured_path = path
+
+        client = TPLinkRouterTest("", "")
+        client.set_vpn(VPN.OPEN_VPN, True)
+
+        expected_path = (
+            "/admin/openvpn?form=config&operation=write&enabled=on"
+            "&proto=udp&access=home&cert_exist=True"
+            "&mask=255.255.255.0&port=1194&serverip=10.8.0.0"
+        )
+        self.assertEqual(client.captured_path, expected_path)
+
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

tplinkrouterc6u/client/c1200.py

@@ -1,8 +1,11 @@
 from re import search
 from requests import post, Response
+from urllib.parse import urlencode
 from tplinkrouterc6u.common.encryption import EncryptionWrapper
 from tplinkrouterc6u.common.exception import ClientException, AuthorizeError
 from tplinkrouterc6u.client.c5400x import TplinkC5400XRouter
+from tplinkrouterc6u.common.dataclass import VPNStatus
+from tplinkrouterc6u.common.package_enum import VPN
 
 
 class TplinkC1200Router(TplinkC5400XRouter):
@@ -100,3 +103,36 @@ class TplinkC1200Router(TplinkC5400XRouter):
     @staticmethod
     def _get_login_data(crypted_pwd: str) -> str:
         return 'operation=login&password={}'.format(crypted_pwd)
+
+    def get_vpn_status(self) -> VPNStatus:
+        status = VPNStatus()
+
+        values = [
+            self.request("/admin/openvpn?form=config&operation=read", "operation=read"),
+            self.request("/admin/pptpd?form=config&operation=read", "operation=read"),
+            self.request("/admin/vpnconn?form=config&operation=list&vpntype=openvpn",
+                         "operation=list&operation=list&vpntype=openvpn"),
+            self.request("/admin/vpnconn?form=config&operation=list&vpntype=pptp",
+                         "operation=list&operation=list&vpntype=pptp"),
+        ]
+
+        status.openvpn_enable = values[0]['enabled'] == 'on'
+        status.pptpvpn_enable = values[1]['enabled'] == 'on'
+
+        if isinstance(values[2], list):
+            status.openvpn_clients_total = len(values[2])
+            status.pptpvpn_clients_total = len(values[3])
+        else:
+            status.openvpn_clients_total = 0
+            status.pptpvpn_clients_total = 0
+
+        return status
+
+    def set_vpn(self, vpn: VPN, enable: bool) -> None:
+        path = "/admin/{}?form=config&operation=read".format(vpn.lowercase)
+        current_config = self.request(path, "operation=read")
+        current_config['enabled'] = "on" if enable else "off"
+        data = urlencode(current_config)
+        data = "&operation=write&{}".format(data)
+        path = "/admin/{}?form=config{}".format(vpn.lowercase, data)
+        self.request(path, data)

tplinkrouterc6u/common/package_enum.py

@@ -49,3 +49,8 @@ class Connection(Enum):
 class VPN(Enum):
     OPEN_VPN = 'OPENVPN'
     PPTP_VPN = 'PPTPVPN'
+
+    @property
+    def lowercase(self) -> str:
+        """Returns the lowercase version of the enum value. Needed for the c1200 router."""
+        return self.value.lower()

{tplinkrouterc6u-5.3.0.dist-info → tplinkrouterc6u-5.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tplinkrouterc6u
-Version: 5.3.0
+Version: 5.4.0
 Summary: TP-Link Router API
 Home-page: https://github.com/AlexandrErohin/TP-Link-Archer-C6U
 Author: Alex Erohin
@@ -303,7 +303,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - Archer C7 (v4.0, v5.0)
 - Archer C5400X V1
 - Archer GX90 v1.0
-- Archer MR200 (v5, v5.3)
+- Archer MR200 (v5, v5.3, v6.0)
 - Archer MR550 v1
 - Archer MR600 (v1, v2, v3)
 - Archer VR600 v3
@@ -328,6 +328,7 @@ or you have TP-link C5400X or similar router you need to get web encrypted passw
 - TL-MR6500v
 - TL-XDR3010 V2
 - TL-WA3001 v1.0
+- NX510v v1.0
 
 ### Not fully tested Hardware Versions
 - AD7200 V2

{tplinkrouterc6u-5.3.0.dist-info → tplinkrouterc6u-5.4.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 test/__init__.py,sha256=McQmUjeN3AwmwdS6QNfwGXXE77OKoPK852I2BM9XsrU,210
-test/test_client_c1200.py,sha256=O6NK9uXIEb_vks6lI3g7j6q8TYJ9MSDFYzGA_wOBhOA,4620
+test/test_client_c1200.py,sha256=4RdwMEwTGWLOxOVTuPikifXDcUJFQ13DuyWGm2Aevrk,8811
 test/test_client_c6u.py,sha256=qC0PNE-Hz3d8PYIGej4j_M4cLDqffnPiXu_ff7Ft29M,30709
 test/test_client_deco.py,sha256=ur4u-pWB-6WaYW6PSpK9OvCg3rfo2x06V5Cf_eE2UYU,30447
 test/test_client_ex.py,sha256=YGY3auCiZTM91640LHmsL6r2-xcK5n5cB_CpvD83GeI,20429
@@ -9,7 +9,7 @@ tplinkrouterc6u/__init__.py,sha256=bLlCkiL9ycyRVG7VqPOJWPcoPmUfMkdTcUKFYKNP8QI,9
 tplinkrouterc6u/client_abstract.py,sha256=OgftTH6bELzhFWom0MOX4EJe3RNS003ezpHyyRnh2tQ,1328
 tplinkrouterc6u/provider.py,sha256=SsyGu_2SZ-a46ADl9aw_0wx0lgbsJhS6wnwUzb_1qGg,1900
 tplinkrouterc6u/client/__init__.py,sha256=KBy3fmtA9wgyFrb0Urh2x4CkKtWVnESdp-vxmuOvq0k,27
-tplinkrouterc6u/client/c1200.py,sha256=4XEYidEGmVIJk0YQLvmTnd0Gqa7glH2gUWvjreHpWrk,3178
+tplinkrouterc6u/client/c1200.py,sha256=_nY_pJ-wPWODAaes9kHPdVcM6YM54f1E54CfdoFHqbE,4771
 tplinkrouterc6u/client/c5400x.py,sha256=9E0omBSbWY_ljrs5MTCMu5brmrLtzsDB5O62Db8lP8Q,4329
 tplinkrouterc6u/client/c6u.py,sha256=8n3nMW20k3SEXamCYzq7-mzBM6wyn5Txl6XxzjHEa6c,17411
 tplinkrouterc6u/client/c6v4.py,sha256=-IF7SqTZx56lRAVmiyxK9VKkrmD7srQSJWFvn2Z0DII,1489
@@ -22,9 +22,9 @@ tplinkrouterc6u/common/dataclass.py,sha256=__u8I8URLk_AdIEN4Jd8Pswh4ujURlJxw8Yun
 tplinkrouterc6u/common/encryption.py,sha256=4HelTxzN6esMfDZRBt3m8bwB9Nj_biKijnCnrGWPWKg,6228
 tplinkrouterc6u/common/exception.py,sha256=_0G8ZvW5__CsGifHrsZeULdl8c6EUD071sDCQsQgrHY,140
 tplinkrouterc6u/common/helper.py,sha256=phcPUdpY7lJVWF8Ih4KHNdsdem2ed6qFSDXuEAtAgug,334
-tplinkrouterc6u/common/package_enum.py,sha256=py31wF7SntZ0D_o0PS7az29wtsWdp0r0uE7QMmiWigY,1451
-tplinkrouterc6u-5.3.0.dist-info/LICENSE,sha256=YF6QR6Vjxcg5b_sYIyqkME7FZYau5TfEUGTG-0JeRK0,35129
-tplinkrouterc6u-5.3.0.dist-info/METADATA,sha256=KT2VlcenWtGibT_nhekDi8QW7yDPN9j0pZ5DOm32Q2w,14935
-tplinkrouterc6u-5.3.0.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
-tplinkrouterc6u-5.3.0.dist-info/top_level.txt,sha256=1iSCCIueqgEkrTxtQ-jiHe99jAB10zqrVdBcwvNfe_M,21
-tplinkrouterc6u-5.3.0.dist-info/RECORD,,
+tplinkrouterc6u/common/package_enum.py,sha256=4ykL_2Pw0nDEIH_qR9UJlFF6stTgSfhPz32r8KT-sh8,1624
+tplinkrouterc6u-5.4.0.dist-info/LICENSE,sha256=YF6QR6Vjxcg5b_sYIyqkME7FZYau5TfEUGTG-0JeRK0,35129
+tplinkrouterc6u-5.4.0.dist-info/METADATA,sha256=xIApxXPRLkY6oFNFMxg6vv6Tt-qLn23EbQyIfVQ-Nyc,14955
+tplinkrouterc6u-5.4.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+tplinkrouterc6u-5.4.0.dist-info/top_level.txt,sha256=1iSCCIueqgEkrTxtQ-jiHe99jAB10zqrVdBcwvNfe_M,21
+tplinkrouterc6u-5.4.0.dist-info/RECORD,,

{tplinkrouterc6u-5.3.0.dist-info → tplinkrouterc6u-5.4.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.5.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any