Merge pull request #1640 from dimagi/make-form-title-translatable

Make form title translatable

src/main/java/org/commcare/formplayer/objects/SerializableFormSession.java

@@ -51,7 +51,7 @@ public enum SubmitStatus {
     @Column(name = "menu_session_id", updatable = false)
     private String menuSessionId;
 
-    @Column(updatable = false)
+    @Setter
     private String title;
 
     @Column(name = "onequestionperscreen", updatable = false)

src/main/java/org/commcare/formplayer/services/NewFormResponseFactory.java

@@ -108,7 +108,8 @@ public NewFormResponse getResponse(NewSessionRequestBean bean, String postUrl) t
                 bean.getRestoreAsCaseId(),
                 null,
                 formplayerRemoteInstanceFetcher,
-                bean.getWindowWidth()
+                bean.getWindowWidth(),
+                null
         );
 
         NewFormResponse response = getResponse(formSession);

src/main/java/org/commcare/formplayer/session/FormSession.java

@@ -5,6 +5,7 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 
+import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.commcare.core.interfaces.RemoteInstanceFetcher;
@@ -27,6 +28,7 @@
 import org.commcare.session.CommCareSession;
 import org.commcare.session.SessionFrame;
 import org.commcare.suite.model.StackFrameStep;
+import org.commcare.suite.model.Text;
 import org.commcare.util.CommCarePlatform;
 import org.commcare.util.engine.CommCareConfigEngine;
 import org.javarosa.core.model.FormDef;
@@ -36,6 +38,7 @@
 import org.javarosa.core.model.instance.FormInstance;
 import org.javarosa.core.model.instance.TreeReference;
 import org.javarosa.core.model.utils.DateUtils;
+import org.javarosa.core.services.locale.Localization;
 import org.javarosa.core.services.storage.StorageManager;
 import org.javarosa.core.util.UnregisteredLocaleException;
 import org.javarosa.engine.FunctionExtensions;
@@ -90,6 +93,7 @@ public class FormSession {
     private boolean suppressAutosync;
     private boolean shouldSkipFullFormValidation;
     private String windowWidth;
+    private Text formTitleText;
 
     public FormSession(SerializableFormSession session,
             RestoreFactory restoreFactory,
@@ -108,7 +112,9 @@ public FormSession(SerializableFormSession session,
 
         this.sandbox = restoreFactory.getSandbox();
         this.windowWidth = windowWidth;
-
+        if (commCareSession != null && commCareSession.getCurrentEntry() != null) {
+            this.formTitleText = commCareSession.getCurrentEntry().getText();
+        }
         this.formDef = formDefinitionService.getFormDef(this.session);
 
         loadInstanceXml(this.formDef, session.getInstanceXml());
@@ -150,12 +156,14 @@ public FormSession(UserSqlSandbox sandbox,
             String caseId,
             @Nullable SessionFrame sessionFrame,
             RemoteInstanceFetcher instanceFetcher,
-            String windowWidth) throws Exception {
+            String windowWidth,
+            Text formTitleText) throws Exception {
         // use this.formDef to mutate (e.g., inject instance content, set callout handler)
         this.formDef = formDef;
+        this.formTitleText = formTitleText;
         this.session = new SerializableFormSession(
                 domain, appId, TableBuilder.scrubName(username), asUser, caseId,
-                postUrl, menuSessionId, formDef.getTitle(), oneQuestionPerScreen,
+                postUrl, menuSessionId, getLocalizedFormTitle(), oneQuestionPerScreen,
                 locale, inPromptMode, sessionData, functionContext
         );
         this.session.setFormDefinition(serializableFormDefinition);
@@ -183,6 +191,18 @@ public FormSession(UserSqlSandbox sandbox,
         }
     }
 
+    public void updateFormTitle() {
+        session.setTitle(getLocalizedFormTitle());
+    }
+
+    private String getLocalizedFormTitle() {
+        if (formTitleText == null) {
+            return formDef.getTitle();
+        } else {
+            return formTitleText.evaluate();
+        }
+    }
+
     @Trace
     private void setupJavaRosaObjects() {
         formEntryModel = new FormEntryModel(formDef, FormEntryModel.REPEAT_STRUCTURE_LINEAR);
@@ -634,6 +654,8 @@ public void setIsAtFirstIndex(boolean isAtFirstIndex) {
     public void changeLocale(String locale) {
         session.setInitLang(locale);
         formEntryController.setLanguage(locale);
+        Localization.setLocale(locale);
+        updateFormTitle();
     }
 
     public SerializableFormSession getSerializableSession() {

src/main/java/org/commcare/formplayer/session/MenuSession.java

@@ -409,7 +409,7 @@ public FormSession getFormEntrySession(FormSendCalloutHandler formSendCalloutHan
                 session.getDomain(), sessionData, postUrl, session.getLocale(), session.getId(), null,
                 oneQuestionPerScreen, session.getAsUser(), session.getAppId(), null, formSendCalloutHandler,
                 storageFactory, false, null, new SessionFrame(sessionWrapper.getFrame()),
-                instanceFetcher, getWindowWidth());
+                instanceFetcher, getWindowWidth(), sessionWrapper.getCurrentEntry().getText());
     }
 
     public SessionWrapper getSessionWrapper() {

src/test/java/org/commcare/formplayer/tests/CaseClaimNavigationTests.java

@@ -349,7 +349,7 @@ public void testClearCachesAfterFormSubmission() throws Exception {
                     queryData,
                     NewFormResponse.class);
         }
-        assertEquals("Close", formResponse.getTitle());
+        assertEquals("Close again", formResponse.getTitle());
 
         ExternalDataInstanceSource source = getInstanceSourceFromSession(
                 formResponse.getSessionId(), VirtualInstances.getRemoteReference("results"));

src/test/java/org/commcare/formplayer/tests/FormEntryWithQueryTests.java

@@ -152,7 +152,7 @@ public void testNavigationToFormEntryWithMultipleQueries() throws Exception {
                 CommandListResponseBean.class);
 
         assertEquals(1, menuResponse.getCommands().length);
-        assertEquals("Dedupe Form", menuResponse.getCommands()[0].getDisplayText());
+        assertEquals("Followup Form", menuResponse.getCommands()[0].getDisplayText());
 
         // verify the second query block to fetch the remote case was executed as well as the 3rd
         // query block

src/test/java/org/commcare/formplayer/tests/LocalizationTests.java

@@ -59,13 +59,17 @@ public void testInFormLocalization() throws Exception {
 
         assert newFormResponse.getTree().length == 2;
 
+        assert newFormResponse.getTitle().equals("English Form 1");
+
         assert newFormResponse.getTree()[0].getCaption().equals("I'm English");
 
         assert newFormResponse.getTree()[1].getCaption().equals("English rules");
 
         FormEntryResponseBean formResponse = this.changeLanguage("es",
                 newFormResponse.getSessionId());
 
+        assert formResponse.getTitle().equals("Spanish Form 1");
+
         assert formResponse.getTree()[0].getCaption().equals("I'm Spanish");
 
         assert formResponse.getTree()[1].getCaption().equals("No Spanish rules");
@@ -85,6 +89,8 @@ public void testFormLocalization() throws Exception {
 
         assert newFormResponse.getTree().length == 2;
 
+        assert newFormResponse.getTitle().equals("English Form 1");
+
         assert newFormResponse.getTree()[0].getCaption().equals("I'm English");
 
         assert newFormResponse.getTree()[1].getCaption().equals("English rules");
@@ -94,6 +100,8 @@ public void testFormLocalization() throws Exception {
 
         assert newFormResponseSpanish.getTree().length == 2;
 
+        assert newFormResponseSpanish.getTitle().equals("Spanish Form 1");
+
         assert newFormResponseSpanish.getTree()[0].getCaption().equals("I'm Spanish");
 
         assert newFormResponseSpanish.getTree()[1].getCaption().equals("No Spanish rules");

src/test/resources/archives/case_claim_post_in_entry/default/app_strings.txt

@@ -22,7 +22,7 @@ forms.m0f0=Registration
 forms.m1f0=Visit
 forms.m1f1=Close
 forms.m2f0=Visit after post
-forms.m2f1=Close
+forms.m2f1=Close again
 forms.m2f2=Close Again
 homescreen.title=Case Claim
 lang.current=en

src/test/resources/archives/caseclaimquery/default/app_strings.txt

@@ -26,7 +26,7 @@ cchq.reports_last_updated_on=Reports last updated on
 en=English
 forms.m0f0=Registration Form
 forms.m1f0=Followup Form
-forms.m2f0=Dedupe Form
+forms.m2f0=Followup Form
 homescreen.title=Data Registry Test
 lang.current=en
 m0.case_long.case_name_1.header=Name