mirror of
https://github.com/HuFlungDu/pylibmeshctrl.git
synced 2026-02-20 13:42:11 +00:00
Compare commits
14 Commits
0.0.19
...
fix/raw-ev
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
564d466ff9 | ||
|
|
6919da4a42 | ||
|
|
ff120490fa | ||
|
|
d9991156f6 | ||
|
|
4fea858fbc | ||
|
|
3b4a18b379 | ||
|
|
c072d6012a | ||
|
|
0ee2e2dc94 | ||
|
|
f2d9fcd295 | ||
|
|
7456743709 | ||
|
|
07b828a150 | ||
|
|
cd7a356eb5 | ||
|
|
5ee2c8edf3 | ||
|
|
d3d5b87287 |
@@ -19,7 +19,7 @@ formats:
|
|||||||
build:
|
build:
|
||||||
os: ubuntu-22.04
|
os: ubuntu-22.04
|
||||||
tools:
|
tools:
|
||||||
python: "3.11"
|
python: "3.13"
|
||||||
|
|
||||||
python:
|
python:
|
||||||
install:
|
install:
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
Changelog
|
Changelog
|
||||||
=========
|
=========
|
||||||
|
|
||||||
Version 0.1
|
Version 1.0.0
|
||||||
===========
|
===========
|
||||||
|
|
||||||
Create
|
First release
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ Library for remotely interacting with a
|
|||||||
Installation
|
Installation
|
||||||
------------
|
------------
|
||||||
|
|
||||||
pip install meshctrl
|
pip install libmeshctrl
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
-----
|
-----
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ platforms = any
|
|||||||
# Add here all kinds of additional classifiers as defined under
|
# Add here all kinds of additional classifiers as defined under
|
||||||
# https://pypi.org/classifiers/
|
# https://pypi.org/classifiers/
|
||||||
classifiers =
|
classifiers =
|
||||||
Development Status :: 4 - Beta
|
Development Status :: 5 - Production/Stable
|
||||||
Programming Language :: Python
|
Programming Language :: Python
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ class Device(object):
|
|||||||
name (str|None): Device name as it is shown on the meshcentral server
|
name (str|None): Device name as it is shown on the meshcentral server
|
||||||
description (str|None): Device description as it is shown on the meshcentral server. Also accepted as desc.
|
description (str|None): Device description as it is shown on the meshcentral server. Also accepted as desc.
|
||||||
tags (list[str]|None): tags associated with device.
|
tags (list[str]|None): tags associated with device.
|
||||||
|
users (list[str]|None): latest known usernames which have logged in.
|
||||||
created_at (datetime.Datetime|int|None): Time at which device mas created. Also accepted as agct.
|
created_at (datetime.Datetime|int|None): Time at which device mas created. Also accepted as agct.
|
||||||
computer_name (str|None): Device name as reported from the agent. This may be different from name. Also accepted as rname.
|
computer_name (str|None): Device name as reported from the agent. This may be different from name. Also accepted as rname.
|
||||||
icon (~meshctrl.constants.Icon): Icon displayed on the website
|
icon (~meshctrl.constants.Icon): Icon displayed on the website
|
||||||
@@ -38,6 +39,7 @@ class Device(object):
|
|||||||
name (str|None): Device name as it is shown on the meshcentral server
|
name (str|None): Device name as it is shown on the meshcentral server
|
||||||
description (str|None): Device description as it is shown on the meshcentral server.
|
description (str|None): Device description as it is shown on the meshcentral server.
|
||||||
tags (list[str]): tags associated with device.
|
tags (list[str]): tags associated with device.
|
||||||
|
users (list[str]): latest known usernames which have logged in.
|
||||||
computer_name (str|None): Device name as reported from the agent. This may be different from name. Also accepted as rname.
|
computer_name (str|None): Device name as reported from the agent. This may be different from name. Also accepted as rname.
|
||||||
icon (~meshctrl.constants.Icon): Icon displayed on the website
|
icon (~meshctrl.constants.Icon): Icon displayed on the website
|
||||||
mesh (~meshctrl.mesh.Mesh|None): Mesh object under which this device exists. Is None for individual device access.
|
mesh (~meshctrl.mesh.Mesh|None): Mesh object under which this device exists. Is None for individual device access.
|
||||||
@@ -56,7 +58,7 @@ class Device(object):
|
|||||||
'''
|
'''
|
||||||
def __init__(self, nodeid, session, agent=None,
|
def __init__(self, nodeid, session, agent=None,
|
||||||
name=None, desc=None, description=None,
|
name=None, desc=None, description=None,
|
||||||
tags=None,
|
tags=None, users=None,
|
||||||
agct=None, created_at=None,
|
agct=None, created_at=None,
|
||||||
rname=None, computer_name=None, icon=constants.Icon.desktop,
|
rname=None, computer_name=None, icon=constants.Icon.desktop,
|
||||||
mesh=None, mtype=None, meshtype=None, groupname=None, meshname=None,
|
mesh=None, mtype=None, meshtype=None, groupname=None, meshname=None,
|
||||||
@@ -90,13 +92,14 @@ class Device(object):
|
|||||||
self.description = description if description is not None else desc
|
self.description = description if description is not None else desc
|
||||||
self.os_description = os_description if os_description is not None else osdesc
|
self.os_description = os_description if os_description is not None else osdesc
|
||||||
self.tags = tags if tags is not None else []
|
self.tags = tags if tags is not None else []
|
||||||
|
self.users = users if users is not None else []
|
||||||
self.details = details if details is not None else {}
|
self.details = details if details is not None else {}
|
||||||
|
|
||||||
created_at = created_at if created_at is not None else agct
|
created_at = created_at if created_at is not None else agct
|
||||||
if not isinstance(created_at, datetime.datetime) and created_at is not None:
|
if not isinstance(created_at, datetime.datetime) and created_at is not None:
|
||||||
try:
|
try:
|
||||||
created_at = datetime.datetime.fromtimestamp(created_at)
|
created_at = datetime.datetime.fromtimestamp(created_at)
|
||||||
except OSError:
|
except (OSError, ValueError):
|
||||||
# Meshcentral returns in miliseconds, while fromtimestamp, and most of python, expects the argument in seconds. Try seconds frist, then translate from ms if it fails.
|
# Meshcentral returns in miliseconds, while fromtimestamp, and most of python, expects the argument in seconds. Try seconds frist, then translate from ms if it fails.
|
||||||
# This doesn't work for really early timestamps, but I don't expect that to be a problem here.
|
# This doesn't work for really early timestamps, but I don't expect that to be a problem here.
|
||||||
created_at = datetime.datetime.fromtimestamp(created_at/1000.0)
|
created_at = datetime.datetime.fromtimestamp(created_at/1000.0)
|
||||||
@@ -106,7 +109,7 @@ class Device(object):
|
|||||||
if not isinstance(lastconnect, datetime.datetime) and lastconnect is not None:
|
if not isinstance(lastconnect, datetime.datetime) and lastconnect is not None:
|
||||||
try:
|
try:
|
||||||
lastconnect = datetime.datetime.fromtimestamp(lastconnect)
|
lastconnect = datetime.datetime.fromtimestamp(lastconnect)
|
||||||
except OSError:
|
except (OSError, ValueError):
|
||||||
# Meshcentral returns in miliseconds, while fromtimestamp, and most of python, expects the argument in seconds. Try seconds frist, then translate from ms if it fails.
|
# Meshcentral returns in miliseconds, while fromtimestamp, and most of python, expects the argument in seconds. Try seconds frist, then translate from ms if it fails.
|
||||||
# This doesn't work for really early timestamps, but I don't expect that to be a problem here.
|
# This doesn't work for really early timestamps, but I don't expect that to be a problem here.
|
||||||
lastconnect = datetime.datetime.fromtimestamp(lastconnect/1000.0)
|
lastconnect = datetime.datetime.fromtimestamp(lastconnect/1000.0)
|
||||||
@@ -340,10 +343,10 @@ class Device(object):
|
|||||||
def __str__(self):
|
def __str__(self):
|
||||||
return f"<Device: nodeid={self.nodeid} name={self.name} description={self.description} computer_name={self.computer_name} icon={self.icon} "\
|
return f"<Device: nodeid={self.nodeid} name={self.name} description={self.description} computer_name={self.computer_name} icon={self.icon} "\
|
||||||
f"mesh={self.mesh} meshtype={self.meshtype} meshname={self.meshname} domain={self.domain} host={self.host} ip={self.ip} "\
|
f"mesh={self.mesh} meshtype={self.meshtype} meshname={self.meshname} domain={self.domain} host={self.host} ip={self.ip} "\
|
||||||
f"tags={self.tags} details={self.details} created_at={self.created_at} lastaddr={self.lastaddr} lastconnect={self.lastconnect} "\
|
f"tags={self.tags} users={self.users} details={self.details} created_at={self.created_at} lastaddr={self.lastaddr} lastconnect={self.lastconnect} "\
|
||||||
f"connected={self.connected} powered_on={self.powered_on} os_description={self.os_description} links={self.links} _extra_props={self._extra_props}>"
|
f"connected={self.connected} powered_on={self.powered_on} os_description={self.os_description} links={self.links} _extra_props={self._extra_props}>"
|
||||||
def __repr__(self):
|
def __repr__(self):
|
||||||
return f"Device(nodeid={repr(self.nodeid)}, session={repr(self._session)}, name={repr(self.name)}, description={repr(self.description)}, computer_name={repr(self.computer_name)}, icon={repr(self.icon)}, "\
|
return f"Device(nodeid={repr(self.nodeid)}, session={repr(self._session)}, name={repr(self.name)}, description={repr(self.description)}, computer_name={repr(self.computer_name)}, icon={repr(self.icon)}, "\
|
||||||
f"mesh={repr(self.mesh)}, meshtype={repr(self.meshtype)}, meshname={repr(self.meshname)}, domain={repr(self.domain)}, host={repr(self.host)}, ip={repr(self.ip)}, "\
|
f"mesh={repr(self.mesh)}, meshtype={repr(self.meshtype)}, meshname={repr(self.meshname)}, domain={repr(self.domain)}, host={repr(self.host)}, ip={repr(self.ip)}, "\
|
||||||
f"tags={repr(self.tags)}, details={repr(self.details)} created_at={repr(self.created_at)} lastaddr={repr(self.lastaddr)} lastconnect={repr(self.lastconnect)} "\
|
f"tags={repr(self.tags)}, users={repr(self.users)}, details={repr(self.details)} created_at={repr(self.created_at)} lastaddr={repr(self.lastaddr)} lastconnect={repr(self.lastconnect)} "\
|
||||||
f"connected={repr(self.connected)}, powered_on={repr(self.powered_on)}, os_description={repr(self.os_description)}, links={repr(self.links)}, **{repr(self._extra_props)})"
|
f"connected={repr(self.connected)}, powered_on={repr(self.powered_on)}, os_description={repr(self.os_description)}, links={repr(self.links)}, **{repr(self._extra_props)})"
|
||||||
@@ -46,7 +46,7 @@ class Mesh(object):
|
|||||||
if not isinstance(created_at, datetime.datetime) and created_at is not None:
|
if not isinstance(created_at, datetime.datetime) and created_at is not None:
|
||||||
try:
|
try:
|
||||||
created_at = datetime.datetime.fromtimestamp(created_at)
|
created_at = datetime.datetime.fromtimestamp(created_at)
|
||||||
except OSError:
|
except (OSError, ValueError):
|
||||||
# Meshcentral returns in miliseconds, while fromtimestamp, and most of python, expects the argument in seconds. Try seconds frist, then translate from ms if it fails.
|
# Meshcentral returns in miliseconds, while fromtimestamp, and most of python, expects the argument in seconds. Try seconds frist, then translate from ms if it fails.
|
||||||
# This doesn't work for really early timestamps, but I don't expect that to be a problem here.
|
# This doesn't work for really early timestamps, but I don't expect that to be a problem here.
|
||||||
created_at = datetime.datetime.fromtimestamp(created_at/1000.0)
|
created_at = datetime.datetime.fromtimestamp(created_at/1000.0)
|
||||||
|
|||||||
@@ -533,7 +533,7 @@ class Session(object):
|
|||||||
data = await event_queue.get()
|
data = await event_queue.get()
|
||||||
yield data
|
yield data
|
||||||
finally:
|
finally:
|
||||||
self._eventer.off("server_event", _)
|
self._eventer.off("raw", _)
|
||||||
|
|
||||||
async def events(self, filter=None):
|
async def events(self, filter=None):
|
||||||
'''
|
'''
|
||||||
@@ -1824,7 +1824,7 @@ class Session(object):
|
|||||||
|
|
||||||
async def upload(self, node, source, target, unique_file_tunnel=False, timeout=None):
|
async def upload(self, node, source, target, unique_file_tunnel=False, timeout=None):
|
||||||
'''
|
'''
|
||||||
Upload a stream to a device. This creates an _File and destroys it every call. If you need to upload multiple files, use {@link Session#file_explorer} instead.
|
Upload a stream to a device.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
node (~meshctrl.device.Device|str): Device or id of device to which to upload the file. If it is a device, it must have a ~meshctrl.mesh.Mesh device associated with it (the default). If it is a string, the device will be fetched prior to tunnel creation.
|
node (~meshctrl.device.Device|str): Device or id of device to which to upload the file. If it is a device, it must have a ~meshctrl.mesh.Mesh device associated with it (the default). If it is a string, the device will be fetched prior to tunnel creation.
|
||||||
@@ -1844,7 +1844,7 @@ class Session(object):
|
|||||||
node = await self.device_info(node)
|
node = await self.device_info(node)
|
||||||
if unique_file_tunnel:
|
if unique_file_tunnel:
|
||||||
async with self.file_explorer(node) as files:
|
async with self.file_explorer(node) as files:
|
||||||
return await files.upload(source, target)
|
return await files.upload(source, target, timeout=timeout)
|
||||||
else:
|
else:
|
||||||
files = await self._cached_file_explorer(node, node.nodeid)
|
files = await self._cached_file_explorer(node, node.nodeid)
|
||||||
return await files.upload(source, target, timeout=timeout)
|
return await files.upload(source, target, timeout=timeout)
|
||||||
@@ -1898,12 +1898,12 @@ class Session(object):
|
|||||||
start = target.tell()
|
start = target.tell()
|
||||||
if unique_file_tunnel:
|
if unique_file_tunnel:
|
||||||
async with self.file_explorer(node) as files:
|
async with self.file_explorer(node) as files:
|
||||||
await files.download(source, target)
|
await files.download(source, target, skip_http_attempt=skip_http_attempt, skip_ws_attempt=skip_ws_attempt, timeout=timeout)
|
||||||
target.seek(start)
|
target.seek(start)
|
||||||
return target
|
return target
|
||||||
else:
|
else:
|
||||||
files = await self._cached_file_explorer(node, node.nodeid)
|
files = await self._cached_file_explorer(node, node.nodeid)
|
||||||
await files.download(source, target, timeout=timeout)
|
await files.download(source, target, skip_http_attempt=skip_http_attempt, skip_ws_attempt=skip_ws_attempt, timeout=timeout)
|
||||||
target.seek(start)
|
target.seek(start)
|
||||||
return target
|
return target
|
||||||
|
|
||||||
@@ -1928,7 +1928,7 @@ class Session(object):
|
|||||||
None
|
None
|
||||||
'''
|
'''
|
||||||
with open(filepath, "wb") as f:
|
with open(filepath, "wb") as f:
|
||||||
await self.download(node, source, f, unique_file_tunnel, timeout=timeout)
|
await self.download(node, source, f, skip_http_attempt=skip_http_attempt, skip_ws_attempt=skip_ws_attempt, unique_file_tunnel=unique_file_tunnel, timeout=timeout)
|
||||||
|
|
||||||
async def _cached_file_explorer(self, node, _id):
|
async def _cached_file_explorer(self, node, _id):
|
||||||
if (_id not in self._file_tunnels or not self._file_tunnels[_id].alive):
|
if (_id not in self._file_tunnels or not self._file_tunnels[_id].alive):
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ class Tunnel(object):
|
|||||||
options["ssl"] = self._session._ssl_context
|
options["ssl"] = self._session._ssl_context
|
||||||
|
|
||||||
if (len(self.node_id.split('/')) != 3):
|
if (len(self.node_id.split('/')) != 3):
|
||||||
self.node_id = f"node/{self._session._currentDomain or ""}/{self.node_id}"
|
self.node_id = f"node/{self._session._currentDomain or ''}/{self.node_id}"
|
||||||
|
|
||||||
self._tunnel_id = util._get_random_hex(6)
|
self._tunnel_id = util._get_random_hex(6)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user