mirror of https://github.com/nextcloud/server.git
Merge pull request #44069 from nextcloud/artonge/fix/split_live_photo_listener
Split live photo listener to extract trashbin specific code into its own listenerfix/session/transactional-remember-me-renewal
Louis
3 months ago
committed by
GitHub
commit
dd26fb2ba4
@ -0,0 +1,52 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2024 Louis Chemineau <louis@chmn.me>
|
||||
*
|
||||
* @author Louis Chemineau <louis@chmn.me>
|
||||
*
|
||||
* @license GNU AGPL version 3 or any later version
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
namespace OCA\Files\Service;
|
||||
|
||||
use OCP\FilesMetadata\Exceptions\FilesMetadataNotFoundException;
|
||||
use OCP\FilesMetadata\IFilesMetadataManager;
|
||||
|
||||
class LivePhotosService {
|
||||
public function __construct(
|
||||
private IFilesMetadataManager $filesMetadataManager,
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the associated live photo for a given file id
|
||||
*/
|
||||
public function getLivePhotoPeerId(int $fileId): ?int {
|
||||
try {
|
||||
$metadata = $this->filesMetadataManager->getMetadata($fileId);
|
||||
} catch (FilesMetadataNotFoundException $ex) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!$metadata->hasKey('files-live-photo')) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return (int)$metadata->getString('files-live-photo');
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,148 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2023 Louis Chemineau <louis@chmn.me>
|
||||
*
|
||||
* @author Louis Chemineau <louis@chmn.me>
|
||||
*
|
||||
* @license GNU AGPL version 3 or any later version
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
namespace OCA\Files_Trashbin\Listeners;
|
||||
|
||||
use OCA\Files\Service\LivePhotosService;
|
||||
use OCA\Files_Trashbin\Events\BeforeNodeRestoredEvent;
|
||||
use OCA\Files_Trashbin\Trash\ITrashItem;
|
||||
use OCA\Files_Trashbin\Trash\ITrashManager;
|
||||
use OCP\EventDispatcher\Event;
|
||||
use OCP\EventDispatcher\IEventListener;
|
||||
use OCP\Files\Folder;
|
||||
use OCP\Files\Node;
|
||||
use OCP\Files\NotFoundException;
|
||||
use OCP\Files\NotPermittedException;
|
||||
use OCP\IUserSession;
|
||||
|
||||
/**
|
||||
* @template-implements IEventListener<BeforeNodeRestoredEvent>
|
||||
*/
|
||||
class SyncLivePhotosListener implements IEventListener {
|
||||
/** @var Array<int, bool> */
|
||||
private array $pendingRestores = [];
|
||||
|
||||
public function __construct(
|
||||
private ?IUserSession $userSession,
|
||||
private ITrashManager $trashManager,
|
||||
private LivePhotosService $livePhotosService,
|
||||
) {
|
||||
}
|
||||
|
||||
public function handle(Event $event): void {
|
||||
if ($this->userSession === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var BeforeNodeRestoredEvent $event */
|
||||
$peerFileId = $this->livePhotosService->getLivePhotoPeerId($event->getSource()->getId());
|
||||
|
||||
if ($peerFileId === null) {
|
||||
return; // Not a live photo.
|
||||
}
|
||||
|
||||
// Check the user's trashbin.
|
||||
$user = $this->userSession->getUser();
|
||||
if ($user === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
$peerFile = $this->trashManager->getTrashNodeById($user, $peerFileId);
|
||||
|
||||
if ($peerFile === null) {
|
||||
return; // Peer file not found.
|
||||
}
|
||||
|
||||
$this->handleRestore($event, $peerFile);
|
||||
}
|
||||
|
||||
/**
|
||||
* During restore event, we trigger another recursive restore on the peer file.
|
||||
* Restore operations on the .mov file directly are currently blocked.
|
||||
* The event listener being singleton, we can store the current state
|
||||
* of pending restores inside the 'pendingRestores' property,
|
||||
* to prevent infinite recursivity.
|
||||
*/
|
||||
private function handleRestore(BeforeNodeRestoredEvent $event, Node $peerFile): void {
|
||||
$sourceFile = $event->getSource();
|
||||
|
||||
if ($sourceFile->getMimetype() === 'video/quicktime') {
|
||||
if (isset($this->pendingRestores[$peerFile->getId()])) {
|
||||
unset($this->pendingRestores[$peerFile->getId()]);
|
||||
return;
|
||||
} else {
|
||||
$event->abortOperation(new NotPermittedException("Cannot restore the video part of a live photo"));
|
||||
}
|
||||
} else {
|
||||
$user = $this->userSession?->getUser();
|
||||
if ($user === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
$peerTrashItem = $this->trashManager->getTrashNodeById($user, $peerFile->getId());
|
||||
// Peer file is not in the bin, no need to restore it.
|
||||
if ($peerTrashItem === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
$trashRoot = $this->trashManager->listTrashRoot($user);
|
||||
$trashItem = $this->getTrashItem($trashRoot, $peerFile->getInternalPath());
|
||||
|
||||
if ($trashItem === null) {
|
||||
$event->abortOperation(new NotFoundException("Couldn't find peer file in trashbin"));
|
||||
}
|
||||
|
||||
$this->pendingRestores[$sourceFile->getId()] = true;
|
||||
try {
|
||||
$this->trashManager->restoreItem($trashItem);
|
||||
} catch (\Throwable $ex) {
|
||||
$event->abortOperation($ex);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* There is currently no method to restore a file based on its fileId or path.
|
||||
* So we have to manually find a ITrashItem from the trash item list.
|
||||
* TODO: This should be replaced by a proper method in the TrashManager.
|
||||
*/
|
||||
private function getTrashItem(array $trashFolder, string $path): ?ITrashItem {
|
||||
foreach($trashFolder as $trashItem) {
|
||||
if (str_starts_with($path, "files_trashbin/files".$trashItem->getTrashPath())) {
|
||||
if ($path === "files_trashbin/files".$trashItem->getTrashPath()) {
|
||||
return $trashItem;
|
||||
}
|
||||
|
||||
if ($trashItem instanceof Folder) {
|
||||
$node = $this->getTrashItem($trashItem->getDirectoryListing(), $path);
|
||||
if ($node !== null) {
|
||||
return $node;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,215 @@
|
||||
/**
|
||||
* @copyright Copyright (c) 2024 Louis Chmn <louis@chmn.me>
|
||||
*
|
||||
* @author Louis Chmn <louis@chmn.me>
|
||||
*
|
||||
* @license AGPL-3.0-or-later
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
import type { User } from '@nextcloud/cypress'
|
||||
import { closeSidebar, copyFile, getRowForFile, getRowForFileId, renameFile, triggerActionForFile, triggerInlineActionForFileId } from './FilesUtils'
|
||||
|
||||
/**
|
||||
*
|
||||
* @param label
|
||||
*/
|
||||
function refreshView(label: string) {
|
||||
cy.intercept('PROPFIND', /\/remote.php\/dav\//).as('propfind')
|
||||
cy.get('[data-cy-files-content-breadcrumbs]').contains(label).click()
|
||||
cy.wait('@propfind')
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param user
|
||||
* @param fileName
|
||||
* @param domain
|
||||
* @param requesttoken
|
||||
* @param metadata
|
||||
*/
|
||||
function setMetadata(user: User, fileName: string, domain: string, requesttoken: string, metadata: object) {
|
||||
cy.request({
|
||||
method: 'PROPPATCH',
|
||||
url: `http://${domain}/remote.php/dav/files/${user.userId}/${fileName}`,
|
||||
auth: { user: user.userId, pass: user.password },
|
||||
headers: {
|
||||
requesttoken,
|
||||
},
|
||||
body: `<?xml version="1.0"?>
|
||||
<d:propertyupdate xmlns:d="DAV:" xmlns:nc="http://nextcloud.org/ns">
|
||||
<d:set>
|
||||
<d:prop>
|
||||
${Object.entries(metadata).map(([key, value]) => `<${key}>${value}</${key}>`).join('\n')}
|
||||
</d:prop>
|
||||
</d:set>
|
||||
</d:propertyupdate>`,
|
||||
})
|
||||
}
|
||||
|
||||
describe('Files: Live photos', { testIsolation: true }, () => {
|
||||
let currentUser: User
|
||||
let randomFileName: string
|
||||
let jpgFileId: number
|
||||
let movFileId: number
|
||||
let hostname: string
|
||||
let requesttoken: string
|
||||
|
||||
before(() => {
|
||||
cy.createRandomUser().then((user) => {
|
||||
currentUser = user
|
||||
cy.login(currentUser)
|
||||
cy.visit('/apps/files')
|
||||
})
|
||||
|
||||
cy.url().then(url => { hostname = new URL(url).hostname })
|
||||
})
|
||||
|
||||
beforeEach(() => {
|
||||
randomFileName = Math.random().toString(36).replace(/[^a-z]+/g, '').substring(0, 10)
|
||||
|
||||
cy.uploadContent(currentUser, new Blob(['jpg file'], { type: 'image/jpg' }), 'image/jpg', `/${randomFileName}.jpg`)
|
||||
.then(response => { jpgFileId = parseInt(response.headers['oc-fileid']) })
|
||||
cy.uploadContent(currentUser, new Blob(['mov file'], { type: 'video/mov' }), 'video/mov', `/${randomFileName}.mov`)
|
||||
.then(response => { movFileId = parseInt(response.headers['oc-fileid']) })
|
||||
|
||||
cy.login(currentUser)
|
||||
cy.visit('/apps/files')
|
||||
|
||||
cy.get('head').invoke('attr', 'data-requesttoken').then(_requesttoken => { requesttoken = _requesttoken as string })
|
||||
|
||||
cy.then(() => {
|
||||
setMetadata(currentUser, `${randomFileName}.jpg`, hostname, requesttoken, { 'nc:metadata-files-live-photo': movFileId })
|
||||
setMetadata(currentUser, `${randomFileName}.mov`, hostname, requesttoken, { 'nc:metadata-files-live-photo': jpgFileId })
|
||||
})
|
||||
|
||||
cy.then(() => {
|
||||
cy.visit(`/apps/files/files/${jpgFileId}`) // Refresh and scroll to the .jpg file.
|
||||
closeSidebar()
|
||||
})
|
||||
})
|
||||
|
||||
it('Only renders the .jpg file', () => {
|
||||
getRowForFileId(jpgFileId).should('have.length', 1)
|
||||
getRowForFileId(movFileId).should('have.length', 0)
|
||||
})
|
||||
|
||||
context("'Show hidden files' is enabled", () => {
|
||||
before(() => {
|
||||
cy.login(currentUser)
|
||||
cy.visit('/apps/files')
|
||||
cy.get('[data-cy-files-navigation-settings-button]').click()
|
||||
// Force:true because the checkbox is hidden by the pretty UI.
|
||||
cy.get('[data-cy-files-settings-setting="show_hidden"] input').check({ force: true })
|
||||
})
|
||||
|
||||
it("Shows both files when 'Show hidden files' is enabled", () => {
|
||||
getRowForFileId(jpgFileId).should('have.length', 1).invoke('attr', 'data-cy-files-list-row-name').should('equal', `${randomFileName}.jpg`)
|
||||
getRowForFileId(movFileId).should('have.length', 1).invoke('attr', 'data-cy-files-list-row-name').should('equal', `${randomFileName}.mov`)
|
||||
})
|
||||
|
||||
it('Copies both files when copying the .jpg', () => {
|
||||
copyFile(`${randomFileName}.jpg`, '.')
|
||||
refreshView('All files')
|
||||
|
||||
getRowForFile(`${randomFileName}.jpg`).should('have.length', 1)
|
||||
getRowForFile(`${randomFileName}.mov`).should('have.length', 1)
|
||||
getRowForFile(`${randomFileName} (copy).jpg`).should('have.length', 1)
|
||||
getRowForFile(`${randomFileName} (copy).mov`).should('have.length', 1)
|
||||
})
|
||||
|
||||
it('Copies both files when copying the .mov', () => {
|
||||
copyFile(`${randomFileName}.mov`, '.')
|
||||
refreshView('All files')
|
||||
|
||||
getRowForFile(`${randomFileName}.mov`).should('have.length', 1)
|
||||
getRowForFile(`${randomFileName} (copy).jpg`).should('have.length', 1)
|
||||
getRowForFile(`${randomFileName} (copy).mov`).should('have.length', 1)
|
||||
})
|
||||
|
||||
it('Moves files when moving the .jpg', () => {
|
||||
renameFile(`${randomFileName}.jpg`, `${randomFileName}_moved.jpg`)
|
||||
refreshView('All files')
|
||||
|
||||
getRowForFileId(jpgFileId).invoke('attr', 'data-cy-files-list-row-name').should('equal', `${randomFileName}_moved.jpg`)
|
||||
getRowForFileId(movFileId).invoke('attr', 'data-cy-files-list-row-name').should('equal', `${randomFileName}_moved.mov`)
|
||||
})
|
||||
|
||||
it('Moves files when moving the .mov', () => {
|
||||
renameFile(`${randomFileName}.mov`, `${randomFileName}_moved.mov`)
|
||||
refreshView('All files')
|
||||
|
||||
getRowForFileId(jpgFileId).invoke('attr', 'data-cy-files-list-row-name').should('equal', `${randomFileName}_moved.jpg`)
|
||||
getRowForFileId(movFileId).invoke('attr', 'data-cy-files-list-row-name').should('equal', `${randomFileName}_moved.mov`)
|
||||
})
|
||||
|
||||
it('Deletes files when deleting the .jpg', () => {
|
||||
triggerActionForFile(`${randomFileName}.jpg`, 'delete')
|
||||
refreshView('All files')
|
||||
|
||||
getRowForFile(`${randomFileName}.jpg`).should('have.length', 0)
|
||||
getRowForFile(`${randomFileName}.mov`).should('have.length', 0)
|
||||
|
||||
cy.visit('/apps/files/trashbin')
|
||||
|
||||
getRowForFileId(jpgFileId).invoke('attr', 'data-cy-files-list-row-name').should('to.match', new RegExp(`^${randomFileName}.jpg\\.d[0-9]+$`))
|
||||
getRowForFileId(movFileId).invoke('attr', 'data-cy-files-list-row-name').should('to.match', new RegExp(`^${randomFileName}.mov\\.d[0-9]+$`))
|
||||
})
|
||||
|
||||
it('Block deletion when deleting the .mov', () => {
|
||||
triggerActionForFile(`${randomFileName}.mov`, 'delete')
|
||||
refreshView('All files')
|
||||
|
||||
getRowForFile(`${randomFileName}.jpg`).should('have.length', 1)
|
||||
getRowForFile(`${randomFileName}.mov`).should('have.length', 1)
|
||||
|
||||
cy.visit('/apps/files/trashbin')
|
||||
|
||||
getRowForFileId(jpgFileId).should('have.length', 0)
|
||||
getRowForFileId(movFileId).should('have.length', 0)
|
||||
})
|
||||
|
||||
it('Restores files when restoring the .jpg', () => {
|
||||
triggerActionForFile(`${randomFileName}.jpg`, 'delete')
|
||||
cy.visit('/apps/files/trashbin')
|
||||
triggerInlineActionForFileId(jpgFileId, 'restore')
|
||||
refreshView('Deleted files')
|
||||
|
||||
getRowForFile(`${randomFileName}.jpg`).should('have.length', 0)
|
||||
getRowForFile(`${randomFileName}.mov`).should('have.length', 0)
|
||||
|
||||
cy.visit('/apps/files')
|
||||
|
||||
getRowForFile(`${randomFileName}.jpg`).should('have.length', 1)
|
||||
getRowForFile(`${randomFileName}.mov`).should('have.length', 1)
|
||||
})
|
||||
|
||||
it('Blocks restoration when restoring the .mov', () => {
|
||||
triggerActionForFile(`${randomFileName}.jpg`, 'delete')
|
||||
cy.visit('/apps/files/trashbin')
|
||||
triggerInlineActionForFileId(movFileId, 'restore')
|
||||
refreshView('Deleted files')
|
||||
|
||||
getRowForFileId(jpgFileId).should('have.length', 1)
|
||||
getRowForFileId(movFileId).should('have.length', 1)
|
||||
|
||||
cy.visit('/apps/files')
|
||||
|
||||
getRowForFile(`${randomFileName}.jpg`).should('have.length', 0)
|
||||
getRowForFile(`${randomFileName}.mov`).should('have.length', 0)
|
||||
})
|
||||
})
|
||||
})
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue