Skip to content

Using optional p4a hook for inserting BroadcastReceiver without editing AndroidManifest.tmpl.xml #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Fector101 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Using optional p4a hook for inserting BroadcastReceiver without editing AndroidManifest.tmpl.xml #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 39 additions & 2 deletions Action Buttons Notification/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ You can add a maximum of three action buttons to a notification
```
here scr is a folder within my project directory that contains the java class `action1` that I have written.

## 7. Edit Android Manifest Template
## 7. Adding Broadcast Receiver
We need to register our broadcast receiver in our android manifest.

### option 1: Edit Manifest Template
Inside your project directory you will find a `.buildozer` folder. Within this folder navigate to this path `.buildozer/android/platform/python-for-android/pythonforandroid/bootstraps/sdl2/build/templates`.

There you will find an android manifest template file.
Expand All @@ -60,6 +60,43 @@ You can add a maximum of three action buttons to a notification
{% endfor %}
```

### option 2: Use python-for-android hook
You can also use a p4a hook to automatically add the receiver after the `AndroidManifest.xml` is generate each time.
In `buildozer.spec`, add:
```
# (str) Filename to the hook for p4a
p4a.hook = p4a/hook.py
```
Lastly Create `p4a/hook.py` in your project directory and insert:
```py
from pathlib import Path
from pythonforandroid.toolchain import ToolchainCL

def after_apk_build(toolchain: ToolchainCL):
manifest_file = Path(toolchain._dist.dist_dir) / "src" / "main" / "AndroidManifest.xml"
old_manifest = manifest_file.read_text(encoding="utf-8")

# Your custom receiver XML
receiver_xml = '''
<receiver android:name="org.org.appname.Action1"
android:enabled="true"
android:exported="false">
<intent-filter>
<action android:name="android.intent.action.BOOT_COMPLETED" />
</intent-filter>
</receiver>
'''

# Insert before the closing </application>
new_manifest = old_manifest.replace('</application>', f'{receiver_xml}\n</application>')

manifest_file.write_text(new_manifest, encoding="utf-8")

if old_manifest != new_manifest:
print("Receiver added successfully")
else:
print("Failed to add receiver")
```

## 8. Build
Create a copy of the edited manifest in some other directory.
Expand Down