]>
Commit | Line | Data |
---|---|---|
7dcf23b1 SH |
1 | # -*- coding: utf-8 -*- |
2 | # | |
e836cfb0 SH |
3 | # network.py - I/O with WeeChat/relay |
4 | # | |
8335009d | 5 | # Copyright (C) 2011-2021 Sébastien Helleu <flashcode@flashtux.org> |
7dcf23b1 SH |
6 | # |
7 | # This file is part of QWeeChat, a Qt remote GUI for WeeChat. | |
8 | # | |
9 | # QWeeChat is free software; you can redistribute it and/or modify | |
10 | # it under the terms of the GNU General Public License as published by | |
11 | # the Free Software Foundation; either version 3 of the License, or | |
12 | # (at your option) any later version. | |
13 | # | |
14 | # QWeeChat is distributed in the hope that it will be useful, | |
15 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | # GNU General Public License for more details. | |
18 | # | |
19 | # You should have received a copy of the GNU General Public License | |
20 | # along with QWeeChat. If not, see <http://www.gnu.org/licenses/>. | |
21 | # | |
22 | ||
7dcf23b1 | 23 | import struct |
8e15c19f | 24 | |
1f27a20e | 25 | from PySide6 import QtCore, QtNetwork |
8e15c19f AR |
26 | |
27 | from qweechat import config | |
28 | ||
356719e0 | 29 | |
77df9d06 SH |
30 | _PROTO_INIT_CMD = ['init password=%(password)s'] |
31 | ||
32 | _PROTO_SYNC_CMDS = [ | |
33 | '(listbuffers) hdata buffer:gui_buffers(*) number,full_name,short_name,' | |
34 | 'type,nicklist,title,local_variables', | |
35 | ||
36 | '(listlines) hdata buffer:gui_buffers(*)/own_lines/last_line(-%(lines)d)/' | |
37 | 'data date,displayed,prefix,message', | |
38 | ||
39 | '(nicklist) nicklist', | |
40 | ||
41 | 'sync', | |
42 | ||
43 | '' | |
44 | ] | |
7dcf23b1 SH |
45 | |
46 | ||
47 | class Network(QtCore.QObject): | |
48 | """I/O with WeeChat/relay.""" | |
49 | ||
8e15c19f AR |
50 | statusChanged = QtCore.Signal(str, str) |
51 | messageFromWeechat = QtCore.Signal(QtCore.QByteArray) | |
7dcf23b1 SH |
52 | |
53 | def __init__(self, *args): | |
1f27a20e | 54 | super().__init__(*args) |
7dcf23b1 SH |
55 | self.status_disconnected = 'disconnected' |
56 | self.status_connecting = 'connecting...' | |
57 | self.status_connected = 'connected' | |
58 | self._server = None | |
59 | self._port = None | |
77b25057 | 60 | self._ssl = None |
7dcf23b1 | 61 | self._password = None |
46e5dee0 | 62 | self._lines = config.CONFIG_DEFAULT_RELAY_LINES |
7dcf23b1 | 63 | self._buffer = QtCore.QByteArray() |
77b25057 | 64 | self._socket = QtNetwork.QSslSocket() |
7dcf23b1 | 65 | self._socket.connected.connect(self._socket_connected) |
1f27a20e | 66 | # self._socket.error.connect(self._socket_error) |
7dcf23b1 SH |
67 | self._socket.readyRead.connect(self._socket_read) |
68 | self._socket.disconnected.connect(self._socket_disconnected) | |
69 | ||
70 | def _socket_connected(self): | |
71 | """Slot: socket connected.""" | |
72 | self.statusChanged.emit(self.status_connected, None) | |
73 | if self._password: | |
46e5dee0 SH |
74 | self.send_to_weechat('\n'.join(_PROTO_INIT_CMD + _PROTO_SYNC_CMDS) |
75 | % {'password': str(self._password), | |
76 | 'lines': self._lines}) | |
7dcf23b1 SH |
77 | |
78 | def _socket_error(self, error): | |
79 | """Slot: socket error.""" | |
77df9d06 SH |
80 | self.statusChanged.emit( |
81 | self.status_disconnected, | |
82 | 'Failed, error: %s' % self._socket.errorString()) | |
7dcf23b1 SH |
83 | |
84 | def _socket_read(self): | |
85 | """Slot: data available on socket.""" | |
6d5927c6 SH |
86 | data = self._socket.readAll() |
87 | self._buffer.append(data) | |
7dcf23b1 SH |
88 | while len(self._buffer) >= 4: |
89 | remainder = None | |
1f27a20e | 90 | length = struct.unpack('>i', self._buffer[0:4].data())[0] |
7dcf23b1 SH |
91 | if len(self._buffer) < length: |
92 | # partial message, just wait for end of message | |
93 | break | |
94 | # more than one message? | |
95 | if length < len(self._buffer): | |
96 | # save beginning of another message | |
97 | remainder = self._buffer[length:] | |
98 | self._buffer = self._buffer[0:length] | |
99 | self.messageFromWeechat.emit(self._buffer) | |
77b25057 SH |
100 | if not self.is_connected(): |
101 | return | |
7dcf23b1 SH |
102 | self._buffer.clear() |
103 | if remainder: | |
104 | self._buffer.append(remainder) | |
105 | ||
106 | def _socket_disconnected(self): | |
107 | """Slot: socket disconnected.""" | |
108 | self._server = None | |
109 | self._port = None | |
77b25057 | 110 | self._ssl = None |
1f27a20e | 111 | self._password = "" |
7dcf23b1 SH |
112 | self.statusChanged.emit(self.status_disconnected, None) |
113 | ||
114 | def is_connected(self): | |
ac53e98c | 115 | """Return True if the socket is connected, False otherwise.""" |
7dcf23b1 SH |
116 | return self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState |
117 | ||
77b25057 | 118 | def is_ssl(self): |
ac53e98c | 119 | """Return True if SSL is used, False otherwise.""" |
77b25057 SH |
120 | return self._ssl |
121 | ||
46e5dee0 | 122 | def connect_weechat(self, server, port, ssl, password, lines): |
ac53e98c | 123 | """Connect to WeeChat.""" |
7dcf23b1 SH |
124 | self._server = server |
125 | try: | |
126 | self._port = int(port) | |
87a9710d | 127 | except ValueError: |
7dcf23b1 | 128 | self._port = 0 |
77b25057 | 129 | self._ssl = ssl |
7dcf23b1 | 130 | self._password = password |
46e5dee0 SH |
131 | try: |
132 | self._lines = int(lines) | |
87a9710d | 133 | except ValueError: |
46e5dee0 | 134 | self._lines = config.CONFIG_DEFAULT_RELAY_LINES |
7dcf23b1 SH |
135 | if self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState: |
136 | return | |
137 | if self._socket.state() != QtNetwork.QAbstractSocket.UnconnectedState: | |
138 | self._socket.abort() | |
77b25057 SH |
139 | if self._ssl: |
140 | self._socket.ignoreSslErrors() | |
1f27a20e AR |
141 | self._socket.connectToHostEncrypted(self._server, self._port) |
142 | else: | |
143 | self._socket.connectToHost(self._server, self._port) | |
1f27a20e | 144 | self.statusChanged.emit(self.status_connecting, "") |
7dcf23b1 SH |
145 | |
146 | def disconnect_weechat(self): | |
ac53e98c | 147 | """Disconnect from WeeChat.""" |
77df9d06 SH |
148 | if self._socket.state() == QtNetwork.QAbstractSocket.UnconnectedState: |
149 | return | |
150 | if self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState: | |
151 | self.send_to_weechat('quit\n') | |
152 | self._socket.waitForBytesWritten(1000) | |
153 | else: | |
154 | self.statusChanged.emit(self.status_disconnected, None) | |
155 | self._socket.abort() | |
7dcf23b1 SH |
156 | |
157 | def send_to_weechat(self, message): | |
ac53e98c | 158 | """Send a message to WeeChat.""" |
e09c80ab | 159 | self._socket.write(message.encode('utf-8')) |
7dcf23b1 | 160 | |
beaa8775 | 161 | def desync_weechat(self): |
ac53e98c | 162 | """Desynchronize from WeeChat.""" |
77b25057 | 163 | self.send_to_weechat('desync\n') |
beaa8775 SH |
164 | |
165 | def sync_weechat(self): | |
ac53e98c | 166 | """Synchronize with WeeChat.""" |
77b25057 | 167 | self.send_to_weechat('\n'.join(_PROTO_SYNC_CMDS)) |
beaa8775 | 168 | |
7dcf23b1 | 169 | def status_icon(self, status): |
890d4fa2 SH |
170 | """Return the name of icon for a given status.""" |
171 | icon = { | |
172 | self.status_disconnected: 'dialog-close.png', | |
173 | self.status_connecting: 'dialog-close.png', | |
174 | self.status_connected: 'dialog-ok-apply.png', | |
175 | } | |
7dcf23b1 | 176 | return icon.get(status, '') |
b548a19e | 177 | |
178 | def get_options(self): | |
890d4fa2 SH |
179 | """Get connection options.""" |
180 | return { | |
181 | 'server': self._server, | |
182 | 'port': self._port, | |
183 | 'ssl': 'on' if self._ssl else 'off', | |
184 | 'password': self._password, | |
185 | 'lines': str(self._lines), | |
186 | } |