Inspection of "Merge pull request #22112 from nextcloud/enh/noid/..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5b6246...3f1c48 )

by Morris

created 2020-08-06 07:36 UTC

Status

Indentation +15 added lines, -15 removed lines patch added patch discarded remove patch

@@ -40,20 +40,20 @@
 block discarded – undo
  */
 interface IContextPortation {
 
-	/**
-	 * All relevant context identifiers that are needed to restore the state
-	 * of an entity shall be returned with this method. The resulting array
-	 * must be JSON-serializable.
-	 *
-	 * @since 20.0.0
-	 */
-	public function exportContextIDs(): array;
+    /**
+     * All relevant context identifiers that are needed to restore the state
+     * of an entity shall be returned with this method. The resulting array
+     * must be JSON-serializable.
+     *
+     * @since 20.0.0
+     */
+    public function exportContextIDs(): array;
 
-	/**
-	 * This method receives the array as returned by `exportContextIDs()` in
-	 * order to restore the state of the IEntity if necessary.
-	 *
-	 * @since 20.0.0
-	 */
-	public function importContextIDs(array $contextIDs): void;
+    /**
+     * This method receives the array as returned by `exportContextIDs()` in
+     * order to restore the state of the IEntity if necessary.
+     *
+     * @since 20.0.0
+     */
+    public function importContextIDs(array $contextIDs): void;
 }

Please login to merge, or discard this patch.

apps/workflowengine/lib/Entity/File.php 2 patches

Indentation +207 added lines, -207 removed lines patch added patch discarded remove patch

@@ -49,225 +49,225 @@
 block discarded – undo
 use OCP\WorkflowEngine\IRuleMatcher;
 
 class File implements IEntity, IDisplayText, IUrl, IContextPortation {
-	private const EVENT_NAMESPACE = '\OCP\Files::';
+    private const EVENT_NAMESPACE = '\OCP\Files::';
 
-	/** @var IL10N */
-	protected $l10n;
-	/** @var IURLGenerator */
-	protected $urlGenerator;
-	/** @var IRootFolder */
-	protected $root;
-	/** @var ILogger */
-	protected $logger;
-	/** @var string */
-	protected $eventName;
-	/** @var Event */
-	protected $event;
-	/** @var ShareManager */
-	private $shareManager;
-	/** @var IUserSession */
-	private $userSession;
-	/** @var ISystemTagManager */
-	private $tagManager;
-	/** @var ?Node */
-	private $node;
-	/** @var ?IUser */
-	private $actingUser = null;
-	/** @var IUserManager */
-	private $userManager;
+    /** @var IL10N */
+    protected $l10n;
+    /** @var IURLGenerator */
+    protected $urlGenerator;
+    /** @var IRootFolder */
+    protected $root;
+    /** @var ILogger */
+    protected $logger;
+    /** @var string */
+    protected $eventName;
+    /** @var Event */
+    protected $event;
+    /** @var ShareManager */
+    private $shareManager;
+    /** @var IUserSession */
+    private $userSession;
+    /** @var ISystemTagManager */
+    private $tagManager;
+    /** @var ?Node */
+    private $node;
+    /** @var ?IUser */
+    private $actingUser = null;
+    /** @var IUserManager */
+    private $userManager;
 
-	public function __construct(
-		IL10N $l10n,
-		IURLGenerator $urlGenerator,
-		IRootFolder $root,
-		ILogger $logger,
-		ShareManager $shareManager,
-		IUserSession $userSession,
-		ISystemTagManager $tagManager,
-		IUserManager $userManager
-	) {
-		$this->l10n = $l10n;
-		$this->urlGenerator = $urlGenerator;
-		$this->root = $root;
-		$this->logger = $logger;
-		$this->shareManager = $shareManager;
-		$this->userSession = $userSession;
-		$this->tagManager = $tagManager;
-		$this->userManager = $userManager;
-	}
+    public function __construct(
+        IL10N $l10n,
+        IURLGenerator $urlGenerator,
+        IRootFolder $root,
+        ILogger $logger,
+        ShareManager $shareManager,
+        IUserSession $userSession,
+        ISystemTagManager $tagManager,
+        IUserManager $userManager
+    ) {
+        $this->l10n = $l10n;
+        $this->urlGenerator = $urlGenerator;
+        $this->root = $root;
+        $this->logger = $logger;
+        $this->shareManager = $shareManager;
+        $this->userSession = $userSession;
+        $this->tagManager = $tagManager;
+        $this->userManager = $userManager;
+    }
 
-	public function getName(): string {
-		return $this->l10n->t('File');
-	}
+    public function getName(): string {
+        return $this->l10n->t('File');
+    }
 
-	public function getIcon(): string {
-		return $this->urlGenerator->imagePath('core', 'categories/files.svg');
-	}
+    public function getIcon(): string {
+        return $this->urlGenerator->imagePath('core', 'categories/files.svg');
+    }
 
-	public function getEvents(): array {
-		return [
-			new GenericEntityEvent($this->l10n->t('File created'), self::EVENT_NAMESPACE . 'postCreate'),
-			new GenericEntityEvent($this->l10n->t('File updated'), self::EVENT_NAMESPACE . 'postWrite'),
-			new GenericEntityEvent($this->l10n->t('File renamed'), self::EVENT_NAMESPACE . 'postRename'),
-			new GenericEntityEvent($this->l10n->t('File deleted'), self::EVENT_NAMESPACE . 'postDelete'),
-			new GenericEntityEvent($this->l10n->t('File accessed'), self::EVENT_NAMESPACE . 'postTouch'),
-			new GenericEntityEvent($this->l10n->t('File copied'), self::EVENT_NAMESPACE . 'postCopy'),
-			new GenericEntityEvent($this->l10n->t('Tag assigned'), MapperEvent::EVENT_ASSIGN),
-		];
-	}
+    public function getEvents(): array {
+        return [
+            new GenericEntityEvent($this->l10n->t('File created'), self::EVENT_NAMESPACE . 'postCreate'),
+            new GenericEntityEvent($this->l10n->t('File updated'), self::EVENT_NAMESPACE . 'postWrite'),
+            new GenericEntityEvent($this->l10n->t('File renamed'), self::EVENT_NAMESPACE . 'postRename'),
+            new GenericEntityEvent($this->l10n->t('File deleted'), self::EVENT_NAMESPACE . 'postDelete'),
+            new GenericEntityEvent($this->l10n->t('File accessed'), self::EVENT_NAMESPACE . 'postTouch'),
+            new GenericEntityEvent($this->l10n->t('File copied'), self::EVENT_NAMESPACE . 'postCopy'),
+            new GenericEntityEvent($this->l10n->t('Tag assigned'), MapperEvent::EVENT_ASSIGN),
+        ];
+    }
 
-	public function prepareRuleMatcher(IRuleMatcher $ruleMatcher, string $eventName, Event $event): void {
-		if (!$event instanceof GenericEvent && !$event instanceof MapperEvent) {
-			return;
-		}
-		$this->eventName = $eventName;
-		$this->event = $event;
-		$this->actingUser = $this->actingUser ?? $this->userSession->getUser();
-		try {
-			$node = $this->getNode();
-			$ruleMatcher->setEntitySubject($this, $node);
-			$ruleMatcher->setFileInfo($node->getStorage(), $node->getInternalPath());
-		} catch (NotFoundException $e) {
-			// pass
-		}
-	}
+    public function prepareRuleMatcher(IRuleMatcher $ruleMatcher, string $eventName, Event $event): void {
+        if (!$event instanceof GenericEvent && !$event instanceof MapperEvent) {
+            return;
+        }
+        $this->eventName = $eventName;
+        $this->event = $event;
+        $this->actingUser = $this->actingUser ?? $this->userSession->getUser();
+        try {
+            $node = $this->getNode();
+            $ruleMatcher->setEntitySubject($this, $node);
+            $ruleMatcher->setFileInfo($node->getStorage(), $node->getInternalPath());
+        } catch (NotFoundException $e) {
+            // pass
+        }
+    }
 
-	public function isLegitimatedForUserId(string $uid): bool {
-		try {
-			$node = $this->getNode();
-			if ($node->getOwner()->getUID() === $uid) {
-				return true;
-			}
-			$acl = $this->shareManager->getAccessList($node, true, true);
-			return array_key_exists($uid, $acl['users']);
-		} catch (NotFoundException $e) {
-			return false;
-		}
-	}
+    public function isLegitimatedForUserId(string $uid): bool {
+        try {
+            $node = $this->getNode();
+            if ($node->getOwner()->getUID() === $uid) {
+                return true;
+            }
+            $acl = $this->shareManager->getAccessList($node, true, true);
+            return array_key_exists($uid, $acl['users']);
+        } catch (NotFoundException $e) {
+            return false;
+        }
+    }
 
-	/**
-	 * @throws NotFoundException
-	 */
-	protected function getNode(): Node {
-		if ($this->node) {
-			return $this->node;
-		}
-		if (!$this->event instanceof GenericEvent && !$this->event instanceof MapperEvent) {
-			throw new NotFoundException();
-		}
-		switch ($this->eventName) {
-			case self::EVENT_NAMESPACE . 'postCreate':
-			case self::EVENT_NAMESPACE . 'postWrite':
-			case self::EVENT_NAMESPACE . 'postDelete':
-			case self::EVENT_NAMESPACE . 'postTouch':
-				return $this->event->getSubject();
-			case self::EVENT_NAMESPACE . 'postRename':
-			case self::EVENT_NAMESPACE . 'postCopy':
-				return $this->event->getSubject()[1];
-			case MapperEvent::EVENT_ASSIGN:
-				if (!$this->event instanceof MapperEvent || $this->event->getObjectType() !== 'files') {
-					throw new NotFoundException();
-				}
-				$nodes = $this->root->getById((int)$this->event->getObjectId());
-				if (is_array($nodes) && isset($nodes[0])) {
-					$this->node = $nodes[0];
-					return $this->node;
-				}
-				break;
-		}
-		throw new NotFoundException();
-	}
+    /**
+     * @throws NotFoundException
+     */
+    protected function getNode(): Node {
+        if ($this->node) {
+            return $this->node;
+        }
+        if (!$this->event instanceof GenericEvent && !$this->event instanceof MapperEvent) {
+            throw new NotFoundException();
+        }
+        switch ($this->eventName) {
+            case self::EVENT_NAMESPACE . 'postCreate':
+            case self::EVENT_NAMESPACE . 'postWrite':
+            case self::EVENT_NAMESPACE . 'postDelete':
+            case self::EVENT_NAMESPACE . 'postTouch':
+                return $this->event->getSubject();
+            case self::EVENT_NAMESPACE . 'postRename':
+            case self::EVENT_NAMESPACE . 'postCopy':
+                return $this->event->getSubject()[1];
+            case MapperEvent::EVENT_ASSIGN:
+                if (!$this->event instanceof MapperEvent || $this->event->getObjectType() !== 'files') {
+                    throw new NotFoundException();
+                }
+                $nodes = $this->root->getById((int)$this->event->getObjectId());
+                if (is_array($nodes) && isset($nodes[0])) {
+                    $this->node = $nodes[0];
+                    return $this->node;
+                }
+                break;
+        }
+        throw new NotFoundException();
+    }
 
-	public function getDisplayText(int $verbosity = 0): string {
-		try {
-			$node = $this->getNode();
-		} catch (NotFoundException $e) {
-			return '';
-		}
+    public function getDisplayText(int $verbosity = 0): string {
+        try {
+            $node = $this->getNode();
+        } catch (NotFoundException $e) {
+            return '';
+        }
 
-		$options = [
-			$this->actingUser ? $this->actingUser->getDisplayName() : $this->l10n->t('Someone'),
-			$node->getName()
-		];
+        $options = [
+            $this->actingUser ? $this->actingUser->getDisplayName() : $this->l10n->t('Someone'),
+            $node->getName()
+        ];
 
-		switch ($this->eventName) {
-			case self::EVENT_NAMESPACE . 'postCreate':
-				return $this->l10n->t('%s created %s', $options);
-			case self::EVENT_NAMESPACE . 'postWrite':
-				return $this->l10n->t('%s modified %s', $options);
-			case self::EVENT_NAMESPACE . 'postDelete':
-				return $this->l10n->t('%s deleted %s', $options);
-			case self::EVENT_NAMESPACE . 'postTouch':
-				return $this->l10n->t('%s accessed %s', $options);
-			case self::EVENT_NAMESPACE . 'postRename':
-				return $this->l10n->t('%s renamed %s', $options);
-			case self::EVENT_NAMESPACE . 'postCopy':
-				return $this->l10n->t('%s copied %s', $options);
-			case MapperEvent::EVENT_ASSIGN:
-				$tagNames = [];
-				if ($this->event instanceof MapperEvent) {
-					$tagIDs = $this->event->getTags();
-					$tagObjects = $this->tagManager->getTagsByIds($tagIDs);
-					foreach ($tagObjects as $systemTag) {
-						/** @var ISystemTag $systemTag */
-						if ($systemTag->isUserVisible()) {
-							$tagNames[] = $systemTag->getName();
-						}
-					}
-				}
-				$filename = array_pop($options);
-				$tagString = implode(', ', $tagNames);
-				if ($tagString === '') {
-					return '';
-				}
-				array_push($options, $tagString, $filename);
-				return $this->l10n->t('%s assigned %s to %s', $options);
-		}
-	}
+        switch ($this->eventName) {
+            case self::EVENT_NAMESPACE . 'postCreate':
+                return $this->l10n->t('%s created %s', $options);
+            case self::EVENT_NAMESPACE . 'postWrite':
+                return $this->l10n->t('%s modified %s', $options);
+            case self::EVENT_NAMESPACE . 'postDelete':
+                return $this->l10n->t('%s deleted %s', $options);
+            case self::EVENT_NAMESPACE . 'postTouch':
+                return $this->l10n->t('%s accessed %s', $options);
+            case self::EVENT_NAMESPACE . 'postRename':
+                return $this->l10n->t('%s renamed %s', $options);
+            case self::EVENT_NAMESPACE . 'postCopy':
+                return $this->l10n->t('%s copied %s', $options);
+            case MapperEvent::EVENT_ASSIGN:
+                $tagNames = [];
+                if ($this->event instanceof MapperEvent) {
+                    $tagIDs = $this->event->getTags();
+                    $tagObjects = $this->tagManager->getTagsByIds($tagIDs);
+                    foreach ($tagObjects as $systemTag) {
+                        /** @var ISystemTag $systemTag */
+                        if ($systemTag->isUserVisible()) {
+                            $tagNames[] = $systemTag->getName();
+                        }
+                    }
+                }
+                $filename = array_pop($options);
+                $tagString = implode(', ', $tagNames);
+                if ($tagString === '') {
+                    return '';
+                }
+                array_push($options, $tagString, $filename);
+                return $this->l10n->t('%s assigned %s to %s', $options);
+        }
+    }
 
-	public function getUrl(): string {
-		try {
-			return $this->urlGenerator->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $this->getNode()->getId()]);
-		} catch (InvalidPathException $e) {
-			return '';
-		} catch (NotFoundException $e) {
-			return '';
-		}
-	}
+    public function getUrl(): string {
+        try {
+            return $this->urlGenerator->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $this->getNode()->getId()]);
+        } catch (InvalidPathException $e) {
+            return '';
+        } catch (NotFoundException $e) {
+            return '';
+        }
+    }
 
-	/**
-	 * @inheritDoc
-	 */
-	public function exportContextIDs(): array {
-		$nodeOwner = $this->getNode()->getOwner();
-		$actingUserId = null;
-		if ($this->actingUser instanceof IUser) {
-			$actingUserId = $this->actingUser->getUID();
-		} elseif ($this->userSession->getUser() instanceof IUser) {
-			$actingUserId = $this->userSession->getUser()->getUID();
-		}
-		return [
-			'eventName' => $this->eventName,
-			'nodeId' => $this->getNode()->getId(),
-			'nodeOwnerId' => $nodeOwner ? $nodeOwner->getUID() : null,
-			'actingUserId' => $actingUserId,
-		];
-	}
+    /**
+     * @inheritDoc
+     */
+    public function exportContextIDs(): array {
+        $nodeOwner = $this->getNode()->getOwner();
+        $actingUserId = null;
+        if ($this->actingUser instanceof IUser) {
+            $actingUserId = $this->actingUser->getUID();
+        } elseif ($this->userSession->getUser() instanceof IUser) {
+            $actingUserId = $this->userSession->getUser()->getUID();
+        }
+        return [
+            'eventName' => $this->eventName,
+            'nodeId' => $this->getNode()->getId(),
+            'nodeOwnerId' => $nodeOwner ? $nodeOwner->getUID() : null,
+            'actingUserId' => $actingUserId,
+        ];
+    }
 
-	/**
-	 * @inheritDoc
-	 */
-	public function importContextIDs(array $contextIDs): void {
-		$this->eventName = $contextIDs['eventName'];
-		if ($contextIDs['nodeOwnerId'] !== null) {
-			$userFolder = $this->root->getUserFolder($contextIDs['nodeOwnerId']);
-			$nodes = $userFolder->getById($contextIDs['nodeId']);
-		} else {
-			$nodes = $this->root->getById($contextIDs['nodeId']);
-		}
-		$this->node = $nodes[0] ?? null;
-		if ($contextIDs['actingUserId']) {
-			$this->actingUser = $this->userManager->get($contextIDs['actingUserId']);
-		}
-	}
+    /**
+     * @inheritDoc
+     */
+    public function importContextIDs(array $contextIDs): void {
+        $this->eventName = $contextIDs['eventName'];
+        if ($contextIDs['nodeOwnerId'] !== null) {
+            $userFolder = $this->root->getUserFolder($contextIDs['nodeOwnerId']);
+            $nodes = $userFolder->getById($contextIDs['nodeId']);
+        } else {
+            $nodes = $this->root->getById($contextIDs['nodeId']);
+        }
+        $this->node = $nodes[0] ?? null;
+        if ($contextIDs['actingUserId']) {
+            $this->actingUser = $this->userManager->get($contextIDs['actingUserId']);
+        }
+    }
 }

Please login to merge, or discard this patch.

Spacing +19 added lines, -19 removed lines patch added patch discarded remove patch

@@ -106,12 +106,12 @@  discard block
 block discarded – undo
 
 	public function getEvents(): array {
 		return [
-			new GenericEntityEvent($this->l10n->t('File created'), self::EVENT_NAMESPACE . 'postCreate'),
-			new GenericEntityEvent($this->l10n->t('File updated'), self::EVENT_NAMESPACE . 'postWrite'),
-			new GenericEntityEvent($this->l10n->t('File renamed'), self::EVENT_NAMESPACE . 'postRename'),
-			new GenericEntityEvent($this->l10n->t('File deleted'), self::EVENT_NAMESPACE . 'postDelete'),
-			new GenericEntityEvent($this->l10n->t('File accessed'), self::EVENT_NAMESPACE . 'postTouch'),
-			new GenericEntityEvent($this->l10n->t('File copied'), self::EVENT_NAMESPACE . 'postCopy'),
+			new GenericEntityEvent($this->l10n->t('File created'), self::EVENT_NAMESPACE.'postCreate'),
+			new GenericEntityEvent($this->l10n->t('File updated'), self::EVENT_NAMESPACE.'postWrite'),
+			new GenericEntityEvent($this->l10n->t('File renamed'), self::EVENT_NAMESPACE.'postRename'),
+			new GenericEntityEvent($this->l10n->t('File deleted'), self::EVENT_NAMESPACE.'postDelete'),
+			new GenericEntityEvent($this->l10n->t('File accessed'), self::EVENT_NAMESPACE.'postTouch'),
+			new GenericEntityEvent($this->l10n->t('File copied'), self::EVENT_NAMESPACE.'postCopy'),
 			new GenericEntityEvent($this->l10n->t('Tag assigned'), MapperEvent::EVENT_ASSIGN),
 		];
 	}
@@ -156,19 +156,19 @@  discard block
 block discarded – undo
 			throw new NotFoundException();
 		}
 		switch ($this->eventName) {
-			case self::EVENT_NAMESPACE . 'postCreate':
-			case self::EVENT_NAMESPACE . 'postWrite':
-			case self::EVENT_NAMESPACE . 'postDelete':
-			case self::EVENT_NAMESPACE . 'postTouch':
+			case self::EVENT_NAMESPACE.'postCreate':
+			case self::EVENT_NAMESPACE.'postWrite':
+			case self::EVENT_NAMESPACE.'postDelete':
+			case self::EVENT_NAMESPACE.'postTouch':
 				return $this->event->getSubject();
-			case self::EVENT_NAMESPACE . 'postRename':
-			case self::EVENT_NAMESPACE . 'postCopy':
+			case self::EVENT_NAMESPACE.'postRename':
+			case self::EVENT_NAMESPACE.'postCopy':
 				return $this->event->getSubject()[1];
 			case MapperEvent::EVENT_ASSIGN:
 				if (!$this->event instanceof MapperEvent || $this->event->getObjectType() !== 'files') {
 					throw new NotFoundException();
 				}
-				$nodes = $this->root->getById((int)$this->event->getObjectId());
+				$nodes = $this->root->getById((int) $this->event->getObjectId());
 				if (is_array($nodes) && isset($nodes[0])) {
 					$this->node = $nodes[0];
 					return $this->node;
@@ -191,17 +191,17 @@  discard block
 block discarded – undo
 		];
 
 		switch ($this->eventName) {
-			case self::EVENT_NAMESPACE . 'postCreate':
+			case self::EVENT_NAMESPACE.'postCreate':
 				return $this->l10n->t('%s created %s', $options);
-			case self::EVENT_NAMESPACE . 'postWrite':
+			case self::EVENT_NAMESPACE.'postWrite':
 				return $this->l10n->t('%s modified %s', $options);
-			case self::EVENT_NAMESPACE . 'postDelete':
+			case self::EVENT_NAMESPACE.'postDelete':
 				return $this->l10n->t('%s deleted %s', $options);
-			case self::EVENT_NAMESPACE . 'postTouch':
+			case self::EVENT_NAMESPACE.'postTouch':
 				return $this->l10n->t('%s accessed %s', $options);
-			case self::EVENT_NAMESPACE . 'postRename':
+			case self::EVENT_NAMESPACE.'postRename':
 				return $this->l10n->t('%s renamed %s', $options);
-			case self::EVENT_NAMESPACE . 'postCopy':
+			case self::EVENT_NAMESPACE.'postCopy':
 				return $this->l10n->t('%s copied %s', $options);
 			case MapperEvent::EVENT_ASSIGN:
 				$tagNames = [];

Please login to merge, or discard this patch.

		@@ -106,12 +106,12 @@ discard block
		block discarded – undo
106	106
107	107	public function getEvents(): array {
108	108	return [
109		- new GenericEntityEvent($this->l10n->t('File created'), self::EVENT_NAMESPACE . 'postCreate'),
110		- new GenericEntityEvent($this->l10n->t('File updated'), self::EVENT_NAMESPACE . 'postWrite'),
111		- new GenericEntityEvent($this->l10n->t('File renamed'), self::EVENT_NAMESPACE . 'postRename'),
112		- new GenericEntityEvent($this->l10n->t('File deleted'), self::EVENT_NAMESPACE . 'postDelete'),
113		- new GenericEntityEvent($this->l10n->t('File accessed'), self::EVENT_NAMESPACE . 'postTouch'),
114		- new GenericEntityEvent($this->l10n->t('File copied'), self::EVENT_NAMESPACE . 'postCopy'),
	109	+ new GenericEntityEvent($this->l10n->t('File created'), self::EVENT_NAMESPACE.'postCreate'),
	110	+ new GenericEntityEvent($this->l10n->t('File updated'), self::EVENT_NAMESPACE.'postWrite'),
	111	+ new GenericEntityEvent($this->l10n->t('File renamed'), self::EVENT_NAMESPACE.'postRename'),
	112	+ new GenericEntityEvent($this->l10n->t('File deleted'), self::EVENT_NAMESPACE.'postDelete'),
	113	+ new GenericEntityEvent($this->l10n->t('File accessed'), self::EVENT_NAMESPACE.'postTouch'),
	114	+ new GenericEntityEvent($this->l10n->t('File copied'), self::EVENT_NAMESPACE.'postCopy'),
115	115	new GenericEntityEvent($this->l10n->t('Tag assigned'), MapperEvent::EVENT_ASSIGN),
116	116	];
117	117	}
		@@ -156,19 +156,19 @@ discard block
		block discarded – undo
156	156	throw new NotFoundException();
157	157	}
158	158	switch ($this->eventName) {
159		- case self::EVENT_NAMESPACE . 'postCreate':
160		- case self::EVENT_NAMESPACE . 'postWrite':
161		- case self::EVENT_NAMESPACE . 'postDelete':
162		- case self::EVENT_NAMESPACE . 'postTouch':
	159	+ case self::EVENT_NAMESPACE.'postCreate':
	160	+ case self::EVENT_NAMESPACE.'postWrite':
	161	+ case self::EVENT_NAMESPACE.'postDelete':
	162	+ case self::EVENT_NAMESPACE.'postTouch':
163	163	return $this->event->getSubject();
164		- case self::EVENT_NAMESPACE . 'postRename':
165		- case self::EVENT_NAMESPACE . 'postCopy':
	164	+ case self::EVENT_NAMESPACE.'postRename':
	165	+ case self::EVENT_NAMESPACE.'postCopy':
166	166	return $this->event->getSubject()[1];
167	167	case MapperEvent::EVENT_ASSIGN:
168	168	if (!$this->event instanceof MapperEvent \|\| $this->event->getObjectType() !== 'files') {
169	169	throw new NotFoundException();
170	170	}
171		- $nodes = $this->root->getById((int)$this->event->getObjectId());
	171	+ $nodes = $this->root->getById((int) $this->event->getObjectId());
172	172	if (is_array($nodes) && isset($nodes[0])) {
173	173	$this->node = $nodes[0];
174	174	return $this->node;
		@@ -191,17 +191,17 @@ discard block
		block discarded – undo
191	191	];
192	192
193	193	switch ($this->eventName) {
194		- case self::EVENT_NAMESPACE . 'postCreate':
	194	+ case self::EVENT_NAMESPACE.'postCreate':
195	195	return $this->l10n->t('%s created %s', $options);
196		- case self::EVENT_NAMESPACE . 'postWrite':
	196	+ case self::EVENT_NAMESPACE.'postWrite':
197	197	return $this->l10n->t('%s modified %s', $options);
198		- case self::EVENT_NAMESPACE . 'postDelete':
	198	+ case self::EVENT_NAMESPACE.'postDelete':
199	199	return $this->l10n->t('%s deleted %s', $options);
200		- case self::EVENT_NAMESPACE . 'postTouch':
	200	+ case self::EVENT_NAMESPACE.'postTouch':
201	201	return $this->l10n->t('%s accessed %s', $options);
202		- case self::EVENT_NAMESPACE . 'postRename':
	202	+ case self::EVENT_NAMESPACE.'postRename':
203	203	return $this->l10n->t('%s renamed %s', $options);
204		- case self::EVENT_NAMESPACE . 'postCopy':
	204	+ case self::EVENT_NAMESPACE.'postCopy':
205	205	return $this->l10n->t('%s copied %s', $options);
206	206	case MapperEvent::EVENT_ASSIGN:
207	207	$tagNames = [];

		@@ -40,20 +40,20 @@
		block discarded – undo
40	40	*/
41	41	interface IContextPortation {
42	42
43		- /**
44		- * All relevant context identifiers that are needed to restore the state
45		- * of an entity shall be returned with this method. The resulting array
46		- * must be JSON-serializable.
47		- *
48		- * @since 20.0.0
49		- */
50		- public function exportContextIDs(): array;
	43	+ /**
	44	+ * All relevant context identifiers that are needed to restore the state
	45	+ * of an entity shall be returned with this method. The resulting array
	46	+ * must be JSON-serializable.
	47	+ *
	48	+ * @since 20.0.0
	49	+ */
	50	+ public function exportContextIDs(): array;
51	51
52		- /**
53		- * This method receives the array as returned by `exportContextIDs()` in
54		- * order to restore the state of the IEntity if necessary.
55		- *
56		- * @since 20.0.0
57		- */
58		- public function importContextIDs(array $contextIDs): void;
	52	+ /**
	53	+ * This method receives the array as returned by `exportContextIDs()` in
	54	+ * order to restore the state of the IEntity if necessary.
	55	+ *
	56	+ * @since 20.0.0
	57	+ */
	58	+ public function importContextIDs(array $contextIDs): void;
59	59	}

		@@ -49,225 +49,225 @@
		block discarded – undo
49	49	use OCP\WorkflowEngine\IRuleMatcher;
50	50
51	51	class File implements IEntity, IDisplayText, IUrl, IContextPortation {
52		- private const EVENT_NAMESPACE = '\OCP\Files::';
	52	+ private const EVENT_NAMESPACE = '\OCP\Files::';
53	53
54		- /** @var IL10N */
55		- protected $l10n;
56		- /** @var IURLGenerator */
57		- protected $urlGenerator;
58		- /** @var IRootFolder */
59		- protected $root;
60		- /** @var ILogger */
61		- protected $logger;
62		- /** @var string */
63		- protected $eventName;
64		- /** @var Event */
65		- protected $event;
66		- /** @var ShareManager */
67		- private $shareManager;
68		- /** @var IUserSession */
69		- private $userSession;
70		- /** @var ISystemTagManager */
71		- private $tagManager;
72		- /** @var ?Node */
73		- private $node;
74		- /** @var ?IUser */
75		- private $actingUser = null;
76		- /** @var IUserManager */
77		- private $userManager;
	54	+ /** @var IL10N */
	55	+ protected $l10n;
	56	+ /** @var IURLGenerator */
	57	+ protected $urlGenerator;
	58	+ /** @var IRootFolder */
	59	+ protected $root;
	60	+ /** @var ILogger */
	61	+ protected $logger;
	62	+ /** @var string */
	63	+ protected $eventName;
	64	+ /** @var Event */
	65	+ protected $event;
	66	+ /** @var ShareManager */
	67	+ private $shareManager;
	68	+ /** @var IUserSession */
	69	+ private $userSession;
	70	+ /** @var ISystemTagManager */
	71	+ private $tagManager;
	72	+ /** @var ?Node */
	73	+ private $node;
	74	+ /** @var ?IUser */
	75	+ private $actingUser = null;
	76	+ /** @var IUserManager */
	77	+ private $userManager;
78	78
79		- public function __construct(
80		- IL10N $l10n,
81		- IURLGenerator $urlGenerator,
82		- IRootFolder $root,
83		- ILogger $logger,
84		- ShareManager $shareManager,
85		- IUserSession $userSession,
86		- ISystemTagManager $tagManager,
87		- IUserManager $userManager
88		- ) {
89		- $this->l10n = $l10n;
90		- $this->urlGenerator = $urlGenerator;
91		- $this->root = $root;
92		- $this->logger = $logger;
93		- $this->shareManager = $shareManager;
94		- $this->userSession = $userSession;
95		- $this->tagManager = $tagManager;
96		- $this->userManager = $userManager;
97		- }
	79	+ public function __construct(
	80	+ IL10N $l10n,
	81	+ IURLGenerator $urlGenerator,
	82	+ IRootFolder $root,
	83	+ ILogger $logger,
	84	+ ShareManager $shareManager,
	85	+ IUserSession $userSession,
	86	+ ISystemTagManager $tagManager,
	87	+ IUserManager $userManager
	88	+ ) {
	89	+ $this->l10n = $l10n;
	90	+ $this->urlGenerator = $urlGenerator;
	91	+ $this->root = $root;
	92	+ $this->logger = $logger;
	93	+ $this->shareManager = $shareManager;
	94	+ $this->userSession = $userSession;
	95	+ $this->tagManager = $tagManager;
	96	+ $this->userManager = $userManager;
	97	+ }
98	98
99		- public function getName(): string {
100		- return $this->l10n->t('File');
101		- }
	99	+ public function getName(): string {
	100	+ return $this->l10n->t('File');
	101	+ }
102	102
103		- public function getIcon(): string {
104		- return $this->urlGenerator->imagePath('core', 'categories/files.svg');
105		- }
	103	+ public function getIcon(): string {
	104	+ return $this->urlGenerator->imagePath('core', 'categories/files.svg');
	105	+ }
106	106
107		- public function getEvents(): array {
108		- return [
109		- new GenericEntityEvent($this->l10n->t('File created'), self::EVENT_NAMESPACE . 'postCreate'),
110		- new GenericEntityEvent($this->l10n->t('File updated'), self::EVENT_NAMESPACE . 'postWrite'),
111		- new GenericEntityEvent($this->l10n->t('File renamed'), self::EVENT_NAMESPACE . 'postRename'),
112		- new GenericEntityEvent($this->l10n->t('File deleted'), self::EVENT_NAMESPACE . 'postDelete'),
113		- new GenericEntityEvent($this->l10n->t('File accessed'), self::EVENT_NAMESPACE . 'postTouch'),
114		- new GenericEntityEvent($this->l10n->t('File copied'), self::EVENT_NAMESPACE . 'postCopy'),
115		- new GenericEntityEvent($this->l10n->t('Tag assigned'), MapperEvent::EVENT_ASSIGN),
116		- ];
117		- }
	107	+ public function getEvents(): array {
	108	+ return [
	109	+ new GenericEntityEvent($this->l10n->t('File created'), self::EVENT_NAMESPACE . 'postCreate'),
	110	+ new GenericEntityEvent($this->l10n->t('File updated'), self::EVENT_NAMESPACE . 'postWrite'),
	111	+ new GenericEntityEvent($this->l10n->t('File renamed'), self::EVENT_NAMESPACE . 'postRename'),
	112	+ new GenericEntityEvent($this->l10n->t('File deleted'), self::EVENT_NAMESPACE . 'postDelete'),
	113	+ new GenericEntityEvent($this->l10n->t('File accessed'), self::EVENT_NAMESPACE . 'postTouch'),
	114	+ new GenericEntityEvent($this->l10n->t('File copied'), self::EVENT_NAMESPACE . 'postCopy'),
	115	+ new GenericEntityEvent($this->l10n->t('Tag assigned'), MapperEvent::EVENT_ASSIGN),
	116	+ ];
	117	+ }
118	118
119		- public function prepareRuleMatcher(IRuleMatcher $ruleMatcher, string $eventName, Event $event): void {
120		- if (!$event instanceof GenericEvent && !$event instanceof MapperEvent) {
121		- return;
122		- }
123		- $this->eventName = $eventName;
124		- $this->event = $event;
125		- $this->actingUser = $this->actingUser ?? $this->userSession->getUser();
126		- try {
127		- $node = $this->getNode();
128		- $ruleMatcher->setEntitySubject($this, $node);
129		- $ruleMatcher->setFileInfo($node->getStorage(), $node->getInternalPath());
130		- } catch (NotFoundException $e) {
131		- // pass
132		- }
133		- }
	119	+ public function prepareRuleMatcher(IRuleMatcher $ruleMatcher, string $eventName, Event $event): void {
	120	+ if (!$event instanceof GenericEvent && !$event instanceof MapperEvent) {
	121	+ return;
	122	+ }
	123	+ $this->eventName = $eventName;
	124	+ $this->event = $event;
	125	+ $this->actingUser = $this->actingUser ?? $this->userSession->getUser();
	126	+ try {
	127	+ $node = $this->getNode();
	128	+ $ruleMatcher->setEntitySubject($this, $node);
	129	+ $ruleMatcher->setFileInfo($node->getStorage(), $node->getInternalPath());
	130	+ } catch (NotFoundException $e) {
	131	+ // pass
	132	+ }
	133	+ }
134	134
135		- public function isLegitimatedForUserId(string $uid): bool {
136		- try {
137		- $node = $this->getNode();
138		- if ($node->getOwner()->getUID() === $uid) {
139		- return true;
140		- }
141		- $acl = $this->shareManager->getAccessList($node, true, true);
142		- return array_key_exists($uid, $acl['users']);
143		- } catch (NotFoundException $e) {
144		- return false;
145		- }
146		- }
	135	+ public function isLegitimatedForUserId(string $uid): bool {
	136	+ try {
	137	+ $node = $this->getNode();
	138	+ if ($node->getOwner()->getUID() === $uid) {
	139	+ return true;
	140	+ }
	141	+ $acl = $this->shareManager->getAccessList($node, true, true);
	142	+ return array_key_exists($uid, $acl['users']);
	143	+ } catch (NotFoundException $e) {
	144	+ return false;
	145	+ }
	146	+ }
147	147
148		- /**
149		- * @throws NotFoundException
150		- */
151		- protected function getNode(): Node {
152		- if ($this->node) {
153		- return $this->node;
154		- }
155		- if (!$this->event instanceof GenericEvent && !$this->event instanceof MapperEvent) {
156		- throw new NotFoundException();
157		- }
158		- switch ($this->eventName) {
159		- case self::EVENT_NAMESPACE . 'postCreate':
160		- case self::EVENT_NAMESPACE . 'postWrite':
161		- case self::EVENT_NAMESPACE . 'postDelete':
162		- case self::EVENT_NAMESPACE . 'postTouch':
163		- return $this->event->getSubject();
164		- case self::EVENT_NAMESPACE . 'postRename':
165		- case self::EVENT_NAMESPACE . 'postCopy':
166		- return $this->event->getSubject()[1];
167		- case MapperEvent::EVENT_ASSIGN:
168		- if (!$this->event instanceof MapperEvent \|\| $this->event->getObjectType() !== 'files') {
169		- throw new NotFoundException();
170		- }
171		- $nodes = $this->root->getById((int)$this->event->getObjectId());
172		- if (is_array($nodes) && isset($nodes[0])) {
173		- $this->node = $nodes[0];
174		- return $this->node;
175		- }
176		- break;
177		- }
178		- throw new NotFoundException();
179		- }
	148	+ /**
	149	+ * @throws NotFoundException
	150	+ */
	151	+ protected function getNode(): Node {
	152	+ if ($this->node) {
	153	+ return $this->node;
	154	+ }
	155	+ if (!$this->event instanceof GenericEvent && !$this->event instanceof MapperEvent) {
	156	+ throw new NotFoundException();
	157	+ }
	158	+ switch ($this->eventName) {
	159	+ case self::EVENT_NAMESPACE . 'postCreate':
	160	+ case self::EVENT_NAMESPACE . 'postWrite':
	161	+ case self::EVENT_NAMESPACE . 'postDelete':
	162	+ case self::EVENT_NAMESPACE . 'postTouch':
	163	+ return $this->event->getSubject();
	164	+ case self::EVENT_NAMESPACE . 'postRename':
	165	+ case self::EVENT_NAMESPACE . 'postCopy':
	166	+ return $this->event->getSubject()[1];
	167	+ case MapperEvent::EVENT_ASSIGN:
	168	+ if (!$this->event instanceof MapperEvent \|\| $this->event->getObjectType() !== 'files') {
	169	+ throw new NotFoundException();
	170	+ }
	171	+ $nodes = $this->root->getById((int)$this->event->getObjectId());
	172	+ if (is_array($nodes) && isset($nodes[0])) {
	173	+ $this->node = $nodes[0];
	174	+ return $this->node;
	175	+ }
	176	+ break;
	177	+ }
	178	+ throw new NotFoundException();
	179	+ }
180	180
181		- public function getDisplayText(int $verbosity = 0): string {
182		- try {
183		- $node = $this->getNode();
184		- } catch (NotFoundException $e) {
185		- return '';
186		- }
	181	+ public function getDisplayText(int $verbosity = 0): string {
	182	+ try {
	183	+ $node = $this->getNode();
	184	+ } catch (NotFoundException $e) {
	185	+ return '';
	186	+ }
187	187
188		- $options = [
189		- $this->actingUser ? $this->actingUser->getDisplayName() : $this->l10n->t('Someone'),
190		- $node->getName()
191		- ];
	188	+ $options = [
	189	+ $this->actingUser ? $this->actingUser->getDisplayName() : $this->l10n->t('Someone'),
	190	+ $node->getName()
	191	+ ];
192	192
193		- switch ($this->eventName) {
194		- case self::EVENT_NAMESPACE . 'postCreate':
195		- return $this->l10n->t('%s created %s', $options);
196		- case self::EVENT_NAMESPACE . 'postWrite':
197		- return $this->l10n->t('%s modified %s', $options);
198		- case self::EVENT_NAMESPACE . 'postDelete':
199		- return $this->l10n->t('%s deleted %s', $options);
200		- case self::EVENT_NAMESPACE . 'postTouch':
201		- return $this->l10n->t('%s accessed %s', $options);
202		- case self::EVENT_NAMESPACE . 'postRename':
203		- return $this->l10n->t('%s renamed %s', $options);
204		- case self::EVENT_NAMESPACE . 'postCopy':
205		- return $this->l10n->t('%s copied %s', $options);
206		- case MapperEvent::EVENT_ASSIGN:
207		- $tagNames = [];
208		- if ($this->event instanceof MapperEvent) {
209		- $tagIDs = $this->event->getTags();
210		- $tagObjects = $this->tagManager->getTagsByIds($tagIDs);
211		- foreach ($tagObjects as $systemTag) {
212		- /** @var ISystemTag $systemTag */
213		- if ($systemTag->isUserVisible()) {
214		- $tagNames[] = $systemTag->getName();
215		- }
216		- }
217		- }
218		- $filename = array_pop($options);
219		- $tagString = implode(', ', $tagNames);
220		- if ($tagString === '') {
221		- return '';
222		- }
223		- array_push($options, $tagString, $filename);
224		- return $this->l10n->t('%s assigned %s to %s', $options);
225		- }
226		- }
	193	+ switch ($this->eventName) {
	194	+ case self::EVENT_NAMESPACE . 'postCreate':
	195	+ return $this->l10n->t('%s created %s', $options);
	196	+ case self::EVENT_NAMESPACE . 'postWrite':
	197	+ return $this->l10n->t('%s modified %s', $options);
	198	+ case self::EVENT_NAMESPACE . 'postDelete':
	199	+ return $this->l10n->t('%s deleted %s', $options);
	200	+ case self::EVENT_NAMESPACE . 'postTouch':
	201	+ return $this->l10n->t('%s accessed %s', $options);
	202	+ case self::EVENT_NAMESPACE . 'postRename':
	203	+ return $this->l10n->t('%s renamed %s', $options);
	204	+ case self::EVENT_NAMESPACE . 'postCopy':
	205	+ return $this->l10n->t('%s copied %s', $options);
	206	+ case MapperEvent::EVENT_ASSIGN:
	207	+ $tagNames = [];
	208	+ if ($this->event instanceof MapperEvent) {
	209	+ $tagIDs = $this->event->getTags();
	210	+ $tagObjects = $this->tagManager->getTagsByIds($tagIDs);
	211	+ foreach ($tagObjects as $systemTag) {
	212	+ /** @var ISystemTag $systemTag */
	213	+ if ($systemTag->isUserVisible()) {
	214	+ $tagNames[] = $systemTag->getName();
	215	+ }
	216	+ }
	217	+ }
	218	+ $filename = array_pop($options);
	219	+ $tagString = implode(', ', $tagNames);
	220	+ if ($tagString === '') {
	221	+ return '';
	222	+ }
	223	+ array_push($options, $tagString, $filename);
	224	+ return $this->l10n->t('%s assigned %s to %s', $options);
	225	+ }
	226	+ }
227	227
228		- public function getUrl(): string {
229		- try {
230		- return $this->urlGenerator->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $this->getNode()->getId()]);
231		- } catch (InvalidPathException $e) {
232		- return '';
233		- } catch (NotFoundException $e) {
234		- return '';
235		- }
236		- }
	228	+ public function getUrl(): string {
	229	+ try {
	230	+ return $this->urlGenerator->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $this->getNode()->getId()]);
	231	+ } catch (InvalidPathException $e) {
	232	+ return '';
	233	+ } catch (NotFoundException $e) {
	234	+ return '';
	235	+ }
	236	+ }
237	237
238		- /**
239		- * @inheritDoc
240		- */
241		- public function exportContextIDs(): array {
242		- $nodeOwner = $this->getNode()->getOwner();
243		- $actingUserId = null;
244		- if ($this->actingUser instanceof IUser) {
245		- $actingUserId = $this->actingUser->getUID();
246		- } elseif ($this->userSession->getUser() instanceof IUser) {
247		- $actingUserId = $this->userSession->getUser()->getUID();
248		- }
249		- return [
250		- 'eventName' => $this->eventName,
251		- 'nodeId' => $this->getNode()->getId(),
252		- 'nodeOwnerId' => $nodeOwner ? $nodeOwner->getUID() : null,
253		- 'actingUserId' => $actingUserId,
254		- ];
255		- }
	238	+ /**
	239	+ * @inheritDoc
	240	+ */
	241	+ public function exportContextIDs(): array {
	242	+ $nodeOwner = $this->getNode()->getOwner();
	243	+ $actingUserId = null;
	244	+ if ($this->actingUser instanceof IUser) {
	245	+ $actingUserId = $this->actingUser->getUID();
	246	+ } elseif ($this->userSession->getUser() instanceof IUser) {
	247	+ $actingUserId = $this->userSession->getUser()->getUID();
	248	+ }
	249	+ return [
	250	+ 'eventName' => $this->eventName,
	251	+ 'nodeId' => $this->getNode()->getId(),
	252	+ 'nodeOwnerId' => $nodeOwner ? $nodeOwner->getUID() : null,
	253	+ 'actingUserId' => $actingUserId,
	254	+ ];
	255	+ }
256	256
257		- /**
258		- * @inheritDoc
259		- */
260		- public function importContextIDs(array $contextIDs): void {
261		- $this->eventName = $contextIDs['eventName'];
262		- if ($contextIDs['nodeOwnerId'] !== null) {
263		- $userFolder = $this->root->getUserFolder($contextIDs['nodeOwnerId']);
264		- $nodes = $userFolder->getById($contextIDs['nodeId']);
265		- } else {
266		- $nodes = $this->root->getById($contextIDs['nodeId']);
267		- }
268		- $this->node = $nodes[0] ?? null;
269		- if ($contextIDs['actingUserId']) {
270		- $this->actingUser = $this->userManager->get($contextIDs['actingUserId']);
271		- }
272		- }
	257	+ /**
	258	+ * @inheritDoc
	259	+ */
	260	+ public function importContextIDs(array $contextIDs): void {
	261	+ $this->eventName = $contextIDs['eventName'];
	262	+ if ($contextIDs['nodeOwnerId'] !== null) {
	263	+ $userFolder = $this->root->getUserFolder($contextIDs['nodeOwnerId']);
	264	+ $nodes = $userFolder->getById($contextIDs['nodeId']);
	265	+ } else {
	266	+ $nodes = $this->root->getById($contextIDs['nodeId']);
	267	+ }
	268	+ $this->node = $nodes[0] ?? null;
	269	+ if ($contextIDs['actingUserId']) {
	270	+ $this->actingUser = $this->userManager->get($contextIDs['actingUserId']);
	271	+ }
	272	+ }
273	273	}

nextcloud / server

Push — master ( 5b6246...3f1c48 )

Status

Category

Indentation +15 added lines, -15 removed lines patch added patch discarded remove patch

Indentation +207 added lines, -207 removed lines patch added patch discarded remove patch

Spacing +19 added lines, -19 removed lines patch added patch discarded remove patch