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, override
 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    @override
 25    def __del__(self) -> None:
 26        bui.set_party_window_open(False)
 27        super().__del__()
 28
 29    def __init__(self, origin: Sequence[float] = (0, 0)):
 30        bui.set_party_window_open(True)
 31        self._r = 'partyWindow'
 32        self._popup_type: str | None = None
 33        self._popup_party_member_client_id: int | None = None
 34        self._popup_party_member_is_host: bool | None = None
 35        self._width = 500
 36        assert bui.app.classic is not None
 37        uiscale = bui.app.ui_v1.uiscale
 38        self._height = (
 39            365
 40            if uiscale is bui.UIScale.SMALL
 41            else 480 if uiscale is bui.UIScale.MEDIUM else 600
 42        )
 43        self._display_old_msgs = True
 44        super().__init__(
 45            root_widget=bui.containerwidget(
 46                size=(self._width, self._height),
 47                transition='in_scale',
 48                color=(0.40, 0.55, 0.20),
 49                parent=bui.get_special_widget('overlay_stack'),
 50                on_outside_click_call=self.close_with_sound,
 51                scale_origin_stack_offset=origin,
 52                scale=(
 53                    1.8
 54                    if uiscale is bui.UIScale.SMALL
 55                    else 1.3 if uiscale is bui.UIScale.MEDIUM else 0.9
 56                ),
 57                stack_offset=(
 58                    (200, -10)
 59                    if uiscale is bui.UIScale.SMALL
 60                    else (
 61                        (260, 0) if uiscale is bui.UIScale.MEDIUM else (370, 60)
 62                    )
 63                ),
 64            ),
 65            # We exist in the overlay stack so main-windows being
 66            # recreated doesn't affect us.
 67            prevent_main_window_auto_recreate=False,
 68        )
 69
 70        self._cancel_button = bui.buttonwidget(
 71            parent=self._root_widget,
 72            scale=0.7,
 73            position=(30, self._height - 47),
 74            size=(50, 50),
 75            label='',
 76            on_activate_call=self.close,
 77            autoselect=True,
 78            color=(0.45, 0.63, 0.15),
 79            icon=bui.gettexture('crossOut'),
 80            iconscale=1.2,
 81        )
 82        bui.containerwidget(
 83            edit=self._root_widget, cancel_button=self._cancel_button
 84        )
 85
 86        self._menu_button = bui.buttonwidget(
 87            parent=self._root_widget,
 88            scale=0.7,
 89            position=(self._width - 60, self._height - 47),
 90            size=(50, 50),
 91            label='...',
 92            autoselect=True,
 93            button_type='square',
 94            on_activate_call=bui.WeakCall(self._on_menu_button_press),
 95            color=(0.55, 0.73, 0.25),
 96            iconscale=1.2,
 97        )
 98
 99        info = bs.get_connection_to_host_info_2()
100
101        if info is not None and info.name != '':
102            title = bui.Lstr(value=info.name)
103        else:
104            title = bui.Lstr(resource=f'{self._r}.titleText')
105
106        self._title_text = bui.textwidget(
107            parent=self._root_widget,
108            scale=0.9,
109            color=(0.5, 0.7, 0.5),
110            text=title,
111            size=(0, 0),
112            position=(self._width * 0.5, self._height - 29),
113            maxwidth=self._width * 0.7,
114            h_align='center',
115            v_align='center',
116        )
117
118        self._empty_str = bui.textwidget(
119            parent=self._root_widget,
120            scale=0.6,
121            size=(0, 0),
122            # color=(0.5, 1.0, 0.5),
123            shadow=0.3,
124            position=(self._width * 0.5, self._height - 57),
125            maxwidth=self._width * 0.85,
126            h_align='center',
127            v_align='center',
128        )
129        self._empty_str_2 = bui.textwidget(
130            parent=self._root_widget,
131            scale=0.5,
132            size=(0, 0),
133            color=(0.5, 1.0, 0.5),
134            shadow=0.1,
135            position=(self._width * 0.5, self._height - 75),
136            maxwidth=self._width * 0.85,
137            h_align='center',
138            v_align='center',
139        )
140
141        self._scroll_width = self._width - 50
142        self._scrollwidget = bui.scrollwidget(
143            parent=self._root_widget,
144            size=(self._scroll_width, self._height - 200),
145            position=(30, 80),
146            color=(0.4, 0.6, 0.3),
147            border_opacity=0.6,
148        )
149        self._columnwidget = bui.columnwidget(
150            parent=self._scrollwidget, border=2, left_border=-200, margin=0
151        )
152        bui.widget(edit=self._menu_button, down_widget=self._columnwidget)
153
154        self._muted_text = bui.textwidget(
155            parent=self._root_widget,
156            position=(self._width * 0.5, self._height * 0.5),
157            size=(0, 0),
158            h_align='center',
159            v_align='center',
160            text=bui.Lstr(resource='chatMutedText'),
161        )
162        self._chat_texts: list[bui.Widget] = []
163
164        self._text_field = txt = bui.textwidget(
165            parent=self._root_widget,
166            editable=True,
167            size=(530, 40),
168            position=(44, 39),
169            text='',
170            maxwidth=494,
171            shadow=0.3,
172            flatness=1.0,
173            description=bui.Lstr(resource=f'{self._r}.chatMessageText'),
174            autoselect=True,
175            v_align='center',
176            corner_scale=0.7,
177        )
178
179        bui.widget(
180            edit=self._scrollwidget,
181            autoselect=True,
182            left_widget=self._cancel_button,
183            up_widget=self._cancel_button,
184            down_widget=self._text_field,
185        )
186        bui.widget(
187            edit=self._columnwidget,
188            autoselect=True,
189            up_widget=self._cancel_button,
190            down_widget=self._text_field,
191        )
192        bui.containerwidget(edit=self._root_widget, selected_child=txt)
193
194        btn = bui.buttonwidget(
195            parent=self._root_widget,
196            size=(50, 35),
197            label=bui.Lstr(resource=f'{self._r}.sendText'),
198            button_type='square',
199            autoselect=True,
200            position=(self._width - 70, 35),
201            on_activate_call=self._send_chat_message,
202        )
203
204        bui.textwidget(edit=txt, on_return_press_call=btn.activate)
205        self._name_widgets: list[bui.Widget] = []
206        self._roster: list[dict[str, Any]] | None = None
207        self._update_timer = bui.AppTimer(
208            1.0, bui.WeakCall(self._update), repeat=True
209        )
210        self._update()
211
212    def on_chat_message(self, msg: str) -> None:
213        """Called when a new chat message comes through."""
214        if not bui.app.config.resolve('Chat Muted'):
215            self._add_msg(msg)
216
217    def _add_msg(self, msg: str) -> None:
218        txt = bui.textwidget(
219            parent=self._columnwidget,
220            h_align='left',
221            v_align='center',
222            scale=0.55,
223            size=(900, 13),
224            text=msg,
225            autoselect=True,
226            maxwidth=self._scroll_width * 0.94,
227            shadow=0.3,
228            flatness=1.0,
229            on_activate_call=bui.Call(self._copy_msg, msg),
230            selectable=True,
231        )
232
233        self._chat_texts.append(txt)
234        while len(self._chat_texts) > 40:
235            self._chat_texts.pop(0).delete()
236        bui.containerwidget(edit=self._columnwidget, visible_child=txt)
237
238    def _copy_msg(self, msg: str) -> None:
239        if bui.clipboard_is_supported():
240            bui.clipboard_set_text(msg)
241            bui.screenmessage(
242                bui.Lstr(resource='copyConfirmText'), color=(0, 1, 0)
243            )
244
245    def _on_menu_button_press(self) -> None:
246        is_muted = bui.app.config.resolve('Chat Muted')
247        assert bui.app.classic is not None
248        uiscale = bui.app.ui_v1.uiscale
249
250        choices: list[str] = ['unmute' if is_muted else 'mute']
251        choices_display: list[bui.Lstr] = [
252            bui.Lstr(resource='chatUnMuteText' if is_muted else 'chatMuteText')
253        ]
254
255        # Allow the 'Add to Favorites' option only if we're actually
256        # connected to a party and if it doesn't seem to be a private
257        # party (those are dynamically assigned addresses and ports so
258        # it makes no sense to save them).
259        server_info = bs.get_connection_to_host_info_2()
260        if server_info is not None and not server_info.name.startswith(
261            'Private Party '
262        ):
263            choices.append('add_to_favorites')
264            choices_display.append(bui.Lstr(resource='addToFavoritesText'))
265
266        PopupMenuWindow(
267            position=self._menu_button.get_screen_space_center(),
268            scale=(
269                2.3
270                if uiscale is bui.UIScale.SMALL
271                else 1.65 if uiscale is bui.UIScale.MEDIUM else 1.23
272            ),
273            choices=choices,
274            choices_display=choices_display,
275            current_choice='unmute' if is_muted else 'mute',
276            delegate=self,
277        )
278        self._popup_type = 'menu'
279
280    def _update(self) -> None:
281        # pylint: disable=too-many-locals
282        # pylint: disable=too-many-branches
283        # pylint: disable=too-many-statements
284        # pylint: disable=too-many-nested-blocks
285
286        # update muted state
287        if bui.app.config.resolve('Chat Muted'):
288            bui.textwidget(edit=self._muted_text, color=(1, 1, 1, 0.3))
289            # clear any chat texts we're showing
290            if self._chat_texts:
291                while self._chat_texts:
292                    first = self._chat_texts.pop()
293                    first.delete()
294        else:
295            bui.textwidget(edit=self._muted_text, color=(1, 1, 1, 0.0))
296            # add all existing messages if chat is not muted
297            if self._display_old_msgs:
298                msgs = bs.get_chat_messages()
299                for msg in msgs:
300                    self._add_msg(msg)
301                self._display_old_msgs = False
302
303        # update roster section
304        roster = bs.get_game_roster()
305        if roster != self._roster:
306            self._roster = roster
307
308            # clear out old
309            for widget in self._name_widgets:
310                widget.delete()
311            self._name_widgets = []
312            if not self._roster:
313                top_section_height = 60
314                bui.textwidget(
315                    edit=self._empty_str,
316                    text=bui.Lstr(resource=f'{self._r}.emptyText'),
317                )
318                bui.textwidget(
319                    edit=self._empty_str_2,
320                    text=bui.Lstr(resource='gatherWindow.descriptionShortText'),
321                )
322                bui.scrollwidget(
323                    edit=self._scrollwidget,
324                    size=(
325                        self._width - 50,
326                        self._height - top_section_height - 110,
327                    ),
328                    position=(30, 80),
329                )
330            else:
331                columns = (
332                    1
333                    if len(self._roster) == 1
334                    else 2 if len(self._roster) == 2 else 3
335                )
336                rows = int(math.ceil(float(len(self._roster)) / columns))
337                c_width = (self._width * 0.9) / max(3, columns)
338                c_width_total = c_width * columns
339                c_height = 24
340                c_height_total = c_height * rows
341                for y in range(rows):
342                    for x in range(columns):
343                        index = y * columns + x
344                        if index < len(self._roster):
345                            t_scale = 0.65
346                            pos = (
347                                self._width * 0.53
348                                - c_width_total * 0.5
349                                + c_width * x
350                                - 23,
351                                self._height - 65 - c_height * y - 15,
352                            )
353
354                            # if there are players present for this client, use
355                            # their names as a display string instead of the
356                            # client spec-string
357                            try:
358                                if self._roster[index]['players']:
359                                    # if there's just one, use the full name;
360                                    # otherwise combine short names
361                                    if len(self._roster[index]['players']) == 1:
362                                        p_str = self._roster[index]['players'][
363                                            0
364                                        ]['name_full']
365                                    else:
366                                        p_str = '/'.join(
367                                            [
368                                                entry['name']
369                                                for entry in self._roster[
370                                                    index
371                                                ]['players']
372                                            ]
373                                        )
374                                        if len(p_str) > 25:
375                                            p_str = p_str[:25] + '...'
376                                else:
377                                    p_str = self._roster[index][
378                                        'display_string'
379                                    ]
380                            except Exception:
381                                logging.exception(
382                                    'Error calcing client name str.'
383                                )
384                                p_str = '???'
385
386                            widget = bui.textwidget(
387                                parent=self._root_widget,
388                                position=(pos[0], pos[1]),
389                                scale=t_scale,
390                                size=(c_width * 0.85, 30),
391                                maxwidth=c_width * 0.85,
392                                color=(1, 1, 1) if index == 0 else (1, 1, 1),
393                                selectable=True,
394                                autoselect=True,
395                                click_activate=True,
396                                text=bui.Lstr(value=p_str),
397                                h_align='left',
398                                v_align='center',
399                            )
400                            self._name_widgets.append(widget)
401
402                            # in newer versions client_id will be present and
403                            # we can use that to determine who the host is.
404                            # in older versions we assume the first client is
405                            # host
406                            if self._roster[index]['client_id'] is not None:
407                                is_host = self._roster[index]['client_id'] == -1
408                            else:
409                                is_host = index == 0
410
411                            # FIXME: Should pass client_id to these sort of
412                            #  calls; not spec-string (perhaps should wait till
413                            #  client_id is more readily available though).
414                            bui.textwidget(
415                                edit=widget,
416                                on_activate_call=bui.Call(
417                                    self._on_party_member_press,
418                                    self._roster[index]['client_id'],
419                                    is_host,
420                                    widget,
421                                ),
422                            )
423                            pos = (
424                                self._width * 0.53
425                                - c_width_total * 0.5
426                                + c_width * x,
427                                self._height - 65 - c_height * y,
428                            )
429
430                            # Make the assumption that the first roster
431                            # entry is the server.
432                            # FIXME: Shouldn't do this.
433                            if is_host:
434                                twd = min(
435                                    c_width * 0.85,
436                                    bui.get_string_width(
437                                        p_str, suppress_warning=True
438                                    )
439                                    * t_scale,
440                                )
441                                self._name_widgets.append(
442                                    bui.textwidget(
443                                        parent=self._root_widget,
444                                        position=(
445                                            pos[0] + twd + 1,
446                                            pos[1] - 0.5,
447                                        ),
448                                        size=(0, 0),
449                                        h_align='left',
450                                        v_align='center',
451                                        maxwidth=c_width * 0.96 - twd,
452                                        color=(0.1, 1, 0.1, 0.5),
453                                        text=bui.Lstr(
454                                            resource=f'{self._r}.hostText'
455                                        ),
456                                        scale=0.4,
457                                        shadow=0.1,
458                                        flatness=1.0,
459                                    )
460                                )
461                bui.textwidget(edit=self._empty_str, text='')
462                bui.textwidget(edit=self._empty_str_2, text='')
463                bui.scrollwidget(
464                    edit=self._scrollwidget,
465                    size=(
466                        self._width - 50,
467                        max(100, self._height - 139 - c_height_total),
468                    ),
469                    position=(30, 80),
470                )
471
472    def popup_menu_selected_choice(
473        self, popup_window: PopupMenuWindow, choice: str
474    ) -> None:
475        """Called when a choice is selected in the popup."""
476        del popup_window  # unused
477        if self._popup_type == 'partyMemberPress':
478            if self._popup_party_member_is_host:
479                bui.getsound('error').play()
480                bui.screenmessage(
481                    bui.Lstr(resource='internal.cantKickHostError'),
482                    color=(1, 0, 0),
483                )
484            else:
485                assert self._popup_party_member_client_id is not None
486
487                # Ban for 5 minutes.
488                result = bs.disconnect_client(
489                    self._popup_party_member_client_id, ban_time=5 * 60
490                )
491                if not result:
492                    bui.getsound('error').play()
493                    bui.screenmessage(
494                        bui.Lstr(resource='getTicketsWindow.unavailableText'),
495                        color=(1, 0, 0),
496                    )
497        elif self._popup_type == 'menu':
498            if choice in ('mute', 'unmute'):
499                cfg = bui.app.config
500                cfg['Chat Muted'] = choice == 'mute'
501                cfg.apply_and_commit()
502                self._display_old_msgs = True
503                self._update()
504            if choice == 'add_to_favorites':
505                info = bs.get_connection_to_host_info_2()
506                if info is not None:
507                    self._add_to_favorites(
508                        name=info.name,
509                        address=info.address,
510                        port_num=info.port,
511                    )
512                else:
513                    # We should not allow the user to see this option
514                    # if they aren't in a server; this is our bad.
515                    bui.screenmessage(
516                        bui.Lstr(resource='errorText'), color=(1, 0, 0)
517                    )
518                    bui.getsound('error').play()
519        else:
520            print(f'unhandled popup type: {self._popup_type}')
521
522    def _add_to_favorites(
523        self, name: str, address: str | None, port_num: int | None
524    ) -> None:
525        addr = address
526        if addr == '':
527            bui.screenmessage(
528                bui.Lstr(resource='internal.invalidAddressErrorText'),
529                color=(1, 0, 0),
530            )
531            bui.getsound('error').play()
532            return
533        port = port_num if port_num is not None else -1
534        if port > 65535 or port < 0:
535            bui.screenmessage(
536                bui.Lstr(resource='internal.invalidPortErrorText'),
537                color=(1, 0, 0),
538            )
539            bui.getsound('error').play()
540            return
541
542        # Avoid empty names.
543        if not name:
544            name = f'{addr}@{port}'
545
546        config = bui.app.config
547
548        if addr:
549            if not isinstance(config.get('Saved Servers'), dict):
550                config['Saved Servers'] = {}
551            config['Saved Servers'][f'{addr}@{port}'] = {
552                'addr': addr,
553                'port': port,
554                'name': name,
555            }
556            config.commit()
557            bui.getsound('gunCocking').play()
558            bui.screenmessage(
559                bui.Lstr(
560                    resource='addedToFavoritesText', subs=[('${NAME}', name)]
561                ),
562                color=(0, 1, 0),
563            )
564        else:
565            bui.screenmessage(
566                bui.Lstr(resource='internal.invalidAddressErrorText'),
567                color=(1, 0, 0),
568            )
569            bui.getsound('error').play()
570
571    def popup_menu_closing(self, popup_window: PopupWindow) -> None:
572        """Called when the popup is closing."""
573
574    def _on_party_member_press(
575        self, client_id: int, is_host: bool, widget: bui.Widget
576    ) -> None:
577        # if we're the host, pop up 'kick' options for all non-host members
578        if bs.get_foreground_host_session() is not None:
579            kick_str = bui.Lstr(resource='kickText')
580        else:
581            # kick-votes appeared in build 14248
582            info = bs.get_connection_to_host_info_2()
583            if info is None or info.build_number < 14248:
584                return
585            kick_str = bui.Lstr(resource='kickVoteText')
586        assert bui.app.classic is not None
587        uiscale = bui.app.ui_v1.uiscale
588        PopupMenuWindow(
589            position=widget.get_screen_space_center(),
590            scale=(
591                2.3
592                if uiscale is bui.UIScale.SMALL
593                else 1.65 if uiscale is bui.UIScale.MEDIUM else 1.23
594            ),
595            choices=['kick'],
596            choices_display=[kick_str],
597            current_choice='kick',
598            delegate=self,
599        )
600        self._popup_type = 'partyMemberPress'
601        self._popup_party_member_client_id = client_id
602        self._popup_party_member_is_host = is_host
603
604    def _send_chat_message(self) -> None:
605        text = cast(str, bui.textwidget(query=self._text_field)).strip()
606        if text != '':
607            bs.chatmessage(text)
608            bui.textwidget(edit=self._text_field, text='')
609
610    def close(self) -> None:
611        """Close the window."""
612        # no-op if our underlying widget is dead or on its way out.
613        if not self._root_widget or self._root_widget.transitioning_out:
614            return
615
616        bui.containerwidget(edit=self._root_widget, transition='out_scale')
617
618    def close_with_sound(self) -> None:
619        """Close the window and make a lovely sound."""
620        # no-op if our underlying widget is dead or on its way out.
621        if not self._root_widget or self._root_widget.transitioning_out:
622            return
623
624        bui.getsound('swish').play()
625        self.close()