Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add move rename support #43

Merged
merged 2 commits into from
Oct 5, 2016
Merged

Add move rename support #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a229b1
Add support for rename operations
nickvergessen Sep 15, 2016
c2130a7
Add activity support for moving of files up/down/mixed
nickvergessen Sep 15, 2016
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
2 changes: 2 additions & 0 deletions lib/AppInfo/Application.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,8 @@ public function registerFilesActivity() {
Util::connectHook('OC_Filesystem', 'post_create', FilesHooksStatic::class, 'fileCreate');
Util::connectHook('OC_Filesystem', 'post_update', FilesHooksStatic::class, 'fileUpdate');
Util::connectHook('OC_Filesystem', 'delete', FilesHooksStatic::class, 'fileDelete');
Util::connectHook('OC_Filesystem', 'rename', FilesHooksStatic::class, 'fileMove');
Util::connectHook('OC_Filesystem', 'post_rename', FilesHooksStatic::class, 'fileMovePost');
Util::connectHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', FilesHooksStatic::class, 'fileRestore');
Util::connectHook('OCP\Share', 'post_shared', FilesHooksStatic::class, 'share');
Util::connectHook('OCP\Share', 'pre_unshare', FilesHooksStatic::class, 'unShare');
Expand Down
317 changes: 317 additions & 0 deletions lib/FilesHooks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,17 @@ class FilesHooks {
/** @var CurrentUser */
protected $currentUser;

/** @var string|bool */
protected $moveCase = false;
/** @var string[] */
protected $oldParentUsers;
/** @var string */
protected $oldParentPath;
/** @var string */
protected $oldParentOwner;
/** @var string */
protected $oldParentId;

/**
* Constructor
*
Expand Down Expand Up @@ -174,6 +185,312 @@ protected function addNotificationsForFileAction($filePath, $activityType, $subj
}
}

/**
* Collect some information for move/renames
*
* @param string $oldPath Path of the file that has been moved
* @param string $newPath Path of the file that has been moved
*/
public function fileMove($oldPath, $newPath) {
if (substr($oldPath, -5) === '.part' || substr($newPath, -5) === '.part') {
// Do not add activities for .part-files
$this->moveCase = false;
return;
}

$oldDir = dirname($oldPath);
$newDir = dirname($newPath);

if ($oldDir === $newDir) {
/**
* a/b moved to a/c
*
* Cases:
* - a/b shared: no visible change
* - a/ shared: rename
*/
$this->moveCase = 'rename';
return;
}

if (strpos($oldDir, $newDir) === 0) {
/**
* a/b/c moved to a/c
*
* Cases:
* - a/b/c shared: no visible change
* - a/b/ shared: delete
* - a/ shared: move/rename
*/
$this->moveCase = 'moveUp';
} else if (strpos($newDir, $oldDir) === 0) {
/**
* a/b moved to a/c/b
*
* Cases:
* - a/b shared: no visible change
* - a/c/ shared: add
* - a/ shared: move/rename
*/
$this->moveCase = 'moveDown';
} else {
/**
* a/b/c moved to a/d/c
*
* Cases:
* - a/b/c shared: no visible change
* - a/b/ shared: delete
* - a/d/ shared: add
* - a/ shared: move/rename
*/
$this->moveCase = 'moveCross';
}

list($this->oldParentPath, $this->oldParentOwner, $this->oldParentId) = $this->getSourcePathAndOwner($oldDir);
if ($this->oldParentId === 0) {
// Could not find the file for the owner ...
$this->moveCase = false;
return;
}
$this->oldParentUsers = $this->getUserPathsFromPath($this->oldParentPath, $this->oldParentOwner);
}


/**
* Store the move hook events
*
* @param string $oldPath Path of the file that has been moved
* @param string $newPath Path of the file that has been moved
*/
public function fileMovePost($oldPath, $newPath) {
// Do not add activities for .part-files
if ($this->moveCase === false) {
return;
}

switch ($this->moveCase) {
case 'rename':
$this->fileRenaming($oldPath, $newPath);
break;
case 'moveUp':
case 'moveDown':
case 'moveCross':
$this->fileMoving($oldPath, $newPath);
break;
}

$this->moveCase = false;
}


/**
* Renaming a file inside the same folder (a/b to a/c)
*
* @param string $oldPath
* @param string $newPath
*/
protected function fileRenaming($oldPath, $newPath) {
$dirName = dirname($newPath);
$fileName = basename($newPath);
$oldFileName = basename($oldPath);

list(, , $fileId) = $this->getSourcePathAndOwner($newPath);
list($parentPath, $parentOwner, $parentId) = $this->getSourcePathAndOwner($dirName);
if ($fileId === 0 || $parentId === 0) {
// Could not find the file for the owner ...
return;
}
$affectedUsers = $this->getUserPathsFromPath($parentPath, $parentOwner);

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

foreach ($affectedUsers as $user => $path) {
if (empty($filteredStreamUsers[$user]) && empty($filteredEmailUsers[$user])) {
continue;
}

if ($user === $this->currentUser->getUID()) {
$userSubject = 'renamed_self';
$userParams = [
[$fileId => $path . '/' . $fileName],
[$fileId => $path . '/' . $oldFileName],
];
} else {
$userSubject = 'renamed_by';
$userParams = [
[$fileId => $path . '/' . $fileName],
$this->currentUser->getUserIdentifier(),
[$fileId => $path . '/' . $oldFileName],
];
}

$this->addNotificationsForUser(
$user, $userSubject, $userParams,
$fileId, $path . '/' . $fileName, true,
!empty($filteredStreamUsers[$user]),
!empty($filteredEmailUsers[$user]) ? $filteredEmailUsers[$user] : 0,
Files::TYPE_SHARE_CHANGED
);
}
}

/**
* Moving a file from one folder to another
*
* @param string $oldPath
* @param string $newPath
*/
protected function fileMoving($oldPath, $newPath) {
$dirName = dirname($newPath);
$fileName = basename($newPath);
$oldFileName = basename($oldPath);

list(, , $fileId) = $this->getSourcePathAndOwner($newPath);
list($parentPath, $parentOwner, $parentId) = $this->getSourcePathAndOwner($dirName);
if ($fileId === 0 || $parentId === 0) {
// Could not find the file for the owner ...
return;
}
$affectedUsers = $this->getUserPathsFromPath($parentPath, $parentOwner);

$beforeUsers = array_keys($this->oldParentUsers);
$afterUsers = array_keys($affectedUsers);

$deleteUsers = array_diff($beforeUsers, $afterUsers);
$this->generateDeleteActivities($deleteUsers, $this->oldParentUsers, $fileId, $oldFileName);

$addUsers = array_diff($afterUsers, $beforeUsers);
$this->generateAddActivities($addUsers, $affectedUsers, $fileId, $fileName);

$moveUsers = array_intersect($beforeUsers, $afterUsers);
$this->generateMoveActivities($moveUsers, $this->oldParentUsers, $affectedUsers, $fileId, $oldFileName, $fileName);
}

/**
* @param string[] $users
* @param string[] $pathMap
* @param int $fileId
* @param string $oldFileName
*/
protected function generateDeleteActivities($users, $pathMap, $fileId, $oldFileName) {
if (empty($users)) {
return;
}

$filteredStreamUsers = $this->userSettings->filterUsersBySetting($users, 'stream', Files::TYPE_SHARE_DELETED);
$filteredEmailUsers = $this->userSettings->filterUsersBySetting($users, 'email', Files::TYPE_SHARE_DELETED);

foreach ($users as $user) {
if (empty($filteredStreamUsers[$user]) && empty($filteredEmailUsers[$user])) {
continue;
}

$path = $pathMap[$user];

if ($user === $this->currentUser->getUID()) {
$userSubject = 'deleted_self';
$userParams = [[$fileId => $path . '/' . $oldFileName]];
} else {
$userSubject = 'deleted_by';
$userParams = [[$fileId => $path . '/' . $oldFileName], $this->currentUser->getUserIdentifier()];
}

$this->addNotificationsForUser(
$user, $userSubject, $userParams,
$fileId, $path . '/' . $oldFileName, true,
!empty($filteredStreamUsers[$user]),
!empty($filteredEmailUsers[$user]) ? $filteredEmailUsers[$user] : 0,
Files::TYPE_SHARE_DELETED
);
}
}

/**
* @param string[] $users
* @param string[] $pathMap
* @param int $fileId
* @param string $fileName
*/
protected function generateAddActivities($users, $pathMap, $fileId, $fileName) {
if (empty($users)) {
return;
}

$filteredStreamUsers = $this->userSettings->filterUsersBySetting($users, 'stream', Files::TYPE_SHARE_CREATED);
$filteredEmailUsers = $this->userSettings->filterUsersBySetting($users, 'email', Files::TYPE_SHARE_CREATED);

foreach ($users as $user) {
if (empty($filteredStreamUsers[$user]) && empty($filteredEmailUsers[$user])) {
continue;
}

$path = $pathMap[$user];

if ($user === $this->currentUser->getUID()) {
$userSubject = 'created_self';
$userParams = [[$fileId => $path . '/' . $fileName]];
} else {
$userSubject = 'created_by';
$userParams = [[$fileId => $path . '/' . $fileName], $this->currentUser->getUserIdentifier()];
}

$this->addNotificationsForUser(
$user, $userSubject, $userParams,
$fileId, $path . '/' . $fileName, true,
!empty($filteredStreamUsers[$user]),
!empty($filteredEmailUsers[$user]) ? $filteredEmailUsers[$user] : 0,
Files::TYPE_SHARE_CREATED
);
}
}

/**
* @param string[] $users
* @param string[] $beforePathMap
* @param string[] $afterPathMap
* @param int $fileId
* @param string $oldFileName
* @param string $fileName
*/
protected function generateMoveActivities($users, $beforePathMap, $afterPathMap, $fileId, $oldFileName, $fileName) {
if (empty($users)) {
return;
}

$filteredStreamUsers = $this->userSettings->filterUsersBySetting($users, 'stream', Files::TYPE_SHARE_CHANGED);
$filteredEmailUsers = $this->userSettings->filterUsersBySetting($users, 'email', Files::TYPE_SHARE_CHANGED);

foreach ($users as $user) {
if (empty($filteredStreamUsers[$user]) && empty($filteredEmailUsers[$user])) {
continue;
}

if ($user === $this->currentUser->getUID()) {
$userSubject = 'moved_self';
$userParams = [
[$fileId => $afterPathMap[$user] . '/' . $fileName],
[$fileId => $beforePathMap[$user] . '/' . $oldFileName],
];
} else {
$userSubject = 'moved_by';
$userParams = [
[$fileId => $afterPathMap[$user] . '/' . $fileName],
$this->currentUser->getUserIdentifier(),
[$fileId => $beforePathMap[$user] . '/' . $oldFileName],
];
}

$this->addNotificationsForUser(
$user, $userSubject, $userParams,
$fileId, $afterPathMap[$user] . '/' . $fileName, true,
!empty($filteredStreamUsers[$user]),
!empty($filteredEmailUsers[$user]) ? $filteredEmailUsers[$user] : 0,
Files::TYPE_SHARE_CHANGED
);
}
}

/**
* Returns a "username => path" map for all affected users
*
Expand Down
19 changes: 17 additions & 2 deletions lib/FilesHooksStatic.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@ class FilesHooksStatic {
* @return FilesHooks
*/
static protected function getHooks() {
$app = new AppInfo\Application();
return $app->getContainer()->query(FilesHooks::class);
return \OC::$server->query(FilesHooks::class);
}

/**
Expand All @@ -62,6 +61,22 @@ public static function fileDelete($params) {
self::getHooks()->fileDelete($params['path']);
}

/**
* Store the rename hook events
* @param array $params The hook params
*/
public static function fileMove($params) {
self::getHooks()->fileMove($params['oldpath'], $params['newpath']);
}

/**
* Store the rename hook events
* @param array $params The hook params
*/
public static function fileMovePost($params) {
self::getHooks()->fileMovePost($params['oldpath'], $params['newpath']);
}

/**
* Store the restore hook events
* @param array $params The hook params
Expand Down