|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types=1); |
| 4 | + |
| 5 | +/*! |
| 6 | + * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors |
| 7 | + * SPDX-License-Identifier: AGPL-3.0-or-later |
| 8 | + */ |
| 9 | +namespace OCA\Files_Versions; |
| 10 | + |
| 11 | +use OCA\Files_Versions\Events\CreateVersionEvent; |
| 12 | +use OCA\WorkflowEngine\Entity\File as FileEntity; |
| 13 | +use OCP\EventDispatcher\Event; |
| 14 | +use OCP\Files\Folder; |
| 15 | +use OCP\IL10N; |
| 16 | +use OCP\IURLGenerator; |
| 17 | +use OCP\WorkflowEngine\IComplexOperation; |
| 18 | +use OCP\WorkflowEngine\IManager; |
| 19 | +use OCP\WorkflowEngine\IRuleMatcher; |
| 20 | +use OCP\WorkflowEngine\ISpecificOperation; |
| 21 | +use Psr\Log\LoggerInterface; |
| 22 | + |
| 23 | +class BlockVersioningOperation implements ISpecificOperation, IComplexOperation { |
| 24 | + |
| 25 | + public function __construct( |
| 26 | + private readonly IL10N $l10n, |
| 27 | + private readonly FileEntity $fileEntity, |
| 28 | + private readonly LoggerInterface $logger, |
| 29 | + private readonly IURLGenerator $urlGenerator, |
| 30 | + ) { |
| 31 | + } |
| 32 | + |
| 33 | + #[\Override] |
| 34 | + public function getEntityId(): string { |
| 35 | + return FileEntity::class; |
| 36 | + } |
| 37 | + |
| 38 | + #[\Override] |
| 39 | + public function getDisplayName(): string { |
| 40 | + return $this->l10n->t('Block file versioning'); |
| 41 | + } |
| 42 | + |
| 43 | + #[\Override] |
| 44 | + public function getDescription(): string { |
| 45 | + return $this->l10n->t('Automatic tag based blocking of file version creation.'); |
| 46 | + } |
| 47 | + |
| 48 | + #[\Override] |
| 49 | + public function getIcon(): string { |
| 50 | + return $this->urlGenerator->imagePath('files_versions', 'app.svg'); |
| 51 | + } |
| 52 | + |
| 53 | + #[\Override] |
| 54 | + public function isAvailableForScope(int $scope): bool { |
| 55 | + return $scope === IManager::SCOPE_ADMIN; |
| 56 | + } |
| 57 | + |
| 58 | + #[\Override] |
| 59 | + public function validateOperation(string $name, array $checks, string $operation): void { |
| 60 | + if (empty($checks)) { |
| 61 | + throw new \UnexpectedValueException($this->l10n->t('No rule given')); |
| 62 | + } |
| 63 | + } |
| 64 | + |
| 65 | + #[\Override] |
| 66 | + public function onEvent(string $eventName, Event $event, IRuleMatcher $ruleMatcher): void { |
| 67 | + if ($eventName !== CreateVersionEvent::class || !($event instanceof CreateVersionEvent)) { |
| 68 | + return; |
| 69 | + } |
| 70 | + |
| 71 | + $node = $event->getNode(); |
| 72 | + $path = $node->getInternalPath(); |
| 73 | + |
| 74 | + $ruleMatcher->setFileInfo( |
| 75 | + $node->getStorage(), |
| 76 | + $path, |
| 77 | + $node instanceof Folder, |
| 78 | + ); |
| 79 | + $ruleMatcher->setEntitySubject($this->fileEntity, $node); |
| 80 | + $ruleMatcher->setOperation($this); |
| 81 | + $flows = $ruleMatcher->getFlows(); |
| 82 | + |
| 83 | + if ($flows !== []) { |
| 84 | + $this->logger->debug('Blocking version creation due to matching workflow rules', [ |
| 85 | + 'path' => $path, |
| 86 | + ]); |
| 87 | + $event->disableVersions(); |
| 88 | + } |
| 89 | + } |
| 90 | + |
| 91 | + #[\Override] |
| 92 | + public function getTriggerHint(): string { |
| 93 | + return $this->l10n->t('A new version is created'); // TRANSLATORS: This will be shown as "When: " "A new version is created" |
| 94 | + } |
| 95 | +} |
0 commit comments