Merge pull request #54 from humhub/fix/389-remove-legacy-driver

Remove obsolete driver FcmLegacy
humhub · Oct 21, 2024 · 048de8d · 048de8d
2 parents a7ff93e + dafcfc1
commit 048de8d
Show file tree

Hide file tree

Showing 5 changed files with 4 additions and 85 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -4,6 +4,7 @@ Changelog
 2.1.0 (Unreleased)
 -------------------------
 - Fix #51: Firebase not working anymore for web push notifications
+- Fix #54: Remove obsolete driver FcmLegacy
 
 **This version requires extra settings in the module configuration.**
 

diff --git a/driver/FcmLegacy.php b/driver/FcmLegacy.php
diff --git a/models/ConfigureForm.php b/models/ConfigureForm.php
@@ -23,8 +23,6 @@ class ConfigureForm extends Model
 
     public $json;
 
-    public $serverKey;
-
     public $humhubApiKey;
 
     public $disableAuthChoicesIos;
@@ -93,7 +91,7 @@ public function rules()
             [['enableEmailGoService', 'disableAuthChoicesIos'], 'boolean'],
             [['senderId'], 'number'],
             [['firebaseApiKey', 'firebaseAppId', 'firebaseVapidKey'], 'string'],
-            [['serverKey', 'json', 'humhubApiKey'], 'safe'],
+            [['json', 'humhubApiKey'], 'safe'],
             [['fileAssetLinks', 'fileAppleAssociation'], 'string'],
             ['json', function ($attribute, $params, $validator) {
                 if (empty($this->$attribute)) {
@@ -152,7 +150,6 @@ public function attributeLabels()
             'firebaseAppId' => Yii::t('FcmPushModule.base', 'Web App ID'),
             'firebaseVapidKey' => Yii::t('FcmPushModule.base', 'Key pair of the Web Push certificates'),
             'json' => Yii::t('FcmPushModule.base', 'Service Account (JSON file)'),
-            'serverKey' => Yii::t('FcmPushModule.base', 'Cloud Messaging API (Legacy)'),
             'disableAuthChoicesIos' => Yii::t('FcmPushModule.base', 'Disable AuthChoices on iOS App'),
             'fileAssetLinks' => Yii::t('FcmPushModule.base', 'Well-known file {fileName}', [
                 'fileName' => '"' . WellKnownService::getFileName('fileAssetLinks') . '"',
@@ -168,7 +165,6 @@ public function attributeHints()
         return [
             'humhubInstallId' => Yii::t('FcmPushModule.base', 'Use this ID to register your API Key.'),
             'firebaseVapidKey' => Yii::t('FcmPushModule.base', 'Firebase Cloud Messaging -> Web Push certificates -> Key pair'),
-            'serverKey' => Yii::t('FcmPushModule.base', 'Please switch to the new "Firebase Cloud Messaging API (V1)" and enter a JSON file in the field above. The old legacy API is only temporarily available for existing installations and is no longer supported or maintained.'),
             'json' => Yii::t('FcmPushModule.base', 'Paste the content of the service account JSON files here. You can find more information in the module instructions.'),
             'fileAssetLinks' => Yii::t('FcmPushModule.base', 'URL to the file {fileNameLink}', [
                 'fileNameLink' => Link::to(
@@ -202,7 +198,6 @@ public function loadSettings()
         $this->firebaseAppId = $settings->get('firebaseAppId');
         $this->firebaseVapidKey = $settings->get('firebaseVapidKey');
         $this->json = $settings->get('json');
-        $this->serverKey = $settings->get('serverKey');
         $this->humhubApiKey = $settings->get('humhubApiKey');
         $this->disableAuthChoicesIos = $settings->get('disableAuthChoicesIos');
         $this->fileAssetLinks = $settings->get('fileAssetLinks');
@@ -222,7 +217,6 @@ public function saveSettings()
         $module->settings->set('firebaseAppId', $this->firebaseAppId);
         $module->settings->set('firebaseVapidKey', $this->firebaseVapidKey);
         $module->settings->set('json', $this->json);
-        $module->settings->set('serverKey', $this->serverKey);
         $module->settings->set('humhubApiKey', $this->humhubApiKey);
         $module->settings->set('disableAuthChoicesIos', $this->disableAuthChoicesIos);
         $module->settings->set('fileAssetLinks', $this->fileAssetLinks);

diff --git a/services/DriverService.php b/services/DriverService.php
@@ -4,7 +4,6 @@
 
 use humhub\modules\fcmPush\driver\DriverInterface;
 use humhub\modules\fcmPush\driver\Fcm;
-use humhub\modules\fcmPush\driver\FcmLegacy;
 use humhub\modules\fcmPush\driver\Proxy;
 use humhub\modules\fcmPush\helpers\MobileAppHelper;
 use humhub\modules\fcmPush\models\ConfigureForm;
@@ -33,19 +32,14 @@ private function initDrivers()
         $fcm = new Fcm($this->config);
         if ($fcm->isConfigured()) {
             $this->configuredDrivers[] = $fcm;
-        } else {
-            $fcmLegacy = new FcmLegacy($this->config);
-            if ($fcmLegacy->isConfigured()) {
-                $this->configuredDrivers[] = $fcmLegacy;
-            }
         }
     }
 
 
     /**
      * There may be several Firebase drivers at the same time. e.g.
      *
-     * - Fcm or FcmLegacy: For PWA/Web Notification
+     * - Fcm: For PWA/Web Notification
      * - HumHubProxy: For the official Mobile Apps
      *
      * @return DriverInterface[]
@@ -55,12 +49,11 @@ public function getConfiguredDrivers(): array
         return $this->configuredDrivers;
     }
 
-
     public function getWebDriver(): ?DriverInterface
     {
         // If Fcm driver is available use it
         foreach ($this->configuredDrivers as $driver) {
-            if ($driver instanceof Fcm || $driver instanceof FcmLegacy) {
+            if ($driver instanceof Fcm) {
                 return $driver;
             }
         }

diff --git a/views/admin/index.php b/views/admin/index.php
@@ -43,9 +43,6 @@
         <?= $form->field($model, 'firebaseAppId') ?>
         <?= $form->field($model, 'firebaseVapidKey') ?>
         <?= $form->field($model, 'json')->textarea(['rows' => 10]); ?>
-        <?php if (!empty($model->serverKey)): ?>
-            <?= $form->field($model, 'serverKey')->textInput(); ?>
-        <?php endif; ?>
         <br/>