1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCA\Files_Sharing\Tests;
use OC\SystemConfig;
use OCA\Files_Sharing\SharesReminderJob;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Constants;
use OCP\Defaults;
use OCP\Files\IMimeTypeLoader;
use OCP\Files\IRootFolder;
use OCP\IDBConnection;
use OCP\IURLGenerator;
use OCP\IUserManager;
use OCP\L10N\IFactory;
use OCP\Mail\IMailer;
use OCP\Mail\IMessage;
use OCP\Share\IManager;
use OCP\Share\IShare;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;
/**
* Class SharesReminderJobTest
*
* @group DB
*
* @package OCA\Files_Sharing\Tests
*/
class SharesReminderJobTest extends \Test\TestCase {
private SharesReminderJob $job;
private IDBConnection $db;
private IManager $shareManager;
private IUserManager $userManager;
private IMailer|MockObject $mailer;
private string $user1;
private string $user2;
protected function setUp(): void {
parent::setUp();
$this->db = \OC::$server->get(IDBConnection::class);
$this->shareManager = \OC::$server->get(IManager::class);
$this->userManager = \OC::$server->get(IUserManager::class);
$this->mailer = $this->createMock(IMailer::class);
// Clear occasional leftover shares from other tests
$this->db->executeUpdate('DELETE FROM `*PREFIX*share`');
$this->user1 = $this->getUniqueID('user1_');
$this->user2 = $this->getUniqueID('user2_');
$user1 = $this->userManager->createUser($this->user1, 'longrandompassword');
$user2 = $this->userManager->createUser($this->user2, 'longrandompassword');
$user1->setSystemEMailAddress('user1@test.com');
$user2->setSystemEMailAddress('user2@test.com');
\OC::registerShareHooks(\OC::$server->get(SystemConfig::class));
$this->job = new SharesReminderJob(
\OC::$server->get(ITimeFactory::class),
$this->db,
\OC::$server->get(IManager::class),
$this->userManager,
\OC::$server->get(LoggerInterface::class),
\OC::$server->get(IURLGenerator::class),
\OC::$server->get(IFactory::class),
$this->mailer,
\OC::$server->get(Defaults::class),
\OC::$server->get(IMimeTypeLoader::class),
);
}
protected function tearDown(): void {
$this->db->executeUpdate('DELETE FROM `*PREFIX*share`');
$userManager = \OC::$server->get(IUserManager::class);
$user1 = $userManager->get($this->user1);
if ($user1) {
$user1->delete();
}
$user2 = $userManager->get($this->user2);
if ($user2) {
$user2->delete();
}
$this->logout();
parent::tearDown();
}
public function dataSharesReminder() {
$someMail = 'test@test.com';
$noExpirationDate = null;
$today = new \DateTime();
// For expiration dates, the time is always automatically set to zero by ShareAPIController
$today->setTime(0, 0);
$nearFuture = new \DateTime();
$nearFuture->setTimestamp($today->getTimestamp() + 86400 * 1);
$farFuture = new \DateTime();
$farFuture->setTimestamp($today->getTimestamp() + 86400 * 2);
$permissionRead = Constants::PERMISSION_READ;
$permissionCreate = $permissionRead | Constants::PERMISSION_CREATE;
$permissionUpdate = $permissionRead | Constants::PERMISSION_UPDATE;
$permissionDelete = $permissionRead | Constants::PERMISSION_DELETE;
$permissionAll = Constants::PERMISSION_ALL;
return [
// No reminders for folders without expiration date
[$noExpirationDate, '', false, $permissionRead, false],
[$noExpirationDate, '', false, $permissionCreate, false],
[$noExpirationDate, '', true, $permissionDelete, false],
[$noExpirationDate, '', true, $permissionCreate, false],
[$noExpirationDate, $someMail, false, $permissionUpdate, false],
[$noExpirationDate, $someMail, false, $permissionCreate, false],
[$noExpirationDate, $someMail, true, $permissionRead, false],
[$noExpirationDate, $someMail, true, $permissionAll, false],
// No reminders for folders with expiration date in the far future
[$farFuture, '', false, $permissionRead, false],
[$farFuture, '', false, $permissionCreate, false],
[$farFuture, '', true, $permissionDelete, false],
[$farFuture, '', true, $permissionCreate, false],
[$farFuture, $someMail, false, $permissionUpdate, false],
[$farFuture, $someMail, false, $permissionCreate, false],
[$farFuture, $someMail, true, $permissionRead, false],
[$farFuture, $someMail, true, $permissionAll, false],
/* Should send reminders for folders with expiration date in the near future
if the folder is empty and the user has write permission */
[$nearFuture, '', false, $permissionRead, false],
[$nearFuture, '', false, $permissionCreate, false],
[$nearFuture, '', true, $permissionDelete, false],
[$nearFuture, '', true, $permissionCreate, true],
[$nearFuture, $someMail, false, $permissionUpdate, false],
[$nearFuture, $someMail, false, $permissionCreate, false],
[$nearFuture, $someMail, true, $permissionRead, false],
[$nearFuture, $someMail, true, $permissionAll, true],
];
}
/**
* @dataProvider dataSharesReminder
*
* @param \DateTime|null $expirationDate Share expiration date
* @param string $email Share with this email. If empty, the share is of type TYPE_USER and the sharee is user2
* @param bool $isEmpty Is share folder empty?
* @param int $permissions
* @param bool $shouldBeReminded
*/
public function testSharesReminder(
?\DateTime $expirationDate, string $email, bool $isEmpty, int $permissions, bool $shouldBeReminded,
): void {
$this->loginAsUser($this->user1);
$user1Folder = \OC::$server->get(IRootFolder::class)->getUserFolder($this->user1);
$testFolder = $user1Folder->newFolder('test');
if (!$isEmpty) {
$testFolder->newFile('some_file.txt', 'content');
}
$share = $this->shareManager->newShare();
$share->setNode($testFolder)
->setShareType(($email ? IShare::TYPE_EMAIL : IShare::TYPE_USER))
->setPermissions($permissions)
->setSharedBy($this->user1)
->setSharedWith(($email ?: $this->user2))
->setExpirationDate($expirationDate);
$share = $this->shareManager->createShare($share);
$this->logout();
$messageMock = $this->createMock(IMessage::class);
$this->mailer->method('createMessage')->willReturn($messageMock);
$this->mailer
->expects(($shouldBeReminded ? $this->once() : $this->never()))
->method('send')
->with($messageMock);
$messageMock
->expects(($shouldBeReminded ? $this->once() : $this->never()))
->method('setTo')
->with([$email ?: $this->userManager->get($this->user2)->getSystemEMailAddress()]);
$this->assertSame(false, $share->getReminderSent());
$this->job->run([]);
$share = $this->shareManager->getShareById($share->getFullId());
$this->assertEquals($shouldBeReminded, $share->getReminderSent());
}
}
|
