Skip to content

[stable18] Use the usermountcache to get all users who have access to a file #457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nickvergessen merged 4 commits into from
May 26, 2020
Merged

[stable18] Use the usermountcache to get all users who have access to a file #457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
044ffb7
Use the usermountcache to get all users who have access to a file
icewind1991 Aug 22, 2017
7e79598
Only use the visible path
nickvergessen Mar 10, 2020
2a3a63f
Add a config to use the cached mount points
nickvergessen Mar 10, 2020
de92930
Fix unit test
nickvergessen May 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 35 additions & 21 deletions lib/FilesHooks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,14 @@
use OCA\Activity\Extension\Files;
use OCA\Activity\Extension\Files_Sharing;
use OCP\Activity\IManager;
use OCP\Files\Config\ICachedMountFileInfo;
use OCP\Files\Config\ICachedMountInfo;
use OCP\Files\Config\IUserMountCache;
use OCP\Files\IRootFolder;
use OCP\Files\Mount\IMountPoint;
use OCP\Files\Node;
use OCP\Files\NotFoundException;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\IGroup;
use OCP\IGroupManager;
Expand Down Expand Up @@ -82,6 +86,10 @@ class FilesHooks {

/** @var CurrentUser */
protected $currentUser;
/** @var IUserMountCache */
protected $userMountCache;
/** @var IConfig */
protected $config;

/** @var string|bool */
protected $moveCase = false;
Expand All @@ -94,21 +102,6 @@ class FilesHooks {
/** @var string */
protected $oldParentId;

/**
* Constructor
*
* @param IManager $manager
* @param Data $activityData
* @param UserSettings $userSettings
* @param IGroupManager $groupManager
* @param View $view
* @param IRootFolder $rootFolder
* @param IShareHelper $shareHelper
* @param IDBConnection $connection
* @param IURLGenerator $urlGenerator
* @param ILogger $logger
* @param CurrentUser $currentUser
*/
public function __construct(IManager $manager,
Data $activityData,
UserSettings $userSettings,
Expand All @@ -119,7 +112,9 @@ public function __construct(IManager $manager,
IDBConnection $connection,
IURLGenerator $urlGenerator,
ILogger $logger,
CurrentUser $currentUser) {
CurrentUser $currentUser,
IUserMountCache $userMountCache,
IConfig $config) {
$this->manager = $manager;
$this->activityData = $activityData;
$this->userSettings = $userSettings;
Expand All @@ -131,6 +126,8 @@ public function __construct(IManager $manager,
$this->urlGenerator = $urlGenerator;
$this->logger = $logger;
$this->currentUser = $currentUser;
$this->userMountCache = $userMountCache;
$this->config = $config;
}

/**
Expand Down Expand Up @@ -197,7 +194,19 @@ protected function addNotificationsForFileAction($filePath, $activityType, $subj

$this->generateRemoteActivity($accessList['remotes'], $activityType, time(), $this->currentUser->getCloudId(), $accessList['ownerPath']);

$affectedUsers = $accessList['users'];
if ($this->config->getSystemValueBool('activity_use_cached_mountpoints', false)) {
$mountsForFile = $this->userMountCache->getMountsForFileId($fileId);
$affectedUserIds = array_map(function (ICachedMountInfo $mount) {
return $mount->getUser()->getUID();
}, $mountsForFile);
$affectedPaths = array_map(function (ICachedMountFileInfo $mount) {
return $this->getVisiblePath($mount->getPath());
}, $mountsForFile);
$affectedUsers = array_combine($affectedUserIds, $affectedPaths);
} else {
$affectedUsers = $accessList['users'];
}

$filteredStreamUsers = $this->userSettings->filterUsersBySetting(array_keys($affectedUsers), 'stream', $activityType);
$filteredEmailUsers = $this->userSettings->filterUsersBySetting(array_keys($affectedUsers), 'email', $activityType);

Expand Down Expand Up @@ -616,15 +625,20 @@ protected function getUserPathsFromPath($path, $uidOwner) {
$accessList = $this->shareHelper->getPathsForAccessList($node);

$path = $node->getPath();
$sections = explode('/', $path, 4);
$accessList['ownerPath'] = $this->getVisiblePath($path);
return $accessList;
}

$accessList['ownerPath'] = '/';
protected function getVisiblePath(string $absolutePath): string {
$sections = explode('/', $absolutePath, 4);

$path = '/';
if (isset($sections[3])) {
// Not the case when a file in root is renamed
$accessList['ownerPath'] .= $sections[3];
$path .= $sections[3];
}

return $accessList;
return $path;
}

/**
Expand Down
110 changes: 100 additions & 10 deletions tests/FilesHooksTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,14 @@

namespace OCA\Activity;

use OC\Files\Config\CachedMountFileInfo;
use OCA\Activity\Extension\Files;
use OCA\Activity\Extension\Files_Sharing;
use OCA\Activity\Tests\TestCase;
use OCP\Files\Config\IUserMountCache;
use OCP\Files\IRootFolder;
use OCP\Files\NotFoundException;
use OCP\IConfig;
use OCP\ILogger;
use OCP\Share;
use OCP\Share\IShareHelper;
Expand Down Expand Up @@ -61,6 +64,10 @@ class FilesHooksTest extends TestCase {
protected $shareHelper;
/** @var IURLGenerator|\PHPUnit_Framework_MockObject_MockObject */
protected $urlGenerator;
/** @var IUserMountCache|MockObject */
protected $userMountCache;
/** @var IConfig|MockObject */
protected $config;

protected function setUp(): void {
parent::setUp();
Expand All @@ -73,6 +80,8 @@ protected function setUp(): void {
$this->rootFolder = $this->createMock(IRootFolder::class);
$this->shareHelper = $this->createMock(IShareHelper::class);
$this->urlGenerator = $this->createMock(IURLGenerator::class);
$this->userMountCache = $this->createMock(IUserMountCache::class);
$this->config = $this->createMock(IConfig::class);

$this->filesHooks = $this->getFilesHooks();
}
Expand Down Expand Up @@ -107,6 +116,8 @@ protected function getFilesHooks(array $mockedMethods = [], $user = 'user') {
$this->urlGenerator,
$logger,
$currentUser,
$this->userMountCache,
$this->config,
])
->setMethods($mockedMethods)
->getMock();
Expand All @@ -123,7 +134,9 @@ protected function getFilesHooks(array $mockedMethods = [], $user = 'user') {
\OC::$server->getDatabaseConnection(),
$this->urlGenerator,
$logger,
$currentUser
$currentUser,
$this->userMountCache,
$this->config
);
}

Expand Down Expand Up @@ -233,11 +246,12 @@ public function dataAddNotificationsForFileAction() {
[['user', 'user1', 'user2'], 'stream', Files::TYPE_SHARE_RESTORED, ['user' => true]],
[['user', 'user1', 'user2'], 'email', Files::TYPE_SHARE_RESTORED, ['user' => 42]],
],
'mountcache_used' => false,
[
'user' => [
'subject' => 'restored_self',
'subject_params' => [[1337 => '/user/path']],
'path' => '/user/path',
'subject_params' => [[1337 => '/user/files/path']],
'path' => '/user/files/path',
'stream' => true,
'email' => 42,
],
Expand All @@ -248,11 +262,44 @@ public function dataAddNotificationsForFileAction() {
[['user', 'user1', 'user2'], 'stream', Files::TYPE_SHARE_RESTORED, ['user1' => true]],
[['user', 'user1', 'user2'], 'email', Files::TYPE_SHARE_RESTORED, []],
],
'mountcache_used' => false,
[
'user1' => [
'subject' => 'restored_by',
'subject_params' => [[1337 => '/user1/path'], 'user'],
'path' => '/user1/path',
'subject_params' => [[1337 => '/user1/files/path'], 'user'],
'path' => '/user1/files/path',
'stream' => true,
'email' => 0,
],
],
],
[
[
[['user', 'user1', 'user2'], 'stream', Files::TYPE_SHARE_RESTORED, ['user' => true]],
[['user', 'user1', 'user2'], 'email', Files::TYPE_SHARE_RESTORED, ['user' => 42]],
],
'mountcache_used' => true,
[
'user' => [
'subject' => 'restored_self',
'subject_params' => [[1337 => '/path']],
'path' => '/path',
'stream' => true,
'email' => 42,
],
],
],
[
[
[['user', 'user1', 'user2'], 'stream', Files::TYPE_SHARE_RESTORED, ['user1' => true]],
[['user', 'user1', 'user2'], 'email', Files::TYPE_SHARE_RESTORED, []],
],
'mountcache_used' => true,
[
'user1' => [
'subject' => 'restored_by',
'subject_params' => [[1337 => '/path'], 'user'],
'path' => '/path',
'stream' => true,
'email' => 0,
],
Expand All @@ -265,9 +312,10 @@ public function dataAddNotificationsForFileAction() {
* @dataProvider dataAddNotificationsForFileAction
*
* @param array $filterUsers
* @param bool $mountCacheUsed
* @param array $addNotifications
*/
public function testAddNotificationsForFileAction($filterUsers, $addNotifications) {
public function testAddNotificationsForFileAction($filterUsers, $mountCacheUsed, $addNotifications) {
$filesHooks = $this->getFilesHooks([
'getSourcePathAndOwner',
'getUserPathsFromPath',
Expand All @@ -284,13 +332,55 @@ public function testAddNotificationsForFileAction($filterUsers, $addNotification
->willReturn([
'ownerPath' => '/owner/path',
'users' => [
'user' => '/user/path',
'user1' => '/user1/path',
'user2' => '/user2/path',
'user' => '/user/files/path',
'user1' => '/user1/files/path',
'user2' => '/user2/files/path',
],
'remotes' => [],
]);

$this->config->expects($this->once())
->method('getSystemValueBool')
->with('activity_use_cached_mountpoints', false)
->willReturn($mountCacheUsed);
Copy link
Member

@nickvergessen nickvergessen May 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Undefined variable: mountCacheUsed

You added it in the doc block, but not the arguments list


if ($mountCacheUsed) {
$this->userMountCache->expects($this->once())
->method('getMountsForFileId')
->willReturn([
new CachedMountFileInfo(
$this->getUserMock('user'),
1,
1,
'/user/files/',
null,
'',
'path'
),
new CachedMountFileInfo(
$this->getUserMock('user1'),
1,
1,
'/user1/files/',
null,
'',
'path'
),
new CachedMountFileInfo(
$this->getUserMock('user2'),
1,
1,
'/user2/files/',
null,
'',
'path'
)
]);
} else {
$this->userMountCache->expects($this->never())
->method('getMountsForFileId');
}

$this->settings->expects($this->exactly(2))
->method('filterUsersBySetting')
->willReturnMap($filterUsers);
Expand Down Expand Up @@ -852,7 +942,7 @@ public function dataAddNotificationsForUser() {
['notAuthor', 'subject', ['parameter'], 42, 'path/subpath', 'path', true, false, true, Files::TYPE_SHARE_CREATED, false, false, 'files', false, true],
['notAuthor', 'subject', ['parameter'], 0, 'path/subpath', 'path', true, false, true, Files::TYPE_SHARE_CREATED, false, false, 'files', false, true],
['notAuthor', 'subject', ['parameter'], 0, 'path/subpath', 'path', true, false, true, Files::TYPE_SHARE_CREATED, false, false, 'files', false, true],
['notAuthor', 'subject', ['parameter'], 0, 'path/subpath','path/subpath', false, false, true, Files::TYPE_SHARE_CREATED, false, false, 'files', false, true],
['notAuthor', 'subject', ['parameter'], 0, 'path/subpath', 'path/subpath', false, false, true, Files::TYPE_SHARE_CREATED, false, false, 'files', false, true],
];
}

Expand Down