Merge branch 'master' into release

Author: gounux

.env.example

@@ -134,6 +134,16 @@ QFIELDCLOUD_SUBSCRIPTION_MODEL=subscription.Subscription
 # DEFAULT: 720
 QFIELDCLOUD_AUTH_TOKEN_EXPIRATION_HOURS=720
 
+# Whether QFieldCloud should be translated in another language other than English.
+# NOTE if there is no full translation in given language, QFieldCloud will be shown in mixture of English and the given language. Also installed Django modules have their own translations that might not be complete.
+# VALUES: 0 - English only; 1 - enable other languages
+# DEFAULT: 1
+QFIELDCLOUD_USE_I18N=1
+
+# QFieldCloud default language that is displayed in the interface
+# DEFAULT: "en"
+QFIELDCLOUD_DEFAULT_LANGUAGE="en"
+
 # QFieldCloud default timezone that is used when account has no timezone
 # DEFAULT: "Europe/Zurich"
 QFIELDCLOUD_DEFAULT_TIME_ZONE="Europe/Zurich"

.github/workflows/sync_translations.yml

@@ -0,0 +1,55 @@
+name: 🌎 Synchronize translations with Transifex
+
+on:
+    schedule:
+      - cron: "0 2 * * *"
+    workflow_dispatch:
+
+jobs:
+
+  sync_translations:
+
+    name: Synchronize Transifex translations
+    runs-on: ubuntu-latest
+
+    env:
+      TX_TOKEN: ${{ secrets.TX_TOKEN }}
+
+    steps:
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.NYUKI_TOKEN }}
+
+      - name: Install Transifex CLI
+        run: |
+            curl -OL https://github.com/transifex/cli/releases/download/v1.6.17/tx-linux-amd64.tar.gz
+            tar -xvzf tx-linux-amd64.tar.gz
+
+      - name: Copy .env file
+        run: |
+          cp .env.example .env
+
+      - name: Perform docker pre operations
+        run: |
+            docker compose pull
+            docker compose build
+
+      - name: Generate Django translation po files
+        run: |
+            docker compose run --user root app python manage.py makemessages -l es
+
+      - name: Push translation files to Transifex
+        run: ./tx push --source
+
+      - name: Pull from Transifex
+        run: ./tx pull --all --minimum-perc 0 --force
+
+      - name: Add and commit new translations
+        uses: EndBug/add-and-commit@v9
+        with:
+          message: Synchronize translations
+          author_name: Translation update 💬
+          author_email: [email protected]
+          add: '["docker-app/qfieldcloud/locale"]'

.gitignore

@@ -16,3 +16,6 @@ Pipfile*
 **/site-packages
 docker-qgis/libqfieldsync
 docker-qgis/qfieldcloud-sdk-python
+
+# compiled translations
+docker-app/qfieldcloud/locale/**/*.mo

.pre-commit-config.yaml

@@ -50,3 +50,5 @@ repos:
         additional_dependencies: [types-pytz, types-Deprecated, types-PyYAML, types-requests, types-tabulate, types-jsonschema, django-stubs, django-stubs-ext, djangorestframework-stubs]
         pass_filenames: false
         entry: bash -c 'mypy -p docker-app -p docker-qgis "$@"' --
+
+exclude: 'docker-app/qfieldcloud/locale/.*'

.tx/config

@@ -0,0 +1,8 @@
+[main]
+host = https://www.transifex.com
+
+[o:opengisch:p:qfieldcloud:r:qfieldcloud]
+file_filter   = docker-app/qfieldcloud/locale/<lang>/LC_MESSAGES/django.po
+source_file   = docker-app/qfieldcloud/locale/en/LC_MESSAGES/django.po
+type          = PO
+resource_name = QFieldCloud

README.md

@@ -76,6 +76,10 @@ Now you can get started by adding the first user that would also be a super user
 
     docker compose run app python manage.py createsuperuser --username super_user --email [email protected]
 
+If QFieldCloud needs to be translated, you can compile the translations using Django's tooling:
+
+    docker compose run --user root app python manage.py compilemessages
+
 ### Dependencies
 
 QFieldCloud uses [`pip-compile`](https://pypi.org/project/pip-tools/) to manage it's dependencies.
@@ -84,7 +88,7 @@ When a `pip` a dependency is changed, the developer should produce the new `requ
 
     docker compose run --rm pipcompile
 
-Alterantively, one can create only a `requirements.txt` file for a single `requirements.in`:
+Alternatively, one can create only a `requirements.txt` file for a single `requirements.in`:
 
     docker compose run --rm pipcompile pip-compile --no-strip-extras -o requirements/requirements_worker_wrapper.txt requirements/requirements_worker_wrapper.in
 

docker-app/qfieldcloud/core/admin.py

@@ -745,7 +745,7 @@ class ProjectForm(ModelForm):
 
     class Meta:
         model = Project
-        widgets = {"project_filename": widgets.TextInput()}
+        widgets = {"the_qgis_file_name": widgets.TextInput()}
         fields = "__all__"  # required for Django 3.x
 
 
@@ -774,7 +774,7 @@ class ProjectAdmin(QFieldCloudModelAdmin):
         "owner",
         "status",
         "status_code",
-        "project_filename",
+        "the_qgis_file_name",
         "overwrite_conflicts",
         "has_restricted_projectfiles",
         "file_storage_bytes",
@@ -943,6 +943,7 @@ class JobAdmin(QFieldCloudModelAdmin):
         "status",
         "error_type",
         "type",
+        "qgis_version",
         "created_at",
         "updated_at",
         "started_at",
@@ -1214,14 +1215,14 @@ def response_change(self, request, delta):
         return super().response_change(request, delta)
 
     def apply_delta(self, request, delta):
-        if not delta.project.project_filename:
+        if not delta.project.has_the_qgis_file:
             self.message_user(request, "Missing project file")
             raise exceptions.NoQGISProjectError()
 
         if not jobs.apply_deltas(
             delta.project,
             request.user,
-            delta.project.project_filename,
+            delta.project.the_qgis_file_name,
             delta.project.overwrite_conflicts,
             delta_ids=[str(delta.id)],
         ):

docker-app/qfieldcloud/core/management/commands/calcprojectstorage.py

@@ -25,7 +25,7 @@ def handle(self, *args, **options):
             extra_filters["file_storage_bytes"] = 0
 
         projects_qs = Project.objects.filter(
-            project_filename__isnull=False,
+            the_qgis_filename__isnull=False,
             **extra_filters,
         ).order_by("-updated_at")
         total_count = projects_qs.count()

docker-app/qfieldcloud/core/migrations/0080_rename_project_filename_project_the_qgis_file_name.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.17 on 2025-01-23 19:25
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0079_organizationmember_created_at_and_more"),
+    ]
+
+    operations = [
+        migrations.RenameField(
+            model_name="project",
+            old_name="project_filename",
+            new_name="the_qgis_file_name",
+        ),
+    ]

docker-app/qfieldcloud/core/models.py

@@ -1037,7 +1037,7 @@ class Meta:
     )
 
     description = models.TextField(blank=True)
-    project_filename = models.TextField(blank=True, null=True)
+    the_qgis_file_name = models.TextField(blank=True, null=True)
     project_details = models.JSONField(blank=True, null=True)
     is_public = models.BooleanField(
         default=False,
@@ -1121,6 +1121,10 @@ class Meta:
         choices=PackagingOffliner.choices,
     )
 
+    @property
+    def has_the_qgis_file(self) -> bool:
+        return bool(self.the_qgis_file_name)
+
     @property
     def owner_aware_storage_keep_versions(self) -> int:
         """Determine the storage versions to keep based on the owner's subscription plan and project settings.
@@ -1257,7 +1261,7 @@ def needs_repackaging(self) -> bool:
     def problems(self) -> list[dict]:
         problems = []
 
-        if not self.project_filename:
+        if not self.has_the_qgis_file:
             problems.append(
                 {
                     "layer": None,
@@ -1349,7 +1353,7 @@ def status(self) -> "Project.Status":
             max_premium_collaborators_per_private_project = self.owner.useraccount.current_subscription.plan.max_premium_collaborators_per_private_project
 
             # TODO use self.problems to get if there are project problems
-            if not self.project_filename or not self.project_details:
+            if not self.has_the_qgis_file or not self.project_details:
                 status = Project.Status.FAILED
                 status_code = Project.StatusCode.FAILED_PROCESS_PROJECTFILE
             elif (
@@ -1764,6 +1768,30 @@ def fallback_output(self) -> str:
                 "The job ended in unknown state. Please verify the project is configured properly, try again and contact QFieldCloud support for more information."
             )
 
+    @property
+    def qgis_version(self) -> str | None:
+        """Returns QGIS app version used for the job.
+
+        The QGIS version is the one coming from the instanciated worker QGIS app.
+        The version number would be in `Major.Minor.Patch-NAME` format, e.g. 3.40.2-Bratislava
+
+        Returns:
+            str | None: QGIS version if found else None.
+        """
+        if not self.feedback:
+            return None
+
+        feedback_step_data = self.get_feedback_step_data("start_qgis_app")
+
+        if not feedback_step_data:
+            return None
+
+        if "qgis_version" in feedback_step_data["returns"]:
+            qgis_version = feedback_step_data["returns"]["qgis_version"]
+            return qgis_version
+
+        return None
+
     def check_can_be_created(self):
         from qfieldcloud.core.permissions_utils import (
             check_supported_regarding_owner_account,