Add a settings import/export receiver
If you install a signed release build and want to switch to an unsigned debug build, that involves an uninstall and reinstall, which by default will lose your configuration. Modify scripts/pull_config.sh and scripts/push_config.sh so it works on release builds, not just debug builds, and update README.md to tell you to export your config before doing this kind of upgrade.
This commit is contained in:
1 parent
f4c43090f5
commit
3e8be93833
7 files changed
+271
-6
No files matched your search
@@ -0,0 +1,46 @@
|
||||
# Sourceable adb helper functions shared by the scripts/ utilities.
|
||||
# Not a standalone script; use: source "$(dirname "$0")/adbutil.sh"
|
||||
|
||||
# adb_preflight <package>
|
||||
#
|
||||
# Checks that adb exists, exactly one device is reachable, and <package> is
|
||||
# installed, then prints the install mode on stdout:
|
||||
# debug - debuggable build; run-as works
|
||||
# release - installed but not debuggable; run-as is refused
|
||||
# Any other condition prints a diagnosis to stderr and returns nonzero (which
|
||||
# aborts callers running under `set -e`).
|
||||
adb_preflight() {
|
||||
local package="$1"
|
||||
local state
|
||||
|
||||
if ! command -v adb >/dev/null 2>&1; then
|
||||
echo "Error: adb not found on PATH" >&2
|
||||
return 1
|
||||
fi
|
||||
|
||||
# get-state fails outright when there is no device or more than one, and
|
||||
# reports states like "offline" / "unauthorized" for unusable ones.
|
||||
if ! state="$(adb get-state 2>&1)"; then
|
||||
echo "Error: no usable adb device ($state)." >&2
|
||||
echo " Connected devices:" >&2
|
||||
adb devices -l | sed '1d;/^$/d' >&2
|
||||
return 1
|
||||
fi
|
||||
if [ "$state" != "device" ]; then
|
||||
echo "Error: adb device is in state '$state' (offline/unauthorized?)" >&2
|
||||
return 1
|
||||
fi
|
||||
|
||||
# grep rather than pm's exit code: exit-code propagation over `adb shell`
|
||||
# needs shell protocol v2, which very old adb binaries lack.
|
||||
if ! adb shell pm path "$package" 2>/dev/null | grep -q "^package:"; then
|
||||
echo "Error: $package is not installed on this device" >&2
|
||||
return 1
|
||||
fi
|
||||
|
||||
if adb shell run-as "$package" true >/dev/null 2>&1; then
|
||||
echo debug
|
||||
else
|
||||
echo release
|
||||
fi
|
||||
}
|
||||
+27
-2
@@ -1,11 +1,36 @@
|
||||
#!/bin/bash
|
||||
# Pull faceclaw's shared preferences off the attached device.
|
||||
# Usage: pull_config.sh [output-file] (default: faceclaw_settings.xml)
|
||||
#
|
||||
# Uses run-as on debuggable (dev) builds. On release builds, where run-as is
|
||||
# refused, falls back to the FaceclawSettingsPortReceiver broadcast, which
|
||||
# copies the settings file into the app's external files dir for adb to pull
|
||||
# (and which only the adb shell can trigger; see the receiver's javadoc).
|
||||
set -euo pipefail
|
||||
|
||||
source "$(cd "$(dirname "$0")" && pwd)/adbutil.sh"
|
||||
|
||||
PACKAGE=com.faceclaw.app
|
||||
PREFS=shared_prefs/faceclaw_settings.xml
|
||||
OUT="${1:-faceclaw_settings.xml}"
|
||||
EXPORT_REMOTE=/sdcard/Android/data/$PACKAGE/files/faceclaw-settings-export.xml
|
||||
|
||||
adb exec-out run-as "$PACKAGE" cat "$PREFS" > "$OUT"
|
||||
echo "Pulled $PREFS to $OUT"
|
||||
MODE="$(adb_preflight "$PACKAGE")"
|
||||
|
||||
if [ "$MODE" = debug ]; then
|
||||
adb exec-out run-as "$PACKAGE" cat "$PREFS" > "$OUT"
|
||||
echo "Pulled $PREFS to $OUT"
|
||||
else
|
||||
echo "Release build installed; using settings-port broadcast..."
|
||||
RESULT="$(adb shell am broadcast -n "$PACKAGE/.FaceclawSettingsPortReceiver" \
|
||||
-a com.faceclaw.app.SETTINGS_EXPORT)"
|
||||
if ! printf '%s' "$RESULT" | grep -q 'data="exported:'; then
|
||||
printf '%s\n' "$RESULT" >&2
|
||||
echo "Error: export broadcast did not report success (old app version?)" >&2
|
||||
exit 1
|
||||
fi
|
||||
adb pull "$EXPORT_REMOTE" "$OUT" >/dev/null
|
||||
# The export contains API tokens; don't leave it sitting on shared storage.
|
||||
adb shell rm "$EXPORT_REMOTE"
|
||||
echo "Pulled $PREFS to $OUT (via settings-port export)"
|
||||
fi
|
||||
+30
-4
@@ -3,12 +3,21 @@
|
||||
# Usage: push_config.sh [input-file] (default: faceclaw_settings.xml)
|
||||
# Validates the XML, force-stops the app (so a running instance doesn't
|
||||
# overwrite the pushed file from its in-memory prefs), then installs it.
|
||||
#
|
||||
# Uses run-as on debuggable (dev) builds. On release builds, where run-as is
|
||||
# refused, falls back to the FaceclawSettingsPortReceiver broadcast: the file
|
||||
# is staged in the app's external files dir and the receiver (adb-only; see
|
||||
# its javadoc) validates and installs it, then exits so the next launch
|
||||
# re-reads settings from disk.
|
||||
set -euo pipefail
|
||||
|
||||
source "$(cd "$(dirname "$0")" && pwd)/adbutil.sh"
|
||||
|
||||
PACKAGE=com.faceclaw.app
|
||||
PREFS=shared_prefs/faceclaw_settings.xml
|
||||
IN="${1:-faceclaw_settings.xml}"
|
||||
STAGE=/data/local/tmp/faceclaw_settings_push.xml
|
||||
IMPORT_REMOTE=/sdcard/Android/data/$PACKAGE/files/faceclaw-settings-import.xml
|
||||
|
||||
if [ ! -f "$IN" ]; then
|
||||
echo "Error: $IN not found" >&2
|
||||
@@ -24,8 +33,25 @@ else
|
||||
exit 1
|
||||
fi
|
||||
|
||||
MODE="$(adb_preflight "$PACKAGE")"
|
||||
|
||||
adb shell am force-stop "$PACKAGE"
|
||||
adb push "$IN" "$STAGE"
|
||||
adb shell run-as "$PACKAGE" cp "$STAGE" "$PREFS"
|
||||
adb shell rm "$STAGE"
|
||||
echo "Pushed $IN to $PREFS (app was force-stopped; relaunch it to pick up the new settings)"
|
||||
|
||||
if [ "$MODE" = debug ]; then
|
||||
adb push "$IN" "$STAGE"
|
||||
adb shell run-as "$PACKAGE" cp "$STAGE" "$PREFS"
|
||||
adb shell rm "$STAGE"
|
||||
echo "Pushed $IN to $PREFS (app was force-stopped; relaunch it to pick up the new settings)"
|
||||
else
|
||||
echo "Release build installed; using settings-port broadcast..."
|
||||
adb push "$IN" "$IMPORT_REMOTE" >/dev/null
|
||||
RESULT="$(adb shell am broadcast -n "$PACKAGE/.FaceclawSettingsPortReceiver" \
|
||||
-a com.faceclaw.app.SETTINGS_IMPORT)"
|
||||
if ! printf '%s' "$RESULT" | grep -q 'data="imported:'; then
|
||||
printf '%s\n' "$RESULT" >&2
|
||||
adb shell rm -f "$IMPORT_REMOTE"
|
||||
echo "Error: import broadcast did not report success (old app version?)" >&2
|
||||
exit 1
|
||||
fi
|
||||
echo "Pushed $IN to $PREFS via settings-port import (previous settings kept as $PREFS.bak)"
|
||||
fi
|
||||
Reference in new issue
Block a user