tabs.py 50 KB
Newer Older
1
# Copyright 2010-2011 Le Coz Florent <louiz@louiz.org>
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
#
# This file is part of Poezio.
#
# Poezio 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, version 3 of the License.
#
# Poezio 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 Poezio.  If not, see <http://www.gnu.org/licenses/>.

"""
18
a Tab object is a way to organize various Windows (see windows.py)
19
around the screen at once.
20 21 22
A tab is then composed of multiple Buffer.
Each Tab object has different refresh() and resize() methods, defining how its
Buffer are displayed, resized, etc
23 24 25
"""

MIN_WIDTH = 50
26
MIN_HEIGHT = 16
27

28 29 30
from gettext import (bindtextdomain, textdomain, bind_textdomain_codeset,
                     gettext as _)

31 32 33
import logging
log = logging.getLogger(__name__)

34
import windows
35
import theme
36
import curses
37
import difflib
38
import shlex
39
import text_buffer
louiz’'s avatar
louiz’ committed
40
import string
41 42

from sleekxmpp.xmlstream.stanzabase import JID
43
from config import config
44
from roster import RosterGroup, roster
45
from contact import Contact, Resource
46
from logger import logger
47
import multiuserchat as muc
48 49 50 51

class Tab(object):
    number = 0

52
    def __init__(self, core):
53
        self.core = core        # a pointer to core, to access its attributes (ugly?)
louiz’'s avatar
louiz’ committed
54
        self._color_state = theme.COLOR_TAB_NORMAL
55 56
        self.nb = Tab.number
        Tab.number += 1
57
        self.size = (self.height, self.width) = self.core.stdscr.getmaxyx()
58 59 60 61
        if self.height < MIN_HEIGHT or self.width < MIN_WIDTH:
            self.visible = False
        else:
            self.visible = True
62 63
        self.key_func = {}      # each tab should add their keys in there
                                # and use them in on_input
64
        self.commands = {}      # and their own commands
65

66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
    def complete_commands(self, the_input):
        """
        Does command completion on the specified input for both global and tab-specific
        commands.
        This should be called from the completion method (on tab, for example), passing
        the input where completion is to be made.
        It can completion the command name itself or an argument of the command.
        Returns True if a completion was made, False else.
        """
        txt = the_input.get_text()
        # check if this is a command
        if txt.startswith('/') and not txt.startswith('//'):
            # check if we are in the middle of the command name
            if len(txt.split()) > 1 or\
                    (txt.endswith(' ') and not the_input.last_completion):
                command_name = txt.split()[0][1:]
                if command_name in self.core.commands:
                    command = self.core.commands[command_name]
                elif command_name in self.commands:
                    command = self.commands[command_name]
                else:           # Unknown command, cannot complete
                    return False
                if command[2] is None:
                    return False # There's no completion functio
                else:
                    return command[2](the_input)
            else:
                # complete the command's name
                words = ['/%s'%(name) for name in list(self.core.commands.keys())] +\
                    ['/%s'% (name) for name in list(self.commands.keys())]
                the_input.auto_completion(words, '')
                return True
        return False
99

100
    def execute_command(self, provided_text):
louiz’'s avatar
louiz’ committed
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
        """
        Execute the command in the input and return False if
        the input didn't contain a command
        """
        txt = provided_text or self.input.key_enter()
        if txt.startswith('/') and not txt.startswith('//') and\
                not txt.startswith('/me '):
            command = txt.strip().split()[0][1:]
            arg = txt[2+len(command):] # jump the '/' and the ' '
            if command in self.core.commands: # check global commands
                self.core.commands[command][0](arg)
            elif command in self.commands: # check tab-specific commands
                self.commands[command][0](arg)
            else:
                self.core.information(_("Unknown command (%s)") % (command), _('Error'))
            return True
        else:
            return False

120 121
    def resize(self):
        self.size = (self.height, self.width) = self.core.stdscr.getmaxyx()
122 123 124 125 126
        if self.height < MIN_HEIGHT or self.width < MIN_WIDTH:
            self.visible = False
        else:
            self.visible = True

127 128 129 130 131 132
    def refresh(self, tabs, informations, roster):
        """
        Called on each screen refresh (when something has changed)
        """
        raise NotImplementedError

133 134 135 136
    def get_color_state(self):
        """
        returns the color that should be used in the GlobalInfoBar
        """
louiz’'s avatar
louiz’ committed
137
        return self._color_state
138 139 140 141 142

    def set_color_state(self, color):
        """
        set the color state
        """
143
        pass
144 145 146 147 148

    def get_name(self):
        """
        get the name of the tab
        """
149
        return self.__class__.__name__
150

151 152 153 154 155 156
    def get_text_window(self):
        """
        Returns the principal TextWin window, if there's one
        """
        return None

157
    def on_input(self, key):
158
        pass
159 160 161 162 163

    def on_lose_focus(self):
        """
        called when this tab loses the focus.
        """
louiz’'s avatar
louiz’ committed
164
        self._color_state = theme.COLOR_TAB_NORMAL
165 166 167 168 169

    def on_gain_focus(self):
        """
        called when this tab gains the focus.
        """
louiz’'s avatar
louiz’ committed
170
        self._color_state = theme.COLOR_TAB_CURRENT
171 172 173 174 175 176 177 178

    def add_message(self):
        """
        Adds a message in the tab.
        If the tab cannot add a message in itself (for example
        FormTab, where text is not intented to be appened), it returns False.
        If the tab can, it returns True
        """
179
        return False
180 181 182 183 184

    def on_scroll_down(self):
        """
        Defines what happens when we scrol down
        """
185
        pass
186 187 188 189 190

    def on_scroll_up(self):
        """
        Defines what happens when we scrol down
        """
191
        pass
192

193
    def on_info_win_size_changed(self):
194 195 196
        """
        Called when the window with the informations is resized
        """
197
        pass
198

199 200 201 202 203 204
    def just_before_refresh(self):
        """
        Method called just before the screen refresh.
        Particularly useful to move the cursor at the
        correct position.
        """
205
        pass
206

207 208 209 210
    def on_close(self):
        """
        Called when the tab is to be closed
        """
211
        pass
212

213 214
class ChatTab(Tab):
    """
215 216 217
    A tab containing a chat of any type.
    Just use this class instead of Tab if the tab needs a recent-words completion
    Also, \n, ^J and ^M are already bound to on_enter
218
    And also, add the /say command
219
    """
220 221 222 223 224 225 226
    def __init__(self, core, room):
        Tab.__init__(self, core)
        self._room = room
        self.key_func['M-/'] = self.last_words_completion
        self.key_func['^J'] = self.on_enter
        self.key_func['^M'] = self.on_enter
        self.key_func['\n'] = self.on_enter
227 228
        self.commands['say'] =  (self.command_say,
                                 _("""Usage: /say <message>\nSay: Just send the message.
229
                                        Useful if you want your message to begin with a '/'"""), None)
230 231 232 233 234 235

    def last_words_completion(self):
        """
        Complete the input with words recently said
        """
        # build the list of the recent words
louiz’'s avatar
louiz’ committed
236
        char_we_dont_want = string.punctuation+' '
237 238 239 240
        words = list()
        for msg in self._room.messages[:-40:-1]:
            if not msg:
                continue
241
            txt = msg.txt
242
            for char in char_we_dont_want:
243 244
                txt = txt.replace(char, ' ')
            for word in txt.split():
245 246
                if len(word) >= 4 and word not in words:
                    words.append(word)
247
        self.input.auto_completion(words, ' ')
248 249

    def on_enter(self):
250
        txt = self.input.key_enter()
251
        if not self.execute_command(txt):
louiz’'s avatar
louiz’ committed
252 253
            if txt.startswith('//'):
                txt = txt[1:]
254 255 256
            self.command_say(txt)

    def command_say(self, line):
257 258
        raise NotImplementedError

259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
class InfoTab(ChatTab):
    """
    The information tab, used to display global informations
    when using a anonymous account
    """
    def __init__(self, core):
        Tab.__init__(self, core)
        self.tab_win = windows.GlobalInfoBar()
        self.info_win = windows.TextWin()
        self.core.information_buffer.add_window(self.info_win)
        self.input = windows.Input()
        self.name = "Info"
        self.color_state = theme.COLOR_TAB_NORMAL
        self.key_func['^J'] = self.on_enter
        self.key_func['^M'] = self.on_enter
        self.key_func['\n'] = self.on_enter
        self.key_func['^I'] = self.completion
        self.key_func['M-i'] = self.completion
        self.resize()

    def resize(self):
        Tab.resize(self)
281 282
        if not self.visible:
            return
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
        self.tab_win.resize(1, self.width, self.height-2, 0, self.core.stdscr)
        self.info_win.resize(self.height-2, self.width, 0, 0, self.core.stdscr)
        self.input.resize(1, self.width, self.height-1, 0, self.core.stdscr)

    def refresh(self, tabs, informations, _):
        if not self.visible:
            return
        self.info_win.refresh(informations)
        self.tab_win.refresh(tabs, tabs[0])
        self.input.refresh()

    def completion(self):
        self.complete_commands(self.input)

    def get_name(self):
        return self.name

    def get_color_state(self):
        return self.color_state

    def set_color_state(self, color):
        return

    def on_input(self, key):
        if key in self.key_func:
            self.key_func[key]()
            return False
        self.input.do_command(key)
        return False

313
    def on_enter(self):
louiz’'s avatar
louiz’ committed
314
        self.execute_command(self.input.key_enter())
315

316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
    def on_lose_focus(self):
        self.color_state = theme.COLOR_TAB_NORMAL

    def on_gain_focus(self):
        self.color_state = theme.COLOR_TAB_CURRENT
        curses.curs_set(1)

    def on_scroll_up(self):
        pass

    def on_scroll_down(self):
        pass

    def on_info_win_size_changed(self):
        return

    def just_before_refresh(self):
        return

    def on_close(self):
        return

338
class MucTab(ChatTab):
339 340 341 342
    """
    The tab containing a multi-user-chat room.
    It contains an userlist, an input, a topic, an information and a chat zone
    """
343
    def __init__(self, core, room):
344
        ChatTab.__init__(self, core, room)
345 346
        self.topic_win = windows.Topic()
        self.text_win = windows.TextWin()
347
        room.add_window(self.text_win)
348 349 350 351
        self.v_separator = windows.VerticalSeparator()
        self.user_win = windows.UserList()
        self.info_header = windows.MucInfoWin()
        self.info_win = windows.TextWin()
352
        self.core.information_buffer.add_window(self.info_win)
353 354
        self.tab_win = windows.GlobalInfoBar()
        self.input = windows.MessageInput()
355 356
        self.ignores = []       # set of Users
        # keys
357 358
        self.key_func['^I'] = self.completion
        self.key_func['M-i'] = self.completion
359 360
        self.key_func['M-u'] = self.scroll_user_list_down
        self.key_func['M-y'] = self.scroll_user_list_up
361
        # commands
362 363 364 365 366 367 368 369
        self.commands['ignore'] = (self.command_ignore, _("Usage: /ignore <nickname> \nIgnore: Ignore a specified nickname."), None)
        self.commands['unignore'] = (self.command_unignore, _("Usage: /unignore <nickname>\nUnignore: Remove the specified nickname from the ignore list."), None)
        self.commands['kick'] =  (self.command_kick, _("Usage: /kick <nick> [reason]\nKick: Kick the user with the specified nickname. You also can give an optional reason."), None)
        self.commands['topic'] = (self.command_topic, _("Usage: /topic <subject>\nTopic: Change the subject of the room"), None)
        self.commands['query'] = (self.command_query, _('Usage: /query <nick> [message]\nQuery: Open a private conversation with <nick>. This nick has to be present in the room you\'re currently in. If you specified a message after the nickname, it will immediately be sent to this user'), None)
        self.commands['part'] = (self.command_part, _("Usage: /part [message]\n Part: disconnect from a room. You can specify an optional message."), None)
        self.commands['nick'] = (self.command_nick, _("Usage: /nick <nickname>\nNick: Change your nickname in the current room"), None)
        self.commands['recolor'] = (self.command_recolor, _('Usage: /recolor\nRecolor: Re-assign a color to all participants of the current room, based on the last time they talked. Use this if the participants currently talking have too many identical colors.'), None)
370
        self.commands['cycle'] = (self.command_cycle, _('Usage: /cycle [message]\nCycle: Leaves the current room and rejoin it immediately'), None)
louiz’'s avatar
louiz’ committed
371 372
        self.commands['info'] = (self.command_info, _('Usage: /info <nickname>\nInfo: Display some information about the user in the MUC: his/here role, affiliation, status and status message.'), None)
        self.commands['configure'] = (self.command_configure, _('Usage: /configure\nConfigure: Configure the current room, through a form.'), None)
373
        self.resize()
374

375 376 377 378 379 380 381 382
    def scroll_user_list_up(self):
        self.user_win.scroll_up()
        self.core.refresh_window()

    def scroll_user_list_down(self):
        self.user_win.scroll_down()
        self.core.refresh_window()

383 384 385 386 387 388 389 390 391 392
    def command_info(self, arg):
        try:
            args = shlex.split(arg)
        except ValueError as error:
            return self.core.information(str(error), _("Error"))
        if len(args) != 1:
            return self.core.information("Info command takes only 1 argument")
        user = self.get_room().get_user_by_name(args[0])
        if not user:
            return self.core.information("Unknown user: %s" % args[0])
louiz’'s avatar
louiz’ committed
393
        self.get_room().add_message("%s%s: show: %s, affiliation: %s, role: %s\n%s"% (args[0], user.user.show or 'Available', user.role or 'None', user.affiliation or 'None', user.status))
394 395
        self.core.refresh_window()

louiz’'s avatar
louiz’ committed
396 397 398
    def command_configure(self, arg):
        form = self.core.xmpp.plugin['xep_0045'].getRoomForm(self.get_name())
        self.core.information('%s' % form)
399 400
        if not form:
            return
louiz’'s avatar
louiz’ committed
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
        self.core.open_new_form(form, self.cancel_config, self.send_config)

    def cancel_config(self, form):
        """
        The user do not want to send his/her config, send an iq cancel
        """
        self.core.xmpp.plugin['xep_0045'].cancelConfig(self.get_name())
        self.core.close_tab()

    def send_config(self, form):
        """
        The user sends his/her config to the server
        """
        self.core.xmpp.plugin['xep_0045'].configureRoom(self.get_name(), form)
        self.core.close_tab()

417 418
    def command_cycle(self, arg):
        if self.get_room().joined:
419
            muc.leave_groupchat(self.core.xmpp, self.get_name(), self.get_room().own_nick, arg)
420
        self.get_room().joined = False
421
        self.core.command_join('/', "0")
422

423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
    def command_recolor(self, arg):
        """
        Re-assign color to the participants of the room
        """
        room = self.get_room()
        i = 0
        compare_users = lambda x: x.last_talked
        users = list(room.users)
        # search our own user, to remove it from the room
        for user in users:
            if user.nick == room.own_nick:
                users.remove(user)
        nb_color = len(theme.LIST_COLOR_NICKNAMES)
        for user in sorted(users, key=compare_users, reverse=True):
            user.color = theme.LIST_COLOR_NICKNAMES[i % nb_color]
438
            i += 1
439
        self.text_win.rebuild_everything(self.get_room())
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
        self.core.refresh_window()

    def command_nick(self, arg):
        """
        /nick <nickname>
        """
        try:
            args = shlex.split(arg)
        except ValueError as error:
            return self.core.information(str(error), _("Error"))
        if len(args) != 1:
            return
        nick = args[0]
        room = self.get_room()
        if not room.joined:
            return
        muc.change_nick(self.core.xmpp, room.name, nick)

    def command_part(self, arg):
        """
        /part [msg]
        """
        args = arg.split()
        reason = None
        room = self.get_room()
        if len(args):
            msg = ' '.join(args)
        else:
            msg = None
        if self.get_room().joined:
            muc.leave_groupchat(self.core.xmpp, room.name, room.own_nick, arg)
        self.core.close_tab()

    def command_query(self, arg):
        """
        /query <nick> [message]
        """
        try:
            args = shlex.split(arg)
        except ValueError as error:
            return self.core.information(str(error), _("Error"))
        if len(args) < 1:
            return
        nick = args[0]
        room = self.get_room()
        r = None
        for user in room.users:
            if user.nick == nick:
                r = self.core.open_private_window(room.name, user.nick)
        if r and len(args) > 1:
            msg = arg[len(nick)+1:]
            muc.send_private_message(self.core.xmpp, r.name, msg)
            self.core.add_message_to_text_buffer(r, msg, None, r.own_nick)

    def command_topic(self, arg):
        """
        /topic [new topic]
        """
        if not arg.strip():
            self.core.add_message_to_text_buffer(self.get_room(),
                                                 _("The subject of the room is: %s") % self.get_room().topic)
            return
        subject = arg
        muc.change_subject(self.core.xmpp, self.get_room().name, subject)

    def command_kick(self, arg):
        """
        /kick <nick> [reason]
        """
        try:
            args = shlex.split(arg)
        except ValueError as error:
            return self.core.information(str(error), _("Error"))
        if len(args) < 1:
            self.core.command_help('kick')
            return
        nick = args[0]
        if len(args) >= 2:
            reason = ' '.join(args[1:])
        else:
            reason = ''
        if not self.get_room().joined:
            return
        res = muc.eject_user(self.core.xmpp, self.get_name(), nick, reason)
        if res['type'] == 'error':
            self.core.room_error(res, self.get_name())

    def command_say(self, line):
        muc.send_groupchat_message(self.core.xmpp, self.get_name(), line)

    def command_ignore(self, arg):
        """
        /ignore <nick>
        """
        try:
            args = shlex.split(arg)
        except ValueError as error:
            return self.core.information(str(error), _("Error"))
        if len(args) != 1:
            self.core.command_help('ignore')
            return
        nick = args[0]
        user = self._room.get_user_by_name(nick)
        if not user:
            self.core.information(_('%s is not in the room') % nick)
        elif user in self.ignores:
            self.core.information(_('%s is already ignored') % nick)
        else:
            self.ignores.append(user)
            self.core.information(_("%s is now ignored") % nick, 'info')

    def command_unignore(self, arg):
        """
        /unignore <nick>
        """
        try:
            args = shlex.split(arg)
        except ValueError as error:
            return self.core.information(str(error), _("Error"))
        if len(args) != 1:
            self.core.command_help('unignore')
            return
        nick = args[0]
        user = self._room.get_user_by_name(nick)
        if not user:
            self.core.information(_('%s is not in the room') % nick)
        elif user not in self.ignores:
            self.core.information(_('%s is not ignored') % nick)
        else:
            self.ignores.remove(user)
            self.core.information(_('%s is now unignored') % nick)

572
    def resize(self):
573 574 575
        """
        Resize the whole window. i.e. all its sub-windows
        """
576
        Tab.resize(self)
577 578
        if not self.visible:
            return
579
        text_width = (self.width//10)*9
580 581
        self.topic_win.resize(1, self.width, 0, 0, self.core.stdscr)
        self.text_win.resize(self.height-4-self.core.information_win_size, text_width, 1, 0, self.core.stdscr)
582
        self.text_win.rebuild_everything(self._room)
583 584 585
        self.v_separator.resize(self.height-3, 1, 1, 9*(self.width//10), self.core.stdscr)
        self.user_win.resize(self.height-3, self.width-text_width-1, 1, text_width+1, self.core.stdscr)
        self.info_header.resize(1, (self.width//10)*9, self.height-3-self.core.information_win_size, 0, self.core.stdscr)
586
        self.info_win.resize(self.core.information_win_size, (self.width//10)*9, self.height-2-self.core.information_win_size, 0, self.core.stdscr, self.core.information_buffer)
587 588
        self.tab_win.resize(1, self.width, self.height-2, 0, self.core.stdscr)
        self.input.resize(1, self.width, self.height-1, 0, self.core.stdscr)
589

590
    def refresh(self, tabs, informations, _):
591 592
        if not self.visible:
            return
593 594 595 596
        self.topic_win.refresh(self._room.topic)
        self.text_win.refresh(self._room)
        self.v_separator.refresh()
        self.user_win.refresh(self._room.users)
597
        self.info_header.refresh(self._room, self.text_win)
598
        self.tab_win.refresh(tabs, tabs[0])
599
        self.info_win.refresh(informations)
600 601 602
        self.input.refresh()

    def on_input(self, key):
603 604
        if key in self.key_func:
            self.key_func[key]()
605 606 607
            return False
        self.input.do_command(key)
        return False
608 609 610 611 612

    def completion(self):
        """
        Called when Tab is pressed, complete the nickname in the input
        """
613 614
        if self.complete_commands(self.input):
            return
615
        # If we are not completing a command or a command's argument, complete a nick
616
        compare_users = lambda x: x.last_talked
617 618
        word_list = [user.nick for user in sorted(self._room.users, key=compare_users, reverse=True)\
                         if user.nick != self._room.own_nick]
619 620 621 622 623 624 625
        after = config.get('after_completion', ',')+" "
        if ' ' not in self.input.get_text() or (self.input.last_completion and\
                     self.input.get_text()[:-len(after)] == self.input.last_completion):
            add_after = after
        else:
            add_after = ' '
        self.input.auto_completion(word_list, add_after)
626 627 628 629 630 631 632 633 634 635

    def get_color_state(self):
        return self._room.color_state

    def set_color_state(self, color):
        self._room.set_color_state(color)

    def get_name(self):
        return self._room.name

636 637 638
    def get_text_window(self):
        return self.text_win

639 640 641 642 643
    def get_room(self):
        return self._room

    def on_lose_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_NORMAL)
644 645
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator()
646 647 648

    def on_gain_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_CURRENT)
649
        if self.text_win.built_lines and self.text_win.built_lines[-1] is None:
650
            self.text_win.remove_line_separator()
651
        curses.curs_set(1)
652 653

    def on_scroll_up(self):
654
        self.text_win.scroll_up(self.text_win.height-1)
655 656

    def on_scroll_down(self):
657
        self.text_win.scroll_down(self.text_win.height-1)
658

659
    def on_info_win_size_changed(self):
660
        text_width = (self.width//10)*9
661 662 663
        self.text_win.resize(self.height-4-self.core.information_win_size, text_width, 1, 0, self.core.stdscr)
        self.info_header.resize(1, (self.width//10)*9, self.height-3-self.core.information_win_size, 0, self.core.stdscr)
        self.info_win.resize(self.core.information_win_size, (self.width//10)*9, self.height-2-self.core.information_win_size, 0, self.core.stdscr)
664

665
    def just_before_refresh(self):
666
        return
667

668 669 670
    def on_close(self):
        return

671
class PrivateTab(ChatTab):
672 673 674
    """
    The tab containg a private conversation (someone from a MUC)
    """
675
    def __init__(self, core, room):
676
        ChatTab.__init__(self, core, room)
677
        self.text_win = windows.TextWin()
678
        room.add_window(self.text_win)
679 680
        self.info_header = windows.PrivateInfoWin()
        self.info_win = windows.TextWin()
681
        self.core.information_buffer.add_window(self.info_win)
682 683
        self.tab_win = windows.GlobalInfoBar()
        self.input = windows.MessageInput()
684 685 686 687 688 689
        # keys
        self.key_func['^I'] = self.completion
        self.key_func['M-i'] = self.completion
        # commands
        self.commands['unquery'] = (self.command_unquery, _("Usage: /unquery\nUnquery: close the tab"), None)
        self.commands['part'] = (self.command_unquery, _("Usage: /part\Part: close the tab"), None)
690
        self.resize()
691

692 693 694
    def completion(self):
        self.complete_commands(self.input)

695 696 697
    def command_say(self, line):
        muc.send_private_message(self.core.xmpp, self.get_name(), line)
        self.core.add_message_to_text_buffer(self.get_room(), line, None, self.get_room().own_nick)
698
        logger.log_message(self.get_name().replace('/', '\\'), self.get_room().own_nick, line)
699 700 701 702 703 704 705

    def command_unquery(self, arg):
        """
        /unquery
        """
        self.core.close_tab()

706 707
    def resize(self):
        Tab.resize(self)
708 709
        if not self.visible:
            return
710
        self.text_win.resize(self.height-3-self.core.information_win_size, self.width, 0, 0, self.core.stdscr)
711
        self.text_win.rebuild_everything(self._room)
712
        self.info_header.resize(1, self.width, self.height-3-self.core.information_win_size, 0, self.core.stdscr)
713
        self.info_win.resize(self.core.information_win_size, self.width, self.height-2-self.core.information_win_size, 0, self.core.stdscr, self.core.information_buffer)
714 715
        self.tab_win.resize(1, self.width, self.height-2, 0, self.core.stdscr)
        self.input.resize(1, self.width, self.height-1, 0, self.core.stdscr)
716

717
    def refresh(self, tabs, informations, _):
718 719
        if not self.visible:
            return
720
        self.text_win.refresh(self._room)
721
        self.info_header.refresh(self._room, self.text_win)
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
        self.info_win.refresh(informations)
        self.tab_win.refresh(tabs, tabs[0])
        self.input.refresh()

    def get_color_state(self):
        if self._room.color_state == theme.COLOR_TAB_NORMAL or\
                self._room.color_state == theme.COLOR_TAB_CURRENT:
            return self._room.color_state
        return theme.COLOR_TAB_PRIVATE

    def set_color_state(self, color):
        self._room.color_state = color

    def get_name(self):
        return self._room.name

    def on_input(self, key):
739 740
        if key in self.key_func:
            self.key_func[key]()
741
            return False
742 743
        self.input.do_command(key)
        return False
744 745 746

    def on_lose_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_NORMAL)
747 748
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator()
749 750 751

    def on_gain_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_CURRENT)
752
        curses.curs_set(1)
753 754

    def on_scroll_up(self):
755
        self.text_win.scroll_up(self.text_win.height-1)
756 757

    def on_scroll_down(self):
758
        self.text_win.scroll_down(self.text_win.height-1)
759

760
    def on_info_win_size_changed(self):
761 762
        self.text_win.resize(self.height-3-self.core.information_win_size, self.width, 0, 0, self.core.stdscr)
        self.info_header.resize(1, self.width, self.height-3-self.core.information_win_size, 0, self.core.stdscr)
763
        self.info_win.resize(self.core.information_win_size, self.width, self.height-2-self.core.information_win_size, 0, self.core.stdscr, None)
764 765 766

    def get_room(self):
        return self._room
767

768 769 770
    def get_text_window(self):
        return self.text_win

771 772 773
    def just_before_refresh(self):
        return

774 775 776
    def on_close(self):
        return

777 778
class RosterInfoTab(Tab):
    """
779
    A tab, splitted in two, containing the roster and infos
780
    """
781 782
    def __init__(self, core):
        Tab.__init__(self, core)
783
        self.name = "Roster"
784 785 786
        self.v_separator = windows.VerticalSeparator()
        self.tab_win = windows.GlobalInfoBar()
        self.info_win = windows.TextWin()
787
        self.core.information_buffer.add_window(self.info_win)
788 789 790
        self.roster_win = windows.RosterWin()
        self.contact_info_win = windows.ContactInfoWin()
        self.default_help_message = windows.HelpText("Enter commands with “/”. “o”: toggle offline show")
791
        self.input = self.default_help_message
792
        self.set_color_state(theme.COLOR_TAB_NORMAL)
793 794 795 796 797 798 799 800 801
        self.key_func['^I'] = self.completion
        self.key_func['M-i'] = self.completion
        self.key_func["^J"] = self.on_enter
        self.key_func["^M"] = self.on_enter
        self.key_func[' '] = self.on_space
        self.key_func["/"] = self.on_slash
        self.key_func["KEY_UP"] = self.move_cursor_up
        self.key_func["KEY_DOWN"] = self.move_cursor_down
        self.key_func["o"] = self.toggle_offline_show
802 803
        self.key_func["s"] = self.start_search
        self.key_func["S"] = self.start_search_slow
804
        self.commands['deny'] = (self.command_deny, _("Usage: /deny [jid]\nDeny: Use this command to remove and deny your presence to the provided JID (or the selected contact in your roster), who is asking you to be in his/here roster"), self.completion_deny)
louiz’'s avatar
louiz’ committed
805 806 807
        self.commands['accept'] = (self.command_accept, _("Usage: /accept [jid]\nAccept: Use this command to authorize the provided JID (or the selected contact in your roster), to see your presence, and to ask to subscribe to it (mutual presence subscription)."), self.completion_deny)
        self.commands['add'] = (self.command_add, _("Usage: /add <jid>\Add: Use this command to add the specified JID to your roster. The reverse authorization will automatically be accepted if the remote JID accepts your subscription, leading to a mutual presence subscription."), None)
        self.commands['remove'] = (self.command_remove, _("Usage: /remove [jid]\Remove: Use this command to remove the specified JID from your roster. This wil unsubscribe you from its presence, cancel its subscription to yours, and remove the item from your roster"), self.completion_remove)
808
        self.resize()
809

810 811
    def resize(self):
        Tab.resize(self)
812 813
        if not self.visible:
            return
814 815
        roster_width = self.width//2
        info_width = self.width-roster_width-1
816 817
        self.v_separator.resize(self.height-2, 1, 0, roster_width, self.core.stdscr)
        self.tab_win.resize(1, self.width, self.height-2, 0, self.core.stdscr)
818 819 820
        self.info_win.resize(self.height-2-4, info_width, 0, roster_width+1, self.core.stdscr, self.core.information_buffer)
        self.roster_win.resize(self.height-2, roster_width, 0, 0, self.core.stdscr)
        self.contact_info_win.resize(4, info_width, self.height-2-4, roster_width+1, self.core.stdscr)
821
        self.input.resize(1, self.width, self.height-1, 0, self.core.stdscr)
822

823 824 825 826 827
    def completion(self):
        # Check if we are entering a command (with the '/' key)
        if isinstance(self.input, windows.CommandInput) and\
                not self.input.help_message:
            self.complete_commands(self.input)
828

829 830 831 832
    def command_deny(self, args):
        """
        Denies a JID from our roster
        """
louiz’'s avatar
louiz’ committed
833 834 835 836 837 838 839 840 841
        args = args.split()
        if not args:
            item = self.roster_win.selected_row
            if isinstance(item, Contact) and item.get_ask() == 'asked':
                jid = item.get_bare_jid()
            else:
                self.core.information('No subscription to deny')
                return
        else:
louiz’'s avatar
louiz’ committed
842
            jid = JID(args[0]).bare
louiz’'s avatar
louiz’ committed
843 844 845 846
        self.core.xmpp.sendPresence(pto=jid, ptype='unsubscribed')
        if self.core.xmpp.update_roster(jid, subscription='remove'):
            roster.remove_contact(jid)

louiz’'s avatar
louiz’ committed
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
    def command_add(self, args):
        """
        Add the specified JID to the roster, and set automatically
        accept the reverse subscription
        """
        jid = JID(args.strip()).bare
        if not jid:
            return
        self.core.xmpp.sendPresence(pto=jid, ptype='subscribe')

    def command_remove(self, args):
        """
        Remove the specified JID from the roster. i.e. : unsubscribe
        from its presence, and cancel its subscription to our.
        """
        if args.strip():
            jid = JID(args.strip()).bare
        else:
            item = self.roster_win.selected_row
            if isinstance(item, Contact):
                jid = item.get_bare_jid()
            else:
                self.core.information('No roster item to remove')
                return
        self.core.xmpp.sendPresence(pto=jid, ptype='unsubscribe')
        self.core.xmpp.sendPresence(pto=jid, ptype='unsubscribed')
        self.core.xmpp.del_roster_item(jid=jid)

    def completion_remove(self, the_input):
        """
        From with any JID presence in the roster
        """
        jids = [contact.get_bare_jid() for contact in roster.get_contacts()]
        the_input.auto_completion(jids, '')

louiz’'s avatar
louiz’ committed
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
    def completion_deny(self, the_input):
        """
        Complete the first argument from the list of the
        contact with ask=='subscribe'
        """
        jids = [contact.get_bare_jid() for contact in roster.get_contacts()\
             if contact.get_ask() == 'asked']
        the_input.auto_completion(jids, '')

    def command_accept(self, args):
        """
        Accept a JID from in roster. Authorize it AND subscribe to it
        """
        args = args.split()
        if not args:
            item = self.roster_win.selected_row
            if isinstance(item, Contact) and item.get_ask() == 'asked':
                jid = item.get_bare_jid()
            else:
                self.core.information('No subscription to deny')
                return
        else:
            jid = args[0]
        self.core.xmpp.sendPresence(pto=jid, ptype='subscribed')
        self.core.xmpp.sendPresence(pto=jid, ptype='subscribe')

908
    def refresh(self, tabs, informations, roster):
909 910
        if not self.visible:
            return
911
        self.v_separator.refresh()
912
        self.roster_win.refresh(roster)
913
        self.contact_info_win.refresh(self.roster_win.get_selected_row())
914
        # self.core.global_information_win.refresh(informations)
915 916 917 918 919 920 921 922 923 924 925 926 927 928
        self.info_win.refresh(informations)
        self.tab_win.refresh(tabs, tabs[0])
        self.input.refresh()

    def get_name(self):
        return self.name

    def get_color_state(self):
        return self._color_state

    def set_color_state(self, color):
        self._color_state = color

    def on_input(self, key):
929 930
        res = self.input.do_command(key)
        if res:
931
            return True
932 933
        if key in self.key_func:
            return self.key_func[key]()
934 935 936 937 938 939 940 941 942 943 944

    def toggle_offline_show(self):
        """
        Show or hide offline contacts
        """
        option = 'roster_show_offline'
        if config.get(option, 'false') == 'false':
            config.set_and_save(option, 'true')
        else:
            config.set_and_save(option, 'false')
        return True
945

946 947 948 949 950
    def on_slash(self):
        """
        '/' is pressed, we enter "input mode"
        """
        curses.curs_set(1)
951 952
        self.input = windows.CommandInput("", self.reset_help_message, self.execute_slash_command)
        self.input.resize(1, self.width, self.height-1, 0, self.core.stdscr)
953 954 955 956 957
        self.input.do_command("/") # we add the slash

    def reset_help_message(self, _=None):
        curses.curs_set(0)
        self.input = self.default_help_message
958
        self.core.refresh_window()
959 960 961 962
        return True

    def execute_slash_command(self, txt):
        if txt.startswith('/'):
963
            self.execute_command(txt)
964
        return self.reset_help_message()
965 966 967 968 969 970

    def on_lose_focus(self):
        self._color_state = theme.COLOR_TAB_NORMAL

    def on_gain_focus(self):
        self._color_state = theme.COLOR_TAB_CURRENT
971 972 973 974
        if isinstance(self.input, windows.HelpText):
            curses.curs_set(0)
        else:
            curses.curs_set(1)
975 976 977 978

    def add_message(self):
        return False

979
    def move_cursor_down(self):
980
        self.roster_win.move_cursor_down()
981
        return True
982

983
    def move_cursor_up(self):
984
        self.roster_win.move_cursor_up()
985 986 987 988 989 990 991 992 993
        return True

    def on_scroll_down(self):
        # Scroll info win
        pass

    def on_scroll_up(self):
        # Scroll info down
        pass
994

995
    def on_info_win_size_changed(self):
996 997
        pass

998 999 1000 1001 1002 1003
    def on_space(self):
        selected_row = self.roster_win.get_selected_row()
        if isinstance(selected_row, RosterGroup) or\
                isinstance(selected_row, Contact):
            selected_row.toggle_folded()
            return True
1004

1005
    def on_enter(self):
1006
        selected_row = self.roster_win.get_selected_row()
1007
        self.core.on_roster_enter_key(selected_row)
1008
        return selected_row
1009

1010 1011 1012 1013 1014 1015
    def start_search(self):
        """
        Start the search. The input should appear with a short instruction
        in it.
        """
        curses.curs_set(1)
1016 1017
        self.input = windows.CommandInput("[Search]", self.on_search_terminate, self.on_search_terminate, self.set_roster_filter)
        self.input.resize(1, self.width, self.height-1, 0, self.core.stdscr)
1018 1019
        return True

1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
    def start_search_slow(self):
        curses.curs_set(1)
        self.input = windows.CommandInput("[Search]", self.on_search_terminate, self.on_search_terminate, self.set_roster_filter_slow)
        self.input.resize(1, self.width, self.height-1, 0, self.core.stdscr)
        return True

    def set_roster_filter_slow(self, txt):
        roster._contact_filter = (jid_and_name_match_slow, txt)
        self.roster_win.refresh(roster)
        return False

1031 1032
    def set_roster_filter(self, txt):
        roster._contact_filter = (jid_and_name_match, txt)
1033 1034
        self.roster_win.refresh(roster)
        return False
1035

1036 1037 1038
    def on_search_terminate(self, txt):
        curses.curs_set(0)
        roster._contact_filter = None
1039
        self.reset_help_message()
1040
        return False
1041

1042 1043 1044
    def just_before_refresh(self):
        return

1045 1046 1047
    def on_close(self):
        return

1048
class ConversationTab(ChatTab):
1049
    """
1050
    The tab containg a normal conversation (not from a MUC)
1051
    """
1052
    def __init__(self, core, jid):
1053 1054
        txt_buff = text_buffer.TextBuffer()
        ChatTab.__init__(self, core, txt_buff)
1055 1056
        self.color_state = theme.COLOR_TAB_NORMAL
        self._name = jid        # a conversation tab is linked to one specific full jid OR bare jid
1057
        self.text_win = windows.TextWin()
1058
        txt_buff.add_window(self.text_win)
1059 1060 1061
        self.upper_bar = windows.ConversationStatusMessageWin()
        self.info_header = windows.ConversationInfoWin()
        self.info_win = windows.TextWin()
1062
        self.core.information_buffer.add_window(self.info_win)
1063 1064
        self.tab_win = windows.GlobalInfoBar()
        self.input = windows.MessageInput()
1065 1066 1067 1068 1069 1070
        # keys
        self.key_func['^I'] = self.completion
        self.key_func['M-i'] = self.completion
        # commands
        self.commands['unquery'] = (self.command_unquery, _("Usage: /unquery\nUnquery: close the tab"), None)
        self.commands['part'] = (self.command_unquery, _("Usage: /part\Part: close the tab"), None)
1071
        self.resize()
1072

1073 1074 1075
    def completion(self):
        self.complete_commands(self.input)

1076 1077 1078
    def command_say(self, line):
        muc.send_private_message(self.core.xmpp, self.get_name(), line)
        self.core.add_message_to_text_buffer(self.get_room(), line, None, self.core.own_nick)
1079
        logger.log_message(JID(self.get_name()).bare, self.core.own_nick, line)
1080 1081 1082 1083

    def command_unquery(self, arg):
        self.core.close_tab()

1084 1085
    def resize(self):
        Tab.resize(self)
1086 1087
        if not self.visible:
            return
1088
        self.text_win.resize(self.height-4-self.core.information_win_size, self.width, 1, 0, self.core.stdscr)
1089
        self.text_win.rebuild_everything(self._room)
1090 1091
        self.upper_bar.resize(1, self.width, 0, 0, self.core.stdscr)
        self.info_header.resize(1, self.width, self.height-3-self.core.information_win_size, 0, self.core.stdscr)
1092
        self.info_win.resize(self.core.information_win_size, self.width, self.height-2-self.core.information_win_size, 0, self.core.stdscr, self.core.information_buffer)
1093 1094
        self.tab_win.resize(1, self.width, self.height-2, 0, self.core.stdscr)
        self.input.resize(1, self.width, self.height-1, 0, self.core.stdscr)
1095

1096
    def refresh(self, tabs, informations, roster):
1097 1098
        if not self.visible:
            return
1099
        self.text_win.refresh(self._room)
1100
        self.upper_bar.refresh(self.get_name(), roster.get_contact_by_jid(self.get_name()))
1101
        self.info_header.refresh(self.get_name(), roster.get_contact_by_jid(self.get_name()), self._room, self.text_win)
1102 1103 1104 1105 1106
        self.info_win.refresh(informations)
        self.tab_win.refresh(tabs, tabs[0])
        self.input.refresh()

    def get_color_state(self):
1107 1108 1109
        if self.color_state == theme.COLOR_TAB_NORMAL or\
                self.color_state == theme.COLOR_TAB_CURRENT:
            return self.color_state
1110 1111 1112
        return theme.COLOR_TAB_PRIVATE

    def set_color_state(self, color):
1113
        self.color_state = color
1114 1115

    def get_name(self):
1116
        return self._name
1117 1118

    def on_input(self, key):
1119 1120
        if key in self.key_func:
            self.key_func[key]()
1121
            return False
1122
        self.input.do_command(key)
1123
        return False
1124 1125

    def on_lose_focus(self):
1126
        self.set_color_state(theme.COLOR_TAB_NORMAL)
1127 1128
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator()
1129 1130

    def on_gain_focus(self):
1131 1132
        self.set_color_state(theme.COLOR_TAB_CURRENT)
        curses.curs_set(1)
1133 1134

    def on_scroll_up(self):
1135
        self.text_win.scroll_up(self.text_win.height-1)
1136 1137

    def on_scroll_down(self):
1138
        self.text_win.scroll_down(self.text_win.height-1)
1139

1140
    def on_info_win_size_changed(self):
1141 1142 1143
        self.text_win.resize(self.height-3-self.core.information_win_size, self.width, 0, 0, self.core.stdscr)
        self.info_header.resize(1, self.width, self.height-3-self.core.information_win_size, 0, self.core.stdscr)
        self.info_win.resize(self.core.information_win_size, self.width, self.height-2-self.core.information_win_size, 0, self.core.stdscr)
1144 1145