# -*- coding: utf-8 -*- # # qweechat.py - WeeChat remote GUI using Qt toolkit # # Copyright (C) 2011-2022 Sébastien Helleu # # 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 . # """ QWeeChat is a WeeChat remote GUI using Qt toolkit. It requires requires WeeChat 0.3.7 or newer, running on local or remote host. """ # # History: # # 2011-05-27, Sébastien Helleu : # start dev # import sys import traceback from pkg_resources import resource_filename from PyQt5 import QtCore, QtGui, QtWidgets from qweechat import config from qweechat.about import AboutDialog from qweechat.buffer import BufferListWidget, Buffer from qweechat.connection import ConnectionDialog from qweechat.network import Network, STATUS_DISCONNECTED from qweechat.preferences import PreferencesDialog from qweechat.weechat import protocol APP_NAME = 'QWeeChat' AUTHOR = 'Sébastien Helleu' WEECHAT_SITE = 'https://weechat.org/' # not QFrame class MainWindow(QtWidgets.QMainWindow): """Main window.""" def __init__(self, *args): super().__init__(*args) self.config = config.read() self.resize(1000, 600) self.setWindowTitle(APP_NAME) self.about_dialog = None self.connection_dialog = None self.preferences_dialog = None # network self.network = Network() self.network.statusChanged.connect(self._network_status_changed) self.network.messageFromWeechat.connect(self._network_weechat_msg) # list of buffers self.list_buffers = BufferListWidget() self.list_buffers.currentRowChanged.connect(self._buffer_switch) # default buffer self.buffers = [Buffer()] self.stacked_buffers = QtWidgets.QStackedWidget() self.stacked_buffers.addWidget(self.buffers[0].widget) # splitter with buffers + chat/input splitter = QtWidgets.QSplitter() splitter.addWidget(self.list_buffers) splitter.addWidget(self.stacked_buffers) self.list_buffers.setSizePolicy(QtWidgets.QSizePolicy.Preferred, QtWidgets.QSizePolicy.Preferred) self.stacked_buffers.setSizePolicy(QtWidgets.QSizePolicy.Expanding, QtWidgets.QSizePolicy.Expanding) # MainWindow self.setCentralWidget(splitter) if self.config.getboolean('look', 'statusbar'): self.statusBar().visible = True self.statusBar().visible = True # actions for menu and toolbar actions_def = { 'connect': [ 'network-connect.png', 'Connect to WeeChat', 'Ctrl+O', self.open_connection_dialog, ], 'disconnect': [ 'network-disconnect.png', 'Disconnect from WeeChat', 'Ctrl+D', self.network.disconnect_weechat, ], 'debug': [ 'edit-find.png', 'Open debug console window', 'Ctrl+B', self.network.open_debug_dialog, ], 'preferences': [ 'preferences-other.png', 'Change preferences', 'Ctrl+P', self.open_preferences_dialog, ], 'about': [ 'help-about.png', 'About QWeeChat', 'Ctrl+H', self.open_about_dialog, ], 'save connection': [ 'document-save.png', 'Save connection configuration', 'Ctrl+S', self.save_connection, ], 'quit': [ 'application-exit.png', 'Quit application', 'Ctrl+Q', self.close, ], } self.actions = {} for name, action in list(actions_def.items()): self.actions[name] = QtWidgets.QAction( QtGui.QIcon( resource_filename(__name__, 'data/icons/%s' % action[0])), name.capitalize(), self) self.actions[name].setToolTip(f'{action[1]} ({action[2]})') self.actions[name].setShortcut(action[2]) self.actions[name].triggered.connect(action[3]) # menu self.menu = self.menuBar() menu_file = self.menu.addMenu('&File') menu_file.addActions([self.actions['connect'], self.actions['disconnect'], self.actions['preferences'], self.actions['save connection'], self.actions['quit']]) menu_window = self.menu.addMenu('&Window') menu_window.addAction(self.actions['debug']) menu_help = self.menu.addMenu('&Help') menu_help.addAction(self.actions['about']) self.network_status = QtWidgets.QLabel() self.network_status.setFixedHeight(20) self.network_status.setFixedWidth(200) self.network_status.setContentsMargins(0, 0, 10, 0) self.network_status.setAlignment(QtCore.Qt.AlignRight) if hasattr(self, 'menuBar'): if hasattr(self.menu, 'setCornerWidget'): self.menu.setCornerWidget(self.network_status, QtCore.Qt.TopRightCorner) self.network_status_set(STATUS_DISCONNECTED) # toolbar if hasattr(self, 'addToolBar'): toolbar = self.addToolBar('toolBar') toolbar.setToolButtonStyle(QtCore.Qt.ToolButtonTextUnderIcon) toolbar.addActions([self.actions['connect'], self.actions['disconnect'], self.actions['debug'], self.actions['preferences'], self.actions['about'], self.actions['quit']]) self.buffers[0].widget.input.setFocus() # open debug dialog if self.config.getboolean('look', 'debug'): self.network.open_debug_dialog() # auto-connect to relay if self.config.getboolean('relay', 'autoconnect'): self.network.connect_weechat( hostname=self.config.get('relay', 'hostname', fallback=''), port=self.config.get('relay', 'port', fallback=''), ssl=self.config.getboolean('relay', 'ssl', fallback=''), password=self.config.get('relay', 'password', fallback=''), totp=None, lines=self.config.get('relay', 'lines', fallback=''), ) self.show() def _buffer_switch(self, index): """Switch to a buffer.""" if index >= 0: self.stacked_buffers.setCurrentIndex(index) self.stacked_buffers.widget(index).input.setFocus() def buffer_input(self, full_name, text): """Send buffer input to WeeChat.""" if self.network.is_connected(): message = 'input %s %s\n' % (full_name, text) self.network.send_to_weechat(message) self.network.debug_print(0, '<==', message, forcecolor='#AA0000') def open_preferences_dialog(self): """Open a dialog with preferences.""" # TODO: implement the preferences dialog box self.preferences_dialog = PreferencesDialog(self) def save_connection(self): """Save connection configuration.""" if self.network: options = self.network.get_options() for option in options: self.config.set('relay', option, options[option]) def open_about_dialog(self): """Open a dialog with info about QWeeChat.""" self.about_dialog = AboutDialog(APP_NAME, AUTHOR, WEECHAT_SITE, self) def open_connection_dialog(self): """Open a dialog with connection settings.""" values = {} for option in ('hostname', 'port', 'ssl', 'password', 'lines'): values[option] = self.config.get('relay', option, fallback='') self.connection_dialog = ConnectionDialog(values, self) self.connection_dialog.dialog_buttons.accepted.connect( self.connect_weechat) def connect_weechat(self): """Connect to WeeChat.""" self.network.connect_weechat( hostname=self.connection_dialog.fields['hostname'].text(), port=self.connection_dialog.fields['port'].text(), ssl=self.connection_dialog.fields['ssl'].isChecked(), password=self.connection_dialog.fields['password'].text(), totp=self.connection_dialog.fields['totp'].text(), lines=int(self.connection_dialog.fields['lines'].text()), ) self.connection_dialog.close() def _network_status_changed(self, status, extra): """Called when the network status has changed.""" if self.config.getboolean('look', 'statusbar'): self.statusBar().showMessage(status) self.network.debug_print(0, '', status, forcecolor='#0000AA') self.network_status_set(status) def network_status_set(self, status): """Set the network status.""" pal = self.network_status.palette() try: pal.setColor(self.network_status.foregroundRole(), self.network.status_color(status)) except: # dunno pass ssl = ' (SSL)' if status != STATUS_DISCONNECTED \ and self.network.is_ssl() else '' self.network_status.setPalette(pal) icon = self.network.status_icon(status) if icon: self.network_status.setText( ' %s' % (resource_filename(__name__, 'data/icons/%s' % icon), self.network.status_label(status) + ssl)) else: self.network_status.setText(status.capitalize()) if status == STATUS_DISCONNECTED: self.actions['connect'].setEnabled(True) self.actions['disconnect'].setEnabled(False) else: self.actions['connect'].setEnabled(False) self.actions['disconnect'].setEnabled(True) def _network_weechat_msg(self, message): """Called when a message is received from WeeChat.""" self.network.debug_print( 0, '==>', 'message (%d bytes):\n%s' % (len(message), protocol.hex_and_ascii(message.data(), 20)), forcecolor='#008800', ) try: proto = protocol.Protocol() message = proto.decode(message.data()) if message.uncompressed: self.network.debug_print( 0, '==>', 'message uncompressed (%d bytes):\n%s' % (message.size_uncompressed, protocol.hex_and_ascii(message.uncompressed, 20)), forcecolor='#008800') self.network.debug_print(0, '', 'Message: %s' % message) self.parse_message(message) except Exception: # noqa: E722 print('Error while decoding message from WeeChat:\n%s' % traceback.format_exc()) self.network.disconnect_weechat() def _parse_handshake(self, message): """Parse a WeeChat message with handshake response.""" for obj in message.objects: if obj.objtype != 'htb': continue self.network.init_with_handshake(obj.value) break def _parse_listbuffers(self, message): """Parse a WeeChat message with list of buffers.""" for obj in message.objects: if obj.objtype != 'hda' or obj.value['path'][-1] != 'buffer': continue self.list_buffers.clear() while self.stacked_buffers.count() > 0: buf = self.stacked_buffers.widget(0) self.stacked_buffers.removeWidget(buf) self.buffers = [] for item in obj.value['items']: buf = self.create_buffer(item) self.insert_buffer(len(self.buffers), buf) self.list_buffers.setCurrentRow(0) self.buffers[0].widget.input.setFocus() def _parse_line(self, message): """Parse a WeeChat message with a buffer line.""" for obj in message.objects: lines = [] if obj.objtype != 'hda' or obj.value['path'][-1] != 'line_data': continue for item in obj.value['items']: if message.msgid == 'listlines': ptrbuf = item['__path'][0] else: ptrbuf = item['buffer'] index = [i for i, b in enumerate(self.buffers) if b.pointer() == ptrbuf] if index: lines.append( (index[0], (item['date'], item['prefix'], item['message'])) ) if message.msgid == 'listlines': lines.reverse() for line in lines: self.buffers[line[0]].widget.chat.display(*line[1]) def _parse_nicklist(self, message): """Parse a WeeChat message with a buffer nicklist.""" buffer_refresh = {} for obj in message.objects: if obj.objtype != 'hda' or \ obj.value['path'][-1] != 'nicklist_item': continue group = '__root' for item in obj.value['items']: index = [i for i, b in enumerate(self.buffers) if b.pointer() == item['__path'][0]] if index: if not index[0] in buffer_refresh: self.buffers[index[0]].nicklist = {} buffer_refresh[index[0]] = True if item['group']: group = item['name'] self.buffers[index[0]].nicklist_add_item( group, item['group'], item['prefix'], item['name'], item['visible']) for index in buffer_refresh: self.buffers[index].nicklist_refresh() def _parse_nicklist_diff(self, message): """Parse a WeeChat message with a buffer nicklist diff.""" buffer_refresh = {} for obj in message.objects: if obj.objtype != 'hda' or \ obj.value['path'][-1] != 'nicklist_item': continue group = '__root' for item in obj.value['items']: index = [i for i, b in enumerate(self.buffers) if b.pointer() == item['__path'][0]] if not index: continue buffer_refresh[index[0]] = True if item['_diff'] == ord('^'): group = item['name'] elif item['_diff'] == ord('+'): self.buffers[index[0]].nicklist_add_item( group, item['group'], item['prefix'], item['name'], item['visible']) elif item['_diff'] == ord('-'): self.buffers[index[0]].nicklist_remove_item( group, item['group'], item['name']) elif item['_diff'] == ord('*'): self.buffers[index[0]].nicklist_update_item( group, item['group'], item['prefix'], item['name'], item['visible']) for index in buffer_refresh: self.buffers[index].nicklist_refresh() def _parse_buffer_opened(self, message): """Parse a WeeChat message with a new buffer (opened).""" for obj in message.objects: if obj.objtype != 'hda' or obj.value['path'][-1] != 'buffer': continue for item in obj.value['items']: buf = self.create_buffer(item) index = self.find_buffer_index_for_insert(item['next_buffer']) self.insert_buffer(index, buf) def _parse_buffer(self, message): """Parse a WeeChat message with a buffer event (anything except a new buffer). """ for obj in message.objects: if obj.objtype != 'hda' or obj.value['path'][-1] != 'buffer': continue for item in obj.value['items']: index = [i for i, b in enumerate(self.buffers) if b.pointer() == item['__path'][0]] if not index: continue index = index[0] if message.msgid == '_buffer_type_changed': self.buffers[index].data['type'] = item['type'] elif message.msgid in ('_buffer_moved', '_buffer_merged', '_buffer_unmerged'): buf = self.buffers[index] buf.data['number'] = item['number'] self.remove_buffer(index) index2 = self.find_buffer_index_for_insert( item['next_buffer']) self.insert_buffer(index2, buf) elif message.msgid == '_buffer_renamed': self.buffers[index].data['full_name'] = item['full_name'] self.buffers[index].data['short_name'] = item['short_name'] elif message.msgid == '_buffer_title_changed': self.buffers[index].data['title'] = item['title'] self.buffers[index].update_title() elif message.msgid == '_buffer_cleared': self.buffers[index].widget.chat.clear() elif message.msgid.startswith('_buffer_localvar_'): self.buffers[index].data['local_variables'] = \ item['local_variables'] self.buffers[index].update_prompt() elif message.msgid == '_buffer_closing': self.remove_buffer(index) def parse_message(self, message): """Parse a WeeChat message.""" if message.msgid.startswith('debug'): self.network.debug_print(0, '', '(debug message, ignored)') elif message.msgid == 'handshake': self._parse_handshake(message) elif message.msgid == 'listbuffers': self._parse_listbuffers(message) elif message.msgid in ('listlines', '_buffer_line_added'): self._parse_line(message) elif message.msgid in ('_nicklist', 'nicklist'): self._parse_nicklist(message) elif message.msgid == '_nicklist_diff': self._parse_nicklist_diff(message) elif message.msgid == '_buffer_opened': self._parse_buffer_opened(message) elif message.msgid.startswith('_buffer_'): self._parse_buffer(message) elif message.msgid == '_upgrade': self.network.desync_weechat() elif message.msgid == '_upgrade_ended': self.network.sync_weechat() else: print(f"Unknown message with id {message.msgid}") def create_buffer(self, item): """Create a new buffer.""" buf = Buffer(item) buf.bufferInput.connect(self.buffer_input) buf.widget.input.bufferSwitchPrev.connect( self.list_buffers.switch_prev_buffer) buf.widget.input.bufferSwitchNext.connect( self.list_buffers.switch_next_buffer) return buf def insert_buffer(self, index, buf): """Insert a buffer in list.""" self.buffers.insert(index, buf) self.list_buffers.insertItem(index, '%s' % (buf.data['local_variables']['name'])) self.stacked_buffers.insertWidget(index, buf.widget) def remove_buffer(self, index): """Remove a buffer.""" if self.list_buffers.currentRow == index and index > 0: self.list_buffers.setCurrentRow(index - 1) self.list_buffers.takeItem(index) self.stacked_buffers.removeWidget(self.stacked_buffers.widget(index)) self.buffers.pop(index) def find_buffer_index_for_insert(self, next_buffer): """Find position to insert a buffer in list.""" index = -1 if next_buffer == '0x0': index = len(self.buffers) else: index = [i for i, b in enumerate(self.buffers) if b.pointer() == next_buffer] if index: index = index[0] if index < 0: print('Warning: unable to find position for buffer, using end of ' 'list by default') index = len(self.buffers) return index def closeEvent(self, event): """Called when QWeeChat window is closed.""" self.network.disconnect_weechat() if self.network.debug_dialog: self.network.debug_dialog.close() config.write(self.config) QtWidgets.QFrame.closeEvent(self, event) def main(): app = QtWidgets.QApplication(sys.argv) app.setStyle(QtWidgets.QStyleFactory.create('Cleanlooks')) app.setWindowIcon(QtGui.QIcon( resource_filename(__name__, 'data/icons/weechat.png'))) main_win = MainWindow() main_win.show() sys.exit(app.exec_()) if __name__ == '__main__': main()