tabs.py 41.3 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
40 41

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

class Tab(object):
    number = 0

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

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

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

110 111 112 113
    def get_color_state(self):
        """
        returns the color that should be used in the GlobalInfoBar
        """
114
        return theme.COLOR_TAB_NORMAL
115 116 117 118 119

    def set_color_state(self, color):
        """
        set the color state
        """
120
        pass
121 122 123 124 125

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

128 129 130 131 132 133
    def get_text_window(self):
        """
        Returns the principal TextWin window, if there's one
        """
        return None

134
    def on_input(self, key):
135
        pass
136 137 138 139 140

    def on_lose_focus(self):
        """
        called when this tab loses the focus.
        """
141
        pass
142 143 144 145 146

    def on_gain_focus(self):
        """
        called when this tab gains the focus.
        """
147
        pass
148 149 150 151 152 153 154 155

    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
        """
156
        return False
157 158 159 160 161

    def on_scroll_down(self):
        """
        Defines what happens when we scrol down
        """
162
        pass
163 164 165 166 167

    def on_scroll_up(self):
        """
        Defines what happens when we scrol down
        """
168
        pass
169

170
    def on_info_win_size_changed(self):
171 172 173
        """
        Called when the window with the informations is resized
        """
174
        pass
175

176 177 178 179 180 181
    def just_before_refresh(self):
        """
        Method called just before the screen refresh.
        Particularly useful to move the cursor at the
        correct position.
        """
182
        pass
183

184 185 186 187
    def on_close(self):
        """
        Called when the tab is to be closed
        """
188
        pass
189

190 191
class ChatTab(Tab):
    """
192 193 194
    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
195
    And also, add the /say command
196
    """
197 198 199 200 201 202 203
    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
204 205
        self.commands['say'] =  (self.command_say,
                                 _("""Usage: /say <message>\nSay: Just send the message.
206
                                        Useful if you want your message to begin with a '/'"""), None)
207 208 209 210 211 212 213 214 215 216 217 218

    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
219
            txt = msg.txt
220
            for char in char_we_dont_want:
221 222
                txt = txt.replace(char, ' ')
            for word in txt.split():
223 224
                if len(word) >= 4 and word not in words:
                    words.append(word)
225
        self.input.auto_completion(words, ' ')
226 227

    def on_enter(self):
228 229 230 231 232 233 234 235 236 237 238 239
        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:
240 241
            if txt.startswith('//'):
                txt = txt[1:]
242 243 244
            self.command_say(txt)

    def command_say(self, line):
245 246
        raise NotImplementedError

247 248 249 250 251 252 253 254 255 256 257 258 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)
        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 on_enter(self):
281
        # TODO duplicate
282 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 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
        txt = self.input.get_text()
        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'))

    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

    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

335
class MucTab(ChatTab):
336 337 338 339
    """
    The tab containing a multi-user-chat room.
    It contains an userlist, an input, a topic, an information and a chat zone
    """
340
    def __init__(self, core, room):
341
        ChatTab.__init__(self, core, room)
342 343
        self.topic_win = windows.Topic()
        self.text_win = windows.TextWin()
344
        room.add_window(self.text_win)
345 346 347 348
        self.v_separator = windows.VerticalSeparator()
        self.user_win = windows.UserList()
        self.info_header = windows.MucInfoWin()
        self.info_win = windows.TextWin()
349
        self.core.information_buffer.add_window(self.info_win)
350 351
        self.tab_win = windows.GlobalInfoBar()
        self.input = windows.MessageInput()
352 353
        self.ignores = []       # set of Users
        # keys
354 355
        self.key_func['^I'] = self.completion
        self.key_func['M-i'] = self.completion
356 357
        self.key_func['M-u'] = self.scroll_user_list_down
        self.key_func['M-y'] = self.scroll_user_list_up
358
        # commands
359 360 361 362 363 364 365 366
        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)
367
        self.resize()
368

369 370 371 372 373 374 375 376
    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()

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
    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
393
        self.text_win.rebuild_everything(self.get_room())
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 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
        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)

526
    def resize(self):
527 528 529
        """
        Resize the whole window. i.e. all its sub-windows
        """
530
        Tab.resize(self)
531
        text_width = (self.width//10)*9
532 533
        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)
534
        self.text_win.rebuild_everything(self._room)
535 536 537
        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)
538
        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)
539 540
        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)
541

542
    def refresh(self, tabs, informations, _):
543 544
        if not self.visible:
            return
545 546 547 548
        self.topic_win.refresh(self._room.topic)
        self.text_win.refresh(self._room)
        self.v_separator.refresh()
        self.user_win.refresh(self._room.users)
549
        self.info_header.refresh(self._room, self.text_win)
550
        self.tab_win.refresh(tabs, tabs[0])
551
        self.info_win.refresh(informations)
552 553 554
        self.input.refresh()

    def on_input(self, key):
555 556
        if key in self.key_func:
            self.key_func[key]()
557 558 559
            return False
        self.input.do_command(key)
        return False
560 561 562 563 564

    def completion(self):
        """
        Called when Tab is pressed, complete the nickname in the input
        """
565 566
        if self.complete_commands(self.input):
            return
567
        # If we are not completing a command or a command's argument, complete a nick
568
        compare_users = lambda x: x.last_talked
569 570
        word_list = [user.nick for user in sorted(self._room.users, key=compare_users, reverse=True)\
                         if user.nick != self._room.own_nick]
571 572 573 574 575 576 577
        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)
578 579 580 581 582 583 584 585 586 587

    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

588 589 590
    def get_text_window(self):
        return self.text_win

591 592 593 594 595
    def get_room(self):
        return self._room

    def on_lose_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_NORMAL)
596 597
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator()
598 599 600

    def on_gain_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_CURRENT)
601
        curses.curs_set(1)
602 603

    def on_scroll_up(self):
604
        self.text_win.scroll_up(self.text_win.height-1)
605 606

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

609
    def on_info_win_size_changed(self):
610
        text_width = (self.width//10)*9
611 612 613
        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)
614

615
    def just_before_refresh(self):
616
        return
617

618 619 620
    def on_close(self):
        return

621
class PrivateTab(ChatTab):
622 623 624
    """
    The tab containg a private conversation (someone from a MUC)
    """
625
    def __init__(self, core, room):
626
        ChatTab.__init__(self, core, room)
627
        self.text_win = windows.TextWin()
628
        room.add_window(self.text_win)
629 630
        self.info_header = windows.PrivateInfoWin()
        self.info_win = windows.TextWin()
631
        self.core.information_buffer.add_window(self.info_win)
632 633
        self.tab_win = windows.GlobalInfoBar()
        self.input = windows.MessageInput()
634 635 636 637 638 639
        # 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)
640
        self.resize()
641

642 643 644
    def completion(self):
        self.complete_commands(self.input)

645 646 647 648 649 650 651 652 653 654
    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()

655 656
    def resize(self):
        Tab.resize(self)
657
        self.text_win.resize(self.height-3-self.core.information_win_size, self.width, 0, 0, self.core.stdscr)
658
        self.text_win.rebuild_everything(self._room)
659
        self.info_header.resize(1, self.width, self.height-3-self.core.information_win_size, 0, self.core.stdscr)
660
        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)
661 662
        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)
663

664
    def refresh(self, tabs, informations, _):
665 666
        if not self.visible:
            return
667
        self.text_win.refresh(self._room)
668
        self.info_header.refresh(self._room, self.text_win)
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
        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):
686 687
        if key in self.key_func:
            self.key_func[key]()
688
            return False
689 690
        self.input.do_command(key)
        return False
691 692 693

    def on_lose_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_NORMAL)
694 695
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator()
696 697 698

    def on_gain_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_CURRENT)
699
        curses.curs_set(1)
700 701

    def on_scroll_up(self):
702
        self.text_win.scroll_up(self.text_win.height-1)
703 704

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

707
    def on_info_win_size_changed(self):
708 709
        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)
710
        self.info_win.resize(self.core.information_win_size, self.width, self.height-2-self.core.information_win_size, 0, self.core.stdscr, None)
711 712 713

    def get_room(self):
        return self._room
714

715 716 717
    def get_text_window(self):
        return self.text_win

718 719 720
    def just_before_refresh(self):
        return

721 722 723
    def on_close(self):
        return

724 725
class RosterInfoTab(Tab):
    """
726
    A tab, splitted in two, containing the roster and infos
727
    """
728 729
    def __init__(self, core):
        Tab.__init__(self, core)
730
        self.name = "Roster"
731 732 733
        self.v_separator = windows.VerticalSeparator()
        self.tab_win = windows.GlobalInfoBar()
        self.info_win = windows.TextWin()
734
        self.core.information_buffer.add_window(self.info_win)
735 736 737
        self.roster_win = windows.RosterWin()
        self.contact_info_win = windows.ContactInfoWin()
        self.default_help_message = windows.HelpText("Enter commands with “/”. “o”: toggle offline show")
738
        self.input = self.default_help_message
739
        self.set_color_state(theme.COLOR_TAB_NORMAL)
740 741 742 743 744 745 746 747 748 749
        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
750
        self.resize()
751

752 753
    def resize(self):
        Tab.resize(self)
754 755
        roster_width = self.width//2
        info_width = self.width-roster_width-1
756 757
        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)
758
        self.info_win.resize(self.height-2, info_width, 0, roster_width+1, self.core.stdscr, self.core.information_buffer)
759 760 761
        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)
762

763 764 765 766 767
    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)
768

769
    def refresh(self, tabs, informations, roster):
770 771
        if not self.visible:
            return
772
        self.v_separator.refresh()
773
        self.roster_win.refresh(roster)
774
        self.contact_info_win.refresh(self.roster_win.get_selected_row())
775
        # self.core.global_information_win.refresh(informations)
776 777 778 779 780 781 782 783 784 785 786 787 788 789
        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):
790 791
        res = self.input.do_command(key)
        if res:
792
            return True
793 794
        if key in self.key_func:
            return self.key_func[key]()
795 796 797 798 799 800 801 802 803 804 805

    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
806

807 808 809 810 811
    def on_slash(self):
        """
        '/' is pressed, we enter "input mode"
        """
        curses.curs_set(1)
812 813
        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)
814 815 816 817 818 819 820 821 822 823 824
        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()
825 826 827 828 829 830

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

    def on_gain_focus(self):
        self._color_state = theme.COLOR_TAB_CURRENT
831 832 833 834
        if isinstance(self.input, windows.HelpText):
            curses.curs_set(0)
        else:
            curses.curs_set(1)
835 836 837 838

    def add_message(self):
        return False

839
    def move_cursor_down(self):
840
        self.roster_win.move_cursor_down()
841
        return True
842

843
    def move_cursor_up(self):
844
        self.roster_win.move_cursor_up()
845 846 847 848 849 850 851 852 853
        return True

    def on_scroll_down(self):
        # Scroll info win
        pass

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

855
    def on_info_win_size_changed(self):
856 857
        pass

858 859 860 861 862 863
    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
864

865
    def on_enter(self):
866
        selected_row = self.roster_win.get_selected_row()
867
        self.core.on_roster_enter_key(selected_row)
868
        return selected_row
869

870 871 872 873 874 875
    def start_search(self):
        """
        Start the search. The input should appear with a short instruction
        in it.
        """
        curses.curs_set(1)
876 877
        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)
878 879
        return True

880 881
    def set_roster_filter(self, txt):
        roster._contact_filter = (jid_and_name_match, txt)
882 883
        self.roster_win.refresh(roster)
        return False
884

885 886 887
    def on_search_terminate(self, txt):
        curses.curs_set(0)
        roster._contact_filter = None
888
        self.reset_help_message()
889
        return False
890

891 892 893
    def just_before_refresh(self):
        return

894 895 896
    def on_close(self):
        return

897
class ConversationTab(ChatTab):
898
    """
899
    The tab containg a normal conversation (not from a MUC)
900
    """
901
    def __init__(self, core, jid):
902 903
        txt_buff = text_buffer.TextBuffer()
        ChatTab.__init__(self, core, txt_buff)
904 905
        self.color_state = theme.COLOR_TAB_NORMAL
        self._name = jid        # a conversation tab is linked to one specific full jid OR bare jid
906
        self.text_win = windows.TextWin()
907
        txt_buff.add_window(self.text_win)
908 909 910
        self.upper_bar = windows.ConversationStatusMessageWin()
        self.info_header = windows.ConversationInfoWin()
        self.info_win = windows.TextWin()
911
        self.core.information_buffer.add_window(self.info_win)
912 913
        self.tab_win = windows.GlobalInfoBar()
        self.input = windows.MessageInput()
914 915 916 917 918 919
        # 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)
920
        self.resize()
921

922 923 924
    def completion(self):
        self.complete_commands(self.input)

925 926 927 928 929 930 931
    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):
        self.core.close_tab()

932 933
    def resize(self):
        Tab.resize(self)
934
        self.text_win.resize(self.height-4-self.core.information_win_size, self.width, 1, 0, self.core.stdscr)
935
        self.text_win.rebuild_everything(self._room)
936 937
        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)
938
        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)
939 940
        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)
941

942
    def refresh(self, tabs, informations, roster):
943 944
        if not self.visible:
            return
945
        self.text_win.refresh(self._room)
946
        self.upper_bar.refresh(self.get_name(), roster.get_contact_by_jid(self.get_name()))
947
        self.info_header.refresh(self.get_name(), roster.get_contact_by_jid(self.get_name()), self._room, self.text_win)
948 949 950 951 952
        self.info_win.refresh(informations)
        self.tab_win.refresh(tabs, tabs[0])
        self.input.refresh()

    def get_color_state(self):
953 954 955
        if self.color_state == theme.COLOR_TAB_NORMAL or\
                self.color_state == theme.COLOR_TAB_CURRENT:
            return self.color_state
956 957 958
        return theme.COLOR_TAB_PRIVATE

    def set_color_state(self, color):
959
        self.color_state = color
960 961

    def get_name(self):
962
        return self._name
963 964

    def on_input(self, key):
965 966
        if key in self.key_func:
            self.key_func[key]()
967
            return False
968
        self.input.do_command(key)
969
        return False
970 971

    def on_lose_focus(self):
972
        self.set_color_state(theme.COLOR_TAB_NORMAL)
973 974
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator()
975 976

    def on_gain_focus(self):
977 978
        self.set_color_state(theme.COLOR_TAB_CURRENT)
        curses.curs_set(1)
979 980

    def on_scroll_up(self):
981
        self.text_win.scroll_up(self.text_win.height-1)
982 983

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

986
    def on_info_win_size_changed(self):
987 988 989
        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)
990 991

    def get_room(self):
992
        return self._room
993

994 995 996
    def get_text_window(self):
        return self.text_win

997 998
    def just_before_refresh(self):
        return
999

1000 1001 1002
    def on_close(self):
        return

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
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()
1017
        self.default_help_message = windows.HelpText("“j”: join room.")
1018 1019 1020 1021 1022 1023
        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
1024 1025
        self.key_func['^J'] = self.join_selected
        self.key_func['^M'] = self.join_selected
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
        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):
1061 1062 1063 1064
        row = self.listview.get_selected_row()
        if not row:
            return
        self.core.command_join(row['jid'])
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075

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

1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
    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)

1093
    def get_color_state(self):
1094
        return self._color_state
1095

1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
class SimpleTextTab(Tab):
    """
    A very simple tab, with just a text displaying some
    information or whatever.
    For example used to display tracebacks
    """
    def __init__(self, core, text):
        Tab.__init__(self, core)
        self._color_state = theme.COLOR_TAB_NORMAL
        self.text_win = windows.SimpleTextWin(text)
        self.tab_win = windows.GlobalInfoBar()
        self.default_help_message = windows.HelpText("“Ctrl+q”: close")
        self.input = self.default_help_message
        self.key_func['^T'] = self.close
        self.key_func["/"] = self.on_slash
        self.resize()
1112

1113 1114 1115 1116 1117 1118 1119 1120
    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
1121 1122 1123 1124 1125 1126 1127 1128

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

1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
    def close(self):
        self.core.close_tab()

    def resize(self):
        self.text_win.resize(self.height-2, self.width, 0, 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 refresh(self, tabs, information, roster):
        self.text_win.refresh()
        self.tab_win.refresh(tabs, tabs[0])
        self.input.refresh()

1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
    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

1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
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

1165 1166 1167 1168 1169
def jid_and_name_match(contact, txt):
    """
    A function used to know if a contact in the roster should
    be shown in the roster
    """
1170 1171 1172 1173 1174 1175 1176
    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()):
1177 1178
        return True
    return False