Migrate to androidx.preference 1.1.0

build.gradle

@@ -9,7 +9,6 @@ buildscript {
         sdkVersion = 28
         compileSdkVersion = 28
         buildToolsVersion = '28.0.3'
-        preferencexVersion = '1.0.0'
         junitVersion = '4.12'
         androidTestVersion = '1.1.1'
         androidEspressoVersion = '3.1.1'

core/build.gradle

@@ -51,12 +51,11 @@ dependencies {
     api "android.arch.work:work-runtime-ktx:$workVersion"
     api "androidx.lifecycle:lifecycle-extensions:$lifecycleVersion"
     api "androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycleVersion"
-    api 'androidx.preference:preference:1.0.0'
+    api 'androidx.preference:preference:1.1.0-alpha04'
     api "androidx.room:room-runtime:$roomVersion"
     api 'com.crashlytics.sdk.android:crashlytics:2.9.9'
     api 'com.google.firebase:firebase-config:16.1.3'
     api 'com.google.firebase:firebase-core:16.0.7'
-    api "com.takisoft.preferencex:preferencex:$preferencexVersion"
     api 'dnsjava:dnsjava:2.1.8'
     api 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.1.1'
     api 'org.connectbot.jsocks:jsocks:1.0.0'

core/src/main/java/com/github/shadowsocks/preference/DataStore.kt

@@ -42,7 +42,7 @@ object DataStore : OnPreferenceDataStoreChangeListener {
         publicStore.registerChangeListener(this)
     }
 
-    override fun onPreferenceDataStoreChanged(store: PreferenceDataStore, key: String?) {
+    override fun onPreferenceDataStoreChanged(store: PreferenceDataStore, key: String) {
         when (key) {
             Key.id -> if (DataStore.directBootAware) DirectBoot.update()
         }

core/src/main/java/com/github/shadowsocks/preference/OnPreferenceDataStoreChangeListener.kt

@@ -23,5 +23,5 @@ package com.github.shadowsocks.preference
 import androidx.preference.PreferenceDataStore
 
 interface OnPreferenceDataStoreChangeListener {
-    fun onPreferenceDataStoreChanged(store: PreferenceDataStore, key: String?)
+    fun onPreferenceDataStoreChanged(store: PreferenceDataStore, key: String)
 }

core/src/main/java/com/github/shadowsocks/preference/PortPreferenceListener.kt

@@ -0,0 +1,36 @@
+/*******************************************************************************
+ *                                                                             *
+ *  Copyright (C) 2019 by Max Lv <max.c.lv@gmail.com>                          *
+ *  Copyright (C) 2019 by Mygod Studio <contact-shadowsocks-android@mygod.be>  *
+ *                                                                             *
+ *  This program is free software: you can redistribute it and/or modify       *
+ *  it under the terms of the GNU General Public License as published by       *
+ *  the Free Software Foundation, either version 3 of the License, or          *
+ *  (at your option) any later version.                                        *
+ *                                                                             *
+ *  This program is distributed in the hope that it will be useful,            *
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of             *
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
+ *  GNU General Public License for more details.                               *
+ *                                                                             *
+ *  You should have received a copy of the GNU General Public License          *
+ *  along with this program. If not, see <http://www.gnu.org/licenses/>.       *
+ *                                                                             *
+ *******************************************************************************/
+
+package com.github.shadowsocks.preference
+
+import android.text.InputFilter
+import android.view.inputmethod.EditorInfo
+import android.widget.EditText
+import androidx.preference.EditTextPreference
+
+object PortPreferenceListener : EditTextPreference.OnBindEditTextListener {
+    private val portLengthFilter = arrayOf(InputFilter.LengthFilter(5))
+
+    override fun onBindEditText(editText: EditText) {
+        editText.inputType = EditorInfo.TYPE_CLASS_NUMBER
+        editText.filters = portLengthFilter
+        editText.setSingleLine()
+    }
+}

gradle.properties

@@ -11,7 +11,7 @@
 # The setting is particularly useful for tweaking memory settings.
 android.enableJetifier=true
 android.enableR8=true
-# android.enableR8.fullMode=true
+android.enableR8.fullMode=true
 android.useAndroidX=true
 
 # When configured, Gradle will run in incubating parallel mode.

mobile/build.gradle

@@ -56,11 +56,11 @@ androidExtensions {
 
 dependencies {
     implementation project(':core')
-    implementation "androidx.browser:browser:1.0.0"
+    implementation 'androidx.browser:browser:1.0.0'
     implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
     implementation 'com.google.android.gms:play-services-vision:17.0.2'
     implementation 'com.google.firebase:firebase-ads:17.2.0'
-    implementation "com.takisoft.preferencex:preferencex-simplemenu:$preferencexVersion"
+    implementation 'com.takisoft.preferencex:preferencex-simplemenu:1.0.0'
     implementation 'com.twofortyfouram:android-plugin-api-for-locale:1.0.4'
     implementation 'net.glxn.qrgen:android:2.0'
     implementation 'xyz.belvi.mobilevision:barcodescanner:2.0.3'

mobile/src/main/java/com/github/shadowsocks/App.kt

@@ -23,17 +23,12 @@ package com.github.shadowsocks
 import android.app.Application
 import android.content.res.Configuration
 import androidx.appcompat.app.AppCompatDelegate
-import com.github.shadowsocks.preference.BottomSheetPreferenceDialogFragment
-import com.github.shadowsocks.preference.IconListPreference
-import com.takisoft.preferencex.PreferenceFragmentCompat
 
 class App : Application() {
     override fun onCreate() {
         super.onCreate()
         Core.init(this, MainActivity::class)
         AppCompatDelegate.setCompatVectorFromResourcesEnabled(true)
-        PreferenceFragmentCompat.registerPreferenceFragment(IconListPreference::class.java,
-                BottomSheetPreferenceDialogFragment::class.java)
     }
 
     override fun onConfigurationChanged(newConfig: Configuration) {

mobile/src/main/java/com/github/shadowsocks/GlobalSettingsPreferenceFragment.kt

@@ -22,36 +22,38 @@ package com.github.shadowsocks
 
 import android.os.Build
 import android.os.Bundle
+import androidx.preference.EditTextPreference
 import androidx.preference.Preference
+import androidx.preference.PreferenceFragmentCompat
 import androidx.preference.SwitchPreference
 import com.github.shadowsocks.bg.BaseService
 import com.github.shadowsocks.preference.DataStore
 import com.github.shadowsocks.utils.DirectBoot
 import com.github.shadowsocks.utils.Key
 import com.github.shadowsocks.net.TcpFastOpen
+import com.github.shadowsocks.preference.PortPreferenceListener
 import com.github.shadowsocks.utils.remove
-import com.takisoft.preferencex.PreferenceFragmentCompat
 
 class GlobalSettingsPreferenceFragment : PreferenceFragmentCompat() {
-    override fun onCreatePreferencesFix(savedInstanceState: Bundle?, rootKey: String?) {
+    override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
         preferenceManager.preferenceDataStore = DataStore.publicStore
         DataStore.initGlobal()
         addPreferencesFromResource(R.xml.pref_global)
-        val boot = findPreference(Key.isAutoConnect) as SwitchPreference
+        val boot = findPreference<SwitchPreference>(Key.isAutoConnect)!!
         boot.setOnPreferenceChangeListener { _, value ->
             BootReceiver.enabled = value as Boolean
             true
         }
         boot.isChecked = BootReceiver.enabled
         if (Build.VERSION.SDK_INT >= 24) boot.setSummary(R.string.auto_connect_summary_v24)
 
-        val canToggleLocked = findPreference(Key.directBootAware)
+        val canToggleLocked = findPreference<Preference>(Key.directBootAware)!!
         if (Build.VERSION.SDK_INT >= 24) canToggleLocked.setOnPreferenceChangeListener { _, newValue ->
             if (Core.directBootSupported && newValue as Boolean) DirectBoot.update() else DirectBoot.clean()
             true
         } else canToggleLocked.remove()
 
-        val tfo = findPreference(Key.tfo) as SwitchPreference
+        val tfo = findPreference<SwitchPreference>(Key.tfo)!!
         tfo.isChecked = DataStore.tcpFastOpen
         tfo.setOnPreferenceChangeListener { _, value ->
             if (value as Boolean && !TcpFastOpen.sendEnabled) {
@@ -68,10 +70,13 @@ class GlobalSettingsPreferenceFragment : PreferenceFragmentCompat() {
             tfo.summary = getString(R.string.tcp_fastopen_summary_unsupported, System.getProperty("os.version"))
         }
 
-        val serviceMode = findPreference(Key.serviceMode)
-        val portProxy = findPreference(Key.portProxy)
-        val portLocalDns = findPreference(Key.portLocalDns)
-        val portTransproxy = findPreference(Key.portTransproxy)
+        val serviceMode = findPreference<Preference>(Key.serviceMode)!!
+        val portProxy = findPreference<EditTextPreference>(Key.portProxy)!!
+        portProxy.onBindEditTextListener = PortPreferenceListener
+        val portLocalDns = findPreference<EditTextPreference>(Key.portLocalDns)!!
+        portLocalDns.onBindEditTextListener = PortPreferenceListener
+        val portTransproxy = findPreference<EditTextPreference>(Key.portTransproxy)!!
+        portTransproxy.onBindEditTextListener = PortPreferenceListener
         val onServiceModeChange = Preference.OnPreferenceChangeListener { _, newValue ->
             val (enabledLocalDns, enabledTransproxy) = when (newValue as String?) {
                 Key.modeProxy -> Pair(false, false)

mobile/src/main/java/com/github/shadowsocks/MainActivity.kt

@@ -209,7 +209,7 @@ class MainActivity : AppCompatActivity(), ShadowsocksConnection.Callback, OnPref
         else ImportProfilesDialogFragment().withArg(ProfilesArg(profiles)).show(supportFragmentManager, null)
     }
 
-    override fun onPreferenceDataStoreChanged(store: PreferenceDataStore, key: String?) {
+    override fun onPreferenceDataStoreChanged(store: PreferenceDataStore, key: String) {
         when (key) {
             Key.serviceMode -> handler.post {
                 connection.disconnect(this)

mobile/src/main/java/com/github/shadowsocks/ProfileConfigFragment.kt

@@ -28,30 +28,24 @@ import android.os.Bundle
 import android.os.Parcelable
 import android.view.MenuItem
 import androidx.appcompat.app.AlertDialog
-import androidx.core.os.bundleOf
-import androidx.preference.Preference
-import androidx.preference.PreferenceDataStore
-import androidx.preference.SwitchPreference
+import androidx.preference.*
 import com.github.shadowsocks.Core.app
 import com.github.shadowsocks.database.Profile
 import com.github.shadowsocks.database.ProfileManager
 import com.github.shadowsocks.plugin.*
-import com.github.shadowsocks.preference.DataStore
-import com.github.shadowsocks.preference.IconListPreference
-import com.github.shadowsocks.preference.OnPreferenceDataStoreChangeListener
-import com.github.shadowsocks.preference.PluginConfigurationDialogFragment
+import com.github.shadowsocks.preference.*
 import com.github.shadowsocks.utils.Action
 import com.github.shadowsocks.utils.DirectBoot
 import com.github.shadowsocks.utils.Key
 import com.github.shadowsocks.utils.readableMessage
 import com.google.android.material.snackbar.Snackbar
-import com.takisoft.preferencex.EditTextPreference
-import com.takisoft.preferencex.PreferenceFragmentCompat
 import kotlinx.android.parcel.Parcelize
 
 class ProfileConfigFragment : PreferenceFragmentCompat(),
         Preference.OnPreferenceChangeListener, OnPreferenceDataStoreChangeListener {
-    companion object {
+    companion object PasswordSummaryProvider : Preference.SummaryProvider<EditTextPreference> {
+        override fun provideSummary(preference: EditTextPreference?) = "\u2022".repeat(preference?.text?.length ?: 0)
+
         private const val REQUEST_CODE_PLUGIN_CONFIGURE = 1
         const val REQUEST_UNSAVED_CHANGES = 2
     }
@@ -77,23 +71,25 @@ class ProfileConfigFragment : PreferenceFragmentCompat(),
     private lateinit var receiver: BroadcastReceiver
     private lateinit var udpFallback: Preference
 
-    override fun onCreatePreferencesFix(savedInstanceState: Bundle?, rootKey: String?) {
+    override fun onCreatePreferences(savedInstanceState: Bundle?, rootKey: String?) {
         preferenceManager.preferenceDataStore = DataStore.privateStore
         val activity = requireActivity()
         profileId = activity.intent.getLongExtra(Action.EXTRA_PROFILE_ID, -1L)
         addPreferencesFromResource(R.xml.pref_profile)
+        findPreference<EditTextPreference>(Key.remotePort)!!.onBindEditTextListener = PortPreferenceListener
+        findPreference<EditTextPreference>(Key.password)!!.summaryProvider = PasswordSummaryProvider
         val serviceMode = DataStore.serviceMode
-        findPreference(Key.remoteDns).isEnabled = serviceMode != Key.modeProxy
-        isProxyApps = findPreference(Key.proxyApps) as SwitchPreference
+        findPreference<Preference>(Key.remoteDns)!!.isEnabled = serviceMode != Key.modeProxy
+        isProxyApps = findPreference(Key.proxyApps)!!
         isProxyApps.isEnabled = serviceMode == Key.modeVpn
         isProxyApps.setOnPreferenceClickListener {
             startActivity(Intent(activity, AppManager::class.java))
             isProxyApps.isChecked = true
             false
         }
-        findPreference(Key.udpdns).isEnabled = serviceMode != Key.modeProxy
-        plugin = findPreference(Key.plugin) as IconListPreference
-        pluginConfigure = findPreference(Key.pluginConfigure) as EditTextPreference
+        findPreference<Preference>(Key.udpdns)!!.isEnabled = serviceMode != Key.modeProxy
+        plugin = findPreference(Key.plugin)!!
+        pluginConfigure = findPreference(Key.pluginConfigure)!!
         plugin.unknownValueSummary = getString(R.string.plugin_unknown)
         plugin.setOnPreferenceChangeListener { _, newValue ->
             pluginConfiguration = PluginConfiguration(pluginConfiguration.pluginsOptions, newValue as String)
@@ -109,7 +105,7 @@ class ProfileConfigFragment : PreferenceFragmentCompat(),
         pluginConfigure.onPreferenceChangeListener = this
         initPlugins()
         receiver = Core.listenForPackageChanges(false) { initPlugins() }
-        udpFallback = findPreference(Key.udpFallback)
+        udpFallback = findPreference(Key.udpFallback)!!
         DataStore.privateStore.registerChangeListener(this)
     }
 
@@ -122,14 +118,16 @@ class ProfileConfigFragment : PreferenceFragmentCompat(),
         pluginConfiguration = PluginConfiguration(DataStore.plugin)
         plugin.value = pluginConfiguration.selected
         plugin.init()
-        plugin.checkSummary()
         pluginConfigure.isEnabled = pluginConfiguration.selected.isNotEmpty()
         pluginConfigure.text = pluginConfiguration.selectedOptions.toString()
     }
 
-    private fun showPluginEditor() = displayPreferenceDialog(PluginConfigurationDialogFragment(), Key.pluginConfigure,
-            bundleOf(Pair("key", Key.pluginConfigure),
-                    Pair(PluginConfigurationDialogFragment.PLUGIN_ID_FRAGMENT_TAG, pluginConfiguration.selected)))
+    private fun showPluginEditor() {
+        PluginConfigurationDialogFragment().apply {
+            setArg(Key.pluginConfigure, pluginConfiguration.selected)
+            setTargetFragment(this@ProfileConfigFragment, 0)
+        }.show(fragmentManager ?: return, Key.pluginConfigure)
+    }
 
     private fun saveAndExit() {
         val profile = ProfileManager.getProfile(profileId) ?: Profile()
@@ -161,18 +159,26 @@ class ProfileConfigFragment : PreferenceFragmentCompat(),
         false
     }
 
-    override fun onPreferenceDataStoreChanged(store: PreferenceDataStore, key: String?) {
-        if (key != Key.proxyApps && findPreference(key) != null) DataStore.dirty = true
+    override fun onPreferenceDataStoreChanged(store: PreferenceDataStore, key: String) {
+        if (key != Key.proxyApps && findPreference<Preference>(key) != null) DataStore.dirty = true
     }
 
     override fun onDisplayPreferenceDialog(preference: Preference) {
-        if (preference.key == Key.pluginConfigure) {
-            val intent = PluginManager.buildIntent(pluginConfiguration.selected, PluginContract.ACTION_CONFIGURE)
-            if (intent.resolveActivity(requireContext().packageManager) == null) showPluginEditor() else
-                startActivityForResult(intent
-                        .putExtra(PluginContract.EXTRA_OPTIONS, pluginConfiguration.selectedOptions.toString()),
-                        REQUEST_CODE_PLUGIN_CONFIGURE)
-        } else super.onDisplayPreferenceDialog(preference)
+        when (preference.key) {
+            Key.plugin -> BottomSheetPreferenceDialogFragment().apply {
+                setArg(Key.plugin)
+                setTargetFragment(this@ProfileConfigFragment, 0)
+            }.show(fragmentManager ?: return, Key.plugin)
+            Key.pluginConfigure -> {
+                val intent = PluginManager.buildIntent(pluginConfiguration.selected, PluginContract.ACTION_CONFIGURE)
+                if (intent.resolveActivity(requireContext().packageManager) == null) showPluginEditor() else {
+                    startActivityForResult(intent
+                            .putExtra(PluginContract.EXTRA_OPTIONS, pluginConfiguration.selectedOptions.toString()),
+                            REQUEST_CODE_PLUGIN_CONFIGURE)
+                }
+            }
+            else -> super.onDisplayPreferenceDialog(preference)
+        }
     }
 
     override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {

mobile/src/main/java/com/github/shadowsocks/preference/BottomSheetPreferenceDialogFragment.kt

@@ -32,6 +32,7 @@ import android.view.View
 import android.view.ViewGroup
 import android.widget.ImageView
 import android.widget.TextView
+import androidx.core.os.bundleOf
 import androidx.core.view.isVisible
 import androidx.preference.PreferenceDialogFragmentCompat
 import androidx.recyclerview.widget.DefaultItemAnimator
@@ -97,6 +98,10 @@ class BottomSheetPreferenceDialogFragment : PreferenceDialogFragmentCompat() {
         }
     }
 
+    fun setArg(key: String) {
+        arguments = bundleOf(PreferenceDialogFragmentCompat.ARG_KEY to key)
+    }
+
     private val preference by lazy { getPreference() as IconListPreference }
     private var clickedIndex = -1
 

mobile/src/main/java/com/github/shadowsocks/preference/IconListPreference.kt

@@ -26,6 +26,14 @@ import android.util.AttributeSet
 import androidx.preference.ListPreference
 
 class IconListPreference(context: Context, attrs: AttributeSet? = null) : ListPreference(context, attrs) {
+    companion object FallbackProvider : SummaryProvider<IconListPreference> {
+        override fun provideSummary(preference: IconListPreference?): CharSequence? {
+            val i = preference?.selectedEntry
+            return if (i != null && i < 0) preference.unknownValueSummary?.format(preference.value) else
+                preference?.entry
+        }
+    }
+
     var entryIcons: Array<Drawable?>? = null
     val selectedEntry: Int get() = entryValues.indexOf(value)
     val entryIcon: Drawable? get() = entryIcons?.getOrNull(selectedEntry)
@@ -49,7 +57,6 @@ class IconListPreference(context: Context, attrs: AttributeSet? = null) : ListPr
             val listener = listener
             if (listener == null || listener.onPreferenceChange(preference, newValue)) {
                 value = newValue.toString()
-                checkSummary()
                 if (entryIcons != null) icon = entryIcon
                 true
             } else false
@@ -60,13 +67,9 @@ class IconListPreference(context: Context, attrs: AttributeSet? = null) : ListPr
 //        a.recycle()
     }
 
-    fun checkSummary() {
-        val unknownValueSummary = unknownValueSummary
-        if (unknownValueSummary != null) summary = if (selectedEntry < 0) unknownValueSummary.format(value) else "%s"
-    }
-
     fun init() {
         icon = entryIcon
+        summaryProvider = FallbackProvider
     }
     override fun onSetInitialValue(defaultValue: Any?) {
         super.onSetInitialValue(defaultValue)