forked from MycroftAI/skill-ip
-
Notifications
You must be signed in to change notification settings - Fork 1
/
__init__.py
163 lines (149 loc) · 7.34 KB
/
__init__.py
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
# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
# All trademark and other rights reserved by their respective owners
# Copyright 2008-2022 Neongecko.com Inc.
# Contributors: Daniel McKnight, Guy Daniels, Elon Gasper, Richard Leeds,
# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
# BSD-3 License
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
# 3. Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from this
# software without specific prior written permission.
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# Copyright 2017 Mycroft AI Inc.
#
# 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.
from typing import List
from ifaddr import get_adapters
from lingua_franca import load_language
from neon_utils.user_utils import get_user_prefs
from requests import get
from neon_utils.skills.neon_skill import NeonSkill
from ovos_utils import classproperty
from ovos_utils.log import LOG
from ovos_utils.process_utils import RuntimeRequirements
from ovos_bus_client.message import Message
from ovos_workshop.decorators import intent_handler
from ovos_workshop.intents import IntentBuilder
from lingua_franca.format import pronounce_number
# TODO: Add something equivalent to neon_utils.net_utils
def get_ifaces(ignore_list: List[str] = None, message: Message = None) -> dict:
"""
Build a dict with device names and their associated ip address.
@param ignore_list: list of devices to ignore. Defaults to "lo"
@param message: Message associated with request
Returns:
(dict) with device names as keys and ip addresses as value.
"""
if message and message.context.get('node_data'):
remote_ip = message.context['node_data'].get('networking',
{}).get('local_ip')
if remote_ip:
LOG.info(f"Got node IP from context: {remote_ip}")
return {"node": remote_ip}
ignore_list = ignore_list or ['lo']
res = {}
for iface in get_adapters():
# ignore "lo" (the local loopback)
if iface.ips and iface.name not in ignore_list:
for addr in iface.ips:
if addr.is_IPv4:
res[iface.nice_name] = addr.ip
break
return res
class IPSkill(NeonSkill):
@classproperty
def runtime_requirements(self):
return RuntimeRequirements(network_before_load=False,
internet_before_load=False,
gui_before_load=False,
requires_internet=True, # TODO: Refactor to handle no internet
requires_network=True,
requires_gui=False,
no_internet_fallback=True,
no_network_fallback=False,
no_gui_fallback=True)
@intent_handler(IntentBuilder("IPIntent").require("query").require("IP")
.optionally("public"))
def handle_query_ip(self, message):
"""
Handle a user request for the IP Address
:param message: Message associated with request
"""
load_language(self.lang)
if message.data.get("public"):
public = True
addr = {'public': self._get_public_ip_address(message)}
else:
public = False
addr = get_ifaces(message=message)
if len(addr) == 0: # No IP Address found
if not get_user_prefs(message)["response_mode"].get(
"limit_dialog"):
self.speak_dialog("no network connection", private=True)
else:
self.speak("I'm not connected to a network", private=True)
return
dot = self.resources.render_dialog("dot")
if len(addr) == 1: # Single IP Address to speak
iface, ip = addr.popitem()
ip_spoken = f" {dot} ".join([pronounce_number(int(part))
for part in ip.split('.')])
if public:
say_ip = self.resources.render_dialog("word_public")
else:
say_ip = self.resources.render_dialog("word_local")
self.speak_dialog("my address is",
{'ip': ip_spoken,
'pub': say_ip}, private=True)
self.gui.show_text(ip, "IP Address")
return
for iface in addr: # Speak and show all Local IP Addresses
ip = addr[iface]
self.gui.show_text(ip, iface)
ip_spoken = ip.replace(".", " " + dot + " ")
self.speak_dialog("my address on X is Y",
{'interface': iface, 'ip': ip_spoken},
private=True, wait=True)
def _get_public_ip_address(self, message: Message = None) -> str:
"""
Get the public IP address associated with the request
:returns: str public IP address
"""
public_addr = None
if message and message.context.get('node_data'):
public_addr = message.context['node_data'].get('networking',
{}).get('public_ip')
LOG.info(f"Got public IP from context: {public_addr}")
if not public_addr:
hana_url = self.config_core.get('hana', {}).get('url') or \
"https://hana.neonaibeta.com" # TODO: Update to neonaiservices after HANA 0.2 release
public_addr = get(f"{hana_url}/util/client_ip").text
LOG.info(f"Got public IP from HANA: {public_addr}")
return public_addr