nextcloud / server

lib/public/WorkflowEngine/IRuleMatcher.php

Indentation +47 added lines, -47 removed lines

@@ -36,56 +36,56 @@
  * @since 18.0.0
  */
 interface IRuleMatcher extends IFileCheck {
-	/**
-	 * This method is left for backwards compatibility and easier porting of
-	 * apps. Please use 'getFlows' instead (and setOperation if you implement
-	 * an IComplexOperation).
-	 *
-	 * @since 18.0.0
-	 * @deprecated 18.0.0
-	 */
-	public function getMatchingOperations(string $class, bool $returnFirstMatchingOperationOnly = true): array;
+    /**
+     * This method is left for backwards compatibility and easier porting of
+     * apps. Please use 'getFlows' instead (and setOperation if you implement
+     * an IComplexOperation).
+     *
+     * @since 18.0.0
+     * @deprecated 18.0.0
+     */
+    public function getMatchingOperations(string $class, bool $returnFirstMatchingOperationOnly = true): array;
 
-	/**
-	 * @throws RuntimeException
-	 * @since 18.0.0
-	 */
-	public function getFlows(bool $returnFirstMatchingOperationOnly = true): array;
+    /**
+     * @throws RuntimeException
+     * @since 18.0.0
+     */
+    public function getFlows(bool $returnFirstMatchingOperationOnly = true): array;
 
-	/**
-	 * this method can only be called once and is typically called by the
-	 * Flow engine, unless for IComplexOperations.
-	 *
-	 * @throws RuntimeException
-	 * @since 18.0.0
-	 */
-	public function setOperation(IOperation $operation): void;
+    /**
+     * this method can only be called once and is typically called by the
+     * Flow engine, unless for IComplexOperations.
+     *
+     * @throws RuntimeException
+     * @since 18.0.0
+     */
+    public function setOperation(IOperation $operation): void;
 
-	/**
-	 * this method can only be called once and is typically called by the
-	 * Flow engine, unless for IComplexOperations.
-	 *
-	 * @throws RuntimeException
-	 * @since 18.0.0
-	 */
-	public function setEntity(IEntity $entity): void;
+    /**
+     * this method can only be called once and is typically called by the
+     * Flow engine, unless for IComplexOperations.
+     *
+     * @throws RuntimeException
+     * @since 18.0.0
+     */
+    public function setEntity(IEntity $entity): void;
 
-	/**
-	 * returns the entity which might provide more information, depending on
-	 * the interfaces it implements
-	 *
-	 * @return IEntity
-	 * @since 18.0.0
-	 */
-	public function getEntity(): IEntity;
+    /**
+     * returns the entity which might provide more information, depending on
+     * the interfaces it implements
+     *
+     * @return IEntity
+     * @since 18.0.0
+     */
+    public function getEntity(): IEntity;
 
-	/**
-	 * this method can be called once to set the event name that is currently
-	 * being processed. The workflow engine takes care of this usually, only an
-	 * IComplexOperation might want to make use of it.
-	 *
-	 * @throws RuntimeException
-	 * @since 20.0.0
-	 */
-	public function setEventName(string $eventName): void;
+    /**
+     * this method can be called once to set the event name that is currently
+     * being processed. The workflow engine takes care of this usually, only an
+     * IComplexOperation might want to make use of it.
+     *
+     * @throws RuntimeException
+     * @since 20.0.0
+     */
+    public function setEventName(string $eventName): void;
 }

apps/workflowengine/lib/Service/RuleMatcher.php

Indentation +196 added lines, -196 removed lines

@@ -44,200 +44,200 @@
 
 class RuleMatcher implements IRuleMatcher {
 
-	/** @var IUserSession */
-	protected $session;
-	/** @var IManager */
-	protected $manager;
-	/** @var array */
-	protected $contexts;
-	/** @var IServerContainer */
-	protected $container;
-	/** @var array */
-	protected $fileInfo = [];
-	/** @var IL10N */
-	protected $l;
-	/** @var IOperation */
-	protected $operation;
-	/** @var IEntity */
-	protected $entity;
-	/** @var Logger */
-	protected $logger;
-	/** @var string */
-	protected $eventName;
-
-	public function __construct(
-		IUserSession $session,
-		IServerContainer $container,
-		IL10N $l,
-		Manager $manager,
-		Logger $logger
-	) {
-		$this->session = $session;
-		$this->manager = $manager;
-		$this->container = $container;
-		$this->l = $l;
-		$this->logger = $logger;
-	}
-
-	public function setFileInfo(IStorage $storage, string $path, bool $isDir = false): void {
-		$this->fileInfo['storage'] = $storage;
-		$this->fileInfo['path'] = $path;
-		$this->fileInfo['isDir'] = $isDir;
-	}
-
-	public function setEntitySubject(IEntity $entity, $subject): void {
-		$this->contexts[get_class($entity)] = [$entity, $subject];
-	}
-
-	public function setOperation(IOperation $operation): void {
-		if ($this->operation !== null) {
-			throw new RuntimeException('This method must not be called more than once');
-		}
-		$this->operation = $operation;
-	}
-
-	public function setEntity(IEntity $entity): void {
-		if ($this->entity !== null) {
-			throw new RuntimeException('This method must not be called more than once');
-		}
-		$this->entity = $entity;
-	}
-
-	public function setEventName(string $eventName): void {
-		if ($this->eventName !== null) {
-			throw new RuntimeException('This method must not be called more than once');
-		}
-		$this->eventName = $eventName;
-	}
-
-	public function getEntity(): IEntity {
-		if ($this->entity === null) {
-			throw new \LogicException('Entity was not set yet');
-		}
-		return $this->entity;
-	}
-
-	public function getFlows(bool $returnFirstMatchingOperationOnly = true): array {
-		if (!$this->operation) {
-			throw new RuntimeException('Operation is not set');
-		}
-		return $this->getMatchingOperations(get_class($this->operation), $returnFirstMatchingOperationOnly);
-	}
-
-	public function getMatchingOperations(string $class, bool $returnFirstMatchingOperationOnly = true): array {
-		$scopes[] = new ScopeContext(IManager::SCOPE_ADMIN);
-		$user = $this->session->getUser();
-		if ($user !== null && $this->manager->isUserScopeEnabled()) {
-			$scopes[] = new ScopeContext(IManager::SCOPE_USER, $user->getUID());
-		}
-
-		$ctx = new LogContext();
-		$ctx
-			->setScopes($scopes)
-			->setEntity($this->entity)
-			->setOperation($this->operation);
-		$this->logger->logFlowRequests($ctx);
-
-		$operations = [];
-		foreach ($scopes as $scope) {
-			$operations = array_merge($operations, $this->manager->getOperations($class, $scope));
-		}
-
-		if ($this->entity instanceof IEntity) {
-			/** @var ScopeContext[] $additionalScopes */
-			$additionalScopes = $this->manager->getAllConfiguredScopesForOperation($class);
-			foreach ($additionalScopes as $hash => $scopeCandidate) {
-				if ($scopeCandidate->getScope() !== IManager::SCOPE_USER || in_array($scopeCandidate, $scopes)) {
-					continue;
-				}
-				if ($this->entity->isLegitimatedForUserId($scopeCandidate->getScopeId())) {
-					$ctx = new LogContext();
-					$ctx
-						->setScopes([$scopeCandidate])
-						->setEntity($this->entity)
-						->setOperation($this->operation);
-					$this->logger->logScopeExpansion($ctx);
-					$operations = array_merge($operations, $this->manager->getOperations($class, $scopeCandidate));
-				}
-			}
-		}
-
-		$matches = [];
-		foreach ($operations as $operation) {
-			$configuredEvents = json_decode($operation['events'], true);
-			if ($this->eventName !== null && !in_array($this->eventName, $configuredEvents)) {
-				continue;
-			}
-
-			$checkIds = json_decode($operation['checks'], true);
-			$checks = $this->manager->getChecks($checkIds);
-
-			foreach ($checks as $check) {
-				if (!$this->check($check)) {
-					// Check did not match, continue with the next operation
-					continue 2;
-				}
-			}
-
-			$ctx = new LogContext();
-			$ctx
-				->setEntity($this->entity)
-				->setOperation($this->operation)
-				->setConfiguration($operation);
-			$this->logger->logPassedCheck($ctx);
-
-			if ($returnFirstMatchingOperationOnly) {
-				$ctx = new LogContext();
-				$ctx
-					->setEntity($this->entity)
-					->setOperation($this->operation)
-					->setConfiguration($operation);
-				$this->logger->logRunSingle($ctx);
-				return $operation;
-			}
-			$matches[] = $operation;
-		}
-
-		$ctx = new LogContext();
-		$ctx
-			->setEntity($this->entity)
-			->setOperation($this->operation);
-		if (!empty($matches)) {
-			$ctx->setConfiguration($matches);
-			$this->logger->logRunAll($ctx);
-		} else {
-			$this->logger->logRunNone($ctx);
-		}
-
-		return $matches;
-	}
-
-	/**
-	 * @param array $check
-	 * @return bool
-	 */
-	public function check(array $check) {
-		try {
-			$checkInstance = $this->container->query($check['class']);
-		} catch (QueryException $e) {
-			// Check does not exist, assume it matches.
-			return true;
-		}
-
-		if ($checkInstance instanceof IFileCheck) {
-			if (empty($this->fileInfo)) {
-				throw new RuntimeException('Must set file info before running the check');
-			}
-			$checkInstance->setFileInfo($this->fileInfo['storage'], $this->fileInfo['path'], $this->fileInfo['isDir']);
-		} elseif ($checkInstance instanceof IEntityCheck) {
-			foreach ($this->contexts as $entityInfo) {
-				list($entity, $subject) = $entityInfo;
-				$checkInstance->setEntitySubject($entity, $subject);
-			}
-		} elseif (!$checkInstance instanceof ICheck) {
-			// Check is invalid
-			throw new \UnexpectedValueException($this->l->t('Check %s is invalid or does not exist', $check['class']));
-		}
-		return $checkInstance->executeCheck($check['operator'], $check['value']);
-	}
+    /** @var IUserSession */
+    protected $session;
+    /** @var IManager */
+    protected $manager;
+    /** @var array */
+    protected $contexts;
+    /** @var IServerContainer */
+    protected $container;
+    /** @var array */
+    protected $fileInfo = [];
+    /** @var IL10N */
+    protected $l;
+    /** @var IOperation */
+    protected $operation;
+    /** @var IEntity */
+    protected $entity;
+    /** @var Logger */
+    protected $logger;
+    /** @var string */
+    protected $eventName;
+
+    public function __construct(
+        IUserSession $session,
+        IServerContainer $container,
+        IL10N $l,
+        Manager $manager,
+        Logger $logger
+    ) {
+        $this->session = $session;
+        $this->manager = $manager;
+        $this->container = $container;
+        $this->l = $l;
+        $this->logger = $logger;
+    }
+
+    public function setFileInfo(IStorage $storage, string $path, bool $isDir = false): void {
+        $this->fileInfo['storage'] = $storage;
+        $this->fileInfo['path'] = $path;
+        $this->fileInfo['isDir'] = $isDir;
+    }
+
+    public function setEntitySubject(IEntity $entity, $subject): void {
+        $this->contexts[get_class($entity)] = [$entity, $subject];
+    }
+
+    public function setOperation(IOperation $operation): void {
+        if ($this->operation !== null) {
+            throw new RuntimeException('This method must not be called more than once');
+        }
+        $this->operation = $operation;
+    }
+
+    public function setEntity(IEntity $entity): void {
+        if ($this->entity !== null) {
+            throw new RuntimeException('This method must not be called more than once');
+        }
+        $this->entity = $entity;
+    }
+
+    public function setEventName(string $eventName): void {
+        if ($this->eventName !== null) {
+            throw new RuntimeException('This method must not be called more than once');
+        }
+        $this->eventName = $eventName;
+    }
+
+    public function getEntity(): IEntity {
+        if ($this->entity === null) {
+            throw new \LogicException('Entity was not set yet');
+        }
+        return $this->entity;
+    }
+
+    public function getFlows(bool $returnFirstMatchingOperationOnly = true): array {
+        if (!$this->operation) {
+            throw new RuntimeException('Operation is not set');
+        }
+        return $this->getMatchingOperations(get_class($this->operation), $returnFirstMatchingOperationOnly);
+    }
+
+    public function getMatchingOperations(string $class, bool $returnFirstMatchingOperationOnly = true): array {
+        $scopes[] = new ScopeContext(IManager::SCOPE_ADMIN);
+        $user = $this->session->getUser();
+        if ($user !== null && $this->manager->isUserScopeEnabled()) {
+            $scopes[] = new ScopeContext(IManager::SCOPE_USER, $user->getUID());
+        }
+
+        $ctx = new LogContext();
+        $ctx
+            ->setScopes($scopes)
+            ->setEntity($this->entity)
+            ->setOperation($this->operation);
+        $this->logger->logFlowRequests($ctx);
+
+        $operations = [];
+        foreach ($scopes as $scope) {
+            $operations = array_merge($operations, $this->manager->getOperations($class, $scope));
+        }
+
+        if ($this->entity instanceof IEntity) {
+            /** @var ScopeContext[] $additionalScopes */
+            $additionalScopes = $this->manager->getAllConfiguredScopesForOperation($class);
+            foreach ($additionalScopes as $hash => $scopeCandidate) {
+                if ($scopeCandidate->getScope() !== IManager::SCOPE_USER || in_array($scopeCandidate, $scopes)) {
+                    continue;
+                }
+                if ($this->entity->isLegitimatedForUserId($scopeCandidate->getScopeId())) {
+                    $ctx = new LogContext();
+                    $ctx
+                        ->setScopes([$scopeCandidate])
+                        ->setEntity($this->entity)
+                        ->setOperation($this->operation);
+                    $this->logger->logScopeExpansion($ctx);
+                    $operations = array_merge($operations, $this->manager->getOperations($class, $scopeCandidate));
+                }
+            }
+        }
+
+        $matches = [];
+        foreach ($operations as $operation) {
+            $configuredEvents = json_decode($operation['events'], true);
+            if ($this->eventName !== null && !in_array($this->eventName, $configuredEvents)) {
+                continue;
+            }
+
+            $checkIds = json_decode($operation['checks'], true);
+            $checks = $this->manager->getChecks($checkIds);
+
+            foreach ($checks as $check) {
+                if (!$this->check($check)) {
+                    // Check did not match, continue with the next operation
+                    continue 2;
+                }
+            }
+
+            $ctx = new LogContext();
+            $ctx
+                ->setEntity($this->entity)
+                ->setOperation($this->operation)
+                ->setConfiguration($operation);
+            $this->logger->logPassedCheck($ctx);
+
+            if ($returnFirstMatchingOperationOnly) {
+                $ctx = new LogContext();
+                $ctx
+                    ->setEntity($this->entity)
+                    ->setOperation($this->operation)
+                    ->setConfiguration($operation);
+                $this->logger->logRunSingle($ctx);
+                return $operation;
+            }
+            $matches[] = $operation;
+        }
+
+        $ctx = new LogContext();
+        $ctx
+            ->setEntity($this->entity)
+            ->setOperation($this->operation);
+        if (!empty($matches)) {
+            $ctx->setConfiguration($matches);
+            $this->logger->logRunAll($ctx);
+        } else {
+            $this->logger->logRunNone($ctx);
+        }
+
+        return $matches;
+    }
+
+    /**
+     * @param array $check
+     * @return bool
+     */
+    public function check(array $check) {
+        try {
+            $checkInstance = $this->container->query($check['class']);
+        } catch (QueryException $e) {
+            // Check does not exist, assume it matches.
+            return true;
+        }
+
+        if ($checkInstance instanceof IFileCheck) {
+            if (empty($this->fileInfo)) {
+                throw new RuntimeException('Must set file info before running the check');
+            }
+            $checkInstance->setFileInfo($this->fileInfo['storage'], $this->fileInfo['path'], $this->fileInfo['isDir']);
+        } elseif ($checkInstance instanceof IEntityCheck) {
+            foreach ($this->contexts as $entityInfo) {
+                list($entity, $subject) = $entityInfo;
+                $checkInstance->setEntitySubject($entity, $subject);
+            }
+        } elseif (!$checkInstance instanceof ICheck) {
+            // Check is invalid
+            throw new \UnexpectedValueException($this->l->t('Check %s is invalid or does not exist', $check['class']));
+        }
+        return $checkInstance->executeCheck($check['operator'], $check['value']);
+    }
 }

apps/workflowengine/lib/AppInfo/Application.php

Indentation +73 added lines, -73 removed lines

@@ -43,86 +43,86 @@
 use OCP\WorkflowEngine\IOperationCompat;
 
 class Application extends App implements IBootstrap {
-	public const APP_ID = 'workflowengine';
+    public const APP_ID = 'workflowengine';
 
-	public function __construct() {
-		parent::__construct(self::APP_ID);
-	}
+    public function __construct() {
+        parent::__construct(self::APP_ID);
+    }
 
-	public function register(IRegistrationContext $context): void {
-		$context->registerServiceAlias('RequestTimeController', RequestTime::class);
-		$context->registerEventListener(
-			LoadSettingsScriptsEvent::class,
-			LoadAdditionalSettingsScriptsListener::class,
-			-100
-		);
-	}
+    public function register(IRegistrationContext $context): void {
+        $context->registerServiceAlias('RequestTimeController', RequestTime::class);
+        $context->registerEventListener(
+            LoadSettingsScriptsEvent::class,
+            LoadAdditionalSettingsScriptsListener::class,
+            -100
+        );
+    }
 
-	public function boot(IBootContext $context): void {
-		$context->injectFn(Closure::fromCallable([$this, 'registerRuleListeners']));
-	}
+    public function boot(IBootContext $context): void {
+        $context->injectFn(Closure::fromCallable([$this, 'registerRuleListeners']));
+    }
 
-	private function registerRuleListeners(IEventDispatcher $dispatcher,
-										   IServerContainer $container,
-										   ILogger $logger): void {
-		/** @var Manager $manager */
-		$manager = $container->query(Manager::class);
-		$configuredEvents = $manager->getAllConfiguredEvents();
+    private function registerRuleListeners(IEventDispatcher $dispatcher,
+                                            IServerContainer $container,
+                                            ILogger $logger): void {
+        /** @var Manager $manager */
+        $manager = $container->query(Manager::class);
+        $configuredEvents = $manager->getAllConfiguredEvents();
 
-		foreach ($configuredEvents as $operationClass => $events) {
-			foreach ($events as $entityClass => $eventNames) {
-				array_map(function (string $eventName) use ($manager, $container, $dispatcher, $logger, $operationClass, $entityClass) {
-					$dispatcher->addListener(
-						$eventName,
-						function ($event) use ($manager, $container, $eventName, $logger, $operationClass, $entityClass) {
-							$ruleMatcher = $manager->getRuleMatcher();
-							try {
-								/** @var IEntity $entity */
-								$entity = $container->query($entityClass);
-								/** @var IOperation $operation */
-								$operation = $container->query($operationClass);
+        foreach ($configuredEvents as $operationClass => $events) {
+            foreach ($events as $entityClass => $eventNames) {
+                array_map(function (string $eventName) use ($manager, $container, $dispatcher, $logger, $operationClass, $entityClass) {
+                    $dispatcher->addListener(
+                        $eventName,
+                        function ($event) use ($manager, $container, $eventName, $logger, $operationClass, $entityClass) {
+                            $ruleMatcher = $manager->getRuleMatcher();
+                            try {
+                                /** @var IEntity $entity */
+                                $entity = $container->query($entityClass);
+                                /** @var IOperation $operation */
+                                $operation = $container->query($operationClass);
 
-								$ruleMatcher->setEventName($eventName);
-								$ruleMatcher->setEntity($entity);
-								$ruleMatcher->setOperation($operation);
+                                $ruleMatcher->setEventName($eventName);
+                                $ruleMatcher->setEntity($entity);
+                                $ruleMatcher->setOperation($operation);
 
-								$ctx = new LogContext();
-								$ctx
-									->setOperation($operation)
-									->setEntity($entity)
-									->setEventName($eventName);
+                                $ctx = new LogContext();
+                                $ctx
+                                    ->setOperation($operation)
+                                    ->setEntity($entity)
+                                    ->setEventName($eventName);
 
-								/** @var Logger $flowLogger */
-								$flowLogger = $container->query(Logger::class);
-								$flowLogger->logEventInit($ctx);
+                                /** @var Logger $flowLogger */
+                                $flowLogger = $container->query(Logger::class);
+                                $flowLogger->logEventInit($ctx);
 
-								if ($event instanceof Event) {
-									$entity->prepareRuleMatcher($ruleMatcher, $eventName, $event);
-									$operation->onEvent($eventName, $event, $ruleMatcher);
-								} elseif ($entity instanceof IEntityCompat && $operation instanceof IOperationCompat) {
-									// TODO: Remove this block (and the compat classes) in the first major release in 2023
-									$entity->prepareRuleMatcherCompat($ruleMatcher, $eventName, $event);
-									$operation->onEventCompat($eventName, $event, $ruleMatcher);
-								} else {
-									$logger->debug(
-										'Cannot handle event {name} of {event} against entity {entity} and operation {operation}',
-										[
-											'app' => self::APP_ID,
-											'name' => $eventName,
-											'event' => get_class($event),
-											'entity' => $entityClass,
-											'operation' => $operationClass,
-										]
-									);
-								}
-								$flowLogger->logEventDone($ctx);
-							} catch (QueryException $e) {
-								// Ignore query exceptions since they might occur when an entity/operation were setup before by an app that is disabled now
-							}
-						}
-					);
-				}, $eventNames ?? []);
-			}
-		}
-	}
+                                if ($event instanceof Event) {
+                                    $entity->prepareRuleMatcher($ruleMatcher, $eventName, $event);
+                                    $operation->onEvent($eventName, $event, $ruleMatcher);
+                                } elseif ($entity instanceof IEntityCompat && $operation instanceof IOperationCompat) {
+                                    // TODO: Remove this block (and the compat classes) in the first major release in 2023
+                                    $entity->prepareRuleMatcherCompat($ruleMatcher, $eventName, $event);
+                                    $operation->onEventCompat($eventName, $event, $ruleMatcher);
+                                } else {
+                                    $logger->debug(
+                                        'Cannot handle event {name} of {event} against entity {entity} and operation {operation}',
+                                        [
+                                            'app' => self::APP_ID,
+                                            'name' => $eventName,
+                                            'event' => get_class($event),
+                                            'entity' => $entityClass,
+                                            'operation' => $operationClass,
+                                        ]
+                                    );
+                                }
+                                $flowLogger->logEventDone($ctx);
+                            } catch (QueryException $e) {
+                                // Ignore query exceptions since they might occur when an entity/operation were setup before by an app that is disabled now
+                            }
+                        }
+                    );
+                }, $eventNames ?? []);
+            }
+        }
+    }
 }