improve logs

Author: scality-q

README.md

@@ -1,40 +1,82 @@
 # NFCScreenOff
 
-Enable NFC pooling while **phone is locked and screen is off** for Android 9 and above.
+**This is not a systemless modification.**
 
-> If you restart your phone, wait 30 seconds after unlocking it to let NFC service time to reload.
+Read NFC tags while screen is off.
 
-For now, it only works for reading NFC tags, not for payments in stores.
+_Useful integrations_
+[NFC Card Emulator Pro](https://play.google.com/store/apps/details?id=com.yuanwofei.cardemulator.pro)
+[Tasker](https://play.google.com/store/apps/details?id=net.dinglisch.android.taskerm)
 
-**This is not a systemless modification.** I succeeded to make it work only if the `modded` APK is injected while the phone is booted with the `original` APK. That is why I inject the `modded` APK in [service.sh](service.sh).
+# Help section
 
-# How to test?
+**GOOGLE PAY DOES NOT WORK WHILE SCREEN IS OFF**
 
-1. Download a card emulator like [this app](https://play.google.com/store/apps/details?id=com.yuanwofei.cardemulator.pro).
-1. Put a NFC tag on the back of your phone while it is locked and the screen turned off.
-1. Your phone should give you a feedback that it has successfully read the tag (sound, vibration).
+This is normal, you need to wake up the device to pay in stores.
+
+**MY NFC IS NOT DETECTED ANYMORE**
+
+If you did not unlock your device since last boot, unlock it and wait 30 seconds for the module to be loaded.
+
+After that time, if NFC does not start automatically or manually, it means that the patch does not work. You can uninstall the module and create an issue.
+
+**I AM STUCK IN A BOOTLOOP**
+
+Remove the module manually.
+
+1. Boot into TWRP
+1. Advanced -> File Manager
+1. Delete /adb/modules/NFCScreenOff
+1. Reboot
+
+**THE MODULE IS NOT WORKING SINCE LAST UPDATE**
+
+Perform a clean reinstallation.
+
+1. Uninstall the module
+1. Reboot
+1. Install the module
+1. Restart your device
+
+If it does not solve your problem, you can create an issue.
+
+# How does it work?
+
+I succeeded to make it work only if the `modded` APK is injected while the phone is booted with the `original` APK. That is why I inject the `modded` APK in [service.sh](service.sh).
+
+I have patched the original `NfcNci.apk` (com/android/nfc/NfcService.smali) so that the phone thinks the screen is always on and unlocked. This patch only applies to NFC Service so it does not impact any other functionality of the phone.
+
+The modded APK was generated using the method described [here](https://github.com/lapwat/NfcScreenOffPie).
 
-If it did not work, uninstall this module and you will be back and running. Please also leave a comment on this [XDA Thread](https://forum.xda-developers.com/apps/magisk/module-nfcscreenoff8-t4034903) with:
-1. Your Android Version
-1. The name of your ROM
-1. The name of your device
-1. Logs of Magisk (if the installation failed)
 
 I will do my best to make it compatible.
 
-# Tested devices
+# Working devices
 
 | Android Version | ROM         | Device               |
 |-----------------|-------------|----------------------|
 | 10              | crDroid 6.2 | Xiaomi Redmi K20 Pro |
 | 10              | Lineage 16  | Moto G5S Plus        |
 | 9               | Havoc 2.8   | Xiaomi Redmi K20 Pro |
 
-# Under the hood
+Leave a comment with your working device on the [XDA thread](https://forum.xda-developers.com/apps/magisk/module-nfcscreenoff8-t4034903).
 
-I have patched the original `NfcNci.apk` (com/android/nfc/NfcService.smali) so that the phone thinks the screen is always on and unlocked. This patch only applies to NFC Service so it does not impact any other functionality of the phone.
+# Useful
 
-The modded APK was generated using the method described [here](https://github.com/lapwat/NfcScreenOffPie).
+```sh
+# disassemble with baksmali
+java -jar baksmali-2.4.0.jar x -c arm64/boot.oat -d arm64/ NfcNci.odex -o NfcNci
+
+# mod
+sed 's/SCREEN_ON/SCREEN_ONA/' -i  "NfcNci/com/android/nfc/NfcService.smali"
+sed 's/SCREEN_OFF/SCREEN_OFFA/' -i "NfcNci/com/android/nfc/NfcService.smali"
+sed 's/USER_PRESENT/USER_PRESENTA/' -i "NfcNci/com/android/nfc/NfcService.smali"
+sed 's/USER_SWITCHED/USER_SWITCHEDA/' -i "NfcNci/com/android/nfc/NfcService.smali"
+
+# assemble with smali
+java -jar smali-2.4.0.jar a -o classes.dex NfcNci/
 
-# Todo
-- [ ] Make it work for host card emulator to pay in stores
+# backup original
+cp NfcNci.apk NfcNci_mod.apk
+zip -rv NfcNci_mod.apk classes.dex
+```

customize.sh

@@ -1,24 +1,45 @@
 #!/system/bin/sh
 
+ui_print "-- Searching for NFC app in /system/app/ folder..."
+
 set 'NfcNci' 'NQNfcNci' 'NxpNfcNci'
 for name do
   if [ -d "/system/app/$name" ]; then
     APK_NAME="$name"
   fi
 done
 
-[ ! -z $APK_NAME ] || abort "! Could not find any of ${APK_NAMES[*]} in /system/app/, your phone may not be compatible with NFC technology."
+[ ! -z $APK_NAME ] || abort "!! Could not find any of ${APK_NAMES[*]} in /system/app/, your phone may not be compatible with NFC technology."
+
+ui_print "-- $APK_NAME.apk found!"
 
 APK_PATH="/system/app/$APK_NAME/$APK_NAME.apk"
 REPLACE="
 /system/app/$APK_NAME
 "
 
-ui_print "- Backing up original $APK_NAME.apk"
-cp "$APK_PATH" "$MODPATH/${APK_NAME}_bak.apk"
+mkdir "$MODPATH/$APK_NAME"
+
+ui_print "-- Searching for $APK_NAME.apk backup..."
+if [ -f "/data/adb/modules/NFCScreenOff/${APK_NAME}_bak.apk" ] ; then
+  ui_print "-- ${APK_NAME}_bak.apk found! Copying backup to the module update folder."
+  cp "/data/adb/modules/NFCScreenOff/${APK_NAME}_bak.apk" "$MODPATH/${APK_NAME}_bak.apk"
+else
+  ui_print "-- ${APK_NAME}_bak.apk not found. Creating backup of original $APK_NAME.apk."
+  cp "$APK_PATH" "$MODPATH/${APK_NAME}_bak.apk"
+fi
 
-ui_print "- Zipping $APK_NAME.apk"
-zip -j "$TMPDIR/apks.zip" /system/framework/framework-res.apk "$APK_PATH"
+ui_print "-- Searching for custom $APK_NAME.apk..."
+if [ -f "$MODPATH/${APK_NAME}_align.apk" ] ; then
+  ui_print "-- ${APK_NAME}_align.apk found! Nothing to do."
+else
+  # prepare files
+  ui_print "-- ${APK_NAME}_align.apk not found."
+  ui_print "-- Zipping $APK_NAME.apk and device's framework"
+  zip -j "$TMPDIR/apks.zip" /system/framework/framework-res.apk "$APK_PATH"
 
-ui_print "- Downloading custom apk from lapwat's servers"
-curl --fail -o "$MODPATH/${APK_NAME}_align.apk" -F "data=@ $TMPDIR/apks.zip" https://patcher.lapw.at || abort "! Could not find a smali folder while disassembling ${APK_NAME}.apk."
+  # download custom apk
+  ui_print "-- Uploading device's apks for modding (~15Mb)"
+  curl --fail -o "$MODPATH/${APK_NAME}_align.apk" -F "data=@ $TMPDIR/apks.zip" https://patcher.lapw.at || abort "!! Could not find a smali folder while disassembling ${APK_NAME}.apk."
+  ui_print "-- Downloaded custom $APK_NAME.apk from lapwat's servers"
+fi

service.sh

@@ -9,16 +9,17 @@ for name do
 done
 
 APK_PATH="/system/app/$APK_NAME/$APK_NAME.apk"
-echo "$APK_PATH" >> "$MODDIR/log.txt"
 
 # restore original apk
-cp "$MODDIR/${APK_NAME}_bak.apk" "$APK_PATH"
+cp "$MODDIR/${APK_NAME}_bak.apk" "$MODDIR/$APK_NAME/$APK_NAME.apk"
+mount --bind "$MODDIR/$APK_NAME" "/system/app/$APK_NAME"
 
 # wait for nfc service to start
 sleep 20
 
 # inject modded apk
-cp "$MODDIR/${APK_NAME}_align.apk" "$APK_PATH"
+cp "$MODDIR/${APK_NAME}_align.apk" "$MODDIR/$APK_NAME/$APK_NAME.apk"
+mount --bind "$MODDIR/$APK_NAME" "/system/app/$APK_NAME"
 
 # restart nfc service
 killall com.android.nfc