Compare commits

...
Sign in to create a new pull request.

6 commits

Author SHA1 Message Date
18d0521576 Fixup layout centering for download progress
All checks were successful
/ build-debug (push) Successful in 5m9s
2025-09-07 14:55:36 -04:00
943f2bd14e Incorporate simplified error messages to the download progress UI
All checks were successful
/ build-debug (push) Successful in 4m43s
2025-09-07 14:39:52 -04:00
8a41eabfb3 Rework simplified error message strings
All checks were successful
/ build-debug (push) Successful in 5m10s
2025-09-07 10:59:20 -04:00
19f07de151 Redo SimplifiedErrorHandling as SimplifiedErrorMessages
All checks were successful
/ build-debug (push) Successful in 5m5s
...and it shouldn't be an object, it should just be an enum class with a
companion object.
2025-09-07 10:51:33 -04:00
1ed53a2f32
feat: add EIDNotSupported error handling and corresponding message 2025-08-28 21:31:44 +08:00
f167d059dc
feat: simplified error handling 2025-08-18 09:57:15 +08:00
4 changed files with 269 additions and 19 deletions

View file

@ -43,18 +43,36 @@ class DownloadWizardProgressFragment : DownloadWizardActivity.DownloadWizardStep
private data class ProgressItem( private data class ProgressItem(
val titleRes: Int, val titleRes: Int,
var state: ProgressState var state: ProgressState,
var errorMessage: SimplifiedErrorMessages?,
) )
private val progressItems = arrayOf( private val progressItems = arrayOf(
ProgressItem(R.string.download_wizard_progress_step_preparing, ProgressState.NotStarted), ProgressItem(
ProgressItem(R.string.download_wizard_progress_step_connecting, ProgressState.NotStarted), R.string.download_wizard_progress_step_preparing,
ProgressState.NotStarted,
null
),
ProgressItem(
R.string.download_wizard_progress_step_connecting,
ProgressState.NotStarted,
null
),
ProgressItem( ProgressItem(
R.string.download_wizard_progress_step_authenticating, R.string.download_wizard_progress_step_authenticating,
ProgressState.NotStarted ProgressState.NotStarted,
null
), ),
ProgressItem(R.string.download_wizard_progress_step_downloading, ProgressState.NotStarted), ProgressItem(
ProgressItem(R.string.download_wizard_progress_step_finalizing, ProgressState.NotStarted) R.string.download_wizard_progress_step_downloading,
ProgressState.NotStarted,
null
),
ProgressItem(
R.string.download_wizard_progress_step_finalizing,
ProgressState.NotStarted,
null
)
) )
private val adapter = ProgressItemAdapter() private val adapter = ProgressItemAdapter()
@ -122,8 +140,13 @@ class DownloadWizardProgressFragment : DownloadWizardActivity.DownloadWizardStep
// Change the state of the last InProgress item to success (or error) // Change the state of the last InProgress item to success (or error)
progressItems.forEachIndexed { index, progressItem -> progressItems.forEachIndexed { index, progressItem ->
if (progressItem.state == ProgressState.InProgress) { if (progressItem.state == ProgressState.InProgress) {
progressItem.state = if (state.downloadError == null) {
if (state.downloadError == null) ProgressState.Done else ProgressState.Error progressItem.state = ProgressState.Done
} else {
progressItem.state = ProgressState.Error
progressItem.errorMessage =
SimplifiedErrorMessages.fromDownloadError(state.downloadError!!)
}
} }
adapter.notifyItemChanged(index) adapter.notifyItemChanged(index)
@ -197,9 +220,15 @@ class DownloadWizardProgressFragment : DownloadWizardActivity.DownloadWizardStep
private val progressBar = private val progressBar =
root.requireViewById<ProgressBar>(R.id.download_progress_icon_progress) root.requireViewById<ProgressBar>(R.id.download_progress_icon_progress)
private val icon = root.requireViewById<ImageView>(R.id.download_progress_icon) private val icon = root.requireViewById<ImageView>(R.id.download_progress_icon)
private val errorTitle =
root.requireViewById<TextView>(R.id.download_progress_item_error_title)
private val errorSuggestion =
root.requireViewById<TextView>(R.id.download_progress_item_error_suggestion)
fun bind(item: ProgressItem) { fun bind(item: ProgressItem) {
title.text = getString(item.titleRes) title.text = getString(item.titleRes)
errorTitle.visibility = View.GONE
errorSuggestion.visibility = View.GONE
when (item.state) { when (item.state) {
ProgressState.NotStarted -> { ProgressState.NotStarted -> {
@ -222,6 +251,16 @@ class DownloadWizardProgressFragment : DownloadWizardActivity.DownloadWizardStep
progressBar.visibility = View.GONE progressBar.visibility = View.GONE
icon.setImageResource(R.drawable.ic_error_outline) icon.setImageResource(R.drawable.ic_error_outline)
icon.visibility = View.VISIBLE icon.visibility = View.VISIBLE
if (item.errorMessage != null) {
errorTitle.visibility = View.VISIBLE
errorTitle.text = getString(item.errorMessage!!.titleResId)
if (item.errorMessage!!.suggestResId != null) {
errorSuggestion.visibility = View.VISIBLE
errorSuggestion.text = getString(item.errorMessage!!.suggestResId!!)
}
}
} }
} }
} }

View file

@ -0,0 +1,154 @@
package im.angry.openeuicc.ui.wizard
import androidx.annotation.StringRes
import im.angry.openeuicc.common.R
import net.typeblog.lpac_jni.LocalProfileAssistant
import org.json.JSONObject
import java.net.NoRouteToHostException
import java.net.PortUnreachableException
import java.net.SocketException
import java.net.SocketTimeoutException
import java.net.UnknownHostException
import javax.net.ssl.SSLException
enum class SimplifiedErrorMessages(
@StringRes val titleResId: Int,
@StringRes val suggestResId: Int?
) {
ICCIDAlreadyInUse(
R.string.download_wizard_error_iccid_already,
R.string.download_wizard_error_suggest_profile_installed
),
InsufficientMemory(
R.string.download_wizard_error_insufficient_memory,
R.string.download_wizard_error_suggest_insufficient_memory
),
UnsupportedProfile(
R.string.download_wizard_error_unsupported_profile,
null
),
CardInternalError(
R.string.download_wizard_error_card_internal_error,
null
),
EIDNotSupported(
R.string.download_wizard_error_eid_not_supported,
R.string.download_wizard_error_suggest_contact_carrier
),
EIDMismatch(
R.string.download_wizard_error_eid_mismatch,
R.string.download_wizard_error_suggest_contact_reissue
),
UnreleasedProfile(
R.string.download_wizard_error_profile_unreleased,
R.string.download_wizard_error_suggest_contact_reissue
),
MatchingIDRefused(
R.string.download_wizard_error_matching_id_refused,
R.string.download_wizard_error_suggest_contact_carrier
),
ProfileRetriesExceeded(
R.string.download_wizard_error_profile_retries_exceeded,
R.string.download_wizard_error_suggest_contact_carrier
),
ConfirmationCodeMissing(
R.string.download_wizard_error_confirmation_code_missing,
R.string.download_wizard_error_suggest_contact_carrier
),
ConfirmationCodeRefused(
R.string.download_wizard_error_confirmation_code_refused,
R.string.download_wizard_error_suggest_contact_carrier
),
ConfirmationCodeRetriesExceeded(
R.string.download_wizard_error_confirmation_code_retries_exceeded,
R.string.download_wizard_error_suggest_contact_carrier
),
ProfileExpired(
R.string.download_wizard_error_profile_expired,
R.string.download_wizard_error_suggest_contact_carrier
),
UnknownHost(
R.string.download_wizard_error_unknown_hostname,
null
),
NetworkUnreachable(
R.string.download_wizard_error_network_unreachable,
R.string.download_wizard_error_suggest_network_unreachable
),
TLSError(
R.string.download_wizard_error_tls_certificate,
null
);
companion object {
private val httpErrors = buildMap {
// Stage: AuthenticateClient
put("8.1" to "4.8", InsufficientMemory)
put("8.1.1" to "2.1", EIDNotSupported)
put("8.1.1" to "3.8", EIDMismatch)
put("8.2" to "1.2", UnreleasedProfile)
put("8.2.6" to "3.8", MatchingIDRefused)
put("8.8.5" to "6.4", ProfileRetriesExceeded)
// Stage: GetBoundProfilePackage
put("8.2.7" to "2.2", ConfirmationCodeMissing)
put("8.2.7" to "3.8", ConfirmationCodeRefused)
put("8.2.7" to "6.4", ConfirmationCodeRetriesExceeded)
// Stage: AuthenticateClient, GetBoundProfilePackage
put("8.8.5" to "4.10", ProfileExpired)
}
fun fromDownloadError(exc: LocalProfileAssistant.ProfileDownloadException) = when {
exc.lpaErrorReason != "ES10B_ERROR_REASON_UNDEFINED" -> fromLPAErrorReason(exc.lpaErrorReason)
exc.lastHttpResponse?.rcode == 200 -> fromHTTPResponse(exc.lastHttpResponse!!)
exc.lastHttpException != null -> fromHTTPException(exc.lastHttpException!!)
exc.lastApduResponse != null -> fromAPDUResponse(exc.lastApduResponse!!)
else -> null
}
private fun fromLPAErrorReason(reason: String) = when (reason) {
"ES10B_ERROR_REASON_UNSUPPORTED_CRT_VALUES" -> UnsupportedProfile
"ES10B_ERROR_REASON_UNSUPPORTED_REMOTE_OPERATION_TYPE" -> UnsupportedProfile
"ES10B_ERROR_REASON_UNSUPPORTED_PROFILE_CLASS" -> UnsupportedProfile
"ES10B_ERROR_REASON_INSTALL_FAILED_DUE_TO_ICCID_ALREADY_EXISTS_ON_EUICC" -> ICCIDAlreadyInUse
"ES10B_ERROR_REASON_INSTALL_FAILED_DUE_TO_INSUFFICIENT_MEMORY_FOR_PROFILE" -> InsufficientMemory
"ES10B_ERROR_REASON_INSTALL_FAILED_DUE_TO_INTERRUPTION" -> CardInternalError
"ES10B_ERROR_REASON_INSTALL_FAILED_DUE_TO_PE_PROCESSING_ERROR" -> CardInternalError
else -> null
}
private fun fromHTTPResponse(httpResponse: net.typeblog.lpac_jni.HttpInterface.HttpResponse): SimplifiedErrorMessages? {
if (httpResponse.data.first().toInt() != '{'.code) return null
val response = JSONObject(httpResponse.data.decodeToString())
val statusCodeData = response.optJSONObject("header")
?.optJSONObject("functionExecutionStatus")
?.optJSONObject("statusCodeData")
?: return null
val subjectCode = statusCodeData.optString("subjectCode")
val reasonCode = statusCodeData.optString("reasonCode")
return httpErrors[subjectCode to reasonCode]
}
private fun fromHTTPException(exc: Exception) = when (exc) {
is SSLException -> TLSError
is UnknownHostException -> UnknownHost
is NoRouteToHostException -> NetworkUnreachable
is PortUnreachableException -> NetworkUnreachable
is SocketTimeoutException -> NetworkUnreachable
is SocketException -> exc.message
?.contains("Connection reset", ignoreCase = true)
?.let { if (it) NetworkUnreachable else null }
else -> null
}
private fun fromAPDUResponse(resp: ByteArray): SimplifiedErrorMessages? {
val isSuccess = resp.size >= 2 &&
resp[resp.size - 2] == 0x90.toByte() &&
resp[resp.size - 1] == 0x00.toByte()
if (isSuccess) return null
return CardInternalError
}
}
}

View file

@ -1,30 +1,32 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android" <androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
android:layout_width="match_parent" android:layout_width="match_parent"
android:layout_height="wrap_content" android:layout_height="wrap_content">
xmlns:app="http://schemas.android.com/apk/res-auto">
<TextView <TextView
android:id="@+id/download_progress_item_title" android:id="@+id/download_progress_item_title"
android:layout_width="wrap_content" android:layout_width="wrap_content"
android:layout_height="wrap_content" android:layout_height="wrap_content"
android:layout_margin="20dp" android:layout_marginHorizontal="20dp"
android:textSize="14sp" android:textSize="14sp"
app:layout_constraintTop_toTopOf="parent"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toStartOf="@id/download_progress_icon_container"
app:layout_constrainedWidth="true" app:layout_constrainedWidth="true"
app:layout_constraintHorizontal_bias="0.0" /> app:layout_constraintBottom_toBottomOf="@id/download_progress_icon_container"
app:layout_constraintEnd_toStartOf="@id/download_progress_icon_container"
app:layout_constraintHorizontal_bias="0.0"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="@id/download_progress_icon_container"
app:layout_constraintVertical_bias="0.5" />
<FrameLayout <FrameLayout
android:id="@+id/download_progress_icon_container" android:id="@+id/download_progress_icon_container"
android:layout_margin="20dp"
android:layout_width="30dp" android:layout_width="30dp"
android:layout_height="30dp" android:layout_height="30dp"
app:layout_constraintTop_toTopOf="parent" android:layout_margin="20dp"
app:layout_constraintBottom_toBottomOf="parent" app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toEndOf="parent"> app:layout_constraintEnd_toEndOf="parent"
app:layout_constraintTop_toTopOf="parent"
app:layout_constraintVertical_bias="0.0">
<ProgressBar <ProgressBar
android:id="@+id/download_progress_icon_progress" android:id="@+id/download_progress_icon_progress"
@ -42,4 +44,38 @@
</FrameLayout> </FrameLayout>
<TextView
android:id="@+id/download_progress_item_error_title"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginTop="10dp"
android:layout_marginStart="20dp"
android:layout_marginEnd="20dp"
android:layout_marginBottom="10dp"
android:textColor="?attr/colorError"
android:textSize="12sp"
android:visibility="gone"
app:layout_constrainedWidth="true"
app:layout_constraintBottom_toTopOf="@id/download_progress_item_error_suggestion"
app:layout_constraintEnd_toStartOf="@id/download_progress_icon_container"
app:layout_constraintHorizontal_bias="0.0"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toBottomOf="@id/download_progress_item_title" />
<TextView
android:id="@+id/download_progress_item_error_suggestion"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="20dp"
android:layout_marginEnd="20dp"
android:textColor="?attr/colorError"
android:textSize="12sp"
android:visibility="gone"
app:layout_constrainedWidth="true"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintEnd_toStartOf="@id/download_progress_icon_container"
app:layout_constraintHorizontal_bias="0.0"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toBottomOf="@id/download_progress_item_title" />
</androidx.constraintlayout.widget.ConstraintLayout> </androidx.constraintlayout.widget.ConstraintLayout>

View file

@ -104,6 +104,27 @@
<string name="download_wizard_diagnostics_last_apdu_exception">Last APDU exception:</string> <string name="download_wizard_diagnostics_last_apdu_exception">Last APDU exception:</string>
<string name="download_wizard_diagnostics_save">Save</string> <string name="download_wizard_diagnostics_save">Save</string>
<string name="download_wizard_diagnostics_file_template">Diagnostics at %s</string> <string name="download_wizard_diagnostics_file_template">Diagnostics at %s</string>
<string name="download_wizard_error_iccid_already">This eSIM profile is already present on your eSIM chip.</string>
<string name="download_wizard_error_insufficient_memory">Your eSIM chip does not have sufficient memory left to download the profile.</string>
<string name="download_wizard_error_unsupported_profile">This eSIM profile is unsupported by your eSIM chip.</string>
<string name="download_wizard_error_card_internal_error">An error occurred in your eSIM chip.</string>
<string name="download_wizard_error_eid_not_supported">The EID of your device or eSIM chip is unsupported by your carrier.</string>
<string name="download_wizard_error_eid_mismatch">This eSIM profile has been downloaded on another device.</string>
<string name="download_wizard_error_profile_unreleased">This eSIM profile has been revoked.</string>
<string name="download_wizard_error_matching_id_refused">The activation code is invalid.</string>
<string name="download_wizard_error_profile_retries_exceeded">The maximum number of download attempts for the eSIM profile has been exceeded.</string>
<string name="download_wizard_error_confirmation_code_missing">Confirmation code is required to download this profile.</string>
<string name="download_wizard_error_confirmation_code_refused">The confirmation code you entered is invalid.</string>
<string name="download_wizard_error_profile_expired">This eSIM profile has expired.</string>
<string name="download_wizard_error_confirmation_code_retries_exceeded">The maximum number of download attempts for the confirmation code has been exceeded.</string>
<string name="download_wizard_error_unknown_hostname">Unknown SM-DP+ address</string>
<string name="download_wizard_error_network_unreachable">Network is unreachable</string>
<string name="download_wizard_error_tls_certificate">TLS certificate error, this eSIM profile is not supported</string>
<string name="download_wizard_error_suggest_profile_installed">You are trying to reinstall an already downloaded eSIM profile</string>
<string name="download_wizard_error_suggest_insufficient_memory">Please delete some unused eSIM profiles and try again</string>
<string name="download_wizard_error_suggest_contact_carrier">Please contact your carrier for assistance.</string>
<string name="download_wizard_error_suggest_contact_reissue">Please contact your carrier to reissue this eSIM profile.</string>
<string name="download_wizard_error_suggest_network_unreachable">Please try again after connecting to a different network (e.g. switching between Wi-Fi and data).</string>
<string name="logs_saved_message">Logs have been saved to the selected path. Would you like to share the log through another app?</string> <string name="logs_saved_message">Logs have been saved to the selected path. Would you like to share the log through another app?</string>