tabs.py 36.8 KB
Newer Older
1
# Copyright 2010 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 40

from sleekxmpp.xmlstream.stanzabase import JID
41
from config import config
42
from roster import RosterGroup, roster
43
from contact import Contact, Resource
44
import multiuserchat as muc
45 46 47 48

class Tab(object):
    number = 0

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

62 63 64 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
    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
95

96 97
    def resize(self):
        self.size = (self.height, self.width) = self.core.stdscr.getmaxyx()
98 99 100 101 102
        if self.height < MIN_HEIGHT or self.width < MIN_WIDTH:
            self.visible = False
        else:
            self.visible = True

103 104 105 106 107 108
    def refresh(self, tabs, informations, roster):
        """
        Called on each screen refresh (when something has changed)
        """
        raise NotImplementedError

109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
    def get_color_state(self):
        """
        returns the color that should be used in the GlobalInfoBar
        """
        raise NotImplementedError

    def set_color_state(self, color):
        """
        set the color state
        """
        raise NotImplementedError

    def get_name(self):
        """
        get the name of the tab
        """
        raise NotImplementedError

    def on_input(self, key):
128
        pass
129 130 131 132 133

    def on_lose_focus(self):
        """
        called when this tab loses the focus.
        """
134
        pass
135 136 137 138 139

    def on_gain_focus(self):
        """
        called when this tab gains the focus.
        """
140
        pass
141 142 143 144 145 146 147 148

    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
        """
149
        return False
150 151 152 153 154

    def on_scroll_down(self):
        """
        Defines what happens when we scrol down
        """
155
        pass
156 157 158 159 160

    def on_scroll_up(self):
        """
        Defines what happens when we scrol down
        """
161
        pass
162

163
    def on_info_win_size_changed(self):
164 165 166
        """
        Called when the window with the informations is resized
        """
167
        pass
168

169 170 171 172 173 174
    def just_before_refresh(self):
        """
        Method called just before the screen refresh.
        Particularly useful to move the cursor at the
        correct position.
        """
175
        pass
176

177 178 179 180
    def on_close(self):
        """
        Called when the tab is to be closed
        """
181
        pass
182

183 184 185 186 187
class InfoTab(Tab):
    """
    The information tab, used to display global informations
    when using a anonymous account
    """
188 189
    def __init__(self, core, name):
        Tab.__init__(self, core)
190 191 192
        self.tab_win = windows.GlobalInfoBar()
        self.text_win = windows.TextWin()
        self.input = windows.Input()
193 194
        self.name = name
        self.color_state = theme.COLOR_TAB_NORMAL
195
        self.resize()
196

197 198
    def resize(self):
        Tab.resize(self)
199 200 201 202
        self.tab_win.resize(1, self.width, self.height-2, 0, self.core.stdscr)
        self.tab_win.resize(1, self.width, self.height-2, 0, self.core.stdscr)
        self.text_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)
203

204
    def refresh(self, tabs, informations, _):
205 206
        if not self.visible:
            return
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
        self.text_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):
        return

    def on_input(self, key):
        return self.input.do_command(key)

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

    def on_gain_focus(self):
        self.color_state = theme.COLOR_TAB_CURRENT
228
        curses.curs_set(0)
229 230 231 232 233 234 235

    def on_scroll_up(self):
        pass

    def on_scroll_down(self):
        pass

236
    def on_info_win_size_changed(self):
237 238
        return

239 240 241
    def just_before_refresh(self):
        return

242 243 244
    def on_close(self):
        return

245 246
class ChatTab(Tab):
    """
247 248 249
    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
250
    And also, add the /say command
251
    """
252 253 254 255 256 257 258
    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
259 260
        self.commands['say'] =  (self.command_say,
                                 _("""Usage: /say <message>\nSay: Just send the message.
261
                                        Useful if you want your message to begin with a '/'"""), None)
262 263 264 265 266 267 268 269 270 271 272 273

    def last_words_completion(self):
        """
        Complete the input with words recently said
        """
        # build the list of the recent words
        char_we_dont_want = [',', '(', ')', '.', '"', '\'', ' ', # The last one is nbsp
                             '’', '“', '”', ':', ';', '[', ']', '{', '}']
        words = list()
        for msg in self._room.messages[:-40:-1]:
            if not msg:
                continue
274
            txt = msg.txt
275
            for char in char_we_dont_want:
276 277
                txt = txt.replace(char, ' ')
            for word in txt.split():
278 279
                if len(word) >= 4 and word not in words:
                    words.append(word)
280
        self.input.auto_completion(words, ' ')
281 282

    def on_enter(self):
283 284 285 286 287 288 289 290 291 292 293 294
        txt = 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'))
        else:
295 296
            if txt.startswith('//'):
                txt = txt[1:]
297 298 299
            self.command_say(txt)

    def command_say(self, line):
300 301 302
        raise NotImplementedError

class MucTab(ChatTab):
303 304 305 306
    """
    The tab containing a multi-user-chat room.
    It contains an userlist, an input, a topic, an information and a chat zone
    """
307
    def __init__(self, core, room):
308
        ChatTab.__init__(self, core, room)
309 310 311 312 313 314 315 316
        self.topic_win = windows.Topic()
        self.text_win = windows.TextWin()
        self.v_separator = windows.VerticalSeparator()
        self.user_win = windows.UserList()
        self.info_header = windows.MucInfoWin()
        self.info_win = windows.TextWin()
        self.tab_win = windows.GlobalInfoBar()
        self.input = windows.MessageInput()
317 318
        self.ignores = []       # set of Users
        # keys
319 320
        self.key_func['^I'] = self.completion
        self.key_func['M-i'] = self.completion
321
        # commands
322 323 324 325 326 327 328 329
        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)
330
        self.resize()
331

332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 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
    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]
            i+= 1
        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)

480
    def resize(self):
481 482 483
        """
        Resize the whole window. i.e. all its sub-windows
        """
484
        Tab.resize(self)
485
        text_width = (self.width//10)*9
486 487 488 489 490 491 492 493
        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)
        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)
        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.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)
494

495
    def refresh(self, tabs, informations, _):
496 497
        if not self.visible:
            return
498 499 500 501 502 503 504 505 506 507
        self.topic_win.refresh(self._room.topic)
        self.text_win.refresh(self._room)
        self.v_separator.refresh()
        self.user_win.refresh(self._room.users)
        self.info_header.refresh(self._room)
        self.info_win.refresh(informations)
        self.tab_win.refresh(tabs, tabs[0])
        self.input.refresh()

    def on_input(self, key):
508 509
        if key in self.key_func:
            self.key_func[key]()
510 511 512
            return False
        self.input.do_command(key)
        return False
513 514 515 516 517

    def completion(self):
        """
        Called when Tab is pressed, complete the nickname in the input
        """
518 519
        if self.complete_commands(self.input):
            return
520
        compare_users = lambda x: x.last_talked
521 522 523 524 525 526 527 528
        word_list = [user.nick for user in sorted(self._room.users, key=compare_users, reverse=True)]
        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)
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544

    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

    def get_room(self):
        return self._room

    def on_lose_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_NORMAL)
        self._room.remove_line_separator()
545
        self._room.add_line_separator()
546 547 548

    def on_gain_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_CURRENT)
549
        curses.curs_set(1)
550 551 552 553 554 555 556

    def on_scroll_up(self):
        self._room.scroll_up(self.text_win.height-1)

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

557
    def on_info_win_size_changed(self):
558
        text_width = (self.width//10)*9
559 560 561
        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)
562

563
    def just_before_refresh(self):
564
        return
565

566 567 568
    def on_close(self):
        return

569
class PrivateTab(ChatTab):
570 571 572
    """
    The tab containg a private conversation (someone from a MUC)
    """
573
    def __init__(self, core, room):
574
        ChatTab.__init__(self, core, room)
575 576 577 578 579
        self.text_win = windows.TextWin()
        self.info_header = windows.PrivateInfoWin()
        self.info_win = windows.TextWin()
        self.tab_win = windows.GlobalInfoBar()
        self.input = windows.MessageInput()
580 581 582 583 584 585
        # 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)
586
        self.resize()
587

588 589 590
    def completion(self):
        self.complete_commands(self.input)

591 592 593 594 595 596 597 598 599 600
    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)

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

601 602
    def resize(self):
        Tab.resize(self)
603 604 605 606 607
        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)
        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)
608

609
    def refresh(self, tabs, informations, _):
610 611
        if not self.visible:
            return
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
        self.text_win.refresh(self._room)
        self.info_header.refresh(self._room)
        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):
631 632
        if key in self.key_func:
            self.key_func[key]()
633
            return False
634 635
        self.input.do_command(key)
        return False
636 637 638 639

    def on_lose_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_NORMAL)
        self._room.remove_line_separator()
640
        self._room.add_line_separator()
641 642 643

    def on_gain_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_CURRENT)
644
        curses.curs_set(1)
645 646 647 648 649 650 651

    def on_scroll_up(self):
        self._room.scroll_up(self.text_win.height-1)

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

652
    def on_info_win_size_changed(self):
653 654 655
        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)
656 657 658

    def get_room(self):
        return self._room
659

660 661 662
    def just_before_refresh(self):
        return

663 664 665
    def on_close(self):
        return

666 667
class RosterInfoTab(Tab):
    """
668
    A tab, splitted in two, containing the roster and infos
669
    """
670 671
    def __init__(self, core):
        Tab.__init__(self, core)
672
        self.name = "Roster"
673 674 675 676 677 678
        self.v_separator = windows.VerticalSeparator()
        self.tab_win = windows.GlobalInfoBar()
        self.info_win = windows.TextWin()
        self.roster_win = windows.RosterWin()
        self.contact_info_win = windows.ContactInfoWin()
        self.default_help_message = windows.HelpText("Enter commands with “/”. “o”: toggle offline show")
679
        self.input = self.default_help_message
680
        self.set_color_state(theme.COLOR_TAB_NORMAL)
681 682 683 684 685 686 687 688 689 690
        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
        self.key_func["^F"] = self.start_search
691
        self.resize()
692

693 694
    def resize(self):
        Tab.resize(self)
695 696
        roster_width = self.width//2
        info_width = self.width-roster_width-1
697 698 699 700 701 702
        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)
        self.info_win.resize(self.height-2, info_width, 0, roster_width+1, self.core.stdscr)
        self.roster_win.resize(self.height-2-3, roster_width, 0, 0, self.core.stdscr)
        self.contact_info_win.resize(3, roster_width, self.height-2-3, 0, self.core.stdscr)
        self.input.resize(1, self.width, self.height-1, 0, self.core.stdscr)
703

704 705 706 707 708 709
    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)

710
    def refresh(self, tabs, informations, roster):
711 712
        if not self.visible:
            return
713
        self.v_separator.refresh()
714
        self.roster_win.refresh(roster)
715
        self.contact_info_win.refresh(self.roster_win.get_selected_row())
716 717 718 719 720 721 722 723 724 725 726 727 728 729
        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):
730 731
        res = self.input.do_command(key)
        if res:
732
            return True
733 734
        if key in self.key_func:
            return self.key_func[key]()
735 736 737 738 739 740 741 742 743 744 745

    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
746

747 748 749 750 751
    def on_slash(self):
        """
        '/' is pressed, we enter "input mode"
        """
        curses.curs_set(1)
752 753
        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)
754 755 756 757 758 759 760 761 762 763 764
        self.input.do_command("/") # we add the slash

    def reset_help_message(self, _=None):
        curses.curs_set(0)
        self.input = self.default_help_message
        return True

    def execute_slash_command(self, txt):
        if txt.startswith('/'):
            self.core.execute(txt)
        return self.reset_help_message()
765 766 767 768 769 770

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

    def on_gain_focus(self):
        self._color_state = theme.COLOR_TAB_CURRENT
771
        curses.curs_set(0)
772 773 774 775

    def add_message(self):
        return False

776
    def move_cursor_down(self):
777
        self.roster_win.move_cursor_down()
778
        return True
779

780
    def move_cursor_up(self):
781
        self.roster_win.move_cursor_up()
782 783 784 785 786 787 788 789 790
        return True

    def on_scroll_down(self):
        # Scroll info win
        pass

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

792
    def on_info_win_size_changed(self):
793 794
        pass

795 796 797 798 799 800
    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
801

802
    def on_enter(self):
803
        selected_row = self.roster_win.get_selected_row()
804
        self.core.on_roster_enter_key(selected_row)
805
        return selected_row
806

807 808 809 810 811 812
    def start_search(self):
        """
        Start the search. The input should appear with a short instruction
        in it.
        """
        curses.curs_set(1)
813 814
        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)
815 816
        return True

817 818
    def set_roster_filter(self, txt):
        roster._contact_filter = (jid_and_name_match, txt)
819 820
        self.roster_win.refresh(roster)
        return False
821

822 823 824
    def on_search_terminate(self, txt):
        curses.curs_set(0)
        roster._contact_filter = None
825
        self.reset_help_message()
826
        return True
827

828 829 830
    def just_before_refresh(self):
        return

831 832 833
    def on_close(self):
        return

834
class ConversationTab(ChatTab):
835 836 837
    """
    The tab containg a normal conversation (someone from our roster)
    """
838
    def __init__(self, core, text_buffer, jid):
839
        ChatTab.__init__(self, core, text_buffer)
840 841
        self.color_state = theme.COLOR_TAB_NORMAL
        self._name = jid        # a conversation tab is linked to one specific full jid OR bare jid
842 843 844 845 846 847
        self.text_win = windows.TextWin()
        self.upper_bar = windows.ConversationStatusMessageWin()
        self.info_header = windows.ConversationInfoWin()
        self.info_win = windows.TextWin()
        self.tab_win = windows.GlobalInfoBar()
        self.input = windows.MessageInput()
848 849 850 851 852 853
        # 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)
854
        self.resize()
855

856 857 858
    def completion(self):
        self.complete_commands(self.input)

859 860 861 862 863 864 865 866 867 868
    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)

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

869 870
    def resize(self):
        Tab.resize(self)
871
        self.text_win.resize(self.height-3-self.core.information_win_size, self.width, 1, 0, self.core.stdscr)
872 873 874 875 876
        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)
        self.info_win.resize(self.core.information_win_size, self.width, self.height-2-self.core.information_win_size, 0, self.core.stdscr)
        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)
877

878
    def refresh(self, tabs, informations, roster):
879 880
        if not self.visible:
            return
881
        self.text_win.refresh(self._room)
882
        self.upper_bar.refresh(self.get_name(), roster.get_contact_by_jid(self.get_name()))
883
        self.info_header.refresh(self.get_name(), roster.get_contact_by_jid(self.get_name()), self._room)
884 885 886 887 888
        self.info_win.refresh(informations)
        self.tab_win.refresh(tabs, tabs[0])
        self.input.refresh()

    def get_color_state(self):
889 890 891
        if self.color_state == theme.COLOR_TAB_NORMAL or\
                self.color_state == theme.COLOR_TAB_CURRENT:
            return self.color_state
892 893 894
        return theme.COLOR_TAB_PRIVATE

    def set_color_state(self, color):
895
        self.color_state = color
896 897

    def get_name(self):
898
        return self._name
899 900

    def on_input(self, key):
901 902
        if key in self.key_func:
            self.key_func[key]()
903
            return False
904
        self.input.do_command(key)
905
        return False
906 907

    def on_lose_focus(self):
908
        self.set_color_state(theme.COLOR_TAB_NORMAL)
909 910
        self._room.remove_line_separator()
        self._room.add_line_separator()
911 912

    def on_gain_focus(self):
913 914
        self.set_color_state(theme.COLOR_TAB_CURRENT)
        curses.curs_set(1)
915 916

    def on_scroll_up(self):
917
        self._room.scroll_up(self.text_win.height-1)
918 919

    def on_scroll_down(self):
920
        self._room.scroll_down(self.text_win.height-1)
921

922
    def on_info_win_size_changed(self):
923 924 925
        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)
926 927

    def get_room(self):
928
        return self._room
929 930 931

    def just_before_refresh(self):
        return
932

933 934 935
    def on_close(self):
        return

936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
class MucListTab(Tab):
    """
    A tab listing rooms from a specific server, displaying various information,
    scrollable, and letting the user join them, etc
    """
    def __init__(self, core, server):
        Tab.__init__(self, core)
        self._color_state = theme.COLOR_TAB_NORMAL
        self.name = server
        self.upper_message = windows.Topic()
        columns = ('node-part','name', 'users')
        self.list_header = windows.ColumnHeaderWin(columns)
        self.listview = windows.ListWin(columns)
        self.tab_win = windows.GlobalInfoBar()
        self.default_help_message = windows.HelpText("“j”: join room. “i”: information")
        self.input = self.default_help_message
        self.key_func["KEY_DOWN"] = self.listview.move_cursor_down
        self.key_func["KEY_UP"] = self.listview.move_cursor_up
        self.key_func["/"] = self.on_slash
        self.key_func['j'] = self.join_selected
        self.key_func['J'] = self.join_selected_no_focus
        self.resize()

    def refresh(self, tabs, informations, roster):
        self.upper_message.refresh('Chatroom list on server %s' % self.name)
        self.list_header.refresh()
        self.listview.refresh()
        self.tab_win.refresh(tabs, tabs[0])
        self.input.refresh()

    def resize(self):
        Tab.resize(self)
        self.upper_message.resize(1, self.width, 0, 0, self.core.stdscr)
        column_size = {'node-part': (self.width-5)//4,
                       'name': (self.width-5)//4*3,
                       'users': 5}
        self.list_header.resize_columns(column_size)
        self.list_header.resize(1, self.width, 1, 0, self.core.stdscr)
        self.listview.resize_columns(column_size)
        self.listview.resize(self.height-4, self.width, 2, 0, self.core.stdscr)
        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)

    def on_slash(self):
        """
        '/' is pressed, activate the input
        """
        curses.curs_set(1)
        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)
        self.input.do_command("/") # we add the slash

    def join_selected_no_focus(self):
        return

    def join_selected(self):
        jid = self.listview.get_selected_row()['jid']
        self.core.command_join(jid)

    def reset_help_message(self, _=None):
        curses.curs_set(0)
        self.input = self.default_help_message
        return True

    def execute_slash_command(self, txt):
        if txt.startswith('/'):
            self.core.execute(txt)
        return self.reset_help_message()

    def get_color_state(self):
        return theme.COLOR_TAB_NORMAL

    def set_color_state(self, color):
        pass

    def get_name(self):
        return self.name

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

    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(0)

    def get_color_state(self):
        return self._color_state


1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
def diffmatch(search, string):
    """
    Use difflib and a loop to check if search_pattern can
    be 'almost' found INSIDE a string.
    'almost' being defined by difflib
    """
    l = len(search)
    ratio = 0.7
    for i in range(len(string) - l + 1):
        if difflib.SequenceMatcher(None, search, string[i:i+l]).ratio() >= ratio:
            return True
    return False

1045 1046 1047 1048 1049
def jid_and_name_match(contact, txt):
    """
    A function used to know if a contact in the roster should
    be shown in the roster
    """
1050 1051 1052 1053 1054 1055 1056
    ratio = 0.7
    if not txt:
        return True             # Everything matches when search is empty
    user = JID(contact.get_bare_jid()).user
    if diffmatch(txt, user):
        return True
    if contact.get_name() and diffmatch(txt, contact.get_name()):
1057 1058
        return True
    return False