214 lines
7.0 KiB
Python
214 lines
7.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# network.py - I/O with WeeChat/relay
|
|
#
|
|
# Copyright (C) 2011-2021 Sébastien Helleu <flashcode@flashtux.org>
|
|
#
|
|
# This file is part of QWeeChat, a Qt remote GUI for WeeChat.
|
|
#
|
|
# QWeeChat is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# QWeeChat is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with QWeeChat. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
|
|
"""I/O with WeeChat/relay."""
|
|
|
|
import struct
|
|
|
|
from PySide6 import QtCore, QtNetwork
|
|
|
|
from qweechat import config
|
|
|
|
|
|
_PROTO_INIT_CMD = [
|
|
# initialize with the password
|
|
'init password=%(password)s',
|
|
]
|
|
|
|
_PROTO_SYNC_CMDS = [
|
|
# get buffers
|
|
'(listbuffers) hdata buffer:gui_buffers(*) number,full_name,short_name,'
|
|
'type,nicklist,title,local_variables',
|
|
# get lines
|
|
'(listlines) hdata buffer:gui_buffers(*)/own_lines/last_line(-%(lines)d)/'
|
|
'data date,displayed,prefix,message',
|
|
# get nicklist for all buffers
|
|
'(nicklist) nicklist',
|
|
# enable synchronization
|
|
'sync',
|
|
]
|
|
|
|
STATUS_DISCONNECTED = 'disconnected'
|
|
STATUS_CONNECTING = 'connecting'
|
|
STATUS_CONNECTED = 'connected'
|
|
|
|
NETWORK_STATUS = {
|
|
'disconnected': {
|
|
'label': 'Disconnected',
|
|
'color': '#aa0000',
|
|
'icon': 'dialog-close.png',
|
|
},
|
|
'connecting': {
|
|
'label': 'Connecting…',
|
|
'color': '#ff7f00',
|
|
'icon': 'dialog-warning.png',
|
|
},
|
|
'connected': {
|
|
'label': 'Connected',
|
|
'color': 'green',
|
|
'icon': 'dialog-ok-apply.png',
|
|
},
|
|
}
|
|
|
|
class Network(QtCore.QObject):
|
|
"""I/O with WeeChat/relay."""
|
|
|
|
statusChanged = QtCore.Signal(str, str)
|
|
messageFromWeechat = QtCore.Signal(QtCore.QByteArray)
|
|
|
|
def __init__(self, *args):
|
|
super().__init__(*args)
|
|
self._server = None
|
|
self._port = None
|
|
self._ssl = None
|
|
self._password = None
|
|
self._lines = config.CONFIG_DEFAULT_RELAY_LINES
|
|
self._buffer = QtCore.QByteArray()
|
|
self._socket = QtNetwork.QSslSocket()
|
|
self._socket.connected.connect(self._socket_connected)
|
|
self._socket.readyRead.connect(self._socket_read)
|
|
self._socket.disconnected.connect(self._socket_disconnected)
|
|
|
|
def _build_init_command(self):
|
|
"""Build the init command to send to WeeChat."""
|
|
cmd = '\n'.join(_PROTO_INIT_CMD) + '\n'
|
|
return cmd % {'password': self._password}
|
|
|
|
def _build_sync_command(self):
|
|
"""Build the sync commands to send to WeeChat."""
|
|
cmd = '\n'.join(_PROTO_SYNC_CMDS) + '\n'
|
|
return cmd % {'lines': self._lines}
|
|
|
|
def _socket_connected(self):
|
|
"""Slot: socket connected."""
|
|
self.statusChanged.emit(STATUS_CONNECTED, None)
|
|
if self._password:
|
|
cmd = self._build_init_command() + self._build_sync_command()
|
|
self.send_to_weechat(cmd)
|
|
|
|
def _socket_read(self):
|
|
"""Slot: data available on socket."""
|
|
data = self._socket.readAll()
|
|
self._buffer.append(data)
|
|
while len(self._buffer) >= 4:
|
|
remainder = None
|
|
length = struct.unpack('>i', self._buffer[0:4].data())[0]
|
|
if len(self._buffer) < length:
|
|
# partial message, just wait for end of message
|
|
break
|
|
# more than one message?
|
|
if length < len(self._buffer):
|
|
# save beginning of another message
|
|
remainder = self._buffer[length:]
|
|
self._buffer = self._buffer[0:length]
|
|
self.messageFromWeechat.emit(self._buffer)
|
|
if not self.is_connected():
|
|
return
|
|
self._buffer.clear()
|
|
if remainder:
|
|
self._buffer.append(remainder)
|
|
|
|
def _socket_disconnected(self):
|
|
"""Slot: socket disconnected."""
|
|
self._server = None
|
|
self._port = None
|
|
self._ssl = None
|
|
self._password = ""
|
|
self.statusChanged.emit(STATUS_DISCONNECTED, None)
|
|
|
|
def is_connected(self):
|
|
"""Return True if the socket is connected, False otherwise."""
|
|
return self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState
|
|
|
|
def is_ssl(self):
|
|
"""Return True if SSL is used, False otherwise."""
|
|
return self._ssl
|
|
|
|
def connect_weechat(self, server, port, ssl, password, lines):
|
|
"""Connect to WeeChat."""
|
|
self._server = server
|
|
try:
|
|
self._port = int(port)
|
|
except ValueError:
|
|
self._port = 0
|
|
self._ssl = ssl
|
|
self._password = password
|
|
try:
|
|
self._lines = int(lines)
|
|
except ValueError:
|
|
self._lines = config.CONFIG_DEFAULT_RELAY_LINES
|
|
if self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState:
|
|
return
|
|
if self._socket.state() != QtNetwork.QAbstractSocket.UnconnectedState:
|
|
self._socket.abort()
|
|
if self._ssl:
|
|
self._socket.ignoreSslErrors()
|
|
self._socket.connectToHostEncrypted(self._server, self._port)
|
|
else:
|
|
self._socket.connectToHost(self._server, self._port)
|
|
self.statusChanged.emit(STATUS_CONNECTING, "")
|
|
|
|
def disconnect_weechat(self):
|
|
"""Disconnect from WeeChat."""
|
|
if self._socket.state() == QtNetwork.QAbstractSocket.UnconnectedState:
|
|
return
|
|
if self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState:
|
|
self.send_to_weechat('quit\n')
|
|
self._socket.waitForBytesWritten(1000)
|
|
else:
|
|
self.statusChanged.emit(STATUS_DISCONNECTED, None)
|
|
self._socket.abort()
|
|
|
|
def send_to_weechat(self, message):
|
|
"""Send a message to WeeChat."""
|
|
self._socket.write(message.encode('utf-8'))
|
|
|
|
def desync_weechat(self):
|
|
"""Desynchronize from WeeChat."""
|
|
self.send_to_weechat('desync\n')
|
|
|
|
def sync_weechat(self):
|
|
"""Synchronize with WeeChat."""
|
|
self.send_to_weechat(self._build_sync_command())
|
|
|
|
def status_label(self, status):
|
|
"""Return the label for a given status."""
|
|
return NETWORK_STATUS.get(status, {}).get('label', '')
|
|
|
|
def status_color(self, status):
|
|
"""Return the color for a given status."""
|
|
return NETWORK_STATUS.get(status, {}).get('color', 'black')
|
|
|
|
def status_icon(self, status):
|
|
"""Return the name of icon for a given status."""
|
|
return NETWORK_STATUS.get(status, {}).get('icon', '')
|
|
|
|
def get_options(self):
|
|
"""Get connection options."""
|
|
return {
|
|
'server': self._server,
|
|
'port': self._port,
|
|
'ssl': 'on' if self._ssl else 'off',
|
|
'password': self._password,
|
|
'lines': str(self._lines),
|
|
}
|