emdee/toxygen_wrapper
1
0
Fork 0
Code Issues Pull Requests Actions Projects Wiki Activity

minor update

Browse Source
This commit is contained in:
emdee 2022-09-25 07:21:16 +00:00
parent c8e0adcb3e
commit 403f5e7468
6 changed files with 58 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,12 +1,12 @@
# toxygen_wrapper # toxygen_wrapper
ctypes wrapping of [Tox](https://tox.chat/) libtoxcore ctypes wrapping of [Tox](https://tox.chat/) libtoxcore
<https://github.com/TokTok/c-toxcore> <https://github.com/TokTok/c-toxcore> into Python.
into Python. Taken from the wrapper directory of the now abandoned Taken from the wrapper directory of the now abandoned
<https://github.com/toxygen-project/toxygen> `next_gen` branch <https://github.com/toxygen-project/toxygen> `next_gen` branch
by Ingvar. by Ingvar.
The basics of NGC groups are supported. The basics of NGC groups are supported, as well as AV and toxencryptsave.
## Install ## Install
@ -22,7 +22,7 @@ No prerequisites in Python3.
There are a number of other wrappings into Python of Tox core. There are a number of other wrappings into Python of Tox core.
This one uses CTYPES which has its merits - there is no need to This one uses CTYPES which has its merits - there is no need to
recompile anything as with Cython - change the Python file and it's done. recompile anything as with Cython - change the Python file and it's done.
CTYPES code can be brittle, segfaulting if you got things wrong, CTYPES code can be brittle, segfaulting if you've got things wrong,
but if your wrapping is right, it is very efficient and easy to work on. but if your wrapping is right, it is very efficient and easy to work on.
Others include: Others include:
@ -30,11 +30,12 @@ Others include:
* <https://github.com/TokTok/py-toxcore-c> Cython bindings. * <https://github.com/TokTok/py-toxcore-c> Cython bindings.
Incomplete and not really actively supported. Maybe it will get Incomplete and not really actively supported. Maybe it will get
worked on in the future, but TokTok seems to be working on worked on in the future, but TokTok seems to be working on
java, rust, go, etc. bindings instead. java, rust, scalla, go, etc. bindings instead.
No support for NGC groups or toxencryptsave.
* <https://github.com/oxij/PyTox> * <https://github.com/oxij/PyTox>
forked from https://github.com/aitjcize/PyTox forked from https://github.com/aitjcize/PyTox
by Wei-Ning Huang <aitjcize@gmail.com>. by Wei-Ning Huang <aitjcize@gmail.com>.
Abandonned. Hardcore C wrapping which is not easy to keep up to date. Hardcore C wrapping which is not easy to keep up to date.
No support for NGC or toxencryptsave. Abandonned.
This was the basis for the TokTok/py-toxcore-c code until recently.

5
wrapper/__init__.py Normal file
View File

@ -0,0 +1,5 @@
# -*- mode: python; indent-tabs-mode: nil; py-indent-offset: 4; coding: utf-8 -*-
# You need a libs directory beside this directory
# and you need to link your libtoxcore.so and libtoxav.so
# and libtoxencryptsave.so into ../libs/
# Link all 3 to libtoxcore.so if you have only libtoxcore.so

1
wrapper/libtox.py
View File

@ -1,4 +1,5 @@
# -*- mode: python; indent-tabs-mode: nil; py-indent-offset: 4; coding: utf-8 -*- # -*- mode: python; indent-tabs-mode: nil; py-indent-offset: 4; coding: utf-8 -*-
import os import os
import sys import sys
from ctypes import CDLL from ctypes import CDLL

62
wrapper/tox.py
View File

@ -1,14 +1,16 @@
# -*- mode: python; indent-tabs-mode: nil; py-indent-offset: 4; coding: utf-8 -*- # -*- mode: python; indent-tabs-mode: nil; py-indent-offset: 4; coding: utf-8 -*-
from ctypes import * from ctypes import *
from datetime import datetime from datetime import datetime
import logging
from wrapper.toxcore_enums_and_consts import * try:
from wrapper.toxav import ToxAV from wrapper.toxcore_enums_and_consts import *
from wrapper.libtox import LibToxCore from wrapper.toxav import ToxAV
from wrapper.libtox import LibToxCore
except:
from toxcore_enums_and_consts import *
from toxav import ToxAV
from libtox import LibToxCore
global LOG
LOG = logging.getLogger('app.'+__name__)
def LOG_ERROR(a): print('EROR> '+a) def LOG_ERROR(a): print('EROR> '+a)
def LOG_WARN(a): print('WARN> '+a) def LOG_WARN(a): print('WARN> '+a)
def LOG_INFO(a): print('INFO> '+a) def LOG_INFO(a): print('INFO> '+a)
@ -163,6 +165,7 @@ class Tox:
def kill(self): def kill(self):
if hasattr(self, 'AV'): del self.AV if hasattr(self, 'AV'): del self.AV
LOG_DEBUG(f"tox_kill")
try: try:
Tox.libtoxcore.tox_kill(self._tox_pointer) Tox.libtoxcore.tox_kill(self._tox_pointer)
except Exception as e: except Exception as e:
@ -270,7 +273,7 @@ class Tox:
:return: True on success. :return: True on success.
""" """
# LOG_DEBUG(f"tox_bootstrap") LOG_DEBUG(f"tox_bootstrap={address}")
address = bytes(address, 'utf-8') address = bytes(address, 'utf-8')
tox_err_bootstrap = c_int() tox_err_bootstrap = c_int()
try: try:
@ -340,9 +343,9 @@ class Tox:
""" """
iRet = Tox.libtoxcore.tox_self_get_connection_status(self._tox_pointer) iRet = Tox.libtoxcore.tox_self_get_connection_status(self._tox_pointer)
if iRet > 2: if iRet > 2:
# LOG_ERROR(f"self_get_connection_status {iRet} > 2") LOG_ERROR(f"self_get_connection_status {iRet} > 2")
# return 0 return 0
pass LOG_TRACE(f"self_get_connection_status {iRet}")
return iRet return iRet
def callback_self_connection_status(self, callback): def callback_self_connection_status(self, callback):
@ -363,7 +366,6 @@ class Tox:
""" """
if callback is None: if callback is None:
LOG_DEBUG(f"tox_callback_self_connection_status")
Tox.libtoxcore.tox_callback_self_connection_status(self._tox_pointer, Tox.libtoxcore.tox_callback_self_connection_status(self._tox_pointer,
POINTER(None)()) POINTER(None)())
self.self_connection_status_cb = None self.self_connection_status_cb = None
@ -391,13 +393,14 @@ class Tox:
if user_data is not None: if user_data is not None:
user_data = c_char_p(user_data) user_data = c_char_p(user_data)
try: try:
LOG_TRACE(f"tox_iterate")
Tox.libtoxcore.tox_iterate(self._tox_pointer, user_data) Tox.libtoxcore.tox_iterate(self._tox_pointer, user_data)
except Exception as e: except Exception as e:
# Fatal Python error: Segmentation fault # Fatal Python error: Segmentation fault
LOG_ERROR(f"iterate {e!s}") LOG_ERROR(f"iterate {e!s}")
else: else:
LOG_TRACE(f"tox_iterate") LOG_TRACE(f"iterate")
# ----------------------------------------------------------------------------------------------------------------- # -----------------------------------------------------------------------------------------------------------------
# Internal client information (Tox address/id) # Internal client information (Tox address/id)
# ----------------------------------------------------------------------------------------------------------------- # -----------------------------------------------------------------------------------------------------------------
@ -1223,7 +1226,6 @@ class Tox:
pointer (c_void_p) to user_data pointer (c_void_p) to user_data
:param user_data: pointer (c_void_p) to user data :param user_data: pointer (c_void_p) to user data
""" """
LOG_DEBUG(f"tox_callback_friend_request")
if callback is None: if callback is None:
Tox.libtoxcore.tox_callback_friend_request(self._tox_pointer, Tox.libtoxcore.tox_callback_friend_request(self._tox_pointer,
POINTER(None)()) POINTER(None)())
@ -2169,12 +2171,12 @@ class Tox:
error = c_int() error = c_int()
size = self.group_peer_get_name_size(group_number, peer_id) size = self.group_peer_get_name_size(group_number, peer_id)
name = create_string_buffer(size) name = create_string_buffer(size)
LOG_DEBUG(f"tox_group_peer_get_name")
result = Tox.libtoxcore.tox_group_peer_get_name(self._tox_pointer, group_number, peer_id, name, byref(error)) result = Tox.libtoxcore.tox_group_peer_get_name(self._tox_pointer, group_number, peer_id, name, byref(error))
if error.value: if error.value:
LOG_ERROR(f" {error.value}") LOG_ERROR(f" {error.value}")
raise RuntimeError(f"tox_group_peer_get_name {error.value}") raise RuntimeError(f"tox_group_peer_get_name {error.value}")
sRet = str(name[:], 'utf-8', errors='ignore') sRet = str(name[:], 'utf-8', errors='ignore')
LOG_DEBUG(f"tox_group_peer_get_name {sRet}")
return sRet return sRet
def group_peer_get_status(self, group_number, peer_id): def group_peer_get_status(self, group_number, peer_id):
@ -2312,6 +2314,7 @@ class Tox:
error = c_int() error = c_int()
try: try:
LOG_DEBUG(f"tox_group_get_topic_size")
result = Tox.libtoxcore.tox_group_get_topic_size(self._tox_pointer, group_number, byref(error)) result = Tox.libtoxcore.tox_group_get_topic_size(self._tox_pointer, group_number, byref(error))
except Exception as e: except Exception as e:
LOG_WARN(f" Exception {e}") LOG_WARN(f" Exception {e}")
@ -2349,6 +2352,7 @@ class Tox:
return value is unspecified. return value is unspecified.
""" """
error = c_int() error = c_int()
LOG_DEBUG(f"tox_group_get_name_size")
result = Tox.libtoxcore.tox_group_get_name_size(self._tox_pointer, group_number, byref(error)) result = Tox.libtoxcore.tox_group_get_name_size(self._tox_pointer, group_number, byref(error))
if error.value: if error.value:
LOG_ERROR(f" {error.value}") LOG_ERROR(f" {error.value}")
@ -2383,6 +2387,7 @@ class Tox:
error = c_int() error = c_int()
buff = create_string_buffer(TOX_GROUP_CHAT_ID_SIZE) buff = create_string_buffer(TOX_GROUP_CHAT_ID_SIZE)
LOG_DEBUG(f"tox_group_get_chat_id")
result = Tox.libtoxcore.tox_group_get_chat_id(self._tox_pointer, result = Tox.libtoxcore.tox_group_get_chat_id(self._tox_pointer,
group_number, group_number,
buff, byref(error)) buff, byref(error))
@ -2647,7 +2652,7 @@ class Tox:
error = c_int() error = c_int()
# uint32_t message_id = 0; # uint32_t message_id = 0;
message_id = c_int() # or POINTER(None)() message_id = c_int() # or POINTER(None)()
LOG_DEBUG(f"tox_group_send_message") LOG_DEBUG(f"tox_group_send_message")
# bool tox_group_send_message(const Tox *tox, uint32_t group_number, Tox_Message_Type type, const uint8_t *message, size_t length, uint32_t *message_id, Tox_Err_Group_Send_Message *error) # bool tox_group_send_message(const Tox *tox, uint32_t group_number, Tox_Message_Type type, const uint8_t *message, size_t length, uint32_t *message_id, Tox_Err_Group_Send_Message *error)
result = Tox.libtoxcore.tox_group_send_message(self._tox_pointer, result = Tox.libtoxcore.tox_group_send_message(self._tox_pointer,
@ -2774,7 +2779,7 @@ class Tox:
f.restype = c_uint32 f.restype = c_uint32
nick = bytes(nick, 'utf-8') nick = bytes(nick, 'utf-8')
invite_data = bytes(invite_data, 'utf-8') invite_data = bytes(invite_data, 'utf-8')
if False: # API change if False: # API change
peer_info = self.group_self_peer_info_new() peer_info = self.group_self_peer_info_new()
peer_info.contents.nick = c_char_p(nick) peer_info.contents.nick = c_char_p(nick)
@ -2833,7 +2838,7 @@ class Tox:
Tox.libtoxcore.tox_callback_group_peer_join(self._tox_pointer, POINTER(None)()) Tox.libtoxcore.tox_callback_group_peer_join(self._tox_pointer, POINTER(None)())
self.group_peer_join_cb = None self.group_peer_join_cb = None
return return
LOG_DEBUG(f"tox_callback_group_peer_join") LOG_DEBUG(f"tox_callback_group_peer_join")
c_callback = CFUNCTYPE(None, c_void_p, c_uint32, c_uint32, c_void_p) c_callback = CFUNCTYPE(None, c_void_p, c_uint32, c_uint32, c_void_p)
self.group_peer_join_cb = c_callback(callback) self.group_peer_join_cb = c_callback(callback)
@ -2853,7 +2858,8 @@ class Tox:
Tox.libtoxcore.tox_callback_group_peer_exit(self._tox_pointer, POINTER(None)()) Tox.libtoxcore.tox_callback_group_peer_exit(self._tox_pointer, POINTER(None)())
self.group_peer_exit_cb = None self.group_peer_exit_cb = None
return return
LOG_DEBUG(f"tox_callback_group_peer_exit")
c_callback = CFUNCTYPE(None, c_void_p, c_callback = CFUNCTYPE(None, c_void_p,
c_uint32, # group_number, c_uint32, # group_number,
c_uint32, # peer_id, c_uint32, # peer_id,
@ -2863,14 +2869,15 @@ class Tox:
c_char_p, # message c_char_p, # message
c_size_t, # message length c_size_t, # message length
c_void_p) # user_data c_void_p) # user_data
self.group_peer_exit_cb = c_callback(callback)
try: try:
self.group_peer_exit_cb = c_callback(callback) LOG_DEBUG(f"tox_callback_group_peer_exit")
Tox.libtoxcore.tox_callback_group_peer_exit(self._tox_pointer, self.group_peer_exit_cb) Tox.libtoxcore.tox_callback_group_peer_exit(self._tox_pointer, self.group_peer_exit_cb)
except Exception as e: except Exception as e:
LOG_ERROR(f"tox_callback_group_peer_exit {e}") # req LOG_ERROR(f"tox_callback_group_peer_exit {e}") # req
else: else:
LOG_DEBUG(f"tox_callback_group_peer_exit") LOG_DEBUG(f"tox_callback_group_peer_exit")
def callback_group_self_join(self, callback, user_data): def callback_group_self_join(self, callback, user_data):
""" """
Set the callback for the `group_self_join` event. Pass NULL to unset. Set the callback for the `group_self_join` event. Pass NULL to unset.
@ -2887,16 +2894,18 @@ class Tox:
Tox.libtoxcore.tox_callback_group_self_join(self._tox_pointer, POINTER(None)()) Tox.libtoxcore.tox_callback_group_self_join(self._tox_pointer, POINTER(None)())
self.group_self_join_cb = None self.group_self_join_cb = None
return return
LOG_DEBUG(f"tox_callback_group_self_join")
c_callback = CFUNCTYPE(None, c_void_p, c_uint32, c_void_p) c_callback = CFUNCTYPE(None, c_void_p, c_uint32, c_void_p)
self.group_self_join_cb = c_callback(callback) self.group_self_join_cb = c_callback(callback)
try: try:
LOG_DEBUG(f"tox_callback_group_self_join")
Tox.libtoxcore.tox_callback_group_self_join(self._tox_pointer, self.group_self_join_cb) Tox.libtoxcore.tox_callback_group_self_join(self._tox_pointer, self.group_self_join_cb)
except Exception as e: except Exception as e:
LOG_ERROR(f"tox_callback_group_self_join {e}") # req LOG_ERROR(f"tox_callback_group_self_join {e}") # req
else: else:
LOG_DEBUG(f"tox_callback_group_self_join") LOG_DEBUG(f"tox_callback_group_self_join")
def callback_group_join_fail(self, callback, user_data): def callback_group_join_fail(self, callback, user_data):
""" """
Set the callback for the `group_join_fail` event. Pass NULL to unset. Set the callback for the `group_join_fail` event. Pass NULL to unset.
@ -2908,7 +2917,7 @@ class Tox:
Tox.libtoxcore.tox_callback_group_join_fail(self._tox_pointer, POINTER(None)()) Tox.libtoxcore.tox_callback_group_join_fail(self._tox_pointer, POINTER(None)())
self.group_join_fail_cb = None self.group_join_fail_cb = None
return return
LOG_DEBUG(f"tox_callback_group_join_fail") LOG_DEBUG(f"tox_callback_group_join_fail")
c_callback = CFUNCTYPE(None, c_void_p, c_uint32, c_int, c_uint32, c_void_p) c_callback = CFUNCTYPE(None, c_void_p, c_uint32, c_int, c_uint32, c_void_p)
self.group_join_fail_cb = c_callback(callback) self.group_join_fail_cb = c_callback(callback)
@ -3036,12 +3045,13 @@ class Tox:
c_callback = CFUNCTYPE(None, c_void_p, c_uint32, c_uint32, c_uint32, c_int, c_void_p) c_callback = CFUNCTYPE(None, c_void_p, c_uint32, c_uint32, c_uint32, c_int, c_void_p)
self.group_moderation_cb = c_callback(callback) self.group_moderation_cb = c_callback(callback)
try: try:
LOG_DEBUG(f"tox_callback_group_moderation")
Tox.libtoxcore.tox_callback_group_moderation(self._tox_pointer, self.group_moderation_cb) Tox.libtoxcore.tox_callback_group_moderation(self._tox_pointer, self.group_moderation_cb)
except Exception as e: except Exception as e:
LOG_ERROR(f"tox_callback_group_moderation {e}") # req LOG_ERROR(f"tox_callback_group_moderation {e}") # req
else: else:
LOG_DEBUG(f"tox_callback_group_moderation") LOG_DEBUG(f"tox_callback_group_moderation")
def group_toggle_set_ignore(self, group_number, peer_id, ignore): def group_toggle_set_ignore(self, group_number, peer_id, ignore):
""" """
Ignore or unignore a peer. Ignore or unignore a peer.

2
wrapper/toxav.py
View File

@ -1,13 +1,11 @@
# -*- mode: python; indent-tabs-mode: nil; py-indent-offset: 4; coding: utf-8 -*- # -*- mode: python; indent-tabs-mode: nil; py-indent-offset: 4; coding: utf-8 -*-
import logging
from ctypes import c_int, POINTER, c_void_p, byref, ArgumentError, c_uint32, CFUNCTYPE, c_size_t, c_uint8, c_uint16 from ctypes import c_int, POINTER, c_void_p, byref, ArgumentError, c_uint32, CFUNCTYPE, c_size_t, c_uint8, c_uint16
from ctypes import c_char_p, c_int32, c_bool, cast from ctypes import c_char_p, c_int32, c_bool, cast
from wrapper.libtox import LibToxAV from wrapper.libtox import LibToxAV
from wrapper.toxav_enums import * from wrapper.toxav_enums import *
LOG = logging.getLogger('app.'+__name__)
def LOG_ERROR(a): print('EROR> '+a) def LOG_ERROR(a): print('EROR> '+a)
def LOG_WARN(a): print('WARN> '+a) def LOG_WARN(a): print('WARN> '+a)
def LOG_INFO(a): print('INFO> '+a) def LOG_INFO(a): print('INFO> '+a)

9
wrapper/toxencryptsave.py
View File

@ -1,8 +1,13 @@
# -*- mode: python; indent-tabs-mode: nil; py-indent-offset: 4; coding: utf-8 -*- # -*- mode: python; indent-tabs-mode: nil; py-indent-offset: 4; coding: utf-8 -*-
from ctypes import c_size_t, create_string_buffer, byref, c_int, ArgumentError, c_char_p, c_bool from ctypes import c_size_t, create_string_buffer, byref, c_int, ArgumentError, c_char_p, c_bool
from wrapper import libtox try:
from wrapper.toxencryptsave_enums_and_consts import * from wrapper import libtox
from wrapper.toxencryptsave_enums_and_consts import *
except:
import libtox
from toxencryptsave_enums_and_consts import *
class ToxEncryptSave: class ToxEncryptSave: