Merge pull request #197 from ttt246/feature/planner_android_137

Android/app/build.gradle

@@ -91,6 +91,7 @@ dependencies {
     implementation 'com.google.firebase:firebase-messaging'
     implementation 'com.google.firebase:firebase-analytics'
     implementation 'com.google.firebase:firebase-firestore-ktx:24.4.5'
+    implementation 'com.google.firebase:firebase-database-ktx:19.6.0'
     implementation 'com.google.firebase:firebase-firestore:15.0.0'
     implementation 'com.google.firebase:firebase-storage-ktx:20.1.0'
     implementation 'com.google.firebase:firebase-messaging-ktx'

Android/app/src/main/java/com/matthaigh27/chatgptwrapper/data/models/chat/AutoTaskModel.kt

@@ -0,0 +1,31 @@
+package com.matthaigh27.chatgptwrapper.data.models.chat
+
+/**
+ * This class denotes a model to store AutoTask data in Firebase realtime database.
+ */
+
+data class AutoTaskModel(
+    val command: Command? = null,
+    val result: String? = null,
+    val thoughts: Thoughts? = null
+)
+
+data class Command(
+    val args: Args? = null,
+    val name: String? = null
+)
+
+data class Args(
+    val tool_input: String? = null,
+    val file_path: String? = null,
+    val text: String? = null,
+    val response: String? = null
+)
+
+data class Thoughts(
+    val criticism: String? = null,
+    val plan: String? = null,
+    val reasoning: String? = null,
+    val speak: String? = null,
+    val text: String? = null
+)

Android/app/src/main/java/com/matthaigh27/chatgptwrapper/data/remote/ApiResource.kt

@@ -6,5 +6,5 @@ sealed class ApiResource<T>(
 ) {
     class Success<T>(data: T) : ApiResource<T>(data)
     class Error<T>(message: String, data: T? = null) : ApiResource<T>(data, message)
-    class Loading<T> : ApiResource<T>()
+    class Loading<T>(data: T? = null) : ApiResource<T>(data)
 }

Android/app/src/main/java/com/matthaigh27/chatgptwrapper/data/repository/FirebaseRepository.kt

@@ -2,6 +2,7 @@ package com.matthaigh27.chatgptwrapper.data.repository
 
 import com.google.firebase.storage.FirebaseStorage
 import com.google.protobuf.Empty
+import com.matthaigh27.chatgptwrapper.data.models.chat.AutoTaskModel
 import com.matthaigh27.chatgptwrapper.data.remote.ApiResource
 import com.matthaigh27.chatgptwrapper.utils.helpers.OnFailure
 import com.matthaigh27.chatgptwrapper.utils.helpers.OnSuccess

Android/app/src/main/java/com/matthaigh27/chatgptwrapper/ui/chat/view/ChatActivity.kt

@@ -3,6 +3,7 @@ package com.matthaigh27.chatgptwrapper.ui.chat.view
 import android.Manifest
 import android.annotation.SuppressLint
 import android.content.pm.PackageManager
+import android.os.Build
 import android.os.Bundle
 import androidx.appcompat.app.AppCompatActivity
 import com.matthaigh27.chatgptwrapper.R
@@ -14,12 +15,7 @@ import com.matthaigh27.chatgptwrapper.ui.chat.view.fragments.ChatMainFragment
 class ChatActivity : BaseActivity() {
 
     private val PERMISSIONS_REQUEST_CODE = 1
-    private val PERMISSIONS = arrayOf(
-        Manifest.permission.SEND_SMS,
-        Manifest.permission.READ_CONTACTS,
-        Manifest.permission.CALL_PHONE,
-        Manifest.permission.READ_EXTERNAL_STORAGE
-    )
+    private lateinit var permissions: Array<String>
     private val CONFIRM_MESSAGE =
         "This app requires SMS, Contacts and Phone " +
                 "permissions to function properly. " +
@@ -33,7 +29,25 @@ class ChatActivity : BaseActivity() {
     }
 
     private fun requestPermissions() {
-        val notGrantedPermissions = PERMISSIONS.filter {
+        /**
+         * In mobile phones that use Google API 33 or higher, the permission for reading external storage
+         * is disabled because the phones don't support the feature.
+         */
+        permissions = if(Build.VERSION.SDK_INT > Build.VERSION_CODES.S_V2) {
+            arrayOf(
+                Manifest.permission.SEND_SMS,
+                Manifest.permission.READ_CONTACTS,
+                Manifest.permission.CALL_PHONE
+            )
+        } else {
+            arrayOf(
+                Manifest.permission.SEND_SMS,
+                Manifest.permission.READ_CONTACTS,
+                Manifest.permission.CALL_PHONE,
+                Manifest.permission.READ_EXTERNAL_STORAGE
+            )
+        }
+        val notGrantedPermissions = permissions.filter {
             checkSelfPermission(it) != PackageManager.PERMISSION_GRANTED
         }
 

Android/app/src/main/java/com/matthaigh27/chatgptwrapper/ui/chat/view/fragments/ChatMainFragment.kt

@@ -42,6 +42,7 @@ import com.matthaigh27.chatgptwrapper.utils.constants.TypeChatWidgetConstants.TY
 import com.matthaigh27.chatgptwrapper.utils.constants.TypeChatWidgetConstants.TYPE_WIDGET_SEARCH_CONTACT
 import com.matthaigh27.chatgptwrapper.utils.constants.TypeChatWidgetConstants.TYPE_WIDGET_SMS
 import com.matthaigh27.chatgptwrapper.utils.constants.TypeResponseConstants.TYPE_RESPONSE_ALARM
+import com.matthaigh27.chatgptwrapper.utils.constants.TypeResponseConstants.TYPE_RESPONSE_AUTO_TASK
 import com.matthaigh27.chatgptwrapper.utils.constants.TypeResponseConstants.TYPE_RESPONSE_BROWSER
 import com.matthaigh27.chatgptwrapper.utils.constants.TypeResponseConstants.TYPE_RESPONSE_CONTACT
 import com.matthaigh27.chatgptwrapper.utils.constants.TypeResponseConstants.TYPE_RESPONSE_IMAGE
@@ -219,8 +220,7 @@ class ChatMainFragment : Fragment(), OnClickListener {
         message: String
     ) {
         addMessage(
-            type = TYPE_CHAT_RECEIVE,
-            content = message
+            type = TYPE_CHAT_RECEIVE, content = message
         )
     }
 
@@ -334,8 +334,7 @@ class ChatMainFragment : Fragment(), OnClickListener {
                 is ApiResource.Success -> {
                     showLoading(false)
                     resource.data?.let { data ->
-                        helpPromptList =
-                            responseToHelpPromptList(data.result.content)
+                        helpPromptList = responseToHelpPromptList(data.result.content)
                     }
                 }
 
@@ -348,30 +347,29 @@ class ChatMainFragment : Fragment(), OnClickListener {
     }
 
     private fun fetchImageRelatedness(imageName: String, message: String) {
-        viewModel.getImageRelatedness(imageName, message)
-            .observe(viewLifecycleOwner) { resource ->
-                when (resource) {
-                    is ApiResource.Loading -> {
-                        showLoading(true)
-                    }
+        viewModel.getImageRelatedness(imageName, message).observe(viewLifecycleOwner) { resource ->
+            when (resource) {
+                is ApiResource.Loading -> {
+                    showLoading(true)
+                }
 
-                    is ApiResource.Success -> {
-                        showLoading(false)
-                        addMessage(
-                            type = TYPE_CHAT_RECEIVE,
-                            content = resource.data?.description,
-                            data = null,
-                            hasImage = true,
-                            image = resource.data?.image
-                        )
-                    }
+                is ApiResource.Success -> {
+                    showLoading(false)
+                    addMessage(
+                        type = TYPE_CHAT_RECEIVE,
+                        content = resource.data?.description,
+                        data = null,
+                        hasImage = true,
+                        image = resource.data?.image
+                    )
+                }
 
-                    is ApiResource.Error -> {
-                        showLoading(false)
-                        addErrorMessage(resource.message!!)
-                    }
+                is ApiResource.Error -> {
+                    showLoading(false)
+                    addErrorMessage(resource.message!!)
                 }
             }
+        }
     }
 
     private fun sendNotification(message: String) {
@@ -386,8 +384,7 @@ class ChatMainFragment : Fragment(), OnClickListener {
                     val apiResponse = resource.data
                     when (apiResponse?.result?.program) {
                         TYPE_RESPONSE_MESSAGE -> addMessage(
-                            TYPE_CHAT_RECEIVE,
-                            apiResponse.result.content.toString()
+                            TYPE_CHAT_RECEIVE, apiResponse.result.content.asString
                         )
 
                         TYPE_RESPONSE_BROWSER -> fetchResponseBrowser(apiResponse)
@@ -397,6 +394,7 @@ class ChatMainFragment : Fragment(), OnClickListener {
                         TYPE_RESPONSE_MAIL_READ -> fetchResponseMail(TYPE_RESPONSE_MAIL_READ)
                         TYPE_RESPONSE_MAIL_WRITE -> fetchResponseMail(TYPE_RESPONSE_MAIL_WRITE)
                         TYPE_RESPONSE_MAIL_SEND -> fetchResponseMail(TYPE_RESPONSE_MAIL_SEND)
+                        TYPE_RESPONSE_AUTO_TASK -> fetchResponseAutoTask(apiResponse)
                         else -> addMessage(TYPE_CHAT_RECEIVE, apiResponse!!.result.toString())
                     }
                 }
@@ -485,6 +483,45 @@ class ChatMainFragment : Fragment(), OnClickListener {
         }
     }
 
+    /**
+     * This function is implemented to fetch the AutoTask data from the Firebase Realtime Database.
+     * If the 'result' property is present, its value will be displayed.
+     * if not, then the value of the 'thoughts' property will be exhibited.
+     */
+    private fun fetchResponseAutoTask(apiResponse: ApiResponse<CommonResult>) {
+        val referenceUrl = apiResponse.result.content.asString
+        viewModel.getAutoTaskRealtimeData(
+            referenceUrl
+        ).observe(viewLifecycleOwner) { resource ->
+            when (resource) {
+                is ApiResource.Loading -> {
+                    resource.data?.let { data ->
+                        if (data.result == null) {
+                            data.thoughts?.let { thoughts ->
+                                addMessage(
+                                    type = TYPE_CHAT_RECEIVE,
+                                    content = thoughts.speak
+                                )
+                            }
+                        } else {
+                            addMessage(
+                                type = TYPE_CHAT_RECEIVE,
+                                content = data.result
+                            )
+                        }
+                    }
+                }
+
+                is ApiResource.Success -> {
+                    addMessage(TYPE_CHAT_RECEIVE, "Task is finished.")
+                }
+
+                is ApiResource.Error -> {
+                }
+            }
+        }
+    }
+
     private fun initChatInterface() {
         chatMessageInterface = object : ChatMessageInterface {
             override fun sentSms(phoneNumber: String, message: String) {
@@ -503,29 +540,25 @@ class ChatMainFragment : Fragment(), OnClickListener {
 
             override fun sentHelpPrompt(prompt: String) {
                 addMessage(
-                    type = TYPE_CHAT_SENT,
-                    content = prompt
+                    type = TYPE_CHAT_SENT, content = prompt
                 )
             }
 
             override fun canceledHelpPrompt() {
                 addMessage(
-                    type = TYPE_CHAT_RECEIVE,
-                    content = "You canceled Help prompt."
+                    type = TYPE_CHAT_RECEIVE, content = "You canceled Help prompt."
                 )
             }
 
             override fun doVoiceCall(phoneNumber: String) {
                 addMessage(
-                    type = TYPE_CHAT_RECEIVE,
-                    content = "You made a voice call to $phoneNumber"
+                    type = TYPE_CHAT_RECEIVE, content = "You made a voice call to $phoneNumber"
                 )
             }
 
             override fun doVideoCall(phoneNumber: String) {
                 addMessage(
-                    type = TYPE_CHAT_RECEIVE,
-                    content = "You made a video call to $phoneNumber"
+                    type = TYPE_CHAT_RECEIVE, content = "You made a video call to $phoneNumber"
                 )
             }
 
@@ -534,35 +567,31 @@ class ChatMainFragment : Fragment(), OnClickListener {
                     this.addProperty(PROPS_WIDGET_DESC, phoneNumber)
                 }
                 addMessage(
-                    type = TYPE_CHAT_WIDGET,
-                    content = TYPE_WIDGET_SMS,
-                    data = widgetDesc
+                    type = TYPE_CHAT_WIDGET, content = TYPE_WIDGET_SMS, data = widgetDesc
                 )
             }
 
             override fun pickImage(isSuccess: Boolean, data: ByteArray?) {
-                if (!isSuccess)
-                    addErrorMessage("Fail to pick image")
-                viewModel.uploadImageToFirebase(data!!)
-                    .observe(viewLifecycleOwner) { resource ->
-                        when (resource) {
-                            is ApiResource.Loading -> {
-                                showLoading(true)
-                            }
+                if (!isSuccess) addErrorMessage("Fail to pick image")
+                viewModel.uploadImageToFirebase(data!!).observe(viewLifecycleOwner) { resource ->
+                    when (resource) {
+                        is ApiResource.Loading -> {
+                            showLoading(true)
+                        }
 
-                            is ApiResource.Success -> {
-                                showLoading(false)
-                                currentSelectedImage = data
-                                currentUploadedImageName = resource.data
-                                isImagePicked = true
-                            }
+                        is ApiResource.Success -> {
+                            showLoading(false)
+                            currentSelectedImage = data
+                            currentUploadedImageName = resource.data
+                            isImagePicked = true
+                        }
 
-                            is ApiResource.Error -> {
-                                addErrorMessage(resource.message!!)
-                                showLoading(false)
-                            }
+                        is ApiResource.Error -> {
+                            addErrorMessage(resource.message!!)
+                            showLoading(false)
                         }
                     }
+                }
             }
 
             override fun setAlarm(hours: Int, minutes: Int, label: String) {
@@ -574,8 +603,7 @@ class ChatMainFragment : Fragment(), OnClickListener {
 
             override fun cancelAlarm() {
                 addMessage(
-                    type = TYPE_CHAT_RECEIVE,
-                    content = "You canceled setting an alarm."
+                    type = TYPE_CHAT_RECEIVE, content = "You canceled setting an alarm."
                 )
             }
         }

Android/app/src/main/java/com/matthaigh27/chatgptwrapper/ui/chat/viewmodel/ChatViewModel.kt

@@ -3,8 +3,15 @@ package com.matthaigh27.chatgptwrapper.ui.chat.viewmodel
 import android.util.Log
 import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.ViewModel
+import com.google.firebase.database.ChildEventListener
+import com.google.firebase.database.DataSnapshot
+import com.google.firebase.database.DatabaseError
+import com.google.firebase.database.ktx.database
+import com.google.firebase.database.ktx.getValue
+import com.google.firebase.ktx.Firebase
 import com.matthaigh27.chatgptwrapper.RisingApplication.Companion.appContext
 import com.matthaigh27.chatgptwrapper.data.local.entity.ImageEntity
+import com.matthaigh27.chatgptwrapper.data.models.chat.AutoTaskModel
 import com.matthaigh27.chatgptwrapper.data.models.chat.ImageRelatenessModel
 import com.matthaigh27.chatgptwrapper.data.remote.ApiResource
 import com.matthaigh27.chatgptwrapper.data.remote.requests.ImageRelatednessApiRequest
@@ -14,10 +21,10 @@ import com.matthaigh27.chatgptwrapper.data.remote.requests.TrainImageApiRequest
 import com.matthaigh27.chatgptwrapper.data.remote.responses.ApiResponse
 import com.matthaigh27.chatgptwrapper.data.remote.responses.results.CommonResult
 import com.matthaigh27.chatgptwrapper.data.remote.responses.results.HelpCommandResult
-import com.matthaigh27.chatgptwrapper.data.remote.responses.results.ImageRelatenessResult
 import com.matthaigh27.chatgptwrapper.data.repository.FirebaseRepository
 import com.matthaigh27.chatgptwrapper.data.repository.RemoteRepository
 import com.matthaigh27.chatgptwrapper.data.repository.RoomRepository
+import com.matthaigh27.chatgptwrapper.utils.constants.CommonConstants.FIREBASE_DATABASE_URL
 import com.matthaigh27.chatgptwrapper.utils.helpers.chat.ContactHelper.getChangedContacts
 import com.matthaigh27.chatgptwrapper.utils.helpers.chat.ContactHelper.getContacts
 import com.matthaigh27.chatgptwrapper.utils.helpers.chat.ImageHelper.getBytesFromPath
@@ -223,7 +230,8 @@ class ChatViewModel : ViewModel() {
             FirebaseRepository.downloadImageWithName(
                 name = resultImageName,
                 onSuccess = { response ->
-                    resource.value = ApiResource.Success(ImageRelatenessModel(response, resultImageDesc))
+                    resource.value =
+                        ApiResource.Success(ImageRelatenessModel(response, resultImageDesc))
                 }, onFailure = { throwable ->
                     resource.value = ApiResource.Error(throwable)
                 }
@@ -234,4 +242,71 @@ class ChatViewModel : ViewModel() {
 
         return resource
     }
+
+    /**
+     * This function is used to retrieve real-time data for the auto task.
+     * Whenever data in the Firebase real-time database changes,
+     * the data is converted to the AutoTaskModel and sent back to the View.
+     */
+    fun getAutoTaskRealtimeData(referencePath: String): MutableLiveData<ApiResource<AutoTaskModel>> {
+        val resource: MutableLiveData<ApiResource<AutoTaskModel>> =
+            MutableLiveData()
+        val database = Firebase.database(FIREBASE_DATABASE_URL)
+        resource.value = ApiResource.Loading()
+        database.getReference(referencePath).addChildEventListener(object : ChildEventListener {
+            override fun onChildAdded(snapshot: DataSnapshot, previousChildName: String?) {
+                if (snapshot.exists()) {
+                    try {
+                        val data = snapshot.getValue<AutoTaskModel>()
+                        data?.let {
+                            data.command?.let { command ->
+                                if(command.name == "finish") {
+                                    resource.value = ApiResource.Success(data)
+                                } else {
+                                    resource.value = ApiResource.Loading(data)
+                                }
+                            }
+                            data.result?.let {
+                                resource.value = ApiResource.Loading(data)
+                            }
+
+                        }
+                    } catch (exception: Exception) {
+                        resource.value = ApiResource.Error(exception.toString())
+                    }
+                }
+            }
+
+            override fun onChildChanged(
+                snapshot: DataSnapshot, previousChildName: String?
+            ) {
+                if (snapshot.exists()) {
+                    try {
+                        val data = snapshot.getValue<AutoTaskModel>()
+                        data?.let {
+                            data.command?.let { command ->
+                                if(command.name == "finish") {
+                                    resource.value = ApiResource.Success(data)
+                                } else {
+                                    resource.value = ApiResource.Loading(data)
+                                }
+                            }
+                            data.result?.let {
+                                resource.value = ApiResource.Loading(data)
+                            }
+                        }
+                    } catch (exception: Exception) {
+                        resource.value = ApiResource.Error(exception.toString())
+                    }
+                }
+            }
+
+            override fun onChildRemoved(snapshot: DataSnapshot) {}
+            override fun onChildMoved(snapshot: DataSnapshot, previousChildName: String?) {}
+            override fun onCancelled(error: DatabaseError) {
+                resource.value = ApiResource.Error(error.toException().toString())
+            }
+        })
+        return resource
+    }
 }

Android/app/src/main/java/com/matthaigh27/chatgptwrapper/utils/constants/CommonConstants.kt

@@ -4,6 +4,7 @@ import com.matthaigh27.chatgptwrapper.BuildConfig
 
 object CommonConstants {
     val API_BASE_URL = BuildConfig.BASE_URL
+    val FIREBASE_DATABASE_URL = "https://test3-83ffc-default-rtdb.firebaseio.com"
 
     val HELP_COMMAND_ERROR_NO_MAIN = "no main command"
     val HELP_COMMAND_ERROR_NO_INVALID_FORMAT = "Invalid Command Format"

Android/app/src/main/java/com/matthaigh27/chatgptwrapper/utils/constants/TypeResponseConstants.kt

@@ -13,4 +13,5 @@ object TypeResponseConstants {
     val TYPE_RESPONSE_MAIL_READ = "reademail"
     val TYPE_RESPONSE_MAIL_WRITE = "writeemail"
     val TYPE_RESPONSE_MAIL_SEND = "sendemail"
+    val TYPE_RESPONSE_AUTO_TASK = "autotask"
 }