Add new fields to project admin form

Author: eemeli

pontoon/administration/forms.py

@@ -38,9 +38,10 @@ class ProjectForm(forms.ModelForm):
 
     def clean(self):
         cleaned_data = super().clean()
+        set_locales_from_repo = cleaned_data.get("set_locales_from_repo")
         locales_readonly = cleaned_data.get("locales_readonly")
         locales = cleaned_data.get("locales")
-        if not (locales or locales_readonly):
+        if not (set_locales_from_repo or locales or locales_readonly):
             raise ValidationError("At least one locale must be selected.")
 
     class Meta:
@@ -61,6 +62,8 @@ class Meta:
             "sync_disabled",
             "tags_enabled",
             "pretranslation_enabled",
+            "set_locales_from_repo",
+            "set_translated_resources_from_repo",
             "visibility",
         )
 

pontoon/administration/static/css/admin_project.css

@@ -184,6 +184,10 @@ form a:visited {
   text-transform: uppercase;
 }
 
+.locales {
+  margin-top: 40px;
+}
+
 .double-list-selector .locale.select .menu {
   background: transparent;
   border-bottom: 1px solid var(--main-border-1);

pontoon/administration/static/js/admin_project.js

@@ -76,8 +76,9 @@ $(function () {
 
     button.addClass('in-progress').html('Syncing...');
 
+    const slug = $('#id_slug').val();
     $.ajax({
-      url: '/admin/projects/' + $('#id_slug').val() + '/sync/',
+      url: `/admin/projects/${slug}/sync/`,
       success: function () {
         button.html('Started');
       },
@@ -105,8 +106,9 @@ $(function () {
 
     button.addClass('in-progress').html('Pretranslating...');
 
+    const slug = $('#id_slug').val();
     $.ajax({
-      url: '/admin/projects/' + $('#id_slug').val() + '/pretranslate/',
+      url: `/admin/projects/${slug}/pretranslate/`,
       success: function () {
         button.html('Started');
       },
@@ -166,6 +168,51 @@ $(function () {
     });
   });
 
+  const setLocalesCheckbox = $('#id_set_locales_from_repo');
+  const configFileInput = $('#id_configuration_file');
+  function setLocalesUpdate() {
+    const configFile = configFileInput.val();
+    let reqSync = configFile !== configFileInput.data('init');
+
+    const controls = $('.repo-locale-control');
+    if ($('#id_data_source').val() === 'repository') {
+      controls.show();
+    } else {
+      controls.hide();
+      setLocalesCheckbox.prop('checked', false);
+      reqSync = false;
+    }
+
+    const label = $('#id_set_locales_from_repo + span');
+    const hint = $('#hint_set_locales_from_repo');
+    if (configFile) {
+      label.text('Read locales from configuration file');
+      hint.hide();
+    } else {
+      label.text('Set locales from repository');
+      hint.show();
+    }
+
+    const setLocalesFromRepo = setLocalesCheckbox.prop('checked');
+    const trDiv = $('#translated_resources_from_repo');
+    const locales = $('.locales, .locales-toolbar');
+    if (setLocalesFromRepo) {
+      trDiv.toggle(!configFile);
+      locales.hide();
+      reqSync ||= setLocalesFromRepo !== setLocalesCheckbox.data('init');
+    } else {
+      trDiv.hide();
+      locales.show();
+    }
+
+    $('button.save').text(reqSync ? 'Save & sync project' : 'Save project');
+  }
+  setLocalesCheckbox.data('init', setLocalesCheckbox.prop('checked'));
+  setLocalesCheckbox.on('change', setLocalesUpdate);
+  configFileInput.data('init', configFileInput.val());
+  configFileInput.on('change', setLocalesUpdate);
+  setLocalesUpdate();
+
   self.NProgressUnbind();
 
   // Set locales to existing projects to be copied to the current project

pontoon/administration/templates/admin_project.html

@@ -54,7 +54,29 @@ <h1>
 
     <h3>Locales</h3>
 
-    <div class="locales clearfix">
+    <div class="repo-locale-control checkbox clearfix">
+      <label for="id_set_locales_from_repo">
+        {{ form.set_locales_from_repo }}
+        <span></span>
+      </label>
+      <span id="hint_set_locales_from_repo"
+        >Locale is available if target directory is present.</span
+      >
+    </div>
+
+    <div
+      class="repo-locale-control checkbox clearfix"
+      id="translated_resources_from_repo"
+      style="display: none"
+    >
+      <label for="id_set_translated_resources_from_repo">
+        {{ form.set_translated_resources_from_repo }} Set per-resource
+        localizability from repository
+      </label>
+      Resource is available if target file is present in locale directory.
+    </div>
+
+    <div class="locales clearfix" style="display: none">
       {{ admin_team_selector.render(locales_available, locales_selected, locales_readonly) }}
       {{ form.locales }}
       {{ form.locales.errors }}

pontoon/administration/views.py

@@ -1,6 +1,8 @@
 import csv
 import logging
 
+from typing import cast
+
 from django.conf import settings
 from django.contrib.auth.decorators import login_required
 from django.core.exceptions import PermissionDenied
@@ -33,6 +35,8 @@
 from pontoon.pretranslation.tasks import pretranslate_task
 from pontoon.sync.tasks import sync_project_task
 
+from ..base.models.project import ProjectQuerySet
+
 
 log = logging.getLogger(__name__)
 
@@ -127,6 +131,8 @@ def manage_project(request, slug=None, template="admin_project.html"):
     subtitle = "Add project"
     pk = None
     project = None
+    prev_config_file = None
+    prev_set_locales_from_repo = False
 
     # Save project
     if request.method == "POST":
@@ -143,7 +149,11 @@ def manage_project(request, slug=None, template="admin_project.html"):
         # Update existing project
         try:
             pk = request.POST["pk"]
-            project = Project.objects.visible_for(request.user).get(pk=pk)
+            project = (
+                cast(ProjectQuerySet, Project.objects)
+                .visible_for(request.user)
+                .get(pk=pk)
+            )
             form = ProjectForm(request.POST, instance=project)
             # Needed if form invalid
             repo_formset = RepositoryInlineFormSet(request.POST, instance=project)
@@ -156,6 +166,8 @@ def manage_project(request, slug=None, template="admin_project.html"):
                 request.POST, instance=project
             )
             subtitle = "Edit project"
+            prev_config_file = project.configuration_file
+            prev_set_locales_from_repo = project.set_locales_from_repo
 
         # Add a new project
         except MultiValueDictKeyError:
@@ -166,7 +178,7 @@ def manage_project(request, slug=None, template="admin_project.html"):
             tag_formset = None
 
         if form.is_valid():
-            project = form.save(commit=False)
+            project = cast(Project, form.save(commit=False))
             repo_formset = RepositoryInlineFormSet(request.POST, instance=project)
             external_resource_formset = ExternalResourceInlineFormSet(
                 request.POST, instance=project
@@ -180,38 +192,43 @@ def manage_project(request, slug=None, template="admin_project.html"):
             )
             if formsets_valid:
                 project.save()
-
-                # Manually save ProjectLocales due to intermediary model
-                locales_form = form.cleaned_data.get("locales", [])
-                locales_readonly_form = form.cleaned_data.get("locales_readonly", [])
-                locales = locales_form | locales_readonly_form
-
-                (
-                    ProjectLocale.objects.filter(project=project)
-                    .exclude(locale__pk__in=[loc.pk for loc in locales])
-                    .delete()
-                )
-
-                for locale in locales:
-                    # The implicit pre_save and post_save signals sent here are required
-                    # to maintain django-guardian permissions.
-                    ProjectLocale.objects.get_or_create(project=project, locale=locale)
-
-                project_locales = ProjectLocale.objects.filter(project=project)
-
-                # Update readonly flags
-                locales_readonly_pks = [loc.pk for loc in locales_readonly_form]
-                project_locales.filter(readonly=True).exclude(
-                    locale__pk__in=locales_readonly_pks
-                ).update(readonly=False)
-                project_locales.filter(
-                    locale__pk__in=locales_readonly_pks, readonly=False
-                ).update(readonly=True)
+                pk = project.pk
+                data = form.cleaned_data
+
+                set_locales_from_repo = data.get("set_locales_from_repo", False)
+
+                if set_locales_from_repo:
+                    project_locales = ProjectLocale.objects.filter(project=project)
+                else:
+                    # Manually save ProjectLocales due to intermediary model
+                    locales_form = data.get("locales", set())
+                    locales_readonly_form = data.get("locales_readonly", set())
+                    locales = locales_form | locales_readonly_form
+
+                    ProjectLocale.objects.filter(project=project).exclude(
+                        locale__pk__in=[loc.pk for loc in locales]
+                    ).delete()
+
+                    for locale in locales:
+                        # The implicit pre_save and post_save signals sent here are required
+                        # to maintain django-guardian permissions.
+                        ProjectLocale.objects.get_or_create(
+                            project=project, locale=locale
+                        )
+
+                    project_locales = ProjectLocale.objects.filter(project=project)
+
+                    # Update readonly flags
+                    locales_readonly_pks = [loc.pk for loc in locales_readonly_form]
+                    project_locales.filter(readonly=True).exclude(
+                        locale__pk__in=locales_readonly_pks
+                    ).update(readonly=False)
+                    project_locales.filter(
+                        locale__pk__in=locales_readonly_pks, readonly=False
+                    ).update(readonly=True)
 
                 # Update pretranslate flags
-                locales_pretranslate_form = form.cleaned_data.get(
-                    "locales_pretranslate", []
-                )
+                locales_pretranslate_form = data.get("locales_pretranslate", [])
                 locales_pretranslate_pks = [loc.pk for loc in locales_pretranslate_form]
                 project_locales.filter(pretranslation_enabled=True).exclude(
                     locale__pk__in=locales_pretranslate_pks,
@@ -239,7 +256,14 @@ def manage_project(request, slug=None, template="admin_project.html"):
                 if project.tags_enabled:
                     tag_formset = TagInlineFormSet(instance=project)
                 subtitle += ". Saved."
-                pk = project.pk
+
+                if project.data_source == Project.DataSource.REPOSITORY and (
+                    set_locales_from_repo
+                    and not prev_set_locales_from_repo
+                    or data.get("configuration_file") != prev_config_file
+                ):
+                    sync_project_task.delay(project.pk)
+                    subtitle += " Sync started."
             else:
                 subtitle += ". Error."
         else: