]>
Commit | Line | Data |
---|---|---|
7dcf23b1 SH |
1 | # -*- coding: utf-8 -*- |
2 | # | |
e836cfb0 SH |
3 | # network.py - I/O with WeeChat/relay |
4 | # | |
da74afdb | 5 | # Copyright (C) 2011-2014 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 SH |
23 | import struct |
24 | import qt_compat | |
25 | QtCore = qt_compat.import_module('QtCore') | |
26 | QtNetwork = qt_compat.import_module('QtNetwork') | |
46e5dee0 | 27 | import config |
7dcf23b1 | 28 | |
77df9d06 SH |
29 | _PROTO_INIT_CMD = ['init password=%(password)s'] |
30 | ||
31 | _PROTO_SYNC_CMDS = [ | |
32 | '(listbuffers) hdata buffer:gui_buffers(*) number,full_name,short_name,' | |
33 | 'type,nicklist,title,local_variables', | |
34 | ||
35 | '(listlines) hdata buffer:gui_buffers(*)/own_lines/last_line(-%(lines)d)/' | |
36 | 'data date,displayed,prefix,message', | |
37 | ||
38 | '(nicklist) nicklist', | |
39 | ||
40 | 'sync', | |
41 | ||
42 | '' | |
43 | ] | |
7dcf23b1 SH |
44 | |
45 | ||
46 | class Network(QtCore.QObject): | |
47 | """I/O with WeeChat/relay.""" | |
48 | ||
49 | statusChanged = qt_compat.Signal(str, str) | |
50 | messageFromWeechat = qt_compat.Signal(QtCore.QByteArray) | |
51 | ||
52 | def __init__(self, *args): | |
67ae3204 | 53 | QtCore.QObject.__init__(*(self,) + args) |
7dcf23b1 SH |
54 | self.status_disconnected = 'disconnected' |
55 | self.status_connecting = 'connecting...' | |
56 | self.status_connected = 'connected' | |
57 | self._server = None | |
58 | self._port = None | |
77b25057 | 59 | self._ssl = None |
7dcf23b1 | 60 | self._password = None |
46e5dee0 | 61 | self._lines = config.CONFIG_DEFAULT_RELAY_LINES |
7dcf23b1 | 62 | self._buffer = QtCore.QByteArray() |
77b25057 | 63 | self._socket = QtNetwork.QSslSocket() |
7dcf23b1 SH |
64 | self._socket.connected.connect(self._socket_connected) |
65 | self._socket.error.connect(self._socket_error) | |
66 | self._socket.readyRead.connect(self._socket_read) | |
67 | self._socket.disconnected.connect(self._socket_disconnected) | |
68 | ||
69 | def _socket_connected(self): | |
70 | """Slot: socket connected.""" | |
71 | self.statusChanged.emit(self.status_connected, None) | |
72 | if self._password: | |
46e5dee0 SH |
73 | self.send_to_weechat('\n'.join(_PROTO_INIT_CMD + _PROTO_SYNC_CMDS) |
74 | % {'password': str(self._password), | |
75 | 'lines': self._lines}) | |
7dcf23b1 SH |
76 | |
77 | def _socket_error(self, error): | |
78 | """Slot: socket error.""" | |
77df9d06 SH |
79 | self.statusChanged.emit( |
80 | self.status_disconnected, | |
81 | 'Failed, error: %s' % self._socket.errorString()) | |
7dcf23b1 SH |
82 | |
83 | def _socket_read(self): | |
84 | """Slot: data available on socket.""" | |
6d5927c6 SH |
85 | data = self._socket.readAll() |
86 | self._buffer.append(data) | |
7dcf23b1 SH |
87 | while len(self._buffer) >= 4: |
88 | remainder = None | |
89 | length = struct.unpack('>i', self._buffer[0:4])[0] | |
90 | if len(self._buffer) < length: | |
91 | # partial message, just wait for end of message | |
92 | break | |
93 | # more than one message? | |
94 | if length < len(self._buffer): | |
95 | # save beginning of another message | |
96 | remainder = self._buffer[length:] | |
97 | self._buffer = self._buffer[0:length] | |
98 | self.messageFromWeechat.emit(self._buffer) | |
77b25057 SH |
99 | if not self.is_connected(): |
100 | return | |
7dcf23b1 SH |
101 | self._buffer.clear() |
102 | if remainder: | |
103 | self._buffer.append(remainder) | |
104 | ||
105 | def _socket_disconnected(self): | |
106 | """Slot: socket disconnected.""" | |
107 | self._server = None | |
108 | self._port = None | |
77b25057 | 109 | self._ssl = None |
7dcf23b1 SH |
110 | self._password = None |
111 | self.statusChanged.emit(self.status_disconnected, None) | |
112 | ||
113 | def is_connected(self): | |
ac53e98c | 114 | """Return True if the socket is connected, False otherwise.""" |
7dcf23b1 SH |
115 | return self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState |
116 | ||
77b25057 | 117 | def is_ssl(self): |
ac53e98c | 118 | """Return True if SSL is used, False otherwise.""" |
77b25057 SH |
119 | return self._ssl |
120 | ||
46e5dee0 | 121 | def connect_weechat(self, server, port, ssl, password, lines): |
ac53e98c | 122 | """Connect to WeeChat.""" |
7dcf23b1 SH |
123 | self._server = server |
124 | try: | |
125 | self._port = int(port) | |
87a9710d | 126 | except ValueError: |
7dcf23b1 | 127 | self._port = 0 |
77b25057 | 128 | self._ssl = ssl |
7dcf23b1 | 129 | self._password = password |
46e5dee0 SH |
130 | try: |
131 | self._lines = int(lines) | |
87a9710d | 132 | except ValueError: |
46e5dee0 | 133 | self._lines = config.CONFIG_DEFAULT_RELAY_LINES |
7dcf23b1 SH |
134 | if self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState: |
135 | return | |
136 | if self._socket.state() != QtNetwork.QAbstractSocket.UnconnectedState: | |
137 | self._socket.abort() | |
138 | self._socket.connectToHost(self._server, self._port) | |
77b25057 SH |
139 | if self._ssl: |
140 | self._socket.ignoreSslErrors() | |
141 | self._socket.startClientEncryption() | |
7dcf23b1 SH |
142 | self.statusChanged.emit(self.status_connecting, None) |
143 | ||
144 | def disconnect_weechat(self): | |
ac53e98c | 145 | """Disconnect from WeeChat.""" |
77df9d06 SH |
146 | if self._socket.state() == QtNetwork.QAbstractSocket.UnconnectedState: |
147 | return | |
148 | if self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState: | |
149 | self.send_to_weechat('quit\n') | |
150 | self._socket.waitForBytesWritten(1000) | |
151 | else: | |
152 | self.statusChanged.emit(self.status_disconnected, None) | |
153 | self._socket.abort() | |
7dcf23b1 SH |
154 | |
155 | def send_to_weechat(self, message): | |
ac53e98c | 156 | """Send a message to WeeChat.""" |
e09c80ab | 157 | self._socket.write(message.encode('utf-8')) |
7dcf23b1 | 158 | |
beaa8775 | 159 | def desync_weechat(self): |
ac53e98c | 160 | """Desynchronize from WeeChat.""" |
77b25057 | 161 | self.send_to_weechat('desync\n') |
beaa8775 SH |
162 | |
163 | def sync_weechat(self): | |
ac53e98c | 164 | """Synchronize with WeeChat.""" |
77b25057 | 165 | self.send_to_weechat('\n'.join(_PROTO_SYNC_CMDS)) |
beaa8775 | 166 | |
7dcf23b1 | 167 | def status_icon(self, status): |
890d4fa2 SH |
168 | """Return the name of icon for a given status.""" |
169 | icon = { | |
170 | self.status_disconnected: 'dialog-close.png', | |
171 | self.status_connecting: 'dialog-close.png', | |
172 | self.status_connected: 'dialog-ok-apply.png', | |
173 | } | |
7dcf23b1 | 174 | return icon.get(status, '') |
b548a19e | 175 | |
176 | def get_options(self): | |
890d4fa2 SH |
177 | """Get connection options.""" |
178 | return { | |
179 | 'server': self._server, | |
180 | 'port': self._port, | |
181 | 'ssl': 'on' if self._ssl else 'off', | |
182 | 'password': self._password, | |
183 | 'lines': str(self._lines), | |
184 | } |