Reorganize classes

- Move base classes to its own package - Move most logic out of MagiskActivity to MainActivity
2025-09-06 06:36:58 +00:00 · 2019-09-28 03:37:24 -04:00
parent fc886a5a47
commit 08b528dc4f
41 changed files with 365 additions and 413 deletions
@@ -0,0 +1,56 @@
+package com.topjohnwu.magisk.base
+
+import android.annotation.SuppressLint
+import android.content.SharedPreferences
+import android.os.Bundle
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import androidx.preference.*
+import androidx.recyclerview.widget.RecyclerView
+import org.koin.android.ext.android.inject
+
+abstract class BasePreferenceFragment : PreferenceFragmentCompat(),
+    SharedPreferences.OnSharedPreferenceChangeListener {
+
+    protected val prefs: SharedPreferences by inject()
+    protected val activity get() = requireActivity() as MagiskActivity<*, *>
+
+    override fun onCreateView(
+        inflater: LayoutInflater,
+        container: ViewGroup?,
+        savedInstanceState: Bundle?
+    ): View? {
+        val v = super.onCreateView(inflater, container, savedInstanceState)
+        prefs.registerOnSharedPreferenceChangeListener(this)
+        return v
+    }
+
+    override fun onDestroyView() {
+        prefs.unregisterOnSharedPreferenceChangeListener(this)
+        super.onDestroyView()
+    }
+
+    private fun setAllPreferencesToAvoidHavingExtraSpace(preference: Preference) {
+        preference.isIconSpaceReserved = false
+        if (preference is PreferenceGroup)
+            for (i in 0 until preference.preferenceCount)
+                setAllPreferencesToAvoidHavingExtraSpace(preference.getPreference(i))
+    }
+
+    override fun setPreferenceScreen(preferenceScreen: PreferenceScreen?) {
+        if (preferenceScreen != null)
+            setAllPreferencesToAvoidHavingExtraSpace(preferenceScreen)
+        super.setPreferenceScreen(preferenceScreen)
+    }
+
+    override fun onCreateAdapter(preferenceScreen: PreferenceScreen?): RecyclerView.Adapter<*> =
+            object : PreferenceGroupAdapter(preferenceScreen) {
+                @SuppressLint("RestrictedApi")
+                override fun onPreferenceHierarchyChange(preference: Preference?) {
+                    if (preference != null)
+                        setAllPreferencesToAvoidHavingExtraSpace(preference)
+                    super.onPreferenceHierarchyChange(preference)
+                }
+            }
+}
@@ -0,0 +1,59 @@
+package com.topjohnwu.magisk.base
+
+import android.content.Context
+import android.net.Network
+import android.net.Uri
+import androidx.annotation.MainThread
+import androidx.annotation.RequiresApi
+import androidx.work.Data
+import androidx.work.ListenableWorker
+import com.google.common.util.concurrent.ListenableFuture
+import java.util.*
+
+abstract class DelegateWorker {
+
+    private lateinit var worker: ListenableWorker
+
+    val applicationContext: Context
+        get() = worker.applicationContext
+
+    val id: UUID
+        get() = worker.id
+
+    val inputData: Data
+        get() = worker.inputData
+
+    val tags: Set<String>
+        get() = worker.tags
+
+    val triggeredContentUris: List<Uri>
+        @RequiresApi(24)
+        get() = worker.triggeredContentUris
+
+    val triggeredContentAuthorities: List<String>
+        @RequiresApi(24)
+        get() = worker.triggeredContentAuthorities
+
+    val network: Network?
+        @RequiresApi(28)
+        get() = worker.network
+
+    val runAttemptCount: Int
+        get() = worker.runAttemptCount
+
+    val isStopped: Boolean
+        get() = worker.isStopped
+
+    abstract fun doWork(): ListenableWorker.Result
+
+    fun onStopped() {}
+
+    fun attachWorker(w: ListenableWorker) {
+        worker = w
+    }
+
+    @MainThread
+    fun startWork(): ListenableFuture<ListenableWorker.Result> {
+        return worker.startWork()
+    }
+}
@@ -0,0 +1,112 @@
+package com.topjohnwu.magisk.base
+
+import android.Manifest
+import android.content.Context
+import android.content.Intent
+import android.content.res.Configuration
+import android.os.Bundle
+import androidx.appcompat.app.AppCompatActivity
+import androidx.appcompat.app.AppCompatDelegate
+import androidx.collection.SparseArrayCompat
+import androidx.core.net.toUri
+import androidx.databinding.DataBindingUtil
+import androidx.databinding.ViewDataBinding
+import com.karumi.dexter.Dexter
+import com.karumi.dexter.MultiplePermissionsReport
+import com.karumi.dexter.PermissionToken
+import com.karumi.dexter.listener.PermissionRequest
+import com.karumi.dexter.listener.multi.MultiplePermissionsListener
+import com.topjohnwu.magisk.BR
+import com.topjohnwu.magisk.Config
+import com.topjohnwu.magisk.base.viewmodel.MagiskViewModel
+import com.topjohnwu.magisk.extensions.set
+import com.topjohnwu.magisk.model.events.EventHandler
+import com.topjohnwu.magisk.model.permissions.PermissionRequestBuilder
+import com.topjohnwu.magisk.utils.LocaleManager
+import com.topjohnwu.magisk.utils.Utils
+import com.topjohnwu.magisk.utils.currentLocale
+
+typealias RequestCallback = MagiskActivity<*, *>.(Int, Intent?) -> Unit
+
+abstract class MagiskActivity<ViewModel : MagiskViewModel, Binding : ViewDataBinding> :
+        AppCompatActivity(), EventHandler {
+
+    protected lateinit var binding: Binding
+    protected abstract val layoutRes: Int
+    protected abstract val viewModel: ViewModel
+    protected open val snackbarView get() = binding.root
+    protected open val navHostId: Int = 0
+    protected open val defaultPosition: Int = 0
+
+    private val resultCallbacks = SparseArrayCompat<RequestCallback>()
+
+    init {
+        val theme = if (Config.darkTheme) {
+            AppCompatDelegate.MODE_NIGHT_YES
+        } else {
+            AppCompatDelegate.MODE_NIGHT_NO
+        }
+        AppCompatDelegate.setDefaultNightMode(theme)
+    }
+
+    override fun applyOverrideConfiguration(config: Configuration?) {
+        // Force applying our preferred local
+        config?.setLocale(currentLocale)
+        super.applyOverrideConfiguration(config)
+    }
+
+    override fun attachBaseContext(base: Context) {
+        super.attachBaseContext(LocaleManager.getLocaleContext(base))
+    }
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+
+        viewModel.viewEvents.observe(this, viewEventObserver)
+
+        binding = DataBindingUtil.setContentView<Binding>(this, layoutRes).apply {
+            setVariable(BR.viewModel, viewModel)
+            lifecycleOwner = this@MagiskActivity
+        }
+    }
+
+    fun openUrl(url: String) = Utils.openLink(this, url.toUri())
+
+    fun withPermissions(vararg permissions: String, builder: PermissionRequestBuilder.() -> Unit) {
+        val request = PermissionRequestBuilder().apply(builder).build()
+        Dexter.withActivity(this)
+            .withPermissions(*permissions)
+            .withListener(object : MultiplePermissionsListener {
+                override fun onPermissionsChecked(report: MultiplePermissionsReport) {
+                    if (report.areAllPermissionsGranted()) {
+                        request.onSuccess()
+                    } else {
+                        request.onFailure()
+                    }
+                }
+
+                override fun onPermissionRationaleShouldBeShown(
+                    permissions: MutableList<PermissionRequest>,
+                    token: PermissionToken
+                ) = token.continuePermissionRequest()
+            }).check()
+    }
+
+    fun withExternalRW(builder: PermissionRequestBuilder.() -> Unit) {
+        withPermissions(Manifest.permission.WRITE_EXTERNAL_STORAGE, builder = builder)
+    }
+
+    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
+        super.onActivityResult(requestCode, resultCode, data)
+        resultCallbacks[requestCode]?.apply {
+            resultCallbacks.remove(requestCode)
+            invoke(this@MagiskActivity, resultCode, data)
+        }
+    }
+
+    fun startActivityForResult(intent: Intent, requestCode: Int, listener: RequestCallback) {
+        resultCallbacks[requestCode] = listener
+        startActivityForResult(intent, requestCode)
+    }
+
+}
@@ -0,0 +1,51 @@
+package com.topjohnwu.magisk.base
+
+import android.os.Bundle
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import androidx.annotation.CallSuper
+import androidx.databinding.DataBindingUtil
+import androidx.databinding.ViewDataBinding
+import androidx.fragment.app.Fragment
+import com.topjohnwu.magisk.BR
+import com.topjohnwu.magisk.base.viewmodel.MagiskViewModel
+import com.topjohnwu.magisk.model.events.EventHandler
+import com.topjohnwu.magisk.model.events.ViewEvent
+import com.topjohnwu.magisk.ui.MainActivity
+
+abstract class MagiskFragment<ViewModel : MagiskViewModel, Binding : ViewDataBinding> :
+    Fragment(), EventHandler {
+
+    protected val activity get() = requireActivity() as MainActivity
+    protected lateinit var binding: Binding
+    protected abstract val layoutRes: Int
+    protected abstract val viewModel: ViewModel
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        viewModel.viewEvents.observe(this, viewEventObserver)
+    }
+
+    override fun onCreateView(
+            inflater: LayoutInflater,
+            container: ViewGroup?,
+            savedInstanceState: Bundle?
+    ): View? {
+        binding = DataBindingUtil.inflate<Binding>(inflater, layoutRes, container, false).apply {
+            setVariable(BR.viewModel, viewModel)
+            lifecycleOwner = this@MagiskFragment
+        }
+
+        return binding.root
+    }
+
+    @CallSuper
+    override fun onEventDispatched(event: ViewEvent) {
+        super.onEventDispatched(event)
+        activity.onEventDispatched(event)
+    }
+
+    open fun onBackPressed(): Boolean = false
+
+}
@@ -0,0 +1,78 @@
+package com.topjohnwu.magisk.base.viewmodel
+
+import androidx.databinding.Bindable
+import com.topjohnwu.magisk.BR
+import io.reactivex.*
+
+abstract class LoadingViewModel(defaultState: State = State.LOADING) :
+    StatefulViewModel<LoadingViewModel.State>(defaultState) {
+
+    val loading @Bindable get() = state == State.LOADING
+    val loaded @Bindable get() = state == State.LOADED
+    val loadingFailed @Bindable get() = state == State.LOADING_FAILED
+
+    @Deprecated(
+        "Direct access is recommended since 0.2. This access method will be removed in 1.0",
+        ReplaceWith("state = State.LOADING", "com.topjohnwu.magisk.base.viewmodel.LoadingViewModel.State"),
+        DeprecationLevel.WARNING
+    )
+    fun setLoading() {
+        state = State.LOADING
+    }
+
+    @Deprecated(
+        "Direct access is recommended since 0.2. This access method will be removed in 1.0",
+        ReplaceWith("state = State.LOADED", "com.topjohnwu.magisk.base.viewmodel.LoadingViewModel.State"),
+        DeprecationLevel.WARNING
+    )
+    fun setLoaded() {
+        state = State.LOADED
+    }
+
+    @Deprecated(
+        "Direct access is recommended since 0.2. This access method will be removed in 1.0",
+        ReplaceWith("state = State.LOADING_FAILED", "com.topjohnwu.magisk.base.viewmodel.LoadingViewModel.State"),
+        DeprecationLevel.WARNING
+    )
+    fun setLoadingFailed() {
+        state = State.LOADING_FAILED
+    }
+
+    override fun notifyStateChanged() {
+        notifyPropertyChanged(BR.loading)
+        notifyPropertyChanged(BR.loaded)
+        notifyPropertyChanged(BR.loadingFailed)
+    }
+
+    enum class State {
+        LOADED, LOADING, LOADING_FAILED
+    }
+
+    //region Rx
+    protected fun <T> Observable<T>.applyViewModel(viewModel: LoadingViewModel, allowFinishing: Boolean = true) =
+        doOnSubscribe { viewModel.state = State.LOADING }
+            .doOnError { viewModel.state = State.LOADING_FAILED }
+            .doOnNext { if (allowFinishing) viewModel.state = State.LOADED }
+
+    protected fun <T> Single<T>.applyViewModel(viewModel: LoadingViewModel, allowFinishing: Boolean = true) =
+        doOnSubscribe { viewModel.state = State.LOADING }
+            .doOnError { viewModel.state = State.LOADING_FAILED }
+            .doOnSuccess { if (allowFinishing) viewModel.state = State.LOADED }
+
+    protected fun <T> Maybe<T>.applyViewModel(viewModel: LoadingViewModel, allowFinishing: Boolean = true) =
+        doOnSubscribe { viewModel.state = State.LOADING }
+            .doOnError { viewModel.state = State.LOADING_FAILED }
+            .doOnComplete { if (allowFinishing) viewModel.state = State.LOADED }
+            .doOnSuccess { if (allowFinishing) viewModel.state = State.LOADED }
+
+    protected fun <T> Flowable<T>.applyViewModel(viewModel: LoadingViewModel, allowFinishing: Boolean = true) =
+        doOnSubscribe { viewModel.state = State.LOADING }
+            .doOnError { viewModel.state = State.LOADING_FAILED }
+            .doOnNext { if (allowFinishing) viewModel.state = State.LOADED }
+
+    protected fun Completable.applyViewModel(viewModel: LoadingViewModel, allowFinishing: Boolean = true) =
+        doOnSubscribe { viewModel.state = State.LOADING }
+            .doOnError { viewModel.state = State.LOADING_FAILED }
+            .doOnComplete { if (allowFinishing) viewModel.state = State.LOADED }
+    //endregion
+}
@@ -0,0 +1,39 @@
+package com.topjohnwu.magisk.base.viewmodel
+
+import android.app.Activity
+import com.github.pwittchen.reactivenetwork.library.rx2.ReactiveNetwork
+import com.topjohnwu.magisk.extensions.doOnSubscribeUi
+import com.topjohnwu.magisk.extensions.get
+import com.topjohnwu.magisk.extensions.subscribeK
+import com.topjohnwu.magisk.model.events.BackPressEvent
+import com.topjohnwu.magisk.model.events.PermissionEvent
+import com.topjohnwu.magisk.model.events.ViewActionEvent
+import com.topjohnwu.magisk.utils.KObservableField
+import io.reactivex.Observable
+import io.reactivex.subjects.PublishSubject
+
+
+abstract class MagiskViewModel(
+    initialState: State = State.LOADING
+) : LoadingViewModel(initialState) {
+
+    val isConnected = KObservableField(true)
+
+    init {
+        ReactiveNetwork.observeNetworkConnectivity(get())
+            .subscribeK { isConnected.value = it.available() }
+            .add()
+    }
+
+    fun withView(action: Activity.() -> Unit) {
+        ViewActionEvent(action).publish()
+    }
+
+    fun withPermissions(vararg permissions: String): Observable<Boolean> {
+        val subject = PublishSubject.create<Boolean>()
+        return subject.doOnSubscribeUi { PermissionEvent(permissions.toList(), subject).publish() }
+    }
+
+    fun back() = BackPressEvent().publish()
+
+}
@@ -0,0 +1,46 @@
+package com.topjohnwu.magisk.base.viewmodel
+
+import androidx.databinding.Observable
+import androidx.databinding.PropertyChangeRegistry
+import androidx.lifecycle.ViewModel
+
+/**
+ * Copy of [android.databinding.BaseObservable] which extends [ViewModel]
+ */
+abstract class ObservableViewModel : TeanityViewModel(), Observable {
+
+    @Transient
+    private var callbacks: PropertyChangeRegistry? = null
+
+    @Synchronized
+    override fun addOnPropertyChangedCallback(callback: Observable.OnPropertyChangedCallback) {
+        if (callbacks == null) {
+            callbacks = PropertyChangeRegistry()
+        }
+        callbacks?.add(callback)
+    }
+
+    @Synchronized
+    override fun removeOnPropertyChangedCallback(callback: Observable.OnPropertyChangedCallback) {
+        callbacks?.remove(callback)
+    }
+
+    /**
+     * Notifies listeners that all properties of this instance have changed.
+     */
+    @Synchronized
+    fun notifyChange() {
+        callbacks?.notifyCallbacks(this, 0, null)
+    }
+
+    /**
+     * Notifies listeners that a specific property has changed. The getter for the property
+     * that changes should be marked with [android.databinding.Bindable] to generate a field in
+     * `BR` to be used as `fieldId`.
+     *
+     * @param fieldId The generated BR id for the Bindable field.
+     */
+    fun notifyPropertyChanged(fieldId: Int) {
+        callbacks?.notifyCallbacks(this, fieldId, null)
+    }
+}
@@ -0,0 +1,15 @@
+package com.topjohnwu.magisk.base.viewmodel
+
+abstract class StatefulViewModel<State : Enum<*>>(
+    val defaultState: State
+) : ObservableViewModel() {
+
+    var state: State = defaultState
+        set(value) {
+            field = value
+            notifyStateChanged()
+        }
+
+    open fun notifyStateChanged() = Unit
+
+}
@@ -0,0 +1,33 @@
+package com.topjohnwu.magisk.base.viewmodel
+
+import androidx.lifecycle.LiveData
+import androidx.lifecycle.MutableLiveData
+import androidx.lifecycle.ViewModel
+import com.topjohnwu.magisk.model.events.SimpleViewEvent
+import com.topjohnwu.magisk.model.events.ViewEvent
+import io.reactivex.disposables.CompositeDisposable
+import io.reactivex.disposables.Disposable
+
+abstract class TeanityViewModel : ViewModel() {
+
+    private val disposables = CompositeDisposable()
+    private val _viewEvents = MutableLiveData<ViewEvent>()
+    val viewEvents: LiveData<ViewEvent> get() = _viewEvents
+
+    override fun onCleared() {
+        super.onCleared()
+        disposables.clear()
+    }
+
+    fun <Event : ViewEvent> Event.publish() {
+        _viewEvents.value = this
+    }
+
+    fun Int.publish() {
+        _viewEvents.value = SimpleViewEvent(this)
+    }
+
+    fun Disposable.add() {
+        disposables.add(this)
+    }
+}