bauiv1lib.profile.browser

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""UI functionality related to browsing player profiles."""
  4
  5from __future__ import annotations
  6
  7import logging
  8from typing import TYPE_CHECKING, override
  9
 10import bauiv1 as bui
 11import bascenev1 as bs
 12
 13if TYPE_CHECKING:
 14    from typing import Any
 15
 16
 17class ProfileBrowserWindow(bui.MainWindow):
 18    """Window for browsing player profiles."""
 19
 20    def __init__(
 21        self,
 22        transition: str | None = 'in_right',
 23        # in_main_menu: bool = True,
 24        selected_profile: str | None = None,
 25        origin_widget: bui.Widget | None = None,
 26        minimal_toolbar: bool = False,
 27    ):
 28        self._minimal_toolbar = minimal_toolbar
 29        back_label = bui.Lstr(resource='backText')
 30        assert bui.app.classic is not None
 31        uiscale = bui.app.ui_v1.uiscale
 32        self._width = 800.0 if uiscale is bui.UIScale.SMALL else 600.0
 33        x_inset = 100.0 if uiscale is bui.UIScale.SMALL else 0.0
 34        self._height = (
 35            360.0
 36            if uiscale is bui.UIScale.SMALL
 37            else 385.0 if uiscale is bui.UIScale.MEDIUM else 410.0
 38        )
 39
 40        # Need to handle out-transitions ourself for modal mode.
 41        if origin_widget is not None:
 42            self._transition_out = 'out_scale'
 43        else:
 44            self._transition_out = 'out_right'
 45
 46        self._r = 'playerProfilesWindow'
 47
 48        # Ensure we've got an account-profile in cases where we're signed in.
 49        assert bui.app.classic is not None
 50        bui.app.classic.accounts.ensure_have_account_player_profile()
 51
 52        top_extra = 20 if uiscale is bui.UIScale.SMALL else 0
 53
 54        super().__init__(
 55            root_widget=bui.containerwidget(
 56                size=(self._width, self._height + top_extra),
 57                toolbar_visibility=(
 58                    'menu_minimal'
 59                    if (uiscale is bui.UIScale.SMALL or minimal_toolbar)
 60                    else 'menu_full'
 61                ),
 62                scale=(
 63                    2.0
 64                    if uiscale is bui.UIScale.SMALL
 65                    else 1.5 if uiscale is bui.UIScale.MEDIUM else 1.0
 66                ),
 67                stack_offset=(
 68                    (0, -14) if uiscale is bui.UIScale.SMALL else (0, 0)
 69                ),
 70            ),
 71            transition=transition,
 72            origin_widget=origin_widget,
 73        )
 74
 75        if bui.app.ui_v1.uiscale is bui.UIScale.SMALL:
 76            self._back_button = bui.get_special_widget('back_button')
 77            bui.containerwidget(
 78                edit=self._root_widget, on_cancel_call=self.main_window_back
 79            )
 80        else:
 81            self._back_button = btn = bui.buttonwidget(
 82                parent=self._root_widget,
 83                position=(40 + x_inset, self._height - 59),
 84                size=(120, 60),
 85                scale=0.8,
 86                label=back_label,
 87                button_type='back',
 88                autoselect=True,
 89                on_activate_call=self.main_window_back,
 90            )
 91            bui.containerwidget(edit=self._root_widget, cancel_button=btn)
 92            bui.buttonwidget(
 93                edit=btn,
 94                button_type='backSmall',
 95                size=(60, 60),
 96                label=bui.charstr(bui.SpecialChar.BACK),
 97            )
 98
 99        bui.textwidget(
100            parent=self._root_widget,
101            position=(self._width * 0.5, self._height - 36),
102            size=(0, 0),
103            text=bui.Lstr(resource=f'{self._r}.titleText'),
104            maxwidth=300,
105            color=bui.app.ui_v1.title_color,
106            scale=0.9,
107            h_align='center',
108            v_align='center',
109        )
110
111        scroll_height = self._height - 140.0
112        self._scroll_width = self._width - (188 + x_inset * 2)
113        v = self._height - 84.0
114        h = 50 + x_inset
115        b_color = (0.6, 0.53, 0.63)
116
117        scl = (
118            1.055
119            if uiscale is bui.UIScale.SMALL
120            else 1.18 if uiscale is bui.UIScale.MEDIUM else 1.3
121        )
122        v -= 70.0 * scl
123        self._new_button = bui.buttonwidget(
124            parent=self._root_widget,
125            position=(h, v),
126            size=(80, 66.0 * scl),
127            on_activate_call=self._new_profile,
128            color=b_color,
129            button_type='square',
130            autoselect=True,
131            textcolor=(0.75, 0.7, 0.8),
132            text_scale=0.7,
133            label=bui.Lstr(resource=f'{self._r}.newButtonText'),
134        )
135        v -= 70.0 * scl
136        self._edit_button = bui.buttonwidget(
137            parent=self._root_widget,
138            position=(h, v),
139            size=(80, 66.0 * scl),
140            on_activate_call=self._edit_profile,
141            color=b_color,
142            button_type='square',
143            autoselect=True,
144            textcolor=(0.75, 0.7, 0.8),
145            text_scale=0.7,
146            label=bui.Lstr(resource=f'{self._r}.editButtonText'),
147        )
148        v -= 70.0 * scl
149        self._delete_button = bui.buttonwidget(
150            parent=self._root_widget,
151            position=(h, v),
152            size=(80, 66.0 * scl),
153            on_activate_call=self._delete_profile,
154            color=b_color,
155            button_type='square',
156            autoselect=True,
157            textcolor=(0.75, 0.7, 0.8),
158            text_scale=0.7,
159            label=bui.Lstr(resource=f'{self._r}.deleteButtonText'),
160        )
161
162        v = self._height - 87
163
164        bui.textwidget(
165            parent=self._root_widget,
166            position=(self._width * 0.5, self._height - 71),
167            size=(0, 0),
168            text=bui.Lstr(resource=f'{self._r}.explanationText'),
169            color=bui.app.ui_v1.infotextcolor,
170            maxwidth=self._width * 0.83,
171            scale=0.6,
172            h_align='center',
173            v_align='center',
174        )
175
176        self._scrollwidget = bui.scrollwidget(
177            parent=self._root_widget,
178            highlight=False,
179            position=(140 + x_inset, v - scroll_height),
180            size=(self._scroll_width, scroll_height),
181        )
182        bui.widget(
183            edit=self._scrollwidget,
184            autoselect=True,
185            left_widget=self._new_button,
186        )
187        bui.containerwidget(
188            edit=self._root_widget, selected_child=self._scrollwidget
189        )
190        self._subcontainer = bui.containerwidget(
191            parent=self._scrollwidget,
192            size=(self._scroll_width, 32),
193            background=False,
194        )
195        v -= 255
196        self._profiles: dict[str, dict[str, Any]] | None = None
197        self._selected_profile = selected_profile
198        self._profile_widgets: list[bui.Widget] = []
199        self._refresh()
200        self._restore_state()
201
202    @override
203    def get_main_window_state(self) -> bui.MainWindowState:
204        # Support recreating our window for back/refresh purposes.
205        cls = type(self)
206
207        minimal_toolbar = self._minimal_toolbar
208
209        return bui.BasicMainWindowState(
210            create_call=lambda transition, origin_widget: cls(
211                transition=transition,
212                origin_widget=origin_widget,
213                minimal_toolbar=minimal_toolbar,
214            )
215        )
216
217    @override
218    def on_main_window_close(self) -> None:
219        self._save_state()
220
221    def _new_profile(self) -> None:
222        # pylint: disable=cyclic-import
223        from bauiv1lib.profile.edit import EditProfileWindow
224        from bauiv1lib.purchase import PurchaseWindow
225
226        # No-op if we're not the in-control main window.
227        if not self.main_window_has_control():
228            return
229
230        # no-op if our underlying widget is dead or on its way out.
231        # if not self._root_widget or self._root_widget.transitioning_out:
232        #     return
233
234        plus = bui.app.plus
235        assert plus is not None
236
237        # Limit to a handful profiles if they don't have pro-options.
238        max_non_pro_profiles = plus.get_v1_account_misc_read_val('mnpp', 5)
239        assert self._profiles is not None
240        assert bui.app.classic is not None
241        if (
242            not bui.app.classic.accounts.have_pro_options()
243            and len(self._profiles) >= max_non_pro_profiles
244        ):
245            PurchaseWindow(
246                items=['pro'],
247                header_text=bui.Lstr(
248                    resource='unlockThisProfilesText',
249                    subs=[('${NUM}', str(max_non_pro_profiles))],
250                ),
251            )
252            return
253
254        # Clamp at 100 profiles (otherwise the server will and that's less
255        # elegant looking).
256        if len(self._profiles) > 100:
257            bui.screenmessage(
258                bui.Lstr(
259                    translate=(
260                        'serverResponses',
261                        'Max number of profiles reached.',
262                    )
263                ),
264                color=(1, 0, 0),
265            )
266            bui.getsound('error').play()
267            return
268
269        self.main_window_replace(EditProfileWindow(existing_profile=None))
270
271    def _delete_profile(self) -> None:
272        # pylint: disable=cyclic-import
273        from bauiv1lib import confirm
274
275        if self._selected_profile is None:
276            bui.getsound('error').play()
277            bui.screenmessage(
278                bui.Lstr(resource='nothingIsSelectedErrorText'), color=(1, 0, 0)
279            )
280            return
281        if self._selected_profile == '__account__':
282            bui.getsound('error').play()
283            bui.screenmessage(
284                bui.Lstr(resource=f'{self._r}.cantDeleteAccountProfileText'),
285                color=(1, 0, 0),
286            )
287            return
288        confirm.ConfirmWindow(
289            bui.Lstr(
290                resource=f'{self._r}.deleteConfirmText',
291                subs=[('${PROFILE}', self._selected_profile)],
292            ),
293            self._do_delete_profile,
294            350,
295        )
296
297    def _do_delete_profile(self) -> None:
298        plus = bui.app.plus
299        assert plus is not None
300
301        plus.add_v1_account_transaction(
302            {'type': 'REMOVE_PLAYER_PROFILE', 'name': self._selected_profile}
303        )
304        plus.run_v1_account_transactions()
305        bui.getsound('shieldDown').play()
306        self._refresh()
307
308        # Select profile list.
309        bui.containerwidget(
310            edit=self._root_widget, selected_child=self._scrollwidget
311        )
312
313    def _edit_profile(self) -> None:
314        # pylint: disable=cyclic-import
315        from bauiv1lib.profile.edit import EditProfileWindow
316
317        # no-op if we're not in control.
318        if not self.main_window_has_control():
319            return
320
321        if self._selected_profile is None:
322            bui.getsound('error').play()
323            bui.screenmessage(
324                bui.Lstr(resource='nothingIsSelectedErrorText'), color=(1, 0, 0)
325            )
326            return
327
328        self.main_window_replace(EditProfileWindow(self._selected_profile))
329
330    def _select(self, name: str, index: int) -> None:
331        del index  # Unused.
332        self._selected_profile = name
333
334    def _refresh(self) -> None:
335        # pylint: disable=too-many-locals
336        # pylint: disable=too-many-statements
337        from efro.util import asserttype
338        from bascenev1 import PlayerProfilesChangedMessage
339        from bascenev1lib.actor import spazappearance
340
341        assert bui.app.classic is not None
342
343        plus = bui.app.plus
344        assert plus is not None
345
346        old_selection = self._selected_profile
347
348        # Delete old.
349        while self._profile_widgets:
350            self._profile_widgets.pop().delete()
351        self._profiles = bui.app.config.get('Player Profiles', {})
352        assert self._profiles is not None
353        items = list(self._profiles.items())
354        items.sort(key=lambda x: asserttype(x[0], str).lower())
355        spazzes = spazappearance.get_appearances()
356        spazzes.sort()
357        icon_textures = [
358            bui.gettexture(bui.app.classic.spaz_appearances[s].icon_texture)
359            for s in spazzes
360        ]
361        icon_tint_textures = [
362            bui.gettexture(
363                bui.app.classic.spaz_appearances[s].icon_mask_texture
364            )
365            for s in spazzes
366        ]
367        index = 0
368        y_val = 35 * (len(self._profiles) - 1)
369        account_name: str | None
370        if plus.get_v1_account_state() == 'signed_in':
371            account_name = plus.get_v1_account_display_string()
372        else:
373            account_name = None
374        widget_to_select = None
375        for p_name, p_info in items:
376            if p_name == '__account__' and account_name is None:
377                continue
378            color, _highlight = bui.app.classic.get_player_profile_colors(
379                p_name
380            )
381            scl = 1.1
382            tval = (
383                account_name
384                if p_name == '__account__'
385                else bui.app.classic.get_player_profile_icon(p_name) + p_name
386            )
387
388            try:
389                char_index = spazzes.index(p_info['character'])
390            except Exception:
391                char_index = spazzes.index('Spaz')
392
393            assert isinstance(tval, str)
394            txtw = bui.textwidget(
395                parent=self._subcontainer,
396                position=(5, y_val),
397                size=((self._width - 210) / scl, 28),
398                text=bui.Lstr(value=f'    {tval}'),
399                h_align='left',
400                v_align='center',
401                on_select_call=bui.WeakCall(self._select, p_name, index),
402                maxwidth=self._scroll_width * 0.86,
403                corner_scale=scl,
404                color=bui.safecolor(color, 0.4),
405                always_highlight=True,
406                on_activate_call=bui.Call(self._edit_button.activate),
407                selectable=True,
408            )
409            character = bui.imagewidget(
410                parent=self._subcontainer,
411                position=(0, y_val),
412                size=(30, 30),
413                color=(1, 1, 1),
414                mask_texture=bui.gettexture('characterIconMask'),
415                tint_color=color,
416                tint2_color=_highlight,
417                texture=icon_textures[char_index],
418                tint_texture=icon_tint_textures[char_index],
419            )
420            if index == 0:
421                bui.widget(edit=txtw, up_widget=self._back_button)
422                if self._selected_profile is None:
423                    self._selected_profile = p_name
424            bui.widget(edit=txtw, show_buffer_top=40, show_buffer_bottom=40)
425            self._profile_widgets.append(txtw)
426            self._profile_widgets.append(character)
427
428            # Select/show this one if it was previously selected
429            # (but defer till after this loop since our height is
430            # still changing).
431            if p_name == old_selection:
432                widget_to_select = txtw
433
434            index += 1
435            y_val -= 35
436
437        bui.containerwidget(
438            edit=self._subcontainer,
439            size=(self._scroll_width, index * 35),
440        )
441        if widget_to_select is not None:
442            bui.containerwidget(
443                edit=self._subcontainer,
444                selected_child=widget_to_select,
445                visible_child=widget_to_select,
446            )
447
448        # If there's a team-chooser in existence, tell it the profile-list
449        # has probably changed.
450        session = bs.get_foreground_host_session()
451        if session is not None:
452            session.handlemessage(PlayerProfilesChangedMessage())
453
454    def _save_state(self) -> None:
455        try:
456            sel = self._root_widget.get_selected_child()
457            if sel == self._new_button:
458                sel_name = 'New'
459            elif sel == self._edit_button:
460                sel_name = 'Edit'
461            elif sel == self._delete_button:
462                sel_name = 'Delete'
463            elif sel == self._scrollwidget:
464                sel_name = 'Scroll'
465            else:
466                sel_name = 'Back'
467            assert bui.app.classic is not None
468            bui.app.ui_v1.window_states[type(self)] = sel_name
469        except Exception:
470            logging.exception('Error saving state for %s.', self)
471
472    def _restore_state(self) -> None:
473        try:
474            assert bui.app.classic is not None
475            sel_name = bui.app.ui_v1.window_states.get(type(self))
476            if sel_name == 'Scroll':
477                sel = self._scrollwidget
478            elif sel_name == 'New':
479                sel = self._new_button
480            elif sel_name == 'Delete':
481                sel = self._delete_button
482            elif sel_name == 'Edit':
483                sel = self._edit_button
484            elif sel_name == 'Back':
485                sel = self._back_button
486            else:
487                # By default we select our scroll widget if we have profiles;
488                # otherwise our new widget.
489                if not self._profile_widgets:
490                    sel = self._new_button
491                else:
492                    sel = self._scrollwidget
493            bui.containerwidget(edit=self._root_widget, selected_child=sel)
494        except Exception:
495            logging.exception('Error restoring state for %s.', self)