Added PromptsCollectionMetadata with defaultSection field.

Author: mgeorg

app/src/main/java/edu/gatech/ccg/recordthesehands/home/HomeScreenActivity.kt

@@ -129,11 +129,6 @@ class HomeScreenActivity : ComponentActivity() {
    */
   private var emailing: Boolean = true
 
-  /**
-   * Whether or not we have already asked the user for permissions.
-   */
-  private var permissionRequestedPreviously: Boolean = false
-
   /**
    * The total number of recordings the user has done in the current session (i.e., since they
    * last cold-booted the app). After this value reaches [Constants.MAX_RECORDINGS_IN_SITTING],
@@ -665,7 +660,7 @@ fun HomeScreenContent(
     ) {
       // Section Name Text
       Text(
-        text = promptState?.currentSectionName ?: "",
+        text = promptState?.currentSectionName ?: "<NO SECTION>",
         fontSize = 18.sp,
       )
 
@@ -699,7 +694,7 @@ fun HomeScreenContent(
     // Total Progress Count Text
     Text(
       // TODO replace with stringResource.
-      text = "${totalCompleted}/${totalPrompts}",
+      text = "${totalCompleted} / ${totalPrompts}",
       fontSize = 18.sp,
       modifier = Modifier
         .constrainAs(totalProgressCountText) {
@@ -891,28 +886,32 @@ fun HomeScreenContent(
     val startButtonText: String
     val startRecordingShouldSwitchPrompts: Boolean
 
-    if (promptState != null && promptState!!.currentPrompts != null && promptState!!.username != null) {
-      if ((promptState!!.currentPromptIndex ?: 0) < (promptState!!.totalPromptsInCurrentSection
-          ?: 0)
-      ) {
-        startButtonEnabled = true
-        startRecordingShouldSwitchPrompts = false
-        startButtonText = stringResource(id = R.string.start_button)
-      } else {
-        if (totalCompleted >= totalPrompts) {
-          startButtonEnabled = false
-          startRecordingShouldSwitchPrompts = false
-          startButtonText = stringResource(id = R.string.no_more_prompts)
-        } else {
-          startButtonEnabled = true
-          startRecordingShouldSwitchPrompts = true
-          startButtonText = stringResource(id = R.string.switch_prompts)
-        }
-      }
-    } else {
+    if (promptState == null || promptState!!.username == null) {
       startButtonEnabled = false
       startRecordingShouldSwitchPrompts = false
       startButtonText = stringResource(id = R.string.start_disabled)
+    } else if (promptState!!.currentSectionName == null) {
+      startButtonEnabled = true
+      startRecordingShouldSwitchPrompts = true
+      startButtonText = stringResource(id = R.string.switch_prompts)
+    } else if (promptState!!.currentPrompts == null) {
+      startButtonEnabled = false
+      startRecordingShouldSwitchPrompts = false
+      startButtonText = stringResource(id = R.string.start_disabled)
+    } else if (
+      (promptState!!.currentPromptIndex ?: 0) < (promptState!!.totalPromptsInCurrentSection ?: 0)
+    ) {
+      startButtonEnabled = true
+      startRecordingShouldSwitchPrompts = false
+      startButtonText = stringResource(id = R.string.start_button)
+    } else if (totalCompleted >= totalPrompts) {
+      startButtonEnabled = false
+      startRecordingShouldSwitchPrompts = false
+      startButtonText = stringResource(id = R.string.no_more_prompts)
+    } else {
+      startButtonEnabled = true
+      startRecordingShouldSwitchPrompts = true
+      startButtonText = stringResource(id = R.string.switch_prompts)
     }
 
     PrimaryButton(

app/src/main/java/edu/gatech/ccg/recordthesehands/upload/DataManager.kt

@@ -234,8 +234,22 @@ class DataManager private constructor(val context: Context) {
     }
 
     if (currentSectionName == null && promptsCollection != null && promptsCollection.sections.isNotEmpty()) {
-      currentSectionName = promptsCollection.sections.values.first().name
-      setCurrentSectionPrefStoreUnderLock(currentSectionName)
+      promptsCollection.collectionMetadata.defaultSection?.let {
+        // if default is not null...
+        Log.i(TAG, "defaultSection == ${it}")
+        if (promptsCollection.sections.containsKey(it)) {
+          // If it is valid, set it to that section.
+          currentSectionName = it
+        }
+        // If it is not valid, leave it as null.
+      } ?: run {
+        // If default is null, set to the first section.
+        currentSectionName = promptsCollection.sections.values.first().name
+      }
+      if (currentSectionName != null) {
+        Log.i(TAG, "Setting current section from null to $currentSectionName")
+        setCurrentSectionPrefStoreUnderLock(currentSectionName)
+      }
     }
 
     val initialState = PromptState(
@@ -803,7 +817,7 @@ class DataManager private constructor(val context: Context) {
    *
    * @param sectionName The name of the section to set as current.
    */
-  suspend fun setCurrentSection(sectionName: String) {
+  suspend fun setCurrentSection(sectionName: String?) {
     dataManagerData.lock.withLock {
       setCurrentSectionUnderLock(sectionName)
     }
@@ -820,17 +834,21 @@ class DataManager private constructor(val context: Context) {
    * @param sectionName The name of the section to set as current.
    * @throws IllegalStateException if the prompt state has not been initialized.
    */
-  private suspend fun setCurrentSectionUnderLock(sectionName: String) {
+  private suspend fun setCurrentSectionUnderLock(sectionName: String?) {
     val currentState = dataManagerData.promptStateContainer
       ?: throw IllegalStateException("Attempted to set current section before prompt state was initialized.")
     updatePromptStateAndPost(currentState.copy(currentSectionName = sectionName))
     setCurrentSectionPrefStoreUnderLock(sectionName)
   }
 
-  private suspend fun setCurrentSectionPrefStoreUnderLock(sectionName: String) {
+  private suspend fun setCurrentSectionPrefStoreUnderLock(sectionName: String?) {
     val keyObject = stringPreferencesKey("currentSectionName")
     context.prefStore.edit {
-      it[keyObject] = sectionName
+      if (sectionName != null) {
+        it[keyObject] = sectionName
+      } else {
+        it.remove(keyObject)
+      }
     }
   }
 

app/src/main/java/edu/gatech/ccg/recordthesehands/upload/PromptsCollection.kt

@@ -9,6 +9,7 @@ import java.io.File
 
 class PromptsCollection(val context: Context) {
   var sections = mutableMapOf<String, PromptsSection>()
+  lateinit var collectionMetadata: PromptsCollectionMetadata
 
   companion object {
     private val TAG = PromptsCollection::class.simpleName
@@ -24,7 +25,14 @@ class PromptsCollection(val context: Context) {
       Log.e(TAG, "Failed to parse prompts file: $e")
       return false
     }
-    val data = json.getJSONObject("data")
+    val collectionMetadataJson = json.optJSONObject("metadata") ?: JSONObject()
+    collectionMetadata = PromptsCollectionMetadata(
+      defaultSection = collectionMetadataJson.opt("defaultSection") as? String,
+    )
+    val data = json.optJSONObject("data") ?: run {
+      Log.e(TAG, "Prompts file did not include \"data\" section")
+      return false
+    }
     data.keys().forEach { sectionName ->
       val sectionJson = data.getJSONObject(sectionName)
       val metadataJson = sectionJson.optJSONObject("metadata") ?: JSONObject()
@@ -69,6 +77,19 @@ class PromptsCollection(val context: Context) {
       sectionsJson.put(key, value.toJson())
     }
     json.put("sections", sectionsJson)
+    json.put("metadata", collectionMetadata.toJson())
+    return json
+  }
+}
+
+data class PromptsCollectionMetadata(
+  val defaultSection: String?,
+) {
+  fun toJson(): JSONObject {
+    val json = JSONObject()
+    if (defaultSection != null) {
+      json.put("defaultSection", defaultSection)
+    }
     return json
   }
 }

app/src/main/res/values/strings.xml

@@ -115,5 +115,5 @@
     <string name="perm_alert_message">In order to record your data, we will need access to the camera and write functionality.</string>
     <string name="ok">OK</string>
     <string name="words_signed">Words signed</string>
-    <string name="no_more_prompts">Cannot start, prompts completed.</string>
+    <string name="no_more_prompts">Tasks completed</string>
 </resources>