bauiv1lib.party

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides party related UI."""
  4
  5from __future__ import annotations
  6
  7import math
  8import logging
  9from typing import TYPE_CHECKING, cast
 10
 11import bauiv1 as bui
 12import bascenev1 as bs
 13from bauiv1lib.popup import PopupMenuWindow
 14
 15if TYPE_CHECKING:
 16    from typing import Sequence, Any
 17
 18    from bauiv1lib.popup import PopupWindow
 19
 20
 21class PartyWindow(bui.Window):
 22    """Party list/chat window."""
 23
 24    def __del__(self) -> None:
 25        bui.set_party_window_open(False)
 26
 27    def __init__(self, origin: Sequence[float] = (0, 0)):
 28        bui.set_party_window_open(True)
 29        self._r = 'partyWindow'
 30        self._popup_type: str | None = None
 31        self._popup_party_member_client_id: int | None = None
 32        self._popup_party_member_is_host: bool | None = None
 33        self._width = 500
 34        assert bui.app.classic is not None
 35        uiscale = bui.app.ui_v1.uiscale
 36        self._height = (
 37            365
 38            if uiscale is bui.UIScale.SMALL
 39            else 480
 40            if uiscale is bui.UIScale.MEDIUM
 41            else 600
 42        )
 43        super().__init__(
 44            root_widget=bui.containerwidget(
 45                size=(self._width, self._height),
 46                transition='in_scale',
 47                color=(0.40, 0.55, 0.20),
 48                parent=bui.get_special_widget('overlay_stack'),
 49                on_outside_click_call=self.close_with_sound,
 50                scale_origin_stack_offset=origin,
 51                scale=(
 52                    2.0
 53                    if uiscale is bui.UIScale.SMALL
 54                    else 1.35
 55                    if uiscale is bui.UIScale.MEDIUM
 56                    else 1.0
 57                ),
 58                stack_offset=(0, -10)
 59                if uiscale is bui.UIScale.SMALL
 60                else (240, 0)
 61                if uiscale is bui.UIScale.MEDIUM
 62                else (330, 20),
 63            )
 64        )
 65
 66        self._cancel_button = bui.buttonwidget(
 67            parent=self._root_widget,
 68            scale=0.7,
 69            position=(30, self._height - 47),
 70            size=(50, 50),
 71            label='',
 72            on_activate_call=self.close,
 73            autoselect=True,
 74            color=(0.45, 0.63, 0.15),
 75            icon=bui.gettexture('crossOut'),
 76            iconscale=1.2,
 77        )
 78        bui.containerwidget(
 79            edit=self._root_widget, cancel_button=self._cancel_button
 80        )
 81
 82        self._menu_button = bui.buttonwidget(
 83            parent=self._root_widget,
 84            scale=0.7,
 85            position=(self._width - 60, self._height - 47),
 86            size=(50, 50),
 87            label='...',
 88            autoselect=True,
 89            button_type='square',
 90            on_activate_call=bui.WeakCall(self._on_menu_button_press),
 91            color=(0.55, 0.73, 0.25),
 92            iconscale=1.2,
 93        )
 94
 95        info = bs.get_connection_to_host_info()
 96        if info.get('name', '') != '':
 97            title = bui.Lstr(value=info['name'])
 98        else:
 99            title = bui.Lstr(resource=self._r + '.titleText')
100
101        self._title_text = bui.textwidget(
102            parent=self._root_widget,
103            scale=0.9,
104            color=(0.5, 0.7, 0.5),
105            text=title,
106            size=(0, 0),
107            position=(self._width * 0.5, self._height - 29),
108            maxwidth=self._width * 0.7,
109            h_align='center',
110            v_align='center',
111        )
112
113        self._empty_str = bui.textwidget(
114            parent=self._root_widget,
115            scale=0.75,
116            size=(0, 0),
117            position=(self._width * 0.5, self._height - 65),
118            maxwidth=self._width * 0.85,
119            h_align='center',
120            v_align='center',
121        )
122
123        self._scroll_width = self._width - 50
124        self._scrollwidget = bui.scrollwidget(
125            parent=self._root_widget,
126            size=(self._scroll_width, self._height - 200),
127            position=(30, 80),
128            color=(0.4, 0.6, 0.3),
129        )
130        self._columnwidget = bui.columnwidget(
131            parent=self._scrollwidget, border=2, left_border=-200, margin=0
132        )
133        bui.widget(edit=self._menu_button, down_widget=self._columnwidget)
134
135        self._muted_text = bui.textwidget(
136            parent=self._root_widget,
137            position=(self._width * 0.5, self._height * 0.5),
138            size=(0, 0),
139            h_align='center',
140            v_align='center',
141            text=bui.Lstr(resource='chatMutedText'),
142        )
143        self._chat_texts: list[bui.Widget] = []
144
145        # add all existing messages if chat is not muted
146        if not bui.app.config.resolve('Chat Muted'):
147            msgs = bs.get_chat_messages()
148            for msg in msgs:
149                self._add_msg(msg)
150
151        self._text_field = txt = bui.textwidget(
152            parent=self._root_widget,
153            editable=True,
154            size=(530, 40),
155            position=(44, 39),
156            text='',
157            maxwidth=494,
158            shadow=0.3,
159            flatness=1.0,
160            description=bui.Lstr(resource=self._r + '.chatMessageText'),
161            autoselect=True,
162            v_align='center',
163            corner_scale=0.7,
164        )
165
166        bui.widget(
167            edit=self._scrollwidget,
168            autoselect=True,
169            left_widget=self._cancel_button,
170            up_widget=self._cancel_button,
171            down_widget=self._text_field,
172        )
173        bui.widget(
174            edit=self._columnwidget,
175            autoselect=True,
176            up_widget=self._cancel_button,
177            down_widget=self._text_field,
178        )
179        bui.containerwidget(edit=self._root_widget, selected_child=txt)
180
181        btn = bui.buttonwidget(
182            parent=self._root_widget,
183            size=(50, 35),
184            label=bui.Lstr(resource=self._r + '.sendText'),
185            button_type='square',
186            autoselect=True,
187            position=(self._width - 70, 35),
188            on_activate_call=self._send_chat_message,
189        )
190
191        bui.textwidget(edit=txt, on_return_press_call=btn.activate)
192        self._name_widgets: list[bui.Widget] = []
193        self._roster: list[dict[str, Any]] | None = None
194        self._update_timer = bui.AppTimer(
195            1.0, bui.WeakCall(self._update), repeat=True
196        )
197        self._update()
198
199    def on_chat_message(self, msg: str) -> None:
200        """Called when a new chat message comes through."""
201        if not bui.app.config.resolve('Chat Muted'):
202            self._add_msg(msg)
203
204    def _add_msg(self, msg: str) -> None:
205        txt = bui.textwidget(
206            parent=self._columnwidget,
207            h_align='left',
208            v_align='center',
209            scale=0.55,
210            size=(900, 13),
211            text=msg,
212            autoselect=True,
213            maxwidth=self._scroll_width * 0.94,
214            shadow=0.3,
215            flatness=1.0,
216            on_activate_call=bui.Call(self._copy_msg, msg),
217            selectable=True,
218        )
219
220        self._chat_texts.append(txt)
221        while len(self._chat_texts) > 40:
222            self._chat_texts.pop(0).delete()
223        bui.containerwidget(edit=self._columnwidget, visible_child=txt)
224
225    def _copy_msg(self, msg: str) -> None:
226        if bui.clipboard_is_supported():
227            bui.clipboard_set_text(msg)
228            bui.screenmessage(
229                bui.Lstr(resource='copyConfirmText'), color=(0, 1, 0)
230            )
231
232    def _on_menu_button_press(self) -> None:
233        is_muted = bui.app.config.resolve('Chat Muted')
234        assert bui.app.classic is not None
235        uiscale = bui.app.ui_v1.uiscale
236        PopupMenuWindow(
237            position=self._menu_button.get_screen_space_center(),
238            scale=(
239                2.3
240                if uiscale is bui.UIScale.SMALL
241                else 1.65
242                if uiscale is bui.UIScale.MEDIUM
243                else 1.23
244            ),
245            choices=['unmute' if is_muted else 'mute'],
246            choices_display=[
247                bui.Lstr(
248                    resource='chatUnMuteText' if is_muted else 'chatMuteText'
249                )
250            ],
251            current_choice='unmute' if is_muted else 'mute',
252            delegate=self,
253        )
254        self._popup_type = 'menu'
255
256    def _update(self) -> None:
257        # pylint: disable=too-many-locals
258        # pylint: disable=too-many-branches
259        # pylint: disable=too-many-statements
260        # pylint: disable=too-many-nested-blocks
261
262        # update muted state
263        if bui.app.config.resolve('Chat Muted'):
264            bui.textwidget(edit=self._muted_text, color=(1, 1, 1, 0.3))
265            # clear any chat texts we're showing
266            if self._chat_texts:
267                while self._chat_texts:
268                    first = self._chat_texts.pop()
269                    first.delete()
270        else:
271            bui.textwidget(edit=self._muted_text, color=(1, 1, 1, 0.0))
272
273        # update roster section
274        roster = bs.get_game_roster()
275        if roster != self._roster:
276            self._roster = roster
277
278            # clear out old
279            for widget in self._name_widgets:
280                widget.delete()
281            self._name_widgets = []
282            if not self._roster:
283                top_section_height = 60
284                bui.textwidget(
285                    edit=self._empty_str,
286                    text=bui.Lstr(resource=self._r + '.emptyText'),
287                )
288                bui.scrollwidget(
289                    edit=self._scrollwidget,
290                    size=(
291                        self._width - 50,
292                        self._height - top_section_height - 110,
293                    ),
294                    position=(30, 80),
295                )
296            else:
297                columns = (
298                    1
299                    if len(self._roster) == 1
300                    else 2
301                    if len(self._roster) == 2
302                    else 3
303                )
304                rows = int(math.ceil(float(len(self._roster)) / columns))
305                c_width = (self._width * 0.9) / max(3, columns)
306                c_width_total = c_width * columns
307                c_height = 24
308                c_height_total = c_height * rows
309                for y in range(rows):
310                    for x in range(columns):
311                        index = y * columns + x
312                        if index < len(self._roster):
313                            t_scale = 0.65
314                            pos = (
315                                self._width * 0.53
316                                - c_width_total * 0.5
317                                + c_width * x
318                                - 23,
319                                self._height - 65 - c_height * y - 15,
320                            )
321
322                            # if there are players present for this client, use
323                            # their names as a display string instead of the
324                            # client spec-string
325                            try:
326                                if self._roster[index]['players']:
327                                    # if there's just one, use the full name;
328                                    # otherwise combine short names
329                                    if len(self._roster[index]['players']) == 1:
330                                        p_str = self._roster[index]['players'][
331                                            0
332                                        ]['name_full']
333                                    else:
334                                        p_str = '/'.join(
335                                            [
336                                                entry['name']
337                                                for entry in self._roster[
338                                                    index
339                                                ]['players']
340                                            ]
341                                        )
342                                        if len(p_str) > 25:
343                                            p_str = p_str[:25] + '...'
344                                else:
345                                    p_str = self._roster[index][
346                                        'display_string'
347                                    ]
348                            except Exception:
349                                logging.exception(
350                                    'Error calcing client name str.'
351                                )
352                                p_str = '???'
353
354                            widget = bui.textwidget(
355                                parent=self._root_widget,
356                                position=(pos[0], pos[1]),
357                                scale=t_scale,
358                                size=(c_width * 0.85, 30),
359                                maxwidth=c_width * 0.85,
360                                color=(1, 1, 1) if index == 0 else (1, 1, 1),
361                                selectable=True,
362                                autoselect=True,
363                                click_activate=True,
364                                text=bui.Lstr(value=p_str),
365                                h_align='left',
366                                v_align='center',
367                            )
368                            self._name_widgets.append(widget)
369
370                            # in newer versions client_id will be present and
371                            # we can use that to determine who the host is.
372                            # in older versions we assume the first client is
373                            # host
374                            if self._roster[index]['client_id'] is not None:
375                                is_host = self._roster[index]['client_id'] == -1
376                            else:
377                                is_host = index == 0
378
379                            # FIXME: Should pass client_id to these sort of
380                            #  calls; not spec-string (perhaps should wait till
381                            #  client_id is more readily available though).
382                            bui.textwidget(
383                                edit=widget,
384                                on_activate_call=bui.Call(
385                                    self._on_party_member_press,
386                                    self._roster[index]['client_id'],
387                                    is_host,
388                                    widget,
389                                ),
390                            )
391                            pos = (
392                                self._width * 0.53
393                                - c_width_total * 0.5
394                                + c_width * x,
395                                self._height - 65 - c_height * y,
396                            )
397
398                            # Make the assumption that the first roster
399                            # entry is the server.
400                            # FIXME: Shouldn't do this.
401                            if is_host:
402                                twd = min(
403                                    c_width * 0.85,
404                                    bui.get_string_width(
405                                        p_str, suppress_warning=True
406                                    )
407                                    * t_scale,
408                                )
409                                self._name_widgets.append(
410                                    bui.textwidget(
411                                        parent=self._root_widget,
412                                        position=(
413                                            pos[0] + twd + 1,
414                                            pos[1] - 0.5,
415                                        ),
416                                        size=(0, 0),
417                                        h_align='left',
418                                        v_align='center',
419                                        maxwidth=c_width * 0.96 - twd,
420                                        color=(0.1, 1, 0.1, 0.5),
421                                        text=bui.Lstr(
422                                            resource=self._r + '.hostText'
423                                        ),
424                                        scale=0.4,
425                                        shadow=0.1,
426                                        flatness=1.0,
427                                    )
428                                )
429                bui.textwidget(edit=self._empty_str, text='')
430                bui.scrollwidget(
431                    edit=self._scrollwidget,
432                    size=(
433                        self._width - 50,
434                        max(100, self._height - 139 - c_height_total),
435                    ),
436                    position=(30, 80),
437                )
438
439    def popup_menu_selected_choice(
440        self, popup_window: PopupMenuWindow, choice: str
441    ) -> None:
442        """Called when a choice is selected in the popup."""
443        del popup_window  # unused
444        if self._popup_type == 'partyMemberPress':
445            if self._popup_party_member_is_host:
446                bui.getsound('error').play()
447                bui.screenmessage(
448                    bui.Lstr(resource='internal.cantKickHostError'),
449                    color=(1, 0, 0),
450                )
451            else:
452                assert self._popup_party_member_client_id is not None
453
454                # Ban for 5 minutes.
455                result = bs.disconnect_client(
456                    self._popup_party_member_client_id, ban_time=5 * 60
457                )
458                if not result:
459                    bui.getsound('error').play()
460                    bui.screenmessage(
461                        bui.Lstr(resource='getTicketsWindow.unavailableText'),
462                        color=(1, 0, 0),
463                    )
464        elif self._popup_type == 'menu':
465            if choice in ('mute', 'unmute'):
466                cfg = bui.app.config
467                cfg['Chat Muted'] = choice == 'mute'
468                cfg.apply_and_commit()
469                self._update()
470        else:
471            print(f'unhandled popup type: {self._popup_type}')
472
473    def popup_menu_closing(self, popup_window: PopupWindow) -> None:
474        """Called when the popup is closing."""
475
476    def _on_party_member_press(
477        self, client_id: int, is_host: bool, widget: bui.Widget
478    ) -> None:
479        # if we're the host, pop up 'kick' options for all non-host members
480        if bs.get_foreground_host_session() is not None:
481            kick_str = bui.Lstr(resource='kickText')
482        else:
483            # kick-votes appeared in build 14248
484            if bs.get_connection_to_host_info().get('build_number', 0) < 14248:
485                return
486            kick_str = bui.Lstr(resource='kickVoteText')
487        assert bui.app.classic is not None
488        uiscale = bui.app.ui_v1.uiscale
489        PopupMenuWindow(
490            position=widget.get_screen_space_center(),
491            scale=(
492                2.3
493                if uiscale is bui.UIScale.SMALL
494                else 1.65
495                if uiscale is bui.UIScale.MEDIUM
496                else 1.23
497            ),
498            choices=['kick'],
499            choices_display=[kick_str],
500            current_choice='kick',
501            delegate=self,
502        )
503        self._popup_type = 'partyMemberPress'
504        self._popup_party_member_client_id = client_id
505        self._popup_party_member_is_host = is_host
506
507    def _send_chat_message(self) -> None:
508        bs.chatmessage(cast(str, bui.textwidget(query=self._text_field)))
509        bui.textwidget(edit=self._text_field, text='')
510
511    def close(self) -> None:
512        """Close the window."""
513        bui.containerwidget(edit=self._root_widget, transition='out_scale')
514
515    def close_with_sound(self) -> None:
516        """Close the window and make a lovely sound."""
517        bui.getsound('swish').play()
518        self.close()