tabs.py 47.5 KB
Newer Older
1
# Copyright 2010-2011 Le Coz Florent <louiz@louiz.org>
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
#
# This file is part of Poezio.
#
# Poezio is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 3 of the License.
#
# Poezio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Poezio.  If not, see <http://www.gnu.org/licenses/>.

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

MIN_WIDTH = 50
26
MIN_HEIGHT = 16
27

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

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

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

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

class Tab(object):
    number = 0

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    def last_words_completion(self):
        """
        Complete the input with words recently said
        """
        # build the list of the recent words
louiz’'s avatar
louiz’ committed
234
        char_we_dont_want = string.punctuation+' '
235 236 237 238
        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()
249
        if not self.execute_command(txt):
250 251 252
            self.command_say(txt)

    def command_say(self, line):
253 254
        raise NotImplementedError

255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
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)
277 278
        if not self.visible:
            return
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
        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

309 310 311
    def on_enter(self):
        self.execute_command(self.input_enter_key())

312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
    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

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

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
    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]
398
            i += 1
399
        self.text_win.rebuild_everything(self.get_room())
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 529 530 531
        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)

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

550
    def refresh(self, tabs, informations, _):
551 552
        if not self.visible:
            return
553 554 555 556
        self.topic_win.refresh(self._room.topic)
        self.text_win.refresh(self._room)
        self.v_separator.refresh()
        self.user_win.refresh(self._room.users)
557
        self.info_header.refresh(self._room, self.text_win)
558
        self.tab_win.refresh(tabs, tabs[0])
559
        self.info_win.refresh(informations)
560 561 562
        self.input.refresh()

    def on_input(self, key):
563 564
        if key in self.key_func:
            self.key_func[key]()
565 566 567
            return False
        self.input.do_command(key)
        return False
568 569 570 571 572

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

    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

596 597 598
    def get_text_window(self):
        return self.text_win

599 600 601 602 603
    def get_room(self):
        return self._room

    def on_lose_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_NORMAL)
604 605
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator()
606 607 608

    def on_gain_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_CURRENT)
609
        if self.text_win.built_lines and self.text_win.built_lines[-1] is None:
610
            self.text_win.remove_line_separator()
611
        curses.curs_set(1)
612 613

    def on_scroll_up(self):
614
        self.text_win.scroll_up(self.text_win.height-1)
615 616

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

619
    def on_info_win_size_changed(self):
620
        text_width = (self.width//10)*9
621 622 623
        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)
624

625
    def just_before_refresh(self):
626
        return
627

628 629 630
    def on_close(self):
        return

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

652 653 654
    def completion(self):
        self.complete_commands(self.input)

655 656 657 658 659 660 661 662 663 664
    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()

665 666
    def resize(self):
        Tab.resize(self)
667 668
        if not self.visible:
            return
669
        self.text_win.resize(self.height-3-self.core.information_win_size, self.width, 0, 0, self.core.stdscr)
670
        self.text_win.rebuild_everything(self._room)
671
        self.info_header.resize(1, self.width, self.height-3-self.core.information_win_size, 0, self.core.stdscr)
672
        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)
673 674
        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)
675

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

    def on_lose_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_NORMAL)
706 707
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator()
708 709 710

    def on_gain_focus(self):
        self._room.set_color_state(theme.COLOR_TAB_CURRENT)
711
        curses.curs_set(1)
712 713

    def on_scroll_up(self):
714
        self.text_win.scroll_up(self.text_win.height-1)
715 716

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

719
    def on_info_win_size_changed(self):
720 721
        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)
722
        self.info_win.resize(self.core.information_win_size, self.width, self.height-2-self.core.information_win_size, 0, self.core.stdscr, None)
723 724 725

    def get_room(self):
        return self._room
726

727 728 729
    def get_text_window(self):
        return self.text_win

730 731 732
    def just_before_refresh(self):
        return

733 734 735
    def on_close(self):
        return

736 737
class RosterInfoTab(Tab):
    """
738
    A tab, splitted in two, containing the roster and infos
739
    """
740 741
    def __init__(self, core):
        Tab.__init__(self, core)
742
        self.name = "Roster"
743 744 745
        self.v_separator = windows.VerticalSeparator()
        self.tab_win = windows.GlobalInfoBar()
        self.info_win = windows.TextWin()
746
        self.core.information_buffer.add_window(self.info_win)
747 748 749
        self.roster_win = windows.RosterWin()
        self.contact_info_win = windows.ContactInfoWin()
        self.default_help_message = windows.HelpText("Enter commands with “/”. “o”: toggle offline show")
750
        self.input = self.default_help_message
751
        self.set_color_state(theme.COLOR_TAB_NORMAL)
752 753 754 755 756 757 758 759 760
        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
761 762
        self.key_func["s"] = self.start_search
        self.key_func["S"] = self.start_search_slow
763
        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
764 765 766
        self.commands['accept'] = (self.command_accept, _("Usage: /accept [jid]\nAccept: Use this command to authorize the provided JID (or the selected contact in your roster), to see your presence, and to ask to subscribe to it (mutual presence subscription)."), self.completion_deny)
        self.commands['add'] = (self.command_add, _("Usage: /add <jid>\Add: Use this command to add the specified JID to your roster. The reverse authorization will automatically be accepted if the remote JID accepts your subscription, leading to a mutual presence subscription."), None)
        self.commands['remove'] = (self.command_remove, _("Usage: /remove [jid]\Remove: Use this command to remove the specified JID from your roster. This wil unsubscribe you from its presence, cancel its subscription to yours, and remove the item from your roster"), self.completion_remove)
767
        self.resize()
768

769 770
    def resize(self):
        Tab.resize(self)
771 772
        if not self.visible:
            return
773 774
        roster_width = self.width//2
        info_width = self.width-roster_width-1
775 776
        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)
777 778 779
        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)
780
        self.input.resize(1, self.width, self.height-1, 0, self.core.stdscr)
781

782 783 784 785 786
    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)
787

788 789 790 791
    def command_deny(self, args):
        """
        Denies a JID from our roster
        """
louiz’'s avatar
louiz’ committed
792 793 794 795 796 797 798 799 800
        args = args.split()
        if not args:
            item = self.roster_win.selected_row
            if isinstance(item, Contact) and item.get_ask() == 'asked':
                jid = item.get_bare_jid()
            else:
                self.core.information('No subscription to deny')
                return
        else:
louiz’'s avatar
louiz’ committed
801
            jid = JID(args[0]).bare
louiz’'s avatar
louiz’ committed
802 803 804 805
        self.core.xmpp.sendPresence(pto=jid, ptype='unsubscribed')
        if self.core.xmpp.update_roster(jid, subscription='remove'):
            roster.remove_contact(jid)

louiz’'s avatar
louiz’ committed
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840
    def command_add(self, args):
        """
        Add the specified JID to the roster, and set automatically
        accept the reverse subscription
        """
        jid = JID(args.strip()).bare
        if not jid:
            return
        self.core.xmpp.sendPresence(pto=jid, ptype='subscribe')

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

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

louiz’'s avatar
louiz’ committed
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
    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')

867
    def refresh(self, tabs, informations, roster):
868 869
        if not self.visible:
            return
870
        self.v_separator.refresh()
871
        self.roster_win.refresh(roster)
872
        self.contact_info_win.refresh(self.roster_win.get_selected_row())
873
        # self.core.global_information_win.refresh(informations)
874 875 876 877 878 879 880 881 882 883 884 885 886 887
        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):
888 889
        res = self.input.do_command(key)
        if res:
890
            return True
891 892
        if key in self.key_func:
            return self.key_func[key]()
893 894 895 896 897 898 899 900 901 902 903

    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
904

905 906 907 908 909
    def on_slash(self):
        """
        '/' is pressed, we enter "input mode"
        """
        curses.curs_set(1)
910 911
        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)
912 913 914 915 916 917 918 919 920
        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('/'):
921
            self.execute_command(txt)
922
        return self.reset_help_message()
923 924 925 926 927 928

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

    def on_gain_focus(self):
        self._color_state = theme.COLOR_TAB_CURRENT
929 930 931 932
        if isinstance(self.input, windows.HelpText):
            curses.curs_set(0)
        else:
            curses.curs_set(1)
933 934 935 936

    def add_message(self):
        return False

937
    def move_cursor_down(self):
938
        self.roster_win.move_cursor_down()
939
        return True
940

941
    def move_cursor_up(self):
942
        self.roster_win.move_cursor_up()
943 944 945 946 947 948 949 950 951
        return True

    def on_scroll_down(self):
        # Scroll info win
        pass

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

953
    def on_info_win_size_changed(self):
954 955
        pass

956 957 958 959 960 961
    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
962

963
    def on_enter(self):
964
        selected_row = self.roster_win.get_selected_row()
965
        self.core.on_roster_enter_key(selected_row)
966
        return selected_row
967

968 969 970 971 972 973
    def start_search(self):
        """
        Start the search. The input should appear with a short instruction
        in it.
        """
        curses.curs_set(1)
974 975
        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)
976 977
        return True

978 979 980 981 982 983 984 985 986 987 988
    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

989 990
    def set_roster_filter(self, txt):
        roster._contact_filter = (jid_and_name_match, txt)
991 992
        self.roster_win.refresh(roster)
        return False
993

994 995 996
    def on_search_terminate(self, txt):
        curses.curs_set(0)
        roster._contact_filter = None
997
        self.reset_help_message()
998
        return False
999

1000 1001 1002
    def just_before_refresh(self):
        return

1003 1004 1005
    def on_close(self):
        return

1006
class ConversationTab(ChatTab):
1007
    """
1008
    The tab containg a normal conversation (not from a MUC)
1009
    """
1010
    def __init__(self, core, jid):
1011 1012
        txt_buff = text_buffer.TextBuffer()
        ChatTab.__init__(self, core, txt_buff)
1013 1014
        self.color_state = theme.COLOR_TAB_NORMAL
        self._name = jid        # a conversation tab is linked to one specific full jid OR bare jid
1015
        self.text_win = windows.TextWin()
1016
        txt_buff.add_window(self.text_win)
1017 1018 1019
        self.upper_bar = windows.ConversationStatusMessageWin()
        self.info_header = windows.ConversationInfoWin()
        self.info_win = windows.TextWin()
1020
        self.core.information_buffer.add_window(self.info_win)
1021 1022
        self.tab_win = windows.GlobalInfoBar()
        self.input = windows.MessageInput()
1023 1024 1025 1026 1027 1028
        # 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)
1029
        self.resize()
1030

1031 1032 1033
    def completion(self):
        self.complete_commands(self.input)

1034 1035 1036 1037 1038 1039 1040
    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()

1041 1042
    def resize(self):
        Tab.resize(self)
1043 1044
        if not self.visible:
            return
1045
        self.text_win.resize(self.height-4-self.core.information_win_size, self.width, 1, 0, self.core.stdscr)
1046
        self.text_win.rebuild_everything(self._room)
1047 1048
        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)
1049
        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)
1050 1051
        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)
1052

1053
    def refresh(self, tabs, informations, roster):
1054 1055
        if not self.visible:
            return
1056
        self.text_win.refresh(self._room)
1057
        self.upper_bar.refresh(self.get_name(), roster.get_contact_by_jid(self.get_name()))
1058
        self.info_header.refresh(self.get_name(), roster.get_contact_by_jid(self.get_name()), self._room, self.text_win)
1059 1060 1061 1062 1063
        self.info_win.refresh(informations)
        self.tab_win.refresh(tabs, tabs[0])
        self.input.refresh()

    def get_color_state(self):
1064 1065 1066
        if self.color_state == theme.COLOR_TAB_NORMAL or\
                self.color_state == theme.COLOR_TAB_CURRENT:
            return self.color_state
1067 1068 1069
        return theme.COLOR_TAB_PRIVATE

    def set_color_state(self, color):
1070
        self.color_state = color
1071 1072

    def get_name(self):
1073
        return self._name
1074 1075

    def on_input(self, key):
1076 1077
        if key in self.key_func:
            self.key_func[key]()
1078
            return False
1079
        self.input.do_command(key)
1080
        return False
1081 1082

    def on_lose_focus(self):
1083
        self.set_color_state(theme.COLOR_TAB_NORMAL)
1084 1085
        self.text_win.remove_line_separator()
        self.text_win.add_line_separator()
1086 1087

    def on_gain_focus(self):
1088 1089
        self.set_color_state(theme.COLOR_TAB_CURRENT)
        curses.curs_set(1)
1090 1091

    def on_scroll_up(self):
1092
        self.text_win.scroll_up(self.text_win.height-1)
1093 1094

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

1097
    def on_info_win_size_changed(self):
1098 1099 1100
        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)
1101 1102

    def get_room(self):
1103
        return self._room
1104

1105 1106 1107
    def get_text_window(self):
        return self.text_win

1108 1109
    def just_before_refresh(self):
        return
1110

1111 1112 1113
    def on_close(self):
        return

1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
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()
1124
        self.upper_message.set_message('Chatroom list on server %s (Loading)' % self.name)
1125 1126 1127 1128
        columns = ('node-part','name', 'users')
        self.list_header = windows.ColumnHeaderWin(columns)
        self.listview = windows.ListWin(columns)
        self.tab_win = windows.GlobalInfoBar()
1129
        self.default_help_message = windows.HelpText("“j”: join room.")
1130 1131 1132 1133 1134 1135
        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
1136 1137
        self.key_func['^J'] = self.join_selected
        self.key_func['^M'] = self.join_selected
1138 1139 1140
        self.resize()

    def refresh(self, tabs, informations, roster):
1141 1142
        if not self.visible:
            return
1143
        self.upper_message.refresh()
1144 1145 1146 1147 1148 1149 1150
        self.list_header.refresh()
        self.listview.refresh()
        self.tab_win.refresh(tabs, tabs[0])
        self.input.refresh()

    def resize(self):
        Tab.resize(self)
louiz’'s avatar <