-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
improve troubleshooting and re-organize some stuff
- move troubleshooting code into its own helper file rather than being in MainViewModel - improve the troubleshooting code a bit by splitting it up more and creating some information-holding objects
- Loading branch information
Showing
5 changed files
with
245 additions
and
187 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
205 changes: 205 additions & 0 deletions
205
app/src/main/java/me/arianb/usb_hid_client/TroubleshootingHelper.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,205 @@ | ||
| package me.arianb.usb_hid_client | ||
|
|
||
| import androidx.collection.mutableIntSetOf | ||
| import androidx.compose.ui.graphics.Color | ||
| import androidx.compose.ui.text.AnnotatedString | ||
| import androidx.compose.ui.text.SpanStyle | ||
| import androidx.compose.ui.text.buildAnnotatedString | ||
| import com.topjohnwu.superuser.Shell | ||
| import me.arianb.usb_hid_client.hid_utils.CharacterDeviceManager | ||
| import me.arianb.usb_hid_client.shell_utils.RootMethod | ||
| import me.arianb.usb_hid_client.shell_utils.RootStateHolder | ||
| import timber.log.Timber | ||
|
|
||
| data class TroubleshootingInfo( | ||
| val rootPermissionInfo: RootPermissionInfo, | ||
| val characterDevicesInfoList: List<CharacterDeviceInfo>? = null, | ||
| val kernelInfo: KernelInfo? = null | ||
| ) | ||
|
|
||
| data class RootPermissionInfo( | ||
| val hasRootPermissions: Boolean, | ||
| val rootMethod: RootMethod, | ||
| ) | ||
|
|
||
| data class CharacterDeviceInfo( | ||
| val isEveryCharDevPresent: Boolean, | ||
| val charDevicePermissions: String, | ||
| ) | ||
|
|
||
| data class KernelInfo( | ||
| val kernelConfigAnnotated: AnnotatedString, | ||
| val hasConfigFsSupport: Boolean?, | ||
| val hasConfigFsHidFunctionSupport: Boolean?, | ||
| ) | ||
|
|
||
| // TODO: make this run in a coroutine in case something takes a while or hangs? | ||
| fun detectIssues(): TroubleshootingInfo { | ||
| val rootStateHolder = RootStateHolder.getInstance() | ||
|
|
||
| // Root permission stuff | ||
| val hasRootPermissions = rootStateHolder.hasRootPermissions() | ||
| val rootMethod = rootStateHolder.detectRootMethod() | ||
| val rootPermissionInfo = RootPermissionInfo( | ||
| hasRootPermissions, | ||
| rootMethod, | ||
| ) | ||
|
|
||
| // Character device stuff | ||
| val characterDevicesInfoList: List<CharacterDeviceInfo>? | ||
|
|
||
| // Kernel stuff | ||
| val kernelInfo: KernelInfo? | ||
|
|
||
| if (hasRootPermissions) { | ||
| // Check character device stuff | ||
| characterDevicesInfoList = buildList { | ||
| for (path in CharacterDeviceManager.ALL_CHARACTER_DEVICE_PATHS) { | ||
| add(getCharacterDeviceInfo(path)) | ||
| } | ||
| } | ||
|
|
||
| // Check kernel support | ||
| kernelInfo = getKernelInfo() | ||
| } else { | ||
| characterDevicesInfoList = null | ||
| kernelInfo = null | ||
| } | ||
|
|
||
| return TroubleshootingInfo( | ||
| rootPermissionInfo = rootPermissionInfo, | ||
| characterDevicesInfoList = characterDevicesInfoList, | ||
| kernelInfo = kernelInfo | ||
| ) | ||
| } | ||
|
|
||
| // FIXME: finish implementation | ||
| private fun getCharacterDeviceInfo(gadgetPath: String): CharacterDeviceInfo { | ||
| val isPresent = false // TODO: | ||
|
|
||
| if (isPresent) { | ||
| // check if permissions seem good | ||
| // TODO: check char dev permissions. Theres a few ways I can do that: | ||
| // - Check it theoretically (check for presence of proper selinux policy and unix permissions) | ||
| // - Check it realistically (write to the devices and see what happens) | ||
| val arePermissionsGood = false | ||
| if (arePermissionsGood) { | ||
| // try to use the char device (write something safe like all zeroes) | ||
| val didWriteFail = false | ||
| if (didWriteFail) { | ||
| // TODO: more debugging necessary, grab the exception | ||
| } else { | ||
| // doesn't seem like there are any problems | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return CharacterDeviceInfo( | ||
| isPresent, | ||
| charDevicePermissions = "PLACEHOLDER" | ||
| ) | ||
| } | ||
|
|
||
| private fun getKernelInfo(): KernelInfo { | ||
| // constants | ||
| val configFsKernelOption = "CONFIG_USB_CONFIGFS" | ||
| val configFsHidKernelOption = "${configFsKernelOption}_F_HID" | ||
|
|
||
| val kernelConfig = getKernelConfig() | ||
| var hasConfigFsSupport: Boolean? = null | ||
| var hasConfigFsHidFunctionSupport: Boolean? = null | ||
| val highlightConfigLines = mutableIntSetOf() | ||
|
|
||
| for ((index, line) in kernelConfig.withIndex()) { | ||
| // Parse kernel config by line | ||
| val configOption: String | ||
| val enabled: Boolean | ||
| if (line.first() == '#') { | ||
| enabled = false | ||
| configOption = line.split(" ")[1] // second word | ||
| } else if (line[line.length - 2] == '=') { // if 2nd to last char is '=' | ||
| enabled = line.last() == 'y' | ||
| configOption = line.substring(0, line.length - 2) // exclude last 2 chars | ||
| } else { | ||
| Timber.wtf("error while parsing kernel config, this line was not formatted as expected: %s", line) | ||
| continue | ||
| } | ||
|
|
||
| // Evaluate the information that I parsed | ||
| when (configOption) { | ||
| configFsKernelOption -> { | ||
| hasConfigFsSupport = enabled | ||
| highlightConfigLines.add(index) | ||
| } | ||
|
|
||
| configFsHidKernelOption -> { | ||
| hasConfigFsHidFunctionSupport = enabled | ||
| highlightConfigLines.add(index) | ||
| } | ||
|
|
||
| else -> { | ||
| // Found a config option I don't care about | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // TODO: optimize this by building annotated string during the first loop through the config instead of looping | ||
| // a second time here. | ||
| val kernelConfigAnnotatedString: AnnotatedString = if (kernelConfig.isEmpty()) { | ||
| AnnotatedString("Failed to read kernel config") | ||
| } else { | ||
| buildAnnotatedString { | ||
| for ((index, line) in kernelConfig.withIndex()) { | ||
| val annotatedLine = if (highlightConfigLines.contains(index)) { | ||
| AnnotatedString(line, spanStyle = SpanStyle(color = Color.Red)) | ||
| } else { | ||
| line | ||
| } | ||
|
|
||
| append(annotatedLine) | ||
| appendLine() | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return KernelInfo( | ||
| kernelConfigAnnotatedString, | ||
| hasConfigFsSupport, | ||
| hasConfigFsHidFunctionSupport, | ||
| ) | ||
| } | ||
|
|
||
| private fun getKernelConfig(): List<String> { | ||
| val commandResult = Shell.cmd("gunzip -c /proc/config.gz | grep -i configfs").exec() | ||
|
|
||
| val kernelConfigLinesList = commandResult.out | ||
|
|
||
| // DEBUG: this is code for testing behavior if kernel support wasn't present | ||
| // val kernelConfigLinesList = mutableListOf<String>() | ||
| // for (line in commandResult.out) { | ||
| // when (line) { | ||
| // "CONFIG_USB_CONFIGFS=y" -> { | ||
| // kernelConfigLinesList.add("CONFIG_USB_CONFIGFS=n") | ||
| // } | ||
| // | ||
| // "CONFIG_USB_CONFIGFS_F_HID=y" -> { | ||
| // kernelConfigLinesList.add("CONFIG_USB_CONFIGFS_F_HID=n") | ||
| // } | ||
| // | ||
| // else -> { | ||
| // kernelConfigLinesList.add(line) | ||
| // } | ||
| // } | ||
| // } | ||
|
|
||
| // TODO: | ||
| // - handle general errors | ||
| // - handle if /proc/config.gz doesn't exist | ||
| // - if empty, grab config without using grep to filter? | ||
|
|
||
| if (kernelConfigLinesList.isEmpty()) { | ||
| Timber.e("failed to read kernel config") | ||
| } | ||
|
|
||
| return kernelConfigLinesList | ||
| } |
Oops, something went wrong.