Refactor: Remove username from settings.xml, input in password auth flow

Refactors the password authentication flow to remove email storage in settings
and instead collect it dynamically.
Email is not needed as input for device auth flow.
Email is stored in settings as part of auth flow, not as an input for auth flow.

- Remove settings from user.login() parameters.
- Add new API endpoint get_personal_data() to call GET /sso/v3/me
- Remove username from settings.xml, but keep it in settings.py to limit touched files.
- Update password auth flow to collect email via keyboard dialog (not hidden)
- Update device auth flow to retrieve email from API /sso/v3/me endpoint

Author: thomas-ernest

plugin.video.arteplussept/resources/lib/api.py

@@ -50,6 +50,9 @@
     # PATCH empty payload
     # needs token in authorization header
     'purge_last_viewed': '/sso/v3/lastvieweds/purge',
+    # GET personal user data (email, firstName, lastName, etc.)
+    # needs token in authorization header
+    'personal_data': '/sso/v3/me',
     # program_id can be 103520-000-A or LIVE
     'player': '/player/v2/config/{lang}/{program_id}',
     'program': '/emac/v4/{lang}/web/programs/{program_id}',
@@ -69,8 +72,6 @@
     # date=2023-01-17
     # 'guide_tv': '/emac/v3/{lang}/{client}/pages/TV_GUIDE/?day={DATE}',
     # auth api
-    'custom_token': '/setCustomToken',
-    # auth api
     'login': '/login',
 }
 ARTETV_HEADERS = {
@@ -82,13 +83,6 @@
     'client': 'tv',
     'accept': 'application/json'
 }
-_API_KEY = '97598990-f0af-427b-893e-9da348d9f5a6'
-_COOKIES = {
-    'TCPID': '123261154911117061452',
-    # pylint: disable=line-too-long
-    'TC_PRIVACY': '1%40031%7C29%7C3445%40%40%401677322453596%2C1677322453596%2C1711018453596%40',
-    'TC_PRIVACY_CENTER': None
-}
 
 _ARTETV_ID_URL = 'https://id.arte.tv/auth/realms/myarte-prod/protocol/openid-connect'
 DEVICE_AUTH_URL = f"{_ARTETV_ID_URL}/auth/device"
@@ -193,6 +187,19 @@ def purge_last_viewed(tkn):
     return reply.status_code
 
 
+def get_personal_data(tkn):
+    """
+    Retrieve personal user data (email, firstName, lastName, etc.) from Arte API.
+    Requires authenticated token.
+    Returns the user data dict from API response or None if request fails.
+    """
+    url = _ARTETV_URL + ARTETV_ENDPOINTS['personal_data']
+    reply = _load_json_personal_content('artetv_getpersonaldata', url, tkn)
+    if reply is not None and isinstance(reply.get('data'), list) and len(reply.get('data', [])) > 0:
+        return reply['data'][0]
+    return None
+
+
 def player_video(lang, program_id):
     """Get the info of content program_id from Arte TV API."""
     url = _ARTETV_URL + ARTETV_ENDPOINTS['player'].format(lang=lang, program_id=program_id)

plugin.video.arteplussept/resources/lib/plugin.py

@@ -242,7 +242,7 @@ def display_search_page(zone_id, page, query):
 @plugin.route('/user/login', name='user_login')
 def user_login():
     """Login user with email already set in settings by creating and persisting a token."""
-    return plugin.finish(succeeded=user.login(plugin, settings))
+    return plugin.finish(succeeded=user.login(plugin))
 
 
 @plugin.route('/user/logout', name='user_logout')

plugin.video.arteplussept/resources/lib/settings.py

@@ -28,8 +28,6 @@ def __init__(self, plugin):
         # Arte TV user name
         # defaults to empty string to return false with if not str
         self.username = plugin.get_setting(
-            'username') or ""
-        self.user_mail = plugin.get_setting(
             'user_email') or ""
         # Enable additional logs managed by plugin: API and display object traces
         self.loglevel = plugin.get_setting(

plugin.video.arteplussept/resources/lib/user.py

@@ -16,12 +16,12 @@
 _TTL = 30*24*60
 
 
-def login(plugin, settings):
+def login(plugin):
     """
     Unified login entry point.
     User chooses between:
-    - Password login
     - Smart TV Device login
+    - Password login
     """
     erase_password_in_old_config(plugin)
 
@@ -33,70 +33,97 @@ def login(plugin, settings):
         ]
     )
     if choice == 0:
-        return login_with_device_flow(plugin, settings)
+        return login_with_device_flow(plugin)
     if choice == 1:
-        return login_with_password(plugin, settings)
+        return login_with_password(plugin)
     return False
 
 
 # ---------------------------------------------------------------------------
 # PASSWORD LOGIN
 # ---------------------------------------------------------------------------
 
-def login_with_password(plugin, settings):
+def login_with_password(plugin):
     """
-    Get user password from UI, create a token with Arte API, persist it in storage
+    Get user email and password from UI, create a token with Arte API, persist it in storage
     and update settings state to show user is logged in.
     """
-    # ensure user to log in is identified
-    usr = settings.username
-    if not usr:
-        msg = f"{plugin.addon.getLocalizedString(30020)} : {plugin.addon.getLocalizedString(30021)}"
-        plugin.notify(msg=msg, image='error')
+    # get email from user
+    email = get_user_email(plugin)
+    if not email:
+        xbmc.log('Authentication aborted by user - no email entered', level=xbmc.LOGWARNING)
+        plugin.notify(msg=plugin.addon.getLocalizedString(30020), image='error')
         return False
 
-    # ensure no user is not logged in
-    loggedin_usr = settings.user_email
-    tkn_data = get_cached_token(plugin, usr, True)
-    if len(loggedin_usr) > 0 and tkn_data:
-        xbmc.log(
-            f"\"{loggedin_usr}\" already authenticated : {tkn_data['access_token']}",
-            level=xbmc.LOGINFO)
-        # notify user that current token might be replaced
-        accept_to_replace = xbmcgui.Dialog().yesno(
-            plugin.addon.getLocalizedString(30015),
-            plugin.addon.getLocalizedString(30016).format(new_user=usr, old_user=loggedin_usr),
-            autoclose=10000
-        )
-        # user didn't accept replacement, so leave
-        if not accept_to_replace:
-            xbmc.log('Authentication aborted by user - keep initial token', level=xbmc.LOGWARNING)
-            return False
+    # if user already logged in with this email and token is valid, confirm s/he wants to override
+    if not want_to_continue_or_override_auth(plugin, email):
+        return False
 
     # get password
     pwd = get_user_password(plugin)
     if not pwd:
         xbmc.log('Authentication aborted by user - no password entered', level=xbmc.LOGWARNING)
-        msg = f"{plugin.addon.getLocalizedString(30020)} : {plugin.addon.getLocalizedString(30022)}"
-        plugin.notify(msg=msg, image='error')
+        plugin.notify(msg=plugin.addon.getLocalizedString(30020), image='error')
         return False
 
     # get token for user and password
-    tokens = api.authenticate_in_arte(plugin, usr, pwd)
+    tokens = api.authenticate_in_arte(plugin, email, pwd)
     if tokens is None:
         xbmc.log('Authentication failed in arte', level=xbmc.LOGERROR)
         msg = f"{plugin.addon.getLocalizedString(30020)}"
         plugin.notify(msg=msg, image='error')
         return False
 
     # store token
-    set_cached_token(plugin, usr, tokens)
-    update_settings_state(plugin, usr)
-    msg = plugin.addon.getLocalizedString(30017).format(user=usr)
+    set_cached_token(plugin, email, tokens)
+    set_auth_user_settings(plugin, email)
+    msg = plugin.addon.getLocalizedString(30017).format(user=email)
     plugin.notify(msg=msg, image='info')
     return True
 
 
+def get_user_email(plugin):
+    """
+    Display a keyboard to get user email.
+    Return None if user didn't enter an email or close the UI.
+    """
+    user_email = ''
+    keyboard = xbmc.Keyboard(user_email, plugin.addon.getLocalizedString(30019), False)
+    keyboard.doModal()
+    if keyboard.isConfirmed() is False:
+        return None
+    user_email = keyboard.getText()
+    if len(user_email) == 0:
+        return None
+    return user_email
+
+
+def want_to_continue_or_override_auth(plugin, new_user):
+    """
+    If user already authenticated (with a valid token and) with same email,
+    confirm that s/he wants to override her/his token.
+    Return False if user confirms replacement, True otherwise.
+    Return true, if token is invalid or emails are different.
+    """
+    # assuming that new user's email and old user's email are the same,
+    # since token can be retrieved/is indexed by email.
+    current_tkn = get_cached_token(plugin, new_user, True)
+    if current_tkn:
+        xbmc.log(f"\"{new_user}\" already authenticated : {current_tkn['access_token']}")
+        # notify user that current token might be replaced
+        accept_to_replace = xbmcgui.Dialog().yesno(
+            plugin.addon.getLocalizedString(30015),
+            # old_user=new_user highlight the unsual situation
+            plugin.addon.getLocalizedString(30016).format(new_user=new_user, old_user=new_user),
+            autoclose=10000
+        )
+        # user didn't accept replacement, so leave
+        if not accept_to_replace:
+            xbmc.log('Authentication aborted by user - keep initial token', level=xbmc.LOGWARNING)
+            return False
+    return True
+
+
 def get_user_password(plugin):
     """
     Display a keyboard to get user password.
@@ -117,13 +144,14 @@ def get_user_password(plugin):
 # SMART TV DEVICE FLOW LOGIN
 # ---------------------------------------------------------------------------
 
-def login_with_device_flow(plugin, settings):
+def login_with_device_flow(plugin):
     """
     Smart TV Device Authorization Flow:
     1. Request device_code + user_code
     2. Show instructions and code to authenticate on another device
     3. Poll token endpoint until success
-    4. Store token
+    4. Retrieve email from personal data endpoint
+    5. Store token
     """
     # Step 1 - request device_code
     device_info = api.device_authorization_request()
@@ -146,11 +174,23 @@ def login_with_device_flow(plugin, settings):
         plugin.notify(plugin.addon.getLocalizedString(30020), image='error')
         return False
 
-    # Step 4 - store token
-    usr = settings.username
-    set_cached_token(plugin, usr, tokens)
-    update_settings_state(plugin, usr)
-    msg = plugin.addon.getLocalizedString(30017).format(user=usr)
+    # Step 4 - retrieve email from personal data endpoint
+    user_data = api.get_personal_data(tokens)
+    if user_data is None:
+        xbmc.log('Failed to retrieve personal data from Arte API', level=xbmc.LOGERROR)
+        plugin.notify(plugin.addon.getLocalizedString(30020), image='error')
+        return False
+
+    email = user_data.get('email')
+    if not email:
+        xbmc.log('Email not found in personal data from Arte API', level=xbmc.LOGERROR)
+        plugin.notify(plugin.addon.getLocalizedString(30020), image='error')
+        return False
+
+    # Step 5 - store token
+    set_cached_token(plugin, email, tokens)
+    set_auth_user_settings(plugin, email)
+    msg = plugin.addon.getLocalizedString(30017).format(user=email)
     plugin.notify(msg=msg, image='info')
     return True
 
@@ -209,7 +249,7 @@ def logout(plugin, settings):
     # clear token locally
     set_cached_token(plugin, settings.username, '')
     clear_cached_tokens(plugin)
-    update_settings_state(plugin, '')
+    set_auth_user_settings(plugin, '')
     plugin.notify(msg=plugin.addon.getLocalizedString(30018), image='info')
     return True
 
@@ -218,7 +258,7 @@ def logout(plugin, settings):
 # ---------------------------------------------------------------------------
 
 
-def update_settings_state(plugin, email):
+def set_auth_user_settings(plugin, email):
     """Update setting state to know who belong the token to"""
     message = plugin.addon.getLocalizedString(30017).format(user=email)
     if email is None or len(email) <= 0:
@@ -261,4 +301,4 @@ def erase_password_in_old_config(plugin):
     to authenticate user.
     Deprecated since creation JUL2023, v1.3.0.
     """
-    return plugin.set_setting('password', '')
+    return plugin.set_setting('password', '') and plugin.set_setting('username', '')

plugin.video.arteplussept/resources/settings.xml

@@ -29,10 +29,6 @@
 
 	<!-- Profile -->
 	<category label="30045">
-		<setting
-			id="username"
-			type="text"
-			label="30054" />
 		<setting
 			id="user_email"
 			type="text"