Removed the Hotspot feature from custom apps, and used the normal service instead of foreground service for readAloud feature.

app/detekt_baseline.xml

@@ -45,6 +45,11 @@
     <ID>PackageNaming:SimplePageChangeListener.kt$package org.kiwix.kiwixmobile.zimManager</ID>
     <ID>PackageNaming:StartMultiSelection.kt$package
       org.kiwix.kiwixmobile.zimManager.fileselectView.effects</ID>
+    <ID>PackageNaming:HotspotNotificationManager.kt$package org.kiwix.kiwixmobile.webserver.wifi_hotspot</ID>
+    <ID>PackageNaming:HotspotStateReceiver.kt$package org.kiwix.kiwixmobile.webserver.wifi_hotspot</ID>
+    <ID>PackageNaming:IpAddressCallbacks.kt$package org.kiwix.kiwixmobile.webserver.wifi_hotspot</ID>
+    <ID>PackageNaming:HotspotService.kt$package org.kiwix.kiwixmobile.webserver.wifi_hotspot</ID>
+    <ID>PackageNaming:ServerStatus.kt$package org.kiwix.kiwixmobile.webserver.wifi_hotspot</ID>
     <ID>PackageNaming:ZimManageViewModel.kt$package org.kiwix.kiwixmobile.zimManager</ID>
     <ID>ReturnCount:Fat32Checker.kt$Fat32Checker$private fun canCreate4GbFile(storage: String): Boolean</ID>
     <ID>TooGenericExceptionCaught:FileWritingFileSystemChecker.kt$FileWritingFileSystemChecker$e: Exception</ID>

app/src/androidTest/java/org/kiwix/kiwixmobile/webserver/ZimHostRobot.kt

@@ -35,6 +35,7 @@ import org.kiwix.kiwixmobile.Findable.StringId.TextId
 import org.kiwix.kiwixmobile.Findable.Text
 import org.kiwix.kiwixmobile.Findable.ViewId
 import org.kiwix.kiwixmobile.core.R
+import org.kiwix.kiwixmobile.R.id
 import org.kiwix.kiwixmobile.core.utils.files.Log
 import org.kiwix.kiwixmobile.testutils.TestUtils
 import org.kiwix.kiwixmobile.testutils.TestUtils.testFlakyView
@@ -74,7 +75,7 @@ class ZimHostRobot : BaseRobot() {
   fun startServer() {
     // stop the server if it is already running.
     stopServerIfAlreadyStarted()
-    clickOn(ViewId(R.id.startServerButton))
+    clickOn(ViewId(id.startServerButton))
     assetWifiDialogDisplayed()
     testFlakyView({ onView(withText("PROCEED")).perform(click()) })
   }
@@ -115,7 +116,7 @@ class ZimHostRobot : BaseRobot() {
     } catch (assertionFailedError: AssertionFailedError) {
       try {
         val recyclerViewItemsCount =
-          RecyclerViewItemCount(R.id.recyclerViewZimHost).checkRecyclerViewCount()
+          RecyclerViewItemCount(id.recyclerViewZimHost).checkRecyclerViewCount()
         (0 until recyclerViewItemsCount)
           .asSequence()
           .filter { it != 0 }
@@ -129,14 +130,14 @@ class ZimHostRobot : BaseRobot() {
   private fun selectZimFile(position: Int) {
     try {
       onView(
-        RecyclerViewMatcher(R.id.recyclerViewZimHost).atPositionOnView(
+        RecyclerViewMatcher(id.recyclerViewZimHost).atPositionOnView(
           position,
           R.id.itemBookCheckbox
         )
       ).check(matches(ViewMatchers.isChecked()))
     } catch (assertionError: AssertionFailedError) {
       onView(
-        RecyclerViewMatcher(R.id.recyclerViewZimHost).atPositionOnView(
+        RecyclerViewMatcher(id.recyclerViewZimHost).atPositionOnView(
           position,
           R.id.itemBookCheckbox
         )
@@ -147,14 +148,14 @@ class ZimHostRobot : BaseRobot() {
   fun assertItemHostedOnServer(itemCount: Int) {
     val checkedCheckboxCount =
       RecyclerViewSelectedCheckBoxCountAssertion(
-        R.id.recyclerViewZimHost,
+        id.recyclerViewZimHost,
         R.id.itemBookCheckbox
       ).countCheckedCheckboxes()
     assertThat(checkedCheckboxCount, CoreMatchers.`is`(itemCount))
   }
 
   fun stopServer() {
-    testFlakyView({ onView(withId(R.id.startServerButton)).perform(click()) })
+    testFlakyView({ onView(withId(id.startServerButton)).perform(click()) })
   }
 
   fun assertServerStopped() {
@@ -163,11 +164,11 @@ class ZimHostRobot : BaseRobot() {
   }
 
   fun assertQrShown() {
-    isVisible(ViewId(R.id.serverQrCode))
+    isVisible(ViewId(id.serverQrCode))
   }
 
   fun assertQrNotShown() {
-    isNotVisible(ViewId(R.id.serverQrCode))
+    isNotVisible(ViewId(id.serverQrCode))
   }
 
   private fun pauseForBetterTestPerformance() {

app/src/main/AndroidManifest.xml

@@ -8,6 +8,13 @@
     tools:ignore="CoarseFineLocation" />
   <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
   <uses-permission android:name="${permission}" />
+  <!-- Device with versions >= Pie need this permission -->
+  <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
+  <uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />
+  <uses-permission
+    android:name="android.permission.NEARBY_WIFI_DEVICES"
+    android:usesPermissionFlags="neverForLocation"
+    tools:targetApi="s" />
 
   <application
     android:name=".KiwixApp"
@@ -136,5 +143,8 @@
         <action android:name="KiwixSearchWidget.STAR_CLICKED" />
       </intent-filter>
     </receiver>
+    <service
+      android:name=".webserver.wifi_hotspot.HotspotService"
+      android:foregroundServiceType="dataSync" />
   </application>
 </manifest>

app/src/main/java/org/kiwix/kiwixmobile/di/components/KiwixActivityComponent.kt

@@ -22,7 +22,8 @@ import dagger.BindsInstance
 import dagger.Subcomponent
 import org.kiwix.kiwixmobile.core.di.ActivityScope
 import org.kiwix.kiwixmobile.core.di.components.CoreActivityComponent
-import org.kiwix.kiwixmobile.core.webserver.ZimHostModule
+import org.kiwix.kiwixmobile.webserver.ZimHostModule
+import org.kiwix.kiwixmobile.webserver.ZimHostFragment
 import org.kiwix.kiwixmobile.di.modules.KiwixActivityModule
 import org.kiwix.kiwixmobile.intro.IntroFragment
 import org.kiwix.kiwixmobile.intro.IntroModule
@@ -49,6 +50,7 @@ interface KiwixActivityComponent : CoreActivityComponent {
   fun inject(deleteFiles: DeleteFiles)
   fun inject(localFileTransferFragment: LocalFileTransferFragment)
   fun inject(languageFragment: LanguageFragment)
+  fun inject(zimHostFragment: ZimHostFragment)
   fun inject(kiwixSettingsFragment: KiwixSettingsFragment)
   fun inject(introActivity: IntroFragment)
   fun inject(kiwixMainActivity: KiwixMainActivity)

app/src/main/java/org/kiwix/kiwixmobile/di/components/KiwixComponent.kt

@@ -21,6 +21,7 @@ package org.kiwix.kiwixmobile.di.components
 import dagger.Component
 import org.kiwix.kiwixmobile.core.di.components.CoreComponent
 import org.kiwix.kiwixmobile.di.KiwixScope
+import org.kiwix.kiwixmobile.di.components.ServiceComponent.Builder
 import org.kiwix.kiwixmobile.di.modules.KiwixModule
 import org.kiwix.kiwixmobile.di.modules.KiwixViewModelModule
 
@@ -31,4 +32,5 @@ import org.kiwix.kiwixmobile.di.modules.KiwixViewModelModule
 )
 interface KiwixComponent {
   fun activityComponentBuilder(): KiwixActivityComponent.Builder
+  fun serviceComponent(): Builder
 }

app/src/main/java/org/kiwix/kiwixmobile/di/components/ServiceComponent.kt

@@ -0,0 +1,38 @@
+/*
+* Kiwix Android
+* Copyright (c) 2019 Kiwix <android.kiwix.org>
+* 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 org.kiwix.kiwixmobile.di.components
+
+import android.app.Service
+import dagger.BindsInstance
+import dagger.Subcomponent
+import org.kiwix.kiwixmobile.di.ServiceScope
+import org.kiwix.kiwixmobile.di.modules.ServiceModule
+import org.kiwix.kiwixmobile.webserver.wifi_hotspot.HotspotService
+
+@Subcomponent(modules = [ServiceModule::class])
+@ServiceScope
+interface ServiceComponent {
+  fun inject(hotspotService: HotspotService)
+
+  @Subcomponent.Builder
+  interface Builder {
+    @BindsInstance fun service(service: Service): Builder
+    fun build(): ServiceComponent
+  }
+}

app/src/main/java/org/kiwix/kiwixmobile/di/modules/KiwixActivityModule.kt

@@ -20,7 +20,6 @@
 
 import dagger.Module
 import org.kiwix.kiwixmobile.core.di.modules.ActivityModule
-import org.kiwix.kiwixmobile.core.webserver.ZimHostModule
 
-@Module(includes = [ActivityModule::class, ZimHostModule::class])
+@Module(includes = [ActivityModule::class])
 class KiwixActivityModule

app/src/main/java/org/kiwix/kiwixmobile/di/modules/KiwixModule.kt

@@ -20,6 +20,7 @@ package org.kiwix.kiwixmobile.di.modules
 
 import android.content.Context
 import android.location.LocationManager
+import android.net.wifi.WifiManager
 import android.net.wifi.p2p.WifiP2pManager
 import dagger.Module
 import dagger.Provides
@@ -55,4 +56,9 @@ object KiwixModule {
   // See: https://github.com/kiwix/kiwix-android/issues/2488
   fun providesWiFiP2pManager(context: Context): WifiP2pManager? =
     context.getSystemService(Context.WIFI_P2P_SERVICE) as WifiP2pManager?
+
+  @Provides
+  @KiwixScope
+  fun provideWifiManager(context: Context): WifiManager =
+    context.applicationContext.getSystemService(Context.WIFI_SERVICE) as WifiManager
 }

app/src/main/java/org/kiwix/kiwixmobile/di/modules/ServiceModule.kt

@@ -0,0 +1,78 @@
+/*
+ * Kiwix Android
+ * Copyright (c) 2024 Kiwix <android.kiwix.org>
+ * 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 org.kiwix.kiwixmobile.di.modules
+
+import android.app.NotificationManager
+import android.app.Service
+import android.content.Context
+import dagger.Module
+import dagger.Provides
+import org.kiwix.kiwixmobile.core.qr.GenerateQR
+import org.kiwix.kiwixmobile.core.read_aloud.ReadAloudNotificationManger
+import org.kiwix.kiwixmobile.di.ServiceScope
+import org.kiwix.kiwixmobile.webserver.KiwixServer
+import org.kiwix.kiwixmobile.webserver.WebServerHelper
+import org.kiwix.kiwixmobile.webserver.wifi_hotspot.HotspotNotificationManager
+import org.kiwix.kiwixmobile.webserver.wifi_hotspot.HotspotStateReceiver
+import org.kiwix.kiwixmobile.webserver.wifi_hotspot.IpAddressCallbacks
+
+@Module
+class ServiceModule {
+  @Provides
+  @ServiceScope
+  fun providesReadAloudNotificationManager(
+    notificationManager: NotificationManager,
+    context: Context
+  ): ReadAloudNotificationManger = ReadAloudNotificationManger(notificationManager, context)
+
+  @Provides
+  @ServiceScope
+  fun providesWebServerHelper(
+    kiwixServerFactory: KiwixServer.Factory,
+    ipAddressCallbacks: IpAddressCallbacks
+  ): WebServerHelper = WebServerHelper(kiwixServerFactory, ipAddressCallbacks)
+
+  @Provides
+  @ServiceScope
+  fun providesIpAddressCallbacks(service: Service): IpAddressCallbacks =
+    service as IpAddressCallbacks
+
+  @Provides
+  @ServiceScope
+  fun providesHotspotNotificationManager(
+    notificationManager: NotificationManager,
+    context: Context,
+    generateQR: GenerateQR,
+  ): HotspotNotificationManager =
+    HotspotNotificationManager(notificationManager, context, generateQR)
+
+  @Provides
+  @ServiceScope
+  fun providesHotspotStateReceiver(callback: HotspotStateReceiver.Callback): HotspotStateReceiver =
+    HotspotStateReceiver(callback)
+
+  @Provides
+  @ServiceScope
+  fun providesHotspotStateReceiverCallback(service: Service): HotspotStateReceiver.Callback =
+    service as HotspotStateReceiver.Callback
+
+  @Provides
+  @ServiceScope
+  fun providesGenerateQr(): GenerateQR = GenerateQR()
+}

app/src/main/java/org/kiwix/kiwixmobile/main/KiwixMainActivity.kt

@@ -26,6 +26,7 @@ import android.graphics.drawable.Icon
 import android.os.Bundle
 import android.os.Handler
 import android.os.Looper
+import android.view.MenuItem
 import androidx.appcompat.app.AppCompatActivity
 import androidx.appcompat.view.ActionMode
 import androidx.core.os.ConfigurationCompat
@@ -40,6 +41,7 @@ import com.google.android.material.navigation.NavigationView
 import eu.mhutti1.utils.storage.StorageDeviceUtils
 import org.kiwix.kiwixmobile.BuildConfig
 import org.kiwix.kiwixmobile.R
+import org.kiwix.kiwixmobile.core.R.id
 import org.kiwix.kiwixmobile.core.R.drawable
 import org.kiwix.kiwixmobile.core.R.mipmap
 import org.kiwix.kiwixmobile.core.R.string
@@ -98,8 +100,6 @@ class KiwixMainActivity : CoreMainActivity() {
   override val notesFragmentResId: Int = R.id.notesFragment
   override val readerFragmentResId: Int = R.id.readerFragment
   override val helpFragmentResId: Int = R.id.helpFragment
-  override val zimHostFragmentResId: Int = R.id.zimHostFragment
-  override val navGraphId: Int = R.navigation.kiwix_nav_graph
   override val topLevelDestinations =
     setOf(R.id.downloadsFragment, R.id.libraryFragment, R.id.readerFragment)
 
@@ -272,6 +272,19 @@ class KiwixMainActivity : CoreMainActivity() {
     }
   }
 
+  override fun onNavigationItemSelected(item: MenuItem): Boolean {
+    when (item.itemId) {
+      id.menu_host_books -> openZimHostFragment()
+      else -> return super.onNavigationItemSelected(item)
+    }
+    return true
+  }
+
+  private fun openZimHostFragment() {
+    disableDrawer()
+    navigate(R.id.zimHostFragment)
+  }
+
   override fun getIconResId() = mipmap.ic_launcher
 
   override fun createApplicationShortcuts() {

app/src/main/java/org/kiwix/kiwixmobile/nav/destination/library/CopyMoveFileHandler.kt

@@ -382,7 +382,7 @@
   @SuppressLint("InflateParams") fun showPreparingCopyMoveDialog() {
     if (copyMovePreparingDialog == null) {
       val dialogView: View =
-        activity.layoutInflater.inflate(R.layout.item_custom_spinner, null)
+        activity.layoutInflater.inflate(layout.item_custom_spinner, null)
       copyMovePreparingDialog =
         alertDialogShower.create(KiwixDialog.PreparingCopyingFilesDialog { dialogView })
     }

core/src/main/java/org/kiwix/kiwixmobile/core/webserver/KiwixServer.kt → app/src/main/java/org/kiwix/kiwixmobile/webserver/KiwixServer.kt

@@ -1,6 +1,6 @@
 /*
  * Kiwix Android
- * Copyright (c) 2023 Kiwix <android.kiwix.org>
+ * Copyright (c) 2024 Kiwix <android.kiwix.org>
  * 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
@@ -16,7 +16,7 @@
  *
  */
 
-package org.kiwix.kiwixmobile.core.webserver
+package org.kiwix.kiwixmobile.webserver
 
 import android.content.Context
 import org.kiwix.kiwixmobile.core.utils.files.Log

core/src/main/java/org/kiwix/kiwixmobile/core/webserver/WebServerHelper.kt → app/src/main/java/org/kiwix/kiwixmobile/webserver/WebServerHelper.kt

@@ -1,6 +1,6 @@
 /*
  * Kiwix Android
- * Copyright (c) 2023 Kiwix <android.kiwix.org>
+ * Copyright (c) 2024 Kiwix <android.kiwix.org>
  * 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
@@ -15,7 +15,7 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
  */
-package org.kiwix.kiwixmobile.core.webserver
+package org.kiwix.kiwixmobile.webserver
 
 import io.reactivex.Flowable
 import io.reactivex.android.schedulers.AndroidSchedulers
@@ -27,8 +27,8 @@ import org.kiwix.kiwixmobile.core.utils.ServerUtils.INVALID_IP
 import org.kiwix.kiwixmobile.core.utils.ServerUtils.getIp
 import org.kiwix.kiwixmobile.core.utils.ServerUtils.getIpAddress
 import org.kiwix.kiwixmobile.core.utils.files.Log
-import org.kiwix.kiwixmobile.core.webserver.wifi_hotspot.IpAddressCallbacks
-import org.kiwix.kiwixmobile.core.webserver.wifi_hotspot.ServerStatus
+import org.kiwix.kiwixmobile.webserver.wifi_hotspot.IpAddressCallbacks
+import org.kiwix.kiwixmobile.webserver.wifi_hotspot.ServerStatus
 import java.util.concurrent.TimeUnit
 import javax.inject.Inject
 

core/src/main/java/org/kiwix/kiwixmobile/core/webserver/ZimHostCallbacks.kt → app/src/main/java/org/kiwix/kiwixmobile/webserver/ZimHostCallbacks.kt

@@ -15,7 +15,7 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  *
  */
-package org.kiwix.kiwixmobile.core.webserver
+package org.kiwix.kiwixmobile.webserver
 
 interface ZimHostCallbacks {
   fun onServerStarted(ip: String)