modules/android-integration: add am command and many termux-tools ones #382
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
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
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,132 @@ | ||
| # Copyright (c) 2019-2024, see AUTHORS. Licensed under MIT License, see LICENSE. | ||
|
|
||
| { config, lib, pkgs, ... }: | ||
|
|
||
| let | ||
| cfg = config.android-integration; | ||
|
|
||
| termux-am = | ||
| pkgs.callPackage (import ../../pkgs/android-integration/termux-am.nix) { }; | ||
| termux-tools = | ||
| pkgs.callPackage (import ../../pkgs/android-integration/termux-tools.nix) { | ||
| inherit termux-am; | ||
| }; | ||
| in | ||
| { | ||
|
|
||
| ###### interface | ||
|
|
||
| options.android-integration = { | ||
|
|
||
| am.enable = lib.mkOption { | ||
| type = lib.types.bool; | ||
| default = false; | ||
| example = "true"; | ||
| description = lib.mdDoc '' | ||
| Provide an `am` (activity manager) command. | ||
| Is not guaranteed to be a real deal, could be of limited compatibility | ||
| with real `am` (like `termux-am`). | ||
| ''; | ||
| }; | ||
|
|
||
| termux-open.enable = lib.mkOption { | ||
| type = lib.types.bool; | ||
| default = false; | ||
| example = "true"; | ||
| description = lib.mdDoc '' | ||
| Provide a `termux-open` command | ||
| that opens files or urls in external apps | ||
| (uses `com.termux.app.TermuxOpenReceiver`). | ||
| ''; | ||
| }; | ||
|
|
||
| termux-open-url.enable = lib.mkOption { | ||
| type = lib.types.bool; | ||
| default = false; | ||
| example = "true"; | ||
| description = lib.mdDoc '' | ||
| Provide a `termux-open-url` command | ||
| that opens files or urls in external apps | ||
| (uses `android.intent.action.VIEW`). | ||
| ''; | ||
| }; | ||
|
|
||
| termux-setup-storage.enable = lib.mkOption { | ||
| type = lib.types.bool; | ||
| default = false; | ||
| example = "true"; | ||
| description = lib.mdDoc '' | ||
| Provide a `termux-setup-storage` command | ||
| that makes the app request storage permission, | ||
| and then creates a $HOME/storage directory with symlinks to storage. | ||
| ''; | ||
| }; | ||
|
|
||
| termux-reload-settings.enable = lib.mkOption { | ||
| type = lib.types.bool; | ||
| default = false; | ||
| example = "true"; | ||
| description = lib.mdDoc '' | ||
| Provide a `termux-reload-settings` command | ||
| which applies changes to font, colorscheme or terminal | ||
| without the need to close all the sessions. | ||
| ''; | ||
| }; | ||
|
|
||
| termux-wake-lock.enable = lib.mkOption { | ||
| type = lib.types.bool; | ||
| default = false; | ||
| example = "true"; | ||
| description = lib.mdDoc '' | ||
| Provide a `termux-wake-lock` command | ||
| that tones down Android power saving measures. | ||
| This is the same action that's available from the notification. | ||
| ''; | ||
| }; | ||
|
|
||
| termux-wake-unlock.enable = lib.mkOption { | ||
| type = lib.types.bool; | ||
| default = false; | ||
| example = "true"; | ||
| description = lib.mdDoc '' | ||
| Provide a `termux-wake-unlock` command | ||
| that undoes the effect of the `termux-wake-lock` one. | ||
| ''; | ||
| }; | ||
|
|
||
| xdg-open.enable = lib.mkOption { | ||
| type = lib.types.bool; | ||
| default = false; | ||
| example = "true"; | ||
| description = lib.mdDoc '' | ||
| Provide an `xdg-open` alias to `termux-open` command. | ||
| ''; | ||
| }; | ||
|
|
||
| unsupported.enable = lib.mkOption { | ||
| type = lib.types.bool; | ||
| default = false; | ||
| example = "true"; | ||
| description = lib.mdDoc '' | ||
| Provide several more unsupported and untested commands. | ||
| For testing and for brave souls only. | ||
| ''; | ||
| }; | ||
|
|
||
| }; | ||
|
|
||
| ###### implementation | ||
|
|
||
| config = let ifD = cond: pkg: if cond then [ pkg ] else [ ]; in { | ||
| environment.packages = | ||
| (ifD cfg.am.enable termux-am) ++ | ||
| (ifD cfg.termux-setup-storage.enable termux-tools.setup_storage) ++ | ||
| (ifD cfg.termux-open.enable termux-tools.open) ++ | ||
| (ifD cfg.termux-open-url.enable termux-tools.open_url) ++ | ||
| (ifD cfg.termux-reload-settings.enable termux-tools.reload_settings) ++ | ||
| (ifD cfg.termux-wake-lock.enable termux-tools.wake_lock) ++ | ||
| (ifD cfg.termux-wake-unlock.enable termux-tools.wake_unlock) ++ | ||
| (ifD cfg.xdg-open.enable termux-tools.xdg_open) ++ | ||
| (ifD cfg.unsupported.enable termux-tools.out); | ||
| }; | ||
| } | ||
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
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,33 @@ | ||
| # Copyright (c) 2019-2024, see AUTHORS. Licensed under MIT License, see LICENSE. | ||
|
|
||
| { stdenv, fetchFromGitHub, cmake }: | ||
|
|
||
| let | ||
| appPath = "/data/data/com.termux.nix/files/apps/com.termux.nix"; | ||
| socketPath = "${appPath}/termux-am/am.sock"; | ||
| in | ||
| stdenv.mkDerivation rec { | ||
| name = "termux-am"; | ||
| version = "1.5.0"; | ||
| src = fetchFromGitHub { | ||
| owner = "termux"; | ||
| repo = "termux-am-socket"; | ||
| rev = version; | ||
| sha256 = "sha256-6pCv2HMBRp8Hi56b43mQqnaFaI7y5DfhS9gScANwg2I="; | ||
| }; | ||
| nativeBuildInputs = [ cmake ]; | ||
| patchPhase = '' | ||
| # Header generation doesn't seem to work on android | ||
| echo "#define SOCKET_PATH \"${socketPath}\"" > termux-am.h | ||
| # Fix the bash link so that nix can patch it + path to termux-am-socket | ||
| substituteInPlace termux-am.sh.in \ | ||
| --replace @TERMUX_PREFIX@/bin/bash /bin/bash \ | ||
| --replace \ | ||
| "termux-am-socket \"\$am_command_string\"" \ | ||
| "$out/bin/termux-am-socket \"\$am_command_string\"" | ||
| ''; | ||
| postInstall = '' | ||
| # Scripts use 'am' as an alias. | ||
| ln -s $out/bin/termux-am $out/bin/am | ||
| ''; | ||
| } |
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,124 @@ | ||
| # Copyright (c) 2019-2024, see AUTHORS. Licensed under MIT License, see LICENSE. | ||
|
|
||
| { stdenvNoCC | ||
| , fetchFromGitHub | ||
| , autoreconfHook | ||
| , makeWrapper | ||
| , gnused | ||
| , getopt | ||
| , termux-am | ||
| }: | ||
|
|
||
| stdenvNoCC.mkDerivation rec { | ||
| name = "termux-tools"; | ||
| version = "1.42.4"; | ||
| src = fetchFromGitHub { | ||
| owner = "termux"; | ||
| repo = "termux-tools"; | ||
| rev = "v${version}"; | ||
| sha256 = "sha256-LkkeaEQcY8HgunBYAg3Ymn5xYPvrGqGNCZTd/NyIOKY="; | ||
| }; | ||
| nativeBuildInputs = [ autoreconfHook makeWrapper ]; | ||
| propagatedInputs = [ termux-am ]; | ||
|
|
||
| # https://github.com/termux/termux-tools/pull/95 | ||
| patches = [ ./termux-tools.patch ]; | ||
| postPatch = '' | ||
| substituteInPlace scripts/termux-setup-storage.in \ | ||
| --replace @TERMUX_HOME@ /data/data/com.termux.nix/files/home/ \ | ||
| --replace @TERMUX_APP_PACKAGE@ com.termux.nix | ||
| substituteInPlace scripts/termux-open.in \ | ||
| --replace 'getopt ' '${getopt}/bin/getopt ' | ||
| substituteInPlace \ | ||
| scripts/termux-open.in \ | ||
| scripts/termux-wake-lock.in \ | ||
| scripts/termux-wake-unlock.in \ | ||
| --replace @[email protected] com.termux.app \ | ||
| --replace @TERMUX_APP_PACKAGE@ com.termux.nix | ||
| substituteInPlace scripts/termux-reload-settings.in \ | ||
| --replace @TERMUX_APP_PACKAGE@ com.termux.nix | ||
| ${gnused}/bin/sed -i 's|^am |${termux-am}/bin/am |' scripts/* | ||
|
There was a problem hiding this comment. Why do you use There was a problem hiding this comment. because substituteInPlace is the recommended Nix way, being more explicit and less surprising and everything... ... and then there are 6 calls to am that need to be patched to use the real path, but you can't just replace all |
||
|
|
||
| rm -r doc # manpage is half misleading, pulling pandoc is not worth it | ||
| substituteInPlace Makefile.am --replace \ | ||
| 'SUBDIRS = . scripts doc mirrors motds' \ | ||
| 'SUBDIRS = . scripts' | ||
| substituteInPlace configure.ac --replace \ | ||
| 'AC_CONFIG_FILES([Makefile scripts/Makefile doc/Makefile' \ | ||
| 'AC_CONFIG_FILES([Makefile scripts/Makefile])' | ||
| substituteInPlace configure.ac --replace \ | ||
| 'mirrors/Makefile motds/Makefile])' "" | ||
| ''; | ||
|
|
||
| outputs = [ | ||
| "out" # all the unsupported unsorted stuff | ||
| "setup_storage" # termux-setup-storage | ||
| "open" # termux-open | ||
| "open_url" # termux-open-url | ||
| "reload_settings" # termux-reload-settings | ||
| "wake_lock" # termux-wake-lock | ||
| "wake_unlock" # termux-wake-unlock | ||
| "xdg_open" # xdg-open | ||
| ]; | ||
| postInstall = '' | ||
| rm $out/etc/termux-login.sh | ||
| rm $out/etc/profile.d/init-termux-properties.sh | ||
| rm -d $out/etc/profile.d | ||
| rm -d $out/etc | ||
|
|
||
| rm $out/bin/chsh # we offer a declarative way to change your shell | ||
| rm $out/bin/cmd # doesn't work because we overlay /system/bin | ||
| rm $out/bin/dalvikvm # doesn't work because we overlay /system/bin | ||
| rm $out/bin/df # works without the magic | ||
| rm $out/bin/getprop # doesn't work because we overlay /system/bin | ||
| rm $out/bin/logcat # doesn't work because we overlay /system/bin | ||
| rm $out/bin/login # we have our own, very complex login | ||
| rm $out/bin/ping # doesn't work because we overlay /system/bin | ||
| rm $out/bin/ping6 # doesn't work because we overlay /system/bin | ||
| rm $out/bin/pkg # we use Nix | ||
| rm $out/bin/pm # doesn't work because we overlay /system/bin | ||
| rm $out/bin/settings # doesn't work because we overlay /system/bin | ||
| rm $out/bin/su # doesn't work because we overlay /bin | ||
| rm $out/bin/top # doesn't work because we overlay /system/bin | ||
|
|
||
| rm $out/bin/termux-change-repo # we use Nix | ||
| rm $out/bin/termux-fix-shebang # we use Nix | ||
| rm $out/bin/termux-info # Termux-specific. write our own? | ||
| rm $out/bin/termux-reset # untested and dangerous | ||
| rm $out/bin/termux-restore # untested and dangerous | ||
| rm $out/bin/termux-setup-package-manager # we use Nix | ||
|
|
||
| mkdir -p $setup_storage/bin | ||
| mv $out/bin/termux-setup-storage $setup_storage/bin/ | ||
|
|
||
| mkdir -p $open/bin | ||
| mv $out/bin/termux-open $open/bin/ | ||
|
|
||
| mkdir -p $open_url/bin | ||
| mv $out/bin/termux-open-url $open_url/bin/ | ||
|
|
||
| mkdir -p $reload_settings/bin | ||
| mv $out/bin/termux-reload-settings $reload_settings/bin/ | ||
|
|
||
| mkdir -p $wake_lock/bin | ||
| mv $out/bin/termux-wake-lock $wake_lock/bin/ | ||
|
|
||
| mkdir -p $wake_unlock/bin | ||
| mv $out/bin/termux-wake-unlock $wake_unlock/bin/ | ||
|
|
||
| mkdir -p $xdg_open/bin | ||
| rm $out/bin/xdg-open | ||
| ln -s $open/bin/termux-open $xdg_open/bin/xdg-open | ||
|
|
||
| # check that we didn't package we didn't want to | ||
| find $out | ${gnused}/bin/sed "s|^$out|.|" | sort > effective | ||
| echo . >> expected | ||
| echo ./bin >> expected | ||
| echo ./bin/termux-backup >> expected # entirely untested | ||
| echo ./share >> expected | ||
| echo ./share/examples >> expected | ||
| echo ./share/examples/termux >> expected | ||
| echo ./share/examples/termux/termux.properties >> expected # useful | ||
| diff -u expected effective | ||
| ''; | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is phrased weirdly, the "is not garunteed/could be" language is unnecessary. A link to more details on the limitations would be great (if they exist). I would suggest:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thing is, I'm not well-versed in Android and don't know its exact limitations. It's very different from the real deal in /system/bin/am, which is a shell wrapper against some java thing, in that it sends the command-line over a socket and something in Termux app handles that. The help message is very different, I wouldn't be surprised if it had different error reporting or differed in exit codes, etc., etc., but I don't know the exact details. All I know it's the best am we can currently have because it works.