Add Dynamic Shortcuts integration

[gergely-sallai]

Added support for Android Dynamic Shortcuts. Dynamic Shortcuts is a standard Android feature that is supported by most of the launchers.

How does this work for users?

Now users can request the app to add shortcuts to their favourite tunnels. When the user enables this for a specific tunnel, 2 dynamic shortcuts are created, one to UP the tunnel, other is to DOWN it.

Additionally this functionality enables users to use certain automation apps to automatically toggle tunnels. For example the built-in Bixby Routines on Samsung devices. (This was my original motivation for adding this feature, but I was trying to incorporate it in a way that could benefit all users.)

What changes were made to previous components to support this?

1. TunnelToggleActivity is now more broadly used. Previously it seemed to be only called from TileService in certain situations.
2. A new button has been added next to the tunnel toggle switch for each tunnel item.
3. Added androidx shortcuts library

Limitations and possible points for future improvement

To my best knowledge all of these -- expect the first point -- were there previous to my PR, and I can help to sort these out if needed.

1. Tooltip popup for the "add shortcuts" button is only available for devices running API 26 and up. This could be solved generally via TooltipCompat, but I didn't want to complicate the code because of this. As doing this with the compat lib can not be done purely from XML..
2. TunnelToggleActivity can be shown briefly when a tunnel is toggled, and it can look weird. This could possibly be solved by adding some design to the activity and showing it a bit longer in a controlled manner, maybe with some animation.
3. There may be some misconfigurations around material colors, it caused me some rendering differences on certain OS version with the button colors. I believe this could be solved with a refactor to support Material You (M3) and its dynamic colors, and fall back to a default on older versions. I do not know what is the intended design language of the app, so I didn't dare to refactor it just yet. :)

[swiffer]

Would be great to see this merged / released.

Looking for a solution to auto-toggle via Samsung Bixby Routines as soon as I leave my Home-WiFi.

[gergely-sallai]

Just to be completely transparent regarding this feature.
I've been actively using it with Bixby Routines for the exact same use-case as you want since I've pushed the changes.
The feature works nicely, no problems there.

However the idea of using the shortcut as a way to toggle automatically with Bixby Routines does have its drawbacks.
Namely it only works flawlessly if the phone is unlocked/awake. This is due to the fact that it's using an Android Activity to do the actual toggling, which does not work with a locked phone. Don't know how this could be better solved.

In my eyes this is a Bixby limitation. Bixby Routines should enable toggling of custom VPN tunnels or let us use custom broadcast messages (to toggle the tunnel in this case). Nevertheless I still use it and it's better than always having to do this manually..

[swiffer]

Thanks for the updated Info - without going to much offtopic: do you know If Bixby Routines gained functionality with OneUI 5 so toggling VPNs defined via 3rd Party Apps Work Out of the Box?

[gergely-sallai]

Don't know yet, haven't checked.

[alexsahka]

Added support for Android Dynamic Shortcuts. Dynamic Shortcuts is a standard Android feature that is supported by most of the launchers.

How does this work for users?

Now users can request the app to add shortcuts to their favourite tunnels. When the user enables this for a specific tunnel, 2 dynamic shortcuts are created, one to UP the tunnel, other is to DOWN it.

Additionally this functionality enables users to use certain automation apps to automatically toggle tunnels. For example the built-in Bixby Routines on Samsung devices. (This was my original motivation for adding this feature, but I was trying to incorporate it in a way that could benefit all users.)

What changes were made to previous components to support this?

1. TunnelToggleActivity is now more broadly used. Previously it seemed to be only called from TileService in certain situations.
2. A new button has been added next to the tunnel toggle switch for each tunnel item.
3. Added androidx shortcuts library

Limitations and possible points for future improvement

To my best knowledge all of these -- expect the first point -- were there previous to my PR, and I can help to sort these out if needed.

1. Tooltip popup for the "add shortcuts" button is only available for devices running API 26 and up. This could be solved generally via TooltipCompat, but I didn't want to complicate the code because of this. As doing this with the compat lib can not be done purely from XML..
2. TunnelToggleActivity can be shown briefly when a tunnel is toggled, and it can look weird. This could possibly be solved by adding some design to the activity and showing it a bit longer in a controlled manner, maybe with some animation.
3. There may be some misconfigurations around material colors, it caused me some rendering differences on certain OS version with the button colors. I believe this could be solved with a refactor to support Material You (M3) and its dynamic colors, and fall back to a default on older versions. I do not know what is the intended design language of the app, so I didn't dare to refactor it just yet. :)

Please, is it possible to post the compiled android app with Dynamic Shortcuts? Thank you!

[nschwing]

@alexsahka https://github.com/nschwing/wireguard-android/releases/tag/ui-signed

Thanks gergely-sallai!

[nibytes]

Could it merged / released? Very useful feature.