qweechat/network.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3 #
   4 # network.py - I/O with WeeChat/relay
   5 #
   6 # Copyright (C) 2011-2014 Sébastien Helleu <flashcode@flashtux.org>
   7 #
   8 # This file is part of QWeeChat, a Qt remote GUI for WeeChat.
   9 #
  10 # QWeeChat is free software; you can redistribute it and/or modify
  11 # it under the terms of the GNU General Public License as published by
  12 # the Free Software Foundation; either version 3 of the License, or
  13 # (at your option) any later version.
  14 #
  15 # QWeeChat is distributed in the hope that it will be useful,
  16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 # GNU General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU General Public License
  21 # along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.
  22 #
  23
  24 import struct
  25 import qt_compat
  26 QtCore = qt_compat.import_module('QtCore')
  27 QtNetwork = qt_compat.import_module('QtNetwork')
  28 import config
  29
  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 ]
  45
  46
  47 class Network(QtCore.QObject):
  48     """I/O with WeeChat/relay."""
  49
  50     statusChanged = qt_compat.Signal(str, str)
  51     messageFromWeechat = qt_compat.Signal(QtCore.QByteArray)
  52
  53     def __init__(self, *args):
  54         QtCore.QObject.__init__(*(self,) + args)
  55         self.status_disconnected = 'disconnected'
  56         self.status_connecting = 'connecting...'
  57         self.status_connected = 'connected'
  58         self._server = None
  59         self._port = None
  60         self._ssl = None
  61         self._password = None
  62         self._lines = config.CONFIG_DEFAULT_RELAY_LINES
  63         self._buffer = QtCore.QByteArray()
  64         self._socket = QtNetwork.QSslSocket()
  65         self._socket.connected.connect(self._socket_connected)
  66         self._socket.error.connect(self._socket_error)
  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:
  74             self.send_to_weechat('\n'.join(_PROTO_INIT_CMD + _PROTO_SYNC_CMDS)
  75                                  % {'password': str(self._password),
  76                                     'lines': self._lines})
  77
  78     def _socket_error(self, error):
  79         """Slot: socket error."""
  80         self.statusChanged.emit(
  81             self.status_disconnected,
  82             'Failed, error: %s' % self._socket.errorString())
  83
  84     def _socket_read(self):
  85         """Slot: data available on socket."""
  86         data = self._socket.readAll()
  87         self._buffer.append(data)
  88         while len(self._buffer) >= 4:
  89             remainder = None
  90             length = struct.unpack('>i', self._buffer[0:4])[0]
  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)
 100             if not self.is_connected():
 101                 return
 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
 110         self._ssl = None
 111         self._password = None
 112         self.statusChanged.emit(self.status_disconnected, None)
 113
 114     def is_connected(self):
 115         return self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState
 116
 117     def is_ssl(self):
 118         return self._ssl
 119
 120     def connect_weechat(self, server, port, ssl, password, lines):
 121         self._server = server
 122         try:
 123             self._port = int(port)
 124         except:
 125             self._port = 0
 126         self._ssl = ssl
 127         self._password = password
 128         try:
 129             self._lines = int(lines)
 130         except:
 131             self._lines = config.CONFIG_DEFAULT_RELAY_LINES
 132         if self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState:
 133             return
 134         if self._socket.state() != QtNetwork.QAbstractSocket.UnconnectedState:
 135             self._socket.abort()
 136         self._socket.connectToHost(self._server, self._port)
 137         if self._ssl:
 138             self._socket.ignoreSslErrors()
 139             self._socket.startClientEncryption()
 140         self.statusChanged.emit(self.status_connecting, None)
 141
 142     def disconnect_weechat(self):
 143         if self._socket.state() == QtNetwork.QAbstractSocket.UnconnectedState:
 144             return
 145         if self._socket.state() == QtNetwork.QAbstractSocket.ConnectedState:
 146             self.send_to_weechat('quit\n')
 147             self._socket.waitForBytesWritten(1000)
 148         else:
 149             self.statusChanged.emit(self.status_disconnected, None)
 150         self._socket.abort()
 151
 152     def send_to_weechat(self, message):
 153         self._socket.write(message.encode('utf-8'))
 154
 155     def desync_weechat(self):
 156         self.send_to_weechat('desync\n')
 157
 158     def sync_weechat(self):
 159         self.send_to_weechat('\n'.join(_PROTO_SYNC_CMDS))
 160
 161     def status_icon(self, status):
 162         icon = {self.status_disconnected: 'dialog-close.png',
 163                 self.status_connecting: 'dialog-close.png',
 164                 self.status_connected: 'dialog-ok-apply.png'}
 165         return icon.get(status, '')
 166
 167     def get_options(self):
 168         return {'server': self._server,
 169                 'port': self._port,
 170                 'ssl': 'on' if self._ssl else 'off',
 171                 'password': self._password,
 172                 'lines': str(self._lines)}