Merge pull request #16026 from edx/MLoTurco/learner-1995

Include language specific templates in template lookup logic learner-1995

common/djangoapps/util/organizations_helpers.py

@@ -88,6 +88,16 @@ def get_course_organizations(course_id):
     return organizations_api.get_course_organizations(course_id)
 
 
+def get_course_organization_id(course_id):
+    """
+    Returns organization id for course or None if the course is not linked to an org
+    """
+    course_organization = get_course_organizations(course_id)
+    if course_organization:
+        return course_organization[0]['id']
+    return None
+
+
 def organizations_enabled():
     """
     Returns boolean indication if organizations app is enabled on not.

lms/djangoapps/certificates/admin.py

@@ -47,7 +47,7 @@ class CertificateTemplateAdmin(admin.ModelAdmin):
     """
     Django admin customizations for CertificateTemplate model
     """
-    list_display = ('name', 'description', 'organization_id', 'course_key', 'mode', 'is_active')
+    list_display = ('name', 'description', 'organization_id', 'course_key', 'mode', 'language', 'is_active')
     form = CertificateTemplateForm
 
 

lms/djangoapps/certificates/api.py

@@ -8,6 +8,7 @@ import logging
 
 from django.conf import settings
 from django.core.urlresolvers import reverse
+from django.db.models import Q
 from opaque_keys import InvalidKeyError
 from opaque_keys.edx.keys import CourseKey
 
@@ -27,7 +28,7 @@ from certificates.queue import XQueueCertInterface
 from eventtracking import tracker
 from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
 from openedx.core.djangoapps.xmodule_django.models import CourseKeyField
-from util.organizations_helpers import get_course_organizations
+from util.organizations_helpers import get_course_organization_id
 from xmodule.modulestore.django import modulestore
 
 log = logging.getLogger("edx.certificate")
@@ -463,49 +464,76 @@ def get_active_web_certificate(course, is_preview_mode=None):
     return None
 
 
-def get_certificate_template(course_key, mode, language):  # pylint: disable=unused-argument
+def get_certificate_template(course_key, mode, language):
     """
     Retrieves the custom certificate template based on course_key, mode, and language.
     """
-    org_id, template = None, None
+    template = None
     # fetch organization of the course
-    course_organization = get_course_organizations(course_key)
-    if course_organization:
-        org_id = course_organization[0]['id']
+    org_id = get_course_organization_id(course_key)
 
-    if org_id and mode:
-        template = CertificateTemplate.objects.filter(
+    # only consider active templates
+    active_templates = CertificateTemplate.objects.filter(is_active=True)
+
+    if org_id and mode:  # get template by org, mode, and key
+        org_mode_and_key_templates = active_templates.filter(
             organization_id=org_id,
-            course_key=course_key,
             mode=mode,
-            is_active=True
+            course_key=course_key
         )
-    # if don't template find by org and mode
-    if not template and org_id and mode:
-        template = CertificateTemplate.objects.filter(
+        template = get_language_specific_template_or_default(language, org_mode_and_key_templates)
+
+    # since no template matched that course_key, only consider templates with empty course_key
+    empty_course_key_templates = active_templates.filter(course_key=CourseKeyField.Empty)
+    if not template and org_id and mode:  # get template by org and mode
+        org_and_mode_templates = empty_course_key_templates.filter(
             organization_id=org_id,
-            course_key=CourseKeyField.Empty,
-            mode=mode,
-            is_active=True
+            mode=mode
         )
-    # if don't template find by only org
-    if not template and org_id:
-        template = CertificateTemplate.objects.filter(
+        template = get_language_specific_template_or_default(language, org_and_mode_templates)
+    if not template and org_id:  # get template by only org
+        org_templates = empty_course_key_templates.filter(
             organization_id=org_id,
-            course_key=CourseKeyField.Empty,
-            mode=None,
-            is_active=True
+            mode=None
         )
-    # if we still don't template find by only course mode
-    if not template and mode:
-        template = CertificateTemplate.objects.filter(
+        template = get_language_specific_template_or_default(language, org_templates)
+    if not template and mode:  # get template by only mode
+        mode_templates = empty_course_key_templates.filter(
             organization_id=None,
-            course_key=CourseKeyField.Empty,
-            mode=mode,
-            is_active=True
+            mode=mode
         )
+        template = get_language_specific_template_or_default(language, mode_templates)
+    #return template[0].template if template else None
+    return template.template if template else None
 
-    return template[0].template if template else None
+
+def get_language_specific_template_or_default(language, templates):
+    """
+    Returns templates that match passed in language.
+    Returns default templates If no language matches, or language passed is None
+    """
+    two_letter_language = _get_two_letter_language_code(language)
+    language_or_default_templates = list(templates.filter(Q(language=two_letter_language) | Q(language=None)))
+    language_specific_template = get_language_specific_template(language, language_or_default_templates)
+    if language_specific_template:
+        return language_specific_template
+    else:
+        return language_or_default_templates[0] if language_or_default_templates else None
+
+
+def get_language_specific_template(language, templates):
+    for template in templates:
+        if template.language == language:
+            return template
+    return None
+
+
+def _get_two_letter_language_code(language_code):
+    """
+    Shortens language to only first two characters (e.g. es-419 becomes es)
+    This is needed because Catalog returns locale language which is not always a 2 letter code.
+    """
+    return language_code[:2] if language_code else None
 
 
 def emit_certificate_event(event_name, user, course_id, course=None, event_data=None):

lms/djangoapps/certificates/migrations/0011_certificatetemplate_alter_unique.py

+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+import logging
+from django.db import migrations, models
+from opaque_keys.edx.keys import CourseKey
+from openedx.core.djangoapps.xmodule_django.models import CourseKeyField
+
+log = logging.getLogger(__name__)
+
+def revert_alter_unique(apps, schema_editor):
+    CertificateTemplateModel = apps.get_model("certificates", "CertificateTemplate")
+
+    all_unique_templates_ignoring_language = CertificateTemplateModel.objects.values_list(
+        "organization_id",
+        "course_key",
+        "mode").distinct()
+
+    for org_id, course_key, mode in all_unique_templates_ignoring_language:
+        key = CourseKey.from_string(course_key) if course_key else CourseKeyField.Empty
+        templates = CertificateTemplateModel.objects.filter(organization_id=org_id, course_key=key, mode=mode)
+        if templates.count() > 1:  
+            # remove all templates past the first (null or default languages are ordered first)
+            language_specific_templates = templates.order_by('language')[1:] 
+            language_specific_template_ids = language_specific_templates.values_list('id', flat=True)
+            for template in language_specific_templates:
+                log.info('Deleting template ' + str(template.id) +  ' with details {' +
+                    "  name: "+ str(template.name) +
+                    "  description: "+ str(template.description) +
+                    "  template: "+ str(template.template) +
+                    "  organization_id: "+ str(template.organization_id) +
+                    "  course_key: "+ str(template.course_key) +
+                    "  mode: "+ str(template.mode) +
+                    "  is_active: "+ str(template.is_active) +
+                    "  language: "+ str(template.language) + " }"
+                )
+            CertificateTemplateModel.objects.filter(id__in=list(language_specific_template_ids)).delete()
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('certificates', '0010_certificatetemplate_language'),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name='certificatetemplate',
+            unique_together=set([('organization_id', 'course_key', 'mode', 'language')]),
+        ),
+        migrations.RunPython(migrations.RunPython.noop, reverse_code=revert_alter_unique)
+    ]

lms/djangoapps/certificates/models.py

@@ -1063,7 +1063,7 @@ class CertificateTemplate(TimeStampedModel):
 
     class Meta(object):
         get_latest_by = 'created'
-        unique_together = (('organization_id', 'course_key', 'mode'),)
+        unique_together = (('organization_id', 'course_key', 'mode', 'language'),)
         app_label = "certificates"
 
 

lms/djangoapps/certificates/signals.py

@@ -7,7 +7,6 @@ from django.db.models.signals import post_save
 from django.dispatch import receiver
 
 from certificates.models import (
-    CertificateGenerationCourseSetting,
     CertificateWhitelist,
     CertificateStatuses,
     GeneratedCertificate