add support for app widgets (see #44)

Author: jrpie

app/build.gradle

@@ -106,6 +106,7 @@ dependencies {
     implementation 'com.google.android.material:material:1.12.0'
     implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3")
     implementation "eu.jonahbauer:android-preference-annotations:1.1.2"
+    implementation 'androidx.activity:activity:1.10.1'
     annotationProcessor "eu.jonahbauer:android-preference-annotations:1.1.2"
     annotationProcessor "com.android.databinding:compiler:$android_plugin_version"
     testImplementation 'junit:junit:4.13.2'

app/src/main/AndroidManifest.xml

@@ -8,6 +8,7 @@
         tools:ignore="QueryAllPackagesPermission" />
     <uses-permission android:name="android.permission.ACCESS_HIDDEN_PROFILES" />
     <uses-permission android:name="android.permission.EXPAND_STATUS_BAR" />
+    <uses-permission android:name="android.permission.BIND_APPWIDGET" />
 
     <application
         android:name=".Application"
@@ -19,6 +20,13 @@
         android:supportsRtl="true"
         android:theme="@style/launcherBaseTheme"
         tools:ignore="UnusedAttribute">
+        <activity
+            android:name=".ui.widgets.manage.ManageWidgetsActivity"
+            android:theme="@style/launcherHomeTheme"
+            android:exported="false" />
+        <activity
+            android:name=".ui.widgets.manage.SelectWidgetActivity"
+            android:exported="false" />
         <activity
             android:name=".ui.PinShortcutActivity"
             android:autoRemoveFromRecents="true"
@@ -97,4 +105,4 @@
         </service>
     </application>
 
-</manifest>
+</manifest>

app/src/main/java/de/jrpie/android/launcher/Application.kt

@@ -12,6 +12,8 @@ import android.os.Build.VERSION_CODES
 import android.os.UserHandle
 import androidx.core.content.ContextCompat
 import androidx.lifecycle.MutableLiveData
+import android.appwidget.AppWidgetHost
+import android.appwidget.AppWidgetManager
 import androidx.preference.PreferenceManager
 import de.jrpie.android.launcher.actions.TorchManager
 import de.jrpie.android.launcher.apps.AbstractAppInfo
@@ -20,13 +22,22 @@ import de.jrpie.android.launcher.apps.isPrivateSpaceLocked
 import de.jrpie.android.launcher.preferences.LauncherPreferences
 import de.jrpie.android.launcher.preferences.migratePreferencesToNewVersion
 import de.jrpie.android.launcher.preferences.resetPreferences
+import de.jrpie.android.launcher.widgets.LauncherWidgetProvider
+import de.jrpie.android.launcher.widgets.Widget
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 
+
+const val APP_WIDGET_HOST_ID = 42;
+
+
 class Application : android.app.Application() {
     val apps = MutableLiveData<List<AbstractDetailedAppInfo>>()
+    val widgets = MutableLiveData<Set<Widget>>()
     val privateSpaceLocked = MutableLiveData<Boolean>()
+    lateinit var appWidgetHost: AppWidgetHost
+    lateinit var appWidgetManager: AppWidgetManager
 
     private val profileAvailabilityBroadcastReceiver = object : BroadcastReceiver() {
         override fun onReceive(context: Context?, intent: Intent?) {
@@ -90,6 +101,8 @@ class Application : android.app.Application() {
             customAppNames = LauncherPreferences.apps().customNames()
         } else if (pref == LauncherPreferences.apps().keys().pinnedShortcuts()) {
             loadApps()
+        } else if (pref == LauncherPreferences.widgets().keys().widgets()) {
+            widgets.postValue(LauncherPreferences.widgets().widgets() ?: setOf())
         }
     }
 
@@ -103,10 +116,15 @@ class Application : android.app.Application() {
             torchManager = TorchManager(this)
         }
 
+        appWidgetHost = AppWidgetHost(this.applicationContext, APP_WIDGET_HOST_ID)
+        appWidgetManager = AppWidgetManager.getInstance(this.applicationContext)
+
+        appWidgetHost.startListening()
+
+
         val preferences = PreferenceManager.getDefaultSharedPreferences(this)
         LauncherPreferences.init(preferences, this.resources)
 
-
         // Try to restore old preferences
         migratePreferencesToNewVersion(this)
 
@@ -157,4 +175,10 @@ class Application : android.app.Application() {
             apps.postValue(getApps(packageManager, applicationContext))
         }
     }
+
+    override fun onTerminate() {
+        appWidgetHost.stopListening()
+        super.onTerminate()
+
+    }
 }

app/src/main/java/de/jrpie/android/launcher/Functions.kt

@@ -6,6 +6,9 @@ import android.app.role.RoleManager
 import android.content.ActivityNotFoundException
 import android.content.ClipData
 import android.content.ClipboardManager
+import android.appwidget.AppWidgetManager
+import android.appwidget.AppWidgetProvider
+import android.appwidget.AppWidgetProviderInfo
 import android.content.Context
 import android.content.Intent
 import android.content.pm.LauncherApps
@@ -223,4 +226,4 @@ fun copyToClipboard(context: Context, text: String) {
     val clipboardManager = context.getSystemService(Context.CLIPBOARD_SERVICE) as ClipboardManager
     val clipData = ClipData.newPlainText("Debug Info", text)
     clipboardManager.setPrimaryClip(clipData)
-}
+}

app/src/main/java/de/jrpie/android/launcher/preferences/LauncherPreferences$Config.java

@@ -8,6 +8,7 @@
 import de.jrpie.android.launcher.preferences.serialization.MapAbstractAppInfoStringPreferenceSerializer;
 import de.jrpie.android.launcher.preferences.serialization.SetAbstractAppInfoPreferenceSerializer;
 import de.jrpie.android.launcher.preferences.serialization.SetPinnedShortcutInfoPreferenceSerializer;
+import de.jrpie.android.launcher.preferences.serialization.SetWidgetSerializer;
 import de.jrpie.android.launcher.preferences.theme.Background;
 import de.jrpie.android.launcher.preferences.theme.ColorTheme;
 import de.jrpie.android.launcher.preferences.theme.Font;
@@ -82,5 +83,8 @@
                 @PreferenceGroup(name = "actions", prefix = "settings_actions_", suffix = "_key", value = {
                         @Preference(name = "lock_method", type = LockMethod.class, defaultValue = "DEVICE_ADMIN"),
                 }),
+                @PreferenceGroup(name = "widgets", prefix = "settings_widgets_", suffix= "_key", value = {
+                        @Preference(name = "widgets", type = Set.class, serializer = SetWidgetSerializer.class)
+                }),
         })
 public final class LauncherPreferences$Config {}

app/src/main/java/de/jrpie/android/launcher/preferences/Preferences.kt

@@ -13,6 +13,9 @@ import de.jrpie.android.launcher.preferences.legacy.migratePreferencesFromVersio
 import de.jrpie.android.launcher.preferences.legacy.migratePreferencesFromVersion3
 import de.jrpie.android.launcher.preferences.legacy.migratePreferencesFromVersionUnknown
 import de.jrpie.android.launcher.ui.HomeActivity
+import de.jrpie.android.launcher.widgets.ClockWidget
+import de.jrpie.android.launcher.widgets.WidgetPosition
+import de.jrpie.android.launcher.widgets.deleteAllWidgets
 
 /* Current version of the structure of preferences.
  * Increase when breaking changes are introduced and write an appropriate case in
@@ -71,6 +74,13 @@ fun resetPreferences(context: Context) {
     Log.i(TAG, "Resetting preferences")
     LauncherPreferences.clear()
     LauncherPreferences.internal().versionCode(PREFERENCE_VERSION)
+    deleteAllWidgets(context)
+
+    LauncherPreferences.widgets().widgets(
+        setOf(
+            ClockWidget(-500, WidgetPosition(1,4,10,3))
+        )
+    )
 
 
     val hidden: MutableSet<AbstractAppInfo> = mutableSetOf()

app/src/main/java/de/jrpie/android/launcher/preferences/serialization/PreferenceSerializers.kt

@@ -4,6 +4,7 @@ package de.jrpie.android.launcher.preferences.serialization
 
 import de.jrpie.android.launcher.apps.AbstractAppInfo
 import de.jrpie.android.launcher.apps.PinnedShortcutInfo
+import de.jrpie.android.launcher.widgets.Widget
 import eu.jonahbauer.android.preference.annotations.serializer.PreferenceSerializationException
 import eu.jonahbauer.android.preference.annotations.serializer.PreferenceSerializer
 import kotlinx.serialization.Serializable
@@ -28,6 +29,24 @@ class SetAbstractAppInfoPreferenceSerializer :
     }
 }
 
+
+@Suppress("UNCHECKED_CAST")
+class SetWidgetSerializer :
+    PreferenceSerializer<java.util.Set<Widget>?, java.util.Set<java.lang.String>?> {
+    @Throws(PreferenceSerializationException::class)
+    override fun serialize(value: java.util.Set<Widget>?): java.util.Set<java.lang.String>? {
+        return value?.map(Widget::serialize)
+            ?.toHashSet() as? java.util.Set<java.lang.String>
+    }
+
+    @Throws(PreferenceSerializationException::class)
+    override fun deserialize(value: java.util.Set<java.lang.String>?): java.util.Set<Widget>? {
+        return value?.map(java.lang.String::toString)?.map(Widget::deserialize)
+            ?.toHashSet() as? java.util.Set<Widget>
+    }
+}
+
+
 @Suppress("UNCHECKED_CAST")
 class SetPinnedShortcutInfoPreferenceSerializer :
     PreferenceSerializer<java.util.Set<PinnedShortcutInfo>?, java.util.Set<java.lang.String>?> {

app/src/main/java/de/jrpie/android/launcher/ui/HomeActivity.kt

@@ -1,6 +1,7 @@
 package de.jrpie.android.launcher.ui
 
 import android.annotation.SuppressLint
+import android.app.Activity
 import android.content.SharedPreferences
 import android.content.res.Configuration
 import android.content.res.Resources
@@ -10,8 +11,7 @@ import android.view.KeyEvent
 import android.view.MotionEvent
 import android.view.View
 import android.window.OnBackInvokedDispatcher
-import androidx.appcompat.app.AppCompatActivity
-import androidx.core.view.isVisible
+import de.jrpie.android.launcher.Application
 import de.jrpie.android.launcher.R
 import de.jrpie.android.launcher.actions.Action
 import de.jrpie.android.launcher.actions.Gesture
@@ -20,7 +20,6 @@ import de.jrpie.android.launcher.databinding.HomeBinding
 import de.jrpie.android.launcher.openTutorial
 import de.jrpie.android.launcher.preferences.LauncherPreferences
 import de.jrpie.android.launcher.ui.tutorial.TutorialActivity
-import java.util.Locale
 
 /**
  * [HomeActivity] is the actual application Launcher,
@@ -34,7 +33,7 @@ import java.util.Locale
  * - Setting global variables (preferences etc.)
  * - Opening the [TutorialActivity] on new installations
  */
-class HomeActivity : UIObject, AppCompatActivity() {
+class HomeActivity : UIObject, Activity() {
 
     private lateinit var binding: HomeBinding
     private var touchGestureDetector: TouchGestureDetector? = null
@@ -45,15 +44,18 @@ class HomeActivity : UIObject, AppCompatActivity() {
                 prefKey?.startsWith("display.") == true
             ) {
                 recreate()
-            }
-
-            if (prefKey?.startsWith("action.") == true) {
+            } else if (prefKey?.startsWith("action.") == true) {
                 updateSettingsFallbackButtonVisibility()
+            } else if (prefKey == LauncherPreferences.widgets().keys().widgets()) {
+                binding.homeWidgetContainer.updateWidgets(this@HomeActivity,
+                    LauncherPreferences.widgets().widgets()
+                )
             }
+
         }
 
     override fun onCreate(savedInstanceState: Bundle?) {
-        super<AppCompatActivity>.onCreate(savedInstanceState)
+        super<Activity>.onCreate(savedInstanceState)
         super<UIObject>.onCreate()
 
 
@@ -81,8 +83,7 @@ class HomeActivity : UIObject, AppCompatActivity() {
     }
 
     override fun onStart() {
-        super<AppCompatActivity>.onStart()
-
+        super<Activity>.onStart()
         super<UIObject>.onStart()
 
         // If the tutorial was not finished, start it
@@ -93,6 +94,15 @@ class HomeActivity : UIObject, AppCompatActivity() {
         LauncherPreferences.getSharedPreferences()
             .registerOnSharedPreferenceChangeListener(sharedPreferencesListener)
 
+        (application as Application).appWidgetHost.startListening()
+
+    }
+
+
+
+    override fun onStop() {
+        (application as Application).appWidgetHost.stopListening()
+        super.onStop()
     }
 
     override fun onWindowFocusChanged(hasFocus: Boolean) {
@@ -118,44 +128,6 @@ class HomeActivity : UIObject, AppCompatActivity() {
         }
     }
 
-    private fun initClock() {
-        val locale = Locale.getDefault()
-        val dateVisible = LauncherPreferences.clock().dateVisible()
-        val timeVisible = LauncherPreferences.clock().timeVisible()
-
-        var dateFMT = "yyyy-MM-dd"
-        var timeFMT = "HH:mm"
-        if (LauncherPreferences.clock().showSeconds()) {
-            timeFMT += ":ss"
-        }
-
-        if (LauncherPreferences.clock().localized()) {
-            dateFMT = android.text.format.DateFormat.getBestDateTimePattern(locale, dateFMT)
-            timeFMT = android.text.format.DateFormat.getBestDateTimePattern(locale, timeFMT)
-        }
-
-        var upperFormat = dateFMT
-        var lowerFormat = timeFMT
-        var upperVisible = dateVisible
-        var lowerVisible = timeVisible
-
-        if (LauncherPreferences.clock().flipDateTime()) {
-            upperFormat = lowerFormat.also { lowerFormat = upperFormat }
-            upperVisible = lowerVisible.also { lowerVisible = upperVisible }
-        }
-
-        binding.homeUpperView.isVisible = upperVisible
-        binding.homeLowerView.isVisible = lowerVisible
-
-        binding.homeUpperView.setTextColor(LauncherPreferences.clock().color())
-        binding.homeLowerView.setTextColor(LauncherPreferences.clock().color())
-
-        binding.homeLowerView.format24Hour = lowerFormat
-        binding.homeUpperView.format24Hour = upperFormat
-        binding.homeLowerView.format12Hour = lowerFormat
-        binding.homeUpperView.format12Hour = upperFormat
-    }
-
     override fun getTheme(): Resources.Theme {
         val mTheme = modifyTheme(super.getTheme())
         mTheme.applyStyle(R.style.backgroundWallpaper, true)
@@ -193,9 +165,11 @@ class HomeActivity : UIObject, AppCompatActivity() {
                 windowInsets
             }
         }
-
-        initClock()
         updateSettingsFallbackButtonVisibility()
+
+        binding.homeWidgetContainer.updateWidgets(this@HomeActivity,
+            LauncherPreferences.widgets().widgets()
+        )
     }
 
     override fun onDestroy() {
@@ -233,30 +207,11 @@ class HomeActivity : UIObject, AppCompatActivity() {
     }
 
     override fun onTouchEvent(event: MotionEvent): Boolean {
+        android.util.Log.e("Launcher", "on touch")
         touchGestureDetector?.onTouchEvent(event)
         return true
     }
 
-    override fun setOnClicks() {
-
-        binding.homeUpperView.setOnClickListener {
-            if (LauncherPreferences.clock().flipDateTime()) {
-                Gesture.TIME(this)
-            } else {
-                Gesture.DATE(this)
-            }
-        }
-
-        binding.homeLowerView.setOnClickListener {
-            if (LauncherPreferences.clock().flipDateTime()) {
-                Gesture.DATE(this)
-            } else {
-                Gesture.TIME(this)
-            }
-        }
-    }
-
-
     private fun handleBack() {
         Gesture.BACK(this)
     }

app/src/main/java/de/jrpie/android/launcher/ui/PinShortcutActivity.kt

@@ -49,7 +49,21 @@ class PinShortcutActivity : AppCompatActivity(), UIObject {
 
         val request = launcherApps.getPinItemRequest(intent)
         this.request = request
-        if (request == null || request.requestType != PinItemRequest.REQUEST_TYPE_SHORTCUT) {
+        if (request == null) {
+            finish()
+            return
+        }
+
+        if (request.requestType == PinItemRequest.REQUEST_TYPE_APPWIDGET) {
+
+            // TODO
+            request.getAppWidgetProviderInfo(this)
+            // startActivity()
+            finish()
+            return
+        }
+
+        if (request.requestType != PinItemRequest.REQUEST_TYPE_SHORTCUT) {
             finish()
             return
         }