Merge pull request #67 from humhub/deprecate-methods-in-new-DeviceDet…

…ectorHelper-2 Use the new DeviceDetectorHelper helper instead of MobileAppHelper & …
humhub · Jan 24, 2025 · b3e2c7c · b3e2c7c
2 parents dda8341 + a0dd4c4
commit b3e2c7c
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 75 deletions.
diff --git a/Events.php b/Events.php
@@ -3,6 +3,7 @@
 namespace humhub\modules\fcmPush;
 
 use humhub\components\mail\Message;
+use humhub\helpers\DeviceDetectorHelper;
 use humhub\modules\fcmPush\assets\FcmPushAsset;
 use humhub\modules\fcmPush\assets\FirebaseAsset;
 use humhub\modules\fcmPush\components\MailerMessage;
@@ -92,7 +93,7 @@ public static function onLayoutAddonInit($event)
         if (Yii::$app->session->has(MobileAppHelper::SESSION_VAR_HIDE_OPENER)) {
             MobileAppHelper::registerHideOpenerScript();
             Yii::$app->session->remove(MobileAppHelper::SESSION_VAR_HIDE_OPENER);
-        } elseif (MobileAppHelper::openerState()) {
+        } elseif (DeviceDetectorHelper::appOpenerState()) {
             MobileAppHelper::registerHideOpenerScript();
         }
 
@@ -156,14 +157,14 @@ public static function onAuthChoiceBeforeRun(Event $event)
         /** @var Module $module */
         $module = Yii::$app->getModule('fcm-push');
 
-        if (MobileAppHelper::isIosApp() && $module->getConfigureForm()->disableAuthChoicesIos) {
+        if (DeviceDetectorHelper::isIosApp() && $module->getConfigureForm()->disableAuthChoicesIos) {
             $sender->setClients([]);
         }
     }
 
     public static function onAccountTopMenuInit(Event $event)
     {
-        if (!MobileAppHelper::isMultiInstanceApp()) {
+        if (!DeviceDetectorHelper::isMultiInstanceApp()) {
             return;
         }
 

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -3,7 +3,9 @@ Changelog
 
 2.1.4 (Unreleased)
 -----------------------
-- Enh: Add "Open native console" button for the mobile app
+- Enh #66: Add "Open native console" button for the mobile app
+- Chg #67: The minimal HumHub version is now 1.17
+- Chg #67: Use the new `DeviceDetectorHelper` helper instead of `MobileAppHelper`
 
 2.1.3 (January 6, 2024)
 -----------------------

diff --git a/helpers/MobileAppHelper.php b/helpers/MobileAppHelper.php
@@ -2,6 +2,7 @@
 
 namespace humhub\modules\fcmPush\helpers;
 
+use humhub\helpers\DeviceDetectorHelper;
 use Yii;
 use yii\helpers\Json;
 use yii\helpers\Url;
@@ -16,9 +17,9 @@ class MobileAppHelper
     public const SESSION_VAR_REGISTER_NOTIFICATION = 'mobileAppRegisterNotification';
     public const SESSION_VAR_UNREGISTER_NOTIFICATION = 'mobileAppUnregisterNotification';
 
-    public static function registerHideOpenerScript()
+    public static function registerHideOpenerScript(): void
     {
-        if (!static::isAppRequest()) {
+        if (!DeviceDetectorHelper::isAppRequest()) {
             return;
         }
 
@@ -28,9 +29,9 @@ public static function registerHideOpenerScript()
         self::sendFlutterMessage($message);
     }
 
-    public static function registerShowOpenerScript()
+    public static function registerShowOpenerScript(): void
     {
-        if (!static::isAppRequest()) {
+        if (!DeviceDetectorHelper::isAppRequest()) {
             return;
         }
 
@@ -40,9 +41,9 @@ public static function registerShowOpenerScript()
         self::sendFlutterMessage($message);
     }
 
-    public static function registerNotificationScript()
+    public static function registerNotificationScript(): void
     {
-        if (!static::isAppRequest()) {
+        if (!DeviceDetectorHelper::isAppRequest()) {
             return;
         }
 
@@ -51,9 +52,9 @@ public static function registerNotificationScript()
         self::sendFlutterMessage($message);
     }
 
-    public static function unregisterNotificationScript()
+    public static function unregisterNotificationScript(): void
     {
-        if (!static::isAppRequest()) {
+        if (!DeviceDetectorHelper::isAppRequest()) {
             return;
         }
 
@@ -62,63 +63,8 @@ public static function unregisterNotificationScript()
         self::sendFlutterMessage($message);
     }
 
-    public static function isAppRequest()
-    {
-        return (
-            (Yii::$app->request->headers->get('x-requested-with', null, true) === 'com.humhub.app') ||
-            (Yii::$app->request->headers->has('x-humhub-app'))
-        );
-    }
-
-    /**
-     * Determines whether the app is a branded app with custom firebase configuration.
-     * @return bool
-     */
-    public static function isAppWithCustomFcm(): bool
-    {
-        return (
-            Yii::$app->request->headers->has('x-humhub-app-bundle-id') &&
-            !str_contains(
-                Yii::$app->request->headers->get('x-humhub-app-bundle-id', '', true),
-                'com.humhub.app',
-            )
-        );
-
-    }
-
-    private static function sendFlutterMessage($msg)
+    private static function sendFlutterMessage($msg): void
     {
         Yii::$app->view->registerJs('if (window.flutterChannel) { window.flutterChannel.postMessage(\'' . $msg . '\'); }');
     }
-
-    public static function isIosApp(): bool
-    {
-        return
-            static::isAppRequest()
-            && Yii::$app->request->headers->get('x-humhub-app-is-ios');
-    }
-
-    /**
-     * True if the mobile app supports multi instance to display the Opener landing page without logout for switching instance
-     *
-     * @since HumHub mobile app v1.0.124
-     */
-    public static function isMultiInstanceApp(): bool
-    {
-        return
-            static::isAppRequest()
-            && Yii::$app->request->headers->get('x-humhub-app-is-multi-instance');
-    }
-
-    /**
-     * True if the mobile app Opener landing page is visible and should be hidden.
-     *
-     * @since HumHub mobile app v1.0.124
-     */
-    public static function openerState(): bool
-    {
-        return
-            static::isAppRequest()
-            && Yii::$app->request->headers->get('x-humhub-app-opener-state');
-    }
 }
diff --git a/helpers/WebAppHelper.php b/helpers/WebAppHelper.php
@@ -2,6 +2,7 @@
 
 namespace humhub\modules\fcmPush\helpers;
 
+use humhub\helpers\DeviceDetectorHelper;
 use Yii;
 
 class WebAppHelper
@@ -10,7 +11,7 @@ class WebAppHelper
 
     public static function unregisterNotificationScript()
     {
-        if (MobileAppHelper::isAppRequest()) {
+        if (DeviceDetectorHelper::isAppRequest()) {
             return;
         }
 

diff --git a/module.json b/module.json
@@ -9,7 +9,7 @@
     ],
     "homepage": "https://github.com/humhub/fcm-push",
     "humhub": {
-        "minVersion": "1.14"
+        "minVersion": "1.17"
     },
     "version": "2.1.4",
     "screenshots": [

diff --git a/services/DriverService.php b/services/DriverService.php
@@ -2,10 +2,10 @@
 
 namespace humhub\modules\fcmPush\services;
 
+use humhub\helpers\DeviceDetectorHelper;
 use humhub\modules\fcmPush\driver\DriverInterface;
 use humhub\modules\fcmPush\driver\Fcm;
 use humhub\modules\fcmPush\driver\Proxy;
-use humhub\modules\fcmPush\helpers\MobileAppHelper;
 use humhub\modules\fcmPush\models\ConfigureForm;
 
 class DriverService
@@ -66,7 +66,7 @@ public function getWebDriver(): ?DriverInterface
 
     public function getMobileAppDriver(): ?DriverInterface
     {
-        if (MobileAppHelper::isAppWithCustomFcm()) {
+        if (DeviceDetectorHelper::isAppWithCustomFcm()) {
             return $this->getConfiguredDriverByType(Fcm::class);
         }
 

diff --git a/views/admin/mobile-app.php b/views/admin/mobile-app.php
@@ -2,8 +2,8 @@
 
 /* @var $this \humhub\modules\ui\view\components\View */
 
+use humhub\helpers\DeviceDetectorHelper;
 use humhub\libs\Html;
-use humhub\modules\fcmPush\helpers\MobileAppHelper;
 use humhub\modules\fcmPush\models\FcmUser;
 use yii\helpers\Json;
 use yii\helpers\Url;
@@ -20,12 +20,12 @@
             </div>
             <div class="panel-body">
 
-                <?php if (MobileAppHelper::isAppRequest()): ?>
+                <?php if (DeviceDetectorHelper::isAppRequest()): ?>
                     <p class="alert alert-success">
                         <strong>App Detection</strong> - Current Request: Is App Request
                     </p>
 
-                    <?php if (MobileAppHelper::isAppWithCustomFcm()): ?>
+                    <?php if (DeviceDetectorHelper::isAppWithCustomFcm()): ?>
                         <p class="alert alert-success">
                             <strong>FCM Detection</strong> - App is using custom Firebase
                         </p>