Differential D2674 Diff 7837 src/app/CompanionApp.php

Changeset View

Standalone View

src/app/CompanionApp.php

This file was added.

				<?php

				namespace App;

				use Illuminate\Database\Eloquent\Model;

				/**
				* The eloquent definition of a CompanionApp.
				*
				* A CompanionApp is an kolab companion app that the user registered
				*/
				class CompanionApp extends Model
				{
				protected $fillable = [
				'name',
				'user_id',
				'device_id',
				'notification_token',
				'mfa_enabled',
				];

				/**
				* Send a notification via firebase.
				*
				* @param array $deviceIds A list of device id's to send the notification to
				* @param array $data The data to include in the notification.
				machniakUnsubmitted Done Inline Actions Documentation for params missing. machniak: Documentation for params missing.
				*
				* @return bool true if a notification has been sent
				*/
				machniakUnsubmitted Done Inline Actions I'd add @throws info. machniak: I'd add @throws info.
				private static function pushFirebaseNotification($deviceIds, $data): bool
				{
				\Log::debug("sending notification to " . var_export($deviceIds, true));
				$apiKey = \config('firebase.api_key');

				$client = new \GuzzleHttp\Client(
				[
				'verify' => \config('firebase.api_verify_tls')
				]
				);
				machniakUnsubmitted Done Inline Actions Short array syntax, please. machniak: Short array syntax, please.
				$response = $client->request(
				'POST',
				\config('firebase.api_url'),
				[
				'headers' => [
				machniakUnsubmitted Done Inline Actions It would be better to not use curl, but guzzlehttp/guzzle client we already have in use. machniak: It would be better to not use curl, but guzzlehttp/guzzle client we already have in use.
				'Authorization' => "key={$apiKey}",
				],
				'json' => [
				'registration_ids' => $deviceIds,
				'data' => $data
				]
				]
				);


				if ($response->getStatusCode() != 200) {
				throw new \Exception('FCM Send Error: ' . $response->getStatusCode());
				}
				return true;
				}

				/**
				* Send a notification to a user.
				*
				* @return bool true if a notification has been sent
				*/
				machniakUnsubmitted Done Inline Actions Just a not that in most cases we're using return type declarations. machniak: Just a not that in most cases we're using return type declarations.
				machniakUnsubmitted Done Inline Actions Add @throws machniak: Add @throws
				public static function notifyUser($userId, $data): bool
				{
				$notificationTokens = \App\CompanionApp::where('user_id', $userId)
				->where('mfa_enabled', true)
				->pluck('notification_token')
				->all();
				machniakUnsubmitted Done Inline Actions Use pluck() method https://laravel.com/docs/8.x/queries#retrieving-a-list-of-column-values machniak: Use pluck() method https://laravel.com/docs/8.x/queries#retrieving-a-list-of-column-values

				if (empty($notificationTokens)) {
				\Log::debug("There is no 2fa device to notify.");
				return false;
				}

				self::pushFirebaseNotification($notificationTokens, $data);
				return true;
				}
				}