bauiv1lib.gather.manualtab

   1# Released under the MIT License. See LICENSE for details.
   2#
   3"""Defines the manual tab in the gather UI."""
   4# pylint: disable=too-many-lines
   5
   6from __future__ import annotations
   7
   8import logging
   9from enum import Enum
  10from threading import Thread
  11from dataclasses import dataclass
  12from typing import TYPE_CHECKING, cast, override
  13from bauiv1lib.gather import GatherTab
  14
  15import bauiv1 as bui
  16import bascenev1 as bs
  17
  18if TYPE_CHECKING:
  19    from typing import Any, Callable
  20
  21    from bauiv1lib.gather import GatherWindow
  22
  23
  24def _safe_set_text(
  25    txt: bui.Widget | None, val: str | bui.Lstr, success: bool = True
  26) -> None:
  27    if txt:
  28        bui.textwidget(
  29            edit=txt, text=val, color=(0, 1, 0) if success else (1, 1, 0)
  30        )
  31
  32
  33class _HostLookupThread(Thread):
  34    """Thread to fetch an addr."""
  35
  36    def __init__(
  37        self, name: str, port: int, call: Callable[[str | None, int], Any]
  38    ):
  39        super().__init__()
  40        self._name = name
  41        self._port = port
  42        self._call = call
  43
  44    @override
  45    def run(self) -> None:
  46        result: str | None
  47        try:
  48            import socket
  49
  50            aresult = [
  51                item[-1][0]
  52                for item in socket.getaddrinfo(self.name, self._port)
  53            ][0]
  54            if isinstance(aresult, int):
  55                raise RuntimeError('Unexpected getaddrinfo int result')
  56            result = aresult
  57        except Exception:
  58            # Hmm should we be logging this?
  59            result = None
  60        bui.pushcall(
  61            lambda: self._call(result, self._port), from_other_thread=True
  62        )
  63
  64
  65class SubTabType(Enum):
  66    """Available sub-tabs."""
  67
  68    JOIN_BY_ADDRESS = 'join_by_address'
  69    FAVORITES = 'favorites'
  70
  71
  72@dataclass
  73class State:
  74    """State saved/restored only while the app is running."""
  75
  76    sub_tab: SubTabType = SubTabType.JOIN_BY_ADDRESS
  77
  78
  79class ManualGatherTab(GatherTab):
  80    """The manual tab in the gather UI"""
  81
  82    def __init__(self, window: GatherWindow) -> None:
  83        super().__init__(window)
  84        self._check_button: bui.Widget | None = None
  85        self._doing_access_check: bool | None = None
  86        self._access_check_count: int | None = None
  87        self._sub_tab: SubTabType = SubTabType.JOIN_BY_ADDRESS
  88        self._t_addr: bui.Widget | None = None
  89        self._t_accessible: bui.Widget | None = None
  90        self._t_accessible_extra: bui.Widget | None = None
  91        self._access_check_timer: bui.AppTimer | None = None
  92        self._checking_state_text: bui.Widget | None = None
  93        self._container: bui.Widget | None = None
  94        self._join_by_address_text: bui.Widget | None = None
  95        self._favorites_text: bui.Widget | None = None
  96        self._width: float | None = None
  97        self._height: float | None = None
  98        self._scroll_width: float | None = None
  99        self._scroll_height: float | None = None
 100        self._favorites_scroll_width: int | None = None
 101        self._favorites_connect_button: bui.Widget | None = None
 102        self._scrollwidget: bui.Widget | None = None
 103        self._columnwidget: bui.Widget | None = None
 104        self._favorite_selected: str | None = None
 105        self._favorite_edit_window: bui.Widget | None = None
 106        self._party_edit_name_text: bui.Widget | None = None
 107        self._party_edit_addr_text: bui.Widget | None = None
 108        self._party_edit_port_text: bui.Widget | None = None
 109        self._no_parties_added_text: bui.Widget | None = None
 110
 111    @override
 112    def on_activate(
 113        self,
 114        parent_widget: bui.Widget,
 115        tab_button: bui.Widget,
 116        region_width: float,
 117        region_height: float,
 118        region_left: float,
 119        region_bottom: float,
 120    ) -> bui.Widget:
 121        # pylint: disable=too-many-positional-arguments
 122        c_width = region_width
 123        c_height = region_height - 20
 124
 125        self._container = bui.containerwidget(
 126            parent=parent_widget,
 127            position=(
 128                region_left,
 129                region_bottom + (region_height - c_height) * 0.5,
 130            ),
 131            size=(c_width, c_height),
 132            background=False,
 133            selection_loops_to_parent=True,
 134        )
 135        v = c_height - 30
 136        self._join_by_address_text = bui.textwidget(
 137            parent=self._container,
 138            position=(c_width * 0.5 - 245, v - 13),
 139            color=(0.6, 1.0, 0.6),
 140            scale=1.3,
 141            size=(200, 30),
 142            maxwidth=250,
 143            h_align='center',
 144            v_align='center',
 145            click_activate=True,
 146            selectable=True,
 147            autoselect=True,
 148            on_activate_call=lambda: self._set_sub_tab(
 149                SubTabType.JOIN_BY_ADDRESS,
 150                region_width,
 151                region_height,
 152                playsound=True,
 153            ),
 154            text=bui.Lstr(resource='gatherWindow.manualJoinSectionText'),
 155            glow_type='uniform',
 156        )
 157        self._favorites_text = bui.textwidget(
 158            parent=self._container,
 159            position=(c_width * 0.5 + 45, v - 13),
 160            color=(0.6, 1.0, 0.6),
 161            scale=1.3,
 162            size=(200, 30),
 163            maxwidth=250,
 164            h_align='center',
 165            v_align='center',
 166            click_activate=True,
 167            selectable=True,
 168            autoselect=True,
 169            on_activate_call=lambda: self._set_sub_tab(
 170                SubTabType.FAVORITES,
 171                region_width,
 172                region_height,
 173                playsound=True,
 174            ),
 175            text=bui.Lstr(resource='gatherWindow.favoritesText'),
 176            glow_type='uniform',
 177        )
 178        bui.widget(edit=self._join_by_address_text, up_widget=tab_button)
 179        bui.widget(
 180            edit=self._favorites_text,
 181            left_widget=self._join_by_address_text,
 182            up_widget=tab_button,
 183        )
 184        bui.widget(edit=tab_button, down_widget=self._favorites_text)
 185        bui.widget(
 186            edit=self._join_by_address_text, right_widget=self._favorites_text
 187        )
 188        self._set_sub_tab(self._sub_tab, region_width, region_height)
 189
 190        return self._container
 191
 192    @override
 193    def save_state(self) -> None:
 194        assert bui.app.classic is not None
 195        bui.app.ui_v1.window_states[type(self)] = State(sub_tab=self._sub_tab)
 196
 197    @override
 198    def restore_state(self) -> None:
 199        assert bui.app.classic is not None
 200        state = bui.app.ui_v1.window_states.get(type(self))
 201        if state is None:
 202            state = State()
 203        assert isinstance(state, State)
 204        self._sub_tab = state.sub_tab
 205
 206    def _set_sub_tab(
 207        self,
 208        value: SubTabType,
 209        region_width: float,
 210        region_height: float,
 211        playsound: bool = False,
 212    ) -> None:
 213        assert self._container
 214        if playsound:
 215            bui.getsound('click01').play()
 216
 217        self._sub_tab = value
 218        active_color = (0.6, 1.0, 0.6)
 219        inactive_color = (0.5, 0.4, 0.5)
 220        bui.textwidget(
 221            edit=self._join_by_address_text,
 222            color=(
 223                active_color
 224                if value is SubTabType.JOIN_BY_ADDRESS
 225                else inactive_color
 226            ),
 227        )
 228        bui.textwidget(
 229            edit=self._favorites_text,
 230            color=(
 231                active_color
 232                if value is SubTabType.FAVORITES
 233                else inactive_color
 234            ),
 235        )
 236
 237        # Clear anything existing in the old sub-tab.
 238        for widget in self._container.get_children():
 239            if widget and widget not in {
 240                self._favorites_text,
 241                self._join_by_address_text,
 242            }:
 243                widget.delete()
 244
 245        if value is SubTabType.JOIN_BY_ADDRESS:
 246            self._build_join_by_address_tab(region_width, region_height)
 247
 248        if value is SubTabType.FAVORITES:
 249            self._build_favorites_tab(region_width, region_height)
 250
 251    # The old manual tab
 252    def _build_join_by_address_tab(
 253        self, region_width: float, region_height: float
 254    ) -> None:
 255        c_width = region_width
 256        c_height = region_height - 20
 257        last_addr = bui.app.config.get('Last Manual Party Connect Address', '')
 258        last_port = bui.app.config.get('Last Manual Party Connect Port', 43210)
 259        v = c_height - 70
 260        v -= 70
 261        bui.textwidget(
 262            parent=self._container,
 263            position=(c_width * 0.5 - 260 - 50, v),
 264            color=(0.6, 1.0, 0.6),
 265            scale=1.0,
 266            size=(0, 0),
 267            maxwidth=130,
 268            h_align='right',
 269            v_align='center',
 270            text=bui.Lstr(resource='gatherWindow.' 'manualAddressText'),
 271        )
 272        txt = bui.textwidget(
 273            parent=self._container,
 274            editable=True,
 275            description=bui.Lstr(resource='gatherWindow.' 'manualAddressText'),
 276            position=(c_width * 0.5 - 240 - 50, v - 30),
 277            text=last_addr,
 278            autoselect=True,
 279            v_align='center',
 280            scale=1.0,
 281            maxwidth=380,
 282            size=(420, 60),
 283        )
 284        assert self._join_by_address_text is not None
 285        bui.widget(edit=self._join_by_address_text, down_widget=txt)
 286        assert self._favorites_text is not None
 287        bui.widget(edit=self._favorites_text, down_widget=txt)
 288        bui.textwidget(
 289            parent=self._container,
 290            position=(c_width * 0.5 - 260 + 490, v),
 291            color=(0.6, 1.0, 0.6),
 292            scale=1.0,
 293            size=(0, 0),
 294            maxwidth=80,
 295            h_align='right',
 296            v_align='center',
 297            text=bui.Lstr(resource='gatherWindow.' 'portText'),
 298        )
 299        txt2 = bui.textwidget(
 300            parent=self._container,
 301            editable=True,
 302            description=bui.Lstr(resource='gatherWindow.' 'portText'),
 303            text=str(last_port),
 304            autoselect=True,
 305            max_chars=5,
 306            position=(c_width * 0.5 - 240 + 490, v - 30),
 307            v_align='center',
 308            scale=1.0,
 309            size=(170, 60),
 310        )
 311
 312        v -= 110
 313
 314        btn = bui.buttonwidget(
 315            parent=self._container,
 316            size=(300, 70),
 317            label=bui.Lstr(resource='gatherWindow.' 'manualConnectText'),
 318            position=(c_width * 0.5 - 300, v),
 319            autoselect=True,
 320            on_activate_call=bui.Call(self._connect, txt, txt2),
 321        )
 322        savebutton = bui.buttonwidget(
 323            parent=self._container,
 324            size=(300, 70),
 325            label=bui.Lstr(resource='gatherWindow.favoritesSaveText'),
 326            position=(c_width * 0.5 - 240 + 490 - 200, v),
 327            autoselect=True,
 328            on_activate_call=bui.Call(self._save_server, txt, txt2),
 329        )
 330        bui.widget(edit=btn, right_widget=savebutton)
 331        bui.widget(edit=savebutton, left_widget=btn, up_widget=txt2)
 332        bui.textwidget(edit=txt, on_return_press_call=btn.activate)
 333        bui.textwidget(edit=txt2, on_return_press_call=btn.activate)
 334        v -= 45
 335
 336        self._check_button = bui.textwidget(
 337            parent=self._container,
 338            size=(250, 60),
 339            text=bui.Lstr(resource='gatherWindow.showMyAddressText'),
 340            v_align='center',
 341            h_align='center',
 342            click_activate=True,
 343            position=(c_width * 0.5 - 125, v - 30),
 344            autoselect=True,
 345            color=(0.5, 0.9, 0.5),
 346            scale=0.8,
 347            selectable=True,
 348            on_activate_call=bui.Call(
 349                self._on_show_my_address_button_press,
 350                v,
 351                self._container,
 352                c_width,
 353            ),
 354            glow_type='uniform',
 355        )
 356        bui.widget(edit=self._check_button, up_widget=btn)
 357
 358    # Tab containing saved favorite addresses
 359    def _build_favorites_tab(
 360        self, region_width: float, region_height: float
 361    ) -> None:
 362        c_height = region_height - 20
 363        v = c_height - 35 - 25 - 30
 364
 365        assert bui.app.classic is not None
 366        uiscale = bui.app.ui_v1.uiscale
 367        # self._width = 1240 if uiscale is bui.UIScale.SMALL else 1040
 368        self._width = region_width
 369        x_inset = 100 if uiscale is bui.UIScale.SMALL else 0
 370        self._height = (
 371            578
 372            if uiscale is bui.UIScale.SMALL
 373            else 670 if uiscale is bui.UIScale.MEDIUM else 800
 374        )
 375
 376        self._scroll_width = self._width - 130 + 2 * x_inset
 377        self._scroll_height = self._height - 180
 378        x_inset = 100 if uiscale is bui.UIScale.SMALL else 0
 379
 380        c_height = self._scroll_height - 20
 381        sub_scroll_height = c_height - 63
 382        self._favorites_scroll_width = sub_scroll_width = (
 383            680 if uiscale is bui.UIScale.SMALL else 640
 384        )
 385
 386        v = c_height - 30
 387
 388        b_width = 140 if uiscale is bui.UIScale.SMALL else 178
 389        b_height = (
 390            107
 391            if uiscale is bui.UIScale.SMALL
 392            else 142 if uiscale is bui.UIScale.MEDIUM else 190
 393        )
 394        b_space_extra = (
 395            0
 396            if uiscale is bui.UIScale.SMALL
 397            else -2 if uiscale is bui.UIScale.MEDIUM else -5
 398        )
 399
 400        btnv = (
 401            c_height
 402            - (
 403                48
 404                if uiscale is bui.UIScale.SMALL
 405                else 45 if uiscale is bui.UIScale.MEDIUM else 40
 406            )
 407            - b_height
 408        )
 409
 410        self._favorites_connect_button = btn1 = bui.buttonwidget(
 411            parent=self._container,
 412            size=(b_width, b_height),
 413            position=(140 if uiscale is bui.UIScale.SMALL else 40, btnv),
 414            button_type='square',
 415            color=(0.6, 0.53, 0.63),
 416            textcolor=(0.75, 0.7, 0.8),
 417            on_activate_call=self._on_favorites_connect_press,
 418            text_scale=1.0 if uiscale is bui.UIScale.SMALL else 1.2,
 419            label=bui.Lstr(resource='gatherWindow.manualConnectText'),
 420            autoselect=True,
 421        )
 422        if uiscale is bui.UIScale.SMALL:
 423            bui.widget(
 424                edit=btn1,
 425                left_widget=bui.get_special_widget('back_button'),
 426            )
 427        btnv -= b_height + b_space_extra
 428        bui.buttonwidget(
 429            parent=self._container,
 430            size=(b_width, b_height),
 431            position=(140 if uiscale is bui.UIScale.SMALL else 40, btnv),
 432            button_type='square',
 433            color=(0.6, 0.53, 0.63),
 434            textcolor=(0.75, 0.7, 0.8),
 435            on_activate_call=self._on_favorites_edit_press,
 436            text_scale=1.0 if uiscale is bui.UIScale.SMALL else 1.2,
 437            label=bui.Lstr(resource='editText'),
 438            autoselect=True,
 439        )
 440        btnv -= b_height + b_space_extra
 441        bui.buttonwidget(
 442            parent=self._container,
 443            size=(b_width, b_height),
 444            position=(140 if uiscale is bui.UIScale.SMALL else 40, btnv),
 445            button_type='square',
 446            color=(0.6, 0.53, 0.63),
 447            textcolor=(0.75, 0.7, 0.8),
 448            on_activate_call=self._on_favorite_delete_press,
 449            text_scale=1.0 if uiscale is bui.UIScale.SMALL else 1.2,
 450            label=bui.Lstr(resource='deleteText'),
 451            autoselect=True,
 452        )
 453
 454        v -= sub_scroll_height + 23
 455        self._scrollwidget = scrlw = bui.scrollwidget(
 456            parent=self._container,
 457            position=(290 if uiscale is bui.UIScale.SMALL else 225, v),
 458            size=(sub_scroll_width, sub_scroll_height),
 459            claims_left_right=True,
 460        )
 461        bui.widget(
 462            edit=self._favorites_connect_button, right_widget=self._scrollwidget
 463        )
 464        self._columnwidget = bui.columnwidget(
 465            parent=scrlw,
 466            left_border=10,
 467            border=2,
 468            margin=0,
 469            claims_left_right=True,
 470        )
 471
 472        self._no_parties_added_text = bui.textwidget(
 473            parent=self._container,
 474            size=(0, 0),
 475            h_align='center',
 476            v_align='center',
 477            text='',
 478            color=(0.6, 0.6, 0.6),
 479            scale=1.2,
 480            position=(
 481                (
 482                    (240 if uiscale is bui.UIScale.SMALL else 225)
 483                    + sub_scroll_width * 0.5
 484                ),
 485                v + sub_scroll_height * 0.5,
 486            ),
 487            glow_type='uniform',
 488        )
 489
 490        self._favorite_selected = None
 491        self._refresh_favorites()
 492
 493    def _no_favorite_selected_error(self) -> None:
 494        bui.screenmessage(
 495            bui.Lstr(resource='nothingIsSelectedErrorText'), color=(1, 0, 0)
 496        )
 497        bui.getsound('error').play()
 498
 499    def _on_favorites_connect_press(self) -> None:
 500        if self._favorite_selected is None:
 501            self._no_favorite_selected_error()
 502
 503        else:
 504            config = bui.app.config['Saved Servers'][self._favorite_selected]
 505            _HostLookupThread(
 506                name=config['addr'],
 507                port=config['port'],
 508                call=bui.WeakCall(self._host_lookup_result),
 509            ).start()
 510
 511    def _on_favorites_edit_press(self) -> None:
 512        if self._favorite_selected is None:
 513            self._no_favorite_selected_error()
 514            return
 515
 516        c_width = 600
 517        c_height = 310
 518        assert bui.app.classic is not None
 519        uiscale = bui.app.ui_v1.uiscale
 520        self._favorite_edit_window = cnt = bui.containerwidget(
 521            scale=(
 522                1.8
 523                if uiscale is bui.UIScale.SMALL
 524                else 1.55 if uiscale is bui.UIScale.MEDIUM else 1.0
 525            ),
 526            size=(c_width, c_height),
 527            transition='in_scale',
 528        )
 529
 530        bui.textwidget(
 531            parent=cnt,
 532            size=(0, 0),
 533            h_align='center',
 534            v_align='center',
 535            text=bui.Lstr(resource='editText'),
 536            color=(0.6, 1.0, 0.6),
 537            maxwidth=c_width * 0.8,
 538            position=(c_width * 0.5, c_height - 60),
 539        )
 540
 541        bui.textwidget(
 542            parent=cnt,
 543            position=(c_width * 0.2 - 15, c_height - 120),
 544            color=(0.6, 1.0, 0.6),
 545            scale=1.0,
 546            size=(0, 0),
 547            maxwidth=60,
 548            h_align='right',
 549            v_align='center',
 550            text=bui.Lstr(resource='nameText'),
 551        )
 552
 553        self._party_edit_name_text = bui.textwidget(
 554            parent=cnt,
 555            size=(c_width * 0.7, 40),
 556            h_align='left',
 557            v_align='center',
 558            text=bui.app.config['Saved Servers'][self._favorite_selected][
 559                'name'
 560            ],
 561            editable=True,
 562            description=bui.Lstr(resource='nameText'),
 563            position=(c_width * 0.2, c_height - 140),
 564            autoselect=True,
 565            maxwidth=c_width * 0.6,
 566            max_chars=200,
 567        )
 568
 569        bui.textwidget(
 570            parent=cnt,
 571            position=(c_width * 0.2 - 15, c_height - 180),
 572            color=(0.6, 1.0, 0.6),
 573            scale=1.0,
 574            size=(0, 0),
 575            maxwidth=60,
 576            h_align='right',
 577            v_align='center',
 578            text=bui.Lstr(resource='gatherWindow.' 'manualAddressText'),
 579        )
 580
 581        self._party_edit_addr_text = bui.textwidget(
 582            parent=cnt,
 583            size=(c_width * 0.4, 40),
 584            h_align='left',
 585            v_align='center',
 586            text=bui.app.config['Saved Servers'][self._favorite_selected][
 587                'addr'
 588            ],
 589            editable=True,
 590            description=bui.Lstr(resource='gatherWindow.manualAddressText'),
 591            position=(c_width * 0.2, c_height - 200),
 592            autoselect=True,
 593            maxwidth=c_width * 0.35,
 594            max_chars=200,
 595        )
 596
 597        bui.textwidget(
 598            parent=cnt,
 599            position=(c_width * 0.7 - 10, c_height - 180),
 600            color=(0.6, 1.0, 0.6),
 601            scale=1.0,
 602            size=(0, 0),
 603            maxwidth=45,
 604            h_align='right',
 605            v_align='center',
 606            text=bui.Lstr(resource='gatherWindow.' 'portText'),
 607        )
 608
 609        self._party_edit_port_text = bui.textwidget(
 610            parent=cnt,
 611            size=(c_width * 0.2, 40),
 612            h_align='left',
 613            v_align='center',
 614            text=str(
 615                bui.app.config['Saved Servers'][self._favorite_selected]['port']
 616            ),
 617            editable=True,
 618            description=bui.Lstr(resource='gatherWindow.portText'),
 619            position=(c_width * 0.7, c_height - 200),
 620            autoselect=True,
 621            maxwidth=c_width * 0.2,
 622            max_chars=6,
 623        )
 624        cbtn = bui.buttonwidget(
 625            parent=cnt,
 626            label=bui.Lstr(resource='cancelText'),
 627            on_activate_call=bui.Call(
 628                lambda c: bui.containerwidget(edit=c, transition='out_scale'),
 629                cnt,
 630            ),
 631            size=(180, 60),
 632            position=(30, 30),
 633            autoselect=True,
 634        )
 635        okb = bui.buttonwidget(
 636            parent=cnt,
 637            label=bui.Lstr(resource='saveText'),
 638            size=(180, 60),
 639            position=(c_width - 230, 30),
 640            on_activate_call=bui.Call(self._edit_saved_party),
 641            autoselect=True,
 642        )
 643        bui.widget(edit=cbtn, right_widget=okb)
 644        bui.widget(edit=okb, left_widget=cbtn)
 645        bui.containerwidget(edit=cnt, cancel_button=cbtn, start_button=okb)
 646
 647    def _edit_saved_party(self) -> None:
 648        server = self._favorite_selected
 649        if self._favorite_selected is None:
 650            self._no_favorite_selected_error()
 651            return
 652        if not self._party_edit_name_text or not self._party_edit_addr_text:
 653            return
 654        new_name_raw = cast(
 655            str, bui.textwidget(query=self._party_edit_name_text)
 656        )
 657        new_addr_raw = cast(
 658            str, bui.textwidget(query=self._party_edit_addr_text)
 659        )
 660        new_port_raw = cast(
 661            str, bui.textwidget(query=self._party_edit_port_text)
 662        )
 663        bui.app.config['Saved Servers'][server]['name'] = new_name_raw
 664        bui.app.config['Saved Servers'][server]['addr'] = new_addr_raw
 665        try:
 666            bui.app.config['Saved Servers'][server]['port'] = int(new_port_raw)
 667        except ValueError:
 668            # Notify about incorrect port? I'm lazy; simply leave old value.
 669            pass
 670        bui.app.config.commit()
 671        bui.getsound('gunCocking').play()
 672        self._refresh_favorites()
 673
 674        bui.containerwidget(
 675            edit=self._favorite_edit_window, transition='out_scale'
 676        )
 677
 678    def _on_favorite_delete_press(self) -> None:
 679        from bauiv1lib import confirm
 680
 681        if self._favorite_selected is None:
 682            self._no_favorite_selected_error()
 683            return
 684        confirm.ConfirmWindow(
 685            bui.Lstr(
 686                resource='gameListWindow.deleteConfirmText',
 687                subs=[
 688                    (
 689                        '${LIST}',
 690                        bui.app.config['Saved Servers'][
 691                            self._favorite_selected
 692                        ]['name'],
 693                    )
 694                ],
 695            ),
 696            self._delete_saved_party,
 697            450,
 698            150,
 699        )
 700
 701    def _delete_saved_party(self) -> None:
 702        if self._favorite_selected is None:
 703            self._no_favorite_selected_error()
 704            return
 705        config = bui.app.config['Saved Servers']
 706        del config[self._favorite_selected]
 707        self._favorite_selected = None
 708        bui.app.config.commit()
 709        bui.getsound('shieldDown').play()
 710        self._refresh_favorites()
 711
 712    def _on_favorite_select(self, server: str) -> None:
 713        self._favorite_selected = server
 714
 715    def _refresh_favorites(self) -> None:
 716        assert self._columnwidget is not None
 717        for child in self._columnwidget.get_children():
 718            child.delete()
 719        t_scale = 1.6
 720
 721        config = bui.app.config
 722        if 'Saved Servers' in config:
 723            servers = config['Saved Servers']
 724
 725        else:
 726            servers = []
 727
 728        assert self._favorites_scroll_width is not None
 729        assert self._favorites_connect_button is not None
 730
 731        bui.textwidget(
 732            edit=self._no_parties_added_text,
 733            text='',
 734        )
 735        num_of_fav = 0
 736        for i, server in enumerate(servers):
 737            txt = bui.textwidget(
 738                parent=self._columnwidget,
 739                size=(self._favorites_scroll_width / t_scale, 30),
 740                selectable=True,
 741                color=(1.0, 1, 0.4),
 742                always_highlight=True,
 743                on_select_call=bui.Call(self._on_favorite_select, server),
 744                on_activate_call=self._favorites_connect_button.activate,
 745                text=(
 746                    config['Saved Servers'][server]['name']
 747                    if config['Saved Servers'][server]['name'] != ''
 748                    else config['Saved Servers'][server]['addr']
 749                    + ' '
 750                    + str(config['Saved Servers'][server]['port'])
 751                ),
 752                h_align='left',
 753                v_align='center',
 754                corner_scale=t_scale,
 755                maxwidth=(self._favorites_scroll_width / t_scale) * 0.93,
 756            )
 757            if i == 0:
 758                bui.widget(edit=txt, up_widget=self._favorites_text)
 759                self._favorite_selected = server
 760            bui.widget(
 761                edit=txt,
 762                left_widget=self._favorites_connect_button,
 763                right_widget=txt,
 764            )
 765            num_of_fav = num_of_fav + 1
 766
 767        # If there's no servers, allow selecting out of the scroll area
 768        bui.containerwidget(
 769            edit=self._scrollwidget,
 770            claims_left_right=bool(servers),
 771            claims_up_down=bool(servers),
 772        )
 773        assert self._scrollwidget is not None
 774        bui.widget(
 775            edit=self._scrollwidget,
 776            up_widget=self._favorites_text,
 777            left_widget=self._favorites_connect_button,
 778        )
 779        if num_of_fav == 0:
 780            bui.textwidget(
 781                edit=self._no_parties_added_text,
 782                text=bui.Lstr(resource='gatherWindow.noPartiesAddedText'),
 783            )
 784
 785    @override
 786    def on_deactivate(self) -> None:
 787        self._access_check_timer = None
 788
 789    def _connect(
 790        self, textwidget: bui.Widget, port_textwidget: bui.Widget
 791    ) -> None:
 792        addr = cast(str, bui.textwidget(query=textwidget))
 793        if addr == '':
 794            bui.screenmessage(
 795                bui.Lstr(resource='internal.invalidAddressErrorText'),
 796                color=(1, 0, 0),
 797            )
 798            bui.getsound('error').play()
 799            return
 800        try:
 801            port = int(cast(str, bui.textwidget(query=port_textwidget)))
 802        except ValueError:
 803            port = -1
 804        if port > 65535 or port < 0:
 805            bui.screenmessage(
 806                bui.Lstr(resource='internal.invalidPortErrorText'),
 807                color=(1, 0, 0),
 808            )
 809            bui.getsound('error').play()
 810            return
 811
 812        _HostLookupThread(
 813            name=addr, port=port, call=bui.WeakCall(self._host_lookup_result)
 814        ).start()
 815
 816    def _save_server(
 817        self, textwidget: bui.Widget, port_textwidget: bui.Widget
 818    ) -> None:
 819        addr = cast(str, bui.textwidget(query=textwidget))
 820        if addr == '':
 821            bui.screenmessage(
 822                bui.Lstr(resource='internal.invalidAddressErrorText'),
 823                color=(1, 0, 0),
 824            )
 825            bui.getsound('error').play()
 826            return
 827        try:
 828            port = int(cast(str, bui.textwidget(query=port_textwidget)))
 829        except ValueError:
 830            port = -1
 831        if port > 65535 or port < 0:
 832            bui.screenmessage(
 833                bui.Lstr(resource='internal.invalidPortErrorText'),
 834                color=(1, 0, 0),
 835            )
 836            bui.getsound('error').play()
 837            return
 838        config = bui.app.config
 839
 840        if addr:
 841            if not isinstance(config.get('Saved Servers'), dict):
 842                config['Saved Servers'] = {}
 843            config['Saved Servers'][f'{addr}@{port}'] = {
 844                'addr': addr,
 845                'port': port,
 846                'name': addr,
 847            }
 848            config.commit()
 849            bui.getsound('gunCocking').play()
 850            bui.screenmessage(
 851                bui.Lstr(
 852                    resource='addedToFavoritesText', subs=[('${NAME}', addr)]
 853                ),
 854                color=(0, 1, 0),
 855            )
 856        else:
 857            bui.screenmessage(
 858                bui.Lstr(resource='internal.invalidAddressErrorText'),
 859                color=(1, 0, 0),
 860            )
 861            bui.getsound('error').play()
 862
 863    def _host_lookup_result(
 864        self, resolved_address: str | None, port: int
 865    ) -> None:
 866        if resolved_address is None:
 867            bui.screenmessage(
 868                bui.Lstr(resource='internal.unableToResolveHostText'),
 869                color=(1, 0, 0),
 870            )
 871            bui.getsound('error').play()
 872        else:
 873            # Store for later.
 874            config = bui.app.config
 875            config['Last Manual Party Connect Address'] = resolved_address
 876            config['Last Manual Party Connect Port'] = port
 877            config.commit()
 878
 879            # Store UI location to return to when done.
 880            if bs.app.classic is not None:
 881                bs.app.classic.save_ui_state()
 882
 883            bs.connect_to_party(resolved_address, port=port)
 884
 885    def _run_addr_fetch(self) -> None:
 886        try:
 887            # FIXME: Update this to work with IPv6.
 888            import socket
 889
 890            sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
 891            sock.connect(('8.8.8.8', 80))
 892            val = sock.getsockname()[0]
 893            sock.close()
 894            bui.pushcall(
 895                bui.Call(
 896                    _safe_set_text,
 897                    self._checking_state_text,
 898                    val,
 899                ),
 900                from_other_thread=True,
 901            )
 902        except Exception as exc:
 903            from efro.error import is_udp_communication_error
 904
 905            if is_udp_communication_error(exc):
 906                bui.pushcall(
 907                    bui.Call(
 908                        _safe_set_text,
 909                        self._checking_state_text,
 910                        bui.Lstr(resource='gatherWindow.' 'noConnectionText'),
 911                        False,
 912                    ),
 913                    from_other_thread=True,
 914                )
 915            else:
 916                bui.pushcall(
 917                    bui.Call(
 918                        _safe_set_text,
 919                        self._checking_state_text,
 920                        bui.Lstr(
 921                            resource='gatherWindow.' 'addressFetchErrorText'
 922                        ),
 923                        False,
 924                    ),
 925                    from_other_thread=True,
 926                )
 927                logging.exception('Error in AddrFetchThread.')
 928
 929    def _on_show_my_address_button_press(
 930        self, v2: float, container: bui.Widget | None, c_width: float
 931    ) -> None:
 932        if not container:
 933            return
 934
 935        tscl = 0.85
 936        tspc = 25
 937
 938        bui.getsound('swish').play()
 939        bui.textwidget(
 940            parent=container,
 941            position=(c_width * 0.5 - 10, v2),
 942            color=(0.6, 1.0, 0.6),
 943            scale=tscl,
 944            size=(0, 0),
 945            maxwidth=c_width * 0.45,
 946            flatness=1.0,
 947            h_align='right',
 948            v_align='center',
 949            text=bui.Lstr(
 950                resource='gatherWindow.' 'manualYourLocalAddressText'
 951            ),
 952        )
 953        self._checking_state_text = bui.textwidget(
 954            parent=container,
 955            position=(c_width * 0.5, v2),
 956            color=(0.5, 0.5, 0.5),
 957            scale=tscl,
 958            size=(0, 0),
 959            maxwidth=c_width * 0.45,
 960            flatness=1.0,
 961            h_align='left',
 962            v_align='center',
 963            text=bui.Lstr(resource='gatherWindow.' 'checkingText'),
 964        )
 965
 966        Thread(target=self._run_addr_fetch).start()
 967
 968        v2 -= tspc
 969        bui.textwidget(
 970            parent=container,
 971            position=(c_width * 0.5 - 10, v2),
 972            color=(0.6, 1.0, 0.6),
 973            scale=tscl,
 974            size=(0, 0),
 975            maxwidth=c_width * 0.45,
 976            flatness=1.0,
 977            h_align='right',
 978            v_align='center',
 979            text=bui.Lstr(
 980                resource='gatherWindow.' 'manualYourAddressFromInternetText'
 981            ),
 982        )
 983
 984        t_addr = bui.textwidget(
 985            parent=container,
 986            position=(c_width * 0.5, v2),
 987            color=(0.5, 0.5, 0.5),
 988            scale=tscl,
 989            size=(0, 0),
 990            maxwidth=c_width * 0.45,
 991            h_align='left',
 992            v_align='center',
 993            flatness=1.0,
 994            text=bui.Lstr(resource='gatherWindow.' 'checkingText'),
 995        )
 996        v2 -= tspc
 997        bui.textwidget(
 998            parent=container,
 999            position=(c_width * 0.5 - 10, v2),
1000            color=(0.6, 1.0, 0.6),
1001            scale=tscl,
1002            size=(0, 0),
1003            maxwidth=c_width * 0.45,
1004            flatness=1.0,
1005            h_align='right',
1006            v_align='center',
1007            text=bui.Lstr(
1008                resource='gatherWindow.' 'manualJoinableFromInternetText'
1009            ),
1010        )
1011
1012        t_accessible = bui.textwidget(
1013            parent=container,
1014            position=(c_width * 0.5, v2),
1015            color=(0.5, 0.5, 0.5),
1016            scale=tscl,
1017            size=(0, 0),
1018            maxwidth=c_width * 0.45,
1019            flatness=1.0,
1020            h_align='left',
1021            v_align='center',
1022            text=bui.Lstr(resource='gatherWindow.' 'checkingText'),
1023        )
1024        v2 -= 28
1025        t_accessible_extra = bui.textwidget(
1026            parent=container,
1027            position=(c_width * 0.5, v2),
1028            color=(1, 0.5, 0.2),
1029            scale=0.7,
1030            size=(0, 0),
1031            maxwidth=c_width * 0.9,
1032            flatness=1.0,
1033            h_align='center',
1034            v_align='center',
1035            text='',
1036        )
1037
1038        self._doing_access_check = False
1039        self._access_check_count = 0  # Cap our refreshes eventually.
1040        self._access_check_timer = bui.AppTimer(
1041            10.0,
1042            bui.WeakCall(
1043                self._access_check_update,
1044                t_addr,
1045                t_accessible,
1046                t_accessible_extra,
1047            ),
1048            repeat=True,
1049        )
1050
1051        # Kick initial off.
1052        self._access_check_update(t_addr, t_accessible, t_accessible_extra)
1053        if self._check_button:
1054            self._check_button.delete()
1055
1056    def _access_check_update(
1057        self,
1058        t_addr: bui.Widget,
1059        t_accessible: bui.Widget,
1060        t_accessible_extra: bui.Widget,
1061    ) -> None:
1062        assert bui.app.classic is not None
1063        # If we don't have an outstanding query, start one..
1064        assert self._doing_access_check is not None
1065        assert self._access_check_count is not None
1066        if not self._doing_access_check and self._access_check_count < 100:
1067            self._doing_access_check = True
1068            self._access_check_count += 1
1069            self._t_addr = t_addr
1070            self._t_accessible = t_accessible
1071            self._t_accessible_extra = t_accessible_extra
1072            bui.app.classic.master_server_v1_get(
1073                'bsAccessCheck',
1074                {'b': bui.app.env.engine_build_number},
1075                callback=bui.WeakCall(self._on_accessible_response),
1076            )
1077
1078    def _on_accessible_response(self, data: dict[str, Any] | None) -> None:
1079        t_addr = self._t_addr
1080        t_accessible = self._t_accessible
1081        t_accessible_extra = self._t_accessible_extra
1082        self._doing_access_check = False
1083        color_bad = (1, 1, 0)
1084        color_good = (0, 1, 0)
1085        if data is None or 'address' not in data or 'accessible' not in data:
1086            if t_addr:
1087                bui.textwidget(
1088                    edit=t_addr,
1089                    text=bui.Lstr(resource='gatherWindow.' 'noConnectionText'),
1090                    color=color_bad,
1091                )
1092            if t_accessible:
1093                bui.textwidget(
1094                    edit=t_accessible,
1095                    text=bui.Lstr(resource='gatherWindow.' 'noConnectionText'),
1096                    color=color_bad,
1097                )
1098            if t_accessible_extra:
1099                bui.textwidget(
1100                    edit=t_accessible_extra, text='', color=color_bad
1101                )
1102            return
1103        if t_addr:
1104            bui.textwidget(edit=t_addr, text=data['address'], color=color_good)
1105        if t_accessible:
1106            if data['accessible']:
1107                bui.textwidget(
1108                    edit=t_accessible,
1109                    text=bui.Lstr(
1110                        resource='gatherWindow.' 'manualJoinableYesText'
1111                    ),
1112                    color=color_good,
1113                )
1114                if t_accessible_extra:
1115                    bui.textwidget(
1116                        edit=t_accessible_extra, text='', color=color_good
1117                    )
1118            else:
1119                bui.textwidget(
1120                    edit=t_accessible,
1121                    text=bui.Lstr(
1122                        resource='gatherWindow.'
1123                        'manualJoinableNoWithAsteriskText'
1124                    ),
1125                    color=color_bad,
1126                )
1127                if t_accessible_extra:
1128                    bui.textwidget(
1129                        edit=t_accessible_extra,
1130                        text=bui.Lstr(
1131                            resource='gatherWindow.'
1132                            'manualRouterForwardingText',
1133                            subs=[
1134                                ('${PORT}', str(bs.get_game_port())),
1135                            ],
1136                        ),
1137                        color=color_bad,
1138                    )