Improve MM QGIS expression variables (#688)

* Improve MM QGIS expression variables

introduces new QGIS expression variable mergin_full_name, mergin_user_email and add additional variable with prefix mm.

Author: Withalion

Mergin/configuration_dialog.py

@@ -99,34 +99,52 @@ def check_master_password(self):
 
     def writeSettings(self):
         url = self.server_url()
-        username = self.ui.username.text()
-        password = self.ui.password.text()
+        login_name = self.ui.username.text()
+        login_password = self.ui.password.text()
         settings = QSettings()
         settings.setValue("Mergin/auth_token", None)  # reset token
         settings.setValue("Mergin/saveCredentials", str(self.ui.save_credentials.isChecked()))
-        settings.setValue("Mergin/username", username)
 
         if self.ui.save_credentials.isChecked():
-            set_mergin_auth(url, username, password)
+            set_mergin_auth(url, login_name, login_password)
             try:
                 mc = create_mergin_client()
             except (URLError, ClientError, LoginError):
                 mc = None
         else:
             try:
                 proxy_config = get_qgis_proxy_config(url)
-                mc = MerginClient(url, None, username, password, get_plugin_version(), proxy_config)
+                mc = MerginClient(url, None, login_name, login_password, get_plugin_version(), proxy_config)
                 settings.setValue("Mergin/auth_token", mc._auth_session["token"])
                 settings.setValue("Mergin/server", url)
             except (URLError, ClientError, LoginError) as e:
                 QgsApplication.messageLog().logMessage(f"Mergin Maps plugin: {str(e)}")
                 mc = None
 
         QgsExpressionContextUtils.setGlobalVariable("mergin_url", url)
+        QgsExpressionContextUtils.setGlobalVariable("mm_url", url)
         if mc:
+            # username can be username or email, so we fetch it from api
+            user_info = mc.user_info()
+            username = user_info["username"]
+            user_email = user_info["email"]
+            user_full_name = user_info["name"]
+            settings.setValue("Mergin/username", username)
+            settings.setValue("Mergin/user_email", user_email)
+            settings.setValue("Mergin/full_name", user_full_name)
             QgsExpressionContextUtils.setGlobalVariable("mergin_username", username)
+            QgsExpressionContextUtils.setGlobalVariable("mergin_user_email", user_email)
+            QgsExpressionContextUtils.setGlobalVariable("mergin_full_name", user_full_name)
+            QgsExpressionContextUtils.setGlobalVariable("mm_username", username)
+            QgsExpressionContextUtils.setGlobalVariable("mm_user_email", user_email)
+            QgsExpressionContextUtils.setGlobalVariable("mm_full_name", user_full_name)
         else:
             QgsExpressionContextUtils.removeGlobalVariable("mergin_username")
+            QgsExpressionContextUtils.removeGlobalVariable("mergin_user_email")
+            QgsExpressionContextUtils.removeGlobalVariable("mergin_full_name")
+            QgsExpressionContextUtils.removeGlobalVariable("mm_username")
+            QgsExpressionContextUtils.removeGlobalVariable("mm_user_email")
+            QgsExpressionContextUtils.removeGlobalVariable("mm_full_name")
 
         return mc
 

Mergin/plugin.py

@@ -103,7 +103,13 @@ def __init__(self, iface):
 
         settings = QSettings()
         QgsExpressionContextUtils.setGlobalVariable("mergin_username", settings.value("Mergin/username", ""))
+        QgsExpressionContextUtils.setGlobalVariable("mm_username", settings.value("Mergin/username", ""))
         QgsExpressionContextUtils.setGlobalVariable("mergin_url", settings.value("Mergin/server", ""))
+        QgsExpressionContextUtils.setGlobalVariable("mm_url", settings.value("Mergin/server", ""))
+        QgsExpressionContextUtils.setGlobalVariable("mergin_full_name", settings.value("Mergin/full_name", ""))
+        QgsExpressionContextUtils.setGlobalVariable("mm_full_name", settings.value("Mergin/full_name", ""))
+        QgsExpressionContextUtils.setGlobalVariable("mergin_user_email", settings.value("Mergin/user_email", ""))
+        QgsExpressionContextUtils.setGlobalVariable("mm_user_email", settings.value("Mergin/user_email", ""))
 
     def initProcessing(self):
         QgsApplication.processingRegistry().addProvider(self.provider)
@@ -533,7 +539,13 @@ def unload(self):
 
         remove_project_variables()
         QgsExpressionContextUtils.removeGlobalVariable("mergin_username")
+        QgsExpressionContextUtils.removeGlobalVariable("mm_username")
         QgsExpressionContextUtils.removeGlobalVariable("mergin_url")
+        QgsExpressionContextUtils.removeGlobalVariable("mm_url")
+        QgsExpressionContextUtils.removeGlobalVariable("mergin_full_name")
+        QgsExpressionContextUtils.removeGlobalVariable("mm_full_name")
+        QgsExpressionContextUtils.removeGlobalVariable("mergin_user_email")
+        QgsExpressionContextUtils.removeGlobalVariable("mm_user_email")
         QgsApplication.instance().dataItemProviderRegistry().removeProvider(self.data_item_provider)
         self.data_item_provider = None
         # this is crashing qgis on exit

Mergin/ui/ui_project_config.ui

@@ -44,9 +44,9 @@
       <property name="geometry">
        <rect>
         <x>0</x>
-        <y>-422</y>
-        <width>624</width>
-        <height>978</height>
+        <y>-442</y>
+        <width>617</width>
+        <height>1104</height>
        </rect>
       </property>
       <layout class="QVBoxLayout" name="verticalLayout">
@@ -221,7 +221,7 @@
           <item row="1" column="1" colspan="2">
            <widget class="QLabel" name="label_6">
             <property name="text">
-             <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;&lt;strong&gt;Photo name format&lt;/strong&gt;&lt;/p&gt;&lt;p&gt;Set up custom photo names format based on an expression. Make sure that the name is unique for each photo.&lt;/p&gt;&lt;p&gt;Pro tip: use variables like &lt;code&gt;@mergin_username&lt;/code&gt;, &lt;code&gt;@layer_name&lt;/code&gt; or layer fields in combination with &lt;code&gt;now()&lt;/code&gt; (to get the current time) in order to generate unique photo names.&lt;/p&gt;&lt;p&gt;For further details, please refer to &lt;a href=&quot;https://merginmaps.com/docs/layer/settingup_forms_photo/#customising-photo-name-format-with-expressions&quot;&gt;our documentation&lt;/a&gt;.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+             <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;Photo name format&lt;/span&gt;&lt;/p&gt;&lt;p&gt;Set up custom photo names format based on an expression. Make sure that the name is unique for each photo.&lt;/p&gt;&lt;p&gt;Pro tip: use variables like &lt;span style=&quot; font-family:'Noto Sans Mono';&quot;&gt;@mm_user_email&lt;/span&gt;, &lt;span style=&quot; font-family:'Noto Sans Mono';&quot;&gt;@layer_name&lt;/span&gt; or layer fields in combination with &lt;span style=&quot; font-family:'Noto Sans Mono';&quot;&gt;now()&lt;/span&gt; (to get the current time) in order to generate unique photo names.&lt;/p&gt;&lt;p&gt;For further details, please refer to &lt;a href=&quot;https://merginmaps.com/docs/layer/settingup_forms_photo/#customising-photo-name-format-with-expressions&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#1d99f3;&quot;&gt;our documentation&lt;/span&gt;&lt;/a&gt;.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
             </property>
             <property name="wordWrap">
              <bool>true</bool>

Mergin/utils.py

@@ -953,6 +953,11 @@ def write_project_variables(project_owner, project_name, project_full_name, vers
     QgsExpressionContextUtils.setProjectVariable(QgsProject.instance(), "mergin_project_full_name", project_full_name)
     QgsExpressionContextUtils.setProjectVariable(QgsProject.instance(), "mergin_project_version", int_version(version))
     QgsExpressionContextUtils.setProjectVariable(QgsProject.instance(), "mergin_project_server", server)
+    QgsExpressionContextUtils.setProjectVariable(QgsProject.instance(), "mm_project_name", project_name)
+    QgsExpressionContextUtils.setProjectVariable(QgsProject.instance(), "mm_project_owner", project_owner)
+    QgsExpressionContextUtils.setProjectVariable(QgsProject.instance(), "mm_project_full_name", project_full_name)
+    QgsExpressionContextUtils.setProjectVariable(QgsProject.instance(), "mm_project_version", int_version(version))
+    QgsExpressionContextUtils.setProjectVariable(QgsProject.instance(), "mm_project_server", server)
 
 
 def remove_project_variables():
@@ -961,6 +966,11 @@ def remove_project_variables():
     QgsExpressionContextUtils.removeProjectVariable(QgsProject.instance(), "mergin_project_version")
     QgsExpressionContextUtils.removeProjectVariable(QgsProject.instance(), "mergin_project_owner")
     QgsExpressionContextUtils.removeProjectVariable(QgsProject.instance(), "mergin_project_server")
+    QgsExpressionContextUtils.removeProjectVariable(QgsProject.instance(), "mm_project_name")
+    QgsExpressionContextUtils.removeProjectVariable(QgsProject.instance(), "mm_project_full_name")
+    QgsExpressionContextUtils.removeProjectVariable(QgsProject.instance(), "mm_project_version")
+    QgsExpressionContextUtils.removeProjectVariable(QgsProject.instance(), "mm_project_owner")
+    QgsExpressionContextUtils.removeProjectVariable(QgsProject.instance(), "mm_project_server")
 
 
 def pretty_summary(summary):
@@ -1489,7 +1499,7 @@ def setup_tracking_layer(layer: QgsVectorLayer):
 
     idx = layer.fields().indexFromName("tracked_by")
     user_default = QgsDefaultValue()
-    user_default.setExpression("@mergin_username")
+    user_default.setExpression("@mm_username")
     layer.setDefaultValueDefinition(idx, user_default)
 
     layer.setDisplayExpression(