tabs.py 45.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

louiz’'s avatar
louiz’ committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
    def on_enter(self, provided_text=None):
        """
        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

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

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

130 131 132 133
    def get_color_state(self):
        """
        returns the color that should be used in the GlobalInfoBar
        """
134
        return theme.COLOR_TAB_NORMAL
135 136 137 138 139

    def set_color_state(self, color):
        """
        set the color state
        """
140
        pass
141 142 143 144 145

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

148 149 150 151 152 153
    def get_text_window(self):
        """
        Returns the principal TextWin window, if there's one
        """
        return None

154
    def on_input(self, key):
155
        pass
156 157 158 159 160

    def on_lose_focus(self):
        """
        called when this tab loses the focus.
        """
161
        pass
162 163 164 165 166

    def on_gain_focus(self):
        """
        called when this tab gains the focus.
        """
167
        pass
168 169 170 171 172 173 174 175

    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
        """
176
        return False
177 178 179 180 181

    def on_scroll_down(self):
        """
        Defines what happens when we scrol down
        """
182
        pass
183 184 185 186 187

    def on_scroll_up(self):
        """
        Defines what happens when we scrol down
        """
188
        pass
189

190
    def on_info_win_size_changed(self):
191 192 193
        """
        Called when the window with the informations is resized
        """
194
        pass
195

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

204 205 206 207
    def on_close(self):
        """
        Called when the tab is to be closed
        """
208
        pass
209

210 211
class ChatTab(Tab):
    """
212 213 214
    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
215
    And also, add the /say command
216
    """
217 218 219 220 221 222 223
    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
224 225
        self.commands['say'] =  (self.command_say,
                                 _("""Usage: /say <message>\nSay: Just send the message.
226
                                        Useful if you want your message to begin with a '/'"""), None)
227 228 229 230 231 232 233 234 235 236 237 238

    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
239
            txt = msg.txt
240
            for char in char_we_dont_want:
241 242
                txt = txt.replace(char, ' ')
            for word in txt.split():
243 244
                if len(word) >= 4 and word not in words:
                    words.append(word)
245
        self.input.auto_completion(words, ' ')
246 247

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

    def command_say(self, line):
255 256
        raise NotImplementedError

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 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
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 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

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

366 367 368 369 370 371 372 373
    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()

374 375
    def command_cycle(self, arg):
        if self.get_room().joined:
376
            muc.leave_groupchat(self.core.xmpp, self.get_name(), self.get_room().own_nick, arg)
377
        self.get_room().joined = False
378
        self.core.command_join('/', "0")
379

380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
    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]
395
            i += 1
396
        self.text_win.rebuild_everything(self.get_room())
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 526 527 528
        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)

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

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

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

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

    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

591 592 593
    def get_text_window(self):
        return self.text_win

594 595 596 597 598
    def get_room(self):
        return self._room

    def on_lose_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_NORMAL)
599 600
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator()
601 602 603

    def on_gain_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_CURRENT)
604
        if self.text_win.built_lines and self.text_win.built_lines[-1] is None:
605
            self.text_win.remove_line_separator()
606
        curses.curs_set(1)
607 608

    def on_scroll_up(self):
609
        self.text_win.scroll_up(self.text_win.height-1)
610 611

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

614
    def on_info_win_size_changed(self):
615
        text_width = (self.width//10)*9
616 617 618
        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)
619

620
    def just_before_refresh(self):
621
        return
622

623 624 625
    def on_close(self):
        return

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

647 648 649
    def completion(self):
        self.complete_commands(self.input)

650 651 652 653 654 655 656 657 658 659
    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()

660 661
    def resize(self):
        Tab.resize(self)
662
        self.text_win.resize(self.height-3-self.core.information_win_size, self.width, 0, 0, self.core.stdscr)
663
        self.text_win.rebuild_everything(self._room)
664
        self.info_header.resize(1, self.width, self.height-3-self.core.information_win_size, 0, self.core.stdscr)
665
        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)
666 667
        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)
668

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

    def on_lose_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_NORMAL)
699 700
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator()
701 702 703

    def on_gain_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_CURRENT)
704
        curses.curs_set(1)
705 706

    def on_scroll_up(self):
707
        self.text_win.scroll_up(self.text_win.height-1)
708 709

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

712
    def on_info_win_size_changed(self):
713 714
        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)
715
        self.info_win.resize(self.core.information_win_size, self.width, self.height-2-self.core.information_win_size, 0, self.core.stdscr, None)
716 717 718

    def get_room(self):
        return self._room
719

720 721 722
    def get_text_window(self):
        return self.text_win

723 724 725
    def just_before_refresh(self):
        return

726 727 728
    def on_close(self):
        return

729 730
class RosterInfoTab(Tab):
    """
731
    A tab, splitted in two, containing the roster and infos
732
    """
733 734
    def __init__(self, core):
        Tab.__init__(self, core)
735
        self.name = "Roster"
736 737 738
        self.v_separator = windows.VerticalSeparator()
        self.tab_win = windows.GlobalInfoBar()
        self.info_win = windows.TextWin()
739
        self.core.information_buffer.add_window(self.info_win)
740 741 742
        self.roster_win = windows.RosterWin()
        self.contact_info_win = windows.ContactInfoWin()
        self.default_help_message = windows.HelpText("Enter commands with “/”. “o”: toggle offline show")
743
        self.input = self.default_help_message
744
        self.set_color_state(theme.COLOR_TAB_NORMAL)
745 746 747 748 749 750 751 752 753
        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
754 755
        self.key_func["s"] = self.start_search
        self.key_func["S"] = self.start_search_slow
756
        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
757
        self.commands['accept'] = (self.command_accept, _("Usage: /accpet [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)
758
        self.resize()
759

760 761
    def resize(self):
        Tab.resize(self)
762 763
        roster_width = self.width//2
        info_width = self.width-roster_width-1
764 765
        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)
766 767 768
        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)
769
        self.input.resize(1, self.width, self.height-1, 0, self.core.stdscr)
770

771 772 773 774 775
    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)
776

777 778 779 780
    def command_deny(self, args):
        """
        Denies a JID from our roster
        """
louiz’'s avatar
louiz’ committed
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820
        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='unsubscribed')
        if self.core.xmpp.update_roster(jid, subscription='remove'):
            roster.remove_contact(jid)

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

821
    def refresh(self, tabs, informations, roster):
822 823
        if not self.visible:
            return
824
        self.v_separator.refresh()
825
        self.roster_win.refresh(roster)
826
        self.contact_info_win.refresh(self.roster_win.get_selected_row())
827
        # self.core.global_information_win.refresh(informations)
828 829 830 831 832 833 834 835 836 837 838 839 840 841
        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):
842 843
        res = self.input.do_command(key)
        if res:
844
            return True
845 846
        if key in self.key_func:
            return self.key_func[key]()
847 848 849 850 851 852 853 854 855 856 857

    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
858

859 860 861 862 863
    def on_slash(self):
        """
        '/' is pressed, we enter "input mode"
        """
        curses.curs_set(1)
864 865
        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)
866 867 868 869 870 871 872 873 874
        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('/'):
louiz’'s avatar
louiz’ committed
875
            Tab.on_enter(self, txt)
876
        return self.reset_help_message()
877 878 879 880 881 882

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

    def on_gain_focus(self):
        self._color_state = theme.COLOR_TAB_CURRENT
883 884 885 886
        if isinstance(self.input, windows.HelpText):
            curses.curs_set(0)
        else:
            curses.curs_set(1)
887 888 889 890

    def add_message(self):
        return False

891
    def move_cursor_down(self):
892
        self.roster_win.move_cursor_down()
893
        return True
894

895
    def move_cursor_up(self):
896
        self.roster_win.move_cursor_up()
897 898 899 900 901 902 903 904 905
        return True

    def on_scroll_down(self):
        # Scroll info win
        pass

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

907
    def on_info_win_size_changed(self):
908 909
        pass

910 911 912 913 914 915
    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
916

917
    def on_enter(self):
918
        selected_row = self.roster_win.get_selected_row()
919
        self.core.on_roster_enter_key(selected_row)
920
        return selected_row
921

922 923 924 925 926 927
    def start_search(self):
        """
        Start the search. The input should appear with a short instruction
        in it.
        """
        curses.curs_set(1)
928 929
        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)
930 931
        return True

932 933 934 935 936 937 938 939 940 941 942
    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

943 944
    def set_roster_filter(self, txt):
        roster._contact_filter = (jid_and_name_match, txt)
945 946
        self.roster_win.refresh(roster)
        return False
947

948 949 950
    def on_search_terminate(self, txt):
        curses.curs_set(0)
        roster._contact_filter = None
951
        self.reset_help_message()
952
        return False
953

954 955 956
    def just_before_refresh(self):
        return

957 958 959
    def on_close(self):
        return

960
class ConversationTab(ChatTab):
961
    """
962
    The tab containg a normal conversation (not from a MUC)
963
    """
964
    def __init__(self, core, jid):
965 966
        txt_buff = text_buffer.TextBuffer()
        ChatTab.__init__(self, core, txt_buff)
967 968
        self.color_state = theme.COLOR_TAB_NORMAL
        self._name = jid        # a conversation tab is linked to one specific full jid OR bare jid
969
        self.text_win = windows.TextWin()
970
        txt_buff.add_window(self.text_win)
971 972 973
        self.upper_bar = windows.ConversationStatusMessageWin()
        self.info_header = windows.ConversationInfoWin()
        self.info_win = windows.TextWin()
974
        self.core.information_buffer.add_window(self.info_win)
975 976
        self.tab_win = windows.GlobalInfoBar()
        self.input = windows.MessageInput()
977 978 979 980 981 982
        # 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)
983
        self.resize()
984

985 986 987
    def completion(self):
        self.complete_commands(self.input)

988 989 990 991 992 993 994
    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()

995 996
    def resize(self):
        Tab.resize(self)
997
        self.text_win.resize(self.height-4-self.core.information_win_size, self.width, 1, 0, self.core.stdscr)
998
        self.text_win.rebuild_everything(self._room)
999 1000
        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)
1001
        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)
1002 1003
        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)
1004

1005
    def refresh(self, tabs, informations, roster):
1006 1007
        if not self.visible:
            return
1008
        self.text_win.refresh(self._room)
1009
        self.upper_bar.refresh(self.get_name(), roster.get_contact_by_jid(self.get_name()))
1010
        self.info_header.refresh(self.get_name(), roster.get_contact_by_jid(self.get_name()), self._room, self.text_win)
1011 1012 1013 1014 1015
        self.info_win.refresh(informations)
        self.tab_win.refresh(tabs, tabs[0])
        self.input.refresh()

    def get_color_state(self):
1016 1017 1018
        if self.color_state == theme.COLOR_TAB_NORMAL or\
                self.color_state == theme.COLOR_TAB_CURRENT:
            return self.color_state
1019 1020 1021
        return theme.COLOR_TAB_PRIVATE

    def set_color_state(self, color):
1022
        self.color_state = color
1023 1024

    def get_name(self):
1025
        return self._name
1026 1027

    def on_input(self, key):
1028 1029
        if key in self.key_func:
            self.key_func[key]()
1030
            return False
1031
        self.input.do_command(key)
1032
        return False
1033 1034

    def on_lose_focus(self):
1035
        self.set_color_state(theme.COLOR_TAB_NORMAL)
1036 1037
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator()
1038 1039

    def on_gain_focus(self):
1040 1041
        self.set_color_state(theme.COLOR_TAB_CURRENT)
        curses.curs_set(1)
1042 1043

    def on_scroll_up(self):
1044
        self.text_win.scroll_up(self.text_win.height-1)
1045 1046

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

1049
    def on_info_win_size_changed(self):
1050 1051 1052
        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)
1053 1054

    def get_room(self):
1055
        return self._room
1056

1057 1058 1059
    def get_text_window(self):
        return self.text_win

1060 1061
    def just_before_refresh(self):
        return
1062

1063 1064 1065
    def on_close(self):
        return

1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
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()
1076
        self.upper_message.set_message('Chatroom list on server %s (Loading)' % self.name)
1077 1078 1079 1080
        columns = ('node-part','name', 'users')
        self.list_header = windows.ColumnHeaderWin(columns)
        self.listview = windows.ListWin(columns)
        self.tab_win = windows.GlobalInfoBar()
1081
        self.default_help_message = windows.HelpText("“j”: join room.")
1082 1083 1084 1085 1086 1087
        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
1088 1089
        self.key_func['^J'] = self.join_selected
        self.key_func['^M'] = self.join_selected
1090 1091 1092
        self.resize()

    def refresh(self, tabs, informations, roster):
1093
        self.upper_message.refresh()
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
        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

1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
    def set_error(self, msg, code, body):
        """
        If there's an error (retrieving the values etc)
        """
        self._error_message = _('Error: %(code)s - %(msg)s: %(body)s') % {'msg':msg, 'body':body, 'code':code}
        self.upper_message.set_message(self._error_message)
        self.upper_message.refresh()
        curses.doupdate()

    def on_muc_list_item_received(self, iq):
        """
        Callback called when a disco#items result is received
        Used with command_list
        """
        log.debug('res: %s\n\n' % iq)
        if iq['type'] == 'error':
            self.set_error(iq['error']['type'], iq['error']['code'], iq['error']['text'])
            return
        items = [{'node-part':JID(item[0]).user,
                  'jid': item[0],
                  'name': item[2]} for item in iq['disco_items'].get_items()]
        self.listview.add_lines(items)
        self.upper_message.set_message('Chatroom list on server %s' % self.name)
        self.upper_message.refresh()
        curses.doupdate()

1150
    def join_selected(self):
1151 1152 1153 1154
        row = self.listview.get_selected_row()
        if not row:
            return
        self.core.command_join(row['jid'])
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165

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

1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
    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 =