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