[WIP][QFieldSync] When logging to a QFC account add the Global variable @Cloud_username available

qfieldsync/core/preferences.py

@@ -8,6 +8,7 @@
     String,
     Stringlist,
 )
+from qfieldsync.setting_manager.types.integer import Integer
 
 pluginName = "QFieldSync"
 
@@ -31,6 +32,7 @@ def __init__(self):
         self.add_setting(Dictionary("qfieldCloudLastProjectFiles", Scope.Global, {}))
         self.add_setting(String("qfieldCloudServerUrl", Scope.Global, ""))
         self.add_setting(String("qfieldCloudAuthcfg", Scope.Global, ""))
+        self.add_setting(Integer("qfieldCloudAuthMethod", Scope.Global, 0))
         self.add_setting(Bool("qfieldCloudRememberMe", Scope.Global, False))
         self.add_setting(
             String("cloudDirectory", Scope.Global, str(home.joinpath("QField/cloud")))

qfieldsync/gui/cloud_browser_tree.py

@@ -87,7 +87,7 @@ def capabilities2(self):
     def createChildren(self):
         items = []
 
-        if not self.network_manager.has_token():
+        if not self.network_manager.is_authenticated():
             CloudLoginDialog.show_auth_dialog(self.network_manager)
             self.setState(QgsDataItem.Populating)
             return []
@@ -119,7 +119,7 @@ def refreshing_cloud_projects(self):
         self.refresh()
 
     def update_icon(self):
-        if self.network_manager.has_token():
+        if self.network_manager.is_authenticated():
             self.setIcon(
                 QIcon(os.path.join(os.path.dirname(__file__), "../resources/cloud.svg"))
             )
@@ -283,7 +283,7 @@ def open_project(self, item) -> bool:
         return False
 
     def refresh_cloud_projects(self):
-        if not self.network_manager.has_token():
+        if not self.network_manager.is_authenticated():
             CloudLoginDialog.show_auth_dialog(
                 self.network_manager, lambda: self.refresh_cloud_projects()
             )

qfieldsync/gui/cloud_create_project_widget.py

@@ -85,7 +85,7 @@ def __init__(
         # keep a timer reference
         self.timer = QTimer(self)
 
-        if not self.network_manager.has_token():
+        if not self.network_manager.is_authenticated():
             CloudLoginDialog.show_auth_dialog(
                 self.network_manager, lambda: self.close(), None, parent=self
             )
@@ -339,20 +339,18 @@ def set_dirname(self, dirname: str):
     def refresh_project_owners(self):
         self.projectOwnerComboBox.setEnabled(False)
         self.projectOwnerComboBox.clear()
-        self.projectOwnerComboBox.addItem(
-            self.network_manager.auth().config("username")
-        )
+        self.projectOwnerComboBox.addItem(self.network_manager.get_username())
         self.projectOwnerRefreshButton.setEnabled(False)
         self.projectOwnerFeedbackLabel.setVisible(False)
 
         reply = self.network_manager.get_user_organizations(
-            self.network_manager.auth().config("username")
+            self.network_manager.get_username()
         )
         reply.finished.connect(lambda: self.on_refresh_project_owners_finished(reply))
 
     def on_refresh_project_owners_finished(self, reply):
         items = [
-            self.network_manager.auth().config("username"),
+            self.network_manager.get_username(),
         ]
         try:
             payload = self.network_manager.json_array(reply)

qfieldsync/gui/cloud_login_dialog.py

@@ -21,21 +21,35 @@
  ***************************************************************************/
 """
 import os
+from functools import partial
 from typing import Callable
+from urllib.parse import urlparse
 
-from qgis.PyQt.QtCore import Qt
-from qgis.PyQt.QtGui import QPixmap
+from qgis.core import QgsApplication, QgsNetworkAccessManager
+from qgis.PyQt.QtCore import Qt, QTimer, QUrl
+from qgis.PyQt.QtGui import QCursor, QIcon, QPainter, QPalette, QPixmap
+from qgis.PyQt.QtNetwork import QNetworkRequest
+from qgis.PyQt.QtSvg import QSvgRenderer
 from qgis.PyQt.QtWidgets import (
     QApplication,
     QDialog,
     QDialogButtonBox,
+    QGroupBox,
     QMainWindow,
+    QPushButton,
+    QSizePolicy,
+    QSpacerItem,
     QWidget,
 )
 from qgis.PyQt.uic import loadUiType
 
 from qfieldsync.core import Preferences
-from qfieldsync.core.cloud_api import CloudNetworkAccessManager
+from qfieldsync.core.cloud_api import (
+    CloudAuthMethod,
+    CloudException,
+    CloudNetworkAccessManager,
+    build_oauth2_auth_config,
+)
 
 CloudLoginDialogUi, _ = loadUiType(
     os.path.join(os.path.dirname(__file__), "../ui/cloud_login_dialog.ui")
@@ -45,6 +59,10 @@
 class CloudLoginDialog(QDialog, CloudLoginDialogUi):
     instance = None
 
+    _fetch_auth_methods_timer: QTimer = QTimer()
+
+    _sso_login_buttons: list[QPushButton] = []
+
     @staticmethod
     def show_auth_dialog(
         network_manager: CloudNetworkAccessManager,
@@ -82,25 +100,34 @@ def __init__(
         self.preferences = Preferences()
         self.network_manager = network_manager
 
-        self.buttonBox.button(QDialogButtonBox.Ok).setText(self.tr("Sign In"))
-        self.buttonBox.button(QDialogButtonBox.Ok).clicked.connect(
-            self.on_login_button_clicked
+        self.buttonBox.setEnabled(False)
+        self.buttonBox.hide()
+
+        self._fetch_auth_methods_timer.setInterval(750)
+        self._fetch_auth_methods_timer.setSingleShot(True)
+        self._fetch_auth_methods_timer.timeout.connect(
+            self.fetch_server_auth_capabilities
         )
-        self.buttonBox.button(QDialogButtonBox.Cancel).clicked.connect(
-            self.on_cancel_button_clicked
+
+        self.signInUsernameButton.clicked.connect(
+            self.on_credentials_login_button_clicked
         )
 
-        self.serverUrlLabel.setVisible(False)
-        self.serverUrlCmb.setVisible(False)
+        self.loginFormGroup.setVisible(False)
+        self.set_login_groupbox_visibility(self.signInUsernameGroupBox, False)
+
         for server_url in self.network_manager.server_urls():
             self.serverUrlCmb.addItem(server_url)
 
         cfg = self.network_manager.auth()
-        remember_me = self.preferences.value("qfieldCloudRememberMe")
-
         self.serverUrlCmb.setCurrentText(cfg.uri() or self.network_manager.url)
-        self.usernameLineEdit.setText(cfg.config("username"))
-        self.passwordLineEdit.setText(cfg.config("password"))
+        self.serverUrlCmb.editTextChanged.connect(self.on_server_url_edit_text_changed)
+
+        if self.network_manager == CloudAuthMethod.CREDENTIALS:
+            self.usernameLineEdit.setText(cfg.config("username"))
+            self.passwordLineEdit.setText(cfg.config("password"))
+
+        remember_me = self.preferences.value("qfieldCloudRememberMe")
         self.rememberMeCheckBox.setChecked(remember_me)
 
         self.network_manager.login_finished.connect(self.on_login_finished)
@@ -120,15 +147,128 @@ def __init__(
         self.rejected.connect(self.on_rejected)
         self.hide()
 
+        self.fetch_server_auth_capabilities()
+
     def on_rejected(self) -> None:
         QApplication.restoreOverrideCursor()
         if self.parent():
             self.parent().setEnabled(True)
             self.setEnabled(True)
 
     def toggle_server_url_visibility(self) -> None:
-        self.serverUrlLabel.setVisible(not self.serverUrlLabel.isVisible())
-        self.serverUrlCmb.setVisible(not self.serverUrlCmb.isVisible())
+        self.loginFormGroup.setVisible(not self.loginFormGroup.isVisible())
+
+    def clear_login_widgets(self) -> None:
+        self.set_login_groupbox_visibility(self.signInUsernameGroupBox, False)
+
+        # clear sso login buttons
+        for push_button in self._sso_login_buttons:
+            push_button.deleteLater()
+
+        self._sso_login_buttons = []
+
+    def set_login_groupbox_visibility(self, group_box: QGroupBox, visible: bool):
+        group_box.setEnabled(visible)
+
+    def fetch_server_auth_capabilities(self) -> None:
+        """
+        Fetches the provided server authentication method capabilities.
+        """
+        self.clear_login_widgets()
+        self.network_manager.set_url(self.serverUrlCmb.currentText())
+        self.auth_methods_reply = self.network_manager.get_auth_capabilities()
+        self.auth_methods_reply.finished.connect(self.on_fetch_auth_methods_finished)
+
+    def on_fetch_auth_methods_finished(self) -> None:
+        try:
+            auth_methods = self.network_manager.json_array(self.auth_methods_reply)
+        except CloudException:
+            self.set_login_groupbox_visibility(self.signInUsernameGroupBox, True)
+            return
+
+        self.clear_login_widgets()
+
+        # add vertical space before SSO login buttons
+        vertical_spacer = QSpacerItem(
+            0, 20, QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Expanding
+        )
+        self.signInUsernameGroupBox.layout().addItem(vertical_spacer)
+
+        for auth_method in auth_methods:
+            # credentials login: enabled static groupbox.
+            if auth_method["id"] == "credentials":
+                self.set_login_groupbox_visibility(self.signInUsernameGroupBox, True)
+                continue
+
+            # sso provider: dynamically generate button to login.
+            login_button = QPushButton(
+                self.tr("Sign In with {provider}").format(provider=auth_method["name"])
+            )
+            login_button.setCursor(QCursor(Qt.CursorShape.PointingHandCursor))
+
+            self.set_sso_provider_button_style(auth_method.get("styles"), login_button)
+
+            login_button.clicked.connect(
+                partial(self.on_login_with_sso_provider_button_clicked, auth_method)
+            )
+            self.signInUsernameGroupBox.layout().addWidget(login_button)
+            self._sso_login_buttons.append(login_button)
+
+    def set_sso_provider_button_style(
+        self, style_data: dict, button: QPushButton
+    ) -> None:
+        """Apply style to a SSO provider login button.
+
+        Args:
+            style_data (dict): style JSON for the provider, served by QFieldCloud.
+            button (QPushButton): button to apply the style to.
+        """
+
+        theme = style_data.get(self.extract_theme_from_qgis_settings())
+        button.setStyleSheet(
+            f"background-color: {theme.get('color_fill')}; border-color: {theme.get('color_stroke')}; color: {theme.get('color_text')};"
+        )
+
+        # download svg logo and apply it to button
+        icon_url = theme.get("logo")
+        icon_req = QNetworkRequest(QUrl(icon_url))
+        icon_reply = QgsNetworkAccessManager.instance().get(icon_req)
+        icon_reply.finished.connect(
+            partial(self.on_get_svg_logo_reply_finished, icon_reply, button)
+        )
+
+    def on_get_svg_logo_reply_finished(self, reply, button: QPushButton) -> None:
+        if reply.error():
+            return
+
+        svg_data = reply.readAll()
+        renderer = QSvgRenderer(svg_data)
+
+        pixmap = QPixmap(32, 32)
+        pixmap.fill(Qt.GlobalColor.transparent)
+        painter = QPainter(pixmap)
+        renderer.render(painter)
+        painter.end()
+
+        button.setIcon(QIcon(pixmap))
+
+    def extract_theme_from_qgis_settings(self) -> str:
+        """Finds if the current QGIS theme should use "light" or "dark" theme.
+        Return the most accurate possible "dark" or "light" key.
+        Typically used for styling SSO logins buttons.
+
+        Returns:
+            str: "light" or "dark", based on user's current QGIS settings.
+        """
+        qgis_theme = QgsApplication.instance().themeName()
+        if qgis_theme == "Night Mapping":
+            return "dark"
+        if qgis_theme == "Blend of Gray":
+            return "light"
+        color = QWidget().palette().color(QPalette.Window)
+        if (color.red() + color.green() + color.blue()) / 3 < 120:
+            return "dark"
+        return "light"
 
     def authenticate(self) -> None:
         self.usernameLineEdit.setEnabled(True)
@@ -142,7 +282,9 @@ def authenticate(self) -> None:
 
         cfg = self.network_manager.auth()
 
-        if cfg.config("token"):
+        auth_method = self.network_manager.auth_method
+
+        if auth_method == CloudAuthMethod.CREDENTIALS:
             self.usernameLineEdit.setEnabled(False)
             self.passwordLineEdit.setEnabled(False)
             self.rememberMeCheckBox.setEnabled(False)
@@ -151,14 +293,28 @@ def authenticate(self) -> None:
             self.network_manager.set_url(cfg.uri())
             self.network_manager.set_auth(self.network_manager.url, token="")
             # don't trust the password, just login once again
-            self.network_manager.login(cfg.config("username"), cfg.config("password"))
+            self.network_manager.login_with_credentials(
+                cfg.config("username"), cfg.config("password")
+            )
+
+        elif auth_method == CloudAuthMethod.SSO:
+            self.network_manager.set_url(cfg.uri())
+            self.network_manager.login_with_sso()
 
-        if not cfg.config("token") or not self.parent():
+        elif not cfg.config("token") or not self.parent():
             self.show()
             self.raise_()
             self.activateWindow()
 
-    def on_login_button_clicked(self) -> None:
+    def on_server_url_edit_text_changed(self) -> None:
+        server_url = self.serverUrlCmb.currentText()
+        result = urlparse(server_url)
+        if all([result.scheme, result.netloc]):
+            if self._fetch_auth_methods_timer.isActive():
+                return
+            self._fetch_auth_methods_timer.start()
+
+    def on_credentials_login_button_clicked(self) -> None:
         QApplication.setOverrideCursor(Qt.WaitCursor)
 
         self.buttonBox.button(QDialogButtonBox.Ok).setEnabled(False)
@@ -169,9 +325,10 @@ def on_login_button_clicked(self) -> None:
         password = self.passwordLineEdit.text()
         remember_me = self.rememberMeCheckBox.isChecked()
 
-        self.network_manager.set_auth(server_url, username=username, password=password)
         self.network_manager.set_url(server_url)
-        self.network_manager.login(username, password)
+        self.network_manager.set_auth_method(CloudAuthMethod.CREDENTIALS)
+        self.network_manager.set_auth(server_url, username=username, password=password)
+        self.network_manager.login_with_credentials(username, password)
 
         self.preferences.set_value("qfieldCloudRememberMe", remember_me)
 
@@ -181,7 +338,7 @@ def on_login_finished(self) -> None:
             self.parent().setEnabled(True)
             self.setEnabled(True)
 
-        if not self.network_manager.has_token():
+        if not self.network_manager.is_authenticated():
             self.loginFeedbackLabel.setText(self.network_manager.get_last_login_error())
             self.loginFeedbackLabel.setVisible(True)
             self.usernameLineEdit.setEnabled(True)
@@ -195,5 +352,16 @@ def on_login_finished(self) -> None:
         self.rememberMeCheckBox.setEnabled(False)
         self.done(QDialog.Accepted)
 
+    def on_login_with_sso_provider_button_clicked(self, provider_data: dict) -> None:
+        server_url = self.serverUrlCmb.currentText()
+        auth_config = build_oauth2_auth_config(
+            provider_data,
+            server_url,
+        )
+        self.network_manager.set_url(server_url)
+        self.network_manager.set_auth_method(CloudAuthMethod.SSO)
+        self.network_manager.set_sso_auth_config(auth_config)
+        self.network_manager.login_with_sso()
+
     def on_cancel_button_clicked(self):
         self.reject()