Skip to content

Commit 87f8505

Browse files
dasdodasdo
authoredJan 20, 2021
Merge pull request #588 from bakaphp/unsubscribe-0.2
[0.2] Unsubscribe
·
0.2.10-RC10.2.5-BETA4
2 parents 16fae0b + 4f52954 commit 87f8505

File tree

8 files changed

+279
-1
lines changed

8 files changed

+279
-1
lines changed
 

‎routes/api.php

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
Route::crud('/apps-keys')->controller('AppsKeysController'),
2929
Route::post('/apps-keys/regenerate')->controller('AppsKeysController')->action('regenerateKeys'),
3030
Route::crud('/users')->notVia('post'),
31+
Route::post('/users/{id}/unsubscribe')->controller('UsersController')->action('unsubscribe'),
3132
Route::crud('/companies'),
3233
Route::crud('/roles'),
3334
Route::crud('/locales'),

‎src/Api/Controllers/UsersController.php

+36
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
use Canvas\Dto\User as UserDto;
1212
use Canvas\Mapper\UserMapper;
1313
use Canvas\Models\Users;
14+
use Canvas\Models\NotificationType;
15+
use Canvas\Models\Notifications;
1416
use Canvas\Models\UsersAssociatedApps;
1517
use Phalcon\Http\Response;
1618
use Phalcon\Validation\Validator\PresenceOf;
@@ -244,4 +246,38 @@ public function changeAppUserActiveStatus(int $id, int $appsId) : Response
244246
$userAssociatedToApp->updateOrFail();
245247
return $this->response($userAssociatedToApp);
246248
}
249+
250+
/**
251+
* unsubscribe from notification
252+
*
253+
* @param int $id
254+
* @throws InternalServerErrorException
255+
*
256+
* @return Response
257+
*/
258+
public function unsubscribe(int $id) : Response
259+
{
260+
$request = $this->request->getPostData();
261+
262+
263+
if (!isset($request['notification_types'])) {
264+
throw new Exception("Error Processing Request", 1);
265+
}
266+
267+
//none admin users can only edit themselves
268+
if (!$this->userData->hasRole('Default.Admins') || $id == 0) {
269+
$id = $this->userData->getId();
270+
}
271+
272+
$user = $this->model->findFirstOrFail([
273+
'id = ?0 AND is_deleted = 0',
274+
'bind' => [$id],
275+
]);
276+
$unsubscribe = [];
277+
foreach ($request['notification_types'] as $typeId) {
278+
$unsubscribe[] = $user->unsubscribe((int) $typeId);
279+
}
280+
281+
return $this->response($unsubscribe);
282+
}
247283
}

‎src/Models/Notifications.php

+12
Original file line numberDiff line numberDiff line change
@@ -84,4 +84,16 @@ public static function totalUnRead(Users $user) : int
8484
]
8585
]);
8686
}
87+
88+
/**
89+
* unsubscribe user for NotificationType
90+
* @param Users $user
91+
* @param int $notificationTypeId
92+
* @param int $systemModulesId
93+
* @return NotificationsUnsubscribe
94+
*/
95+
public static function unsubscribe(Users $user, int $notificationTypeId, int $systemModulesId) : NotificationsUnsubscribe
96+
{
97+
return NotificationsUnsubscribe::unsubscribe($user, $notificationTypeId, $systemModulesId);
98+
}
8799
}

‎src/Models/NotificationsUnsubscribe.php

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
<?php
2+
declare(strict_types=1);
3+
4+
namespace Canvas\Models;
5+
6+
use Phalcon\Di;
7+
8+
class NotificationsUnsubscribe extends AbstractModel
9+
{
10+
public ?int $users_id = 0;
11+
public ?int $companies_id = 0;
12+
public ?int $apps_id = 0;
13+
public ?int $system_modules_id = 0;
14+
public ?int $notification_type_id = 0;
15+
public ?string $email = null;
16+
17+
/**
18+
* Initialize method for model.
19+
*/
20+
public function initialize()
21+
{
22+
$this->setSource('notifications_unsubscribe');
23+
24+
$this->belongsTo(
25+
'users_id',
26+
'Canvas\Models\Users',
27+
'id',
28+
['alias' => 'user']
29+
);
30+
31+
$this->belongsTo(
32+
'notification_type_id',
33+
'Canvas\Models\NotificationType',
34+
'id',
35+
['alias' => 'type']
36+
);
37+
}
38+
39+
/**
40+
* get NotificationsUnsubscribe by NotificationType
41+
* @param Users $user
42+
* @param int $notificationTypeId
43+
* @return NotificationsUnsubscribe
44+
*/
45+
public static function getByNotificationType(Users $user, int $notificationTypeId) : ?NotificationsUnsubscribe
46+
{
47+
return NotificationsUnsubscribe::findFirst([
48+
'conditions' => 'users_id = ?0 AND companies_id = ?1 AND apps_id = ?2 AND \notification_type_id = ?3 AND is_deleted = 0',
49+
'bind' => [
50+
0 => $user->getId(),
51+
1 => $user->currentCompanyId(),
52+
2 => Di::getDefault()->getApp()->getId(),
53+
3 => $notificationTypeId
54+
]
55+
]);
56+
}
57+
58+
/**
59+
* Verify that the user is unsubscribed
60+
* @param Users $user
61+
* @param int $notificationType
62+
* @return bool
63+
*/
64+
public static function isUnsubscribe(Users $user, int $notificationTypeId) : bool
65+
{
66+
//-1 means it is out of all lists
67+
$userNotification = NotificationsUnsubscribe::getByNotificationType($user, -1);
68+
69+
if (!$userNotification) {
70+
$userNotification = NotificationsUnsubscribe::getByNotificationType($user, $notificationTypeId);
71+
}
72+
73+
return $userNotification ? true : false;
74+
}
75+
76+
/**
77+
* unsubscribe user for NotificationType
78+
* @param Users $user
79+
* @param int $notificationTypeId
80+
* @param int $systemModulesId
81+
* @return NotificationsUnsubscribe
82+
*/
83+
public static function unsubscribe(Users $user, int $notificationTypeId, int $systemModulesId) : NotificationsUnsubscribe
84+
{
85+
$userNotification = NotificationsUnsubscribe::getByNotificationType($user, $notificationTypeId);
86+
87+
if (!$userNotification) {
88+
$userNotification = new NotificationsUnsubscribe();
89+
$userNotification->users_id = $user->getId();
90+
$userNotification->companies_id = $user->currentCompanyId();
91+
$userNotification->apps_id = Di::getDefault()->getApp()->getId();
92+
$userNotification->notification_type_id = $notificationTypeId;
93+
$userNotification->system_modules_id = $systemModulesId;
94+
$userNotification->email = $user->getEmail();
95+
}
96+
97+
$userNotification->is_deleted = 0;
98+
$userNotification->saveOrFail();
99+
return $userNotification;
100+
}
101+
}

‎src/Models/Users.php

+22
Original file line numberDiff line numberDiff line change
@@ -739,4 +739,26 @@ protected function throwErrorMessages() : void
739739
current($this->getMessages())->getMessage()
740740
);
741741
}
742+
743+
/**
744+
* Verify that the user is unsubscribed from email
745+
* @param int $notificationTypeId
746+
* @return bool
747+
*/
748+
public function isUnsubscribe(int $notificationTypeId) : bool
749+
{
750+
return NotificationsUnsubscribe::isUnsubscribe($this, $notificationTypeId);
751+
}
752+
753+
/**
754+
* unsubscribe user for NotificationType
755+
* @param int $notificationTypeId
756+
* @return NotificationsUnsubscribe
757+
*/
758+
public function unsubscribe(int $notificationTypeId) : NotificationsUnsubscribe
759+
{
760+
$notificationType = NotificationType::findFirst($notificationTypeId);
761+
$systemModulesId = $notificationType ? $notificationType->system_modules_id : -1;
762+
return Notifications::unsubscribe($this, (int) $notificationTypeId, (int) $systemModulesId);
763+
}
742764
}

‎src/Notifications/Notification.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ public function trigger() : bool
235235
$notification->saveOrFail();
236236

237237
$toMail = $this->toMail();
238-
if ($toMail instanceof Message) {
238+
if ($toMail instanceof Message && !$this->toUser->isUnsubscribe($notification->notification_type_id)) {
239239
$this->fire('notification:sendMail', $toMail);
240240
}
241241

‎storage/db/migrations/20210114193743_notifications_unsubscribe.php

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
<?php
2+
3+
use Phinx\Db\Adapter\MysqlAdapter;
4+
5+
class NotificationsUnsubscribe extends Phinx\Migration\AbstractMigration
6+
{
7+
public function change()
8+
{
9+
$this->table('notifications_unsubscribe', [
10+
'id' => false,
11+
'primary_key' => ['id'],
12+
'engine' => 'InnoDB',
13+
'encoding' => 'latin1',
14+
'collation' => 'latin1_swedish_ci',
15+
'comment' => '',
16+
'row_format' => 'DYNAMIC',
17+
])
18+
->addColumn('id', 'integer', [
19+
'null' => false,
20+
'limit' => MysqlAdapter::INT_REGULAR,
21+
'identity' => 'enable',
22+
])
23+
->addColumn('users_id', 'integer', [
24+
'null' => false,
25+
'limit' => MysqlAdapter::INT_REGULAR,
26+
'after' => 'id',
27+
])
28+
->addColumn('companies_id', 'integer', [
29+
'null' => false,
30+
'limit' => MysqlAdapter::INT_REGULAR,
31+
'after' => 'users_id',
32+
])
33+
->addColumn('apps_id', 'integer', [
34+
'null' => false,
35+
'limit' => MysqlAdapter::INT_REGULAR,
36+
'after' => 'companies_id',
37+
])
38+
->addColumn('notification_type_id', 'integer', [
39+
'null' => false,
40+
'limit' => MysqlAdapter::INT_REGULAR,
41+
'after' => 'apps_id',
42+
])
43+
->addColumn('email', 'string', [
44+
'null' => false,
45+
'limit' => 255,
46+
'collation' => 'latin1_swedish_ci',
47+
'encoding' => 'latin1',
48+
'after' => 'notification_type_id',
49+
])
50+
->addColumn('created_at', 'datetime', [
51+
'null' => false,
52+
'after' => 'email',
53+
])
54+
->addColumn('updated_at', 'datetime', [
55+
'null' => true,
56+
'default' => null,
57+
'after' => 'created_at',
58+
])
59+
->addColumn('is_deleted', 'integer', [
60+
'null' => false,
61+
'limit' => MysqlAdapter::INT_REGULAR,
62+
'after' => 'updated_at',
63+
])
64+
->addColumn('system_modules_id', 'integer', [
65+
'null' => false,
66+
'limit' => MysqlAdapter::INT_REGULAR,
67+
'after' => 'is_deleted',
68+
])
69+
->create();
70+
}
71+
}

‎tests/api/UsersCest.php

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<?php
2+
3+
namespace Canvas\Tests\api;
4+
5+
use ApiTester;
6+
7+
class UsersCest
8+
{
9+
/**
10+
* unsubscribe from notification
11+
*
12+
* @param ApiTester
13+
*
14+
* @return void
15+
*/
16+
public function unsubscribe(ApiTester $I) : void
17+
{
18+
$userData = $I->apiLogin();
19+
$userName = $I->faker()->firstname;
20+
21+
$I->haveHttpHeader('Authorization', $userData->token);
22+
$I->sendPost('/v1/users/0/unsubscribe', [
23+
'notification_types' => [
24+
-1
25+
]
26+
]);
27+
28+
$I->seeResponseIsSuccessful();
29+
$response = $I->grabResponse();
30+
$data = json_decode($response, true);
31+
32+
$I->assertTrue(isset($data[0]['notification_type_id']));
33+
$I->assertTrue($data[0]['notification_type_id'] == -1);
34+
}
35+
}

0 commit comments

Comments
 (0)
Please sign in to comment.